edge_rider 0.2.5 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODY2ODc4YmNlY2UxYjI4ZDBjMTRiZjg5ZGY1ZjM4Y2JhNzkyNDg2OA==
+  data.tar.gz: !binary |-
+    MGZhMTUwMWQxYWViNTQwMjVkMGQzZDE2YjljYTI1MmVlZThmNGFiYQ==
+SHA512:
+  metadata.gz: !binary |-
+    MjYyZDFkZWM4NDYzNmVlNjEwNTk1NjdhMWUyNzc3YmUxNTZjOTVjZTMxOTZh
+    MTQxMjBlMDdlMjQ4NmFmNWMxYWY4ZWFlMjA4MTQ2Y2UzNjQ2NmMyMDY1OTI3
+    ZTljOGE4NmQ3MzU3MzBhM2U2Y2UxZGQ3NmM3YzA2MThhZTM5NzE=
+  data.tar.gz: !binary |-
+    NzQ4NTM3NWIwN2EyYjcyZWM5ZjgwZjNiYzVjZDc0NjBmZjc4OTM5NDBiZTg3
+    NGI5NDU2MjM1MGU0MzI0MGE2YmQ1MGE1YzBkMDQwOGI4ODczMjE4NGEzNWJk
+    MTA5NDg2NzVlYTkyNTI3NTkyODI2ZjQ1ODQyOThiZTgxNjRiMTg=

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - "1.8.7"
   - "1.9.3"
+  - "2.1.0"
   - ree
 services:
   - mysql

data/README.md

@@ -10,11 +10,11 @@ of scalable code with ActiveRecord, you are probably using relations (or scopes)
 
 Edge Rider was created with two intents:
 
-1. Provides a number of utility methods to facilitate hardcore work with relations.
+1. Provide a number of utility methods to facilitate hardcore work with relations.
 2. Provide a stable API for working with relations across multiple versions of Rails (since
 Rails has a tradition of breaking details of its relation API every other release).
 
-It has been tested with Rails 2.3, 3.0 and 3.2.
+It is tested with Rails 2.3, 3.0, 3.2 and 4.1, and on Ruby 1.8.7, 1.9.3 and 2.1.0.
 
 
 Usage
@@ -185,13 +185,8 @@ which Edge Rider merely makes public. Edge Rider ports this method forward to Ra
 ### Retrieve the class a relation is based on
 
 Edge Rider gives your relations a method `#origin_class` that returns the class the relation is based on.
-This is useful e.g. to perform unscoped method look-up.
+This is useful e.g. to perform unscoped record look-up.
 
-    # Rails 2 scope
-    Post.recent.origin_class
-    # => Post
-
-    # Rails 3 relation
     Post.recent.origin_class
     # => Post
 
