cereal_box 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2@cereal_box --create

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+script: "bundle exec rake spec"
+gemfile:
+  - Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cereal_box.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    cereal_box (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    guard (0.8.4)
+      thor (~> 0.14.6)
+    guard-rspec (0.5.0)
+      guard (>= 0.8.4)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    thor (0.14.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  cereal_box!
+  guard
+  guard-rspec
+  rake
+  rspec

data/Guardfile

@@ -0,0 +1,21 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Christopher Meiklejohn
+
+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.rdoc

@@ -0,0 +1,60 @@
+= Cereal box.
+
+Serialization filters for active record.
+
+== Motivation
+
+Ever have a controller that looks like this?
+
+    class ThingController < ActionController::Base
+      respond_to :json
+
+      def show
+        @thing = Thing.find(1)
+        @thing = @thing.as_json 
+        @thing[:other_things][:name] = thing.other_thing.name
+        @thing[:other_related_thing][:name] = thing.other_related_thing.name
+
+        respond_with(@thing)
+      end
+    end
+
+Specifically adding additional related information from other models
+into the serialized hash of an object?  Well, no more!
+
+Doesn't this look better?
+
+    class ThingController < ActionController::Base
+      respond_to :json
+
+      def show
+        @thing = Thing.find(1)
+
+        respond_with(OtherRelatedThingFilter.new(ThingFilter.new(@thing))
+      end
+    end
+
+== Filters
+
+=== Implement a filter
+
+It's simple!  Just define a module that includes cereal_box and
+implements an attributes method.
+
+    module OtherThingFilter
+      include CerealBox
+
+      def attributes(base)
+        { :name => base.other_thing.name }
+      end
+    end
+
+Filters support as_xml, as_json and serializable_hash.
+
+== License
+
+Cereal Box is Copyright © 2011 Christopher Meiklejohn.  It is free software, and may be redistributed under the terms specified in the LICENSE file.
+
+== About
+
+The cereal_box gem was written by {Christopher Meiklejohn}[mailto:cmeiklejohn@swipely.com] from {Swipely, Inc.}[http://www.swipely.com].

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rdoc.options << '-f' << 'horo'
+end

data/cereal_box.gemspec

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "cereal_box/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cereal_box"
+  s.version     = CerealBox::VERSION
+  s.authors     = ["Christopher Meiklejohn"]
+  s.email       = ["christopher.meiklejohn@gmail.com"]
+  s.homepage    = "https://github.com/cmeiklejohn/cereal_box"
+  s.summary     = %q{Serialization filters for active record.}
+  s.description = %q{Serialization filters for active record.}
+
+  s.rubyforge_project = "cereal_box"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('bundler')
+  s.add_development_dependency('rspec') 
+  s.add_development_dependency('guard') 
+  s.add_development_dependency('guard-rspec')
+  s.add_development_dependency('rake')
+end

data/lib/cereal_box/version.rb

@@ -0,0 +1,3 @@
+module CerealBox
+  VERSION = "0.0.1"
+end

data/lib/cereal_box.rb

@@ -0,0 +1,37 @@
+require "cereal_box/version"
+
+module CerealBox
+
+  def self.included?(base)
+    base.attr_accessor :cereal_box_base_instance
+    base.attr_accessor :cereal_box_previous_filter
+  end
+
+  def initialize(base)
+    @cereal_box_base_instance = base
+  end
+
+  def cereal_box_node_name
+    self.class.to_s.split(/(?=[A-Z])/).map{ |w| w.downcase }[0...-1].join("_").to_sym
+  end
+
+  def serializable_hash(options = {})
+    apply(:serializable_hash, options)
+  end
+
+  def as_json(options = {}) 
+    apply(:as_json, options)
+  end
+
+  def as_xml(options = {}) 
+    apply(:as_xml, options)
+  end
+
+  def apply(message, options = {})
+    target = @cereal_box_previous_filter ? @cereal_box_previous_filter : @cereal_box_base_instance
+    target.send(message.to_sym, options).merge(
+      { cereal_box_node_name => self.send(:attributes, @cereal_box_base_instance) }
+    )
+  end
+
+end

data/spec/cereal_box_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+class Base
+  def c
+    "ceee"
+  end
+
+  def as_xml(options = {})
+    { :a => "a" }
+  end
+
+  def serializable_hash(options = {})
+    { :a => "a" }
+  end
+
+  def as_json(options = {})
+    { :a => "a" }
+  end
+end
+
+class AdditiveFilter
+  include CerealBox
+
+  def attributes(base)
+    { :b => "b", :c => base.c }
+  end
+end
+
+class SecondAdditiveFilter
+  include CerealBox
+
+  def attributes(base)
+    { :d => "d" }
+  end
+end
+
+describe CerealBox do 
+
+  describe 'with the base class' do 
+    subject { Base.new } 
+
+    it 'should serialize the base class correctly' do 
+      subject.as_json.keys.should include :a
+    end
+  end
+
+  describe 'with one additive filter' do 
+    subject { AdditiveFilter.new(Base.new) } 
+
+    it 'should include the base attributes' do 
+      subject.as_json.keys.should include :a
+    end
+
+    it 'should include the additional direct attributes' do 
+      subject.as_json[:additive].should include :b
+    end
+
+    it 'should include the additional method attributes' do 
+      subject.as_json[:additive].should include :c
+      subject.as_json[:additive][:c].should == "ceee"
+    end
+  end
+
+  describe 'with two additive filters' do 
+    subject { SecondAdditiveFilter.new(AdditiveFilter.new(Base.new)) } 
+
+    it 'should include the base attributes' do 
+      subject.as_json.keys.should include :a
+    end
+
+    it 'should include the additional direct attributes' do 
+      subject.as_json[:additive].should include :b
+    end
+
+    it 'should include the additional method attributes' do 
+      subject.as_json[:additive].should include :c
+      subject.as_json[:additive][:c].should == "ceee"
+    end
+
+    it 'should include the additional method attributes' do 
+      subject.as_json[:second_additive].should include :d
+    end
+  end
+
+  describe 'with one additive filter and using serializable_hash' do 
+    subject { AdditiveFilter.new(Base.new) } 
+
+    it 'should include the base attributes' do 
+      subject.serializable_hash.keys.should include :a
+    end
+
+    it 'should include the additional direct attributes' do 
+      subject.serializable_hash[:additive].should include :b
+    end
+
+    it 'should include the additional method attributes' do 
+      subject.serializable_hash[:additive].should include :c
+      subject.serializable_hash[:additive][:c].should == "ceee"
+    end
+  end
+
+  describe 'with one additive filter and using as_xml' do 
+    subject { AdditiveFilter.new(Base.new) } 
+
+    it 'should include the base attributes' do 
+      subject.as_xml.keys.should include :a
+    end
+
+    it 'should include the additional direct attributes' do 
+      subject.as_xml[:additive].should include :b
+    end
+
+    it 'should include the additional method attributes' do 
+      subject.as_xml[:additive].should include :c
+      subject.as_xml[:additive][:c].should == "ceee"
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+ENV["RAILS_ENV"] ||= "test"
+
+PROJECT_ROOT = File.expand_path("../..", __FILE__)
+$LOAD_PATH << File.join(PROJECT_ROOT, "lib")
+
+Bundler.require
+
+require 'cereal_box'

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: cereal_box
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christopher Meiklejohn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-13 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &18087140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18087140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &18086120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18086120
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &18084760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18084760
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &18082860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18082860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &18050160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *18050160
+description: Serialization filters for active record.
+email:
+- christopher.meiklejohn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- cereal_box.gemspec
+- lib/cereal_box.rb
+- lib/cereal_box/version.rb
+- spec/cereal_box_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/cmeiklejohn/cereal_box
+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'
+      segments:
+      - 0
+      hash: 2025275564822566330
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2025275564822566330
+requirements: []
+rubyforge_project: cereal_box
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Serialization filters for active record.
+test_files: []