kartograph 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 058669bff932d817f5f55ba0db31eae00a6176c8
-  data.tar.gz: 13ce3561911df10ec3bcbf972e929cf4171b7a42
+  metadata.gz: 34cf2d2347f433eb341a3ff291db0897542b44fa
+  data.tar.gz: 587af332800ff4eaec9fb7a685e74379557d6091
 SHA512:
-  metadata.gz: ea8f25bb8ab823fe9c2206cab7afb3f2626f1ad233d7fcdcfd6eb9781d5e7e521fd65d5e2d7b056297f129bc863f0ad3fdc054a06410aabd18d434038bd0b422
-  data.tar.gz: 547d95b3446781a52e56b3e75e8ff56dfa932a4aad52effdaa76fdf4d9f290f65aa966c8ebe5b35c8281dbf3fb5db53eeaf3c2c592b9f18809fcbcd34f2c6409
+  metadata.gz: b6d58d31c6519e3ef49a301429370294b95c4b9c2cbf7b26b2a64943fa17f802ac98f7f8e1cd8ab3bdd16f786105fd0c4140d416ccb7b2bc35d25e05d351f37d
+  data.tar.gz: d3a4ae339b1fa2f2815efc101e1db7a60b6edfd75bafa3b0afe2f6d3a13b9735ae445a5b5eaccae2ed47d95a0d0460dfb9265abf52b582c9536a6a417343e62e

data/README.md

@@ -36,6 +36,16 @@ user = User.new(name: 'Bobby Tables')
 json_for_create = UserMapping.representation_for(:create, user)
 ```
 
+### Rendering Objects or Collections as Hashes
+
+```ruby
+user = User.new(name: 'PB Jelly')
+users = [user]
+
+hash = UserMapping.hash_for(:read, user)
+hash_collection = UserMapping.hash_collection_for(:read, user)
+```
+
 ### Rendering Collections as JSON
 
 ```ruby

data/lib/kartograph/dsl.rb

@@ -15,18 +15,35 @@ module Kartograph
         @kartograph_map
       end
 
-      def representation_for(scope, object, dumper = Kartograph.default_dumper)
-        drawed = Artist.new(object, @kartograph_map).draw(scope)
-
-        dumper.dump(prepend_root_key(scope, :singular, drawed))
+      # Returns a hash representation of the object based on the mapping
+      #
+      # @param scope [Symbol] the scope of the mapping
+      # @param object the object to be mapped
+      # @return [Hash, Array]
+      def hash_for(scope, object)
+        drawn_object = Artist.new(object, @kartograph_map).draw(scope)
+        prepend_root_key(scope, :singular, drawn_object)
       end
 
-      def represent_collection_for(scope, objects, dumper = Kartograph.default_dumper)
-        drawed_objects = objects.map do |object|
+      # Returns a hash representation of the collection of objects based on the mapping
+      #
+      # @param scope [Symbol] the scope of the mapping
+      # @params objects [Array] the array of objects to be mapped
+      # @return [Hash, Array]
+      def hash_collection_for(scope, objects)
+        drawn_objects = objects.map do |object|
           Artist.new(object, @kartograph_map).draw(scope)
         end
 
-        dumper.dump(prepend_root_key(scope, :plural, drawed_objects))
+        prepend_root_key(scope, :plural, drawn_objects)
+      end
+
+      def representation_for(scope, object, dumper = Kartograph.default_dumper)
+        dumper.dump(hash_for(scope, object))
+      end
+
+      def represent_collection_for(scope, objects, dumper = Kartograph.default_dumper)
+        dumper.dump(hash_collection_for(scope, objects))
       end
 
       def extract_single(content, scope, loader = Kartograph.default_loader)
@@ -40,6 +57,19 @@ module Kartograph
         Sculptor.new(loaded, @kartograph_map).sculpt(scope)
       end
 
+      def extract_into_object(object, content, scope, loader = Kartograph.default_loader)
+        loaded = loader.load(content)
+
+        retrieve_root_key(scope, :singular) do |root_key|
+          # Reassign loaded if a root key exists
+          loaded = loaded[root_key]
+        end
+
+        sculptor = Sculptor.new(loaded, @kartograph_map)
+        sculptor.sculpted_object = object
+        sculptor.sculpt(scope)
+      end
+
       def extract_collection(content, scope, loader = Kartograph.default_loader)
         loaded = loader.load(content)
 
@@ -71,4 +101,4 @@ module Kartograph
 
     end
   end
-end
+end

data/lib/kartograph/property.rb

@@ -20,7 +20,7 @@ module Kartograph
     end
 
     def key
