ownable 0.1.0 → 0.2.0

data/README.markdown

@@ -4,18 +4,21 @@ Ownable gem helps you verify the "ownership" of a associated models in Rails 3.
 
 The term "ownership" in the contact of Ownable is the association between two models, usually a User Model (though any model can do) and some other Model.
 
-Ownable becomes incresa
+Ownable exposes an instance method on ActiveRecord objects that declare themselves to be acts_as_ownable:
 
-For example:
+	owned_by? (and its alias belongs_to?)
+
+For example, assume the associations:
 
 	User has_many Orders has_one Invoice has_many Payments
 	
+Determine if a User "owns" a particular Payment object
+	
 	Rather than manually defining and then checking the association between User and Payment like:
-		- @payment.invoice.order.user == current_user # => true/false
+		@payment.invoice.order.user == current_user # => true/false
 		
 	you can use Ownable for a much shorter and simpler syntax:
-	   - @payment.owned_by? current_user 						# => true/false
-
+	   @payment.owned_by? current_user # => true/false
 
 ## INSTALLATION
   
@@ -29,7 +32,6 @@ Then tell bundler to update the gems :
 
     $ bundle install
     
-
 ## USE
 
 In each Model define the associations from the Model to the "Owner" model (which will be User in this example)
@@ -38,33 +40,41 @@ Assuming a set of Model associations as follows:
 
 	User has_many Orders has_one Invoice has_many Payments
 	
+Ownable is added to the Payment Model using "acts_as_ownable"
 
 	class Payment < ActiveRecord::Base  
 	  acts_as_ownable :through => [:invoice, :order, :user]
 		...
 	end
 	
-	Now all Payment objects will have the instance methods:
+The "acts_as_ownable" method call takes a hash with key :through with an Array value. 
+The Array is a list of the Model names that define the association path from the current Model back to, 
+and including the "Owner" model. Important note: The last item in the array is always the "Owner" model name.
 	
-	@payment.owned_by?(model_instance)
+Now all Payment objects will have the instance methods:
 	
-	and
+	@payment.owned_by?(ActiveRecord Object)
+	@payment.owned_by?(Fixnum Id)
 	
-	@payment.owned_by_id?(id)
+or using the belongs_to? alias
+
+	@payment.belongs_to?(ActiveRecord Object)
+	@payment.belongs_to?(Fixnum Id)
 	
 Note that when declaring acts_as_ownable in the Models, the last Model name in the array must be the "Owner" model name.
 Also, this only works when each upstream association returns a single object. For example, the following will NOT work:
 
 	Publisher has_many Authors has_and_belongs_to_many Books 
 
+
 	class Book < ActiveRecord::Base  
 	  acts_as_ownable :through => [:author, :publisher]
 		...
 	end
-	
+
+
 	@book.owned_by? Publisher.first
 	
-	
 This will not work because several authors may have co-authored a Book so there is multiple paths back to the "Owner" model (the Publisher). 
 At this time this gem does not support these relationships.
 

data/lib/ownable/acts_as_ownable.rb

@@ -16,39 +16,36 @@ module Ownable
 
     end #ClassMethods
      
-    # Add owned_by? and owned_by_id? to ActiveRecord subclasses
+    # Add owned_by? and belongs_to? to ActiveRecord subclasses
     module InstanceMethods
 
-       def owned_by? candidate
-          owner = find_owner
+      def owned_by? candidate
+        owner = find_owner
 
-          return false if (owner.nil? || candidate.nil?)
-          candidate == owner
-        end
-
-        def owned_by_id? candidate_id
-          owner = find_owner
-          
-          return false if (owner.nil? || candidate_id.nil?)
-          candidate_id == owner.id
-        end
-        
+        return false if (owner.nil? || candidate.nil?)
+        return candidate == owner.id if candidate.is_a? Fixnum
+        return candidate == owner          
+      end
         
-        private 
+      def belongs_to? candidate
+        owned_by? candidate
+      end
+      
+      private 
         
-        def find_owner
-          owner = self
-
-          self.ownable_through.each do |class_name|          
-            begin 
-              owner = owner.send class_name
-            rescue
-              owner = nil
-            end
-          end
-          
-          return owner
-        end
+      def find_owner
+        owner = self  
+            
+        self.ownable_through.each do |class_name|          
+          begin       
+            owner =   owner.send class_name
+          rescue      
+            owner =   nil
+          end         
+        end           
+            
+        return owner  
+      end             
       
     end #InstanceMethods
     

data/lib/ownable/version.rb

@@ -1,3 +1,3 @@
 module Ownable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/ownable.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["David Gonzalez"]
   s.email       = ["davidjgonzalez@gmail.com"]
-  s.homepage    = "http://unicornless.com/gems/ownable"
+  s.homepage    = "http://github.com/emp29/Ownable"
   s.summary     = "Model ownership with Rails 3"
   s.description = "Model ownership with Rails 3"
 
@@ -15,8 +15,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'rails', '~> 3.0.0'
 
-  s.add_development_dependency "bundler", "~> 1.0.0"
-
   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) }

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - David Gonzalez
@@ -21,6 +21,7 @@ dependencies:
   name: rails
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
@@ -31,20 +32,6 @@ dependencies:
         version: 3.0.0
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        version: 1.0.0
-  type: :development
-  version_requirements: *id002
 description: Model ownership with Rails 3
 email: 
 - davidjgonzalez@gmail.com
@@ -55,7 +42,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- Gemfile
 - README.markdown
 - Rakefile
 - lib/ownable.rb
@@ -64,7 +50,7 @@ files:
 - lib/ownable/version.rb
 - ownable.gemspec
 has_rdoc: true
-homepage: http://unicornless.com/gems/ownable
+homepage: http://github.com/emp29/Ownable
 licenses: []
 
 post_install_message: 
@@ -73,6 +59,7 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -80,6 +67,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -91,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Model ownership with Rails 3

data/Gemfile

@@ -1,3 +0,0 @@
-source :rubygems
-
-gemspec