hal-interpretation 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52c231b40d2b58c3c0b1a5c3256b1b3b4a9d2588
-  data.tar.gz: ae6b29f0cb4de045685d0934d37e84c555314ab7
+  metadata.gz: ddd4f4d59ce42087dfde97336e8ff4c2cd32a99f
+  data.tar.gz: c922581f34ac914205b687a8bbabc7be87678377
 SHA512:
-  metadata.gz: 4d8c1cf2fc169bc09f4847b41ef4a25101cbe0ded25b5f0a7d3f25d06503508ced8a4cda4b21a0db80f9f15a5fe5a6e3d8acaacfe7937b7c9f4beff7e4311e71
-  data.tar.gz: 44f5146b86da19be5961c16c5ec4aed8ffc7ae0de5a95c576951e6805285a12b91bccdf95058fe8ac96d992efb98f432caf3618ceea8a6a9a60d38283f8629d4
+  metadata.gz: a52862249331ca2ebce1be637e8c44cf6d1d2073f95922b857e99400b4666a3356751849fb3a7b45d8967163b941c9be6256f679aa79488b826486177fd68319
+  data.tar.gz: 45c8213ca0346ea609bd3c57d767969b03590211c5396b44402ab3c09b241d6eb26db89900978768d13fec298dd7f1129e3453e5af8967f44ecc720fa75aeedd

data/lib/hal_interpretation/extractor.rb

@@ -37,6 +37,8 @@ module HalInterpretation
       context = opts.fetch(:context, self)
 
       raw_val = context.instance_exec from, &fetcher
+      return [] unless raw_val
+
       val = context.instance_exec raw_val, &value_coercion
 
       to.public_send "#{attr}=", val

data/lib/hal_interpretation/item_interpreter.rb

@@ -54,13 +54,23 @@ module HalInterpretation
 
     def apply_validations(an_item)
       an_item.valid?
+
       an_item.errors.each do |attr, msg|
-        @problems << "#{json_path_for attr} #{msg}"
+        leader = begin
+                   json_path_for attr
+                 rescue KeyError
+                   "#{attr} [which is not directly extracted from JSON]"
+                 end
+
+        @problems << leader + " " + msg
       end
     end
 
     def json_path_for(attr)
-      json_pointer_join(location, extractor_for(attr).location)
+      extractor = extractor_for(attr)
+      raise KeyError unless extractor
+
+      json_pointer_join(location, extractor.location)
     end
 
     def json_pointer_join(head, tail)
@@ -71,4 +81,4 @@ module HalInterpretation
     end
   end
 
-end
+end

data/lib/hal_interpretation/version.rb

@@ -1,3 +1,3 @@
 module HalInterpretation
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/hal_interpretation/extractor_spec.rb

@@ -64,9 +64,26 @@ describe HalInterpretation::Extractor do
     specify { expect(target.bday).to eq Time.utc(2013,10,10,12,13,14) }
   end
 
+  context "basic attr" do
+    subject(:extractor) { described_class.new(attr: "age") }
 
-  let(:target) { Struct.new(:first_name, :bday, :parent, :seq).new }
+    before do extractor.extract(from: source, to: target) end
+
+    specify { expect(target.age).to eq 1 }
+  end
+
+  context "missing attr" do
+    subject(:extractor) { described_class.new(attr: "seq") }
+
+    before do extractor.extract(from: source, to: target) end
+
+    specify { expect(target.seq).to be_nil }
+  end
+
+
+  let(:target) { Struct.new(:first_name, :bday, :parent, :seq, :age).new }
   let(:source) { HalClient::Representation.new(parsed_json: {
+                                                 "age" => 1,
                                                  "firstName" => "Alice",
                                                  "bday" => "2013-10-10T12:13:14Z",
                                                  "_links" => {

data/spec/hal_interpretation_spec.rb

@@ -13,6 +13,16 @@ describe HalInterpretation do
       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) }
+      extract :seq, with: ->(_) { next_seq_num }
+
+      def initialize(*args)
+        @cur_seq_num = 0
+        super
+      end
+
+      def next_seq_num
+        @cur_seq_num += 1
+      end
     end }
 
   context "valid single item" do
@@ -33,6 +43,7 @@ describe HalInterpretation do
     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.items.first.seq).to eq 1 }
     specify { expect(interpreter.problems).to be_empty }
   end
 
@@ -61,6 +72,8 @@ describe HalInterpretation do
     specify { expect(interpreter.items).to have(2).items }
     specify { expect(interpreter.items).to include item_named "foo" }
     specify { expect(interpreter.items).to include item_named "bar" }
+    specify { expect(interpreter.items[0].seq).to eq 1 }
+    specify { expect(interpreter.items[1].seq).to eq 2 }
 
     matcher :item_named do |expected_name|
       match do |obj|
@@ -128,6 +141,42 @@ describe HalInterpretation do
         .to include matching(%r(/geo/latitude\b)).and(match(/\bblank\b/i))  }
   end
 
+  context "missing non-required member" do
+    let(:json_doc) { <<-JSON }
+      { "name": "nowhere"
+        ,"geo": {
+          "latitude": 13.12
+        }
+        ,"_links": {
+          "up": { "href": "http://example.com/" }
+        }
+      }
+    JSON
+
+    specify { expect(interpreter.problems).to be_empty }
+  end
+
+  context "validation failure on unmapped attr" do
+    let(:json_doc) { <<-JSON }
+      { "name": "nowhere"
+        ,"geo": {
+          "latitude": 13.12
+        }
+        ,"_links": {
+          "up": { "href": "http://example.com/" }
+        }
+      }
+    JSON
+
+    before do
+      test_item_class.class_eval "validates :hair, presence: true"
+    end
+
+    specify { expect{interpreter.items}
+        .to raise_exception HalInterpretation::InvalidRepresentationError}
+    specify { expect(interpreter.problems)
+        .to include matching(/hair/).and(match(/\bblank\b/i))  }
+  end
 
   context "non-json doc" do
     let(:non_json_doc) { "what's json" }
@@ -141,7 +190,7 @@ describe HalInterpretation do
   let(:test_item_class) { Class.new do
       include ActiveModel::Validations
 
-      attr_accessor :name, :latitude, :up, :bday
+      attr_accessor :name, :latitude, :up, :bday, :seq, :hair
 
       def initialize
         yield self

metadata

@@ -1,139 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: hal-interpretation
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Peter Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-18 00:00:00.000000000 Z
+date: 2014-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hal-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: '2.2'
 - !ruby/object:Gem::Dependency
   name: hana
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 description: Declarative creation of ActiveModels from HAL documents.
@@ -143,8 +143,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -170,17 +170,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Build models from HAL documents.