parse_me 0.0.2

data/spec/fixed_width/input_splitting_spec.rb

@@ -0,0 +1,389 @@
+require './spec/spec_helper'
+require "./lib/parse_me"
+
+describe 'FixedWidthParser' do
+  subject {ParseMe::FixedWidthParser}
+
+  describe 'InputSplitting' do
+    subject {ParseMe::InputSplitting}
+
+    it 'should be defined' do
+      should be
+    end
+
+    describe 'Fixed' do
+      subject {ParseMe::InputSplitting::Fixed}
+
+      before :each do
+        class Dummy; include ParseMe::InputSplitting::Fixed; end
+        @dummy = Dummy.new
+
+        subject.public_instance_methods.each do |pim|
+          subject.module_eval do
+            module_function pim
+            public pim
+          end
+        end
+      end
+
+      it 'should be defined' do
+        should be
+      end
+
+      describe 'parse' do
+
+        it 'should define the parse method' do
+          subject.method(:parse).should be
+        end
+
+        describe 'test case 1' do
+          before :each do
+            @source = 'Lorem Ipsum    Dolor sit amet      Foo            Bar                 '
+            @rules = {
+              name: {required: true, length: 15},
+              last_name: {required: true, length: 20}
+            }
+            test_rules = @rules
+            test_source = @source
+            @dummy.instance_eval do
+              @source = test_source
+              @rules = test_rules
+              @options = {}
+            end
+          end
+
+          it 'should have a 70 characters long source' do
+            @source.length.should eq(70)
+          end
+
+          it 'should properly get length rules' do
+            @dummy.get_length_rules.should eq([15,20])
+          end
+
+          it 'should acknowledge valid length rules' do
+            @dummy.valid_length_rules?.should be_true
+          end
+
+          it 'should have NO labeled rows' do
+            @dummy.labeled_rows?.should be_false
+          end
+
+          it 'should have a width of 35' do
+            @dummy.file_width.should eq(35)
+          end
+
+          it 'should properly split the input' do
+            @dummy.split_input.should eq([
+              'Lorem Ipsum    Dolor sit amet      ',
+              'Foo            Bar                 '
+            ])
+          end
+
+          it 'should create a proper unpack pattern' do
+            @dummy.unpack_pattern.should eq('A15A20')
+          end
+
+          it 'should parse valid attributes' do
+            @dummy.attributes.should eq([:name, :last_name])
+          end
+
+          describe 'member' do
+            it 'should create a valid attributes hash for first string' do
+              @dummy.member(@dummy.split_input[0]).should eq({
+                name: 'Lorem Ipsum',
+                last_name: 'Dolor sit amet'
+              })
+            end
+
+            it 'should create a valid attributes hash for second string' do
+              @dummy.member(@dummy.split_input[1]).should eq({
+                name: 'Foo',
+                last_name: 'Bar'
+              })
+            end
+          end
+
+          describe 'collection' do
+            it 'should map a valid collection of members' do
+              @dummy.collection.should eq([
+                {
+                  name: 'Lorem Ipsum',
+                  last_name: 'Dolor sit amet'
+                },
+                {
+                  name: 'Foo',
+                  last_name: 'Bar'
+                }
+              ])
+            end
+          end
+        end
+
+        describe 'test case 2 (invalid length)' do
+          before :each do
+            @source = 'Lorem Ipsum    Dolor sit amet      Foo            Bar                 '
+            @rules = {
+              name: {required: true},
+              last_name: {required: true, length: 20}
+            }
+            test_rules = @rules
+            @dummy.instance_eval do
+              @rules = test_rules
+              @options = {}
+            end
+          end
+
+          it 'should have a 70 characters long source' do
+            @source.length.should eq(70)
+          end
+
+          it 'should properly get length rules' do
+            @dummy.get_length_rules.should eq([nil,20])
+          end
+
+          it 'should NOT acknowledge valid length rules' do
+            @dummy.valid_length_rules?.should be_false
+          end
+
+          it 'should have NO labeled rows' do
+            @dummy.labeled_rows?.should be_false
+          end
+
+          it 'should have a width of 35' do
+            expect { @dummy.file_width }.to raise_error(Exception)
+          end
+
+          it 'should raise an exception when split is invoked' do
+            expect { @dummy.split_input }.to raise_error(Exception)
+          end
+
+          it 'should raise an exception when parse is invoked' do
+            expect { @dummy.parse(@source, @rules) }.to raise_error(Exception)
+          end
+
+          it 'should parse valid attributes' do
+            @dummy.attributes.should eq([:name, :last_name])
+          end
+        end
+
+        describe 'test case 3 (labeled rows)' do
+          before :each do
+            @source =  '0Lorem Ipsum    Dolor sit amet      '
+            @source += '1Foo            Bar       Baz       '
+            @rules = {
+              "0" => {
+                name: {required: true, length: 15},
+                last_name: {required: true, length: 20}
+              },
+              "1" => {
+                first: {required: true, length: 15},
+                second: {required: true, length: 10},
+                third: {required: true, length: 10}
+              }
+            }
+            test_rules = @rules
+            test_source = @source
+            @dummy.instance_eval do
+              @source = test_source
+              @rules = test_rules
+              @options = {labeled_rows: true}
+            end
+          end
+
+          it 'should have a 72 characters long source' do
+            @source.length.should eq(72)
+          end
+
+          it 'should properly get length rules' do
+            @dummy.get_length_rules.should eq([15,20,15,10,10])
+          end
+
+          it 'should acknowledge valid length rules' do
+            @dummy.valid_length_rules?.should be
+          end
+
+          it 'should have labeled rows' do
+            @dummy.labeled_rows?.should be
+          end
+
+          it 'should have labels 0 and 1' do
+            @dummy.labels.should eq(['0','1'])
+          end
+
+          it 'should have label_lengths equal to 1 and 1' do
+            @dummy.label_lengths.should eq([1,1])
+          end
+
+          it 'should have label_length equal to 1' do
+            @dummy.label_length.should eq(1)
+          end
+
+          it 'should have a width of 36' do
+            @dummy.file_width.should eq(36)
+          end
+
+          it 'should properly split the input' do
+            @dummy.split_input.should eq([
+              '0Lorem Ipsum    Dolor sit amet      ',
+              '1Foo            Bar       Baz       '
+            ])
+          end
+
+          it 'should create a proper unpack pattern for label "0"' do
+            @dummy.unpack_pattern('0').should eq('A1A15A20')
+          end
+
+          it 'should create a proper unpack pattern for label "1"' do
+            @dummy.unpack_pattern('1').should eq('A1A15A10A10')
+          end
+
+          describe 'label_for' do
+            it 'should fetch the label of the first string' do
+              @dummy.label_for(@dummy.split_input[0]).should eq('0')
+            end
+
+            it 'should fetch the label of the second string' do
+              @dummy.label_for(@dummy.split_input[1]).should eq('1')
+            end
+          end
+
+          describe 'labeled_member' do
+            it 'should create a proper attributes hash for first string' do
+              str = @dummy.split_input[0]
+              label = @dummy.label_for str
+              @dummy.labeled_member(str, label).should eq({
+                name: 'Lorem Ipsum',
+                last_name: 'Dolor sit amet',
+                __label: '0'
+              })
+            end
+
+            it 'should create a proper attributes hash for second string' do
+              str = @dummy.split_input[1]
+              label = @dummy.label_for str
+              @dummy.labeled_member(str, label).should eq({
+                first: 'Foo',
+                second: 'Bar',
+                third: 'Baz',
+                __label: '1'
+              })
+            end
+          end
+
+          describe 'attributes' do
+            it 'should parse valid attributes for first label' do
+              @dummy.attributes('0').should eq([:name, :last_name])
+            end
+
+            it 'should parse valid attributes for second label' do
+              @dummy.attributes('1').should eq([:first, :second, :third])
+            end
+          end
+
+          describe 'collection' do
+            it 'should map a valid collection of members' do
+              @dummy.collection.should eq([
+                {
+                  name: 'Lorem Ipsum',
+                  last_name: 'Dolor sit amet',
+                  __label: '0'
+                },
+                {
+                  first: 'Foo',
+                  second: 'Bar',
+                  third: 'Baz',
+                  __label: '1'
+                }
+              ])
+            end
+          end
+
+        end
+
+        describe 'test case 4' do
+          before :each do
+            @source = "Lorem Ipsum    Dolor sit amet      \nFoo            Bar                 \n"
+            @rules = {
+              name: {required: true, length: 15},
+              last_name: {required: true, length: 20}
+            }
+            test_rules = @rules
+            test_source = @source
+            @dummy.instance_eval do
+              @source = test_source
+              @rules = test_rules
+              @options = {}
+            end
+          end
+
+          it 'should have a 72 characters long source' do
+            @source.length.should eq(72)
+          end
+
+          it 'should properly get length rules' do
+            @dummy.get_length_rules.should eq([15,20])
+          end
+
+          it 'should acknowledge valid length rules' do
+            @dummy.valid_length_rules?.should be_true
+          end
+
+          it 'should have NO labeled rows' do
+            @dummy.labeled_rows?.should be_false
+          end
+
+          it 'should have a width of 35' do
+            @dummy.file_width.should eq(35)
+          end
+
+          it 'should properly split the input' do
+            @dummy.split_input.should eq([
+              'Lorem Ipsum    Dolor sit amet      ',
+              'Foo            Bar                 '
+            ])
+          end
+
+          it 'should create a proper unpack pattern' do
+            @dummy.unpack_pattern.should eq('A15A20')
+          end
+
+          it 'should parse valid attributes' do
+            @dummy.attributes.should eq([:name, :last_name])
+          end
+
+          describe 'member' do
+            it 'should create a valid attributes hash for first string' do
+              @dummy.member(@dummy.split_input[0]).should eq({
+                name: 'Lorem Ipsum',
+                last_name: 'Dolor sit amet'
+              })
+            end
+
+            it 'should create a valid attributes hash for second string' do
+              @dummy.member(@dummy.split_input[1]).should eq({
+                name: 'Foo',
+                last_name: 'Bar'
+              })
+            end
+          end
+
+          describe 'collection' do
+            it 'should map a valid collection of members' do
+              @dummy.collection.should eq([
+                {
+                  name: 'Lorem Ipsum',
+                  last_name: 'Dolor sit amet'
+                },
+                {
+                  name: 'Foo',
+                  last_name: 'Bar'
+                }
+              ])
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/spec/fixed_width/parser_spec.rb

@@ -0,0 +1,35 @@
+require './spec/spec_helper'
+require "./lib/parse_me"
+
+describe 'FixedWidthParser' do
+  subject {ParseMe::FixedWidthParser}
+
+  describe 'Test case 1' do
+    before :each do
+      @source = 'Lorem Ipsum    Dolor sit amet      Foo            Bar                 '
+      @rules = {
+        name: {required: true, length: 15},
+        last_name: {required: true, length: 20}
+      }
+      @attributes = [
+        {name: 'Lorem Ipsum', last_name: 'Dolor sit amet'},
+        {name: 'Foo', last_name: 'Bar'}
+      ]
+      @result = subject.parse(@source, @rules)
+    end
+
+    it 'should return an array' do
+      @result.class.should eq(Array)
+    end
+
+    it 'should properly parse attributes for record with index 0' do
+      @result[0].name.should eq(@attributes[0][:name])
+      @result[0].last_name.should eq(@attributes[0][:last_name])
+    end
+
+    it 'should properly parse attributes for record with index 1' do
+      @result[1].name.should eq(@attributes[1][:name])
+      @result[1].last_name.should eq(@attributes[1][:last_name])
+    end
+  end
+end

data/spec/namespace_spec.rb

@@ -0,0 +1,20 @@
+require './spec/spec_helper'
+require "./lib/parse_me"
+
+describe ParseMe do
+  it 'should be defined' do
+    should be
+  end
+
+  it 'should define FixedWidthParser' do
+    ParseMe::FixedWidthParser.should be
+  end
+
+  it 'should define VarWidthParser' do
+    ParseMe::VarWidthParser.should be
+  end
+
+  it 'should define ParsedObject' do
+    ParseMe::ParsedObject.should be
+  end
+end

data/spec/parsed_object/parsed_object_spec.rb

@@ -0,0 +1,165 @@
+require './spec/spec_helper'
+require './lib/parse_me'
+
+describe 'ParsedObject' do
+  subject{ParseMe::ParsedObject}
+
+  it 'should be defined' do
+    should be
+  end
+
+  it 'should create an instance properly' do
+    po = subject.new({})
+    po.should be
+  end
+
+  describe 'attribute reading' do
+    before :each do
+      attrs = {
+        name: 'Foo',
+        last_name: 'Bar',
+        age: 15
+      }
+      @po = subject.new attrs
+    end
+
+    it 'should be able to read an attribute' do
+      @po.name.should eq('Foo')
+    end
+
+    it 'should raise NoMethodError when reading an undefined attribute' do
+      expect{@po.foo}.to raise_error(NoMethodError)
+    end
+  end
+
+  describe 'not labeled rows' do
+    before :each do
+      @source =  'Lorem Ipsum    Dolor sit amet      1050000'
+      @source += 'Foo            Bar       Baz       1234567'
+      @source += 'John           Doe       Dong        34000'
+      @rules = {
+        first: {required: true, length: 15},
+        second: {required: true, length: 10},
+        third: {required: true, length: 10},
+        income: {required: true, length: 7, ghost_decimal_scale: 2}
+      }
+      @parsed = ParseMe::FixedWidthParser.new.parse(@source, @rules)
+    end
+
+    it 'should return a 3 elements long Array' do
+      @parsed.length.should eq(3)
+    end
+
+    it 'should have valid records(0)' do
+      @parsed[0].valid?.should be(true)
+    end
+
+    it 'should have valid records(1)' do
+      @parsed[1].valid?.should be(true)
+    end
+
+    it 'should have valid records(2)' do
+      @parsed[2].valid?.should be(true)
+    end
+
+    it 'should have no errors(0)' do
+      @parsed[0].errors.empty?.should be(true)
+    end
+
+    it 'should have no errors(1)' do
+      @parsed[1].errors.empty?.should be(true)
+    end
+
+    it 'should have no errors(2)' do
+      @parsed[2].errors.empty?.should be(true)
+    end
+
+    describe 'income attribute' do
+      it 'should properly transform the income attribute to 10500' do
+        @parsed[0].income.should eq(10500)
+      end
+
+      it 'should properly transform the income attribute to 12345.67' do
+        @parsed[1].income.should eq(12345.67)
+      end
+
+      it 'should properly transform the income attribute to 340' do
+        @parsed[2].income.should eq(340)
+      end
+    end
+
+    describe 'invalid record' do
+      before :each do
+        @inv_source =  'Lorem Ipsum    Dolor sit amet      1050000'
+        @inv_source += 'Foo            Bar       Baz       1234567'
+        @inv_source += 'John           Doe                   34000'
+        @inv = ParseMe::FixedWidthParser.new.parse(@inv_source, @rules)
+      end
+
+      it "should have it's fourth record invalid" do
+        @inv[2].valid?.should be(false)
+      end
+
+      it "should have an error" do
+        @inv[2].errors.length.should eq(1)
+      end
+    end
+  end
+
+  describe 'labeled rows' do
+    before :each do
+      @source =  '0This is a header    This is a desc.       '
+      @source += '1Lorem Ipsum    Dolor sit amet      1050000'
+      @source += '1Foo            Bar       Baz       1234567'
+      @source += '1John           Doe       Dong      0034000'
+      @rules = {
+        "0" => {
+          header: {required: true, length: 20},
+          description: {required: true, length: 15},
+          filler: {length: 7}
+        },
+        "1" => {
+          first: {required: true, length: 15},
+          second: {required: true, length: 10},
+          third: {required: true, length: 10},
+          income: {required: true, length: 7, ghost_decimal_scale: 2}
+        }
+      }
+      @parsed = ParseMe::FixedWidthParser.new.parse(@source, @rules, labeled_rows: true)
+    end
+
+    it 'should return a 4 elements long Array' do
+      @parsed.length.should eq(4)
+    end
+
+    describe 'header record' do
+      it 'should be labeled with "0"' do
+        @parsed[0].record_label.should eq("0")
+      end
+    end
+
+    describe 'body record' do
+      it 'should be labeled with "1"' do
+        @parsed[1].record_label.should eq("1")
+      end
+
+      it 'should be labeled with "1"' do
+        @parsed[2].record_label.should eq("1")
+      end
+    end
+
+    describe 'income attribute' do
+      it 'should properly transform the income attribute to 10500' do
+        @parsed[1].income.should eq(10500)
+      end
+
+      it 'should properly transform the income attribute to 12345.67' do
+        @parsed[2].income.should eq(12345.67)
+      end
+
+      it 'should properly transform the income attribute to 340' do
+        @parsed[3].income.should eq(340)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+SimpleCov.start do
+  minimum_coverage 90
+end