pikelet 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b08f706b9dfcb52105cbcbafdb725cca95db84fc
-  data.tar.gz: 0a4362f589115d5b7fc082322b9d419f68e62c0a
+  metadata.gz: dacccea06922299a0d633783508e02e9ecdffb5c
+  data.tar.gz: 60844ae6f649d78df19fc3a3104a1e8270869ccb
 SHA512:
-  metadata.gz: db9ac7654c8a926801bde9f537b36990b7d9560477eae190116b1ab24fe6915b0d44e0abe48357a25497bba512c3d555e6c4c6d3c4a5a260d750963183350843
-  data.tar.gz: 44e690c9a0913d61bc7a77df2ec460e4ee38479425c166fd6c24ab657699650ee511927829638bd723309487551e03932b1b21b52fc35052619803f5bf66f5d9
+  metadata.gz: 15e82690246aeb038429e4aca2a160c1b5cc3329266b0a99cfaa3e4525e26ae0d56f42d2a292e6e3733d7f58a75fc2eeba95b7b161c3fb6d6f294d4cf15a5eb7
+  data.tar.gz: d50efdf234ef8828b69c536de57f59ba569cffcb824eb724abefcca72d7b84cee99cdebad0ce276ff1939b0659a0ce6358c2b4e27a697da5c2ec4686e257f310

data/README.md

@@ -211,52 +211,6 @@ You can also use shorthand syntax:
       a_number 0...4, &:to_i
     end
 
-### A stupid trick
-
-The `field` statement will actually accepts multiple ranges/indices and will
-simply glue the sections described together. Consider the following data:
-
-    |BFH|00000001|01|LONZZZ  203TEST1101022359GB000001        |
-    |BCH|00000002|02|0111101007F110107                        |
-    |BOH|00000003|03|91200001101031                       GBP2|
-    |BKT|00000004|06|      000001                    011X ZZZ |
-
-In this format the first three characters are a 'message identifier', the next
-8 characters are a sequence number and the next 2 are a 'numeric qualifier'.
-The message identifier and numeric qualifier together form the type signature.
-
-We can describe this as follows (let's not bother describing all the
-different record types):
-
-    Pikelet.define do
-      type_signature  0... 3, 11...13
-      sequence        3...11, &:to_i
-      payload        13.. -1
-    end
-
-Which will yield:
-
-    #<struct
-      type_signature="BFH01",
-      sequence=1,
-      payload="LONZZZ  203TEST1101022359GB000001">,
-    #<struct
-      type_signature="BCH02",
-      sequence=2,
-      payload="0111101007F110107">,
-    #<struct
-      type_signature="BOH03",
-      sequence=3,
-      payload="91200001101031                       GBP2">,
-    #<struct
-      type_signature="BKT06",
-      sequence=4,
-      payload="000001                    011X ZZZ">
-
-In case you were wondering, no I didn't make that format up. That is what a
-[BSP HOT file][dish] actually looks like, except there's a hell of a lot more
-of it and many, many more record types.
-
 ## Thoughts/plans
 
 * With some work, Pikelet could produce flat file records as easily as it

data/lib/pikelet/field_definition.rb

@@ -1,33 +1,14 @@
-require "overpunch"
-
 module Pikelet
   class FieldDefinition
-    attr_reader :indices, :parser
+    attr_reader :index, :parser
 
-    def initialize(indices, type: nil, &parser)
-      @indices = indices
-      if block_given?
-        @parser = parser
-      else
-        @parser = parser_from_type(type)
-      end
+    def initialize(index, &parser)
+      @index = index
+      @parser = parser || :strip.to_proc
     end
 
     def parse(text)
-      @parser.call(indices.map { |index| text[index] }.join)
-    end
-
-    private
-
-    def parser_from_type(type)
-      case type
-      when :integer
-        :to_i.to_proc
-      when :overpunch
-        Proc.new { |value| Overpunch.parse(value) }
-      else
-        :strip.to_proc
-      end
+      parser.call(text[index])
     end
   end
 end

data/lib/pikelet/record_definition.rb

@@ -10,9 +10,9 @@ module Pikelet
       end
     end
 
-    def field(name, *indices, type: nil, &block)
+    def field(name, index, &block)
       @record_class = nil
-      field_definitions[name] = Pikelet::FieldDefinition.new(indices, type: type, &block)
+      field_definitions[name] = Pikelet::FieldDefinition.new(index, &block)
     end
 
     def record(type_signature, &block)
