cartograph 1.0.0

data/spec/lib/cartograph/root_key_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Cartograph::RootKey do
+  describe '#initialize' do
+    it 'initializes with options' do
+      options = { singular: 'hello', plural: 'hellos', scopes: [:read] }
+
+      instance = Cartograph::RootKey.new(options)
+      expect(instance.options).to eq(options)
+    end
+  end
+
+  describe '#scopes' do
+    it 'reads the scopes' do
+      instance = Cartograph::RootKey.new(scopes: [:read])
+      expect(instance.scopes).to eq([:read])
+    end
+
+    it 'reads the scopes as an array always' do
+      instance = Cartograph::RootKey.new(scopes: :read)
+      expect(instance.scopes).to eq([:read])
+    end
+  end
+
+  describe '#singular' do
+    it 'reads the singular key' do
+      instance = Cartograph::RootKey.new(singular: 'user')
+      expect(instance.singular).to eq('user')
+    end
+  end
+
+  describe '#plural' do
+    it 'reads the plural key' do
+      instance = Cartograph::RootKey.new(plural: 'user')
+      expect(instance.plural).to eq('user')
+    end
+  end
+end

data/spec/lib/cartograph/sculptor_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Cartograph::Sculptor do
+  describe '#initialize' do
+    it 'initializes with a hash and map' do
+      hash = {}
+      map = double('im a map')
+
+      sculptor = Cartograph::Sculptor.new(hash, map)
+
+      expect(sculptor.object).to be(hash)
+      expect(sculptor.map).to be(map)
+    end
+  end
+
+  describe '#sculpted_object=' do
+    context 'objects that are not the mapping class' do
+      it 'raises an error' do
+        hash = {}
+        map = double(Cartograph::Map, mapping: Hash)
+
+        sculptor = Cartograph::Sculptor.new(hash, map)
+
+        expect {
+          sculptor.sculpted_object = ""
+        }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe '#sculpt' do
+    let(:map) { Cartograph::Map.new }
+    let(:object) { { 'id' => 343, 'name' => 'Guilty Spark', 'email_address' => 'guilty@bungie.net' } }
+
+    it 'returns nil if the object in nil' do
+      sculptor = Cartograph::Sculptor.new(nil, map)
+      expect(sculptor.sculpt).to be_nil
+    end
+
+    context 'without a scope' do
+      before do
+        map.mapping DummyUser
+        map.property :id, scopes: [:read]
+        map.property :name, scopes: [:read, :create]
+        map.property :email, scopes: [:read, :create], key: 'email_address'
+      end
+
+      it 'returns a coerced user' do
+        sculptor = Cartograph::Sculptor.new(object, map)
+        sculpted = sculptor.sculpt
+
+        expect(sculpted).to be_kind_of(DummyUser)
+        expect(sculpted.id).to eq(object['id'])
+        expect(sculpted.name).to eq(object['name'])
+        expect(sculpted.email).to eq(object['email_address'])
+      end
+
+      it 'sculpts into a provided object' do
+        sculptor = Cartograph::Sculptor.new(object, map)
+        dummy = DummyUser.new
+        sculptor.sculpted_object = dummy
+        sculpted = sculptor.sculpt
+
+        expect(sculpted).to eq(dummy)
+      end
+    end
+
+    context 'with a scope' do
+      before do
+        map.mapping DummyUser
+        map.property :id, scopes: [:read]
+        map.property :name, scopes: [:create]
+      end
+
+      it 'returns a coerced user' do
+        sculptor = Cartograph::Sculptor.new(object, map)
+        sculpted = sculptor.sculpt(:read)
+
+        expect(sculpted).to be_kind_of(DummyUser)
+        expect(sculpted.id).to eq(object['id'])
+        expect(sculpted.name).to be_nil
+      end
+
+      context 'for nested properties' do
+        let(:object) { super().merge('comment' => { 'id' => 123, 'text' => 'hello' }) }
+
+        before do
+          map.property :comment, scopes: [:read] do
+            mapping DummyComment
+
+            property :id, scopes: [:read]
+            property :text, scopes: [:create]
+          end
+        end
+
+        it 'returns the nested objects with scoped properties set' do
+          sculptor = Cartograph::Sculptor.new(object, map)
+          sculpted = sculptor.sculpt(:read)
+
+          expect(sculpted.comment).to be_kind_of(DummyComment)
+          expect(sculpted.comment.id).to eq(123)
+          expect(sculpted.comment.text).to be_nil
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,77 @@
+require 'cartograph'
+
+require 'pry'
+
+Dir['./spec/support/**/*.rb'].each {|f| load f }
+
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.after(:each) do
+    Cartograph.default_dumper = JSON
+    Cartograph.default_loader = JSON
+    Cartograph.default_cache = nil
+    Cartograph.default_cache_key = nil
+  end
+
+=begin
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/support/dsl_contexts.rb

@@ -0,0 +1,22 @@
+shared_context "DSL Objects" do
+  let(:object) { double('object', id: 1066, name: 'Bruce (the dude from Finding Nemo)') }
+  let(:mapped) do
+    Class.new do
+      include Cartograph::DSL
+
+      cartograph do
+        mapping DummyUser
+
+        property :id, scopes: [:read]
+        property :name, scopes: [:read, :create]
+
+        property :comments, plural: true do
+          mapping DummyComment
+
+          property :id, scopes: [:read]
+          property :text, scopes: [:read, :create]
+        end
+      end
+    end
+  end
+end

data/spec/support/dummy_comment.rb

@@ -0,0 +1,2 @@
+class DummyComment < OpenStruct
+end

data/spec/support/dummy_user.rb

@@ -0,0 +1,2 @@
+class DummyUser < OpenStruct
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: cartograph
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert Ross
+- Kyrylo Silin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !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: Cartograph makes it easy to generate and convert JSON. It's intention
+  is to be used for API clients.
+email:
+- silin@kyrylo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cartograph.gemspec
+- examples/collection_representation.rb
+- examples/domains.rb
+- examples/representation_for.rb
+- lib/cartograph.rb
+- lib/cartograph/artist.rb
+- lib/cartograph/dsl.rb
+- lib/cartograph/map.rb
+- lib/cartograph/property.rb
+- lib/cartograph/property_collection.rb
+- lib/cartograph/root_key.rb
+- lib/cartograph/sculptor.rb
+- lib/cartograph/version.rb
+- spec/lib/cartograph/artist_spec.rb
+- spec/lib/cartograph/dsl_spec.rb
+- spec/lib/cartograph/map_spec.rb
+- spec/lib/cartograph/property_collection_spec.rb
+- spec/lib/cartograph/property_spec.rb
+- spec/lib/cartograph/root_key_spec.rb
+- spec/lib/cartograph/sculptor_spec.rb
+- spec/spec_helper.rb
+- spec/support/dsl_contexts.rb
+- spec/support/dummy_comment.rb
+- spec/support/dummy_user.rb
+homepage: https://github.com/kyrylo/cartograph
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Cartograph makes it easy to generate and convert JSON. It's intention is
+  to be used for API clients.
+test_files:
+- spec/lib/cartograph/artist_spec.rb
+- spec/lib/cartograph/dsl_spec.rb
+- spec/lib/cartograph/map_spec.rb
+- spec/lib/cartograph/property_collection_spec.rb
+- spec/lib/cartograph/property_spec.rb
+- spec/lib/cartograph/root_key_spec.rb
+- spec/lib/cartograph/sculptor_spec.rb
+- spec/spec_helper.rb
+- spec/support/dsl_contexts.rb
+- spec/support/dummy_comment.rb
+- spec/support/dummy_user.rb