grape-active_model_serializers 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8ff356c3449ed21a7317fa1aba4f2166bd37f08
-  data.tar.gz: d5d8c18b882b728fa2dc80ef8fc117f50514cfcf
+  metadata.gz: b3e93ead8a09d258d62697918cb9f2c02b928bcd
+  data.tar.gz: 3674a40549e956720723447f751b8a9dea4f2158
 SHA512:
-  metadata.gz: 1d759b25c58f6f4f822268643888949e4a499361c987ff2900b535ec59af5ca9926701cf87ade34f7346dca4a664c97836d08aabb6e704d022bb72dfb81bdca2
-  data.tar.gz: bcf1bebecde31d684cc11d7ae200caf6b9ff1ec254f328292f882162ac3c909efc03caace67a20925174fdd2d9aa1b6f89657bb76fd6e5a24d6f4164b98841b6
+  metadata.gz: b735ccb020ec984ab176a277b0864373923234f0927c87c4b434decf633b8b17281e865753b2b43289524aa65f1db8495f0c3e16155e89f1d84a42957d6e4acd
+  data.tar.gz: a152d5e8e472f71b2dd316bf10815502a13f1fc250c2cffa1a999a2a377ca0e3f0053fe74103120118f3f4c9880d33110c2878a664c81c382d176fbe926e3834

data/.travis.yml

@@ -4,6 +4,9 @@ sudo: false
 
 matrix:
   include:
+    - rvm: 2.3.1
+      script:
+        - bundle exec danger
     - rvm: 2.3.1
       env: GRAPE_VERSION=0.8.0
     - rvm: 2.3.1

data/CHANGELOG.md

@@ -1,8 +1,15 @@
 ## Changelog
 
-### 1.5.1 (Next)
+### 1.5.2 (Next)
 
-* ...
+* Your contribution here.
+
+### 1.5.1 (April 25, 2017)
+
+* [#74](https://github.com/ruby-grape/grape-active_model_serializers/pull/74): Add support for Sequel - [@drn](https://github.com/drn).
+* [#73](https://github.com/ruby-grape/grape-active_model_serializers/pull/73): Ensure all AMS options are passed through - [@drn](https://github.com/drn).
+* [#65](https://github.com/ruby-grape/grape-active_model_serializers/pull/65): Added Danger, PR linter - [@dblock](https://github.com/dblock).
+* [#63](https://github.com/ruby-grape/grape-active_model_serializers/pull/63): Pass adapter options through render - [@drn](https://github.com/drn).
 
 ### 1.5.0 (August 24, 2016)
 

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -8,3 +8,9 @@ when 'HEAD'
 else
   gem 'grape', version
 end
+
+group :test do
+  gem 'sqlite3'
+  gem 'sequel', '~> 4.37', require: false
+  gem 'ruby-grape-danger', '~> 0.1.0', require: false
+end

data/README.md

@@ -150,10 +150,10 @@ Or as follows.
 
 ActiveModelSerializer will fetch automatically the right serializer to render.
 
-### Manually specifying serializer options
+### Manually specifying serializer / adapter options
 
 ```ruby
-# Serializer options can be specified on routes or namespaces.
+# Serializer and adapter options can be specified on routes or namespaces.
 namespace 'foo', serializer: BarSerializer do
   get "/" do
     # will use "bar" serializer
@@ -171,6 +171,36 @@ namespace 'foo', serializer: BarSerializer do
 end
 ```
 
+```ruby
+# Serializer and adapter options can also be specified in the body of the route
+resource :users do
+  get '/:id' do
+    if conditional
+      # uses UserSerializer and configured default adapter automatically
+      current_user
+    else
+      # uses specified serializer and adapter
+      render current_user, serializer: ErrorSerializer, adapter: :attributes
+    end
+  end
+end
+```
+
+```ruby
+# Adhoc serializer options can be specified in the body of the route
+resource :users do
+  get '/:id' do
+    render current_user, extra: { adhoc_name_option: 'value' }
+  end
+end
+
+class UserSerializer
+  def name
+    instance_options[:adhoc_name_option] # accessible in instance_options
+  end
+end
+```
+
 ### Custom Metadata
 
 ```ruby

data/lib/grape-active_model_serializers/endpoint_extension.rb

@@ -37,8 +37,16 @@ module Grape
       end
     end
 
-    def render(resources, meta = {})
-      env['ams_meta'] = meta
+    def render(resources, extra_options = {})
+      options = extra_options.symbolize_keys
+      env['ams_meta'] = options.slice(
+        :meta, :meta_key
+      )
+      env['ams_adapter'] = options.slice(
+        :adapter, :serializer, :each_serializer, :include,
+        :fields, :key_transform, :links, :namespace
+      )
+      env['ams_extra'] = options[:extra]
       resources
     end
 

data/lib/grape-active_model_serializers/options_builder.rb

@@ -12,6 +12,8 @@ module Grape
           options[:scope] = endpoint unless options.key?(:scope)
           options.merge!(default_root_options) unless options.key?(:root)
           options.merge!(meta_options)
+          options.merge!(adapter_options)
+          options.merge!(extra_options)
           options
         )
       end
@@ -56,13 +58,23 @@ module Grape
 
       def meta_options
         options = {}
-        ams_meta = env['ams_meta'] || {}
-        meta = ams_meta[:meta]
-        meta_key = ams_meta[:meta_key]
+        meta_options = env['ams_meta'] || {}
+        meta = meta_options[:meta]
+        meta_key = meta_options[:meta_key]
         options[:meta] = meta if meta
         options[:meta_key] = meta_key if meta && meta_key
         options
       end
+
+      def adapter_options
+        env['ams_adapter'] || {}
+      end
+
+      def extra_options
+        options = env['ams_extra'] || {}
+        return options if options.is_a?(Hash)
+        raise 'Extra options must be a hash'
+      end
     end
   end
 end

data/lib/grape-active_model_serializers/serializer_resolver.rb

@@ -48,8 +48,9 @@ module Grape
       end
 
       def collection_class
-        return nil unless resource.respond_to?(:to_ary)
-        ActiveModel::Serializer.config.collection_serializer
+        if resource.respond_to?(:to_ary) || resource.respond_to?(:all)
+          ActiveModel::Serializer.config.collection_serializer
+        end
       end
 
       def namespace_inferred_class
@@ -84,8 +85,10 @@ module Grape
       end
 
       def resource_class
-        if resource.respond_to?(:to_ary)
-          resource.try(:klass) || resource.compact.first.class
+        if resource.respond_to?(:klass)
+          resource.klass
+        elsif resource.respond_to?(:to_ary) || resource.respond_to?(:all)
+          resource.first.class
         else
           resource.class
         end

data/lib/grape-active_model_serializers/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module ActiveModelSerializers
-    VERSION = '1.5.0'.freeze
+    VERSION = '1.5.1'.freeze
   end
 end

data/spec/grape-active_model_serializers/endpoint_extension_spec.rb

@@ -16,45 +16,126 @@ describe 'Grape::EndpointExtension' do
   end
 
   let(:serializer) { Grape::Formatter::ActiveModelSerializers }
-
-  let(:user) do
+  let(:user) {
     Object.new do
       def name
         'sven'
       end
     end
-  end
-
+  }
   let(:users) { [user, user] }
 
   describe '#render' do
+    let(:env) { {} }
+    let(:env_key) {}
+
     before do
-      allow(subject).to receive(:env).and_return({})
+      allow(subject).to receive(:env).and_return(env)
+    end
+
+    shared_examples_for 'option capture' do
+      it 'captures options' do
+        subject.render(users, options)
+        expect(env[env_key]).to eq(options)
+      end
+    end
+
+    shared_examples_for 'skipped option capture' do
+      it 'does not capture options' do
+        subject.render(users, options)
+        expect(env[env_key]).to eq({})
+      end
     end
 
     it { should respond_to(:render) }
-    let(:meta_content) { { total: 2 } }
-    let(:meta_full) { { meta: meta_content } }
 
-    context 'supplying meta' do
-      before do
-        allow(subject).to receive(:env) { { meta: meta_full } }
+    context 'meta options' do
+      let(:env_key) { 'ams_meta' }
+      let(:meta_full) { { meta: meta_content } }
+
+      context 'meta' do
+        let(:options) { { meta: { total: 2 } } }
+        it_behaves_like 'option capture'
+      end
+
+      context 'meta_key' do
+        let(:options) { { meta_key: 'custom_meta' } }
+        it_behaves_like 'option capture'
       end
 
-      it 'passes through the Resource and uses given meta settings' do
-        expect(subject.render(users, meta_full)).to eq(users)
+      context 'unknown option' do
+        let(:options) { { unknown: 'value' } }
+        it_behaves_like 'skipped option capture'
       end
     end
 
-    context 'supplying meta and key' do
-      let(:meta_key) { { meta_key: :custom_key_name } }
+    context 'adapter options' do
+      let(:options) { {} }
+      let(:env_key) { 'ams_adapter' }
+
+      context 'adapter' do
+        let(:options) { { adapter: :json } }
+        it_behaves_like 'option capture'
+      end
 
-      before do
-        allow(subject).to receive(:env) { { meta: meta_full.merge(meta_key) } }
+      context 'include' do
+        let(:options) { { include: '*' } }
+        it_behaves_like 'option capture'
       end
 
-      it 'passes through the Resource and uses given meta settings' do
-        expect(subject.render(users, meta_full.merge(meta_key))).to eq(users)
+      context 'fields' do
+        let(:options) { { fields: [:id] } }
+        it_behaves_like 'option capture'
+      end
+
+      context 'key_transform' do
+        let(:options) { { key_transform: :camel_lower } }
+        it_behaves_like 'option capture'
+      end
+
+      context 'links' do
+        let(:links_object) {
+          {
+            href: 'http://example.com/api/posts',
+            meta: {
+              count: 10
+            }
+          }
+        }
+        let(:options) { { links: links_object } }
+        it_behaves_like 'option capture'
+      end
+
+      context 'namespace' do
+        let(:options) { { namespace: V4 } }
+        it_behaves_like 'option capture'
+      end
+
+      context 'unknown option' do
+        let(:options) { { unknown: 'value' } }
+        it_behaves_like 'skipped option capture'
+      end
+    end
+
+    context 'extra options' do
+      let(:env_key) { 'ams_extra' }
+
+      context 'namespace' do
+        let(:options) { { extra: { option: 'value' } } }
+
+        it 'captures options' do
+          subject.render(users, options)
+          expect(env[env_key]).to eq(options[:extra])
+        end
+      end
+
+      context 'unknown option' do
+        let(:options) { { unknown: 'value' } }
+
+        it 'does not capture options' do
+          subject.render(users, options)
+          expect(env[env_key]).to eq(nil)
+        end
       end
     end
   end

data/spec/grape/active_model_serializers/options_builder_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe Grape::ActiveModelSerializers::OptionsBuilder do
+  let(:resolver) { described_class.new(resource, env) }
+  let(:resource) { User.new }
+  let(:env) { { 'api.endpoint' => UsersApi.endpoints.first } }
+
+  context '#options' do
+    let(:options) { resolver.options }
+
+    context 'meta options' do
+      let(:env) { super().merge('ams_meta' => meta_options) }
+      let(:meta_options) {
+        {
+          meta:     meta,
+          meta_key: meta_key
+        }
+      }
+      let(:meta) { { sample: 'metadata' } }
+      let(:meta_key) { 'specified_key' }
+
+      context 'meta option set' do
+        context 'meta_key set' do
+          it 'includes meta' do
+            expect(options[:meta]).to eq(meta)
+          end
+
+          it 'includes meta_key' do
+            expect(options[:meta_key]).to eq(meta_key)
+          end
+        end
+
+        context 'meta_key unset' do
+          let(:meta_key) { nil }
+
+          it 'includes meta' do
+            expect(options[:meta]).to eq(meta)
+          end
+
+          it 'does not include meta_key' do
+            expect(options.keys).not_to include(:meta_key)
+          end
+        end
+      end
+
+      context 'meta option unset' do
+        let(:meta) { nil }
+
+        context 'meta_key set' do
+          it 'does not include meta' do
+            expect(options.keys).not_to include(:meta)
+          end
+
+          it 'does not include meta_key' do
+            expect(options.keys).not_to include(:meta_key)
+          end
+        end
+
+        context 'meta_key unset' do
+          let(:meta_key) { nil }
+
+          it 'does not include meta' do
+            expect(options.keys).not_to include(:meta)
+          end
+
+          it 'does not include meta_key' do
+            expect(options.keys).not_to include(:meta_key)
+          end
+        end
+      end
+    end
+
+    context 'adapter options' do
+      let(:env) { super().merge('ams_adapter' => adapter_options) }
+      let(:adapter_options) { {} }
+
+      context 'adapter' do
+        let(:adapter_options) { { adapter: adapter } }
+        let(:adapter) { :attributes }
+
+        it 'includes adapter as top-level option' do
+          expect(options[:adapter]).to eq(adapter)
+        end
+      end
+
+      context 'serializer' do
+        let(:adapter_options) { { serializer: serializer } }
+        let(:serializer) { V2::UserSerializer }
+
+        it 'includes serializer as top-level option' do
+          expect(options[:serializer]).to eq(serializer)
+        end
+      end
+
+      context 'each_serializer' do
+        let(:adapter_options) { { each_serializer: each_serializer } }
+        let(:each_serializer) { V2::UserSerializer }
+
+        it 'includes each_serializer as top-level option' do
+          expect(options[:each_serializer]).to eq(each_serializer)
+        end
+      end
+    end
+
+    context 'extra options' do
+      let(:env) { super().merge('ams_extra' => extra_options) }
+
+      context 'hash' do
+        let(:extra_options) { { extra: 'info' } }
+
+        it 'includes extra options in top-level options' do
+          expect(options.keys).to include(:extra)
+        end
+      end
+
+      context 'not a hash' do
+        let(:extra_options) { 'extra' }
+
+        it 'raises an exception' do
+          expect {
+            options
+          }.to raise_exception(
+            'Extra options must be a hash'
+          )
+        end
+      end
+    end
+  end
+end

data/spec/grape/active_model_serializers/serializer_resolver_spec.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'spec_helper'
 
 # asserts serializer resolution order:

data/spec/integration/sequel_spec.rb

@@ -0,0 +1,68 @@
+require 'sequel'
+require 'spec_helper'
+
+describe 'Sequel Integration' do
+  before do
+    DB = Sequel.sqlite unless defined?(DB)
+    DB.create_table(:users) do
+      primary_key :id
+      String :name
+    end
+    ActiveModelSerializers.config.adapter = :json
+    app.format :json
+    app.formatter :json, Grape::Formatter::ActiveModelSerializers
+  end
+
+  after do
+    DB.drop_table(:users)
+    Object.send(:remove_const, :SequelUser)
+    Object.send(:remove_const, :SequelUserSerializer)
+  end
+
+  let!(:model) {
+    SequelUser = Class.new(Sequel::Model(:users)) do
+      include ActiveModel::Serialization
+      def self.model_name
+        'User'
+      end
+    end
+  }
+  let!(:serializer) {
+    SequelUserSerializer = Class.new(ActiveModel::Serializer) do
+      attributes :id, :name
+    end
+  }
+  let(:app) { Class.new(Grape::API) }
+
+  context 'collection' do
+    let!(:users) {
+      [
+        model.create(name: 'one'),
+        model.create(name: 'two')
+      ]
+    }
+
+    it 'renders' do
+      app.get('/users') { render SequelUser.dataset }
+      response = get '/users'
+      expect(JSON.parse(response.body)).to eq(
+        'users' => [
+          { 'id' => 1, 'name' => 'one' },
+          { 'id' => 2, 'name' => 'two' }
+        ]
+      )
+    end
+  end
+
+  context 'member' do
+    let!(:user) { model.create(name: 'name') }
+
+    it 'renders' do
+      app.get('/user/1') { render SequelUser.first }
+      response = get '/user/1'
+      expect(JSON.parse(response.body)).to eq(
+        'user' => { 'id' => 1, 'name' => 'name' }
+      )
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-active_model_serializers
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Jonathan Richard Henry Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-24 00:00:00.000000000 Z
+date: 2017-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -136,6 +136,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
+- Dangerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -156,7 +157,9 @@ files:
 - spec/grape-active_model_serializers/formatter_spec.rb
 - spec/grape-active_model_serializers/versioned_api_formatter_spec.rb
 - spec/grape-active_model_serializers_spec.rb
+- spec/grape/active_model_serializers/options_builder_spec.rb
 - spec/grape/active_model_serializers/serializer_resolver_spec.rb
+- spec/integration/sequel_spec.rb
 - spec/old_grape_ams_spec.rb
 - spec/spec_helper.rb
 - spec/support/api/users_api.rb
@@ -190,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Use active_model_serializer in grape
@@ -200,7 +203,9 @@ test_files:
 - spec/grape-active_model_serializers/formatter_spec.rb
 - spec/grape-active_model_serializers/versioned_api_formatter_spec.rb
 - spec/grape-active_model_serializers_spec.rb
+- spec/grape/active_model_serializers/options_builder_spec.rb
 - spec/grape/active_model_serializers/serializer_resolver_spec.rb
+- spec/integration/sequel_spec.rb
 - spec/old_grape_ams_spec.rb
 - spec/spec_helper.rb
 - spec/support/api/users_api.rb