fixy 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9262fa93a8633148f73159bacbbcb4d21ed4b408
-  data.tar.gz: 8994b5cd70ce533762cab617358e21f69cf12547
+  metadata.gz: da0096eb40aeacfe04cf63c2389ca65064fcbae5
+  data.tar.gz: 9e0721a2d0987f29d7fea9a33cfd99e8c1658b4b
 SHA512:
-  metadata.gz: ff5b8c0e48810b780fa12ef0eaa2c64c4ca4c7a3a36790808cc31b09d260149e83158eaab624231311e368842b4192d550b1ba176be6fb7e87141faaedaf14d4
-  data.tar.gz: 17ed2f4d5c446805a342181736bcf4e6c1f672b20e8b16b3f184d1c66f6fc4bde028e85ce7e4e439251162ef7931c5f907908799d31fc49c5054061f34a363d6
+  metadata.gz: ecbac0ae5a1a21134cacf33dd911a88c0c8b908617ee4c5261920a13bd224e1ed07311ec62da655a6d021b39b1cef4dd0664999f0397c3bbf936ceb9ba3fc202
+  data.tar.gz: 0fedb296e3d9952edb107169a4c8fa15285155d817d6e7ee2a2a25f66552537fca9e7cb1272c44779c1ebe373005c62a09254e4d2e015431d9db02f53d090a01

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.0.4
+
+* Basic support for parsing records
+
 ## v0.0.3
 
 * Allow passing block to field to define field_value

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/Chetane/fixy.svg?branch=master)](https://travis-ci.org/Chetane/fixy)
+
 ## fixy
 
 Library for generating fixed width flat file documents. 
@@ -85,6 +87,13 @@ class PersonRecord < Fixy::Record
 end
 ```
 
+You can also specify the field definition and field value together by passing a block to `field`.
+
+```ruby
+
+field(:first_name, 10, '1-10', :alphanumeric) { @first_name }
+```
+
 Given a record definition, you can generate a single line (e.g. for testing purposes):
 
 ```ruby
@@ -98,6 +107,24 @@ PersonRecord.new('Sarah', 'Kerrigan').generate
 
 Most of the time however, you will not have to call `generate` directly, as the document will take care of that part.
 
+
+### Parsing existing records
+
+There is limited support for parsing existing records and documents. Because the formatters are currently uni-directionals, formatted values are extracted.
+
+```ruby
+PersonRecord.parse "Sarah     Kerrigan  "
+
+# This will generate the following hash
+# {
+#     :fields => [
+#         { :name => :first_name, :value => "Sarah     "},
+#         { :name => :last_name,  :value => "Kerrigan  "}
+#     ],
+#     :record => "Sarah     Kerrigan  \n"
+# }
+```
+
 ## Document definition
 
 A document is composed of a multitude of records (instances of a `Fixy::Record`). Because some document specification require earlier records to contain a count of upcoming records, both appending and prepending records is supported during a document definition. Below is an example of a document, based on the record defined in the previous section.
@@ -112,6 +139,23 @@ class PeopleDocument < Fixy::Document
 end
 ```
 
+### Document definition using existing records
+
+Occasionally, it is useful to generate a document using existing records. This is particularly handy when generating debug documents (detailed in the next section).
+
+
+```ruby
+class ParsedPeopleDocument < Fixy::Document
+  def build
+		parse_record IdentityRecord, 'Arcturus  Mengsk    '
+		parse_record IdentityRecord, 'Sarah     Kerrigan  '
+		parse_record IdentityRecord, 'Jim       Raynor    '
+	end
+end
+```
+
+
+
 ## Generating a document
 
 With records and documents defined, generating documents is a breeze:
@@ -150,16 +194,16 @@ An example for formatter definition:
 ```ruby
 
 module Fixy
-	module Formatter
-		module Numeric
-    		def format_numeric(input, length)
-      			input = input.to_s
-      			raise ArgumentError, "Invalid Input (only digits are accepted)" unless input =~ /^\d+$/
-      			raise ArgumentError, "Not enough length (input: #{input}, length: #{length})" if input.length > length
-      			input.rjust(length, '0')
-           end
-  		end
-	end
+  module Formatter
+    module Numeric
+      def format_numeric(input, length)
+        input = input.to_s
+        raise ArgumentError, "Invalid Input (only digits are accepted)" unless input =~ /^\d+$/
+        raise ArgumentError, "Not enough length (input: #{input}, length: #{length})" if input.length > length
+        input.rjust(length, '0')
+      end
+    end
+  end
 end
 ```
 

data/lib/fixy/document.rb

@@ -36,5 +36,9 @@ module Fixy
     def append_record(record)
       @content << record.generate(debug_mode)
     end
+
+    def parse_record(klass, record)
+      @content << klass.parse(record, debug_mode)[:record]
+    end
   end
-end
+end

data/lib/fixy/record.rb

@@ -62,13 +62,50 @@ module Fixy
           {}
         end
       end
-    end
 
-    attr_accessor :debug_mode
+      # Parse an existing record
+      def parse(record, debug = false)
+        raise ArgumentError, 'Record must be a string'  unless record.is_a? String
+
+        unless record.length == record_length
+          raise ArgumentError, "Record length is invalid (Expected #{record_length})"
+        end
+
+        decorator = debug ? Fixy::Decorator::Debug : Fixy::Decorator::Default
+        fields = []
+        output = ''
+        current_position = 1
+        current_record = 1
+
+        while current_position <= record_length do
+
+          field = record_fields[current_position]
+          raise StandardError, "Undefined field for position #{current_position}" unless field
+
+          # Extract field data from existing record
+          from   = field[:from] - 1
+          to     = field[:to]   - 1
+          method = field[:name]
+          value  = record[from..to]
+
+          formatted_value = decorator.field(value, current_record, current_position, method, field[:size], field[:type])
+          output << formatted_value
+          fields << { name:  method, value: value }
+
+          current_position = field[:to] + 1
+          current_record += 1
+        end
+
+        # Documentation mandates that every record ends with new line.
+        output << "\n"
+
+        { fields: fields, record: decorator.record(output) }
+      end
+    end
 
     # Generate the entry based on the record structure
     def generate(debug = false)
-      @debug_mode = debug
+      decorator = debug ? Fixy::Decorator::Debug : Fixy::Decorator::Default
       output = ''
       current_position = 1
       current_record = 1
@@ -107,9 +144,5 @@ module Fixy
     def record_fields
       self.class.record_fields
     end
-
-    def decorator
-      debug_mode ? Fixy::Decorator::Debug : Fixy::Decorator::Default
-    end
   end
 end

data/lib/fixy/version.rb

@@ -1,3 +1,3 @@
 module Fixy
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/fixtures/debug_parsed_record.txt

@@ -0,0 +1,2 @@
+<div><pre><span class='odd' data-column='1' data-method='first_name' data-size='10' data-format='alphanumeric'>Sarah     </span><span class='even' data-column='11' data-method='last_name' data-size='10' data-format='alphanumeric'>Kerrigan  </span>
+</pre></div>

data/spec/fixy/document_spec.rb

@@ -10,33 +10,45 @@ describe 'Defining a Document' do
   end
 
   context 'when a build action is defined' do
-    it 'should generate fixed width document' do
+    class IdentityRecord < Fixy::Record
+      set_record_length 20
+      include Fixy::Formatter::Alphanumeric
+      field :first_name, 10, '1-10' , :alphanumeric
+      field :last_name , 10, '11-20', :alphanumeric
 
-      class IdentityRecord < Fixy::Record
-        set_record_length 20
-        include Fixy::Formatter::Alphanumeric
-        field :first_name, 10, '1-10' , :alphanumeric
-        field :last_name , 10, '11-20', :alphanumeric
+      def initialize(first_name, last_name)
+        @first_name = first_name
+        @last_name  = last_name
+      end
 
-        def initialize(first_name, last_name)
-          @first_name = first_name
-          @last_name  = last_name
-        end
+      field_value :first_name, -> { @first_name }
+      field_value :last_name , -> { @last_name  }
+    end
 
-        field_value :first_name, -> { @first_name }
-        field_value :last_name , -> { @last_name  }
+    class PeopleDocument < Fixy::Document
+      def build
+        append_record  IdentityRecord.new('Sarah', 'Kerrigan')
+        append_record  IdentityRecord.new('Jim', 'Raynor')
+        prepend_record IdentityRecord.new('Arcturus', 'Mengsk')
       end
+    end
 
-      class PeopleDocument < Fixy::Document
-        def build
-          append_record  IdentityRecord.new('Sarah', 'Kerrigan')
-          append_record  IdentityRecord.new('Jim', 'Raynor')
-          prepend_record IdentityRecord.new('Arcturus', 'Mengsk')
-        end
+    class ParsedPeopleDocument < Fixy::Document
+      def build
+        parse_record IdentityRecord, 'Arcturus  Mengsk    '
+        parse_record IdentityRecord, 'Sarah     Kerrigan  '
+        parse_record IdentityRecord, 'Jim       Raynor    '
       end
+    end
 
-      PeopleDocument.new.generate "Arcturus  Mengsk    \nSarah     Kerrigan  \nJim       Raynor   "
+    it 'should generate fixed width document' do
+      PeopleDocument.new.generate.should eq "Arcturus  Mengsk    \nSarah     Kerrigan  \nJim       Raynor    \n"
       PeopleDocument.new.generate(true).should eq File.read('spec/fixtures/debug_document.txt')
     end
+
+    it 'should parse fixed width document' do
+      ParsedPeopleDocument.new.generate.should eq "Arcturus  Mengsk    \nSarah     Kerrigan  \nJim       Raynor    \n"
+      ParsedPeopleDocument.new.generate(true).should eq File.read('spec/fixtures/debug_document.txt')
+    end
   end
 end

data/spec/fixy/record_spec.rb

@@ -169,3 +169,80 @@ describe 'Generating a Record' do
     end
   end
 end
+
+describe 'Parsing a record' do
+  context 'when properly defined' do
+    let(:record) { "Sarah     Kerrigan  " }
+    class PersonRecordK < Fixy::Record
+      include Fixy::Formatter::Alphanumeric
+
+      set_record_length 20
+
+      field :first_name, 10, '1-10' , :alphanumeric
+      field :last_name , 10, '11-20', :alphanumeric
+
+      field_value :first_name, -> { 'Sarah' }
+
+      def last_name
+        'Kerrigan'
+      end
+    end
+
+    it 'should generate fixed width record' do
+      PersonRecordE.parse(record).should eq({
+        record: (record + "\n"),
+        fields: [
+          { name: :first_name, value: 'Sarah     '},
+          { name: :last_name,  value: 'Kerrigan  '}
+        ]
+      })
+    end
+
+    context 'when using the debug flag' do
+      it 'should produce a debug log' do
+        PersonRecordE.parse(record, true).should eq({
+          record: File.read('spec/fixtures/debug_parsed_record.txt'),
+          fields: [
+            { name: :first_name, value: 'Sarah     '},
+            { name: :last_name,  value: 'Kerrigan  '}
+          ]
+        })
+      end
+    end
+
+    context 'when invalid record provided' do
+      context 'with a non-string record type' do
+        it 'should raise an error' do
+          expect {
+            PersonRecordE.parse(nil, true)
+          }.to raise_error(StandardError, 'Record must be a string')
+        end
+      end
+
+      context 'with an invalid record length' do
+        it 'should raise an error' do
+          expect {
+            PersonRecordE.parse('', true)
+          }.to raise_error(StandardError, 'Record length is invalid (Expected 20)')
+        end
+      end
+    end
+  end
+
+  context 'when definition is incomplete (e.g. undefined columns)' do
+    it 'should raise an error' do
+      class PersonRecordL < Fixy::Record
+        include Fixy::Formatter::Alphanumeric
+        set_record_length 20
+        field :first_name, 10, '1-10' , :alphanumeric
+        field :last_name , 8,  '11-18', :alphanumeric
+        field_value :first_name, -> { 'Sarah' }
+        field_value :last_name,  -> { 'Kerrigan' }
+      end
+
+      expect {
+        PersonRecordL.parse(' ' * 20)
+      }.to raise_error(StandardError, "Undefined field for position 19")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixy
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Omar Skalli
@@ -74,6 +74,7 @@ files:
 - lib/fixy/record.rb
 - lib/fixy/version.rb
 - spec/fixtures/debug_document.txt
+- spec/fixtures/debug_parsed_record.txt
 - spec/fixtures/debug_record.txt
 - spec/fixy/document_spec.rb
 - spec/fixy/record_spec.rb
@@ -104,6 +105,7 @@ specification_version: 4
 summary: Provides a DSL for defining, generating, and debugging fixed width documents.
 test_files:
 - spec/fixtures/debug_document.txt
+- spec/fixtures/debug_parsed_record.txt
 - spec/fixtures/debug_record.txt
 - spec/fixy/document_spec.rb
 - spec/fixy/record_spec.rb