-      options[:key] || name
+      (options[:key] || name).to_s
     end
 
     def value_for(object, scope = nil)
@@ -31,7 +31,7 @@ module Kartograph
 
     def value_from(object, scope = nil)
       return if object.nil?
-      value = object.has_key?(key) ? object[key] : object[key.to_s]
+      value = object.has_key?(key) ? object[key] : object[key.to_sym]
       map ? sculpt_value(value, scope) : value
     end
 

data/lib/kartograph/sculptor.rb

@@ -11,14 +11,25 @@ module Kartograph
       map.properties
     end
 
+    def sculpted_object
+      # Fallback initialization of the object we're extracting into
+      @sculpted_object ||= map.mapping.new
+    end
+
+    # Set this to pass in an object to extract into. Must
+    # @param object must be of the same class as the map#mapping
+    def sculpted_object=(object)
+      raise ArgumentError unless object.is_a?(map.mapping)
+
+      @sculpted_object = object
+    end
+
     def sculpt(scope = nil)
       return nil if @object.nil?
 
-      # Initializing the object we're coercing so we can set attributes on it
-      coerced = map.mapping.new
       scoped_properties = scope ? properties.filter_by_scope(scope) : properties
 
-      scoped_properties.each_with_object(coerced) do |property, mutable|
+      scoped_properties.each_with_object(sculpted_object) do |property, mutable|
         setter_method = "#{property.name}="
         value = property.value_from(object, scope)
         mutable.send(setter_method, value)

data/lib/kartograph/version.rb

@@ -1,4 +1,4 @@
 module Kartograph
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end
 

data/spec/lib/kartograph/artist_spec.rb

@@ -24,7 +24,7 @@ describe Kartograph::Artist do
       artist = Kartograph::Artist.new(object, map)
       masterpiece = artist.draw
 
-      expect(masterpiece).to include(hello: 'world')
+      expect(masterpiece).to include('hello' => 'world')
     end
 
     it 'raises for a property that the object does not have' do
@@ -43,7 +43,7 @@ describe Kartograph::Artist do
         artist = Kartograph::Artist.new(object, map)
         masterpiece = artist.draw
 
-        expect(masterpiece).to include(hola: 'world')
+        expect(masterpiece).to include('hola' => 'world')
       end
     end
 
@@ -56,7 +56,7 @@ describe Kartograph::Artist do
         artist = Kartograph::Artist.new(object, map)
         masterpiece = artist.draw(:read)
 
-        expect(masterpiece).to eq(hello: 'world')
+        expect(masterpiece).to eq('hello' => 'world')
       end
 
       context 'on nested properties' do
@@ -74,7 +74,7 @@ describe Kartograph::Artist do
           artist = Kartograph::Artist.new(object, map)
           masterpiece = artist.draw(:read)
 
-          expect(masterpiece).to eq(child: { foo: child.foo })
+          expect(masterpiece).to eq('child' => { 'foo' => child.foo })
         end
       end
     end
@@ -111,4 +111,4 @@ describe Kartograph::Artist do
       end
     end
   end
-end
+end

data/spec/lib/kartograph/dsl_spec.rb

@@ -20,6 +20,76 @@ describe Kartograph::DSL do
     end
   end
 
+  describe '.hash_for' do
+    include_context 'DSL Objects'
+
+    it 'returns the hash representation for an object' do
+      hash = mapped.hash_for(:create, object)
+      expect(hash).to eq({ 'name' => object.name })
+    end
+
+    context 'with a root key for the scope' do
+      it 'returns the hash with the root key' do
+        mapped.kartograph do
+          root_key singular: 'user', scopes: [:create]
+        end
+        hash = mapped.hash_for(:create, object)
+
+        expect(hash).to eq(
+          {
+            'user' => {
+              'name' => object.name
+            }
+          }
+        )
+      end
+    end
+  end
+
+  describe '.hash_collection_for' do
+    include_context 'DSL Objects'
+
+    let(:users) { Array.new(3, object) }
+
+    subject(:parsed) do
+      json = mapped.represent_collection_for(:read, users)
+      JSON.parse(json)
+    end
+
+    it 'returns the objects as a collection of hashes' do
+      collection = mapped.hash_collection_for(:read, users)
+
+      expect(collection).to be_an(Array)
+      expect(collection.size).to be(3)
+
+      expect(collection[0]['id']).to   eq(users[0].id)
+      expect(collection[0]['name']).to eq(users[0].name)
+      expect(collection[1]['id']).to   eq(users[1].id)
+      expect(collection[1]['name']).to eq(users[1].name)
+    end
+
+    context 'with a root key' do
+      it "includes the root key" do
+        root_key_name = "the_root_key"
+
+        mapped.kartograph do
+          root_key plural: root_key_name, scopes: [:read]
+        end
+
+        collection = mapped.hash_collection_for(:read, users)
+
+        expect(collection).to be_an(Hash)
+        expect(collection.keys.first).to eq(root_key_name)
+
+        collection_array = collection[root_key_name]
+        expect(collection_array[0]['id']).to   eq(users[0].id)
+        expect(collection_array[0]['name']).to eq(users[0].name)
+        expect(collection_array[1]['id']).to   eq(users[1].id)
+        expect(collection_array[1]['name']).to eq(users[1].name)
+      end
+    end
+  end
+
   describe '.representation_for' do
     include_context 'DSL Objects'
 
@@ -122,6 +192,21 @@ describe Kartograph::DSL do
     end
   end
 
+  describe '.extract_into_object' do
+    include_context 'DSL Objects'
+    let(:json) do
+      { id: 1337, name: 'Paul the octopus' }
+    end
+
+    it 'returns a populated object from a JSON representation' do
+      object = DummyUser.new
+      mapped.extract_into_object(object, json.to_json, :read)
+
+      expect(object.id).to eq(1337)
+      expect(object.name).to eq('Paul the octopus')
+    end
+  end
+
   describe '.extract_collection' do
     include_context 'DSL Objects'
     let(:json) do
@@ -169,4 +254,4 @@ describe Kartograph::DSL do
       end
     end
   end
-end
+end

data/spec/lib/kartograph/property_spec.rb

@@ -9,7 +9,7 @@ describe Kartograph::Property do
       property = Kartograph::Property.new(name, options)
       expect(property.name).to eq(name)
       expect(property.options).to eq(options)
-      expect(property.key).to eq(:hey)
+      expect(property.key).to eq('hey')
     end
 
     context 'with a key' do
@@ -89,7 +89,7 @@ describe Kartograph::Property do
         child = double('child', cephalopod: 'I will ink you')
         root = double('root', sammy: child)
 
-        expect(top_level.value_for(root)).to eq(cephalopod: child.cephalopod)
+        expect(top_level.value_for(root)).to eq('cephalopod' => child.cephalopod)
       end
 
       context 'when it is plural' do
@@ -104,8 +104,8 @@ describe Kartograph::Property do
           root = double('root', sammy: [child1, child2])
 
           expect(top_level.value_for(root)).to eq([
-            { cephalopod: child1.cephalopod },
-            { cephalopod: child2.cephalopod }
+            { 'cephalopod' => child1.cephalopod },
+            { 'cephalopod' => child2.cephalopod }
           ])
         end
       end

data/spec/lib/kartograph/sculptor_spec.rb

@@ -13,6 +13,40 @@ describe Kartograph::Sculptor do
     end
   end
 
+  describe '#sculpted_object=' do
+    context 'objects that are not the mapping class' do
+      it 'raises an error' do
+        hash = {}
+        map = double(Kartograph::Map, mapping: Hash)
+
+        sculptor = Kartograph::Sculptor.new(hash, map)
+
+        expect {
+          sculptor.sculpted_object = ""
+        }.to raise_error(ArgumentError)
+      end
+    end
+
+    it 'sets the sculpted_object' do
+      hash = {}
+      map = double(Kartograph::Map, mapping: Hash)
+
+      sculptor = Kartograph::Sculptor.new(hash, map)
+      sculptor.sculpted_object = hash
+      expect(sculptor.sculpted_object).to be hash
+    end
+  end
+
+  describe '#sculpted_object' do
+    it 'initializes the mapping class' do
+      hash = {}
+      map = double(Kartograph::Map, mapping: Hash)
+
+      sculptor = Kartograph::Sculptor.new(hash, map)
+      expect(sculptor.sculpted_object).to be_kind_of(Hash)
+    end
+  end
+
   describe '#sculpt' do
     let(:map) { Kartograph::Map.new }
     let(:object) { { 'id' => 343, 'name' => 'Guilty Spark', 'email_address' => 'guilty@bungie.net' } }
@@ -39,6 +73,15 @@ describe Kartograph::Sculptor do
         expect(sculpted.name).to eq(object['name'])
         expect(sculpted.email).to eq(object['email_address'])
       end
+
+      it 'sculpts into a provided object' do
+        sculptor = Kartograph::Sculptor.new(object, map)
+        dummy = DummyUser.new
+        sculptor.sculpted_object = dummy
+        sculpted = sculptor.sculpt
+
+        expect(sculpted).to be dummy
+      end
     end
 
     context 'with a scope' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kartograph
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Kartograph makes it easy to generate and convert JSON. It's intention is