friendly-attributes 0.1.0 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+### 0.2.0
+
+  * (ihoka) Extended the DSL to allow passing a hash of options when defining friendly_attributes.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/friendly-attributes.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{friendly-attributes}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Istvan Hoka"]
@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/lib/friendly_attributes/class_methods.rb

@@ -1,7 +1,22 @@
 module FriendlyAttributes
   module ClassMethods
-    def friendly_details(klass, &block)
-      DetailsDelegator.new(klass, self, &block)
+    def friendly_details(*args, &block)
+      klass = args.shift
+      options = args.extract_options!
+      
+      delegate_options = proc {
+        options.each do |key, value|
+          if Array === value
+            value.each { |v| delegated_attribute v, key }
+          else
+            delegated_attribute value, key
+          end
+        end
+      }
+      
+      DetailsDelegator.new(klass, self, &block).tap do |dd|
+        dd.instance_eval(&delegate_options)
+      end
     end
     
     def friendly_mount_uploader(name, klass)

data/lib/friendly_attributes/details_delegator.rb

@@ -24,7 +24,7 @@ module FriendlyAttributes
         end
       end
       
-      self.instance_eval(&block)
+      self.instance_eval(&block) if block_given?
     end
     
     def delegated_attribute(name, klass)

data/spec/friendly_attributes/class_methods_spec.rb

@@ -14,9 +14,51 @@ describe FriendlyAttributes::ClassMethods do
   class FakeUploader; end
   
   describe ".friendly_details" do
-    it "instantiates a new DetailsDelegator" do
-      FriendlyAttributes::DetailsDelegator.should_receive(:new).with(friendly_model, ar_model, &initializer).and_return(details_delegator)
-      ar_model.friendly_details(friendly_model, &initializer).should == details_delegator
+    let(:options) do
+      {
+        String  => :foo,
+        Integer => [:bar, :baz]
+      }
+    end
+    
+    before(:each) do
+      details_delegator.stub(:delegated_attribute)
+    end
+    
+    context "with an initializer block" do
+      it "instantiates a new DetailsDelegator" do
+        FriendlyAttributes::DetailsDelegator.should_receive(:new).with(friendly_model, ar_model, &initializer).and_return(details_delegator)
+        ar_model.friendly_details(friendly_model, &initializer).should == details_delegator
+      end
+    end
+    
+    context "with an initializer block and options" do
+      before(:each) do
+        FriendlyAttributes::DetailsDelegator.stub(:new => details_delegator)
+      end
+      
+      def do_details
+        ar_model.friendly_details(friendly_model, options, &initializer).should == details_delegator
+      end
+      
+      it "instantiates a new DetailsDelegator" do
+        FriendlyAttributes::DetailsDelegator.should_receive(:new).with(friendly_model, ar_model, &initializer).and_return(details_delegator)
+        do_details
+      end
+      
+      it "delegates the attributes passed in the options" do
+        details_delegator.should_receive(:delegated_attribute).with(:foo, String)
+        details_delegator.should_receive(:delegated_attribute).with(:bar, Integer)
+        details_delegator.should_receive(:delegated_attribute).with(:baz, Integer)
+        do_details
+      end
+    end
+    
+    context "without a block" do
+      it "instantiates a new DetailsDelegator" do
+        FriendlyAttributes::DetailsDelegator.should_receive(:new).with(friendly_model, ar_model).and_return(details_delegator)
+        ar_model.friendly_details(friendly_model, options).should == details_delegator
+      end
     end
   end
   

data/spec/friendly_attributes/details_delegator_spec.rb

@@ -11,68 +11,79 @@ describe FriendlyAttributes::DetailsDelegator do
   let(:friendly_instance) { mock(friendly_model) }
   
   describe "initialization" do
-    context "the Friendly model" do
-      before(:each) do
-        details_delegator
-      end
-      
-      it "includes Friendly::Document" do
-        friendly_model.ancestors.should include(Friendly::Document)
-      end
+    shared_examples_for "DetailsDelegator initialization" do
+      context "the Friendly model" do
+        before(:each) do
+          details_delegator
+        end
 
-      it "adds the active_record_id attribute" do
-        friendly_model.attributes.should include(:active_record_id)
-      end
+        it "includes Friendly::Document" do
+          friendly_model.ancestors.should include(Friendly::Document)
+        end
 
