ivy-serializers 0.1.0

data/spec/integration/formats/json_api_spec.rb

@@ -0,0 +1,254 @@
+require 'ivy/serializers'
+
+RSpec.describe Ivy::Serializers::Formats::JSONAPI do
+  let(:format) { described_class.new(document) }
+
+  describe '#as_json' do
+    let(:registry) { Ivy::Serializers::Registry.new }
+    let(:document) { Ivy::Serializers::Documents.create(registry, :post, post) }
+
+    subject { format.as_json }
+
+    context 'with default mapping' do
+      let(:post_class) { double('Post', :name => 'Post') }
+      let(:post) { double('post', :class => post_class, :id => 1) }
+
+      it { should eq({
+        :data => {
+          :type => 'post',
+          :id => '1',
+          :links => {}
+        }
+      }) }
+    end
+
+    context 'with an attribute' do
+      let(:post_class) { double('Post', :name => 'Post') }
+      let(:post) { double('post', :class => post_class, :id => 1, :title => 'title') }
+
+      context 'with default options' do
+        before do
+          registry.map post_class do
+            attribute :title
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :title => 'title',
+            :links => {}
+          }
+        }) }
+      end
+
+      context 'with a block provided' do
+        before do
+          registry.map post_class do
+            attribute(:headline) { |post| post.title }
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :headline => 'title',
+            :links => {}
+          }
+        }) }
+      end
+    end
+
+    context 'with a belongs_to relationship' do
+      let(:author_class) { double('Author', :name => 'Author') }
+      let(:author) { double('author', :class => author_class, :id => 1) }
+      let(:post_class) { double('Post', :name => 'Post') }
+      let(:post) { double('post', :author => author, :class => post_class, :id => 1) }
+
+      context 'with default options' do
+        before do
+          registry.map post_class do
+            belongs_to :author
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :author => {
+                :linkage => {:id => '1', :type => 'author'}
+              }
+            }
+          }
+        }) }
+      end
+
+      context 'with a block provided' do
+        before do
+          registry.map post_class do
+            belongs_to(:user) { |post| post.author }
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :user => {
+                :linkage => {:id => '1', :type => 'author'}
+              }
+            }
+          }
+        }) }
+      end
+
+      context 'with the :embed_in_root option' do
+        before do
+          registry.map post_class do
+            belongs_to :author, :embed_in_root => true
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :author => {
+                :linkage => {:id => '1', :type => 'author'}
+              }
+            }
+          },
+
+          :included => {
+            :authors => [{
+              :id => '1',
+              :links => {},
+              :type => 'author'
+            }]
+          }
+        }) }
+      end
+
+      context 'with the :polymorphic option' do
+        before do
+          registry.map post_class do
+            belongs_to :author, :polymorphic => true
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :author => {
+                :linkage => {:id => '1', :type => 'author'}
+              }
+            }
+          }
+        }) }
+      end
+    end
+
+    context 'with a has_many relationship' do
+      let(:comment_class) { double('Comment', :name => 'Comment') }
+      let(:comment) { double('comment', :class => comment_class, :id => 1) }
+      let(:post_class) { double('Post', :name => 'Post') }
+      let(:post) { double('post', :class => post_class, :comments => [comment], :id => 1) }
+
+      context 'with default options' do
+        before do
+          registry.map post_class do
+            has_many :comments
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :comments => {
+                :linkage => [{:id => '1', :type => 'comment'}]
+              }
+            }
+          }
+        }) }
+      end
+
+      context 'with a block provided' do
+        before do
+          registry.map post_class do
+            has_many(:replies) { |post| post.comments }
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :replies => {
+                :linkage => [{:id => '1', :type => 'comment'}]
+              }
+            }
+          }
+        }) }
+      end
+
+      context 'with the :embed_in_root option' do
+        before do
+          registry.map post_class do
+            has_many :comments, :embed_in_root => true
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :comments => {
+                :linkage => [{:id => '1', :type => 'comment'}]
+              }
+            }
+          },
+
+          :included => {
+            :comments => [{
+              :type => 'comment',
+              :id => '1',
+              :links => {}
+            }]
+          }
+        }) }
+      end
+
+      context 'with the :polymorphic option' do
+        before do
+          registry.map post_class do
+            has_many :comments, :polymorphic => true
+          end
+        end
+
+        it { should eq({
+          :data => {
+            :type => 'post',
+            :id => '1',
+            :links => {
+              :comments => {
+                :linkage => [{:id => '1', :type => 'comment'}]
+              }
+            }
+          }
+        }) }
+      end
+    end
+  end
+end

