nfe_reader 1.0.4 → 1.0.5

data/lib/nfe_reader/removal.rb

@@ -1,20 +1,24 @@
 # Local de Retirada
 module Nfe
-  # Identificação do Local de Retirada
-  class Removal
-    attr_reader :cnpj, :cpf, :address, :number, :complement,
-      :neighborhood, :city_code, :city, :state
+  module Reader
+    # Identificação do Local de Retirada
+    class Removal
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      @cnpj = attrs[:CNPJ]
-      @cpf = attrs[:CPF]
-      @address = attrs[:xLgr]
-      @number = attrs[:nro]
-      @complement = attrs[:xCpl]
-      @neighborhood = attrs[:xBairro]
-      @city_code = attrs[:cMun]
-      @city = attrs[:xMun]
-      @state = attrs[:UF]
+      attr_reader :cnpj, :cpf, :address, :number, :complement,
+        :neighborhood, :city_code, :city, :state
+
+      def initialize(attrs = {})
+        @cnpj = attrs[:CNPJ]
+        @cpf = attrs[:CPF]
+        @address = attrs[:xLgr]
+        @number = attrs[:nro]
+        @complement = attrs[:xCpl]
+        @neighborhood = attrs[:xBairro]
+        @city_code = attrs[:cMun]
+        @city = attrs[:xMun]
+        @state = attrs[:UF]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/cofins.rb

@@ -1,43 +1,47 @@
 # encoding: UTF-8
 module Nfe
-  class Cofins
-    attr_reader :cst, :base, :percentage, :value, :amount,
-      :aliquot
+  module Reader
+    class Cofins
+      include ::AttributeHelper
 
-    # Fieds Values
-    #
-    # cst: 
-    #   COFINSAliq:
-    #     01 - Operação Tributável 
-    #          (base de cálculo = valor da operação alíquota normal (cumulativo/não cumulativo));
-    #     02 - Operação Tributável 
-    #          (base de cálculo = valor da operação (alíquota diferenciada));
-    #   COFINSQtde:
-    #     03 - Operação Tributável 
-    #          (base de cálculo = quantidade vendida x alíquota por unidadede produto);
-    #   COFINSNT:
-    #     04 - Operação Tributável
-    #          (tributação monofásica(alíquota zero));
-    #     06 - Operação Tributável(alíquota zero);
-    #     07 - Operação Isenta da Contribuição;
-    #     08 - Operação Sem Incidência da Contribuição;
-    #     09 - Operação com Suspensão da Contribuição;
-    #   COFINSOutr:
-    #     99 - Outras Operações;
-    #
-    def initialize(attrs = {})
-      # Cst COFINS
-      @cst = attrs[:CST]
-      # Base COFINS
-      @base = attrs[:vBC]
-      # % COFINS
-      @percentage = attrs[:pCOFINS]
-      # Valor COFINS
-      @value = attrs[:vCOFINS]
-      # Quantidade Vendida
-      @amount = attrs[:qBCProd]
-      # Alíquota do COFINS
-      @aliquot = attrs[:vAliqProd]
+      attr_reader :cst, :base, :percentage, :value, :amount,
+        :aliquot
+
+      # Fieds Values
+      #
+      # cst: 
+      #   COFINSAliq:
+      #     01 - Operação Tributável 
+      #          (base de cálculo = valor da operação alíquota normal (cumulativo/não cumulativo));
+      #     02 - Operação Tributável 
+      #          (base de cálculo = valor da operação (alíquota diferenciada));
+      #   COFINSQtde:
+      #     03 - Operação Tributável 
+      #          (base de cálculo = quantidade vendida x alíquota por unidadede produto);
+      #   COFINSNT:
+      #     04 - Operação Tributável
+      #          (tributação monofásica(alíquota zero));
+      #     06 - Operação Tributável(alíquota zero);
+      #     07 - Operação Isenta da Contribuição;
+      #     08 - Operação Sem Incidência da Contribuição;
+      #     09 - Operação com Suspensão da Contribuição;
+      #   COFINSOutr:
+      #     99 - Outras Operações;
+      #
+      def initialize(attrs = {})
+        # Cst COFINS
+        @cst = attrs[:CST]
+        # Base COFINS
+        @base = attrs[:vBC]
+        # % COFINS
+        @percentage = attrs[:pCOFINS]
+        # Valor COFINS
+        @value = attrs[:vCOFINS]
+        # Quantidade Vendida
+        @amount = attrs[:qBCProd]
+        # Alíquota do COFINS
+        @aliquot = attrs[:vAliqProd]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/cofins_st.rb

