cnab150 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4031bb0e08749ff15d5fa2bb5cc5dbd3c19ade1
-  data.tar.gz: 18c0864d488bb07341d8ffe78123196a36d0a903
+  metadata.gz: 0972689330a76ce6424c08cdacabf44b2b0c0e5e
+  data.tar.gz: bd3b712996e0dce6bffdf32d857a57dbc19eed80
 SHA512:
-  metadata.gz: 2c00ea7b91dc235c45c894208ed4e8d4f8a13cb48f2038cd45f55f35c15dc9ae436ed0257779b5c58076d65b3d9dc974f0b1db23d7df44335c3545eb7420a8e9
-  data.tar.gz: 33fe44caa56db463a4dfd5e84a4e0c20e3b8c44a3dfff53619140d85c71aeaf567b6d9ffd456427d501ead7877a15175b7358cbfaac0798ef666eebfd80959a5
+  metadata.gz: 32d33ed99e126b56c4d245a5e74c28f1da9e77fb2af249601ed8a4a8bf3d26b01a80c5471e278e1ffa66ca2949709b6b486a5340202828501f70203ce808f362
+  data.tar.gz: 975fcdadcc6d1fcbddf99715f33cd4c2250018167d3e2c4446443b8b4dc038c90115eed4e8f33fa0ea38325512ecdfebaa925e522d2d032634297fa0ecb31408

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [1.3.0] - 2016-01-12
+### ADDED
+- Option to overried the default layouts
+
+### CHANGED
+- Layouts are now yaml file

data/README.md

@@ -27,33 +27,109 @@ Or install it yourself as:
     $ gem install cnab150
 
 ## Usage
+
+* The examples are using these registries
+
 ```
-> registries = ['A20000111111111       PREF MUN XXXXXX-XYZ 341BANCO ITAU S.A.     2015101600131203                                                                     ',
->   'G982300210019        20151015201510168166000000005092477201510160000000000000007500000000050900000803120000701594   2                                 ',
->   'G982300210019        20151015201510168169000000023012477201510310201200230228200100000000230100000803120001183477   2                                 ',
->   'Z00000400000000001533612                                                                                                                              ']
+ string_cnab150 = ['A20000111111111       PREF MUN XXXXXX-XYZ 341BANCO ITAU S.A.     2015101600131203                                                                     ',
+                   'G982300210019        20151015201510168166000000005092477201510160000000000000007500000000050900000803120000701594   2                                 ',
+                   'G982300210019        20151015201510168169000000023012477201510310201200230228200100000000230100000803120001183477   2                                 ',
+                   'Z00000400000000001533612                                                                                                                              ']
 
-> cnabs = Cnab150.parse_registries(registries)
+```
 
-> h = Cnab150.header(cnabs)
+* The parser_registries method needs an array os strings, it'll return an array of Cnab150::Registry
+```
+> registries = Cnab150.parse_registries(string_cnab150)
+ => [ Cnab150::Registry, Cnab150::Registry, Cnab150::Registry, Cnab150::Registry ]
+```
 
-> h.to_hash
- => {registry_code: 'A', registry_type: '2', agreement: '0000111111111', organization: 'PREF MUN XXXXXX-XYZ', bank_code: '341', bank_name: 'BANCO ITAU S.A.', file_date: '20151016', file_number: '001312', version: '03', service: '', filler: ''}
+* To select a kind of registry, call the select method with the type and an array os strings
+```
+> g_registries = Cnab150.select(:g, string_cnab150)
+ => [
+       { registry_code: 'G',
+         account: '982300210019',
+         payment_date: '20151015',
+         credit_date: '20151016',
+         barcode: '81660000000050924772015101600000000000000075',
+         value: '000000000509',
+         service_value: '0000080',
+         registry_number: '31200007',
+         agency: '0159',
+         channel: '4',
+         authentication: '   2',
+         payment_type: '',
+         filler: '' },
+       { registry_code: 'G',
+         account: '982300210019',
+         payment_date: '20151015',
+         credit_date: '20151016',
+         barcode: '81690000000230124772015103102012002302282001',
+         value: '000000002301',
+         service_value: '0000080',
+         registry_number: '31200011',
+         agency: '8347',
+         channel: '7',
+         authentication: '   2',
+         payment_type: '',
+         filler: '' },
+    ]
+```
+
+* There is methods to select just the Header, Trailer and Details registries This method will return a Cnab150::Registry. The detail method return any other registries diferent from Header and Trailer
+
+```
+> h = Cnab150.header(registries)
 
 > h.registry_code
  => 'A'
 
 > h.registry_type
  => '2'
+```
+
+
+* To change the keys to hash
+```
+> h = Cnab150.header(registries)
+> h.to_hash
+ => {:registry_code=>"A",
+     :registry_type=>"2",
+     :agreement=>"0000111111111",
+     :organization=>"PREF MUN XXXXXX-XYZ",
+     :bank_code=>"341",
+     :bank_name=>"BANCO ITAU S.A.",
+     :file_date=>"20151016",
+     :file_number=>"001312",
+     :version=>"03",
+     :service=>"",
+     :filler=>""}
+```
 
-> cnabs.to_hash
-#=> [
-#      { registry_code: 'A', registry_type: '2', agreement: '0000111111111', organization: 'PREF MUN XXXXXX-XYZ', bank_code: '341', bank_name: 'BANCO ITAU S.A.', file_date: '20151016', file_number: '001312', version: '03', service: '', filler: '' },
-#      { registry_code: 'G', account: '982300210019', payment_date: '20151015', credit_date: '20151016', barcode: '81660000000050924772015101600000000000000075', value: '000000000509', service_value: '0000080', registry_number: '31200007', agency: '0159', channel: '4', authentication: '   2', payment_type: '', filler: '' },
-#      { registry_code: 'G', account: '982300210019', payment_date: '20151015', credit_date: '20151016', barcode: '81690000000230124772015103102012002302282001', value: '000000002301', service_value: '0000080', registry_number: '31200011', agency: '8347', channel: '7', authentication: '   2', payment_type: '', filler: '' },
-#      { registry_code: 'Z', rows: '000004', total: '00000000001533612', filler: '                                                                                                                              ' }
-#    ]
+* To create a new layout add a YML file with the column names and positions
 
+```
+cnab150:
+  a:
+    registry_code: 1
+    registry_type: 1
+    agreement: 20
+    organization: 20
+    bank_code: 3
+    bank_name: 20
+    file_date: 8
+    file_number: 6
+    version: 2
+    service: 17
+    filler: 52
+```
+And override the default layout by setting the layout_path_file in the configure
+
+```
+Cnab150.configure do |config|
+  config.layout_file_path = 'absolute/path/to/your/layout.yml'
+end
 ```
 
 ## Development

data/cnab150.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.authors       = ['Marco Moura']
   s.email         = ['marco.moura@gmail.com']
 
-  s.summary       = 'Return File CNAB 150.'
-  s.description   = 'Return File CNAB 150.'
+  s.summary       = 'Parser to Return File CNAB 150.'
+  s.description   = 'Parser to Return File CNAB 150.'
   s.homepage      = 'https://github.com/marcomoura/cnab150'
 
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }

data/config/layout.yml

@@ -0,0 +1,32 @@
+cnab150:
+  a:
+    registry_code: 1
+    registry_type: 1
+    agreement: 20
+    organization: 20
+    bank_code: 3
+    bank_name: 20
+    file_date: 8
+    file_number: 6
+    version: 2
+    service: 17
+    filler: 52
+  g:
+    registry_code: 1
+    account: 20
+    payment_date: 8
+    credit_date: 8
+    barcode: 44
+    value: 12
+    service_value: 7
+    registry_number: 8
+    agency: 4
+    channel: 1
+    authentication: 26
+    payment_type: 5
+    filler: 1
+  z:
+    registry_code: 1
+    rows: 6
+    total: 17
+    filler: 126

data/lib/cnab150.rb

@@ -1,44 +1,47 @@
-require 'cnab150/version'
+require 'cnab150/configuration'
 require 'cnab150/registry'
 require 'cnab150/parser'
 require 'cnab150/layout'
 require 'cnab150/errors'
+require 'cnab150/version'
 
 # The public interface of gem
 module Cnab150
-  def self.parse_registries(registries)
-    registries.each_with_object([]) do |r, a|
-      a << parse_registry(r)
+  class << self
+    def parse_registries(registries)
+      registries.each_with_object([]) do |r, a|
+        a << parse_registry(r)
+      end
     end
-  end
 
-  def self.parse_registry(registry)
-    type = Cnab150::Layout.build(registry.chars.first)
-    Cnab150::Registry.new(registry, type)
-  end
+    def parse_registry(registry)
+      type = Cnab150::Layout.build(registry.chars.first)
+      Cnab150::Registry.new(registry, type)
+    end
 
-  def self.header(registries)
-    find(registries, 'A')
-  end
+    def header(registries)
+      find(registries, 'A')
+    end
 
-  def self.trailer(registries)
-    find(registries, 'Z')
-  end
+    def trailer(registries)
+      find(registries, 'Z')
+    end
 
-  def self.details(registries)
-    registries.select do |r|
-      !(r.registry_code.eql?('A') || r.registry_code.eql?('Z'))
+    def details(registries)
+      registries.select do |r|
+        !(r.registry_code.eql?('A') || r.registry_code.eql?('Z'))
+      end
     end
-  end
 
-  def self.select(type, raw)
-    registries = parse_registries(raw)
-    registries.select do |r|
-      r.registry_code.eql?(type.to_s.upcase)
+    def select(type, raw)
+      registries = parse_registries(raw)
+      registries.select do |r|
+        r.registry_code.eql?(type.to_s.upcase)
+      end
     end
-  end
 
-  def self.find(registries, type)
-    registries.find { |r| r.registry_code.eql?(type) }
+    def find(registries, type)
+      registries.find { |r| r.registry_code.eql?(type) }
+    end
   end
 end

data/lib/cnab150/configuration.rb

@@ -0,0 +1,29 @@
+module Cnab150 #:nodoc:
+  class << self
+    # Configures global settings
+    #   Cnab150.configure do |config|
+    #     config.default_per_page = 10
+    #   end
+    def configure
+      yield(@config)
+    end
+
+    # Global settings
+    def config
+      @config ||= Cnab150::Configuration.new
+    end
+  end
+
+  class Configuration #:nodoc:
+    attr_accessor :layout_file_path
+
+    def initialize
+      @layout_file_path = "#{File.dirname(__dir__)}/../config/layout.yml"
+    end
+
+    # The layouts method load the layouts from the yml file.
+    def layouts
+      @_ ||= YAML.load_file(@layout_file_path)['cnab150']
+    end
+  end
+end

data/lib/cnab150/layout.rb

@@ -1,12 +1,25 @@
-Dir[File.dirname(__FILE__) + '/layout/*.rb'].each { |file| require file }
+require 'yaml'
 
 module Cnab150
   # The Layout module is responsible of build the appropriate layout.
-  module Layout
+  class Layout
     def self.build(type)
-      Cnab150::Layout.const_get(type.upcase).new
-    rescue NameError
-      raise Cnab150::Errors::LayoutNotImplementedError
+      fail Cnab150::Errors::LayoutNotImplementedError unless
+      Cnab150.config.layouts.include?(type.downcase)
+
+      new Cnab150.config.layouts[type.downcase]
+    end
+
+    def initialize(layout)
+      @layout = layout
+    end
+
+    def keys
+      @layout.keys.map(&:to_sym)
+    end
+
+    def layout
+      'A' + @layout.values.join('A')
     end
   end
 end

data/lib/cnab150/version.rb

@@ -1,4 +1,4 @@
 # The version of gem
 module Cnab150
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cnab150
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Marco Moura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-07 00:00:00.000000000 Z
+date: 2016-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Return File CNAB 150.
+description: Parser to Return File CNAB 150.
 email:
 - marco.moura@gmail.com
 executables: []
@@ -62,18 +62,18 @@ files:
 - ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - cnab150.gemspec
+- config/layout.yml
 - lib/cnab150.rb
+- lib/cnab150/configuration.rb
 - lib/cnab150/errors.rb
 - lib/cnab150/layout.rb
-- lib/cnab150/layout/a.rb
-- lib/cnab150/layout/g.rb
-- lib/cnab150/layout/z.rb
 - lib/cnab150/parser.rb
 - lib/cnab150/registry.rb
 - lib/cnab150/version.rb
@@ -99,5 +99,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Return File CNAB 150.
+summary: Parser to Return File CNAB 150.
 test_files: []

data/lib/cnab150/layout/a.rb

@@ -1,18 +0,0 @@
-module Cnab150
-  module Layout
-    # Layout of Register A
-    # This is a HEADER registry type
-    class A
-      def keys
-        [:registry_code, :registry_type, :agreement,
-         :organization,  :bank_code,     :bank_name,
-         :file_date,     :file_number,   :version,
-         :service,       :filler]
-      end
-
-      def layout
-        'A' + [1, 1, 20, 20, 3, 20, 8, 6, 2, 17, 52].join('A')
-      end
-    end
-  end
-end

data/lib/cnab150/layout/g.rb

@@ -1,18 +0,0 @@
-module Cnab150
-  module Layout
-    # Layout of Register G
-    # Return of collections identified by barcode
-    class G
-      def keys
-        [:registry_code, :account, :payment_date,   :credit_date,
-         :barcode,       :value,   :service_value,  :registry_number,
-         :agency,        :channel, :authentication, :payment_type,
-         :filler]
-      end
-
-      def layout
-        'A' + [1, 20, 8, 8, 44, 12, 7, 8, 4, 1, 26, 5, 1].join('A')
-      end
-    end
-  end
-end

data/lib/cnab150/layout/z.rb

@@ -1,15 +0,0 @@
-module Cnab150
-  module Layout
-    # Layout of Register Z
-    # This is a TRAILER registry
-    class Z
-      def keys
-        [:registry_code, :rows, :total, :filler]
-      end
-
-      def layout
-        'A' + [1, 6, 17, 126].join('A')
-      end
-    end
-  end
-end