@@ -199,6 +194,27 @@ Note that `#origin_class` it roughly equivalent to the blockless form of [`unsco
 but it works consistently across all Rails versions.
 
 
+### Turn a model into a scope or narrow down an existing scope
+
+Edge Rider ports `Model.scoped` forward to Rails 4+ (taken from
+[activerecord-deprecated_finders](https://github.com/rails/activerecord-deprecated_finders/blob/master/lib/active_record/deprecated_finders/base.rb#L61)). This
+enables you to consistently turn models into scopes or narrow down scopes
+across all versions of Rails.
+
+    User.scoped # just calls User.all in Rails 4
+    User.active.scoped(conditions: { admin: true })
+
+*Implementation note*: Rails 2 and 3 already have a method
+[`.scoped`](http://apidock.com/rails/ActiveRecord/Scoping/Named/ClassMethods/scoped) which Edge Rider does not touch. Rails 4 has removed this method and
+splits its functionality into the query methods known from Rails 3 (`.where`,
+`.order` etc.) and an `.all` method that just returns a scope.
+
+Note that associations and scopes also have a `.scoped` method that behaves
+slightly different in all versions of Rails (see
+[`scoped_spec.rb`](/spec/shared/spec/edge_rider/scoped_spec.rb#L49)). These
+methods are not modified.
+
+
 Installation
 ------------
 

data/Rakefile

@@ -54,7 +54,14 @@ end
 def for_each_directory_of(path, &block)
   Dir[path].sort.each do |rakefile|
     directory = File.dirname(rakefile)
-    puts '', "\033[44m#{directory}\033[0m", ''
-    block.call(directory)
+    puts '', "\033[4;34m# #{directory}\033[0m", '' # blue underline
+    
+    if directory.include?('rails-2.3') and RUBY_VERSION != '1.8.7'
+      puts 'Skipping - Rails 2.3 requires Ruby 1.8.7'
+    elsif directory.include?('rails-4.1') and RUBY_VERSION == '1.8.7'
+      puts 'Skipping - Rails 4.1 does not support Ruby 1.8'
+    else
+      block.call(directory)
+    end
   end
 end

data/lib/edge_rider.rb

@@ -7,8 +7,7 @@ require 'edge_rider/collect_column'
 require 'edge_rider/collect_ids'
 require 'edge_rider/preload_associations'
 require 'edge_rider/origin_class'
+require 'edge_rider/scoped'
 require 'edge_rider/traverse_association'
 require 'edge_rider/to_id_query'
 require 'edge_rider/to_sql'
-
-

data/lib/edge_rider/preload_associations.rb

@@ -2,10 +2,16 @@ module EdgeRider
   module PreloadAssociations
 
     def preload_associations(*args)
-      ActiveRecord::Associations::Preloader.new(*args).run
+      preloader = ActiveRecord::Associations::Preloader
+
+      if preloader.method_defined?(:preload) # Rails 4
+        preloader.new.preload(*args)
+      else
+        preloader.new(*args).run
+      end
     end
 
-    if ActiveRecord::Base.respond_to?(:preload_associations, true) # Rails 2.3, Rails 3.0
+    if ActiveRecord::Base.respond_to?(:preload_associations, true) # Rails 2/3.0
       ActiveRecord::Base.class_eval do
         class << self
           public :preload_associations

data/lib/edge_rider/scoped.rb

@@ -0,0 +1,30 @@
+module EdgeRider
+  module Scoped
+    
+    VALID_FIND_OPTIONS = [ :conditions, :include, :joins, :limit, :offset,
+                           :order, :select, :readonly, :group, :having, :from, :lock ]
+    
+    def scoped(options = nil)
+      options ||= {}
+      relation = all
+  
+      options.assert_valid_keys(VALID_FIND_OPTIONS)
+      finders = options.dup
+      finders.delete_if { |key, value| value.nil? && key != :limit }
+  
+      ((VALID_FIND_OPTIONS - [:conditions, :include]) & finders.keys).each do |finder|
+        relation = relation.send(finder, finders[finder])
+      end
+  
+      relation = relation.where(finders[:conditions]) if options.has_key?(:conditions)
+      relation = relation.includes(finders[:include]) if options.has_key?(:include)
+  
+      relation
+    end
+
+    if Rails.version.to_i >= 4
+      ActiveRecord::Base.extend(self)
+    end
+
+  end
+end

data/lib/edge_rider/traverse_association.rb

@@ -13,8 +13,10 @@ module EdgeRider
         reflection = scope.reflect_on_association(association) or raise UnknownAssociation, "Could not find association: #{self.name}##{association}"
         foreign_key = reflection.respond_to?(:foreign_key) ? reflection.foreign_key : reflection.primary_key_name
 
-        raise NotImplementedError if reflection.options[:conditions].present?
-
+        # In Rails 4, conditions on a scope are expressed as a lambda parameter
+        # that is called `scope`.
+        raise NotImplementedError if reflection.options[:conditions] or (reflection.respond_to?(:scope) && reflection.scope)
+           
         if reflection.macro == :belongs_to # belongs_to
           ids = scope.collect_column(foreign_key, :distinct => true)
           scope = EdgeRider::Util.exclusive_query(reflection.klass, :id => ids)

data/lib/edge_rider/util.rb

@@ -27,6 +27,31 @@ module EdgeRider
     def scope?(object)
       object.respond_to?(:scoped)
     end
+    
+    def define_scope(klass, name, lambda)
+      if Rails.version.to_i < 4 # Rails 2/3
+        scope_definition = Rails.version.to_i < 3 ? :named_scope : :scope
+        klass.send scope_definition, name, lambda
+      else
+        klass.send :scope, name, lambda { |*args|
+          options = lambda.call(*args)
+          klass.scoped(options.slice :conditions)
+        }
+      end      
+    end
+    
+    def define_association(owner, association, target, options)
+      if Rails.version.to_i < 4
+        owner.send association, target, options
+      else
+        # Reduce the options hash to the given keys and store the remainder in
+        # other_options. Using Hash#extract! would be easier to unterstand,
+        # but Rails 2 does not have it.
+        other_options = options.slice!(:conditions)
+        scope = lambda { |*args| scoped(options) }
+        owner.send association, target, scope, other_options
+      end
+    end
 
     def activerecord2?
       ActiveRecord::VERSION::MAJOR < 3

data/lib/edge_rider/version.rb

@@ -1,3 +1,3 @@
 module EdgeRider
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

data/spec/rails-2.3/.ruby-version

@@ -0,0 +1 @@
+1.8.7

data/spec/rails-2.3/Gemfile

@@ -1,4 +1,7 @@
-source :rubygems
+source 'https://rubygems.org'
+
+Deprecate.skip = true if defined?(Deprecate.skip)
+Gem::Deprecate.skip = true if defined?(Gem::Deprecate.skip)
 
 gem 'rails', '~>2.3'
 gem 'rspec', '~>1.3'

data/spec/rails-2.3/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../..
   specs:
-    edge_rider (0.2.4)
+    edge_rider (0.3.0)
       activerecord
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionmailer (2.3.18)
       actionpack (= 2.3.18)

data/spec/rails-2.3/spec.opts

@@ -2,3 +2,4 @@
 --format progress
 --loadby mtime
 --reverse
+--backtrace

data/spec/rails-3.0/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/spec/rails-3.0/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rails', '~>3.0.17'
 gem 'rspec'

data/spec/rails-3.0/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../..
   specs:
-    edge_rider (0.2.4)
+    edge_rider (0.3.0)
       activerecord
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     abstract (1.0.0)
     actionmailer (3.0.20)

data/spec/rails-3.2/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/spec/rails-3.2/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rails', '~>3.2.0'
 gem 'rspec'

data/spec/rails-3.2/Gemfile.lock

@@ -1,11 +1,11 @@
 PATH
   remote: ../..
   specs:
-    edge_rider (0.2.4)
+    edge_rider (0.3.0)
       activerecord
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     actionmailer (3.2.14)
       actionpack (= 3.2.14)

data/spec/rails-3.2/Rakefile

@@ -8,4 +8,5 @@ desc "Run all specs for a specific rails version"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = defined?(SPEC) ? SPEC : ['**/*_spec.rb', '../shared/spec/**/*_spec.rb']
   t.verbose = false
+  t.rspec_opts = '-b'
 end

data/spec/rails-4.1/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format progress

data/spec/rails-4.1/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/spec/rails-4.1/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~>4.1.0'
+gem 'rspec'
+gem 'rspec-rails'
+gem 'mysql2'
+gem 'rspec_candy'
+gem 'debugger', platform: 'ruby_19'
+gem 'database_cleaner', '=1.0.1'
+gem 'andand'
+gem 'has_defaults'
+gem 'minitest' # fix MiniTest deprecation warnings
+
+gem 'edge_rider', :path => '../..'

data/spec/rails-4.1/Gemfile.lock

@@ -0,0 +1,138 @@
+PATH
+  remote: ../..
+  specs:
+    edge_rider (0.3.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.0)
+      actionpack (= 4.1.0)
+      actionview (= 4.1.0)
+      mail (~> 2.5.4)
+    actionpack (4.1.0)
+      actionview (= 4.1.0)
+      activesupport (= 4.1.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.0)
+      activesupport (= 4.1.0)
+      builder (~> 3.1)
+    activerecord (4.1.0)
+      activemodel (= 4.1.0)
+      activesupport (= 4.1.0)
+      arel (~> 5.0.0)
+    activesupport (4.1.0)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    andand (1.3.3)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
+    columnize (0.3.6)
+    database_cleaner (1.0.1)
+    debugger (1.6.3)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.4)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.4)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    has_defaults (0.4.1)
+      activerecord
+    hike (1.2.3)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (5.3.4)
+    multi_json (1.10.1)
+    mysql2 (0.3.16)
+    polyglot (0.3.5)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.1.0)
+      actionmailer (= 4.1.0)
+      actionpack (= 4.1.0)
+      actionview (= 4.1.0)
+      activemodel (= 4.1.0)
+      activerecord (= 4.1.0)
+      activesupport (= 4.1.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.0)
+      sprockets-rails (~> 2.0)
+    railties (4.1.0)
+      actionpack (= 4.1.0)
+      activesupport (= 4.1.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-rails (3.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.0)
+    rspec_candy (0.3.1)
+      rspec
+      sneaky-save
+    sneaky-save (0.0.5)
+      activerecord (>= 3.2.0)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.1.3)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (1.2.1)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  andand
+  database_cleaner (= 1.0.1)
+  debugger
+  edge_rider!
+  has_defaults
+  minitest
+  mysql2
+  rails (~> 4.1.0)
+  rspec
+  rspec-rails
+  rspec_candy