Add Canceled watermark support

README.md

@@ -65,8 +65,10 @@ XML version | Supported?
 
 ### Options
 
-* `logo_path`: Path of sender's logo image.
-* `logo_dimensions`: Dimensions of the logo. Ex: logo_dimensions = { width: 100, height: 90 }
+- `canceled`: (Boolean) If the NF-e is canceled.
+- `options.logo_path`: Path of sender's logo image.
+- `options.logo_dimensions`: Dimensions of the logo.
+  - Ex: `options.logo_dimensions = { width: 100, height: 90 }`
 
 ### CC-e - Carta de Correção Eletrônica
 

config/locales/pt-BR.yml

@@ -18,6 +18,7 @@ pt-BR:
     infProt: "PROTOCOLO DE AUTORIZAÇÃO DE USO"
     others:
       has_no_fiscal_value: "SEM VALOR FISCAL"
+      canceled: "CANCELADA"
       page: "FOLHA %{current} de %{total}"
       danfe: "DOCUMENTO AUXILIAR DA NOTA FISCAL ELETRÔNICA"
       sefaz: "Consulta de autenticidade no portal nacional da NF-e www.nfe.fazenda.gov.br/portal ou no site da Sefaz Autorizadora"

lib/br_danfe/danfe_lib/base.rb

@@ -2,11 +2,13 @@ module BrDanfe
   module DanfeLib
     class Base
       attr_reader :options
+      attr_writer :canceled
 
       def initialize(xmls)
         @xmls = xmls
         @document = document
         @options = BrDanfe::Logo::Config.new
+        @canceled = false
 
         create_watermark
       end

lib/br_danfe/danfe_lib/nfce.rb

@@ -39,15 +39,52 @@ def generate(footer_info)
           render_no_fiscal_value(xml)
           resize_page_height
         end
+
+        render_canceled_watermark
+
+        @document
       end
 
       def render_no_fiscal_value(xml)
-        @document.stamp('has_no_fiscal_value') if BrDanfe::Helper.unauthorized?(xml)
+        @document.stamp('has_no_fiscal_value') if BrDanfe::Helper.unauthorized?(xml) && !@canceled
       end
 
       def resize_page_height
         @document.page.dictionary.data[:MediaBox] = [0, @document.y - 10, PAGE_WIDTH, PAGE_HEIGHT]
       end
+
+      def render_canceled_watermark
+        return unless @canceled
+
+        create_cancel_watermark
+
+        @document.page_count.times do |i|
+          @document.go_to_page(i + 1)
+          @document.canvas do
+            spacing = 10.cm
+
+            ([email protected]).step(spacing).each do |x|
+              ([email protected]).step(spacing).each do |y|
+                @document.stamp_at('canceled', [x, y])
+              end
+            end
+          end
+        end
+      end
+
+      def create_cancel_watermark
+        return unless @canceled
+
+        @document.create_stamp('canceled') do
+          @document.fill_color '7d7d7d'
+          @document.font_size 1.cm
+          @document.rotate(45, origin: [0, 0]) do
+            @document.transparent(0.3) do
+              @document.draw_text I18n.t('danfe.others.canceled'), at: [1.cm, 0]
+            end
+          end
+        end
+      end
     end
   end
 end

lib/br_danfe/danfe_lib/nfe.rb

@@ -12,14 +12,7 @@ def create_watermark
           @document.fill_color '7d7d7d'
           @document.text_box(
             I18n.t('danfe.others.has_no_fiscal_value'),
-            size: 2.2.cm,
-            width: @document.bounds.width,
-            height: @document.bounds.height,
-            align: :center,
-            valign: :center,
-            at: [0, @document.bounds.height],
-            rotate: 45,
-            rotate_around: :center
+            default_watermark_text_config.merge(size: 2.2.cm)
           )
         end
       end
@@ -36,6 +29,8 @@ def generate(footer_info)
           @document.start_new_page unless index == last_index
         end
 
+        render_canceled_watermark
+
         @document
       end
 
@@ -90,7 +85,42 @@ def render_footer_information(footer_info)
       end
 
       def render_no_fiscal_value(xml)
