hal-interpretation 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969e94cd36e156d8a8dacc0c6cf90489d3360e35
-  data.tar.gz: 26ec24e354607d6cbe2f59a0f4c2641afcb718d1
+  metadata.gz: 5d0bb8bd69d4f918747724f90a4fa6099a8902a5
+  data.tar.gz: a7b3dba7c022043f163e222f124867805f28d20d
 SHA512:
-  metadata.gz: 2f1065997cfd989a531013c6051cbe3f2cf8df53f3160c8b102aea3ceb21bb26432f27cece18b603ac171e1e1909a05427dcf532d2686d6ace4e2d1adfadd3fe
-  data.tar.gz: bcfd8283a0e51b661f214e937dd7633e4d85ce375e8ca48d7d39cca48ff18c22c9292fb0e6a27ea809ca8636d130b67143299e06ec776a7e6207a859e2d8a723
+  metadata.gz: 58cc7ed92a124e87edc19a071e109ff35de963a905849b11774c6e3772ba7a799131dbfd1a2872c2d9cc2d0b940e2a0bc5fbb2680f9a020596cf8c41c5b4ca50
+  data.tar.gz: 0ac2e4aff92dd46c3eea872a36210938e33a7900d4f3be90e9d2a56689d4002c9ccd099d1e83306cfd8e1ba91bbab7ea4dd043033080a2e803ec61c578b65057

data/lib/hal_interpretation.rb

@@ -66,9 +66,16 @@ module HalInterpretation
   # opts
   #   :location - The json path of `a_representation` in the
   #     complete document
+  #
+  # optionally implement `#handle_initialization_opts` for custom option parsing
   def initialize(a_representation, opts)
     @repr = a_representation
     @location = opts.fetch(:location) { raise ArgumentError, "location is required" }
+    handle_initialization_opts(opts)
+  end
+
+  # allows custom setting of options on initialization
+  def handle_initialization_opts(opts)
   end
 
   attr_reader :repr, :location
@@ -104,9 +111,9 @@ module HalInterpretation
     #
     # Raises HalInterpretation::InvalidRepresentationError if the
     #   provided JSON document is not parseable
-    def new_from_json(json)
-      self.new HalClient::Representation.new(parsed_json: MultiJson.load(json)),
-               location: "/"
+    def new_from_json(json, opts = {})
+      repr = HalClient::Representation.new(parsed_json: MultiJson.load(json))
+      self.new repr, opts.merge(location: "/")
 
     rescue MultiJson::ParseError => err
       fail InvalidRepresentationError, "Parse error: " + err.message

data/lib/hal_interpretation/dsl.rb

@@ -134,14 +134,14 @@ module HalInterpretation
     #
     # Examples
     #
-    #     extract_repr :author,
+    #     extract_related :author,
     #                   rel: "http://xmlns.com/foaf/0.1/Person"
     #
     # extracts the targets of the `.../Person` link and stores the
     # corresponding HAL representation object in the `author`
     # attribute of the model.
     #
-    #     extract_repr :author, rel: "http://xmlns.com/foaf/0.1/Person",
+    #     extract_related :author, rel: "http://xmlns.com/foaf/0.1/Person",
     #                   coercion: ->(person_repr) {
     #                     MyInterpretation.new(person_repr)
     #                   }
@@ -168,14 +168,14 @@ module HalInterpretation
     #
     # Examples
     #
-    #     extract_reprs :authors,
+    #     extract_relateds :authors,
     #                    rel: "http://exampe.com/authors"
     #
     # extracts the targets of the `.../authors` link and stores the
     # corresponding HAL representation set object in the `authors`
     # attribute of the model.
     #
-    #     extract_reprs :authors, rel: "http://example.com/authors",
+    #     extract_relateds :authors, rel: "http://example.com/authors",
     #       coercion: ->(person_repr_set) {
     #         person_repr_set.map {|repr| MyInterpretation.new(repr)}
     #       }

data/lib/hal_interpretation/version.rb

@@ -1,3 +1,3 @@
 module HalInterpretation
-  VERSION = "1.8.1"
+  VERSION = "1.9.0"
 end

data/spec/hal_interpretation_spec.rb

@@ -14,10 +14,11 @@ describe HalInterpretation do
       extract :latitude, from: "/geo/latitude"
       extract :bday, coercion: ->(val){ Time.parse(val) }
       extract :seq, with: ->(_) { next_seq_num }
-      extract_link  :up
+      extract_link  :up, rel: "up", coercion: ->(url) { @override_up || url }
       extract_links :friend_ids, rel: "http://xmlns.com/foaf/0.1/knows",
                     coercion: ->(urls) { urls.map{|u| u.split("/").last } }
       extract_link :archives_url_tmpl, rel: "archives"
+
       extract_related :profile, rel: "http://xmlns.com/foaf/0.1/Person"
       extract_relateds :cohorts, rel: "http://xmlns.com/foaf/0.1/knows"
 
@@ -29,6 +30,10 @@ describe HalInterpretation do
       def next_seq_num
         @cur_seq_num += 1
       end
+
+      def handle_initialization_opts(opts)
+        @override_up = opts.fetch(:override_up, nil)
+      end
     end
   }
 
@@ -116,6 +121,36 @@ describe HalInterpretation do
     end
   end
 
+  context "with initialization options" do
+    let(:json_doc_with_links) { <<-JSON }
+          { "name": "foo"
+            ,"bday": "2013-12-11T10:09:08Z"
+            ,"geo": {
+              "latitude": 39.1
+            }
+            ,"_links": {
+              "up": { "href": "/foo" }
+            }
+          }
+    JSON
+
+    let(:json_doc_without_links) { <<-JSON }
+          { "name": "foo"
+            ,"bday": "2013-12-11T10:09:08Z"
+            ,"geo": {
+              "latitude": 39.1
+            }
+          }
+    JSON
+
+    let(:opts) { { override_up: "/new_parent"} }
+    let(:interpreter_with_links) { interpreter_class.new_from_json(json_doc_with_links, opts) }
+    let(:interpreter_without_links) { interpreter_class.new_from_json(json_doc_without_links, opts) }
+
+    specify { expect(interpreter_with_links.item.up).to eq("/new_parent") }
+    specify { expect(interpreter_without_links.item.up).to eq("/new_parent") }
+  end
+
   context "valid collection" do
     let(:json_doc) { <<-JSON }
       { "_embedded": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hal-interpretation
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hal-client
@@ -180,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Build models from HAL documents.
@@ -188,4 +188,3 @@ test_files:
 - spec/hal_interpretation/extractor_spec.rb
 - spec/hal_interpretation_spec.rb
 - spec/spec_helper.rb
-has_rdoc: