acts-as-joinable 0.0.1.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com)
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,54 @@
+# ActsAsJoinable
+
+It extends the functionality of `has_and_belongs_to_many`, conventionalizing common use cases.
+
+## Usage
+
+### Install
+
+    sudo gem install acts-as-joinable
+    
+### Add Relationships
+
+Say you have `Post` and `Asset` models.  If each `has_many` of each other `through` some join model, you can write it as such:
+
+    class Post < ActiveRecord::Base
+      acts_as_joinable_on :assets, :layouts, :tags, :slugs
+    end
+    
+    class Asset < ActiveRecord::Base
+      acts_as_joinable
+    end
+    
+That is a replacement for the longer (and non-polymorphic):
+
+    class Post < ActiveRecord::Base
+      has_and_belongs_to_many :assets
+    end
+    
+    class Asset < ActiveRecord::Base
+      has_and_belongs_to_many :posts
+    end
+
+## Why
+
+Many-to-many relationships end up requiring the same features 99% of the time:
+
+1. Join Table that keeps track of `context`
+  - [ActsAsTaggableOn](http://github.com/mbleigh/acts-as-taggable-on/blob/master/lib/generators/acts_as_taggable_on/migration/templates/active_record/migration.rb)
+  - ActsAsAuthorized
+  - [Preferences](http://github.com/pluginaweek/preferences/blob/master/generators/preferences/templates/001_create_preferences.rb)
+  - [FriendlyId](http://github.com/norman/friendly_id/blob/ca9821192c8c3c4e81a938603151645c7cbe1470/generators/friendly_id/templates/create_slugs.rb)
+
+It looks like this:
+
+    create_table :relationships do |t|
+      t.references :parent, :polymorphic => true
+      t.references :child, :polymorphic => true
+      t.string :context
+      t.timestamps
+    end
+
+## Alternatives
+
+- [ActsAsRelationable](http://github.com/winton/acts_as_relationable)

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "acts-as-joinable"
+  s.authors           = ["Lance Pollard"]
+  s.version           = "0.0.1.5"
+  s.summary           = "ActsAsJoinable: DRYing up Many-to-Many Relationships in ActiveRecord"
+  s.homepage          = "http://github.com/viatropos/cockpit"
+  s.email             = "lancejpollard@gmail.com"
+  s.description       = "DRYing up Many-to-Many Relationships in ActiveRecord"
+  s.has_rdoc          = false
+  s.rubyforge_project = "acts-as-joinable"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,rails,test}/**/*"] - Dir["test/tmp"]
+  s.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc 'run unit tests'
+task :test do
+  Dir["test/**/*"].each do |file|
+    next unless File.basename(file) =~ /test_/
+    next unless File.extname(file) == ".rb"
+    system "ruby #{file}"
+  end
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  command = "gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc"
+  command = "sudo #{command}" if ENV["SUDO"] == true
+  sh %{#{command}}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/init.rb

@@ -0,0 +1 @@
+File.dirname(__FILE__) + "/rails/init.rb"

data/lib/acts-as-joinable.rb

@@ -0,0 +1,172 @@
+module ActsAsJoinable
+  
+  def self.models
+    @models ||= Dir[Rails.root + "/app/models/*.rb"].collect { |f| File.basename f, '.rb' }
+  end
+  
+  def self.models=(value)
+    @models = value
+  end
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    # the parent in the relationship, so to speak
+    def acts_as_joinable_on(*args, &block)
+      if args.empty? # Relationship model
+        belongs_to :parent, :polymorphic => true
+        belongs_to :child,  :polymorphic => true
+
+        ActsAsJoinable.models.each do |m|
+          belongs_to "parent_#{m}".intern, :foreign_key => 'parent_id', :class_name => m.camelize
+          belongs_to "child_#{m}".intern,  :foreign_key => 'child_id',  :class_name => m.camelize
+        end
+      else
+        options = args.extract_options!
+        sql     = options[:conditions]
+        table   = options[:table]
+        fields  = options[:fields] || []
+        fields  = [ fields ] unless fields.respond_to?(:flatten)
+        
+        has_many :parent_relationships, :class_name => 'ActsAsJoinable::Relationship', :as => :child
+        has_many :child_relationships,  :class_name => 'ActsAsJoinable::Relationship', :as => :parent
+        
+        args.each do |type|
+          type   = type.to_s
+          table  = table || type
+          select = "#{table}.*, relationships.id AS relationship_id#{fields.empty? ? '' : ', '}" + fields.collect { |f| "relationships.#{f}" }.join(', ')
+          opts = {
+            :select      => select,
+            :conditions  => sql,
+            :through     => :parent_relationships,
+            :source      => :parent,
+            :class_name  => type.classify,
+            :source_type => table.classify
+          }
+          
+          has_many "parent_#{type}", opts do
+            fields.each do |field|
+              define_method field.to_s.pluralize do |*args|
+                value = args[0] || 1
+                scoped :conditions => [ "relationships.#{field} = ?", value ]
+              end
+            end
+          end
+          
+          opts = {
+            :select      => select,
+            :conditions  => sql,
+            :through     => :child_relationships,
+            :source      => :child,
+            :class_name  => type.classify,
+            :source_type => table.classify
+          }
+          
+          has_many "child_#{type}", opts do
+            fields.each do |field|
+              define_method field.to_s.pluralize do |*args|
+                value = args[0] || 1
+                scoped :conditions => [ "relationships.#{field} = ?", value ]
+              end
+            end
+          end
+          
+          self.class_eval do
+            # Records reader
+            define_method type do |*args|
+              if (read_attribute(:type) || self.class.to_s) < (args.empty? ? type.classify : args[0].to_s)
+                eval "self.child_#{type}"
+              else
+                eval "self.parent_#{type}"
+              end
+            end
+          end
+          
+          fields.each do |field|
+            # Relationship field writer
+            self.class_eval do
+              define_method field.to_s + '=' do |value|
+                modified = read_attribute(:modified_relationship_fields) || []
+                modified << field
+                write_attribute :modified_relationship_fields, modified.uniq
+                write_attribute field, value
+              end
+            end
+          end
+        end
+        unless included_modules.include?(InstanceMethods)
+          extend ClassMethods
+          include InstanceMethods
+          before_save :save_relationship_fields
+        end
+      end
+    end
+    
+    # the child in the relationship, so to speak
+    def acts_as_joinable(*args, &block)
+      acts_as_joinable_on(*args, &block)
+    end
+  end
+  
+  module InstanceMethods
+    # Before save
+    def save_relationship_fields
+      return unless read_attribute(:relationship_id) && read_attribute(:modified_relationship_fields)
+      r = Relationship.find self.relationship_id
+      read_attribute(:modified_relationship_fields).each do |field|
+        r[field] = self[field]
+      end
+      r.save
+      write_attribute :modified_relationship_fields, nil
+    end
+    
+    def get_joining(type, context)
+      get_joinings(type, context).first
+    end
+    
+    def get_joinings(type, context)
+      self.joinings.select do |joining|
+        joining.context == context.to_s
+      end
+    end
+    
+    def get_joined(type, context)
+      get_joineds(type, context).first
+    end
+    
+    def get_joineds(type, context)
+      return [] unless self.joineds and !self.joineds.empty?
+      
+      get_joinings(context).collect do |joining|
+        joining.joined
+      end
+    end
+    
+    def set_joined(type, context, value)
+      joining = get_joining(context) || Joining.new
+      clazz   = get_join_class(type)
+      joining.joined = value.is_a?(clazz) ? value : clazz.find(value)
+      joining.joining = self
+      joining.context = context.to_s
+      joining.save
+      self.send("#{context.to_s}_#{type.to_s}")
+    end
+    
+    private
+      def get_join_class(type)
+        if type.is_a?(String) || type.is_a?(Symbol)
+          type.to_s.camelize.constantize
+        elsif type.is_a?(Class)
+          type
+        else
+          type.class
+        end
+      end
+  end
+end
+
+ActiveRecord::Base.send(:include, ActsAsJoinable) if defined?(ActiveRecord::Base)
+
+Dir["#{File.dirname(__FILE__)}/../app/models/*"].each { |c| require c if File.extname(c) == ".rb" }

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'acts-as-joinable'
+
+ActiveRecord::Base.send :include, ActsAsJoinable

data/test/lib/_database.rb

@@ -0,0 +1,33 @@
+begin
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+rescue ArgumentError
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+end
+
+ActiveRecord::Base.configurations = true
+
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.timestamps
+  end
+  
+  create_table :assets, :force => true do |t|
+    t.string :title
+    t.timestamps
+  end
+  
+  create_table :tags, :force => true do |t|
+    t.string :name
+    t.timestamps
+  end
+  
+  create_table :relationships do |t|
+    t.references :parent, :polymorphic => true
+    t.references :child, :polymorphic => true
+    t.string :context
+    t.timestamps
+  end
+  
+end

data/test/lib/asset.rb

@@ -0,0 +1,3 @@
+class Asset < ActiveRecord::Base
+  acts_as_joinable
+end

data/test/lib/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  acts_as_joinable_on :assets, :tags
+end

data/test/lib/tag.rb

@@ -0,0 +1,3 @@
+class Tag < ActiveRecord::Base
+  acts_as_joinable
+end

data/test/test_acts_as_joinable.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ActsAsJoinableTest < ActiveSupport::TestCase
+  
+  context "ActsAsJoinable" do
+    
+    setup do
+      create_models(1, 2)
+    end
+    
+    should "have 1 of each post, asset, tag to start" do
+      assert_equal 1, Post.count
+      assert_equal 2, Tag.count
+      assert_equal 2, Asset.count
+    end
+    
+    context "correct generated methods" do
+      setup do
+        @post = Post.first
+        @asset = Asset.first
+        @tag = Tag.first
+      end
+      
+      should "Post should respond_to?(:tags) and respond_to?(:assets)" do
+        puts @post.tags.inspect + " !!"
+        assert @post.respond_to?(:tags)
+        assert @post.respond_to?(:assets)
+      end
+    end
+    
+    teardown do
+      Post.detonate
+      Tag.detonate
+      Asset.detonate
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+require "rubygems"
+require "ruby-debug"
+gem 'test-unit'
+require "test/unit"
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'active_record/fixtures'
+require 'shoulda'
+require 'shoulda/active_record'
+
+this = File.expand_path(File.dirname(__FILE__))
+
+require File.expand_path(File.join(this, '/../lib/acts-as-joinable'))
+
+ActsAsJoinable.models = Dir["#{this}/../app/models/*.rb"].collect { |f| File.basename f, '.rb' }
+
+Dir["#{this}/lib/*"].each { |c| require c if File.extname(c) == ".rb" }
+
+ActiveRecord::Base.class_eval do
+  def self.detonate
+    all.map(&:destroy)
+  end
+end
+
+ActiveSupport::TestCase.class_eval do
+  
+  def create_models(parent = 1, child = 2)
+    parent.times do |i|
+      post = Post.create!(:title => "title-#{i.to_s}")
+      child.times do |j|
+        position = (i + 1) * (j + 1)
+        asset = Asset.create!(:title => "asset-title-#{position.to_s}")
+        tag   = Tag.create!(:name => "tag-name-#{position.to_s}")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: acts-as-joinable
+version: !ruby/object:Gem::Version 
+  hash: 65
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  - 5
+  version: 0.0.1.5
+platform: ruby
+authors: 
+- Lance Pollard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-20 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: DRYing up Many-to-Many Relationships in ActiveRecord
+email: lancejpollard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- init.rb
+- MIT-LICENSE
+- lib/acts-as-joinable.rb
+- rails/init.rb
+- test/lib/_database.rb
+- test/lib/asset.rb
+- test/lib/post.rb
+- test/lib/tag.rb
+- test/test_acts_as_joinable.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/viatropos/cockpit
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: acts-as-joinable
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "ActsAsJoinable: DRYing up Many-to-Many Relationships in ActiveRecord"
+test_files: []
+