proxy_for_template 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/lib/proxy_for_template/version.rb

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

data/lib/proxy_for_template.rb

@@ -0,0 +1,117 @@
+require "proxy_for_template/version"
+
+module ProxyForTemplate
+
+  module ClassMethods
+
+    def templated_methods
+      @templated_methods ||= Set.new
+    end
+
+    def template_accessor(*method_names)
+      method_names.each do |method|
+        attr_accessor method
+        define_proxy method
+      end
+    end
+
+    def template_method(*method_names)
+      method_names.each do |method|
+        define_proxy(method)
+      end
+    end
+
+    def within_rails?
+      @rails ||= defined?(ActiveRecord::Base)
+    end
+
+    def define_proxy(method_name)
+      templated_methods << method_name
+
+      define_attribute_methods if respond_to?(:define_attribute_methods)
+
+      read_method = method_name.to_s
+
+      define_proxy_read_method(read_method)
+    end
+
+    def define_proxy_read_method(method_name)
+      read_method = method_name.to_s
+
+      alias_method read_method + '_orig', read_method
+
+      define_method(read_method) do
+        proxy_read(read_method)
+      end
+
+      if(within_rails?)
+        define_method(read_method + '_before_type_cast') do
+          proxy_attribute_read(read_method)
+        end
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def template_takes_precedence(method)
+    true
+  end
+
+  def templated_methods
+    self.class.templated_methods
+  end
+
+  def proxy_attribute_read(method)
+
+    template_value = nil
+    self_value = nil
+
+    if(template_responds_to?(method))
+      template_value = template.attributes[method]
+    end
+
+    self_value = self.attributes[method]
+
+    if template_takes_precedence(method) && !(template_value.nil? || template_value == '')
+      self_value = template_value
+    end
+
+    self_value
+  end
+
+  def proxy_read(method)
+
+    template_value = nil
+    self_value = nil
+
+    if(template_responds_to?(method))
+      template_value = template.send(method)
+    end
+
+    self_value = self.send(method + '_orig')
+
+    if template_takes_precedence(method) && !(template_value.nil? || template_value == '')
+      self_value = template_value
+    end
+
+    self_value
+  end
+
+  def templated?(method)
+    value = nil
+
+    if(templated_methods.include?(method) && template_responds_to?(method))
+      value = template.send(method)
+    end
+
+    blank = (value.nil? || value == '')
+    !blank
+  end
+
+  def template_responds_to?(method)
+    (respond_to?(:template) && template && template.respond_to?(method))
+  end
+end