-        @document.stamp('has_no_fiscal_value') if BrDanfe::Helper.no_fiscal_value?(xml)
+        @document.stamp('has_no_fiscal_value') if BrDanfe::Helper.no_fiscal_value?(xml) && !@canceled
+      end
+
+      def render_canceled_watermark
+        return unless @canceled
+
+        create_canceled_watermark
+
+        @document.page_count.times do |i|
+          @document.go_to_page(i + 1)
+          @document.stamp('canceled')
+        end
+      end
+
+      def create_canceled_watermark
+        @document.create_stamp('canceled') do
+          @document.fill_color '7d7d7d'
+          @document.transparent(0.5) do
+            @document.text_box(
+              I18n.t('danfe.others.canceled'),
+              default_watermark_text_config.merge(size: 3.4.cm)
+            )
+          end
+        end
+      end
+
+      def default_watermark_text_config
+        {
+          width: @document.bounds.width,
+          height: @document.bounds.height,
+          align: :center,
+          valign: :center,
+          at: [0, @document.bounds.height],
+          rotate: 45,
+          rotate_around: :center
+        }
       end
     end
   end

spec/br_danfe/danfe_lib/nfce_spec.rb

@@ -31,6 +31,14 @@
       expect("#{base_dir}saved_nfce.fixture.pdf").to have_same_content_of file: output_pdf
     end
 
+    it 'saves canceled NFC-e as pdf with' do
+      expect(File.exist?(output_pdf)).to be_falsey
+      subject.canceled = true
+      subject.save_pdf output_pdf
+
+      expect("#{base_dir}canceled_nfce.fixture.pdf").to have_same_content_of file: output_pdf
+    end
+
     context 'when nfc-e is unauthorized' do
       context 'when nfc-e is in homologation environment' do
         let(:xml) { BrDanfe::XML.new(File.read("#{base_dir}nfce-unauthorized-hom.xml")) }
@@ -64,6 +72,16 @@
 
         expect("#{base_dir}multiples_xmls_on_the_same_pdf.pdf").to have_same_content_of file: output_pdf
       end
+
+      it 'renders multiple canceled danfes on the same pdf' do
+        subject = described_class.new [xml, xml]
+
+        expect(File.exist?(output_pdf)).to be_falsey
+        subject.canceled = true
+        subject.save_pdf output_pdf
+
+        expect("#{base_dir}multiples_canceled_xmls_on_the_same_pdf.pdf").to have_same_content_of file: output_pdf
+      end
     end
   end
 end

spec/br_danfe/danfe_lib/nfe_spec.rb

@@ -15,6 +15,12 @@
       expected = IO.binread("#{base_dir}nfe_simples_nacional.xml.fixture.pdf")
       expect(subject.render_pdf).to eq expected
     end
+
+    it 'renders a canceled Simples Nacional NF-e using CSOSN' do
+      subject.canceled = true
+      expected = IO.binread("#{base_dir}nfe_simples_nacional_cancel.xml.fixture.pdf")
+      expect(subject.render_pdf).to eq expected
+    end
   end
 
   describe '#save_pdf' do
@@ -48,6 +54,14 @@
         expect("#{base_dir}nfe_with_ns.xml.fixture.pdf").to have_same_content_of file: output_pdf
       end
 
+      it 'renders a basic canceled NF-e with namespace' do
+        expect(File.exist?(output_pdf)).to be_falsey
+        subject.canceled = true
+        subject.save_pdf output_pdf
+
+        expect("#{base_dir}nfe_with_ns_canceled.fixture.pdf").to have_same_content_of file: output_pdf
+      end
+
       context 'when NF-e does not have namespace' do
         let(:xml_file) { File.read("#{base_dir}nfe_without_ns.xml") }
 
@@ -106,6 +120,14 @@
         expect("#{base_dir}nfe_simples_nacional.xml.fixture.pdf").to have_same_content_of file: output_pdf
       end
 
+      it 'renders a canceled Simples Nacional NF-e using CSOSN' do
+        expect(File.exist?(output_pdf)).to be_falsey
+        subject.canceled = true
+        subject.save_pdf output_pdf
+
+        expect("#{base_dir}nfe_simples_nacional_cancel.xml.fixture.pdf").to have_same_content_of file: output_pdf
+      end
+
       context 'when there are more than one page' do
         let(:xml_file) { File.read("#{base_dir}with_three_pages.xml") }
 
@@ -115,6 +137,14 @@
 
           expect("#{base_dir}with_three_pages.fixture.pdf").to have_same_content_of file: output_pdf
         end
+
+        it 'renders xml to the pdf with canceled stamp' do
+          expect(File.exist?(output_pdf)).to be_falsey
+          subject.canceled = true
+          subject.save_pdf output_pdf
+
+          expect("#{base_dir}with_three_pages_cancel.fixture.pdf").to have_same_content_of file: output_pdf
+        end
       end
 
       context 'when there is ISSQN' do