hal-interpretation 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307909b10b6823175a275e546f52f1b2451db046
-  data.tar.gz: bb0969dc221c78829b4fec9f0f1029395a3875f1
+  metadata.gz: 7dd0ca8e27a6128646364bb2d2fc57d341652703
+  data.tar.gz: fe9fd9ad161ad54e5cfaa096c95bd2a3ae2005c6
 SHA512:
-  metadata.gz: c3cb5970235c8d729f3d7f4eaba0637cfce427fbefeb51f647cfc3f236df8c34e53046c17f3cbc778dacd13fac36a10f36d4783086ebd3282469f17631fb6bf9
-  data.tar.gz: 345c2f5de8ac2cad5f1fce84fd62848db9f8526bb762df1474fa8a957ad178d96ad4667c723ef3dbdcbe490081fe6bf55f1dfacec51e00f484f3cb7b93d8b9ad
+  metadata.gz: bb52b63015894a915d4cab0bf8636a935a2b499d51cff8d3eb9354a305bab97c209de37fe4ca385e822c7739cb23c3bfc1fda61846c719649d5f3c93ed4241b8
+  data.tar.gz: 0a21dcf648667768fc5ed137e7a9d64a5414778c08e474071a9f71fe7bc7acfc11f50b13703c2bebbcf7e4b7618ead28581d7e467931be345fe8650c84f9a426

data/lib/hal_interpretation/dsl.rb

@@ -11,12 +11,26 @@ module HalInterpretation
     # document.
     #
     # attr_name - name of attribute on model to extract
+    #
     # opts - hash of named arguments to method
-    #   :from - JSON path from which to get the value for 
-    #     attribute. Default: "/#{attr_name}"
+    #
+    #   :from - JSON path from which to get the value for
+    #     attribute. Default: "/#{attr_name}".
+    #
+    #   :with - Callable that can extract the value when
+    #     passed a HalClient::Representation of the item.
+    #
+    #   :coercion - callable with which the raw value should be
+    #     transformed before being stored.
     def extract(attr_name, opts={})
-      from = opts.fetch(:from) { "/#{attr_name}" }
-      extractors << Extractor.new(attr: attr_name, location: from)
+      extractor_opts = {
+        attr: attr_name,
+        location: opts.fetch(:from) { "/#{attr_name}" }
+      }
+      extractor_opts[:extraction_proc] = opts.fetch(:with) if opts.key? :with
+      extractor_opts[:coercion] = opts[:coercion] if opts.key? :coercion
+
+      extractors << Extractor.new(extractor_opts)
     end
   end
 end

data/lib/hal_interpretation/extractor.rb

@@ -4,11 +4,22 @@ module HalInterpretation
   class Extractor
     # opts - named args
     #   :attr - name of attribute this object will extact.
+    #
     #   :location - JSON path from which to get the value.
-    def initialize(opts) #attr:, location: "/#{attr}")
+    #
+    #   :extraction_proc - Callable that can extract the value when
+    #     passed a HalClient::Representation of the item.
+    #
+    #   :coercion - proc to pass the extracted value through before
+    #     storing it.
+    def initialize(opts)
       @attr = opts.fetch(:attr) { fail ArgumentError, "attr is required" }
       @location = opts.fetch(:location) { "/#{attr}" }
-      @pointer = Hana::Pointer.new(location)
+      @fetcher = opts.fetch(:extraction_proc) { Hana::Pointer.new(location).method(:eval) }
+      @value_coercion = opts.fetch(:coercion) { IDENTITY }
+
+      fail(ArgumentError, ":coercion must respond to #call") unless
+        value_coercion.respond_to? :call
     end
 
     # opts - named args
@@ -19,7 +30,8 @@ module HalInterpretation
     def extract(opts)
       from = opts.fetch(:from) { fail ArgumentError, "from is required" }
       to = opts.fetch(:to) { fail ArgumentError, "to is required" }
-      to.send "#{attr}=", pointer.eval(from)
+
+      to.send "#{attr}=", value_coercion.call(fetcher.call(from))
 
       []
     rescue => err
@@ -29,6 +41,8 @@ module HalInterpretation
     attr_reader :attr, :location
 
     protected
-    attr_reader :pointer
+    attr_reader :fetcher, :value_coercion
+
+    IDENTITY = ->(thing){ thing }
   end
-end
+end

data/lib/hal_interpretation/version.rb

@@ -1,3 +1,3 @@
 module HalInterpretation
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/hal_interpretation/extractor_spec.rb

@@ -0,0 +1,55 @@
+require_relative "../spec_helper"
+
+describe HalInterpretation::Extractor do
+  describe "creation" do
+    specify { expect{described_class.new(attr: "first_name", location: "/firstName")}
+      .not_to raise_error }
+    specify { expect{described_class.new(attr: "first_name", with: ->(hal_repr){ "bob" })}
+      .not_to raise_error }
+    specify { expect{described_class.new(attr: "first_name", location: "/firstName",
+                                         coercion: ->(){ 42 })}
+      .not_to raise_error }
+  end
+
+  context "location based" do
+    subject(:extractor) { described_class.new(attr: "first_name", location: "/firstName") }
+
+    specify { expect{extractor.extract(from: source, to: target)}.not_to raise_error }
+
+    context "after extraction" do
+      before do extractor.extract(from: source, to: target) end
+
+      specify { expect(target.first_name).to eq "Alice" }
+    end
+  end
+
+  context "lambda based" do
+    subject(:extractor) { described_class
+        .new(attr: "parent", location: "/_links/up",
+             extraction_proc: ->(hal_repr) {hal_repr.related_hrefs("up").first}) }
+
+    specify { expect{extractor.extract(from: source, to: target)}.not_to raise_error }
+
+    context "after extraction" do
+      before do extractor.extract(from: source, to: target) end
+
+      specify { expect(target.parent).to eq "http://foo" }
+    end
+  end
+
+  context "coercion" do
+    subject(:extractor) { described_class.new(attr: "bday",
+                                              coercion: ->(val){ Time.parse(val) } ) }
+    before do extractor.extract(from: source, to: target) end
+
+    specify { expect(target.bday).to eq Time.utc(2013,10,10,12,13,14) }
+  end
+
+
+  let(:target) { Struct.new(:first_name, :bday, :parent).new }
+  let(:source) { HalClient::Representation.new(parsed_json: {
+                                                 "firstName" => "Alice",
+                                                 "bday" => "2013-10-10T12:13:14Z",
+                                                 "_links" => {
+                                                   "up" => { "href" => "http://foo" }}}) }
+end

data/spec/hal_interpretation_spec.rb

@@ -11,20 +11,28 @@ describe HalInterpretation do
       item_class test_item_class
       extract :name
       extract :latitude, from: "/geo/latitude"
+      extract :up, with: ->(hal_repr){hal_repr.related_hrefs("up").first}, from: "/_links/up"
+      extract :bday, coercion: ->(val){ Time.parse(val) }
     end }
 
   context "valid single item" do
     let(:json_doc) { <<-JSON }
       { "name": "foo"
+        ,"bday": "2013-12-11T10:09:08Z"
         ,"geo": {
           "latitude": 39.1
         }
+        ,"_links": {
+          "up": {"href": "/foo"}
+        }
       }
     JSON
 
     specify { expect(interpreter.items).to have(1).item }
     specify { expect(interpreter.items.first.name).to eq "foo" }
     specify { expect(interpreter.items.first.latitude).to eq 39.1 }
+    specify { expect(interpreter.items.first.up).to eq "/foo" }
+    specify { expect(interpreter.items.first.bday).to eq Time.utc(2013,12,11,10,9,8) }
     specify { expect(interpreter.problems).to be_empty }
   end
 
@@ -32,14 +40,18 @@ describe HalInterpretation do
     let(:json_doc) { <<-JSON }
       { "_embedded": {
            "item": [{ "name": "foo"
+                      ,"bday": "2013-12-11T10:09:08Z"
                       ,"geo": {
                         "latitude": 39.1
                       }
+                      ,"_links": { "up": {"href": "/foo"} }
                     }
                     ,{ "name": "bar"
+                      ,"bday": "2013-12-11T10:09:08Z"
                       ,"geo": {
                         "latitude": 39.2
                       }
+                      ,"_links": { "up": {"href": "/bar"} }
                     }]
         }
       }
@@ -62,6 +74,7 @@ describe HalInterpretation do
       { "geo": {
           "latitude": "hello"
         }
+        ,"bday": "yesterday"
       }
     JSON
 
@@ -79,6 +92,8 @@ describe HalInterpretation do
         .to include matching(%r(/name\b)).and(match(/\bblank\b/i))  }
     specify { expect(interpreter.problems)
         .to include matching(%r(/geo/latitude\b)).and(match(/\binvalid value\b/i))  }
+    specify { expect(interpreter.problems)
+        .to include matching(%r(/bday\b)).and(match(/\bno time\b/i))  }
   end
 
   context "collection w/ invalid attributes" do
@@ -126,7 +141,7 @@ describe HalInterpretation do
   let(:test_item_class) { Class.new do
       include ActiveModel::Validations
 
-      attr_accessor :name, :latitude
+      attr_accessor :name, :latitude, :up, :bday
 
       def initialize
         yield self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-interpretation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hal-client
@@ -157,6 +157,7 @@ files:
 - lib/hal_interpretation/extractor.rb
 - lib/hal_interpretation/item_interpreter.rb
 - lib/hal_interpretation/version.rb
+- spec/hal_interpretation/extractor_spec.rb
 - spec/hal_interpretation_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pezra/hal-interpretation
@@ -184,5 +185,6 @@ signing_key:
 specification_version: 4
 summary: Build models from HAL documents.
 test_files:
+- spec/hal_interpretation/extractor_spec.rb
 - spec/hal_interpretation_spec.rb
 - spec/spec_helper.rb