acts_as 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff4949b83af1313de02dd223cfa667b8914d03c2
+  data.tar.gz: 950527f10b751bcbeeda69c7816a51924a1de69a
+SHA512:
+  metadata.gz: b024ee340ef12fa6bc5aaa3380de1993ba5fbc349fec88f2a93f39632a0c39ca7a030da2905f45eae69764d4269bca0db46901ceaf18881a4e9832bc2f7ece72
+  data.tar.gz: 186fc903daca73350d57ab4a30ecfd2454a4a567153735a437f478033d892d0ed524b7f4fc62a9508a50bb746c4a340e3f1ada2068bfb5ccdad2d53ec497bfc4

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/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+ruby '2.0.0'
+
+# Specify your gem's dependencies in acts_as.gemspec
+gemspec
+
+gem 'activerecord'
+
+group :test do
+  gem 'pry'
+  gem 'rspec'
+  gem 'sqlite3'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 winfred
+
+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,95 @@
+# ActsAs
+
+ActiveRecord extension for easy 1:1 composition delegation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as
+
+## Usage
+
+```ruby
+
+# table :users
+#   name :string
+#
+class User
+  include ActsAs
+end
+
+class Rebel < User
+  has_one :profile, class_name: 'RebelProfile', autosave: true
+  belongs_to :clan, autosave: true
+  acts_as :profile
+  acts_as :clan, prefix: %w( name ), whitelist: %w( delegate_at_will )
+end
+
+# table :clans
+#   name :string
+#   strength :integer
+#   cool :boolean
+#
+class Clan < ActiveRecord::Base
+  has_many :rebels
+
+  def delegate_at_will
+    '10'
+  end
+end
+
+# table :rebel_profiles
+#   rebel_id :integer
+#   serial_data :string
+#
+class RebelProfile < ActiveRecord::Base
+  belongs_to :rebel
+end
+
+```
+
+Now a whole slew of methods related to ActiveRecord attributes are available for the fields being delegated to another table
+
+    # Fully Proxied Setters/Getters
+    rebel.strength = 10
+    rebel.clan.strength = 20
+    rebel.strength #=> 20
+
+    # ActiveModel::Dirty helpers
+    rebel.strength_was #=> 10
+
+    # Shorthand for prefix-delegating specific fields
+    rebel.clan_name #=> rebel.clan.name
+
+    # Automagic boolean helpers
+    rebel.cool? #=> rebel.clan.cool?
+
+    # Any method you want
+    rebel.delegate_at_will #=> '10'
+
+
+## To be considered
+
+How does the active record join hash-parsing stuff work? EX-
+
+    Rebel.joins(:clan).where(clan: {cool: true)
+
+Can we make this work for ruby-sql autojoins? Is that even a good idea?
+    Rebel.where(cool: true)
+
+## 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 @@
+require "bundler/gem_tasks"

data/acts_as.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as"
+  spec.version       = ActsAs::VERSION
+  spec.authors       = ["winfred"]
+  spec.email         = ["winfred@developerauction.com"]
+  spec.description   = %q{ActiveRecord extension for easy STI Delegation}
+  spec.summary       = %q{ delegate an entire 1:1 association worth of active record field-related helpers }
+  spec.homepage      = "http://github.com/wnadeau/acts_as"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/acts_as/version.rb

@@ -0,0 +1,3 @@
+module ActsAs
+  VERSION = "0.0.2"
+end

data/lib/acts_as.rb

@@ -0,0 +1,77 @@
+require "acts_as/version"
+
+module ActsAs
+  class ActsAs::ActiveRecordOnly < StandardError; end
+
+  PREFIX = %w(id created_at updated_at)
+  ACTING_FOR = {}
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  private
+
+  def acts_as_field_match?(method)
+    @association_match = ACTING_FOR.select do |association, fields|
+      fields.select { |f| method.to_s.include?(f) }.any?
+    end.keys.first
+    @association_match && send(@association_match).respond_to?(method)
+  end
+
+  module ClassMethods
+    def acts_as(one_association, prefix: [], whitelist: [])
+      define_method(one_association) do |*args|
+        super(*args) || send("build_#{one_association}", *args)
+      end
+
+
+      association_class = new.send(one_association).class
+      if association_class.table_exists?
+
+        whitelist_and_delegate_fields(association_class, one_association, prefix, whitelist)
+
+        define_method :method_missing do |method, *args, &block|
+          if acts_as_field_match?(method) then
+            send(@association_match).send(method, *args, &block)
+          else
+            super(method, *args, &block)
+          end
+        end
+
+        define_method :respond_to? do |method, *args, &block|
+          acts_as_field_match?(method) || super(method, *args, &block)
+        end
+      end
+    end
+
+
+    private
+
+    def whitelist_and_delegate_fields(association_class, one_association, prefix, whitelist)
+      association_fields = association_class.columns.map(&:name) - PREFIX - prefix + whitelist
+
+      build_prefix_methods(one_association, prefix)
+
+      attr_accessible *association_fields
+      attr_accessible *prefix.map { |field| "#{one_association}_#{field}" }
+
+      delegate(*(association_fields + association_fields.map { |field| "#{field}=" }), to: one_association)
+
+      #TODO: This feels like a weird place to remember delegated fields
+      ACTING_FOR[one_association] = association_fields + prefix
+    end
+
+    def build_prefix_methods(one_association, prefix)
+      prefix.each do |field|
+        define_method("#{one_association}_#{field}") do |*args|
+          send(one_association).send(field, *args)
+        end
+
+        define_method("#{one_association}_#{field}=") do |*args|
+          send(one_association).send("#{field}=", *args)
+        end
+      end
+    end
+  end
+end

data/spec/acts_for_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'support/active_record'
+
+class User < ActiveRecord::Base
+  include ActsAs
+end
+
+class RebelProfile < ActiveRecord::Base
+  belongs_to :rebel
+end
+
+class ImperialProfile < ActiveRecord::Base
+  belongs_to :imperial
+end
+
+class Clan < ActiveRecord::Base
+  has_many :rebels
+
+  def delegate_at_will
+    '10'
+  end
+end
+
+class Rebel < User
+  has_one :profile, class_name: 'RebelProfile', autosave: true
+  belongs_to :clan, autosave: true
+  acts_as :profile
+  acts_as :clan, prefix: %w( name ), whitelist: %w( delegate_at_will )
+end
+
+class Imperial < User
+  has_one :profile, class_name: 'ImperialProfile'
+  acts_as :profile
+end
+
+
+
+describe ActsAs do
+
+  let(:rebel) { Rebel.create(name: "Leia", clan_name: "Organa") }
+  subject { rebel }
+
+  describe 'whitelist' do
+    it { should respond_to(:delegate_at_will) }
+    its(:delegate_at_will) { should == rebel.clan.delegate_at_will  }
+  end
+
+  describe 'proxied getters and setters' do
+    it { should respond_to(:strength) }
+    its(:strength) { should == rebel.clan.strength }
+    it { should respond_to(:strength=) }
+    it 'defines setters as well' do
+      expect { rebel.strength += 50 }.to change{ rebel.clan.strength }.by(50)
+    end
+
+    context 'for imperial class' do
+      subject { Imperial.create(name: "Darth Vader", analog_data: "CHhhawww phheerrrrr") }
+      it { should respond_to(:analog_data) }
+    end
+  end
+
+  describe 'prefix fields' do
+    it { should respond_to(:clan_name) }
+    its(:clan_name) { should == rebel.clan.name }
+  end
+
+  describe 'dirty helpers' do
+    before { rebel.strength = 10 }
+    it { should respond_to(:strength_was) }
+    its(:strength_was) { should equal(rebel.clan.strength_was) }
+    its(:strength_was) { should equal(50) }
+    its(:strength) { should equal(rebel.clan.strength) }
+    its(:strength) { should equal(10) }
+  end
+
+  describe 'boolean helpers' do
+    it { should respond_to(:cool?)}
+    specify { rebel.should_not be_cool }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry'
+
+require 'acts_as'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

data/spec/support/active_record.rb

@@ -0,0 +1,31 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migrator.up "db/migrate"
+
+ActiveRecord::Migration.create_table :users do |t|
+  t.string :name
+  t.string :type
+  t.integer :clan_id
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :rebel_profiles do |t|
+  t.integer :rebel_id
+  t.string :serial_data
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :imperial_profiles do |t|
+  t.integer :imperial_id
+  t.string :analog_data
+  t.timestamps
+end
+
+ActiveRecord::Migration.create_table :clans do |t|
+  t.string :name
+  t.integer :strength, default: 50
+  t.boolean :cool
+  t.timestamps
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: acts_as
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- winfred
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord extension for easy STI Delegation
+email:
+- winfred@developerauction.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as.gemspec
+- lib/acts_as.rb
+- lib/acts_as/version.rb
+- spec/acts_for_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb
+homepage: http://github.com/wnadeau/acts_as
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: delegate an entire 1:1 association worth of active record field-related helpers
+test_files:
+- spec/acts_for_spec.rb
+- spec/spec_helper.rb
+- spec/support/active_record.rb