@@ -23,8 +23,8 @@ module Pikelet
       record_class.new(*field_definitions.values.map { |field| field.parse(data) })
     end
 
-    def method_missing(method, *args, **options, &block)
-      field(method, *args, **options, &block)
+    def method_missing(method, *args, &block)
+      field(method, *args, &block)
     end
 
     def record_class

data/lib/pikelet/version.rb

@@ -1,3 +1,3 @@
 module Pikelet
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/pikelet.gemspec

@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_runtime_dependency "overpunch"
-
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

data/spec/pikelet/field_definition_spec.rb

@@ -4,13 +4,12 @@ require "csv"
 
 describe Pikelet::FieldDefinition do
   let(:data)        { "The quick brown fox" }
-  let(:type)        { nil }
-  let(:definition)  { Pikelet::FieldDefinition.new(indices, type: type) }
+  let(:definition)  { Pikelet::FieldDefinition.new(index) }
 
   subject(:value) { definition.parse(data) }
 
   describe "for a fixed-width field" do
-    let(:indices) { [ 4...9 ] }
+    let(:index) { 4...9 }
 
     it "extracts the field content from the data" do
       expect(value).to eq "quick"
@@ -18,54 +17,26 @@ describe Pikelet::FieldDefinition do
   end
 
   describe "given whitespace" do
-    let(:indices) { [ 3...16 ] }
+    let(:index) { 3...16 }
 
     it "strips leading and trailing whitespace" do
       expect(value).to eq "quick brown"
     end
   end
 
-  describe "with multiple indices" do
-    let(:indices) { [ 0...4, 16...19 ] }
-
-    it "joins the sections together" do
-      expect(value).to eq "The fox"
-    end
-  end
-
   describe "given a CSV row" do
-    let(:data)    { CSV.parse("The,quick,brown,fox").first }
-    let(:indices) { [ 2 ] }
+    let(:data)  { CSV.parse("The,quick,brown,fox").first }
+    let(:index) { 2 }
 
     it "extracts the field" do
       expect(value).to eq "brown"
     end
   end
 
-  describe "for integer fields" do
-    let(:data)    { "xx326xx" }
-    let(:indices) { [ 2...5] }
-    let(:type)    { :integer }
-
-    it "converts the value to an integer" do
-      expect(value).to eq 326
-    end
-  end
-
-  describe "for overpunch fields" do
-    let(:data)    { "xx67Kxx" }
-    let(:indices) { [ 2...5] }
-    let(:type)    { :overpunch }
-
-    it "converts the value to an integer" do
-      expect(value).to eq -672
-    end
-  end
-
   describe "given a parser block" do
-    let(:indices) { [ 4...9] }
+    let(:index) { 4...9 }
     let(:definition) do
-      Pikelet::FieldDefinition.new(indices) { |value| value.reverse }
+      Pikelet::FieldDefinition.new(index) { |value| value.reverse }
     end
 
     it "yields the value to the parser" do
@@ -74,9 +45,9 @@ describe Pikelet::FieldDefinition do
   end
 
   describe "given a symbol for the parser block" do
-    let(:indices) { [ 4...9] }
+    let(:index) { 4...9 }
     let(:definition) do
-      Pikelet::FieldDefinition.new(indices, &:upcase)
+      Pikelet::FieldDefinition.new(index, &:upcase)
     end
 
     it "invokes the named method on the value" do

data/spec/pikelet_spec.rb

@@ -114,10 +114,10 @@ describe Pikelet do
     its(:last)  { is_expected.to match_hash(name: "Sue",  number: "087654321", type_signature: "FANCY") }
   end
 
-  describe "given integer fields" do
+  describe "given a block for field parsing" do
     let(:definition) do
       Pikelet.define do
-        value 0...4, &:to_i
+        value(0...4) { |value| value.to_i }
       end
     end
 
@@ -132,24 +132,6 @@ describe Pikelet do
     its(:value) { is_expected.to eq 5637 }
   end
 
-  describe "given overpunch fields" do
-    let(:definition) do
-      Pikelet.define do
-        value(0...4) { |value| Overpunch.parse(value) }
-      end
-    end
-
-    let(:data) do
-      <<-FILE.gsub(/^\s*/, "").split(/[\r\n]+/)
-        563J
-      FILE
-    end
-
-    subject { records.first }
-
-    its(:value) { is_expected.to eq -5631 }
-  end
-
   describe "given a block when parsing" do
     let(:collected_records) { [] }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pikelet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - John Carney
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2014-07-25 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: overpunch
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement