kartograph 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b117d28ec0561cefabaf740af34ebfb3cf48a68
-  data.tar.gz: 8874d274b2b788ebbd2c0e79a748c29cdd226e25
+  metadata.gz: 0295131c24571bb5b97074b8c6ddb293d6e6e5c5
+  data.tar.gz: c54a19d0f60e9671b01f46dc7c3e22e9336f4a1d
 SHA512:
-  metadata.gz: b36df369277c0088da9f2fa895ef0ed1640a3c369beab8fc8286480c5f47bc3b98a5fe5e62a19621fc60a5372519df07336a98ce5b1135c06c6c041254709e57
-  data.tar.gz: ec90464e0b3402ac70249f44d96d5a78f19899c681674cb911043bbbc6b4e607eabaa1db7b03b9d5b590330d6050fedd7698caf27fa4450ad8a66b58bdf8cf00
+  metadata.gz: 1f9810e797d94884d70753280442945dd1c8a05fc956d0e545e81fed318fdf087468ad315b60ecc98a8bbd3967f8ad82a0234ace82b75ace8b1e9146f5e3c1d7
+  data.tar.gz: 31cd1b4efc22648129ee836936bd90e42ee428ae351526784ae3e307d7148e473558a3982768b8d9137e530d08a50622525410a3d40b5912cc4f1615b587276f

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+.pairs

data/README.md

@@ -36,6 +36,17 @@ user = User.new(name: 'Bobby Tables')
 json_for_create = UserMapping.representation_for(:create, user)
 ```
 
+### Rendering Collections as JSON
+
+```ruby
+user = User.new(name: 'Bobby Tables')
+users = Array.new(10, user)
+
+json = UserMapping.represent_collection_for(:read, users)
+```
+
+---
+
 Some API's will give you the created resource back as JSON as well on a successful create. For that, you may do something like this:
 
 ```ruby
@@ -93,7 +104,7 @@ class UserMapping
 
   kartograph do
     mapping User
-    root_key singular: 'user', plural: 'users' scopes: [:read]
+    root_key singular: 'user', plural: 'users', scopes: [:read]
     property :id, scopes: [:read]
   end
 end

data/examples/collection_representation.rb

@@ -0,0 +1,41 @@
+require 'kartograph'
+require 'pp'
+
+class User < Struct.new(:id, :name, :comments)
+end
+
+class Comment < Struct.new(:id, :text)
+end
+
+class UserMapping
+  include Kartograph::DSL
+
+  kartograph do
+    mapping User
+
+    property :id, scopes: [:read]
+    property :name, scopes: [:read, :create]
+
+    property :comments, plural: true, scopes: [:read] do
+      mapping Comment
+
+      property :id, scopes: [:read]
+      property :text, scopes: [:read, :create]
+    end
+  end
+end
+
+user = User.new(1, 'he@he.com')
+comment = Comment.new(12, 'aksjdfhasjkdfh')
+
+user.comments = Array.new(3, comment)
+users = Array.new(4, user)
+
+json = UserMapping.represent_collection_for(:read, users)
+puts "The JSON generated from that collection:"
+puts json
+
+users_again = UserMapping.extract_collection(json, :read)
+puts "\n"
+puts "And the JSON slurped back into an array:"
+pp users_again

data/lib/kartograph/dsl.rb

@@ -18,12 +18,15 @@ module Kartograph
       def representation_for(scope, object, dumper = JSON)
         drawed = Artist.new(object, @kartograph_map).draw(scope)
 
-        retrieve_root_key(scope, :singular) do |root_key|
-          # Reassign drawed if a root key exists
-          drawed = { root_key => drawed }
+        dumper.dump(prepend_root_key(scope, :singular, drawed))
+      end
+
+      def represent_collection_for(scope, objects, dumper = JSON)
+        drawed_objects = objects.map do |object|
+          Artist.new(object, @kartograph_map).draw(scope)
         end
 
-        dumper.dump(drawed)
+        dumper.dump(prepend_root_key(scope, :plural, drawed_objects))
       end
 
       def extract_single(content, scope, loader = JSON)
@@ -51,12 +54,21 @@ module Kartograph
       end
 
       private
+      def prepend_root_key(scope, plurality, payload)
+        retrieve_root_key(scope, plurality) do |root_key|
+          # Reassign drawed if a root key exists
+          payload = { root_key => payload }
+        end
+
+        payload
+      end
 
       def retrieve_root_key(scope, type, &block)
         if root_key = @kartograph_map.root_key_for(scope, type)
           yield root_key
         end
       end
+
     end
   end
 end

data/lib/kartograph/version.rb

@@ -1,4 +1,4 @@
 module Kartograph
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end
 

data/spec/lib/kartograph/dsl_spec.rb

@@ -48,6 +48,49 @@ describe Kartograph::DSL do
     end
   end
 
+  describe '.represent_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' do
+      json = mapped.represent_collection_for(:read, users)
+      parsed = JSON.parse(json)
+
+      expect(parsed).to be_an(Array)
+      expect(parsed.size).to be(3)
+
+      expect(parsed[0]['id']).to   eq(users[0].id)
+      expect(parsed[0]['name']).to eq(users[0].name)
+      expect(parsed[1]['id']).to   eq(users[1].id)
+      expect(parsed[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
+
+        expect(parsed).to be_an(Hash)
+        expect(parsed.keys.first).to eq(root_key_name)
+
+        parsed_array = parsed[root_key_name]
+        expect(parsed_array[0]['id']).to   eq(users[0].id)
+        expect(parsed_array[0]['name']).to eq(users[0].name)
+        expect(parsed_array[1]['id']).to   eq(users[1].id)
+        expect(parsed_array[1]['name']).to eq(users[1].name)
+      end
+    end
+  end
+
   describe '.extract_single' do
     include_context 'DSL Objects'
     let(:json) do

data/spec/support/dummy_user.rb

@@ -1 +1,2 @@
-DummyUser = Struct.new(:id, :name, :comment, :email)
+class DummyUser < Struct.new(:id, :name, :comment, :email)
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: kartograph
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-13 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   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'
 description: Kartograph makes it easy to generate and convert JSON. It's intention
@@ -75,13 +75,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/collection_representation.rb
 - examples/domains.rb
 - examples/representation_for.rb
 - kartograph.gemspec
@@ -117,12 +118,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []