kartograph 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca1d38c7c5914edc0a9b78ffed7701e8b3cefff7
-  data.tar.gz: 386c0e6f38402b271d00907596052e34327c1ca4
+  metadata.gz: 4b117d28ec0561cefabaf740af34ebfb3cf48a68
+  data.tar.gz: 8874d274b2b788ebbd2c0e79a748c29cdd226e25
 SHA512:
-  metadata.gz: 254b47f2276dea83ef2e3de5ec260cc1ab3d6ed57a557382d725c1ee2d566f3e5f505ad4daacba0015e4112d63cee3b713e362a56115fb759f3b192516305eaa
-  data.tar.gz: 4a307fb10db634870adaa9f3d9c291803ace606f299e27a46cb91d45466203d17a33bd6b7d614541e517059af624b1db210e3ad3e92230f6702fe11d7d62a7b5
+  metadata.gz: b36df369277c0088da9f2fa895ef0ed1640a3c369beab8fc8286480c5f47bc3b98a5fe5e62a19621fc60a5372519df07336a98ce5b1135c06c6c041254709e57
+  data.tar.gz: ec90464e0b3402ac70249f44d96d5a78f19899c681674cb911043bbbc6b4e607eabaa1db7b03b9d5b590330d6050fedd7698caf27fa4450ad8a66b58bdf8cf00

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0

data/README.md

@@ -2,6 +2,8 @@
 
 A Serialization / Deserialization library.
 
+[![Build Status](https://travis-ci.org/digitaloceancloud/kartograph.svg?branch=master)](https://travis-ci.org/digitaloceancloud/kartograph)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -134,6 +136,30 @@ class CommentMapping
 end
 ```
 
+
+### Scope blocks
+
+Sometimes adding scopes to all properties can be tedious, to avoid that, you can define properties within a scope block.
+
+```ruby
+class UserMapping
+  include Kartograph::DSL
+
+  kartograph do
+    scoped :read do
+      property :name
+      property :id
+      property :email, key: 'email_address' # The JSON returned has the key of email_address, our property is called email however.
+    end
+
+    scoped :update, :create do
+      property :name
+      property :email, key: 'email_address'
+    end
+  end
+end
+```
+
 Now when JSON includes comments for a user, it will know how to map the comments using the provided Kartograph definition.
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/kartograph.rb

@@ -7,6 +7,7 @@ module Kartograph
   autoload :Property, 'kartograph/property'
   autoload :PropertyCollection, 'kartograph/property_collection'
   autoload :RootKey, 'kartograph/root_key'
+  autoload :ScopeProxy, 'kartograph/scope_proxy'
 
   autoload :Artist, 'kartograph/artist'
   autoload :Sculptor, 'kartograph/sculptor'

data/lib/kartograph/map.rb

@@ -11,6 +11,11 @@ module Kartograph
       @properties ||= PropertyCollection.new
     end
 
+    def scoped(*scopes, &block)
+      proxy = ScopeProxy.new(self, scopes)
+      proxy.instance_eval(&block)
+    end
+
     def root_keys
       @root_keys ||= []
     end

data/lib/kartograph/property.rb

@@ -25,6 +25,7 @@ module Kartograph
 
     def value_for(object, scope = nil)
       value = object.send(name)
+      return if value.nil?
       map ? artist_value(value, scope) : value
     end
 

data/lib/kartograph/scope_proxy.rb

@@ -0,0 +1,17 @@
+module Kartograph
+  class ScopeProxy
+    attr_reader :map, :scopes
+
+    def initialize(map, scopes)
+      @map, @scopes = map, scopes
+    end
+
+    def property(*args, &block)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      options[:scopes] = scopes
+      args << options
+
+      map.property(*args, &block)
+    end
+  end
+end

data/lib/kartograph/version.rb

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

data/spec/lib/kartograph/map_spec.rb

@@ -92,4 +92,17 @@ describe Kartograph::Map do
       expect(map1).to eq(map2)
     end
   end
+
+  describe '#scoped' do
+    it 'adds properties with the scopes defined on the block instantiation' do
+      map.scoped :read, :write do
+        property :name
+        property :something
+      end
+
+      expect(map.properties.size).to eq(2)
+      expect(map.properties.filter_by_scope(:read).map(&:name)).to eq([:name, :something])
+      expect(map.properties.filter_by_scope(:write).map(&:name)).to eq([:name, :something])
+    end
+  end
 end

data/spec/lib/kartograph/property_spec.rb

@@ -109,6 +109,18 @@ describe Kartograph::Property do
           ])
         end
       end
+
+      context 'when the value for the root object is nil' do
+        it 'returns nil' do
+          top_level = Kartograph::Property.new(:sammy) do
+            property :cephalopod
+          end
+
+          root = double(sammy: nil)
+
+          expect(top_level.value_for(root)).to be_nil
+        end
+      end
     end
   end
 

data/spec/lib/kartograph/scope_proxy_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+RSpec.describe Kartograph::ScopeProxy do
+  describe '#initialize' do
+    it 'initializes with a map, scopes, and a block' do
+      map, scopes = double, [:read, :write]
+
+      instance = Kartograph::ScopeProxy.new(map, scopes)
+
+      expect(instance.map).to be(map)
+      expect(instance.scopes).to be(scopes)
+    end
+  end
+
+  describe '#property' do
+    let(:map) { Kartograph::Map.new }
+    subject(:proxy) { Kartograph::ScopeProxy.new(map, [:read, :write]) }
+
+    it 'adds a property to the properties with the correct scope' do
+      proxy.property :hello
+      proxy.property :world
+
+      read_properties = map.properties.filter_by_scope(:read)
+      expect(read_properties.map(&:name)).to eq([:hello, :world])
+
+      write_properties = map.properties.filter_by_scope(:write)
+      expect(write_properties.map(&:name)).to eq([:hello, :world])
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kartograph
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Robert Ross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,6 +92,7 @@ files:
 - lib/kartograph/property.rb
 - lib/kartograph/property_collection.rb
 - lib/kartograph/root_key.rb
+- lib/kartograph/scope_proxy.rb
 - lib/kartograph/sculptor.rb
 - lib/kartograph/version.rb
 - spec/lib/kartograph/artist_spec.rb
@@ -99,6 +101,7 @@ files:
 - spec/lib/kartograph/property_collection_spec.rb
 - spec/lib/kartograph/property_spec.rb
 - spec/lib/kartograph/root_key_spec.rb
+- spec/lib/kartograph/scope_proxy_spec.rb
 - spec/lib/kartograph/sculptor_spec.rb
 - spec/spec_helper.rb
 - spec/support/dsl_contexts.rb
@@ -136,6 +139,7 @@ test_files:
 - spec/lib/kartograph/property_collection_spec.rb
 - spec/lib/kartograph/property_spec.rb
 - spec/lib/kartograph/root_key_spec.rb
+- spec/lib/kartograph/scope_proxy_spec.rb
 - spec/lib/kartograph/sculptor_spec.rb
 - spec/spec_helper.rb
 - spec/support/dsl_contexts.rb