data/spec/integration/serializer_spec.rb

@@ -0,0 +1,47 @@
+require 'ivy/serializers'
+
+RSpec.describe Ivy::Serializers::Serializer do
+  describe '#resource' do
+    let(:serializer) { serializer_class.new }
+    let(:generator) { Ivy::Serializers::Formats::ActiveModelSerializers.new(document) }
+    let(:document) { Ivy::Serializers::Documents.create(serializer, :post, post) }
+    let(:post_class) { double('Post') }
+    let(:post) { double('post', :class => post_class, :id => 1, :title => 'title') }
+
+    context 'with an attribute' do
+      subject { generator.as_json }
+
+      context 'with default options' do
+        let(:serializer_class) {
+          post_klass = post_class
+
+          Class.new(described_class) do
+            map post_klass do
+              attribute :title
+            end
+          end
+        }
+
+        it { should eq(:post => {:id => 1, :title => 'title'}) }
+      end
+
+      context 'with a block provided' do
+        let(:serializer_class) {
+          post_klass = post_class
+
+          Class.new(described_class) do
+            map post_klass do
+              attribute(:title) { title }
+
+              def title
+                'custom_title'
+              end
+            end
+          end
+        }
+
+        it { should eq(:post => {:id => 1, :title => 'custom_title'}) }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,93 @@
+require 'simplecov'
+
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # 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|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  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|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # 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
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # 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
+end
+
+Dir['./spec/support/**/*.rb'].each { |file| require(file) }

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: ivy-serializers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dray Lacy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-01 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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: hash_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- dray@envylabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ivy-serializers.gemspec
+- lib/ivy-serializers.rb
+- lib/ivy/serializers.rb
+- lib/ivy/serializers/action_controller/serialization_support.rb
+- lib/ivy/serializers/attribute.rb
+- lib/ivy/serializers/documents.rb
+- lib/ivy/serializers/documents/document.rb
+- lib/ivy/serializers/documents/individual_resource.rb
+- lib/ivy/serializers/documents/resource_collection.rb
+- lib/ivy/serializers/formats.rb
+- lib/ivy/serializers/formats/active_model_serializers.rb
+- lib/ivy/serializers/formats/json.rb
+- lib/ivy/serializers/formats/json_api.rb
+- lib/ivy/serializers/mapping.rb
+- lib/ivy/serializers/railtie.rb
+- lib/ivy/serializers/registry.rb
+- lib/ivy/serializers/relationships.rb
+- lib/ivy/serializers/relationships/belongs_to.rb
+- lib/ivy/serializers/relationships/has_many.rb
+- lib/ivy/serializers/relationships/relationship.rb
+- lib/ivy/serializers/serializer.rb
+- lib/ivy/serializers/version.rb
+- spec/integration/formats/active_model_serializers_spec.rb
+- spec/integration/formats/json_api_spec.rb
+- spec/integration/serializer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.4.6
+signing_key: 
+specification_version: 4
+summary: JSON serialization for client-side apps.
+test_files:
+- spec/integration/formats/active_model_serializers_spec.rb
+- spec/integration/formats/json_api_spec.rb
+- spec/integration/serializer_spec.rb
+- spec/spec_helper.rb