-      it "adds an index to active_record_id" do
-        friendly_model.storage_proxy.index_for_fields([:active_record_id]).should be_an_instance_of(Friendly::Index)
-      end
-    end
-    
-    context "the ActiveRecord model" do
-      it "installs the update_friendly_details callback after_save" do
-        ar_model.should_receive(:after_save).with(:update_friendly_details)
-        details_delegator
-      end
-      
-      it "installs the destroy_friendly_details callback after_destroy" do
-        ar_model.should_receive(:after_destroy).with(:destroy_friendly_details)
-        details_delegator
+        it "adds the active_record_id attribute" do
+          friendly_model.attributes.should include(:active_record_id)
+        end
+
+        it "adds an index to active_record_id" do
+          friendly_model.storage_proxy.index_for_fields([:active_record_id]).should be_an_instance_of(Friendly::Index)
+        end
       end
-      
-      context ".details" do
-        before(:each) do
+
+      context "the ActiveRecord model" do
+        it "installs the update_friendly_details callback after_save" do
+          ar_model.should_receive(:after_save).with(:update_friendly_details)
           details_delegator
         end
-        
-        it "is defined" do
-          ar_instance.should respond_to(:details)
+
+        it "installs the destroy_friendly_details callback after_destroy" do
+          ar_model.should_receive(:after_destroy).with(:destroy_friendly_details)
+          details_delegator
         end
-        
-        it "finds and memoizes the associated Friendly model" do
-          friendly_model.should_receive(:find_or_build_by_active_record_id).with(ar_instance.id).once.and_return(friendly_instance)
-          ar_instance.details.should == friendly_instance
-          ar_instance.details.should == friendly_instance
+
+        context ".details" do
+          before(:each) do
+            details_delegator
+          end
+
+          it "is defined" do
+            ar_instance.should respond_to(:details)
+          end
+
+          it "finds and memoizes the associated Friendly model" do
+            friendly_model.should_receive(:find_or_build_by_active_record_id).with(ar_instance.id).once.and_return(friendly_instance)
+            ar_instance.details.should == friendly_instance
+            ar_instance.details.should == friendly_instance
+          end
         end
       end
     end
+    
+    context "missing initialization block" do
+      let(:details_delegator) { FriendlyAttributes::DetailsDelegator.new(friendly_model, ar_model) }
+      it_should_behave_like "DetailsDelegator initialization"
+    end
   
-    context "the initialization block" do
-      def yielded_inside(instance)
-        @yielded_instance = instance
-      end
+    context "with initialization block" do
+      it_should_behave_like "DetailsDelegator initialization"
       
-      let(:initializer) do
-        example = self
-        
-        proc {
-          example.yielded_inside(self)
-        }
-      end
-      
-      it "is instance evaled" do
-        details_delegator
-        @yielded_instance.should == details_delegator
+      context "the initialization block" do
+        def yielded_inside(instance)
+          @yielded_instance = instance
+        end
+
+        let(:initializer) do
+          example = self
+
+          proc {
+            example.yielded_inside(self)
+          }
+        end
+
+        it "is instance evaled" do
+          details_delegator
+          @yielded_instance.should == details_delegator
+        end
       end
     end
   end

data/spec/friendly_attributes_spec.rb

@@ -5,7 +5,7 @@ describe FriendlyAttributes do
   
   describe "creating" do
     context "with Friendly attributes" do
-      let(:user) { User.create(:name => "Stan", :email => "stan@example.com") }
+      let(:user) { User.create(:name => "Stan", :email => "stan@example.com", :birth_year => 1984, :shoe_size => 42, :subscribed => true) }
       
       it "creates an associated Details model with the AR model" do
         expect do
@@ -14,6 +14,9 @@ describe FriendlyAttributes do
         
         user_detail = user.details
         user_detail.name.should == "Stan"
+        user_detail.birth_year.should == 1984
+        user_detail.shoe_size.should == 42
+        user_detail.subscribed.should be_true
       end
     end
     

data/spec/spec_helper.rb

@@ -41,7 +41,7 @@ RSpec.configure do |config|
   class ::User < ActiveRecord::Base
     include FriendlyAttributes
     
-    friendly_details UserDetails do
+    friendly_details(UserDetails, { Integer => [:birth_year, :shoe_size], Friendly::Boolean => :subscribed }) do
       delegated_attribute :name, String
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: friendly-attributes
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Istvan Hoka
@@ -345,6 +345,7 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt