acts_as_owner 1.2.0 → 2.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2@acts_as_owner

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+case ENV["MODEL_ADAPTER"]
+when nil, "active_record"
+  gem "sqlite3"
+  gem "activerecord", :require => "active_record"
+else
+  raise "Unknown model adapter: #{ENV["MODEL_ADAPTER"]}"
+end
+
+gemspec

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Cyril Wack
+Copyright (c) 2009-2011 Cyril Wack
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,36 +1,79 @@
 = Acts as owner
 
-Provides to a user the ability to self-query about the possession of a given resource or a given account.
+Acts as owner is a plugin for Ruby on Rails that provides to an owner object the
+ability to self-query about the possession of an ownable object.
 
-Any resources belonging to an other resource which is owned by the user are considered such as owned by this user too.
+Ownable objects can be any objects belonging to the owner object and any objects
+belonging to an ownable object.
 
-== Install
+Any ownable child, which belongs to an owned ownable parent, is also owned by
+the owner.
 
-Install the gem (recommended):
+== Philosophy
 
-  sudo gem install acts_as_owner
+General library that does only one thing, without any feature.
 
-Or you can install this as a plugin:
+== Installation
 
-  script/plugin install git://github.com/cyril/acts_as_owner.git
+Include the gem in your <tt>Gemfile</tt>:
+
+  gem 'acts_as_owner'
+
+And run the +bundle+ command.  Or as a plugin:
+
+  rails plugin install git://github.com/cyril/acts_as_owner.git
+
+== Getting started
+
+=== Configuring models
+
+Owner models just have to be declared thanks to <tt>acts_as_owner</tt>, with
+each ownable object passed through a block (using <tt>owns_one</tt> or
+<tt>owns_many</tt> method).
 
 == Example
 
   class User < ActiveRecord::Base
-    acts_as_owner :categories, :articles, :comments
+    acts_as_owner do |u|
+      u.owns_many :articles
+      u.owns_many :comments
+    end
+
+    with_options :dependent => :destroy do |opts|
+      opts.has_many :articles
+      opts.has_many :comments
+    end
   end
 
-  # Considering this article:
+  class Article < ActiveRecord::Base
+    belongs_to :user
+    has_many :comments, :dependent => :destroy
+  end
+
+  class Comment < ActiveRecord::Base
+    belongs_to :article
+    belongs_to :user
+  end
+
+  # An article should be ownable by a user, so:
+  User.could_own_an?(:article)  # => true
+
+  # Considering this one:
   article = current_user.articles.first
 
   # We can see that:
-  current_user.owns? article                     # => true
-  current_user.owns? article.user                # => true
+  current_user.owns? article    # => true
+
+  # Now, considering its first comment:
+  comment = article.comments.first
+
+  # Just like article, we can check that:
+  User.could_own_an? :comment   # => true
 
-  # Now, check if its first comment is ours:
-  current_user.owns? article.comments.first.user # => false
+  # Let's see if the current user is the author:
+  current_user == comment.user  # => false
 
-  # But even if it is not, this comment is a child of our article, so:
-  current_user.owns? article.comments.first      # => true
+  # Never mind.  It belongs to his article so that's also his one:
+  current_user.owns? comment    # => true
 
-Copyright (c) 2009 Cyril Wack, released under the MIT license
+Copyright (c) 2009-2011 Cyril Wack, released under the MIT license

data/Rakefile

@@ -1,12 +1,12 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-Echoe.new('acts_as_owner', '1.2.0') do |p|
-  p.description    = "Simple Rails plugin that allows to operate freely on objects which belong to us."
-  p.url            = "http://github.com/cyril/acts_as_owner"
-  p.author         = "Cyril Wack"
-  p.email          = "cyril.wack@gmail.com"
-  p.ignore_pattern = ["tmp/*", "script/*"]
-  p.development_dependencies = []
-end
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_{helper,test}.rb"]
+end
+
+task :default => :test

data/VERSION.yml

@@ -1,4 +1,4 @@
 ---
-:major: 1
-:minor: 2
+:major: 2
+:minor: 0
 :patch: 0

data/acts_as_owner.gemspec

