pikelet 2.0.0.beta.8 → 2.0.0.beta.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c813b4fc0de2c84af10d6e1be5ef863df7dfd89
-  data.tar.gz: a638197dd405056da0024b5f6e9352159e8ba72b
+  metadata.gz: 58194d17548297f7e8d35fbb76d5ffdb5588a715
+  data.tar.gz: 18bc08e057dc9c91767445a1303800e7e0726e4e
 SHA512:
-  metadata.gz: 9c6c7eddcdc7e5b6453e0364e1f2fd3cc8b7a327a3ad8c4c9c09a5c624c3ae4e9d6b81cdae35b55ca3220f19e9fe4d17e294b714e5c04876fd898f9e2fa647b0
-  data.tar.gz: 54cce0eef113dd276d2a7971f5b7c5789c53648e0a53e316f145222a99d95627e37f6f98356ba5d2e2da89b13637d00def7d9ce1dedaaef5ae6450cfe7fc59eb
+  metadata.gz: bbc2a341e268794105b79104a91f18b25a5a3eaf9f3fbafa49cfe796dc56cd6d432aef249c1622715ab18453f9a2c5787f9e2051b50bdf22c2c228440607f0ea
+  data.tar.gz: d3353fdb052dd8de520c6575ea06d10940ab9606412789fb93ed63b13c80a4732580b6eade95e9e4a7b6a1f7d01989fb5310bd9727a9500cd4209f2b40408040

data/README.md

@@ -295,6 +295,26 @@ a custom class to use instead.
 
 The only requirement on the class is that its constructor (ie. `initialize`
 method) should accept attributes as a hash with symbol keys.
+
+### Legacy type signature syntax
+
+In Pikelet v1.x there wasn't a `signature_field` option. Instead, you were
+required to name your signature field `type_signature`.
+
+    Pikelet.define do
+      type_signature 0...4
+
+      record "NAME" do
+        first_name  4...14
+        last_name  14...24
+      end
+
+      record "ADDR" do
+        street_address  4...24
+        city           24...44
+      end
+    end
+
 ## Thoughts/plans
 
 * I had a crack at supporting lazy enumeration, and it kinda works. Sometimes.

data/lib/pikelet/field_definition.rb

@@ -34,7 +34,8 @@ module Pikelet
 
     def parse(record)
       # TODO: Test that fields are always stripped.
-      if value = record[index].strip
+      if value = record[index]
+        value.strip!
         if parser
           parser.to_proc.call(value)
         else

data/lib/pikelet/version.rb

@@ -1,3 +1,3 @@
 module Pikelet
-  VERSION = "2.0.0.beta.8"
+  VERSION = "2.0.0.beta.9"
 end

data/spec/pikelet/field_definition_spec.rb

@@ -16,7 +16,7 @@ describe Pikelet::FieldDefinition do
 
     subject { definition }
 
-    its(:parser)    { is_expected.to eq :strip }
+    its(:parser)    { is_expected.to be_nil }
     its(:formatter) { is_expected.to eq :to_s }
     its(:padding)   { is_expected.to eq " " }
     its(:alignment) { is_expected.to eq :left }

data/spec/readme_examples_spec.rb

@@ -174,4 +174,123 @@ describe "README Examples:" do
 
     it_will "format the records"
   end
+
+  describe "Formatting options" do
+    let(:definition) do
+      Pikelet.define do
+        number          0... 3, align: :right, pad: "0"
+        text            3...10, align: :left,  pad: "-"
+        another_number 10...13, type: :numeric
+        more_text      13...20, type: :alpha
+      end
+    end
+
+    let(:records) do
+      [
+        OpenStruct.new(number: 9, text: "blah", another_number: 12, more_text: "meh")
+      ]
+    end
+
+    let(:expected_data) do
+      <<-DATA
+        |009|blah---|012|meh    |
+      DATA
+    end
+
+    it_will "format the records"
+  end
+
+  describe "Custom record classes" do
+    class Base
+      attr_reader :type
+
+      def initialize(**attrs)
+        @type = attrs[:type]
+      end
+    end
+
+    class Name < Base
+      attr_reader :name
+
+      def initialize(**attrs)
+        super(type: "NAME")
+        @name = attrs[:name]
+      end
+    end
+
+    class Address < Base
+      attr_reader :street, :city
+
+      def initialize(**attrs)
+        super(type: "ADDR")
+        @street = attrs[:street]
+        @city = attrs[:city]
+      end
+    end
+
+    let(:definition) do
+      Pikelet.define signature_field: :type, record_class: Base do
+        type 0...4
+
+        record "NAME", record_class: Name do
+          name 4...20
+        end
+
+        record "ADDR", record_class: Address do
+          street  4...20
+          city   20...30
+        end
+      end
+    end
+
+    let(:data) do
+      <<-DATA
+        |NAME|Frida Kahlo     |
+        |ADDR|123 South Street|Sometown            |
+      DATA
+    end
+
+    let(:expected_records) do
+      [
+        { class: Name,    type: "NAME", name: "Frida Kahlo" },
+        { class: Address, type: "ADDR", street: "123 South Street", city: "Sometown" }
+      ]
+    end
+
+    it_will "parse the data"
+  end
+
+  describe "Legacy type signature syntax" do
+    let(:definition) do
+      Pikelet.define do
+        type_signature 0...4
+
+        record "NAME" do
+          first_name  4...14
+          last_name  14...24
+        end
+
+        record "ADDR" do
+          street_address  4...24
+          city           24...44
+        end
+      end
+    end
+
+    let(:data) do
+      <<-DATA
+        |NAME|Frida     |Kahlo     |
+        |ADDR|123 South Street     |Sometown            |
+      DATA
+    end
+
+    let(:expected_records) do
+      [
+        { type_signature: "NAME", first_name: "Frida", last_name: "Kahlo" },
+        { type_signature: "ADDR", street_address: "123 South Street", city: "Sometown" }
+      ]
+    end
+
+    it_will "parse the data"
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pikelet
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.8
+  version: 2.0.0.beta.9
 platform: ruby
 authors:
 - John Carney