serializable_decorator 0.0.1

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,3 @@
+--color
+--format progress
+--drb

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serializable-decorator.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+  gem 'spork'
+  gem 'autotest'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Andy Caldwell
+
+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,41 @@
+# SerializableDecorator
+
+An implementation of Delegate that groups the member variables of the delegator (a subclass of SerializableDecorator) together with those of the delegated object.  For example:
+
+    class MyDecorator < SerializableDecorator
+      :attr_accessor :foo
+    end
+
+    class SomeClass
+      :attr_accessor :bar
+    end
+
+    decorated_class = MyDecorator.new(SomeClass.new)
+    decorated_class.foo = "Hello"
+    decorated_class.bar = "World"
+    puts decorated_class.foo                 # => "Hello"
+    puts decorated_class.bar                 # => "World"
+    puts decorated_class.instance_variables  # => @foo and @bar
+    puts decorated_class.instance_values     # => { "foo" => "Hello", "bar" => "World" }
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serializable_decorator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serializable_decorator
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/serializable_decorator/version.rb

@@ -0,0 +1,5 @@
+module Delegators
+  module SerializableDecorator
+    VERSION = "0.0.1"
+  end
+end

data/lib/serializable_decorator.rb

@@ -0,0 +1,45 @@
+require 'serializable_decorator/version'
+require 'delegate'
+require 'json' unless Object.method_defined?(:to_json)
+
+class SerializableDecorator < Delegator
+
+  @@decorator_objects = {}
+  
+  def self.change_obj(decorator, obj)
+    @@decorator_objects[decorator.object_id] = obj
+  end
+
+  def self.get_obj(decorator)
+    @@decorator_objects[decorator.object_id]
+  end
+
+  def initialize(obj)
+    super
+    SerializableDecorator.change_obj(self, obj)
+  end
+
+  def __getobj__
+    SerializableDecorator.get_obj(self)
+  end
+
+  def __setobj__(obj)
+    SerializableDecorator.change_obj(self, obj)
+  end
+
+  def instance_variables
+    super + __getobj__.instance_variables
+  end
+
+  def instance_values
+    Hash[instance_variables.map { | name | [ name.to_s[1..-1], instance_variable_get(name) ] } ]
+  end
+
+  def instance_variable_get(name)
+    __getobj__.instance_variable_get(name) || super
+  end
+
+  def to_json
+    instance_values.to_json
+  end
+end

data/serializable-decorator.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/serializable_decorator/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andy Caldwell"]
+  gem.email         = ["andy.m.caldwell@googlemail.com"]
+  gem.description   = %q{A serializable decorator}
+  gem.summary       = %q{A concrete decorator implementation that can be serialized to JSON with the decoration included alongside the original attributes}
+  gem.homepage      = "https://github.com/bossmc/serializable-decorator"
+
+  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.name          = "serializable_decorator"
+  gem.require_paths = ["lib"]
+  gem.version       = Delegators::SerializableDecorator::VERSION
+
+  gem.add_runtime_dependency "json"
+
+  gem.add_development_dependency "rspec"
+end

data/spec/serializable_decorator_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class Test
+  attr_accessor :foo
+end
+
+class TestDecorator < SerializableDecorator
+  attr_accessor :bar
+end
+
+describe SerializableDecorator do
+  before(:each) do
+    @td = TestDecorator.new(Test.new)
+  end
+
+  it "Original attributes are still available" do
+    @td.foo.should be_nil
+    @td.foo = 12
+    @td.foo.should == 12
+  end
+
+  it "Decoration attributes should be available" do
+    @td.bar.should be_nil
+    @td.bar = 13
+    @td.bar.should == 13
+  end
+
+  it "Supports changing the decorated object" do
+    @td.foo = 12
+    @td.bar = 13
+    @td.__setobj__(Test.new)
+    @td.foo.should be_nil
+    @td.bar.should == 13
+  end
+
+  it "Can get list of attributes" do
+    @td.foo = 12
+    @td.bar = 13
+    @td.instance_variables.should include(:@foo)
+    @td.instance_variables.should include(:@bar)
+  end
+
+  it "Can retrieve original attributes by name" do
+    @td.foo = 12
+    @td.instance_variable_get("@foo").should == 12
+  end
+
+  it "Can retrieve decoration attributes by name" do
+    @td.bar = 13
+    @td.instance_variable_get("@bar").should == 13
+  end
+
+  it "Can retrieve all local variables with values" do
+    @td.foo = 12
+    @td.bar = 13
+    @td.instance_values.should include("foo" => 12)
+    @td.instance_values.should include("bar" => 13)
+  end
+
+  it "Can serialize original attributes to JSON" do
+    @td.foo = 12
+    @td.to_json.should include('"foo":12')
+  end
+
+  it "Can serialize decorated attributes to JSON" do
+    @td.bar = 13
+    @td.to_json.should include('"bar":13')
+  end
+
+  it "Should not report any extraneous variables" do
+    @td.instance_variables.should be_empty
+    @td.instance_values.should be_empty
+  end
+
+  it "Should not include any extraneous entries in the JSON output" do
+    @td.to_json.should == "{}"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'spork'
+require 'rspec'
+#uncomment the following line to use spork with the debugger
+#require 'spork/ext/ruby-debug'
+
+Spork.prefork do
+  RSpec.configure do |config|
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.run_all_when_everything_filtered = true
+    config.filter_run :focus
+  end
+end
+
+Spork.each_run do
+  # This code will be run each time you run your specs.
+  require 'serializable_decorator'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: serializable_decorator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andy Caldwell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A serializable decorator
+email:
+- andy.m.caldwell@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/serializable_decorator.rb
+- lib/serializable_decorator/version.rb
+- serializable-decorator.gemspec
+- spec/serializable_decorator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bossmc/serializable-decorator
+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: A concrete decorator implementation that can be serialized to JSON with the
+  decoration included alongside the original attributes
+test_files:
+- spec/serializable_decorator_spec.rb
+- spec/spec_helper.rb