activerecord-futures 0.3.0 → 0.4.0

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+*.sqlite3
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -2,18 +2,17 @@ language: ruby
 rvm:
   - 1.9.3
 env:
-  - ADAPTER=future_enabled_mysql2 activerecord=3.2.11
-  - ADAPTER=future_enabled_mysql2 activerecord=3.2.12
-  - ADAPTER=future_enabled_mysql2 activerecord=3.2.13
   - ADAPTER=mysql2 activerecord=3.2.11
   - ADAPTER=mysql2 activerecord=3.2.12
   - ADAPTER=mysql2 activerecord=3.2.13
-  - ADAPTER=future_enabled_postgresql activerecord=3.2.11
-  - ADAPTER=future_enabled_postgresql activerecord=3.2.12
-  - ADAPTER=future_enabled_postgresql activerecord=3.2.13
+  - ADAPTER=future_enabled_mysql2 activerecord=3.2.13
   - ADAPTER=postgresql activerecord=3.2.11
   - ADAPTER=postgresql activerecord=3.2.12
   - ADAPTER=postgresql activerecord=3.2.13
+  - ADAPTER=future_enabled_postgresql activerecord=3.2.13
+  - ADAPTER=sqlite3 activerecord=3.2.11
+  - ADAPTER=sqlite3 activerecord=3.2.12
+  - ADAPTER=sqlite3 activerecord=3.2.13
 
 before_script:
   - mysql -e 'create database activerecord_futures_test;'

data/README.md

@@ -33,16 +33,9 @@ Or install it yourself as:
 
 ## Usage
 
-Once the gem is installed, set your config/database.yml file to use a future enabled adapter:
-
-```yml
-development: &development
-  adapter: future_enabled_mysql2 # or "future_enabled_postgresql"
-  username: your_username
-  password: your_password
-  database: your_database
-  host: your_host
-```
+If you're using postgresql or mysql2 currently, you have nothing more to do. The gem will automatically use the future enabled adapter and just work. If you are using a custom adapter, specify it in the config/database.yml file as you're used to.
+
+Check the database support (below) section for more info.
 
 Now let's see what this does, consider a model `User`, with a `:name` attribute:
 
@@ -66,6 +59,20 @@ Any amount of futures can be prepared, and they will get executed as soon as one
 This makes this especially useful for pagination queries, since you can execute
 both count and page queries at once.
 
+#### Rails
+
+No configuration to do, things will Just Work.
+
+#### Rack based apps (not Rails)
+
+You will need to manually add the `ActiveRecord::Futures::Middleware` somewhere in the middleware stack:
+
+```ruby
+use ActiveRecord::Futures::Middleware
+```
+
+This is to clear the futures that were defined and not triggered between requests.
+
 ### Methods
 
 #### #future method
@@ -99,8 +106,8 @@ Lastly, you also get finder methods futurized, which are:
 * future_all
 
 As with the other future methods, those which return an array get triggered with
-the `to_a` method, or the delegated ones, and those that return a value or a hash
-are triggered with the `value` method. Note that the `find` method returns an
+the `#to_a` method, or the delegated ones, and those that return a value or a hash
+are triggered with the `#value` method. Note that the `#find` method returns an
 array or a value depending on the parameters provided, and so will the futurized
 version of the method.
 
@@ -121,8 +128,8 @@ If you have an older version of the gem, ActiveRecord::Futures will fall back to
 
 ### Postgres
 
-The pg gem supports multiple statement queries by using the `send_query` method
-and retrieving the results via `get_result`.
+The pg gem supports multiple statement queries by using the `#send_query` method
+and retrieving the results via `#get_result`.
 
 ### Other databases
 

data/Rakefile

@@ -5,7 +5,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :default => :spec
 
-ADAPTERS = %w(future_enabled_mysql2 future_enabled_postgresql postgresql mysql2)
+ADAPTERS = %w(future_enabled_postgresql future_enabled_mysql2 postgresql mysql2 sqlite3)
 
 desc "Runs the specs with all databases"
 task :all do

data/activerecord-futures.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec-spies'
   gem.add_development_dependency 'mysql2', '>= 0.3.12.b1'
   gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'sqlite3'
 end

data/lib/active_record/futures/middleware.rb

@@ -0,0 +1,14 @@
+module ActiveRecord
+  module Futures
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        FutureRegistry.clear
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/active_record/futures/railtie.rb

@@ -0,0 +1,7 @@
+module ActiveRecord
+  module Futures
+    class Railtie < ::Rails::Railtie
+      config.app_middleware.use Middleware
+    end
+  end
+end

data/lib/activerecord-futures.rb

@@ -14,6 +14,9 @@ require "active_record/futures/calculation_methods"
 require "active_record/futures"
 require "active_record/futures/delegation"
 
+require "active_record/futures/middleware" if defined?(Rack)
+require "active_record/futures/railtie" if defined?(Rails)
+
 module ActiveRecord
   class Relation
     include Futures
@@ -22,4 +25,31 @@ module ActiveRecord
   class Base
     extend Futures::Delegation
   end
+end
+
+class ActiveRecord::Base::ConnectionSpecification
+  class Resolver
+    def spec_with_futures
+      spec = spec_without_futures
+      begin
+        config = spec.config
+        future_adapter_name = "future_enabled_#{config[:adapter]}"
+
+        # Try to load the future version of the adapter
+        require "active_record/connection_adapters/#{future_adapter_name}_adapter"
+
+        config[:adapter] = future_adapter_name
+        adapter_method = "future_enabled_#{spec.adapter_method}"
+
+        # Return the specification with the future adapter instead
+        ActiveRecord::Base::ConnectionSpecification.new(config, adapter_method)
+      rescue LoadError
+        # No future version of the adapter, or the adapter was already a future
+        # one. Keep going as usual...
+        spec
+      end
+    end
+
+    alias_method_chain :spec, :futures
+  end
 end

