custom_associations 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07d9a48c6bf107a6817bad0ce5c3f17a2dd0a3e4
+  data.tar.gz: 17da1a0e7773abf7cb053616ddcf3396d6181021
+SHA512:
+  metadata.gz: fbd43e83424c0adaaf9f7049e4570d8c2925da334e596ce24626219a6370ce504af41b793731b75ca16daf06cb4fe211788574c41bc0a5c84270eca4336490f1
+  data.tar.gz: e3edab075e4065f76c0fa0bb2f9f2538a540953d46eaa952ce4f5f6700e40b9af4e698996f19bb480434671f160b25537d781ac8e4155366bd7bdbcc6e434967

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2007-2013 Joseph Khoobyar
+
+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.rdoc

@@ -0,0 +1,26 @@
+= CustomAssociations
+
+This is a quick rewrite of a very old (ActiveRecord 1.2.x) plugin of mine.
+
+It allows you to define associations based on joins and conditions, instead of keys.
+
+Future versions of this plugin will provide a better DSL, and greater flexibility.
+
+NOTE: Only tested with ActiveRecord 3.2.13.
+NOTE: Preloading is disabled for custom associations - eager-loading will be used instead.
+
+== Brief example
+
+NOTE: The +rescue+ hack below is just a quick way of showing what is possible with this plugin.  Future versions will support a unified syntax.
+
+    class Customer
+	    
+        has_many_custom :addresses,
+          :joins=>['INNER JOIN customer_addresses ON customer_addresses.address_id = addresses.id'],
+          :conditions=>proc{ {:'customer_addresses.customer_number'=>(customer_number rescue Customer.arel_table[:customer_number])} }
+  
+        has_one_custom :address,
+          :joins=>['INNER JOIN customer_addresses ON customer_addresses.address_id = addresses.id'],
+          :conditions=>proc{ {:'customer_addresses.customer_number'=>(customer_number rescue Customer.arel_table[:customer_number])} }
+          
+    end

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+  
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CustomAssociations'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/custom_associations.rb

@@ -0,0 +1,316 @@
+require 'active_record'
+require 'active_record/base'
+require 'active_support/concern'
+require 'custom_associations/version'
+
+module CustomAssociations
+  
+  # Builders for the DSL.
+  module Builder
+    
+    class CustomizableAssociation < ActiveRecord::Associations::Builder::Association
+      self.valid_options -= [ :foreign_key, :validate ]
+      self.valid_options += [ :as, :table_name, :joins, :order, :group, :having, :limit, :offset, :inverse_of ]
+
+    private
+    
+      # Ensure that the association is readonly.
+      def define_writers
+        mixin.remove_possible_method("#{name}=")
+      end
+    end
+    
+    class HasOneCustom < CustomizableAssociation 
+      self.macro = :has_one_custom
+    end
+    
+    class HasManyCustom < CustomizableAssociation
+      self.macro = :has_many_custom
+      
+      self.valid_options += [  :finder_sql, :counter_sql ]
+        
+	    attr_reader :block_extension
+
+	    def self.build(model, name, options, &extension)
+	      new(model, name, options, &extension).build
+	    end
+	
+	    def initialize(model, name, options, &extension)
+	      super(model, name, options)
+	      @block_extension = extension
+	    end
+	
+	    def build
+	      wrap_block_extension
+	      super
+	    end
+	    
+	  private
+
+      def wrap_block_extension
+        options[:extend] = Array.wrap(options[:extend])
+
+        if block_extension
+          silence_warnings do
+            model.parent.const_set(extension_module_name, Module.new(&block_extension))
+          end
+          options[:extend].push("#{model.parent}::#{extension_module_name}".constantize)
+        end
+      end
+
+      def extension_module_name
+        @extension_module_name ||= "#{model.to_s.demodulize}#{name.to_s.camelize}AssociationExtension"
+      end
+
+      def define_readers
+        super
+
+        name = self.name
+        mixin.redefine_method("#{name.to_s.singularize}_ids") do
+          association(name).ids_reader
+        end
+      end
+    end
+  end
+
+  # Customizable associations
+  module Associations
+
+    # Extensions to support custom associations.
+    module JoinAssociation
+      extend ActiveSupport::Concern
+		  
+      included do
+        alias_method_chain :build_constraint, :custom
+        alias_method_chain :join_to, :custom
+      end
+
+		  # HACK: Dummy constraint node for integrating custom associations with ActiveRecord.
+	    DummyConstraint = Object.new.tap{|o| def o.and(conditions) conditions end }.freeze
+
+      # Overridden to support custom associations.
+	    def build_constraint_with_custom(reflection, table, key, foreign_table, foreign_key)
+        case reflection.source_macro
+        when :has_one_custom, :has_many_custom
+		      return DummyConstraint unless reflection.klass.finder_needs_type_condition?
+		      reflection.klass.send(:type_condition, table)
+        else
+          build_constraint_without_custom(reflection, table, key, foreign_table, foreign_key)
+        end
+	    end
+	    
+      # Overridden to support custom associations.
+      def join_to_with_custom(relation)
+        case reflection.source_macro
+        when :has_one_custom, :has_many_custom
+          Array.wrap(reflection.options[:joins]).each do |join|
+	          next if join.blank? or ! join.is_a?(String)
+	          if join !~ /^\s*(?:(?:LEFT|RIGHT|INNER|OUTER|STRAIGHT)\s+)+JOIN\s+/ism
+	            join = "#{join_type==Arel::OuterJoin ? 'LEFT OUTER' : 'INNER'} JOIN #{join}"
+	          elsif join_type==Arel::OuterJoin
+	            join = join.sub(/^\s*(?:LEFT\s+)?INNER\b/,'LEFT OUTER')
+	          end
+	          relation.join(Arel.sql(join))
+          end
+        end
+	      join_to_without_custom(relation)
+      end
+
+    end
+    
+    # Extensions to support custom associations.
+    module JoinDependency
+      extend ActiveSupport::Concern
+      
+      included do
+        alias_method_chain :construct_association, :custom
+      end
+
+    protected
+    
+      # Overridden to support custom associations.
+      def construct_association_with_custom(record, join_part, row)
+        return if record.id.to_s != join_part.parent.record_id(row).to_s
+
+        macro = join_part.reflection.macro
+        if macro == :has_one_custom
+          if record.association_cache.key?(join_part.reflection.name)
+            association = record.association(join_part.reflection.name).target
+          else
+	          association = join_part.instantiate(row) unless row[join_part.aliased_primary_key].nil?
+	          set_target_and_inverse(join_part, association, record)
+	        end
+        elsif macro == :has_many_custom
+          association = join_part.instantiate(row) unless row[join_part.aliased_primary_key].nil?
+          other = record.association(join_part.reflection.name)
+          other.loaded!
+          other.target.push(association) if association
+          other.set_inverse_instance(association)
+        else
+          associaton = construct_association_without_custom(record, join_part, row)
+        end
+        association
+      end
+    end
+    
+    # Gutted to support associations without explicit keys.
+    class CustomizableAssociationScope < ActiveRecord::Associations::AssociationScope
+      
+    private
+
+      # Overridden to remove chain support.
+      def add_constraints(scope)
+        table, foreign_table = construct_tables
+
+        if reflection.type
+	        scope = scope.where(table[reflection.type].eq(owner.class.base_class.name))
+        end
+        
+        conditions.first.each do |condition|
+          scope = scope.where(interpolate(condition))
+        end
+
+        scope
+      end
+      
+    end
+    
+    module CustomizableAssociation
+      
+      # Undefine all mutator methods.
+      def self.included(base)
+        [ :writer, :ids_writer, :set_owner_attributes, :add_to_target, :set_new_record,
+          :replace, :replace_records, :callback, :callbacks_for,
+          :build, :build_record, :create_scope, :creation_attributes,
+		      :create, :create!, :concat, :create_record, :insert_record, :concat_records,
+		      :delete_all, :delete_all_on_destroy, :destroy_all, :delete, :destroy,
+		      :delete_or_destroy, :remove_records, :delete_records
+		    ].each do |name|
+          begin undef_method name
+          rescue NameError
+          end
+        end
+      end
+
+			# Overridden to always return true.
+			def foreign_key_present?
+				true
+			end
+      
+      # Overridden to use CustomizableAssociationScope.
+      def association_scope
+        @association_scope ||= CustomizableAssociationScope.new(self).scope if klass
+      end
+    end
+    
+    # Patterned after belongs_to and has_one associations in AR.
+    class HasOneCustomAssociation < ActiveRecord::Associations::SingularAssociation
+      include CustomizableAssociation
+    end
+    
+    # Patterned after has_many associations in AR.
+    class HasManyCustomAssociation < ActiveRecord::Associations::CollectionAssociation
+      include CustomizableAssociation
+      
+    private
+      
+      # Copied from ActiveRecord::Associations::HasManyAssociation
+      def count_records
+        count = if options[:counter_sql] || options[:finder_sql]
+          reflection.klass.count_by_sql(custom_counter_sql)
+        else
+          scoped.count
+        end
+      
+        # If there's nothing in the database and @target has no new records
+        # we are certain the current target is an empty array. This is a
+        # documented side-effect of the method that may avoid an extra SELECT.
+        @target ||= [] and loaded! if count == 0
+      
+        [options[:limit], count].compact.min
+      end
+    end
+
+  end
+  
+  # Reflection for custom associations.
+	class Reflection < ActiveRecord::Reflection::AssociationReflection
+	  def initialize(macro, name, options, active_record)
+	    super
+	    @collection = (macro==:has_many_custom)
+	  end
+	      
+	  def association_class
+	    case macro
+	    when :has_one_custom
+	      Associations::HasOneCustomAssociation
+	    when :has_many_custom
+	      Associations::HasManyCustomAssociation
+	    end
+	  end
+	end
+	
+	# Relation extensions to disable preloading for custom associations.
+	module Relation
+	  extend ActiveSupport::Concern
+		  
+	  included do
+	    alias_method_chain :eager_loading?, :custom
+	  end
+	  
+    def eager_loading_with_custom?
+      @should_eager_load ||= eager_loading_without_custom? || ! supports_preloading?
+    end
+
+	private
+	
+	  # Checks if this relation supports preloading (which is disabled for custom associations)
+	  def supports_preloading?(klass=@klass, includes=@includes_values)
+	    includes.all? do |(a,b)|
+	      a = klass.reflections[a.to_sym]
+	      a && ! a.is_a?(Reflection) && (! b.present? || supports_preloading?(a.klass, Array.wrap(b)))
+	    end
+	  end
+	end
+  
+	# Extensions to support custom associations.
+  module Core
+	  extend ActiveSupport::Concern
+
+	  module ClassMethods
+	    # DSL method
+	    def has_one_custom(name, options = {}, &extension)
+	      Builder::HasOneCustom.build(self, name, options, &extension)
+	    end
+	    
+	    # DSL method
+	    def has_many_custom(name, options = {}, &extension)
+	      Builder::HasManyCustom.build(self, name, options, &extension)
+	    end
+	
+	    # Overridden to create reflections for custom associations.
+	    def create_reflection(macro, name, options, active_record)
+	      case macro
+	      when :has_one_custom, :has_many_custom
+	        reflection = CustomAssociations::Reflection.new(macro, name, options, active_record)
+	        self.reflections = self.reflections.merge(name => reflection)
+	        reflection
+	      else
+	        super
+	      end
+	    end
+	  end
+  end
+  
+  # Installs this extension into ActiveRecord.
+  def self.initialize!
+    ::ActiveRecord::Base.send :include, Core
+    ::ActiveRecord::Relation.send :include, Relation
+    ::ActiveRecord::Associations::JoinDependency.send :include, Associations::JoinDependency
+    ::ActiveRecord::Associations::JoinDependency::JoinAssociation.send :include, Associations::JoinAssociation
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  CustomAssociations.initialize!
+end

data/lib/custom_associations/version.rb

@@ -0,0 +1,3 @@
+module CustomAssociations
+  VERSION = "0.1.0.pre"
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.