@@ -1,32 +1,18 @@
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
-  s.name = %q{acts_as_owner}
-  s.version = "1.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Cyril Wack"]
-  s.cert_chain = ["/Users/cyril/gem-public_cert.pem"]
-  s.date = %q{2010-04-12}
+  s.name        = "acts_as_owner"
+  s.version     = Psych.load_file("VERSION.yml").values.join('.')
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Cyril Wack"]
+  s.email       = ["cyril@gosu.fr"]
+  s.homepage    = "http://github.com/cyril/acts_as_owner"
+  s.summary     = %q{Simple ownership solution for Rails.}
   s.description = %q{Simple Rails plugin that allows to operate freely on objects which belong to us.}
-  s.email = %q{cyril.wack@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/acts_as_owner.rb"]
-  s.files = ["MIT-LICENSE", "README.rdoc", "Rakefile", "VERSION.yml", "init.rb", "lib/acts_as_owner.rb", "Manifest", "acts_as_owner.gemspec"]
-  s.homepage = %q{http://github.com/cyril/acts_as_owner}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Acts_as_owner", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{acts_as_owner}
-  s.rubygems_version = %q{1.3.6}
-  s.signing_key = %q{/Users/cyril/gem-private_key.pem}
-  s.summary = %q{Simple Rails plugin that allows to operate freely on objects which belong to us.}
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.rubyforge_project = "acts_as_owner"
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.add_runtime_dependency "railties", ">= 3.0.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
 end

data/init.rb

@@ -1 +1 @@
-require 'acts_as_owner'
+require 'acts_as_owner'

data/lib/acts_as_owner.rb

@@ -1,74 +1,69 @@
-require 'active_record/base'
-
 module ActsAsOwner
-  def self.included(base)
-    base.extend(ClassMethods)
+  def owns?(obj)
+    can_own_this?(obj) if self.class.could_own_a?(obj.class.name.underscore)
   end
 
-  module ClassMethods
-    # Configuration resources are: all resources belonging to the current model.
-    def acts_as_owner(*resources)
-      resources.each { |resource| has_many resource.to_s.tableize.to_sym, :dependent => :destroy }
+  protected
 
-      class_eval <<-EOV
-        include ActsAsOwner::InstanceMethods
+  def can_own_this?(obj, depth = 0)
+    association_id = obj.class.name.tableize.singularize.to_sym
+    association_params = self.class.
+      read_inheritable_attribute(:ownable_ids)[association_id]
 
-        def self.owns_many
-          reflections.select { |name, reflection| reflection.macro == :has_many }.collect { |table| table[0].to_s.singularize }
-        end
+    unless depth > association_params[:max_depth]
+      owner_id = association_params[:owner_id]
+      owned = obj.respond_to?(owner_id) && obj.send(owner_id) == self
 
-        def self.owns_one
-          reflections.select { |name, reflection| reflection.macro == :has_one }.collect { |table| table[0].to_s.singularize }
-        end
-      EOV
+      owned || ownable_ancestors(obj).any? do |name|
+        can_own_this?(name, depth.next)
+      end
     end
   end
 
-  module InstanceMethods
-    # Returns true if the user owns the object which can be a account or a resource.  Otherwise returns false.
-    def owns?(object = nil)
-      return false if object.nil?
-      object.is_a?(self.class) ? self.owns_this_account?(object) : self.owns_this_resource?(object)
+  def ownable_ancestors(child)
+    ancestors = child.class.reflections.select do |name, reflection|
+      reflection.macro == :belongs_to
     end
 
-    protected
+    ancestors.map {|table| table.first }.
+      select {|name| self.class.could_own_a?(name) }.
+      map {|name| child.send(name) }.compact
+  end
+end
 
-    # Returns true if the user owns the account, otherwise returns false.
-    def owns_this_account?(account)
-      self.id == account.id
-    end
+class ActiveRecord::Base
+  def self.acts_as_owner(options = {}, &block)
+    configuration = {
+      :max_depth => 50,
+      :owner_id  => name.tableize.singularize.to_sym }
+    configuration.update(options) if options.is_a?(Hash)
 
-    # Returns true if the user owns the resource, otherwise returns false.
-    def owns_this_resource?(resource)
-      (has_many?(resource) || has_one?(resource)) ||
-      parents_of(resource).collect { |parent| owns_this_resource?(parent) }.select { |result| result == true }.uniq.pop == true
-    end
+    write_inheritable_hash(:ownership_options, configuration)
+    write_inheritable_hash(:ownable_ids, {})
 
-    # Has many association
-    def has_many?(resource)
-      self.respond_to?(resource.class.name.tableize) && self.send(resource.class.name.tableize).include?(resource)
-    end
+    class << self
+      def owns_many(association_id, options = {})
+        read_inheritable_attribute(:ownable_ids).update({
+          association_id.to_s.singularize.to_sym =>
+            read_inheritable_attribute(:ownership_options).merge(options) })
+      end
 
-    # Has one association
-    def has_one?(resource)
-      self.respond_to?(resource.class.name.tableize.singularize) && self.send(resource.class.name.tableize.singularize) == resource
-    end
+      def owns_one(association_id, options = {})
+        read_inheritable_attribute(:ownable_ids).update({
+          association_id.to_sym =>
+            read_inheritable_attribute(:ownership_options).merge(options) })
+      end
 
-    # Returns an array of resources that are:
-    #  * directly superior to the resource passed as parameter, according the hierarchical tree structure;
-    #  * potentially owned by the current user, through the hierarchical relationship.
-    def parents_of(resource)
-      potential_owners_of(resource).collect { |method| resource.send(method) }
-    end
+      def could_own_a?(association_id)
+        read_inheritable_attribute(:ownable_ids).keys.
+          include?(association_id.to_sym)
+      end
 
-    # Returns an array containing symbols common to children
-    # which belongs to the current user and to parents which has many or has one given resource.
-    def potential_owners_of(resource)
-      (self.class.owns_many | self.class.owns_one) & resource.class.reflections.select do |name, reflection|
-        reflection.macro == :belongs_to
-      end.collect { |table| table[0].to_s }
+      alias_method :could_own_an?, :could_own_a?
     end
+
+    instance_eval &block
+
+    include ActsAsOwner
   end
 end
-
-ActiveRecord::Base.class_eval { include ActsAsOwner }

data/test/owner_test.rb

@@ -0,0 +1,121 @@
+require 'test_helper'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3', :database => ':memory:')
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :users do |t|
+      t.string :login
+    end
+
+    create_table :blogs do |t|
+      t.references :user, :null => false
+      t.string :title
+    end
+
+    create_table :categories do |t|
+      t.references :blog, :null => false
+      t.string :title
+    end
+
+    create_table :articles do |t|
+      t.references :publishable, :polymorphic => true, :null => false
+      t.references :user
+      t.string :title
+      t.text :content
+    end
+
+    create_table :comments do |t|
+      t.references :article, :null => false
+      t.references :user
+      t.text :content
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class User < ActiveRecord::Base
+  acts_as_owner(:verbose => true) do |a|
+    a.owns_many :categories
+    a.owns_many :articles
+    a.owns_many :comments
+    a.owns_many :publishables
+    a.owns_one :blog
+  end
+
+  has_one :blog, :dependent => :destroy
+  has_many :articles, :dependent => :destroy
+  has_many :comments, :dependent => :destroy
+end
+
+class Blog < ActiveRecord::Base
+  belongs_to :user
+  has_many :articles, :as => :publishable, :dependent => :destroy
+  has_many :categories, :dependent => :destroy
+end
+
+class Category < ActiveRecord::Base
+  belongs_to :blog
+  has_many :articles, :as => :publishable, :dependent => :destroy
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :publishable, :polymorphic => true
+  belongs_to :user
+  has_many :comments, :dependent => :destroy
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :article
+  belongs_to :user
+end
+
+class OwnerTest < MiniTest::Unit::TestCase
+  def setup
+    setup_db
+
+    @admin = User.create! :login => 'admin'
+    @bob = User.create :login => 'bob'
+
+    @blog = @admin.create_blog :title => 'my_blog'
+    @category = @blog.categories.create! :title => 'main'
+    @article0 = @category.articles.create! :title => 'hello, world',
+      :user => @admin
+    @article1 = @blog.articles.create! :title => 'hello, all',
+      :user => @bob
+    @comment0 = @article0.comments.create! :content => 'foo'
+    @comment1 = @article0.comments.create! :content => 'bar',
+      :user => @bob
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_the_ownability
+    refute User.could_own_a?(:tank)
+    refute User.could_own_a?("dinosaur")
+    refute User.could_own_a?(42.to_s)
+    assert User.could_own_a?(:blog)
+    assert User.could_own_an?(:article)
+  end
+
+  def test_the_ownership
+    assert @admin.owns?(@blog)
+    refute @bob.owns?(@blog)
+    assert @admin.owns?(@article0)
+    refute @bob.owns?(@article0)
+    assert @admin.owns?(@article1)
+    assert @bob.owns?(@article1)
+    assert @admin.owns?(@comment0)
+    refute @bob.owns?(@comment0)
+    assert @bob.owns?(@comment1)
+    assert @admin.owns?(@comment1)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'sqlite3'
+require 'active_record'
+require 'acts_as_owner'

metadata

@@ -1,97 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts_as_owner
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Cyril Wack
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApjeXJp
-  bC53YWNrMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
-  b20wHhcNMTAwNDExMjI1OTI4WhcNMTEwNDExMjI1OTI4WjBBMRMwEQYDVQQDDApj
-  eXJpbC53YWNrMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
-  FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDGJFqPSXGYdS6t
-  t+kXyFuLg7uIbQHToLhdbfpu5j7dl65EWAspRI37ZE/FIFosmwQ0DAGiJ35gVX7K
-  5/rj745EUW9vijemlNHZjTY40AQAP2avlcMd6DnA7pl/x8dxC9G2dW/IS0nmjH0E
-  +X7X0BZ8WIY7PBvLsq5ptpGaoaxpmqRjJDANolnODwyBjFWtUqpvOGeUWL24orZ3
-  xwcW6d1vl8hraZ3UUJtIVXFg85lHclyrP33DYxj5sstgRwovaCPrvUQ6ZZ+hX/iJ
-  MYaEFZsw74WVD4RLHl1bEz2RQGDgSwfFnOnrQ1gi2SaeqUN7uFThAEbbyiJK+rNL
-  xapWOFs9AgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBSsO/YPzLP2/ZtBKQfWveZNRK3uKDANBgkqhkiG9w0BAQUFAAOCAQEAGaGpPlEc
-  Z8A7Jtfws1tpdLOlQrQQXfIgBrPvfjO18MxT2BVgnusYcMuJgrY1skbH6RDxhdia
-  EetICD0kvyGnbK+dHdhRwvmmiqc7ZOaiFb3RNLcW6jduxafH4zgKUeg23KpfJYy3
-  MOqVgHckM1hMZTWz7nmrXJBAjj/48jFOPrwtTed8kd6KpIjUz4e2oTwT+JIVnryF
-  sYFesvR4DywbXL88T29gq5biCHsAgbK89DW5DNx1Yg1HNLxCdJurJFrcQQS3XQco
-  h2svBTlG7Yg1wLZAGkVx4RSkrFujrxpgLsz5bfmdnbiEgKcF9njIOdVO4P4vwyoS
-  G4VzQZjAGxprTw==
-  -----END CERTIFICATE-----
-
-date: 2010-04-12 00:00:00 +02:00
-default_executable: 
-dependencies: []
-
-description: Simple Rails plugin that allows to operate freely on objects which belong to us.
-email: cyril.wack@gmail.com
+cert_chain: []
+date: 2011-04-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &2153341400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2153341400
+description: Simple Rails plugin that allows to operate freely on objects which belong
+  to us.
+email:
+- cyril@gosu.fr
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-- lib/acts_as_owner.rb
-files: 
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION.yml
+- acts_as_owner.gemspec
 - init.rb
 - lib/acts_as_owner.rb
-- Manifest
-- acts_as_owner.gemspec
-has_rdoc: true
+- test/owner_test.rb
+- test/test_helper.rb
 homepage: http://github.com/cyril/acts_as_owner
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Acts_as_owner
-- --main
-- README.rdoc
-require_paths: 
+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
-      - 2
-      version: "1.2"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: acts_as_owner
-rubygems_version: 1.3.6
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: Simple Rails plugin that allows to operate freely on objects which belong to us.
-test_files: []
-
+summary: Simple ownership solution for Rails.
+test_files:
+- test/owner_test.rb
+- test/test_helper.rb

data/Manifest

@@ -1,7 +0,0 @@
-MIT-LICENSE
-README.rdoc
-Rakefile
-VERSION.yml
-init.rb
-lib/acts_as_owner.rb
-Manifest