sunat_books 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bc9571ffaf425a6ba23d9ea43d3f1e2eb4e1acf6ba6a05d40d3c974390a9f19
-  data.tar.gz: 884a5edd838e6b36da06b98c956cacbf045bd80f33e7c3700df38e058f21e46a
+  metadata.gz: efd1903840f068f411f75c6c1f8fae4899ffe48fc28a803785a3831203e81ba4
+  data.tar.gz: f1365594c65b1a0b1c13858cfdb3b65db727e7b566120619e124fa54f3702841
 SHA512:
-  metadata.gz: 2d0df1c773487691fc4bc96b46898a3b186dba0500301e71b0e30e345aee646c3fd10fabcae5c95313264f0207381883591e904544a56f471cf38d55d17139fc
-  data.tar.gz: 2ab77e2a3986850ab3619015121b964b42d297ef57edcdddf9b44c89e3d4d19cec1f1139f4471b9550a8136393f3d79daaeb6ea9938de59462a0fae6f40bce64
+  metadata.gz: f349ce044cc13391c2b67f7aab70edf73952c3a8159b5282697d8c935171bf73f16c0a0b34aaaa5d4912a68f94031d37a0a8cd5e84c463b839341ecfc95b9b83
+  data.tar.gz: b8ba1d475126a7ac3e5883df8146bfd9ca01a96149a8e30dbcce37b99c4892eb0f15651370e6256dd1bf2aedf669259818d1e460a44c3c5a532bb331007032ea

data/README.mkd

@@ -31,9 +31,14 @@ pdf.render
 to get the txt file for electronic books
 
 ```ruby
-ple = SunatBooks::Ple::Buys.new(ruc, tickets, month, year)
+ple = SunatBooks::Ple::Buys.new(ruc, tickets, month, year, options)
 ```
 
+Currently allowed options are:
+- `yml`: path location to a custom layout file
+- `layout`: a hash to define method names to replace in layout
+- `book_format`: book format to use
+
 [rubygems-image]: https://badge.fury.io/rb/sunat_books.svg
 [rubygems-url]: https://badge.fury.io/rb/sunat_books
 [travis-image]: https://travis-ci.org/ccarruitero/sunat_books.svg?branch=master

data/lib/sunat_books/csv/base.rb

@@ -15,9 +15,7 @@ module SunatBooks
         # options
         # - layout => Array of strings used to get data for csv
         # - filename
-        if options[:layout].nil?
-          raise SunatBooks::Csv::OptionError, "Layout option is required"
-        end
+        raise SunatBooks::Csv::OptionError, "Layout option is required" if options[:layout].nil?
 
         filename = options[:filename] || "#{tmp_path}book.csv"
         fields = options[:layout]

data/lib/sunat_books/ple/base.rb

@@ -2,74 +2,45 @@
 
 require "csv"
 require_relative "../common_utils"
+require_relative "./utils"
 
 module SunatBooks
   module Ple
     class Base
       include SunatBooks::CommonUtils
+      include Utils
 
       attr_accessor :file
-
-      def ple_book_name(uid, ruc, month, year, *args)
-        code = book_code(uid)
-        code_oportunity = "00" # TODO: case for 'inventarios y balances'
-        operations_state = args[0] || 1 # 0, 1, 2
-        content = args[1] || 1 # 1 ,0
-        currency = args[2] || 1 # 1, 2
-        name = "LE#{ruc}#{year}#{month}00#{code}#{code_oportunity}"
-        name << "#{operations_state}#{content}#{currency}1"
+      attr_reader :book_format
+
+      # ruc => company's ruc in string format
+      # tickets => an array of objects that respond to a layout's methods
+      # month => a number that represent a month
+      # year => a number that represent a year
+      # options =>
+      #   :yml  => to define a custom layout file
+      #   :layout => to define a custom name for a specific layout method
+      #   :book_format => to define ple book format to use
+      def initialize(ruc, tickets, month, year, options = {})
+        @book_format = options[:book_format]
+        yml_path = options[:yml] || default_yml(book_format)
+        fields = YAML.load_file(yml_path)
+        check_layout(options, fields)
+        content = !tickets.empty? ? 1 : 0
+
+        name = ple_book_name(book_format, ruc, month, year, nil, content)
+        filename = "#{path}#{name}.txt"
+        get_file(tickets, fields, filename)
       end
 