data/proxy_for_template.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "proxy_for_template/version"
+
+Gem::Specification.new do |s|
+  s.name        = "proxy_for_template"
+  s.version     = ProxyForTemplate::VERSION
+  s.authors     = ["Mike Emery"]
+  s.email       = ["philodoxx@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Allows method calls to be delegated to a template object.}
+  s.description = %q{Allows method calls to be delegated to a template object.}
+
+  s.rubyforge_project = "proxy_for_template"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "activerecord", '~> 2.3.10'
+  s.add_development_dependency "actionpack", '~> 2.3.10'
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "database_cleaner"
+  # s.add_runtime_dependency "rest-client"
+end

data/spec/activerecord_spec.rb

@@ -0,0 +1,114 @@
+require 'spec_helper'
+require 'active_record'
+require 'action_view'
+require 'action_pack'
+require 'database_cleaner'
+
+DatabaseCleaner.strategy = :truncation
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Base.logger
+ActiveRecord::Schema.define(:version => 1) do  
+  create_table :sporks do |t|
+    t.integer :some_value
+    t.references :template_id
+  end
+end
+
+class Spork < ActiveRecord::Base
+  belongs_to :template, :class_name => Spork.name
+  include ProxyForTemplate
+
+  attr_accessor :template_takes_precedence
+
+  def template_takes_precedence(method)
+    @template_takes_precedence.nil? ? true : @template_takes_precedence
+  end
+
+  template_method :some_value
+end
+
+describe ProxyForTemplate, '#activerecord' do
+
+  include ActionView::Helpers
+
+  before(:each) do
+    DatabaseCleaner.clean
+  end
+
+  after(:all) do
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.drop_table(table)
+    end
+  end
+
+  it "should still work if the template is nil" do
+    base = Spork.create(:some_value => 5)
+
+    base.some_value.should eq(5)
+  end
+
+  it "returns the template's property if it exists" do
+    template = Spork.create(:some_value => 10)
+    base = Spork.create(:some_value => 5, :template => template)
+
+    base.some_value.should eq(10)
+  end
+
+  it "returns the child's property if the template's doesn't exist" do
+    template = Spork.create(:some_value => nil)
+    base = Spork.create(:some_value => 5, :template => template)
+
+    base.some_value.should eq(5)
+  end
+
+  it "should not overwrite the template's property" do
+    template = Spork.create(:some_value => 10)
+    base = Spork.create(:some_value => 5, :template => template)
+
+    base.some_value = 12
+
+    base.some_value.should eq(10)
+
+    template.some_value = nil
+
+    base.some_value.should eq(12)
+  end
+  
+  it 'should not update the local copy whenever the attribute is read' do
+    
+    template = Spork.create(:some_value => 123)
+    base = Spork.create(:some_value => 5, :template => template)
+    
+    base.some_value.should eq(123)
+    base.template = nil
+    base.some_value.should eq(5)
+  end
+
+  it 'should allow write if the template does not have the property' do
+    template = Spork.create(:some_value => nil)
+    base = Spork.create(:some_value => 5, :template => template)
+
+    base.some_value.should eq(5)
+    base.some_value = 12
+
+    base.some_value.should eq(12)
+  end
+
+  it 'should proxy value_before_type_cast' do
+    template = Spork.create(:some_value => 10)
+    base = Spork.create(:some_value => 5, :template => template)
+
+    base.some_value_before_type_cast.should eq(10)
+  end
+
+  it 'the base should take precedence over the template when specified and using before type cast' do
+    template = Spork.create(:some_value => 10)
+    base = Spork.create(:some_value => 5, :template => template)
+    
+    base.template_takes_precedence = false
+
+    base.some_value_before_type_cast.should eq(5)
+  end
+end

data/spec/proxy_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+
+class Foo
+  include ProxyForTemplate
+
+  template_accessor :a
+  attr_accessor :b
+  attr_writer :template_takes_precedence
+
+  attr_accessor :template
+
+  def template_takes_precedence(method)
+    @template_takes_precedence
+  end
+
+  def initialize
+    @template = Bar.new('abc123')
+    @a = 'abc'
+    @b = '123'
+    @template_takes_precedence = true
+  end
+end
+
+class Bar
+  attr_accessor :a
+
+  def initialize(a)
+    @a = a
+  end
+end
+
+describe ProxyForTemplate do
+
+  before(:each) do
+    @f = Foo.new
+  end
+
+  it "should still work if the template is nil" do
+    @f.template = nil
+    @f.a.should eq('abc')
+    @f.b.should eq('123')
+  end
+
+  it "returns the template's property if it exists" do
+    @f.a.should eq('abc123')
+  end
+
+  it "returns the child's property if the templates doesn't exist" do
+    @f.b.should eq('123')
+  end
+
+  it "should not overwrite the template's property" do
+    @f.a = 'arg'
+    @f.a.should eq('abc123')
+  end
+
+  it 'should allow write if the template does not have the property' do
+    @f.b = 'arg'
+    @f.b.should eq('arg')
+  end
+
+  it 'should use the base value if the templates is blank' do
+    @f.template.a = nil
+    @f.a.should eq('abc')
+
+    @f.template.a = ''
+    @f.a.should eq('abc')
+  end
+
+  it 'Templated class should list its templated methods' do
+    @f.class.templated_methods.to_a.should eq([:a])
+  end
+
+  it 'templated object should list its templated methods' do
+    @f.templated_methods.to_a.should eq([:a])
+  end
+
+  it 'should tell you which methods are templated' do
+    @f.templated?(:a).should eq(true)
+    @f.templated?(:b).should eq(false)
+  end
+
+  it 'should update the local copy whenever the attribute is read' do
+    @f.a.should eq('abc123')
+    @f.template = nil
+    @f.a.should eq('abc')
+  end
+
+  it "should be able to control whether proxying is turned off or on" do
+    @f.template_takes_precedence(:a).should eq(true)
+    @f.template_takes_precedence = false
+    @f.template_takes_precedence(:a).should eq(false)
+  end
+
+  it 'the template should not take precedence if its marked as a theme' do
+    @f.template_takes_precedence = false
+
+    @f.template_takes_precedence(:a).should eq(false)
+
+    @f.a = 123
+    @f.a.should eq(123)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'proxy_for_template' # and any other gems you need
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: proxy_for_template
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Emery
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 3
+        - 10
+        version: 2.3.10
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 3
+        - 10
+        version: 2.3.10
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Allows method calls to be delegated to a template object.
+email: 
+- philodoxx@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/proxy_for_template.rb
+- lib/proxy_for_template/version.rb
+- proxy_for_template.gemspec
+- spec/activerecord_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: proxy_for_template
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Allows method calls to be delegated to a template object.
+test_files: 
+- spec/activerecord_spec.rb
+- spec/proxy_spec.rb
+- spec/spec_helper.rb