@@ -1,19 +1,23 @@
 # encoding: UTF-8
 module Nfe
-  class CofinsSt
-    attr_reader :base, :percentage, :amount, :aliquot, :value
+  module Reader
+    class CofinsSt
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      # Valor Base
-      @base = attrs[:vBC]
-      # % COFINS ST
-      @percentage = attrs[:pCOFINS]
-      # Quantidade
-      @amount = attrs[:qBCProd]
-      # Aliquota COFINS ST
-      @aliquot = attrs[:vAliqProd]
-      # Valor COFINS ST
-      @value = attrs[:vCOFINS]
+      attr_reader :base, :percentage, :amount, :aliquot, :value
+
+      def initialize(attrs = {})
+        # Valor Base
+        @base = attrs[:vBC]
+        # % COFINS ST
+        @percentage = attrs[:pCOFINS]
+        # Quantidade
+        @amount = attrs[:qBCProd]
+        # Aliquota COFINS ST
+        @aliquot = attrs[:vAliqProd]
+        # Valor COFINS ST
+        @value = attrs[:vCOFINS]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/icms.rb

@@ -1,86 +1,90 @@
 # encoding: UTF-8
 module Nfe
-  class Icms
-    attr_reader :origin, :cst, :icms_percentage, :icms, :icms_base_kind,
-      :icms_base, :icms_base_reduction, :icms_st_base_kind, :icms_st_base_reduction,
-      :mva, :icms_st_base, :icms_st_percentage, :icms_st, :icms_st_base_retained_sender,
-      :icms_st_retained_sender, :icms_st_base_retained, :icms_st_retained, :state,
-      :retained_reason, :credit_percentage, :icms_credit, :sn_operation_code
-    
-    # == Field Values
-    #
-    # ori: 0 - Nacional
-    #      1 - Estrangeira - Importação direta
-    #      2 - Estrangeira – Adquirida no mercado interno.
-    #
-    # modBC: 0 - Margem Valor Agregado (%);
-    #        1 - Pauta (Valor);
-    #        2 - Preço Tabelado Máx. (valor);
-    #        3 - valor da operação.
-    #
-    # modBCST: 0 – Preço tabelado ou máximosugerido;
-    #          1 - Lista Negativa (valor);
-    #          2 - Lista Positiva (valor);
-    #          3 - Lista Neutra (valor);
-    #          4 - Margem Valor Agregado (%);
-    #          5 - Pauta (valor);
+  module Reader
+    class Icms
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      # Origem da mercadoria
-      @origin = attrs[:orig] 
-      @origin ||= attrs[:Orig]
+      attr_reader :origin, :cst, :icms_percentage, :icms, :icms_base_kind,
+        :icms_base, :icms_base_reduction, :icms_st_base_kind, :icms_st_base_reduction,
+        :mva, :icms_st_base, :icms_st_percentage, :icms_st, :icms_st_base_retained_sender,
+        :icms_st_retained_sender, :icms_st_base_retained, :icms_st_retained, :state,
+        :retained_reason, :credit_percentage, :icms_credit, :sn_operation_code
       
-      # Tributação do ICMS
-      @cst = attrs[:CST]
-      
-      # == ICMS
+      # == Field Values
       #
-      # % ICMS
-      @icms_percentage = attrs[:pICMS]
-      # Valor ICMS
-      @icms = attrs[:vICMS]
-      # Modalidade de determinação da BC do ICMS
-      @icms_base_kind = attrs[:modBC]
-      # Base ICMS
-      @icms_base = attrs[:vBC]
-      # % Redução Base ICMS
-      @icms_base_reduction = attrs[:pRedBC]
-      
-      # == ICMS ST
+      # ori: 0 - Nacional
+      #      1 - Estrangeira - Importação direta
+      #      2 - Estrangeira – Adquirida no mercado interno.
       #
-      # Modalidade de determinação da BC do ICMS ST
-      @icms_st_base_kind = attrs[:modBCST]
-      # % redução Base ICMS ST
-      @icms_st_base_reduction = attrs[:pRedBCST]
-      # MVA ST
-      @mva = attrs[:pMVAST]
-      # Base ICMS ST
-      @icms_st_base = attrs[:vBCST]
-      # % ICMS ST
-      @icms_st_percentage = attrs[:pICMSST]
-      # Valor ICMS ST
-      @icms_st = attrs[:vICMSST]
-      # Valor do BC do ICMS ST Retido UF Remetente
-      @icms_st_base_retained_sender = attrs[:vBCSTRet]
-      # Valor ICMS ST Retido UF Remetente
-      @icms_st_retained_sender = attrs[:vICMSSTRet]
-      # Valor do BC do ICMS ST Retido UF Destiantaria
-      @icms_st_base_retained = attrs[:vBCSTDest]
-      # Valor ICMS ST Retido UF Destinataria
-      @icms_st_retained = attrs[:vICMSSTDes]
-      # UF para qual é devido o ICMS ST
-      @state = attrs[:UFST]
-      
-      # == Simples Nacional
+      # modBC: 0 - Margem Valor Agregado (%);
+      #        1 - Pauta (Valor);
+      #        2 - Preço Tabelado Máx. (valor);
+      #        3 - valor da operação.
       #