-      def book_code(uid)
-        dir = File.dirname(__FILE__)
-        path = "#{dir}/book_codes.csv"
-        code = ""
-        CSV.foreach(path) do |row|
-          if row[0] == uid
-            code = row[2]
-            break
-          end
-        end
-        code
-      end
+      private
 
-      def path
+      # get default yml file according book format given
+      # book_format => ple book format
+      def default_yml(book_format)
+        book_name = self.class.name.downcase.sub("sunatbooks::ple::", "")
         dir = File.dirname(__FILE__)
-        tmp_path = "#{dir}/tmp/"
-        Dir.mkdir(tmp_path) unless Dir.exist?(tmp_path)
-        tmp_path
-      end
-
-      def get_file(tickets, fields, filename)
-        FileUtils.touch(filename.to_s)
-
-        send("file=", filename)
-
-        tickets.each_with_index do |ticket, i|
-          ticket_data = get_value(fields, ticket)
-
-          mode = (i.zero? ? "w+" : "a+")
-          File.open(filename.to_s, mode) do |txt|
-            txt.puts(ticket_data)
-          end
-        end
-      end
-
-      def get_value(fields, ticket)
-        data = ""
-        fields.each do |field|
-          value = available_value?(ticket, field)
-          data << "#{value}|"
-        end
-        data
-      end
-
-      def check_layout(options, fields)
-        options[:layout]&.each do |key, value|
-          i = fields.index(key.to_s)
-          fields.delete(key.to_s)
-          fields.insert(i, value)
-        end
+        "#{dir}/layouts/#{book_name}-#{book_format}.yml"
       end
     end
   end

data/lib/sunat_books/ple/buys.rb

@@ -6,32 +6,8 @@ module SunatBooks
   module Ple
     class Buys < Base
       def initialize(ruc, tickets, month, year, options = {})
-        # ruc => company's ruc in string format
-        # tickets => an array of objects that respond to a layout's methods
-        # month => a number that represent a month
-        # year => a number that represent a year
-        # options =>
-        #   :yml  => to define a custom layout file
-        #   :layout => to define a custom name for a specific layout method
-
-        book_name = self.class.name.downcase.sub("sunatbooks::ple::", "")
-        dir = File.dirname(__FILE__)
-        yml_path = options[:yml] || "#{dir}/layouts/#{book_name}.yml"
-        fields = YAML.load_file(yml_path)
-        check_layout(options, fields)
-        content = !tickets.empty? ? 1 : 0
-        name = ple_book_name("8.1", ruc, month, year, nil, content)
-
-        filename = "#{path}#{name}.txt"
-        get_file(tickets, fields, filename)
-      end
-
-      def insert_layout_fields(options, fields)
-        options[:layout].each do |key, value|
-          i = fields.index(key.to_s)
-          fields.delete(key.to_s)
-          fields.insert(i, value)
-        end
+        options[:book_format] = options[:book_format] || "8.1"
+        super(ruc, tickets, month, year, options)
       end
     end
   end

data/lib/sunat_books/ple/layouts/{buys.yml → buys-8.1.yml}

@@ -21,14 +21,21 @@
 - documentn_isc
 - document_other_tax
 - document_total
-- document_exchange_rate # 1 entero, 3 decimales
+- currency_code
+- exchange_rate # 1 entero, 3 decimales
 - modified_document_date
 - modified_document_type  # 2
 - modified_document_serial
 - modified_document_aduanas_dependency
 - modified_document_number
-- foreign_document_number
 - detraction_date
 - detraction_number
-- marca_document_retention # retention ? '1' : '0'
-- operation_status # current -> '0' '1', -<>?
+- apply_retention? # retention ? '1'
+- clasification_goods_services_adquired
+- contract_or_project
+- inconsistent_exchange
+- inconsistent_provider_inactive
+- inconsistent_provider_igv_exoneration
+- inconsistent_dni_buy_liquidation
+- payment_method
+- anotation_oportunity

data/lib/sunat_books/ple/layouts/buys-8.2.yml

@@ -0,0 +1,36 @@
+- period
+- cuo
+- correlative
+- operation_date
+- document_type
+- document_serial
+- document_number
+- document_bi
+- other_concepts
+- document_total
+- document_type_tax_credit
+- document_serial_tax_credit
+- dua_year_emition
+- document_tax_pay
+- retention_amount
+- currency_code
+- exchange_rate
+- not_domiciled_residence_country
+- not_domiciled_name
+- not_domiciled_address
+- not_domiciled_document_number
+- payment_beneficiary_tax_document_number
+- payment_beneficiary_name
+- payment_beneficiary_residence_country
+- economic_link_type
+- gross_income
+- deduction
+- net_income
+- retention_rate
+- retention_tax
+- double_taxation_agreement
+- exoneration
+- income_type
+- service_mode
+- art_76
+- anotation_oportunity

data/lib/sunat_books/ple/layouts/buys-8.3.yml

@@ -0,0 +1,31 @@
+- period
+- cuo
+- correlative
+- operation_date
+- pay_date
+- document_type
+- document_serial
+- document_number
+- total_diary_operation_non_credit
+- provider_document_type
+- provider_document_number
+- provider_name
+- document_bi
+- document_igv
+- document_other_concept
+- document_total
+- currency_code
+- exchange_rate
+- modified_document_date
+- modified_document_type  # 2
+- modified_document_serial
+- modified_document_number
+- detraction_date
+- detraction_number
+- apply_retention?
+- clasification_goods_services_adquired
+- inconsistent_exchange
+- inconsistent_provider_inactive
+- inconsistent_provider_igv_exoneration
+- payment_method
+- anotation_oportunity

data/lib/sunat_books/ple/layouts/sales-14.1.yml

@@ -0,0 +1,33 @@
+- period
+- cuo
+- correlative
+- operation_date
+- pay_date
+- document_type
+- document_serial
+- initial_document_number
+- final_document_number
+- client_document_type
+- client_document_number
+- client_name
+- bi_exported_operation
+- bi_taxable_operation
+- bi_discount
+- igv_tax
+- igv_discount
+- exempt
+- non_taxable
+- isc_tax
+- bi_ivap
+- ivap_tax
+- other_concept
+- total_operation
+- currency_code
+- exchange_rate
+- original_document_date
+- original_document_type
+- original_document_serial
+- original_document_number
+- contract_uid
+- payment_way
+- anotation_oportunity

data/lib/sunat_books/ple/sales.rb

@@ -6,16 +6,8 @@ module SunatBooks
   module Ple
     class Sales < Base
       def initialize(ruc, tickets, month, year, options = {})
-        book_name = self.class.name.downcase.sub("sunatbooks::ple::", "")
-        dir = File.dirname(__FILE__)
-        yml_path = options[:yml] || "#{dir}/layouts/#{book_name}.yml"
-        fields = YAML.load_file(yml_path)
-        check_layout(options, fields)
-        content = !tickets.empty? ? 1 : 0
-
-        name = ple_book_name("14.2", ruc, month, year, nil, content)
-        @filename = "#{path}#{name}.txt"
-        get_file(tickets, fields, @filename)
+        options[:book_format] = options[:book_format] || "14.2"
+        super(ruc, tickets, month, year, options)
       end
     end
   end

data/lib/sunat_books/ple/utils.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: false
+
+module SunatBooks
+  module Ple
+    module Utils
+      def ple_book_name(uid, ruc, month, year, *args)
+        code = book_code(uid)
+        code_oportunity = "00" # TODO: case for 'inventarios y balances'
+        operations_state = args[0] || 1 # 0, 1, 2
+        content = args[1] || 1 # 1 ,0
+        currency = args[2] || 1 # 1, 2
+        name = "LE#{ruc}#{year}#{month}00#{code}#{code_oportunity}"
+        name << "#{operations_state}#{content}#{currency}1"
+      end
+
+      def book_code(uid)
+        dir = File.dirname(__FILE__)
+        path = "#{dir}/book_codes.csv"
+        code = ""
+        CSV.foreach(path) do |row|
+          if row[0] == uid
+            code = row[2]
+            break
+          end
+        end
+        code
+      end
+
+      def path
+        dir = File.dirname(__FILE__)
+        tmp_path = "#{dir}/tmp/"
+        Dir.mkdir(tmp_path) unless Dir.exist?(tmp_path)
+        tmp_path
+      end
+
+      def get_file(tickets, fields, filename)
+        FileUtils.touch(filename.to_s)
+
+        send("file=", filename)
+
+        tickets.each_with_index do |ticket, i|
+          ticket_data = get_value(fields, ticket)
+
+          mode = (i.zero? ? "w+" : "a+")
+          File.open(filename.to_s, mode) do |txt|
+            txt.puts(ticket_data)
+          end
+        end
+      end
+
+      def get_value(fields, ticket)
+        data = ""
+        fields.each do |field|
+          value = available_value?(ticket, field)
+          data << "#{value}|"
+        end
+        data
+      end
+
+      def check_layout(options, fields)
+        options[:layout]&.each do |key, value|
+          i = fields.index(key.to_s)
+          fields.delete(key.to_s)
+          fields.insert(i, value)
+        end
+      end
+    end
+  end
+end

data/sunat_books.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "sunat_books"
-  s.version = "0.0.4"
+  s.version = "0.1.0"
   s.summary = "A ruby gem to get accounting books for SUNAT"
   s.description = s.summary
   s.authors = ["César Carruitero"]

data/test/ple/buys_test.rb

@@ -2,19 +2,19 @@
 
 require_relative "../helper"
 
-setup do
+def ple_buys(opts = {})
   tickets = [{}]
   ruc = "102392839213"
-  @ple_buys = SunatBooks::Ple::Buys.new(ruc, tickets, 10, 2013)
+  SunatBooks::Ple::Buys.new(ruc, tickets, 10, 2013, opts)
 end
 
 test "generate txt file" do
-  assert File.exist?(@ple_buys.file)
+  assert File.exist?(ple_buys.file)
 end
 
 test "tickets empty" do
-  ple_buys = SunatBooks::Ple::Buys.new("10293827481", {}, 10, 2011)
-  assert File.exist?(ple_buys.file)
+  ple = SunatBooks::Ple::Buys.new("10293827481", {}, 10, 2011)
+  assert File.exist?(ple.file)
 end
 
 scope "custom layout" do
@@ -47,3 +47,13 @@ scope "custom layout" do
     assert txt.include?("20/10/2015")
   end
 end
+
+scope "book_format" do
+  test "without book_format option" do
+    assert_equal ple_buys.book_format, "8.1"
+  end
+
+  test "with book_format option" do
+    assert_equal ple_buys(book_format: "8.2").book_format, "8.2"
+  end
+end

data/test/ple/sales_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative "../helper"
+
+setup do
+  @tickets = [{}]
+  @ruc = "102392839213"
+end
+
+test "generate txt file" do
+  ple = SunatBooks::Ple::Sales.new(@ruc, @tickets, 10, 2013)
+  assert File.exist?(ple.file)
+end
+
+test "allow define book format" do
+  options = { book_format: "14.1" }
+  ple = SunatBooks::Ple::Sales.new(@ruc, @tickets, 10, 2013, options)
+  assert File.exist?(ple.file)
+  assert ple.book_format, "14.1"
+end

data/test/ple/{base_test.rb → utils_test.rb}

@@ -2,8 +2,15 @@
 
 require_relative "../helper"
 
+class TestPle
+  include SunatBooks::Ple::Utils
+  include SunatBooks::CommonUtils
+
+  attr_accessor :file
+end
+
 setup do
-  @base = SunatBooks::Ple::Base.new
+  @base = TestPle.new
 end
 
 test "book_code" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunat_books
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - César Carruitero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-25 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,9 +171,13 @@ files:
 - lib/sunat_books/ple/base.rb
 - lib/sunat_books/ple/book_codes.csv
 - lib/sunat_books/ple/buys.rb
-- lib/sunat_books/ple/layouts/buys.yml
-- lib/sunat_books/ple/layouts/sales.yml
+- lib/sunat_books/ple/layouts/buys-8.1.yml
+- lib/sunat_books/ple/layouts/buys-8.2.yml
+- lib/sunat_books/ple/layouts/buys-8.3.yml
+- lib/sunat_books/ple/layouts/sales-14.1.yml
+- lib/sunat_books/ple/layouts/sales-14.2.yml
 - lib/sunat_books/ple/sales.rb
+- lib/sunat_books/ple/utils.rb
 - sunat_books.gemspec
 - test/csv/base_test.rb
 - test/fixtures/base.rb
@@ -187,8 +191,9 @@ files:
 - test/pdf/pages_utils_test.rb
 - test/pdf/sales_test.rb
 - test/pdf/utils_test.rb
-- test/ple/base_test.rb
 - test/ple/buys_test.rb
+- test/ple/sales_test.rb
+- test/ple/utils_test.rb
 homepage: https://github.com/ccarruitero/sunat_books
 licenses:
 - MPL