data/lib/activerecord-futures/version.rb

@@ -1,5 +1,5 @@
 module Activerecord
   module Futures
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/active_record/futures/middleware_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'active_record/futures/middleware'
+
+module ActiveRecord::Futures
+  describe Middleware do
+    let(:app) { double("Rack Application", call: nil) }
+    let(:env) { double("App environment") }
+
+    subject(:middleware) { Middleware.new(app) }
+
+    before do
+      FutureRegistry.stub(:clear)
+    end
+
+    context "normal flow" do
+      before do
+        middleware.call(env)
+      end
+
+      it "resets the registry" do
+        FutureRegistry.should have_received(:clear)
+      end
+
+      it "continues calling the middleware stack" do
+        app.should have_received(:call).with(env)
+      end
+    end
+
+    context "when app.call raises exception" do
+      before do
+        app.stub(:call).and_raise("some error")
+        begin
+          middleware.call(env)
+        rescue
+        end
+      end
+
+      it "still clears the registry" do
+        FutureRegistry.should have_received(:clear)
+      end
+    end
+  end
+end

data/spec/in_action/future_find_execution_spec.rb

@@ -18,6 +18,13 @@ describe "future_find method" do
       arel.to_sql
     end
 
+    let(:future_sql_sqlite3) do
+      arel = relation.arel
+      arel.constraints.unshift(Arel.sql('"posts"."id" = ?'))
+      arel.limit = 1
+      arel.to_sql
+    end
+
     before do
       Post.create(published_at: Time.new(2012, 12, 10))
       Post.create(published_at: Time.new(2012, 6, 23))

data/spec/spec_helper.rb

@@ -4,17 +4,17 @@ Coveralls.wear!
 require 'activerecord-futures'
 
 configs = {
+  future_enabled_postgresql: {
+    adapter: "postgresql",
+    database: "activerecord_futures_test",
+    username: "postgres"
+  },
   future_enabled_mysql2: {
-    adapter: "future_enabled_mysql2",
+    adapter: "mysql2",
     database: "activerecord_futures_test",
     username: "root",
     encoding: "utf8"
   },
-  future_enabled_postgresql: {
-    adapter: "future_enabled_postgresql",
-    database: "activerecord_futures_test",
-    username: "postgres"
-  },
   postgresql: {
     adapter: "postgresql",
     database: "activerecord_futures_test",
@@ -25,6 +25,10 @@ configs = {
     database: "activerecord_futures_test",
     username: "root",
     encoding: "utf8"
+  },
+  sqlite3: {
+    adapter: "sqlite3",
+    database: ':memory:'
   }
 }
 
@@ -38,6 +42,8 @@ supports_futures =
   ActiveRecord::Base.connection.respond_to?(:supports_futures?) &&
   ActiveRecord::Base.connection.supports_futures?
 
+puts "Supports futures!" if supports_futures
+
 require 'db/schema'
 Dir['./spec/models/**/*.rb'].each { |f| require f }
 
@@ -50,7 +56,10 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
   config.filter_run_excluding(supports_futures ? :not_supporting_adapter : :supporting_adapter)
-  config.filter_run_excluding(postgresql: config_key.to_s.include?("postgresql") ? false : true)
+
+  %w(postgresql mysql2 sqlite3).each do |adapter|
+    config.filter_run_excluding(adapter.to_sym => !config_key.to_s.include?(adapter))
+  end
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.

data/spec/support/futurized_method_examples.rb

@@ -9,7 +9,7 @@ shared_examples "a futurized method" do |exec_trigger|
       calling_future.should exec(1).query
     end
 
-    specify(nil, postgresql: false) do
+    specify(nil, postgresql: false, sqlite3: false) do
       calling_future.should exec_query(future_sql)
     end
 
@@ -18,6 +18,11 @@ shared_examples "a futurized method" do |exec_trigger|
       calling_future.should exec_query(sql)
     end
 
+    specify(nil, sqlite3: true) do
+      sql = respond_to?(:future_sql_sqlite3) ? future_sql_sqlite3 : future_sql
+      calling_future.should exec_query(sql)
+    end
+
     specify { future.send(exec_trigger).should eq relation_result }
 
     context "after executing the future" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-futures
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -91,6 +91,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Save unnecessary round trips to the database
 email:
 - leoasis@gmail.com
@@ -117,14 +133,17 @@ files:
 - lib/active_record/futures/future_array.rb
 - lib/active_record/futures/future_registry.rb
 - lib/active_record/futures/future_value.rb
+- lib/active_record/futures/middleware.rb
 - lib/active_record/futures/proxy.rb
 - lib/active_record/futures/query_recording.rb
+- lib/active_record/futures/railtie.rb
 - lib/activerecord-futures.rb
 - lib/activerecord-futures/version.rb
 - spec/active_record/futures/future_array_spec.rb
 - spec/active_record/futures/future_registry_spec.rb
 - spec/active_record/futures/future_spec.rb
 - spec/active_record/futures/future_value_spec.rb
+- spec/active_record/futures/middleware_spec.rb
 - spec/active_record/futures/proxy_spec.rb
 - spec/db/schema.rb
 - spec/in_action/combination_of_futures_spec.rb
@@ -173,6 +192,7 @@ test_files:
 - spec/active_record/futures/future_registry_spec.rb
 - spec/active_record/futures/future_spec.rb
 - spec/active_record/futures/future_value_spec.rb
+- spec/active_record/futures/middleware_spec.rb
 - spec/active_record/futures/proxy_spec.rb
 - spec/db/schema.rb
 - spec/in_action/combination_of_futures_spec.rb