request_store_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4179f342e1c92035d2daf543887e02c5b2e5620
+  data.tar.gz: ae71e457d209160ae4ccc736f93cb252769640ff
+SHA512:
+  metadata.gz: 480eee450b8cc4f6d9fb105ceaf9ef1520123cb8b9298466b53a22b7ebd8fadcb459349c3700668407787fcee6e6497a5037b5ccf0d5b0876e9b2aaf0ead3c09
+  data.tar.gz: e8cfc0b07cd322fd4dffa9209f9743a88ac1021a9506e913e7be7e4c3c4305a49c6992ffe3455a79745052249cb8eca154c237a8618fa49d6598da3bf5f9d866

data/README.md

@@ -0,0 +1,265 @@
+Queryable
+=====================
+[![Gem Version](https://badge.fury.io/rb/queryable.svg)](http://badge.fury.io/rb/queryable)
+[![Build Status](https://travis-ci.org/ElMassimo/queryable.svg)](https://travis-ci.org/ElMassimo/queryable)
+[![Test Coverage](https://codeclimate.com/github/ElMassimo/queryable/badges/coverage.svg)](https://codeclimate.com/github/ElMassimo/queryable)
+[![Code Climate](https://codeclimate.com/github/ElMassimo/queryable.png)](https://codeclimate.com/github/ElMassimo/queryable)
+[![Inline docs](http://inch-ci.org/github/ElMassimo/queryable.svg)](http://inch-ci.org/github/ElMassimo/queryable)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/ElMassimo/queryable/blob/master/LICENSE.txt)
+<!-- [![Coverage Status](https://coveralls.io/repos/ElMassimo/queryable/badge.png)](https://coveralls.io/r/ElMassimo/queryable) -->
+
+Queryable is a mixin that allows you to easily define query objects with chainable scopes.
+
+### Scopes
+
+Scopes serve to encapsulate reusable business rules, a method is defined with
+the selected name and block (or proc)
+```ruby
+class CustomersQuery
+  include Queryable
+
+  scope(:recent) { desc(:logged_in_at) }
+
+  scope :active, ->{ where(status: 'active') }
+
+  scope :favourite_brand do |product, brand|
+    where("favourites.#{product}": brand)
+  end
+
+  def current
+    recent.active
+  end
+
+  def miller_fans
+    favourite_brand(:beer, :Miller)
+  end
+end
+
+
+CustomerQuery.new(shop.customers).miller_fans
+```
+
+### Delegation
+
+By default most Array methods are delegated to the internal query. It's possible
+to delegate extra methods to the query by calling `delegate`.
+```ruby
+class CustomersQuery
+  include Queryable
+
+  delegate :update_all, :destroy_all, :exists?
+end
+```
+
+### Delegate and Chain
+
+Sometimes you want to delegate a method to the internal query, but continue
+working with the query object like if you were calling scopes.
+
+You can achieve that using `delegate_and_chain`, which will delegate the method
+call, assign the return value as the internal query, and return the query object.
+
+```ruby
+class CustomersQuery
+  include Queryable
+
+  delegate_and_chain :where, :order_by
+end
+```
+
+## Advantages
+
+* Query objects are easy to understand.
+* You can inherit, mixin, and chain queries in a very natural way.
+* Increased testability, pretty close to being ORM/ODM agnostic.
+
+## Basic Usage
+
+If you are using Mongoid or ActiveRecord, you might want to try the
+`Queryable::Mongoid` and `Queryable::ActiveRecord` modules that already take
+care of delegating and chaining most of the methods in the underlying queries.
+
+```ruby
+class CustomersQuery
+  include Queryable::Mongoid
+end
+
+CustomersQuery.new.where(:amount_purchased.gt => 2).active.asc(:logged_in_at)
+```
+
+This modules also include all the optional modules. If you would like to opt-out
+of the other modules you can follow the approach in the [Notes](https://github.com/ElMassimo/queryable#notes) section.
+
+## Advanced Usage
+There are three opt-in modules that can help you when creating query objects.
+These modules would need to be manually required during app initialization or
+wherever necessary (in Rails, config/initializers).
+
+### DefaultQuery
+Provides default initialization for query objects, by attempting to infer the
+class name of the default collection for the query, and it also provides a
+`queryable` method to specify it.
+
+```ruby
+require 'queryable/default_query'
+
+def CustomersQuery
+  include Queryable
+  include Queryable::DefaultQuery
+end
+
+def OldCustomersQuery < CustomersQuery
+  queryable ArchivedCustomers
+end
+
+CustomersQuery.new.queryable == Customer.all
+OldCustomersQuery.new.queryable == ArchivedCustomers.all
+```
+If you want to use common base objects for your queries, you may want want to
+delay the automatic inference:
+
+```ruby
+class BaseQuery
+  include Queryable
+  include Queryable::DefaultQuery
+
+  queryable false
+end
+
+class CustomersQuery < BaseQuery
+end
+
+CustomersQuery.new.queryable == Customer.all
+```
+
+### DefaultScope
+Allows to define default scopes in query objects, and inherit them in query
+object subclasses.
+
+```ruby
+require 'queryable/default_scope'
+
+def CustomersQuery
+  include Queryable
+  include Queryable::DefaultScope
+  include Queryable::DefaultQuery
+
+  default_scope :active
+  scope :active, -> { where(:last_purchase.gt => 7.days.ago) }
+end
+
+def BigCustomersQuery < CustomersQuery
+  default_scope :big_spender
+  scope :big_spender, -> { where(:total_expense.gt => 9999999) }
+end
+
+CustomersQuery.new.queryable == Customer.where(:last_purchase.gt => 7.days.ago)
+
+BigCustomersQuery.new.queryable ==
+Customer.where(:last_purchase.gt => 7.days.ago, :total_expense.gt => 9999999)
+```
+
+### Chainable
+
+While scopes are great because of their terseness, they can be limiting because
+the block executes in the context of the internal query, so methods, constants,
+and variables of the Queryable are not accessible.
+
+For those cases, you can use a normal method, and then `chain` it. Chainable
+will take care of setting the return value of the method as the internal query,
+and return `self` at the end to make the method chainable.
+
+```ruby
+class CustomersQuery
+  include Queryable
+  include Queryable::Chainable
+
+  chain :active, :recent
+
+  def active
+    where(status: 'active')
+  end
+
+  def recent
+    queryable.desc(:logged_in_at)
+  end
+
+  chain def search(field_values)
+    field_values.inject(queryable) { |query, (field, value)|
+      query.where(field => /#{value}/i)
+    }
+  end
+
+  def search_in_active(field_values)
+    search(field_values).active
+  end
+end
+
+
+CustomerQuery.new(shop.customers).miller_fans.search_in_current(last_name: 'M')
+```
+
+### Notes
+To avoid repetition, it's a good idea to create a `BaseQuery` object
+to contain both the modules inclusion, and common scopes you may reuse.
+
+```ruby
+require 'queryable/chainable'
+require 'queryable/default_scope'
+require 'queryable/default_query'
+
+def BaseQuery
+  include Queryable
+  include Queryable::Chainable
+  include Queryable::DefaultScope
+  include Queryable::DefaultQuery
+
+  # If you want to be concise:
+  include Queryable::DefaultQuery, Queryable::DefaultScope, Queryable::Chainable, Queryable
+
+  queryable false
+
+  scope :recent, ->{ where(:created_at.gt => 1.week.ago) }
+end
+
+def CustomersQuery < BaseQuery
+...
+end
+```
+
+## Testing
+
+You can check the [specs](https://github.com/ElMassimo/queryable/tree/master/spec) of the project
+to check how to test query objects without even having to require the ORM/ODM, or
+you can test by requiring your ORM/ODM and executing queries as usual.
+
+## RDocs
+
+You can view the **Queryable** documentation in RDoc format here:
+
+http://rubydoc.info/github/ElMassimo/queryable/master/frames
+
+
+License
+--------
+
+    Copyright (c) 2014 Máximo Mussini
+
+    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/lib/request_locals.rb

@@ -0,0 +1,87 @@
+require 'singleton'
+require 'thread_safe'
+require 'active_support/core_ext/module/delegation'
+
+# Public: Provides per-request global storage, by offering an interface that is
+# very similar to Rails.cache, or Hash.
+#
+# The store may be shared between threads, as long as the :request_id
+# thread-local variable is set.
+#
+# Intended to work in collaboration with the RequestStoreRails middleware, that
+# will clear the request local variables after each request.
+class RequestLocals
+  include Singleton
+
+  class << self
+
+    # Public: Public methods of RequestLocals, they are delegated to the Singleton instance.
+    delegate :clear!, :clear_all!, :[], :[]=, :fetch, :delete, :exist?, :empty?, to: :instance
+
+    # Public: There is no accounting for taste, RequestLocals[:foo] vs RequestLocals.store[:foo]
+    alias_method :store, :instance
+
+    # Internal: We don't want to expose the Singleton implementation details.
+    private :instance
+  end
+
+  # Internal: Methods of the RequestLocals instance, delegated to the request-local structure.
+  delegate :[], :[]=, :delete, :empty?, to: :store
+
+  def initialize
+    @cache = ThreadSafe::Cache.new
+  end
+
+  # Public: Removes all the request-local variables.
+  #
+  # Returns nothing.
+  def clear!
+    @cache.delete(current_request_id)
+  end
+
+  # Public: Clears all the request-local variable stores.
+  #
+  # Returns nothing.
+  def clear_all!
+    @cache = ThreadSafe::Cache.new
+  end
+
+  # Public: Checks if a value was stored for the given key.
+  #
+  # Returns true if there is a value stored for the key.
+  def exist?(key)
+    store.key?(key)
+  end
+
+  # Public: Implements fetch in a consistent way with Rails.cache, persisting
+  # the value yielded by the block if the key was not found.
+  #
+  # Returns an existing value for the key is found, otherwise it returns the
+  # value yielded by the block.
+  def fetch(key, &block)
+    store.fetch_or_store(key, &block)
+  end
+
+protected
+
+  # Internal: Returns the structure that holds the request-local variables for
+  # the current request.
+  #
+  # Returns a ThreadSafe::Cache.
+  def store
+    @cache.fetch_or_store(current_request_id) { new_store }
+  end
+
+  # Internal: The current request is inferred from the current thread. It's very
+  # important to pass on the :request_id thread local variable when spawning new
+  # threads within a single request.
+  def current_request_id
+    Thread.current[:request_id]
+  end
+
+  # Internal: Returns a new empty structure where the request-local variables
+  # will be stored.
+  def new_store
+    ThreadSafe::Cache.new
+  end
+end

data/lib/request_store_rails/middleware.rb

@@ -0,0 +1,29 @@
+require 'securerandom'
+
+# Public: Middleware that takes care of setting the thread-local variable
+# :request_id, which enables RequestLocals to associate threads and requests.
+module RequestStoreRails
+  class Middleware
+
+    def initialize(app)
+      @app = app
+    end
+
+    # Internal: Assigns the :request_id thread-local variable, and cleans up all
+    # the request-local variables after the request.
+    def call(env)
+      Thread.current[:request_id] = extract_request_id(env)
+      @app.call(env)
+    ensure
+      RequestLocals.clear!
+      Thread.current[:request_id] = nil
+    end
+
+  protected
+
+    # Internal: Extracts the request id from the environment, or generates one.
+    def extract_request_id(env)
+      env['action_dispatch.request_id'] || env['HTTP_X_REQUEST_ID'] || SecureRandom.hex(16)
+    end
+  end
+end

data/lib/request_store_rails/railtie.rb

@@ -0,0 +1,14 @@
+# Internal: Inserts the middleware to manage request_ids and cleaning up after
+# the request is complete.
+module RequestStoreRails
+  class Railtie < ::Rails::Railtie
+
+    initializer 'request_store_rails.insert_middleware' do |app|
+      app.config.middleware.insert_after ActionDispatch::RequestId, RequestStoreRails::Middleware
+
+      ActionDispatch::Reloader.to_cleanup do
+        RequestLocals.clear_all!
+      end
+    end
+  end
+end

data/lib/request_store_rails/version.rb

@@ -0,0 +1,5 @@
+# Public: Version of the gem.
+module RequestStoreRails
+
+  VERSION = '0.0.1'
+end

data/lib/request_store_rails.rb

@@ -0,0 +1,5 @@
+require 'request_store_rails/version'
+
+require 'request_locals'
+require 'request_store_rails/middleware'
+require 'request_store_rails/railtie' if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: request_store_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Máximo Mussini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: RequestLocals gives you per-request global storage in Rails
+email:
+- maximomussini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/request_locals.rb
+- lib/request_store_rails.rb
+- lib/request_store_rails/middleware.rb
+- lib/request_store_rails/railtie.rb
+- lib/request_store_rails/version.rb
+homepage: https://github.com/ElMassimo/request_store_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: Per-request global storage for Rails
+test_files: []