active_model_version_serializers 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,5 @@
+rvm:
+  - 1.9.3
+  - ree
+  - jruby
+  - rbx

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in active_model_version_serializer.gemspec
+gemspec
+
+gem "pry"
+gem "simplecov", :require => false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 hookercookerman
+
+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,111 @@
+[![Build
+Status](https://secure.travis-ci.org/hookercookerman/active_model_version_serializers.png)](http://travis-ci.org/hookercookerman/active_model_version_serializers)
+
+# ActiveModel::VersionSerializer
+
+fairly short name. This is a little spin on active model serializers
+
+# what is that?
+
+The purpose of `ActiveModel::Serializers` is to provide an object to
+encapsulate serialization of `ActiveModel` objects, including `ActiveRecord`
+objects.
+
+Serializers know about both a model and the `current_user`, so you can
+customize serialization based upon whether a user is authorized to see the
+content.
+
+In short, **serializers replaces hash-driven development with object-oriented
+development.**
+
+More Information Go See [ActiveModel::Serializer](https://github.com/josevalim/active_model_serializers)
+# Versioning
+
+## Why?
+
+Good Question!
+
+When building an api; one would go through various changes in terms of 
+versioning. you could seperate this out into modules and that is my 
+perfered way. But hey why not have a place where you can easily see
+changes in an expressive way.
+
+## Show Me 
+
+Has the same api as active_model_serializers however we can define
+a named version block. it also has some extra source for using
+previously defined version attributes.
+
+Notice we inherit from `ActiveModel::VersionSerializer`
+
+```ruby
+class UserSerializer < ActiveModel::VersionSerializer
+
+  version :v1 do
+    attributes :name, :remote_image, :likes_beans, :id
+  end
+
+  version :v2 do
+    version_attributes :v1, without: [:likes_beans, :remote_image]
+  end
+
+  version :v3 do
+    version_attributes :v1, with: :date_of_birth
+    embed :ids, :include => true
+    has_many :turns
+  end
+end
+```
+## Explict Version
+
+```ruby
+UserSerializer.new(user, version: v3)
+```
+
+## Controller
+
+`ActiveModel::Serializers` gives you some controller goodness in terms
+of defining scope for your serializers but you now also specify a
+version.
+
+```ruby
+    # Any logic that you have to determine the version wanted for that request
+    # can go here!
+    def default_serializer_options
+      {version: some_method_determining_version}
+    end
+```
+
+## I want to specify a default VERSION
+
+ok
+
+```ruby
+ActiveModel::VersionSerializer.default :v3
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'active_model_version_serializers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_model_version_serializers
+
+## Usage
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+desc "Run the specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+task :default => :spec

data/active_model_version_serializers.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_model/version_serializers/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "active_model_version_serializers"
+  gem.version       = ActiveModel::VersionSerializer::VERSION
+  gem.authors       = ["hookercookerman"]
+  gem.email         = ["hookercookerman@gmail.com"]
+  gem.description   = %q{Active Model Serializer with versioning}
+  gem.summary       = %q{Active Model Serializer with versioning}
+  gem.homepage      = "http://thehitchhikerprinciple.com"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'active_model_serializers', '~>0.5.2'
+  gem.add_dependency "activesupport", ">= 3.0.0"
+  
+  gem.add_development_dependency "rspec", "~> 2.11.0"
+  gem.add_development_dependency "factory_girl", "~> 4.0.0"
+  gem.add_development_dependency "fuubar", "~> 1.0.0"
+  gem.add_development_dependency "activemodel", "~> 3.2.8"
+end

data/lib/active_model/version_serializer.rb

@@ -0,0 +1,107 @@
+require "active_model_serializers"
+require "active_support/concern"
+require 'active_support/core_ext/class/attribute_accessors'
+require 'active_support/core_ext/hash/slice'
+
+module ActiveModel
+  class VersionSerializer
+    class_attribute :_versions, :_default, :_root, :_name
+    self._versions, self._default = {}, :v1
+    attr_reader :object, :options, :version, :vklass
+
+    def initialize(object, options = {})
+      @object, @options = object, options
+      @version = @options[:version] || _default
+      @vklass = self._versions[@version]
+      @vinstance = @vklass.new(@object, @options)
+    end
+
+    def self.default(version)
+      self._default = version
+    end
+
+    # Defines the root used on serialization. If false, disables the root.
+    def self.root(name)
+      self._root = name
+    end
+
+    # Replication of inherited from active_model_serializer but we 
+    # get the name so we can define the correct name on each version
+    #
+    # of defined active model serializers
+    def self.inherited(klass) #:nodoc:
+      return if klass.anonymous?
+      name = klass.name.demodulize.underscore.sub(/_serializer$/, '')
+      self._name = name
+      klass.class_eval do
+        alias_method name.to_sym, :object
+        root name.to_sym unless self._root == false
+      end
+    end
+
+    # creates a anoymous subclass of ActiveModel::Serializer
+    # setting the root from base alias of the serialbe object
+    # with the name
+    #
+    # version_attributes so less typing if the versions are similar
+    # options :with and :without.
+    #
+    # @example
+    #   version :v1 do
+    #     attributes :beans, :eggs
+    #   end
+    #
+    #   version :v2 do
+    #     version_attributes :v1, with: :toast
+    #   end
+    #
+    # @param [Symbol] version
+    # @param [Proc] block
+    def self.version(version, &block)
+      base_class = self
+      vklass = Class.new(ActiveModel::Serializer) do
+        self.root(base_class._root)
+        alias_method base_class._name.to_sym, :object
+
+        singleton_class.class_eval do
+          define_method(:to_s) do
+            "(#{base_class.name} VERSION: #{version})"
+          end
+          alias inspect to_s
+        end
+
+        define_singleton_method(:version_attributes) do |v, options = {}|
+          version_attributes = base_class._versions[v]._attributes.keys
+          version_options = options.extract!(:without, :with)
+          if with_attributes = version_options[:with]
+            version_attributes = (version_attributes + [*with_attributes])
+          end
+          if without_attributes = version_options[:without]
+            version_attributes = (version_attributes - [*without_attributes])
+          end
+          attributes(*version_attributes)
+        end
+        self.class_eval(&block)
+      end
+
+      # mutables with class attribute use setters!
+      self._versions = self._versions.merge({version => vklass})
+    end
+
+  private
+    def method_missing(method, *args)
+      if @vinstance.respond_to?(method)
+        @vinstance.send(method, *args)
+      else
+        super
+      end
+    end
+
+    # lets be nice to method
+    def respond_to_missing?(method_name, include_private = false)
+      @vinstance.respond_to_missing?(method_name, include_private)
+    end
+
+  end
+end
+

data/lib/active_model/version_serializers/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  class VersionSerializer
+    VERSION = "0.0.2"
+  end
+end

data/lib/active_model_version_serializers.rb

@@ -0,0 +1 @@
+require "active_model/version_serializer"

data/spec/scenerio/user_serialization_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe "UserSerialization" do
+  context "v1" do
+    context "serialization of a user object" do
+      let(:user_attributes) do
+        FactoryGirl.attributes_for(:v1_user)
+      end
+
+      let(:user) do
+        FactoryGirl.build(:v1_user, user_attributes)
+      end
+
+      let(:user_serializer) do
+        UserSerializer.new(user)
+      end
+
+      subject{user_serializer.as_json}
+      it{should eq({user: user_attributes})}
+    end
+  end
+
+  context "v2" do
+    let(:user_attributes) do
+      FactoryGirl.attributes_for(:v2_user)
+    end
+
+    let(:user) do
+      FactoryGirl.build(:v2_user, user_attributes)
+    end
+
+    let(:user_serializer) do
+      UserSerializer.new(user, version: :v2)
+    end
+
+    subject{user_serializer.as_json}
+    it{should eq({user: user_attributes})}
+  end
+
+  context "v3" do
+    let(:user_attributes) do
+      FactoryGirl.attributes_for(:v3_user)
+    end
+
+    let(:turn_attributes_1) do
+      FactoryGirl.attributes_for :v3_turn
+    end
+
+    let(:turn_attributes_2) do
+      FactoryGirl.attributes_for :v3_turn
+    end
+
+    let(:turn_attributes_3) do
+      FactoryGirl.attributes_for :v3_turn
+    end
+
+    let(:turn_1) do
+      FactoryGirl.build(:v3_turn, turn_attributes_1)
+    end
+
+    let(:turn_2) do
+      FactoryGirl.build(:v3_turn, turn_attributes_2)
+    end
+
+    let(:turn_3) do
+      FactoryGirl.build(:v3_turn, turn_attributes_3)
+    end
+
+    let(:turns) do
+      [turn_1, turn_2, turn_3]
+    end
+
+    let(:turn_attributes) do
+      [turn_attributes_1, turn_attributes_2, turn_attributes_3]
+    end
+
+    let(:user) do
+      FactoryGirl.build(:v3_user, user_attributes.merge(turns: turns))
+    end
+
+    let(:user_serializer) do
+      UserSerializer.new(user, version: :v3)
+    end
+
+    subject{user_serializer.as_json}
+    it{should eq({user: user_attributes.merge(turns: [1,2,3]), turns: turn_attributes})}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "bundler/setup"
+
+unless ENV["TRAVIS"]
+  require 'simplecov'
+  SimpleCov.start do
+    add_group "lib", "lib"
+    add_group "spec", "spec"
+  end
+end
+
+require "pry"
+require "active_model_version_serializers"
+
+Dir.glob(File.expand_path('../../spec/support/**/*.rb', __FILE__)) do |file|
+  require file
+end
+
+RSpec.configure do |config|
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.after(:each) do
+    ActiveModel::VersionSerializer.default :v1 
+  end
+end

data/spec/support/factories.rb

@@ -0,0 +1,46 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+
+  factory :user do
+    trait :base do
+      sequence(:id)
+      name {'Richardo Alfrono'}
+    end
+
+    trait :version_1 do
+      remote_image { "http://placekitten.com/400/400" }
+      likes_beans { true}
+    end
+
+    trait :version_2 do
+      likes_eggs {true}
+    end
+
+    trait :version_3 do
+      date_of_birth { Time.now }
+    end
+
+    factory :v1_user,    traits: [:base, :version_1]
+    factory :v2_user,    traits: [:base]
+    factory :v3_user,    traits: [:base, :version_1, :version_3]
+    factory :v4_user,    traits: [:base, :version_1, :version_2]
+  end
+
+  factory :turn do
+
+    trait :turn_version_1 do
+      sequence(:id)
+      name {"Doing the eggs"}
+      score {7}
+    end
+
+    trait :turn_version_2 do
+      image {"http://placekitten.com/400/400"} 
+    end
+    factory :v1_turn,    traits: [:turn_version_1]
+    factory :v2_turn,    traits: [:turn_version_1, :turn_version_2]
+    factory :v3_turn,    traits: [:turn_version_1, :turn_version_2]
+    factory :v4_turn,    traits: [:turn_version_1, :turn_version_2]
+  end
+end

data/spec/support/models/turn.rb

@@ -0,0 +1,4 @@
+class Turn
+  include ActiveModel::SerializerSupport
+  attr_accessor :name, :score, :image, :id
+end

data/spec/support/models/user.rb

@@ -0,0 +1,4 @@
+class User
+  include ActiveModel::SerializerSupport
+  attr_accessor :name, :date_of_birth, :likes_eggs, :likes_beans, :remote_image, :turns, :id
+end

data/spec/support/serializers/turn_serializer.rb

@@ -0,0 +1,15 @@
+class TurnSerializer < ActiveModel::VersionSerializer
+
+  version :v1 do
+    attributes :id, :name, :score
+  end
+
+  version :v2 do
+    version_attributes :v1, without: :score
+  end
+
+  version :v3 do
+    version_attributes :v1, with: :image
+  end
+
+end

data/spec/support/serializers/user_serializer.rb

@@ -0,0 +1,17 @@
+class UserSerializer < ActiveModel::VersionSerializer
+
+  version :v1 do
+    attributes :name, :remote_image, :likes_beans, :id
+  end
+
+  version :v2 do
+    version_attributes :v1, without: [:likes_beans, :remote_image]
+  end
+
+  version :v3 do
+    version_attributes :v1, with: :date_of_birth
+    embed :ids, :include => true
+    has_many :turns
+  end
+end
+

data/spec/version_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require File.expand_path("../spec_helper", __FILE__)
+
+describe "Active Model Serializing With Versioning" do
+  context "VersionSerializer" do
+    subject{ActiveModel::VersionSerializer}
+    its(:_default){should eq(:v1)}
+    it{should respond_to :version}
+  end
+
+  context "defining an new default" do
+    describe "#default" do
+      before do
+        ActiveModel::VersionSerializer.default :v2
+      end
+      subject{ActiveModel::VersionSerializer} 
+      its(:_default){should eq(:v2)}
+    end
+
+    context "subclasses"do
+      before do
+        ActiveModel::VersionSerializer.default :v2
+      end
+      subject{UserSerializer}
+      its(:_default){should eq(:v2)}
+      context "chaning again" do
+        before do
+          ActiveModel::VersionSerializer.default :v3
+        end
+        its(:_default){should eq(:v3)}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: active_model_version_serializers
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- hookercookerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_model_serializers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+description: Active Model Serializer with versioning
+email:
+- hookercookerman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_model_version_serializers.gemspec
+- lib/active_model/version_serializer.rb
+- lib/active_model/version_serializers/version.rb
+- lib/active_model_version_serializers.rb
+- spec/scenerio/user_serialization_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models/turn.rb
+- spec/support/models/user.rb
+- spec/support/serializers/turn_serializer.rb
+- spec/support/serializers/user_serializer.rb
+- spec/version_spec.rb
+homepage: http://thehitchhikerprinciple.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Active Model Serializer with versioning
+test_files:
+- spec/scenerio/user_serialization_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/models/turn.rb
+- spec/support/models/user.rb
+- spec/support/serializers/turn_serializer.rb
+- spec/support/serializers/user_serializer.rb
+- spec/version_spec.rb
+has_rdoc: