active_model_serializers-namespaces 1.0.0.rc

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31ba8a1ed28fad0641a19bbc9f37f4e26b8e8d01
+  data.tar.gz: 2511eb2f9af6a7dc3a5ec8c834586d7416cd9427
+SHA512:
+  metadata.gz: b536f8f88c33d3e2a883391fe7282157282e917fd602ccdc1ac1cf7794359e8291afaf20afdccd2d5268f7946d04d51b38d5eb3d704ef8a710924f95bab01edf
+  data.tar.gz: a5b05cc1d04d5cbe2955486d0d30a4555fb9992dd4de9b9070d1cd140f2b93f32031c1ae2b5a40ced4b74913f8865ba5ce122cb980dce63380cd9aa94fd51361

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,34 @@
+language: ruby
+cache: bundler
+script: bundle exec rspec
+
+rvm:
+  - 1.9.3
+  - "2.0"
+  - "2.1"
+  - rbx-2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+
+gemfile:
+  - gemfiles/Rails-4.2.gemfile
+
+matrix:
+  include:
+    - rvm: "2.2"
+      gemfile: gemfiles/Rails-4.2.gemfile
+      env: RUN_COVERALLS=true
+
+    - rvm: "2.2"
+      gemfile: gemfiles/Rails-4.1.gemfile
+
+    - rvm: "2.2"
+      gemfile: gemfiles/Rails-4.0.gemfile
+
+    - rvm: "1.9.3"
+      gemfile: gemfiles/Rails-3.2.gemfile
+
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_model_serializer-namespaces.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec, cmd: 'bundle exec rspec --color' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{\.gemspec$})         { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sebastian Skałacki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# ActiveModelSerializer::Namespaces
+
+[![Version][badge-version]][about-version]
+[![Issues][badge-issues]][about-issues]
+[![Build][badge-travis]][about-travis]
+[![Climate][badge-climate]][about-climate]
+[![Coverage][badge-coverage]][about-coverage]
+
+## Compatibility note
+
+This gem is designed for Active Model Serializers 0.8.x only.
+
+Although newer versions of AMS are also available, currently 0.8.x is
+[most recommended for new projects][ams-maintenance].
+
+## When is it useful?
+
+Short answer: when you need more than one way to serialize your models and
+you want to organize that in namespaces.
+
+For example, your application is serving a versioned API.  You want to
+freeze the old API formats and actively develop upcoming version.
+
+For example, your application is utilizing few 3rd-party services which expect
+JSONs as input, so you need to convert your models somehow, preferably avoiding
+mixing these integrations.
+
+In all these cases the most natural approach is to define a separate set of
+serializers for every API version or integration.  But then you discover that
+you need to pass serializer name every time you use it.  Even `#has_many`
+declarations in serializers require that.  And what will you do to serialize
+a collection of objects of different classes?
+
+With ActiveModelSerializer-Namespaces you can nest your serializers in modules
+with no pain.  Just pass namespace of your choice and it will be used throughout
+complex models and collections.  What's more, you don't need to type it in
+actions, just specify it as default for the whole API version.
+
+Creating brand new API version is again as easy as copying code to new location.
+
+## How do I use it?
+
+Given:
+
+    class Article < ActiveRecord::Base
+    end
+
+    module V1
+      class ArticleSerializer < ActiveModel::Serializer
+      end
+    end
+
+Either specify namespace directly at `render` call:
+
+    def some_action
+      render json: article, serialization_namespace: Ver1
+    end
+
+Or set it as a default option in controller:
+
+    def some_action
+      render json: article
+    end
+
+    def default_serializer_options
+      {serialization_namespace: Ver1}
+    end
+
+See [`spec/features_spec.rb`][spec-features] for more detailed examples.
+
+## How does it works (caveats)?
+
+The trick is to delay inferring serializer class until `#new` is called and
+options hash is available.
+
+To achieve that, `::active_model_serializer` is defined for all models, however
+it returns a finder proxy object instead of serializer class.  The finder
+instance performs lookup for serializer class and instantiates the serializer
+in the response to `#new` call, therefore it's transparent for
+Active Model Serializer internals.
+
+As a consequence, overriding `#active_model_serializer`
+or `::active_model_serializer` disables this gem for given model.
+
+## Why it is a separate gem?
+
+I did want to solve one of the biggest drawbacks of Active Model Serializers
+0.8.  I didn't want to introduce backwards-incompatible changes into it's API.
+
+## Contributing
+
+Fork it, improve it then create a pull request.  You know the drill.
+
+## See also
+
+*   Active Model Serializers issue tracker, particularly [#144][ams-issue-144],
+    but also: [#562][ams-issue-562], [#671][ams-issue-671],
+    [#735][ams-issue-735] and more.
+*   [ActiveModel::VersionSerializer][ams-contrib-version] — different approach
+    to solve the problem
+
+[ams-maintenance]: https://github.com/rails-api/active_model_serializers#maintenance-please-read
+[ams-contrib-version]: https://github.com/hookercookerman/active_model_version_serializers
+[ams-issue-144]: https://github.com/rails-api/active_model_serializers/issues/144
+[ams-issue-562]: https://github.com/rails-api/active_model_serializers/issues/562
+[ams-issue-671]: https://github.com/rails-api/active_model_serializers/issues/671
+[ams-issue-735]: https://github.com/rails-api/active_model_serializers/issues/735
+[spec-features]: https://github.com/skalee/active_model_serializers-namespaces/blob/master/spec/features_spec.rb
+
+[about-climate]: https://codeclimate.com/github/skalee/active_model_serializers-namespaces
+[about-coverage]: https://coveralls.io/r/skalee/active_model_serializers-namespaces
+[about-issues]: https://github.com/skalee/active_model_serializers-namespaces/issues
+[about-travis]: https://travis-ci.org/skalee/active_model_serializers-namespaces
+[about-version]: https://rubygems.org/gems/active_model_serializer-namespaces
+[badge-climate]: https://img.shields.io/codeclimate/github/skalee/active_model_serializers-namespaces.svg
+[badge-coverage]: https://img.shields.io/coveralls/skalee/active_model_serializers-namespaces.svg
+[badge-issues]: https://img.shields.io/github/issues-raw/skalee/active_model_serializers-namespaces.svg
+[badge-travis]: https://img.shields.io/travis/skalee/active_model_serializers-namespaces.svg
+[badge-version]: https://img.shields.io/gem/v/active_model_serializer-namespaces.svg

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/active_model_serializers-namespaces.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_model_serializers/namespaces/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_model_serializers-namespaces"
+  spec.version       = ActiveModelSerializers::Namespaces::VERSION
+  spec.authors       = ["Sebastian Skałacki"]
+  spec.email         = ["skalee@gmail.com"]
+  spec.summary       = %q{Namespaces support for ActiveModel::Serializers.}
+  spec.description   = %q{Enhances ActiveModel::Serializers gem by adding } +
+                       %q{support for serializers namespacing.  This makes } +
+                       %q{developing versioned APIs super easy.  Works with } +
+                       %q{ActiveModel::Serializers 0.8.x series.}
+  spec.homepage      = "https://github.com/skalee/active_model_serializers-namespaces"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "active_model_serializers", "~> 0.8.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_development_dependency "rspec-rails", "~> 3.0"
+  spec.add_development_dependency "rails", ">= 3.2"
+end

data/gemfiles/Rails-3.2.gemfile

@@ -0,0 +1,6 @@
+eval File.read "gemfiles/common.gemfile"
+
+gem "rails", "~> 3.2.0"
+gem "test-unit", "~> 3.0"
+
+gemspec path: ".."

data/gemfiles/Rails-4.0.gemfile

@@ -0,0 +1,5 @@
+eval File.read "gemfiles/common.gemfile"
+
+gem "rails", "~> 4.0.0"
+
+gemspec path: ".."

data/gemfiles/Rails-4.1.gemfile

@@ -0,0 +1,5 @@
+eval File.read "gemfiles/common.gemfile"
+
+gem "rails", "~> 4.1.0"
+
+gemspec path: ".."

data/gemfiles/Rails-4.2.gemfile

@@ -0,0 +1,5 @@
+eval File.read "gemfiles/common.gemfile"
+
+gem "rails", "~> 4.2.0"
+
+gemspec path: ".."

data/gemfiles/common.gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+platform :mri do
+  gem "coveralls", require: false if ENV["TRAVIS"]
+end

data/lib/active_model_serializers/namespaces.rb

@@ -0,0 +1,64 @@
+require "active_model_serializers/namespaces/version"
+
+module ActiveModelSerializers
+  module Namespaces
+    class NamespacedSerializerFinder
+
+      def initialize unscoped_name
+        @unscoped_name = unscoped_name
+      end
+
+      def new *args
+        found_class = nil
+
+        options = (args.last.kind_of?(Hash) ? args.last : {})
+        prefix = options[:serialization_namespace]
+
+        namespaced_name = [prefix, @unscoped_name].compact.join("::")
+
+        if namespaced_name.respond_to?(:safe_constantize)
+          found_class = namespaced_name.safe_constantize
+        else
+          begin
+            found_class = namespaced_name.constantize
+          rescue NameError => e
+            raise unless e.message =~ /uninitialized constant/
+          end
+        end
+
+        found_class ||= ActiveModelSerializers::Namespaces::DefaultSerializer
+        found_class.new *args
+      end
+
+    end
+
+
+    class DefaultSerializer < ActiveModel::DefaultSerializer
+
+      def to_json *args
+        serializable_hash.to_json *args
+      end
+
+      def to_xml *args
+        serializable_hash.to_xml *args
+      end
+
+    end
+  end
+end
+
+
+module ActiveModel
+  module SerializerSupport
+    extend ActiveSupport::Concern
+
+    module ClassMethods #:nodoc:
+
+      def active_model_serializer
+        @namespaced_serializer_finder ||=
+          ActiveModelSerializers::Namespaces::NamespacedSerializerFinder.new("#{self.name}Serializer")
+      end
+
+    end
+  end
+end

data/lib/active_model_serializers/namespaces/version.rb

@@ -0,0 +1,5 @@
+module ActiveModelSerializers
+  module Namespaces
+    VERSION = "1.0.0.rc"
+  end
+end

data/spec/application_fake.rb

@@ -0,0 +1,23 @@
+# Thank you!
+# http://say26.com/rspec-testing-controllers-outside-of-a-rails-application
+# https://github.com/hashrocket/decent_exposure/blob/ea02571938865fe60f86d2e4b37807062a3a7988/spec/fixtures/fake_rails_application.rb
+
+require "rails"
+require "active_support/all"
+require "action_controller/railtie"
+require "action_dispatch/railtie"
+
+module Rails
+  class FakeApplication
+    def env_config; {} end
+
+    def routes
+      return @routes if defined?(@routes)
+      @routes = ActionDispatch::Routing::RouteSet.new
+    end
+  end
+
+  def self.application
+    @app ||= FakeApplication.new
+  end
+end

data/spec/features_spec.rb

@@ -0,0 +1,142 @@
+require "spec_helper"
+
+describe "When serializing objects in controller's #render method", type: :controller do
+
+  class Model
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::SerializerSupport
+
+    def name
+      "I'm a PORO model!"
+    end
+
+    def serializable_hash options = {}
+      {name: name, serialized_by: "Skipping AMS"}
+    end
+  end
+
+  class AnotherModel
+    include ActiveModel::Serializers::JSON
+    include ActiveModel::SerializerSupport
+
+    def name
+      "Yet another PORO model!"
+    end
+  end
+
+  class ModelSerializer < ActiveModel::Serializer
+    attributes :name, :serialized_by
+
+    def serialized_by
+      "Unscoped"
+    end
+  end
+
+  class AnotherModelSerializer < ActiveModel::Serializer
+    attributes :name, :serialized_by
+
+    def serialized_by
+      "Unscoped"
+    end
+  end
+
+  module Version1
+    class Version1::ModelSerializer < ActiveModel::Serializer
+      attributes :name, :serialized_by
+
+      def serialized_by
+        "Version 1"
+      end
+    end
+
+    class Version1::AnotherModelSerializer < ActiveModel::Serializer
+      attributes :name, :serialized_by
+
+      def serialized_by
+        "Version 1"
+      end
+    end
+  end
+
+  module Version2
+  end
+
+  #####
+
+  controller do
+    include Rails.application.routes.url_helpers
+
+    def show
+      render json: Model.new
+    end
+
+    def index
+      render json: [Model.new, AnotherModel.new]
+    end
+  end
+
+  before do
+    routes.draw do
+      get ':controller/:action', format: :json
+    end
+
+    allow(controller).to receive(:default_serializer_options){ options }
+  end
+
+  #####
+
+  let(:serialization_result){ JSON.parse response.body, symbolize_names: true }
+  let(:options){ {root: false} }
+
+
+  context "and when :serialization_namespace is unspecified" do
+    it "searches for serializer in the root namespace" do
+      get :show
+      expect(serialization_result).to eq(name: "I'm a PORO model!", serialized_by: "Unscoped")
+    end
+
+    it "always uses serializer specified with :serializer when such option is present" do
+      options.merge! serializer: ::ModelSerializer
+      get :show
+      expect(serialization_result).to eq(name: "I'm a PORO model!", serialized_by: "Unscoped")
+    end
+
+    it "searches for serializer in the root namespace for every object in collection" do
+      get :index
+      expect(serialization_result).to eq([
+        {name: "I'm a PORO model!", serialized_by: "Unscoped"},
+        {name: "Yet another PORO model!", serialized_by: "Unscoped"},
+      ])
+    end
+  end
+
+  context "and when :serialization_namespace is specified" do
+    it "searches for serializer in that namespace and uses it when found" do
+      options.merge! serialization_namespace: Version1
+      get :show
+      expect(serialization_result).to eq(name: "I'm a PORO model!", serialized_by: "Version 1")
+    end
+
+    it "searches for serializer in that namespace and uses a default serializer when not found" do
+      options.merge! serialization_namespace: Version2
+      get :show
+      expect(serialization_result).to eq(name: "I'm a PORO model!", serialized_by: "Skipping AMS")
+    end
+
+    it "always uses serializer specified with :serializer when such option is present" do
+      options.merge! serialization_namespace: Version1, serializer: ::ModelSerializer
+      get :show
+      expect(serialization_result).to eq(name: "I'm a PORO model!", serialized_by: "Unscoped")
+    end
+
+    it "searches for serializer in that namespace for every object in collection" do
+      options.merge! serialization_namespace: Version1
+      get :index
+      expect(serialization_result).to eq([
+        {name: "I'm a PORO model!", serialized_by: "Version 1"},
+        {name: "Yet another PORO model!", serialized_by: "Version 1"},
+      ])
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require "application_fake"
+
+require "rspec/rails"
+
+require "active_model_serializers"
+require "active_model_serializers/namespaces"
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+
+  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
+
+  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
+
+  # TODO Enable it when the gem starts working properly.
+  # config.warnings = true
+
+end
+
+
+if ENV["RUN_COVERALLS"]
+  require "coveralls"
+  Coveralls.wear!
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: active_model_serializers-namespaces
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc
+platform: ruby
+authors:
+- Sebastian Skałacki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Enhances ActiveModel::Serializers gem by adding support for serializers
+  namespacing.  This makes developing versioned APIs super easy.  Works with ActiveModel::Serializers
+  0.8.x series.
+email:
+- skalee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model_serializers-namespaces.gemspec
+- gemfiles/Rails-3.2.gemfile
+- gemfiles/Rails-4.0.gemfile
+- gemfiles/Rails-4.1.gemfile
+- gemfiles/Rails-4.2.gemfile
+- gemfiles/common.gemfile
+- lib/active_model_serializers/namespaces.rb
+- lib/active_model_serializers/namespaces/version.rb
+- spec/application_fake.rb
+- spec/features_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/skalee/active_model_serializers-namespaces
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Namespaces support for ActiveModel::Serializers.
+test_files:
+- spec/application_fake.rb
+- spec/features_spec.rb
+- spec/spec_helper.rb
+has_rdoc: