rocknab 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1bc7d036063fff49854aa56b7c77da724780c65201ffef3e872e40e945011720
+  data.tar.gz: 9298a235e01f6ce1254a7458b638534612f7fc6fd7a84f889bdb1cb77cb74e71
+SHA512:
+  metadata.gz: 4063101f14520e296a21c09ee7a2e6b9aaa611a760057c8b270fa7e2818d5ebdbaf4b0ac6f6402476dc611a52738d8d3e801e5df6dca902f221536e83a29666a
+  data.tar.gz: e3ab888d884d2c03526a5706d23046d90f6226889ad51e78d1b38efce339de769a052770bf8e21c289f230175f05937da191252343c428d81648c331a9f4d954

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    rocknab (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-rails (0.3.6)
+      pry (>= 0.10.4)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-rails (~> 0.3)
+  rake (~> 10.0)
+  rocknab!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Rock Content 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/rocknab/builder.rb

@@ -0,0 +1,139 @@
+require_relative "builder/text"
+require_relative "builder/number"
+require_relative "builder/date"
+require_relative "builder/padding"
+
+module Rocknab
+  # This is the DSL that is used to declare CNAB registers
+  #
+  # Declaration:
+  #
+  #   class MyRegister < Rocknab::Builder
+  #     text :txt_field, length: 4
+  #     number :num_field, length: 2
+  #   end
+  #
+  # To use the class:
+  #
+  #   register = MyRegister.new(txt_field: "text", num_field: 10)
+  #   register.build
+  #   => "TEXT10"
+  class Builder
+    # Subclasses can be initialized with the arguments passed as a
+    # hash, just like a Struct.
+    #
+    # Usage:
+    #
+    #   MyRegister.new(txt_field: "text", num_field: 10)
+    def initialize(**args)
+      args.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # Builds the class according to the definition
+    #
+    # Usage:
+    #
+    #   register.build
+    #   => "TEXT10"
+    def build
+      self.class.metadata.map do |field|
+        field.build(self)
+      end.join
+    end
+
+    # Declares that the generated content has a text field
+    #
+    # Parameters:
+    #  - name: Name of the field accessors
+    #  - length: Fixed length of the field
+    #  - default: Default value. Empty if not specified.
+    #  - padding: Padding character. Whitespace, if not specified.
+    #
+    # Usage:
+    #
+    #   class MyRegister < Rocknab::Builder
+    #     text :my_field, length: 20, default: "hello", padding: " "
+    #   end
+    def self.text(name, length: 1, default: " ", padding: " ")
+      metadata << Builders::Text.new(name, length, default, padding)
+      attr_accessor(name)
+    end
+
+    # Declares that the generated content has a numeric field.
+    # This field should only be used for integers.
+    #
+    # Parameters:
+    #  - name: Name of the field accessors
+    #  - length: Fixed length of the field
+    #  - default: Default value. Zero if not specified.
+    #  - padding: Padding character. Zeros, if not specified.
+    #
+    # Usage:
+    #
+    #   class MyRegister < Rocknab::Builder
+    #     number :my_num, length: 20, default: 1234, padding: 0
+    #   end
+    def self.number(name, length: 1, default: 0, padding: 0)
+      metadata << Builders::Number.new(name, length, default, padding)
+      attr_accessor(name)
+    end
+
+    # Declares that the generated content has a date field. The
+    # format is DDMMYYYYhhmmss.
+    #
+    # Parameters:
+    #  - name: Name of the field accessors
+    #  - length: Fixed length of the field. Default is 14.
+    #  - default: Default value. Zeroes if not specified.
+    #  - padding: Padding character. Zeros, if not specified.
+    #
+    # Tip: Use 10 as the length, if you only need the date.
+    #
+    # Usage:
+    #
+    #   class MyRegister < Rocknab::Builder
+    #     date :created_at, length: 14, default: "hello", padding: " "
+    #   end
+    def self.date(name, length: 14, default: 0, padding: 0)
+      metadata << Builders::Date.new(name, length, default, padding)
+      attr_accessor(name)
+    end
+
+    # Declares that the generated content has a padding
+    #
+    # Parameters:
+    #  - length: Fixed length of the field
+    #  - char: Character that will be used to pad the content.
+    #          The default is whitespace.
+    #
+    # Usage:
+    #
+    #   padding length: 10, char: "0"
+    def self.padding(length: 1, char: " ")
+      metadata << Builders::Padding.new(length, char)
+    end
+
+    # Returns the total length of the fields. Useful for validation
+    # purposes and testing.
+    #
+    # Usage:
+    #
+    #   MyRegister.length
+    #   => 240
+    def self.length
+      metadata.map(&:length).reduce(&:+)
+    end
+
+    def self.inherited(child)
+      child.instance_eval do
+        class << self
+          attr_accessor :metadata
+        end
+      end
+
+      child.metadata = []
+    end
+  end
+end

data/lib/rocknab/builder/date.rb

@@ -0,0 +1,11 @@
+module Rocknab
+  module Builders
+    class Date < Struct.new(:name, :length, :default, :padding)
+      def build(klass)
+        value = klass.instance_variable_get("@#{name}") || default
+        str_value = value.strftime("%d%m%Y%H%M%S")
+        str_value[0...length].ljust(length, padding.to_s)
+      end
+    end
+  end
+end

data/lib/rocknab/builder/number.rb

@@ -0,0 +1,10 @@
+module Rocknab
+  module Builders
+    class Number < Struct.new(:name, :length, :default, :padding)
+      def build(klass)
+        value = klass.instance_variable_get("@#{name}") || default
+        value.to_s[0...length].rjust(length, padding.to_s)
+      end
+    end
+  end
+end

data/lib/rocknab/builder/padding.rb

@@ -0,0 +1,9 @@
+module Rocknab
+  module Builders
+    class Padding < Struct.new(:length, :default)
+      def build(klass)
+        default.to_s * length
+      end
+    end
+  end
+end

data/lib/rocknab/builder/text.rb

@@ -0,0 +1,10 @@
+module Rocknab
+  module Builders
+    class Text < Struct.new(:name, :length, :default, :padding)
+      def build(klass)
+        value = klass.instance_variable_get("@#{name}") || default
+        value.to_s.upcase[0...length].ljust(length, padding.to_s)
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240.rb

@@ -0,0 +1,80 @@
+require_relative "../builder"
+require_relative "cnab_240/header"
+require_relative "cnab_240/batch"
+require_relative "cnab_240/trailer"
+
+module Rocknab
+  module Layouts
+    module CNAB240
+      # This is the class that builds a CNAB240 file.
+      #
+      # Parameters:
+      #  - params: A hash containing the following values:
+      #    :cnpj, :branch, :account, :digit, :name, :bank, :date,
+      #    :zipcode, :state
+      #  - payments: An array of hashes, each with the following:
+      #    :bank, :branch, :account, :digit, :name, :date, :value
+      #
+      # Usage:
+      #
+      #   cnab = CNAB240.new(params, payments)
+      #   cnab.build
+      #   => "... CNAB content ..."
+      class CNAB240 < Struct.new(:params, :payments)
+        HEADER_PARAMS = [ :bank_code, :cnpj, :branch, :account, :digit, :name,
+          :bank, :date ]
+        TRAILER_PARAMS = [ :bank_code ]
+
+        # Builds the CNAB 240 v81 file according to the contents
+        #
+        # Usage:
+        #
+        #  cnab.build
+        #  => "... CNAB content ..."
+        def build
+          [ header, batches, trailer, nil ].join("\r\n")
+        end
+
+        private
+
+        def header
+          Header.new(params.slice(*HEADER_PARAMS)).build
+        end
+
+        def batches
+          batch_groups.each_with_index.map do |group, index|
+            config, batch_payments = group
+            is_same_bank = config[:is_same_bank]
+            is_ted = config[:is_ted]
+            is_savings = config[:is_savings]
+            Batch.new(params, batch_payments, is_same_bank, is_ted, is_savings, index + 1).build
+          end
+        end
+
+        def batch_groups
+          payments.group_by do |payment|
+            is_same_bank = payment.dig(:bank) === params.dig(:bank_code)
+            is_ted = payment.dig(:is_ted)
+            is_savings = payment.dig(:is_savings)
+
+            {
+              is_same_bank: is_same_bank,
+              is_ted: !is_same_bank && is_ted,
+              is_savings: is_savings,
+            }
+          end
+        end
+
+        def trailer
+          default_params = {
+            register_count: batches.flatten.count + 2,
+            batch_count: batches.length
+          }
+          line_params = params.slice(*TRAILER_PARAMS).merge(default_params)
+
+          Trailer.new(line_params).build
+        end
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240/batch.rb

@@ -0,0 +1,89 @@
+require_relative "batch_header"
+require_relative "batch_trailer"
+require_relative "segment"
+
+module Rocknab
+  module Layouts
+    module CNAB240
+      class Batch < Struct.new(:params, :payments, :is_same_bank, :is_ted, :is_savings,
+        :batch_index)
+        BATCH_PARAMS = [ :bank_code, :cnpj, :branch, :account, :digit, :name,
+          :zipcode, :state, :payment_type, :payment_reason ]
+        SEGMENT_PARAMS = [ :bank_code, :bank, :branch, :account, :digit, :name,
+          :date, :value, :inscription_number ]
+        TRAILER_PARAMS = [ :bank_code ]
+
+        def build
+          [ batch_header, segments, batch_trailer ]
+        end
+
+        private
+
+        def batch_header
+          default_params = {
+            batch_index: batch_index,
+            payment_method: payment_method,
+          }
+          line_params = params.slice(*BATCH_PARAMS).merge(default_params)
+
+          BatchHeader.new(line_params).build
+        end
+
+        def segments
+          payments.each_with_index.map do |payment, index|
+            default_params = {
+              batch_index: batch_index,
+              segment_index: index + 1,
+              bank_code: params.dig(:bank_code),
+              doc_type: doc_type,
+            }
+            line_params = payment.slice(*SEGMENT_PARAMS).merge(default_params)
+
+            Segment.new(line_params).build
+          end
+        end
+
+        def batch_trailer
+          default_params = {
+            batch_index: batch_index,
+            register_count: register_count,
+            total_sum: total_sum,
+          }
+          line_params = params.slice(*TRAILER_PARAMS).merge(default_params)
+
+          BatchTrailer.new(line_params).build
+        end
+
+        def payment_method
+          if is_same_bank && is_savings
+            5
+          elsif is_same_bank
+            1
+          elsif is_ted
+            41
+          else
+            3
+          end
+        end
+
+        def doc_type
+          if is_savings && !is_same_bank
+            "11"
+          else
+            ""
+          end
+        end
+
+        def register_count
+          payments.count + 2
+        end
+
+        def total_sum
+          payments.inject(0) do |sum, payment|
+            sum + payment.dig(:value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240/batch_header.rb

@@ -0,0 +1,49 @@
+module Rocknab
+  module Layouts
+    module CNAB240
+      class BatchHeader < Rocknab::Builder
+        number :bank_code, length: 3, default: 0
+        number :batch_index, length: 4, default: 1
+        number :register_type, length: 1, default: 1
+
+        text :operation_type, length: 1, default: "C"
+        number :payment_type, length: 2, default: 98
+        number :payment_method, length: 2, default: 1
+        number :batch_layout, length: 3, default: 40
+
+        padding length: 1
+
+        number :company_type, length: 1, default: 2
+        number :cnpj, length: 14
+        text :indentification, length: 4
+
+        padding length: 16
+
+        number :branch, length: 5
+
+        padding length: 1
+
+        number :account, length: 12
+
+        padding length: 1
+
+        text :digit, length: 1
+        text :name, length: 30
+
+        text :payment_reason, length: 30, default: "01"
+        text :account_history, length: 10
+
+        text :street, length: 30
+        number :number, length: 5
+        text :type, length: 15
+        text :city, length: 20
+        text :zipcode, length: 8
+        text :state, length: 2
+
+        padding length: 8
+
+        text :return_code, length: 10
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240/batch_trailer.rb

@@ -0,0 +1,21 @@
+module Rocknab
+  module Layouts
+    module CNAB240
+      class BatchTrailer < Rocknab::Builder
+        number :bank_code, length: 3, default: 0
+        number :batch_index, length: 4, default: 1
+        number :register_type, length: 1, default: 5
+
+        padding length: 9
+
+        number :register_count, length: 6
+        number :total_sum, length: 18
+
+        padding length: 18, char: "0"
+        padding length: 171
+
+        text :return_code, length: 10
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240/header.rb

@@ -0,0 +1,43 @@
+module Rocknab
+  module Layouts
+    module CNAB240
+      class Header < Rocknab::Builder
+        number :bank_code, length: 3, default: 0
+        number :batch_index, length: 4, default: 0
+        number :register_type, length: 1, default: 0
+
+        padding length: 6
+
+        number :file_version, length: 3, default: 80
+
+        number :company_type, length: 1, default: 2
+        number :cnpj, length: 14
+
+        padding length: 20
+
+        number :branch, length: 5
+
+        padding length: 1
+
+        number :account, length: 12
+
+        padding length: 1
+
+        number :digit, length: 1
+        text :name, length: 30
+        text :bank, length: 30
+
+        padding length: 10
+
+        number :file_type, length: 1, default: 1
+        date :date, length: 14
+
+        padding length: 9, char: "0"
+
+        number :density_unit, length: 5
+
+        padding length: 69
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240/segment.rb

@@ -0,0 +1,56 @@
+module Rocknab
+  module Layouts
+    module CNAB240
+      class Segment < Rocknab::Builder
+        number :bank_code, length: 3, default: 0
+        number :batch_index, length: 4, default: 1
+        number :register_type, length: 1, default: 3
+        number :segment_index, length: 5, default: 1
+
+        text :segment_type, length: 1, default: "A"
+        number :service_type, length: 3, default: 0
+
+        padding length: 3, char: "0"
+
+        number :bank, length: 3, default: 0
+        number :branch, length: 5
+
+        padding length: 1
+
+        number :account, length: 12
+
+        padding length: 1
+
+        number :digit, length: 1
+        text :name, length: 30
+
+        text :document_number, length: 20
+        date :date, length: 8
+        text :currency_type, length: 3, default: "REA"
+
+        padding length: 15, char: "0"
+
+        number :value, length: 15
+        text :our_number, length: 15
+
+        padding length: 5
+
+        number :actual_date, length: 8
+        number :actual_value, length: 15
+
+        text :cnpj_number, length: 14
+
+        padding length: 6
+
+        number :operation_number, length: 6
+        number :inscription_number, length: 14
+        text :doc_type, length: 2
+        text :ted_type, length: 5
+
+        text :complement, length: 5
+        text :notice, length: 1, default: "0"
+        text :occurrencies, length: 10
+      end
+    end
+  end
+end

data/lib/rocknab/layouts/cnab_240/trailer.rb

@@ -0,0 +1,18 @@
+module Rocknab
+  module Layouts
+    module CNAB240
+      class Trailer < Rocknab::Builder
+        number :bank_code, length: 3, default: 0
+        number :batch_index, length: 4, default: 9999
+        number :register_type, length: 1, default: 9
+
+        padding length: 9
+
+        number :batch_count, length: 6, default: 1
+        number :register_count, length: 6
+
+        padding length: 211
+      end
+    end
+  end
+end

data/lib/rocknab/version.rb

@@ -0,0 +1,3 @@
+module Rocknab
+  VERSION = "0.1.0"
+end

data/rocknab.gemspec

@@ -0,0 +1,23 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rocknab/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rocknab"
+  spec.version       = Rocknab::VERSION
+  spec.authors       = ["Silvio Henrique Ferreira", "Rock Content"]
+  spec.email         = ["shferreira@me.com", "services@rockcontent.com"]
+  spec.summary       = %q{CNAB File Generator}
+  spec.description   = %q{CNAB File Generator}
+  spec.homepage      = "https://github.com/rockcontent/rocknab"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-rails", "~> 0.3"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rocknab
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Silvio Henrique Ferreira
+- Rock Content
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: CNAB File Generator
+email:
+- shferreira@me.com
+- services@rockcontent.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- lib/rocknab/builder.rb
+- lib/rocknab/builder/date.rb
+- lib/rocknab/builder/number.rb
+- lib/rocknab/builder/padding.rb
+- lib/rocknab/builder/text.rb
+- lib/rocknab/layouts/cnab_240.rb
+- lib/rocknab/layouts/cnab_240/batch.rb
+- lib/rocknab/layouts/cnab_240/batch_header.rb
+- lib/rocknab/layouts/cnab_240/batch_trailer.rb
+- lib/rocknab/layouts/cnab_240/header.rb
+- lib/rocknab/layouts/cnab_240/segment.rb
+- lib/rocknab/layouts/cnab_240/trailer.rb
+- lib/rocknab/version.rb
+- rocknab.gemspec
+homepage: https://github.com/rockcontent/rocknab
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: CNAB File Generator
+test_files: []