representation 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'activerecord', '~> 3.0'
+gem 'activesupport', '~> 3.0'
+
+group :development do
+  gem 'rspec'
+  gem 'bundler', '~> 1.0.0'
+  gem 'jeweler', '~> 1.6.4'
+  gem 'sqlite3-ruby'
+  gem 'ruby-debug19'
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.4)
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    rake (0.9.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sqlite3-ruby (1.3.2)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  activesupport (~> 3.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rspec
+  ruby-debug19
+  sqlite3-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Chris Johnson, SocialVibe
+
+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,23 @@
+= representation
+
+Create different, named representations of a resource for cleaner state representation.
+
+= Install
+
+    gem 'representation'
+    bundle
+
+== Contributing to representation
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Chris Johnson, SocialVibe. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "representation"
+  gem.homepage = "http://github.com/findchris/representation"
+  gem.license = "MIT"
+  gem.summary = %Q{Model logical groups of attributes as different object representations.}
+  gem.description = %Q{Create different, named representations of a resource for cleaner state representation.}
+  gem.email = "findchris@gmail.com"
+  gem.authors = ["Chris Johnson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "representation #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/representation/active_record.rb

@@ -0,0 +1,52 @@
+require 'active_record'
+
+module Representation
+  module ActiveRecord
+    extend ActiveSupport::Concern
+  
+    included do
+      class_attribute :representations
+      self.representations = {}
+    end
+   
+    module ClassMethods
+      def representation(name, *attributes_and_method_names)
+        representations[name] = attributes_and_method_names
+      end
+      def representation_names
+        representations.keys
+      end
+      def values_for_representation(name)
+        representations[name]
+      end
+    end
+
+    module InstanceMethods
+      def representation(name)
+        attributes_and_method_names = self.class.values_for_representation(name)
+        represented_attributes = attributes_and_method_names.inject({}) do |attributes, val|
+          attributes.merge({val.to_s => send(val)})
+        end
+
+        clone.tap do |represented_object|
+          represented_object.instance_variable_set('@attributes', represented_attributes)
+        
+          represented_attributes.each do |key, value|
+            represented_object.singleton_class.send :attr_accessor, key.to_sym
+            represented_object.send "#{key}=".to_sym, value
+          end
+        
+          def represented_object.attributes
+            @attributes
+          end
+        
+          def represented_object.inspect
+            attributes_as_nice_string = @attributes.keys.map {|name| "#{name}: #{attribute_for_inspect(name)}"}
+            "#<#{self.class} #{attributes_as_nice_string.compact.join(", ")}>"
+          end
+        end
+      end
+    
+    end
+  end
+end

data/lib/representation.rb

@@ -0,0 +1,14 @@
+require 'representation/active_record'
+ActiveRecord::Base.send :include, Representation::ActiveRecord
+
+# TODO:  Maybe use a Railtie, e.g.:
+# module Representation
+#   class Railtie < Rails::Railtie
+#     initializer "representation.active_record" do
+#       ActiveSupport.on_load :active_record do
+#         require 'representation/active_record'
+#         include Representation::ActiveRecord
+#       end
+#     end
+#   end
+# end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'representation'

data/spec/representation_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ruby-debug'
+
+describe "Representation" do
+  context "the ActiveRecord module" do
+    it "should be includable" do
+      class Dummy
+        include Representation::ActiveRecord
+      end
+    end
+    it "should make available the representation class method" do
+      class Dummy
+        include Representation::ActiveRecord       
+        representation :ignored, :ignored
+        attr_accessor :ignored
+      end
+    end
+    it "should make available the representation instance method" do
+      class Dummy
+        include Representation::ActiveRecord     
+        representation :ignored, :ignored
+        attr_accessor :ignored
+      end
+      Dummy.new.representation(:ignored)
+    end
+  end
+  context ".representation" do
+    it "should accept the name of the representation as the first argument" do
+      class Dummy
+        include Representation::ActiveRecord        
+        representation :public, :ignored
+      end
+      Dummy.representation_names.should include(:public)
+    end
+    it "should accept a list of attributes and method names that make up the named representation" do
+      class Dummy
+        include Representation::ActiveRecord 
+        representation :public, :name, :calculated_age
+        
+        attr_accessor :name, :age
+        
+        def calculated_age
+          age * 2
+        end
+      end
+      Dummy.values_for_representation(:public).should == [:name, :calculated_age]
+    end
+  end
+  context "#representation" do
+    it "should return the same type of object as the receiver" do
+      user = User.new(:age => 42)
+      user.representation(:public).should be_an_instance_of(User)
+    end
+    it "should return an object with only the attributes identified by the representation definition" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      
+      public_user.name.should == 'Tweedle Dum'
+      public_user.calculated_age.should == 84
+      lambda { public_user.ssn }.should raise_error(NoMethodError)
+    end
+  end
+  context "when working with the representation object" do
+    it "should print an accurate #inspect string" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.inspect.should == '#<User name: "Tweedle Dum", calculated_age: 84>'
+    end
+    it "should have the @attributes ivar set correctly" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.instance_variable_get('@attributes').should == {'name' => 'Tweedle Dum', 'calculated_age' => 84}
+    end
+    it "should have have the #attributes method defined correctly" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.attributes.should == {'name' => 'Tweedle Dum', 'calculated_age' => 84}
+    end
+    it "should have attr_accessors set for each attribute of the representation" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.should respond_to(:name=)
+      public_user.name.should == 'Tweedle Dum'
+      public_user.should respond_to(:calculated_age=)
+      public_user.calculated_age.should == 84      
+    end
+    it "should allow multiple representations" do
+      user = User.create!(:name => 'Tweedle Dum', :age => 42, :ssn => '555-55-5555')
+      public_user = user.representation(:public)
+      internal_user = user.representation(:internal)
+      public_user.attributes.should == {'name' => 'Tweedle Dum', 'calculated_age' => 84}
+      internal_user.attributes.should == {'id' => 1, 'name' => 'Tweedle Dum', 'age' => 42, 'ssn' => '555-55-5555'}
+    end
+    it "should respond to to_json" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.should respond_to :to_json
+    end
+    it "should respond to to_xml" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.should respond_to :to_xml
+    end
+    it "should respond to as_json" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.should respond_to :as_json
+    end
+    it "should respond to serializable_hash" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.should respond_to :serializable_hash
+    end
+    it "should not modify the resource off of which the representation is based" do
+      user = User.new(:name => 'Tweedle Dum', :age => 42)
+      public_user = user.representation(:public)
+      public_user.name = 'Tweedle Dee'
+      user.name.should == 'Tweedle Dum'
+    end
+  end
+  context "ActiveRecord" do
+    it "should include the Representation module into ActiveRecord" do
+      class SomeModel < ActiveRecord::Base; end
+      SomeModel.should respond_to :representation
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'representation'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+load File.dirname(__FILE__) + '/support/connection.rb'
+load File.dirname(__FILE__) + '/support/schema.rb'
+load File.dirname(__FILE__) + '/support/models.rb'
+
+RSpec.configure do |config|
+  
+end
+

data/spec/support/connection.rb

@@ -0,0 +1,4 @@
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3", 
+  :database => File.dirname(__FILE__) + "/representation.sqlite3"
+)

data/spec/support/models.rb

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  include Representation        
+  representation :public, :name, :calculated_age
+  representation :internal, :id, :name, :ssn, :age
+
+  def calculated_age
+    age * 2
+  end
+end

data/spec/support/schema.rb

@@ -0,0 +1,10 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, :force => true do |t|
+    t.string  :name
+    t.integer :age
+    t.string  :ssn
+    t.timestamps
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: representation
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+description: Create different, named representations of a resource for cleaner state representation.
+email: findchris@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/representation.rb
+- lib/representation/active_record.rb
+- rails/init.rb
+- spec/representation_spec.rb
+- spec/spec_helper.rb
+- spec/support/connection.rb
+- spec/support/models.rb
+- spec/support/representation.sqlite3
+- spec/support/schema.rb
+has_rdoc: true
+homepage: http://github.com/findchris/representation
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -3487629241149015236
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Model logical groups of attributes as different object representations.
+test_files: []
+