sinatra-active-model-serializers 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eee1dfba4d6f3e8f8f560b5877e31c74f7d21a2
-  data.tar.gz: d524672188df09d01cdfe9b0ead8114a6b83ca7a
+  metadata.gz: 1d72c0b7b8011b0fe2b7d87213cf9892986342e0
+  data.tar.gz: f91dd1b1e0e3037346c15dee162dc0228b4be884
 SHA512:
-  metadata.gz: 0121b5801dee190060a47df5049f06056a61bcb8dc79bf4fa4002ed77811bb42bf47d3d21a9bac3a57e2e07c782528d4ada0e5a4284f2b3e520d2be54a4ef2ac
-  data.tar.gz: 845b7be3d130fc90ea7cafb035451c9d2531a9c1890d420e1d4cab88d747307827849158f47842ddf78fc7fe72de7eeb93877822ccc6dc92f86608daa15af3d7
+  metadata.gz: 5a960482ea967942b4ee8648bcae8f16a888d2e74a6fa6010f28421763430e7cf1d1c82a986ebe8252c790a48e8d4590248b1e5196088512a81f048361a0d4b2
+  data.tar.gz: 13e5092220001d5206d498290a8685dbccc3e50204dcc87e4851476f7b4ec5e13c97a827b216a474ff3b0df2f450092584d2faed706b747d16fda5d20f37ad3e

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: 7YmAGkgvUC6HAOVuQBw61pGod1TZsUWNq

data/.gitignore