-      # Motivo da desoneração do ICMS
-      @retained_reason = attrs[:motDesICMS]
-      # Alíquota aplicável de cálculo do crédito
-      @credit_percentage = attrs[:pCredSN]
-      # Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123
-      @icms_credit = attrs[:vCredICMSSN]
-      # Código de Situação da Operação
-      @sn_operation_code = attrs[:CSOSN]
+      # modBCST: 0 – Preço tabelado ou máximosugerido;
+      #          1 - Lista Negativa (valor);
+      #          2 - Lista Positiva (valor);
+      #          3 - Lista Neutra (valor);
+      #          4 - Margem Valor Agregado (%);
+      #          5 - Pauta (valor);
+
+      def initialize(attrs = {})
+        # Origem da mercadoria
+        @origin = attrs[:orig] 
+        @origin ||= attrs[:Orig]
+        
+        # Tributação do ICMS
+        @cst = attrs[:CST]
+        
+        # == ICMS
+        #
+        # % ICMS
+        @icms_percentage = attrs[:pICMS]
+        # Valor ICMS
+        @icms = attrs[:vICMS]
+        # Modalidade de determinação da BC do ICMS
+        @icms_base_kind = attrs[:modBC]
+        # Base ICMS
+        @icms_base = attrs[:vBC]
+        # % Redução Base ICMS
+        @icms_base_reduction = attrs[:pRedBC]
+        
+        # == ICMS ST
+        #
+        # Modalidade de determinação da BC do ICMS ST
+        @icms_st_base_kind = attrs[:modBCST]
+        # % redução Base ICMS ST
+        @icms_st_base_reduction = attrs[:pRedBCST]
+        # MVA ST
+        @mva = attrs[:pMVAST]
+        # Base ICMS ST
+        @icms_st_base = attrs[:vBCST]
+        # % ICMS ST
+        @icms_st_percentage = attrs[:pICMSST]
+        # Valor ICMS ST
+        @icms_st = attrs[:vICMSST]
+        # Valor do BC do ICMS ST Retido UF Remetente
+        @icms_st_base_retained_sender = attrs[:vBCSTRet]
+        # Valor ICMS ST Retido UF Remetente
+        @icms_st_retained_sender = attrs[:vICMSSTRet]
+        # Valor do BC do ICMS ST Retido UF Destiantaria
+        @icms_st_base_retained = attrs[:vBCSTDest]
+        # Valor ICMS ST Retido UF Destinataria
+        @icms_st_retained = attrs[:vICMSSTDes]
+        # UF para qual é devido o ICMS ST
+        @state = attrs[:UFST]
+        
+        # == Simples Nacional
+        #
+        # Motivo da desoneração do ICMS
+        @retained_reason = attrs[:motDesICMS]
+        # Alíquota aplicável de cálculo do crédito
+        @credit_percentage = attrs[:pCredSN]
+        # Valor crédito do ICMS que pode ser aproveitado nos termos do art. 23 da LC 123
+        @icms_credit = attrs[:vCredICMSSN]
+        # Código de Situação da Operação
+        @sn_operation_code = attrs[:CSOSN]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/importation_tax.rb

@@ -1,17 +1,21 @@
 # encoding: UTF-8
 module Nfe
-  class ImportationTax
-    attr_reader :base, :expenditure, :taxes, :iof
-    
-    def initialize(attrs = {})
-      # Base de Caluclo
-      @base = attrs[:vBC]
-      # Despesas Aduaneiras
-      @expenditure = attrs[:vDespAdu]
-      # Imposto de Importação
-      @taxes = attrs[:vII]
-      # IOF
-      @iof = attrs[:vIOF]
+  module Reader
+    class ImportationTax
+      include ::AttributeHelper
+
+      attr_reader :base, :expenditure, :taxes, :iof
+      
+      def initialize(attrs = {})
+        # Base de Caluclo
+        @base = attrs[:vBC]
+        # Despesas Aduaneiras
+        @expenditure = attrs[:vDespAdu]
+        # Imposto de Importação
+        @taxes = attrs[:vII]
+        # IOF
+        @iof = attrs[:vIOF]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/ipi.rb

