hash19 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4724f0d19cf83a8c0f6b220195ea126152b4f09e
-  data.tar.gz: a85c570dc019daf1f0cfb487cd62e5ab72569a5a
+  metadata.gz: 04b9042abb5650e9ee4e247e0c3539b6c5acf2f2
+  data.tar.gz: dbf0b31e2185441e35994eb2635dc3283e301edb
 SHA512:
-  metadata.gz: cb8d181a696c67a437691df48030c4c203487d396c3be66ae119ea960191f8d29d6e68cc5135a67d4943e3f836ca181f625e7678dc716e37e9c500bf2b61f022
-  data.tar.gz: 80bcb0601b44bfcfefa314f4eeac3577620123828d29187c344795ca67678e94e8bd1543b36626b3d0464662d08eebdcfd826cce466164314a6ca69b646bf992
+  metadata.gz: 1baa6df02fbd4ad2e90ae39ebc36cfdf9db31f4302a0664864275b24d975c46bd9056ed9137d91fed65430a5a4e9148733dbf2e9e1aa8326653fd76e1523a2ba
+  data.tar.gz: 902ca441b549ff9a037fd80dbf755acbf0e8309d3d198632f086d2e6cf32732244c99bdb59d098e4f65d8a31427da8505de38420ddcda9927d3a4b2e39b6292b

data/.travis.yml

@@ -2,4 +2,4 @@ language: ruby
 rvm:
   - ruby-2.1.1
   - ruby-2.1.2
-  - ruby-2.1.3
+  - ruby-2.1.3

data/README.md

@@ -1,5 +1,7 @@
 # Hash19
 [![Build Status](https://travis-ci.org/rcdexta/hash19.svg)](https://travis-ci.org/rcdexta/hash19)
+[![Gem Version](https://badge.fury.io/rb/hash19.svg)](http://badge.fury.io/rb/hash19)
+[![Coverage Status](https://img.shields.io/coveralls/rcdexta/hash19.svg)](https://coveralls.io/r/rcdexta/hash19)
 
 ![Hash-19](https://s3-us-west-1.amazonaws.com/rcdexta/hash-19-droid.png)
 
@@ -7,6 +9,8 @@
 
 Ahem.. Ahem.. So about this gem itself.. When I was writing an aggregation API that had to talk to multiple services each with their own REST end-points and JSON schema, when mashing up multiple hashes and transforming it to a structure acceptable to the consumer, I ended up writing lot of boiler plate code. I could see patterns and there was clearly scope for optimisation.
 
+A [detailed writeup](https://medium.com/@rcdexta/hash19-a-json-aggregation-library-f2ef43d64a86) explaining the need is available for reading.
+
 Hash19 is an attempt at offering a DSL to tame the JSON manipulation and help in dealing with common use-cases. The features include
 
 * whitelisting attributes
@@ -150,9 +154,17 @@ end
 ```
 If you notice the trigger, the `using` parameter denotes the attribute to use to fetch the association and the lambda passed to `trigger` will be invoked to fetch the association. This is lazy loaded, in the sense when a call is made to `.doctor` or `.to_h`, the trigger is fired.
 
+Associations also support alternate keys and aliasing... The below code snippet illustrates use of a different key in source json, the class to use to construct the object and the alias key in the target.
+
+```ruby
+has_one :child, key: :offspring, alias: :junior
+{offspring: {name: 'Luke Skywalker'}} # will be parsed as {'junior' => {'name' => 'Luke Skywalker'}}
+```
+
+
 ###4. Bulk Injections
 
-Left to itself with associations, when the root JSON is a large collection with none of the associations populated in the first place, there will several triggers fired for each item in the collection. This is the HTTP equivalent of `N+1` in the ORM world. To avoid this, Hash19 supports association injections. Let's dive into an example:
+Left to itself with associations, when the root JSON is a large collection with none of the associations populated in the first place, there will be several triggers fired for each item in the collection. This is the HTTP equivalent of `N+1` in the ORM world. To avoid this, Hash19 supports association injections. Let's dive into an example:
 
 ```ruby
 class SuperHeroes < Hashable
@@ -170,13 +182,13 @@ class SuperHeroes < Hashable
     def find_all(ids)..end #calls bulk API across wire. Implementation hidden
   end
 ```
-If you notice, `SuperHeroes` is a wrapper class around `SuperHero`. This is the object equivalent of a JSON collection. The `inject` method will extract `weapon_id` from all items in the collection and call the `trigger` and put back the resultant entities joining `superhero.weapon_id` and `weapon.id`
+If you notice, `SuperHeroes` is a wrapper class around `SuperHero`. This is the object equivalent of a JSON collection. The `inject` method will extract `weapon_id` from all items in the collection based on the json-path specified by `at` and call the `trigger` and put back the resultant entities joining `superhero.weapon_id` and `weapon.id`
 
 So, a json like below
-```json
-super_heroes = SuperHeroes.new([{name: 'iron man', power: 'none', weapon_id: 1},
-                                {name: 'thor', power: 'class 100', weapon_id: 2},
-                                {name: 'hulk', power: 'bulk', weapon_id: 3}])
+```ruby
+super_heros = SuperHeroes.new([{name: 'iron man', power: 'none', weapon_id: 1},
+				{name: 'thor', power: 'class 100', weapon_id: 2},
+				{name: 'hulk', power: 'bulk', weapon_id: 3}])
 ```
 
 will lead to one call to `Weapon#find_all` with params `[1,2,3]` to fetch all weapon details. And the final collection will be of the form:
@@ -186,7 +198,7 @@ super_heroes.to_h #[{'name' => 'iron man', 'power' => 'none', 'weapon' => {'name
                   #{'name' => 'hulk', 'power' => 'bulk', 'weapon' => {'name' => 'hands', 'id' => 3}}
 ```
 
-Note that `injection` always overrides the association trigger sinces the former is eager loaded and latter is lazy loaded thus avoiding the `N+1` calls. 
+Note that `injection` always overrides the association trigger since the former is eager loaded and latter is lazy loaded thus avoiding the `N+1` calls. 
 
 One other important thing to remember is that all the injections will happen in parallel. Hash19 uses [eldritch](https://github.com/beraboris/eldritch) gem to trigger multiple injections concurrently.
 

data/hash19.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'coveralls'
 
   spec.add_runtime_dependency 'jsonpath', '~> 0.5.6'
   spec.add_runtime_dependency 'eldritch'

data/lib/hash19/core.rb

@@ -14,7 +14,7 @@ module Hash19
         if payload.is_a? Array
           @hash19 = payload.map do |el|
             klass = resolve_class(self.class.contains_klass.to_s.camelize.singularize)
-            klass.send(:new, el).to_h(lazy: true)
+            klass.send(:new, el).to_h(true)
           end
         else
           hash = payload.with_indifferent_access
@@ -39,7 +39,7 @@ module Hash19
       end
     end
 
-    def to_h(lazy:false)
+    def to_h(lazy=false)
       return @hash19 if lazy
       if @hash19.is_a? Array
         @hash19.map { |hash| traverse_hash(hash) }

data/lib/hash19/resolvers.rb

@@ -16,13 +16,13 @@ module Hash19
         if association.present?
           klass = resolve_class(class_name.singularize)
           @hash19[opts[:alias] || name] = if type == :one
-                                            klass.send(:new, association).to_h(lazy: true)
+                                            klass.send(:new, association).to_h(true)
                                           elsif type == :many
-                                            association.map { |hash| klass.send(:new, hash).to_h(lazy: true) }
+                                            association.map { |hash| klass.send(:new, hash).to_h(true) }
                                           end
         else
           unless opts[:trigger]
-            puts "warning: Association:<#{name}> is not present in #{self.class.name}. Possible specify a trigger" 
+            # puts "warning: Association:<#{name}> is not present in #{self.class.name}. Probably a trigger is missing!" 
             next
           end
           puts "warning: Key:<#{opts[:using]}> not present in #{self.class.name}. Cannot map association:<#{name}>" unless @hash19.has_key? opts[:using]

data/lib/hash19/version.rb

@@ -1,3 +1,3 @@
 module Hash19
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
 require 'active_support/all'
 require 'pry'
 require 'hash19'
+require 'coveralls'
 
+Coveralls.wear!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash19
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - RC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jsonpath
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Hash helpers to map complex JSON to ruby objects. Handles associations and