@@ -1,4 +1,2 @@
-Gemfile.lock
-db/sinatra_active_model_serializers.sqlite3
-db/schema.rb
-pkg
+pkg
+coverage

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Max: 80
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/TrailingBlankLines:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+## [In git](https://github.com/SauloSilva/sinatra-active-model-serializers/compare/v0.0.2...HEAD)
+
+## [v0.2.0](https://github.com/SauloSilva/sinatra-active-model-serializers/tree/v0.2.0)
+
+### Features:
+* [Adding each serializer](https://github.com/SauloSilva/sinatra-active-model-serializers/pull/15) (saulosantiago)
+
+* [Adding sinatra, sinatra-contrib and sinatra-activerecord with dependencies](https://github.com/SauloSilva/sinatra-active-model-serializers/pull/16) (saulosantiago)
+
+## [v0.1.0](https://github.com/SauloSilva/sinatra-active-model-serializers/tree/v0.1.0)
+
+### Features:
+* [Adding specify serializer](https://github.com/SauloSilva/sinatra-active-model-serializers/pull/8) (saulosantiago)
+
+## [v0.0.3](https://github.com/SauloSilva/sinatra-active-model-serializers/tree/v0.0.3)
+
+### Features:
+* [Adding changelog](https://github.com/SauloSilva/sinatra-active-model-serializers/pull/3) (saulosantiago)
+
+### Bug Fixes
+* [Fix with gem name](https://github.com/SauloSilva/sinatra-active-model-serializers/pull/1) (adrianotadao)
+
+## [v0.0.2](https://github.com/SauloSilva/sinatra-active-model-serializers/tree/v0.0.2)
+
+## First gem release
+
+### Features:
+* [Adding rubygems_task](https://github.com/SauloSilva/sinatra-active-model-serializers/pull/2) (saulosantiago)
+* Adapter from Active Model Serializers (saulosantiago)

data/Gemfile

@@ -2,16 +2,12 @@ source 'http://rubygems.org'
 gemspec
 
 group :development do
+  gem 'rake', '10.4.2'
   gem 'rubygems-tasks', '0.2.4'
 end
 
 group :test do
-  gem 'sinatra', '1.4.5'
-  gem 'sinatra-contrib', '1.4.2'
-  gem 'rake', '10.4.2'
-  gem 'json-schema', '2.5.0'
   gem 'rspec', '3.1.0'
-  gem 'sinatra-activerecord', '2.0.4'
-  gem 'sqlite3', '1.3.10'
-  gem 'database_cleaner', '1.4.0'
+  gem 'json-schema', '2.5.0'
+  gem 'coveralls', '0.8.2', require: false
 end

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    sinatra-active-model-serializers (0.2.0)
+      active_model_serializers (= 0.9.3)
+      sinatra (= 1.4.6)
+      sinatra-activerecord (= 2.0.4)
+      sinatra-contrib (= 1.4.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_model_serializers (0.9.3)
+      activemodel (>= 3.2)
+    activemodel (4.2.3)
+      activesupport (= 4.2.3)
+      builder (~> 3.1)
+    activerecord (4.2.3)
+      activemodel (= 4.2.3)
+      activesupport (= 4.2.3)
+      arel (~> 6.0)
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    arel (6.0.2)
+    backports (3.6.5)
+    builder (3.2.2)
+    coveralls (0.8.2)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    json-schema (2.5.0)
+      addressable (~> 2.3)
+    mime-types (2.6.1)
+    minitest (5.7.0)
+    multi_json (1.11.2)
+    netrc (0.10.3)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    rubygems-tasks (0.2.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    sinatra-activerecord (2.0.4)
+      activerecord (>= 3.2)
+      sinatra (~> 1.0)
+    sinatra-contrib (1.4.6)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (>= 1.3, < 3)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (2.0.1)
+    tins (1.5.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls (= 0.8.2)
+  json-schema (= 2.5.0)
+  rake (= 10.4.2)
+  rspec (= 3.1.0)
+  rubygems-tasks (= 0.2.4)
+  sinatra-active-model-serializers!
+
+BUNDLED WITH
+   1.10.4

data/README.md

@@ -1,5 +1,7 @@
 [ ![Codeship Status for SauloSilva/sinatra-active-model-serializers](https://codeship.com/projects/0be149a0-8d56-0132-3f2c-5691319bff63/status?branch=master)](https://codeship.com/projects/60665)
 
+[![Coverage Status](https://coveralls.io/repos/SauloSilva/sinatra-active-model-serializers/badge.svg?branch=adding_each_serializer&service=github)](https://coveralls.io/github/SauloSilva/sinatra-active-model-serializers?branch=adding_each_serializer)
+
 # Sinatra::ActiveModelSerializers
 
 [![Gem Version](https://badge.fury.io/rb/sinatra-active-model-serializers.png)](http://badge.fury.io/rb/sinatra-active-model-serializers)
@@ -17,14 +19,14 @@ Ruby 1.9.2 or greater, Sinatra 1.4.5 or greater and Sinatra Contrib 1.4.2 or gre
 
 or with bundler
 
-```
+```ruby
 # Gemfile
-source :rubygems
+source 'http://rubygems.org'
 
-gem 'sinatra'
-gem 'sinatra-contrib'
-gem 'sinatra-active-record'
-gem 'sinatra-active-model-serializers'
+gem 'sinatra', '1.4.6'
+gem 'sinatra-contrib', '1.4.6'
+gem 'sinatra-active-record', '2.0.4'
+gem 'sinatra-active-model-serializers', '0.2.0'
 ```
 
 ## Configure
@@ -38,6 +40,8 @@ require 'bundler'
 Bundler.require :default
 
 class App < Sinatra::Base
+  register Sinatra::ActiveRecordExtension
+
   get '/' do
     json Test.first
   end
@@ -50,7 +54,7 @@ end
 
 This attribute is an object, all inserted configuration this object it will be passed on to Active Model Serializers, eg.
 
-```
+```ruby
 set :active_model_serializers, { root: false }
 ```
 
@@ -58,13 +62,13 @@ set :active_model_serializers, { root: false }
 
 By default this attribute is set up to look for the serializers from your project in "* app / serializers *". Whether you have a different environment you can set up by inserting the path of the string, eg.
 
-```
+```ruby
 set :serializers_path, './whatever_path/serializers'
 ```
 
 or not to automatically requires
 
-```
+```ruby
 set :serializers_path, false
 ```
 
@@ -75,7 +79,7 @@ This the second parameter is an object. This object may contain new configuratio
 
 #### root
 
-```
+```ruby
 get '/' do
   json Resource.first, { root: false }
 end
@@ -83,13 +87,13 @@ end
 
 #### scope
 
-```
+```ruby
 get '/' do
   json Resource.first, { scope: self }
 end
 ```
 
-#### serializer
+## Specify a serializer
 
 If you wish to use an another serializer than the default, you can explicitly pass it through the renderer
 
@@ -99,6 +103,15 @@ If you wish to use an another serializer than the default, you can explicitly pa
 json Resource.first, { serializer: ResourcePreviewSerializer }
 ```
 
+2. For an array resource:
+
+Use the default `ArraySerializer`, which will use `each_serializer` to
+serialize each element.
+
+```ruby
+json @resources, { each_serializer: ResourcePreviewSerializer }
+```
+
 ## License
 
 [MIT](https://github.com/SauloSilva/sinatra-active-model-serializers/blob/master/LICENSE)

data/lib/sinatra-active-model-serializers/json.rb

@@ -7,16 +7,27 @@ module Sinatra
       super
     end
 
-    def json(object, options={})
-      options = options.merge(settings.active_model_serializers)
+    def json(resource, options = {})
+      @_options = settings.active_model_serializers.merge(options)
 
-      if serializer = options.fetch(:serializer, ActiveModel::Serializer.serializer_for(object, options))
-        serializer.new(object, options).to_json
+      if serializer = get_serializer(resource)
+        serializer.new(resource, @_options).to_json
       else
-        object.to_json(options)
+        resource.to_json(@_options)
       end
     end
 
+    def get_serializer(resource)
+      _serializer ||= @_options.delete(:serializer)
+      _serializer ||= ActiveModel::Serializer.serializer_for(resource)
+
+      if @_options.key?(:each_serializer)
+        @_options[:serializer] = @_options.fetch(:each_serializer)
+      end
+
+      _serializer
+    end
+
     def files_required
       return unless settings.serializers_path
       Dir["#{ settings.serializers_path }/**/*.rb"].flatten.sort.each do |file|
@@ -25,6 +36,6 @@ module Sinatra
     end
   end
 
-  Base.set :active_model_serializers, {}
+  Base.set :active_model_serializers, root: true
   Base.set :serializers_path, SERIALIZERS_DEFAULT_PATH
 end

data/lib/sinatra-active-model-serializers/version.rb

@@ -1,6 +1,6 @@
 module SinatraActiveModelSerializers
   PATCH = 0
-  MINOR = 1
+  MINOR = 2
   MAJOR = 0
   VERSION = "#{ MAJOR }.#{ MINOR }.#{ PATCH }".freeze
 end

data/sinatra-active-model-serializers.gemspec

@@ -13,33 +13,43 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
 
   # generated from git shortlog -sn
-  s.authors = ['saulosantiago']
+  s.authors = ['Saulo Santiago', 'Adriano Tadao']
 
   # generated from git shortlog -sne
-  s.email = ['saulodasilvasantiago@gmail.com']
+  s.email = ['saulodasilvasantiago@gmail.com', 'drianotadao@gmail.com']
 
   # generated from git ls-files
   s.files = [
+    '.coveralls.yml',
     '.gitignore',
+    '.hound.yml',
+    '.rubocop.yml',
+    'CHANGELOG.md',
     'Gemfile',
+    'Gemfile.lock',
     'LICENSE',
     'README.md',
     'Rakefile',
-    'db/migrate/00_create_tests.rb',
-    'db/schema.rb',
     'lib/sinatra-active-model-serializers.rb',
     'lib/sinatra-active-model-serializers/json.rb',
     'lib/sinatra-active-model-serializers/version.rb',
     'sinatra-active-model-serializers.gemspec',
     'spec/app/application.rb',
     'spec/app/models/test.rb',
+    'spec/app/serializers/foo_serializer.rb',
     'spec/app/serializers/test_serializer.rb',
+    'spec/app/serializers/unitary_serializer.rb',
     'spec/json_spec.rb',
+    'spec/schemas/test_with_each_serializer.json',
     'spec/schemas/test_with_root.json',
+    'spec/schemas/test_with_specific_serializer.json',
     'spec/schemas/test_without_root.json',
     'spec/spec_helper.rb',
     'spec/support/request_support.rb'
   ]
 
+  s.add_runtime_dependency 'sinatra', '1.4.6'
+  s.add_runtime_dependency 'sinatra-contrib', '1.4.6'
+  s.add_runtime_dependency 'sinatra-activerecord', '2.0.4'
   s.add_runtime_dependency 'active_model_serializers', '0.9.3'
 end

data/spec/app/application.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'bundler'
 Bundler.require(:defaut, :test)
 
+require 'sinatra/activerecord'
 require './lib/sinatra-active-model-serializers/'
 Dir['./spec/app/models/**/*.rb'].flatten.sort.each { |file| require file}
 
@@ -15,24 +16,25 @@ module App
       ActiveRecord::Base.logger = nil
     end
 
-    set :database, {
-      adapter: 'sqlite3',
-      database: 'db/sinatra_active_model_serializers.sqlite3'
-    }
+    before do
+      @test ||= Test.new(foo: 'foo')
+    end
 
     get '/with-root/' do
-      json Test.create(foo: 'bar'), { root: true }
+      json @test, root: true
     end
 
     get '/without-root/' do
-      json Test.create(foo: 'bar'), { root: false }
+      json @test, root: false
     end
 
     get '/with-specific-serializer/' do
-      json Test.create(foo: 'bar'), {
-        root: false,
-        serializer: FooSerializer
-      }
+      json @test, root: false, serializer: FooSerializer
+    end
+
+    get '/with-each-serializer/' do
+      tests = [@test, @test]
+      json tests, root: 'units', each_serializer: UnitarySerializer
     end
   end
 end

data/spec/app/models/test.rb

@@ -1,2 +1,8 @@
-class Test < ActiveRecord::Base
+class Test
+  include ActiveModel::Serialization
+  attr_accessor :foo
+
+  def initialize(options)
+    @foo = options[:foo]
+  end
 end

data/spec/app/serializers/foo_serializer.rb

@@ -0,0 +1,7 @@
+class FooSerializer < ActiveModel::Serializer
+  attributes :bar
+
+  def bar
+    "This is a custom serializer - #{ object.class.name }"
+  end
+end

data/spec/app/serializers/unitary_serializer.rb

@@ -0,0 +1,7 @@
+class UnitarySerializer < ActiveModel::Serializer
+  attributes :foo, :extra
+
+  def extra
+    'extra'
+  end
+end

data/spec/json_spec.rb

@@ -14,5 +14,13 @@ describe App::Base do
   it 'should response with specific serializer' do
     get '/with-specific-serializer/'
     match_response_schema(:test_with_specific_serializer)
+
+    json = JSON.parse last_response.body
+    expect(json['bar']).to eq('This is a custom serializer - Test')
+  end
+
+  it 'should response with each serializer' do
+    get '/with-each-serializer/'
+    match_response_schema(:test_with_each_serializer)
   end
 end

data/spec/schemas/test_with_each_serializer.json

@@ -0,0 +1,22 @@
+{
+  "type": "object",
+  "required":  [
+    "units"
+  ],
+  "properties": {
+    "units": {
+      "type": "array",
+      "items": {
+        "type" : "object",
+        "required":  [
+          "foo",
+          "extra"
+        ],
+        "properties" : {
+          "foo" : { "type" : "string" },
+          "extra" : { "type" : "string" }
+        }
+      }
+    }
+  }
+}

data/spec/schemas/test_with_specific_serializer.json

@@ -0,0 +1,9 @@
+{
+  "type": "object",
+  "required":  [
+    "bar"
+  ],
+  "properties": {
+    "bar": { "type": "string" }
+  }
+}

data/spec/spec_helper.rb

@@ -5,22 +5,15 @@ require 'sinatra/contrib'
 require 'app/application'
 require 'rspec'
 require 'rack/test'
+require 'coveralls'
+
+Coveralls.wear!
 Dir[File.expand_path '../support/**/*.rb',  __FILE__].each { |file| require file }
 
 RSpec.configure do |config|
   config.expect_with :rspec
   include Rack::Test::Methods
   include RequestSupport
-  DatabaseCleaner.clean_with :truncation
-  DatabaseCleaner.strategy = :transaction
-
-  before :all do
-    DatabaseCleaner.start
-  end
-
-  after :all do
-    DatabaseCleaner.clean
-  end
 
   def app
     App::Base

metadata

@@ -1,15 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-active-model-serializers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- saulosantiago
+- Saulo Santiago
+- Adriano Tadao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-07-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+- !ruby/object:Gem::Dependency
+  name: sinatra-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.4
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
   requirement: !ruby/object:Gem::Requirement
@@ -28,26 +71,34 @@ description: Adapter from Active Model Serializers, to work in Sinatra from a mo
   practical way with models
 email:
 - saulodasilvasantiago@gmail.com
+- drianotadao@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".hound.yml"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- db/migrate/00_create_tests.rb
-- db/schema.rb
 - lib/sinatra-active-model-serializers.rb
 - lib/sinatra-active-model-serializers/json.rb
 - lib/sinatra-active-model-serializers/version.rb
 - sinatra-active-model-serializers.gemspec
 - spec/app/application.rb
 - spec/app/models/test.rb
+- spec/app/serializers/foo_serializer.rb
 - spec/app/serializers/test_serializer.rb
+- spec/app/serializers/unitary_serializer.rb
 - spec/json_spec.rb
+- spec/schemas/test_with_each_serializer.json
 - spec/schemas/test_with_root.json
+- spec/schemas/test_with_specific_serializer.json
 - spec/schemas/test_without_root.json
 - spec/spec_helper.rb
 - spec/support/request_support.rb
@@ -71,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Adapter from Active Model Serializers

data/db/migrate/00_create_tests.rb

@@ -1,7 +0,0 @@
-class CreateTests < ActiveRecord::Migration
-  def change
-    create_table :tests do |t|
-      t.string :foo
-    end
-  end
-end