@@ -1,40 +1,44 @@
 # encoding: UTF-8
 module Nfe
-  class Ipi
-    attr_reader :frame_class, :frame_code, :cnpj, :seal, :seal_amount,
-      :cst, :ipi_base, :amount, :value_unit, :percentage, :value, :cst_group
+  module Reader
+    class Ipi
+      include ::AttributeHelper
 
-    def initialize(attrs = {})
-      # Classe de enquadramento do IPI para Cigarros e Bebidas
-      @frame_class = attrs[:clEnq]
-      # Codigo enquadramento
-      @frame_code = attrs[:cEnq]
-      # CNPJ do produtor
-      @cnpj = attrs[:CNPJProd]
-      # Código do selo de controle
-      @seal = attrs[:cSelo]
-      # Quantidade do selo de controle
-      @seal_amount = attrs[:qSelo]
-      
-      # == Tributação
-      if attrs[:IPITrib]
-        # Código da situação tributária do IPI
-        @cst = attrs[:IPITrib][:CST]
-        # Valor da BC do IPI
-        @ipi_base = attrs[:IPITrib][:vBC]
-        # Quantidade total na unidade padrão para tributação
-        @amount = attrs[:IPITrib][:qUnid]
-        # Valor por Unidade Tributável
-        @value_unit = attrs[:IPITrib][:vUnid]
-        # % do IPI
-        @percentage = attrs[:IPITrib][:pIPI]
-        # Valor do IPI
-        @value = attrs[:IPITrib][:vIPI]
-      end
+      attr_reader :frame_class, :frame_code, :cnpj, :seal, :seal_amount,
+        :cst, :ipi_base, :amount, :value_unit, :percentage, :value, :cst_group
+
+      def initialize(attrs = {})
+        # Classe de enquadramento do IPI para Cigarros e Bebidas
+        @frame_class = attrs[:clEnq]
+        # Codigo enquadramento
+        @frame_code = attrs[:cEnq]
+        # CNPJ do produtor
+        @cnpj = attrs[:CNPJProd]
+        # Código do selo de controle
+        @seal = attrs[:cSelo]
+        # Quantidade do selo de controle
+        @seal_amount = attrs[:qSelo]
+        
+        # == Tributação
+        if attrs[:IPITrib]
+          # Código da situação tributária do IPI
+          @cst = attrs[:IPITrib][:CST]
+          # Valor da BC do IPI
+          @ipi_base = attrs[:IPITrib][:vBC]
+          # Quantidade total na unidade padrão para tributação
+          @amount = attrs[:IPITrib][:qUnid]
+          # Valor por Unidade Tributável
+          @value_unit = attrs[:IPITrib][:vUnid]
+          # % do IPI
+          @percentage = attrs[:IPITrib][:pIPI]
+          # Valor do IPI
+          @value = attrs[:IPITrib][:vIPI]
+        end
 
-      if attrs[:IPINT]
-        # Grupo do CST 01, 02, 03, 04, 51, 52, 53, 54 e 55
-        @cst_group = attrs[:IPINT][:CST]
+        if attrs[:IPINT]
+          # Grupo do CST 01, 02, 03, 04, 51, 52, 53, 54 e 55
+          @cst_group = attrs[:IPINT][:CST]
+        end
       end
     end
   end

data/lib/nfe_reader/taxation/issqn.rb

@@ -1,22 +1,26 @@
 # encoding: UTF-8
 module Nfe
-  class Issqn
-    attr_accessor :base, :aliquot, :value, :city, :services, :cst
+  module Reader
+    class Issqn
+      include ::AttributeHelper
 
-    # Fields Values
-    #
-    # cStiTrib : N - NORMAL;
-    #            R - RETIDA;
-    #            S - SUBSTITUTA;
-    #            I - ISENTA
+      attr_accessor :base, :aliquot, :value, :city, :services, :cst
 
-    def initialize(attrs = {})
-      @base = attrs[:vBC]
-      @aliquot = attrs[:vAliq]
-      @value = attrs[:vISSQN]
-      @city = attrs[:cMunFG]
-      @services = attrs[:cListServ]
-      @cst = attrs[:cSitTrib]
+      # Fields Values
+      #
+      # cStiTrib : N - NORMAL;
+      #            R - RETIDA;
+      #            S - SUBSTITUTA;
+      #            I - ISENTA
+
+      def initialize(attrs = {})
+        @base = attrs[:vBC]
+        @aliquot = attrs[:vAliq]
+        @value = attrs[:vISSQN]
+        @city = attrs[:cMunFG]
+        @services = attrs[:cListServ]
+        @cst = attrs[:cSitTrib]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/pis.rb

@@ -1,42 +1,46 @@
 # encoding: UTF-8
 module Nfe
-  class Pis
-    attr_reader :cst, :base, :percentage, :value, :amount, :aliquot
-    
-    # Fieds Values
-    #
-    # cst: 
-    #   PISAliq:
-    #     01 - Operação Tributável 
-    #          (base de cálculo = valor da operação alíquota normal (cumulativo/não cumulativo));
-    #     02 - Operação Tributável 
-    #          (base de cálculo = valor da operação (alíquota diferenciada));
-    #   PISQtde:
-    #     03 - Operação Tributável 
-    #          (base de cálculo = quantidade vendida x alíquota por unidadede produto);
-    #   PISNT:
-    #     04 - Operação Tributável
-    #          (tributação monofásica(alíquota zero));
-    #     06 - Operação Tributável(alíquota zero);
-    #     07 - Operação Isenta da Contribuição;
-    #     08 - Operação Sem Incidência da Contribuição;
-    #     09 - Operação com Suspensão da Contribuição;
-    #   PISOutr:
-    #     99 - Outras Operações;
-    #
-    def initialize(attrs = {})
-      # Cst PIS
-      @cst = attrs[:CST]
-      # Base PIS
-      @base = attrs[:vBC]
-      # % PIS
-      @percentage = attrs[:pPIS]
-      # Valor PIS
-      @value = attrs[:vPIS]
-      # Quantidade Vendida
-      @amount = attrs[:qBCProd]
-      # Alíquota do PIS
-      @aliquot = attrs[:vAliqProd]
+  module Reader
+    class Pis
+      include ::AttributeHelper
+
+      attr_reader :cst, :base, :percentage, :value, :amount, :aliquot
+      
+      # Fieds Values
+      #
+      # cst: 
+      #   PISAliq:
+      #     01 - Operação Tributável 
+      #          (base de cálculo = valor da operação alíquota normal (cumulativo/não cumulativo));
+      #     02 - Operação Tributável 
+      #          (base de cálculo = valor da operação (alíquota diferenciada));
+      #   PISQtde:
+      #     03 - Operação Tributável 
+      #          (base de cálculo = quantidade vendida x alíquota por unidadede produto);
+      #   PISNT:
+      #     04 - Operação Tributável
+      #          (tributação monofásica(alíquota zero));
+      #     06 - Operação Tributável(alíquota zero);
+      #     07 - Operação Isenta da Contribuição;
+      #     08 - Operação Sem Incidência da Contribuição;
+      #     09 - Operação com Suspensão da Contribuição;
+      #   PISOutr:
+      #     99 - Outras Operações;
+      #
+      def initialize(attrs = {})
+        # Cst PIS
+        @cst = attrs[:CST]
+        # Base PIS
+        @base = attrs[:vBC]
+        # % PIS
+        @percentage = attrs[:pPIS]
+        # Valor PIS
+        @value = attrs[:vPIS]
+        # Quantidade Vendida
+        @amount = attrs[:qBCProd]
+        # Alíquota do PIS
+        @aliquot = attrs[:vAliqProd]
+      end
     end
   end
 end

data/lib/nfe_reader/taxation/pis_st.rb

@@ -1,19 +1,23 @@
 # encoding: UTF-8
 module Nfe
-  class PisSt
-    attr_reader :base, :percentage, :amount, :aliquot, :value
-    
-    def initialize(attrs = {})
-      # Valor Base
-      @base = attrs[:vBC]
-      # % PISST
-      @percentage = attrs[:pPIS]
-      # Quantidade
-      @amount = attrs[:qBCProd]
-      # Aliquota PIS ST
-      @aliquot = attrs[:vAliqProd]
-      # Valor PIS ST
-      @value = attrs[:vPIS]
+  module Reader
+    class PisSt
+      include ::AttributeHelper
+
+      attr_reader :base, :percentage, :amount, :aliquot, :value
+      
+      def initialize(attrs = {})
+        # Valor Base
+        @base = attrs[:vBC]
+        # % PISST
+        @percentage = attrs[:pPIS]
+        # Quantidade
+        @amount = attrs[:qBCProd]
+        # Aliquota PIS ST
+        @aliquot = attrs[:vAliqProd]
+        # Valor PIS ST
+        @value = attrs[:vPIS]
+      end
     end
   end
 end