acts_as 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff4949b83af1313de02dd223cfa667b8914d03c2
-  data.tar.gz: 950527f10b751bcbeeda69c7816a51924a1de69a
+  metadata.gz: c054f6d73100efb1a76894d75b36424e1f302008
+  data.tar.gz: 8779e7ac0281fe3670eabc205ecfe9a449d305ae
 SHA512:
-  metadata.gz: b024ee340ef12fa6bc5aaa3380de1993ba5fbc349fec88f2a93f39632a0c39ca7a030da2905f45eae69764d4269bca0db46901ceaf18881a4e9832bc2f7ece72
-  data.tar.gz: 186fc903daca73350d57ab4a30ecfd2454a4a567153735a437f478033d892d0ed524b7f4fc62a9508a50bb746c4a340e3f1ada2068bfb5ccdad2d53ec497bfc4
+  metadata.gz: 0a8071e5d1ad40e9a3efbb8f4fba65a6e4d116930659d767027d39cce4ad6ccd05a2b2e5dab8cff73e68723bb55bef5c3425119ae90fd026f5a3382ab8ccb3f5
+  data.tar.gz: 13ac543c1bb90462c8d32b254458f99662fab738a115ded6c385a2bff51246ad11fb495b08450aace144322e9d1987e201ed0c1dc482c3d160eb9d85355cb2d5

data/README.md

@@ -1,6 +1,6 @@
 # ActsAs
 
-ActiveRecord extension for easy 1:1 composition delegation
+ActiveRecord extension for easy belongs_to composition delegation
 
 ## Installation
 
@@ -20,18 +20,20 @@ Or install it yourself as:
 
 ```ruby
 
+# This pattern encourages foreign keys to be stored on the STI's root table for easy reads.
+#
 # table :users
 #   name :string
+#   clan_id :integer
+#   profile_id :integer
 #
 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 )
+  acts_as :profile, class_name: 'RebelProfile', autosave: true
+  acts_as :clan, prefix: %w( name ), with: %w( delegate_at_will ), autosave: true
 end
 
 # table :clans
@@ -48,11 +50,10 @@ class Clan < ActiveRecord::Base
 end
 
 # table :rebel_profiles
-#   rebel_id :integer
 #   serial_data :string
 #
 class RebelProfile < ActiveRecord::Base
-  belongs_to :rebel
+  has_one :rebel
 end
 
 ```
@@ -84,7 +85,7 @@ 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)
+    Rebel.where(cool: true) #auto-joins :clan
 
 ## Contributing
 

data/lib/acts_as/version.rb

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

data/lib/acts_as.rb

@@ -4,52 +4,54 @@ module ActsAs
   class ActsAs::ActiveRecordOnly < StandardError; end
 
   PREFIX = %w(id created_at updated_at)
-  ACTING_FOR = {}
 
   def self.included(base)
+    raise ActiveRecordOnly unless base < ActiveRecord::Base
     base.extend ClassMethods
   end
 
   private
 
   def acts_as_field_match?(method)
-    @association_match = ACTING_FOR.select do |association, fields|
+    @association_match = self.class.acts_as_fields.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
+    def acts_as(association, type = :belongs_to, with: [], prefix: [], **options)
+      type == :belongs_to ? belongs_to(association, **options) : has_one(association, **options)
+      define_method(association) { |*args| super(*args) || send("build_#{association}", *args) }
 
+      if (association_class = new.send(association).class).table_exists?
+        whitelist_and_delegate_fields(association_class, association, prefix, with)
+        override_method_missing
+      end
+    end
 
-      association_class = new.send(one_association).class
-      if association_class.table_exists?
+    def acts_as_fields
+      @acts_as_fields ||= {}
+    end
 
-        whitelist_and_delegate_fields(association_class, one_association, prefix, whitelist)
+    private
 
-        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
+    def override_method_missing
+      define_method :method_missing do |method, *args, &block|
+        if acts_as_field_match?(method)
+          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
+      define_method :respond_to? do |method, *args, &block|
+        acts_as_field_match?(method) || super(method, *args, &block)
       end
     end
 
-
-    private
-
-    def whitelist_and_delegate_fields(association_class, one_association, prefix, whitelist)
-      association_fields = association_class.columns.map(&:name) - PREFIX - prefix + whitelist
+    def whitelist_and_delegate_fields(association_class, one_association, prefix, with)
+      association_fields = association_class.columns.map(&:name) - PREFIX - prefix + with
 
       build_prefix_methods(one_association, prefix)
 
@@ -59,7 +61,7 @@ module ActsAs
       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
+      acts_as_fields[one_association] = association_fields + prefix
     end
 
     def build_prefix_methods(one_association, prefix)

data/spec/{acts_for_spec.rb → acts_as_spec.rb}

@@ -22,25 +22,26 @@ class Clan < ActiveRecord::Base
 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 )
+  acts_as :profile, class_name: 'RebelProfile', autosave: true
+  acts_as :clan, prefix: %w( name ), with: %w( delegate_at_will ), autosave: true
 end
 
 class Imperial < User
-  has_one :profile, class_name: 'ImperialProfile'
-  acts_as :profile
+  acts_as :profile, class_name: 'ImperialProfile'
 end
 
-
-
 describe ActsAs do
 
   let(:rebel) { Rebel.create(name: "Leia", clan_name: "Organa") }
   subject { rebel }
 
-  describe 'whitelist' do
+  it 'raises exception for non-ActiveRecord::Base extensions' do
+    expect {
+      class MyObject; include ActsAs; end
+    }.to raise_error(ActsAs::ActiveRecordOnly)
+  end
+
+  describe 'with' do
     it { should respond_to(:delegate_at_will) }
     its(:delegate_at_will) { should == rebel.clan.delegate_at_will  }
   end

data/spec/support/active_record.rb

@@ -8,17 +8,16 @@ ActiveRecord::Migration.create_table :users do |t|
   t.string :name
   t.string :type
   t.integer :clan_id
+  t.integer :profile_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - winfred
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,7 +53,7 @@ files:
 - acts_as.gemspec
 - lib/acts_as.rb
 - lib/acts_as/version.rb
-- spec/acts_for_spec.rb
+- spec/acts_as_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb
 homepage: http://github.com/wnadeau/acts_as
@@ -81,6 +81,6 @@ 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/acts_as_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record.rb