ownable 0.1.0

data/Gemfile

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

data/README.markdown

@@ -0,0 +1,73 @@
+## INTRODUCTION
+
+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
+
+For example:
+
+	User has_many Orders has_one Invoice has_many Payments
+	
+	Rather than manually defining and then checking the association between User and Payment like:
+		- @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
+
+
+## INSTALLATION
+  
+Ownable is currently available only in Gem form and requires version >= 3.0 of Rails.
+
+You just have to add the 'ownable' gem to your Gemfile
+
+    gem 'ownable'
+
+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)
+
+Assuming a set of Model associations as follows:
+
+	User has_many Orders has_one Invoice has_many Payments
+	
+
+	class Payment < ActiveRecord::Base  
+	  acts_as_ownable :through => [:invoice, :order, :user]
+		...
+	end
+	
+	Now all Payment objects will have the instance methods:
+	
+	@payment.owned_by?(model_instance)
+	
+	and
+	
+	@payment.owned_by_id?(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.
+
+## THANKS
+
+Thanks to jlecour's (http://github.com/jlecour) geokit-rails project for helping me understand how to build a gem that plays well with Rails 3.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+#load 'test/tasks.rake'
+
+#desc 'Default: run unit tests.'
+#task :default => :test
+
+desc 'Generate documentation for the Ownable gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ownable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/ownable.rb

@@ -0,0 +1,2 @@
+require 'ownable/railtie'
+require 'ownable/acts_as_ownable'

data/lib/ownable/acts_as_ownable.rb

@@ -0,0 +1,57 @@
+require 'active_record'
+require 'active_support/concern'
+
+module Ownable
+  
+  # Add acts_as_ownable to ActiveRecord subclasses  
+  module ActsAsOwnable extend ActiveSupport::Concern
+      
+    module ClassMethods
+      
+      def acts_as_ownable(options = {})
+        cattr_accessor :ownable_through 
+        
+        self.ownable_through = options[:through] || [':user']
+      end
+
+    end #ClassMethods
+     
+    # Add owned_by? and owned_by_id? to ActiveRecord subclasses
+    module InstanceMethods
+
+       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
+        
+        
+        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
+      
+    end #InstanceMethods
+    
+  end #ActsAsOwnable
+  
+end #Ownable

data/lib/ownable/railtie.rb

@@ -0,0 +1,15 @@
+require 'ownable'
+require 'rails'
+
+module Ownable
+  class Railtie < Rails::Railtie
+    
+    initializer 'ownable.insert_into_active_record' do
+      ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send :extend, Ownable::ActsAsOwnable::ClassMethods
+          ActiveRecord::Base.send :include, Ownable::ActsAsOwnable::InstanceMethods
+      end  
+    end
+    
+  end
+end

data/lib/ownable/version.rb

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

data/ownable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/ownable/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "ownable"
+  s.version     = Ownable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["David Gonzalez"]
+  s.email       = ["davidjgonzalez@gmail.com"]
+  s.homepage    = "http://unicornless.com/gems/ownable"
+  s.summary     = "Model ownership with Rails 3"
+  s.description = "Model ownership with Rails 3"
+
+  s.required_rubygems_version = ">= 1.3.6"
+
+  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) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: ownable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        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
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/ownable.rb
+- lib/ownable/acts_as_ownable.rb
+- lib/ownable/railtie.rb
+- lib/ownable/version.rb
+- ownable.gemspec
+has_rdoc: true
+homepage: http://unicornless.com/gems/ownable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Model ownership with Rails 3
+test_files: []
+