autoscope 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 587a92815a96628be40ceaff108a08c6effbd9b2
+  data.tar.gz: e165de7ddf47f773a1bc1a9c51ea5f13f21f827e
+SHA512:
+  metadata.gz: c4157ad99f92cf44f77fa8bba8d31abe676882cb3e2df8f95d00737defaca270b723eecbc7379b21ff038e06c6f94d3c00b2add96b02d9e94251ef0b182eb2a1
+  data.tar.gz: 424de896368aa88cf8e4a5052dff86d97e3d69b4aa9834aa99feaee36c1cd94c639d9a1ac89fabc3cd84975c96a424dd4a4660d1f327255eee6e6a3cbe2457a7

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format nested
+

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autoscope.gemspec
+gemspec
+
+# for our dummy app and specs
+gem 'guard-bundler'
+gem 'guard-rspec'
+gem 'mocha', require: false
+gem 'rails', "~> 4.0"
+gem 'rspec-rails'
+gem 'sqlite3'

data/Guardfile

@@ -0,0 +1,30 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+
+
+guard :bundler do
+  watch('Gemfile')
+  # Uncomment next line if your Gemfile contains the `gemspec' command.
+  watch(/^.+\.gemspec/)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dan Langevin
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Autoscope
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'autoscope'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install autoscope
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+require "bundler/gem_tasks"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec

data/autoscope.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autoscope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autoscope"
+  spec.version       = Autoscope::VERSION
+  spec.authors       = ["Dan Langevin"]
+  spec.email         = ["dan.langevin@lifebooker.com"]
+  spec.description   = %q{Automatically apply scopes to a model}
+  spec.summary       = %q{Automatically apply scopes to a model}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'will_paginate'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rake"
+end

data/lib/autoscope.rb

@@ -0,0 +1,10 @@
+require "active_record"
+require "will_paginate"
+require "autoscope/active_record_methods"
+require "autoscope/version"
+
+module Autoscope
+  # Your code goes here...
+end
+
+::ActiveRecord::Base.send(:include, Autoscope::ActiveRecordMethods)

data/lib/autoscope/active_record_methods.rb

@@ -0,0 +1,236 @@
+module Autoscope
+  module ActiveRecordMethods
+
+    extend ActiveSupport::Concern
+
+    included do |klass|
+
+      klass.class_attribute :scope_definition
+      klass.scope_definition = {}
+
+      # add scope protection behavior
+      class << klass
+        alias_method_chain :scope, :resource_definition_addition
+      end
+
+    end
+
+    module ClassMethods
+
+      # adds any available scopes to the scope
+      # passed in
+      #
+      # @example
+      #   class MyController < ActionController::Base
+      #     # GET /my_resources.json
+      #     def index
+      #       @my_resources = MyResource.add_scopes(params)
+      #     end
+      #   end
+      #
+      # @param params [Hash]
+      # @param scope [ActiveRecord::Relation]
+      # @return [ActiveRecord::Relation]
+
+      def add_scopes(params, scope = self.all)
+        params = params.with_indifferent_access
+
+        # add any type parameters
+        scope = self.add_type_filter(params, scope)
+        # add our static scopes
+        scope = self.add_static_scopes(params, scope)
+        scope = self.add_dynamic_scopes(params, scope)
+        scope = self.add_pagination(params, scope)
+        scope
+      end
+
+      protected
+
+      # adds scopes that don't take any parameters to the scope
+      # passed in
+      #
+      # @example
+      #   class MyController < ActionController::Base
+      #     # GET /my_resources.json
+      #     def index
+      #       @my_resources = MyResource.add_static_scopes(params)
+      #     end
+      #   end
+      #
+      # @param params [Hash]
+      # @param scope [ActiveRecord::Relation]
+      # @return [ActiveRecord::Relation]
+      def add_static_scopes(params, scope = self.all)
+        scope.klass.static_scopes.each do |scope_name|
+          if params[scope_name].present?
+            scope = scope.send(scope_name)
+          end
+        end
+        # special case for ids
+        if params[:ids].present?
+          scope = scope.where(id: params[:ids])
+        end
+        scope
+      end
+
+      def add_type_filter(params, scope)
+        return scope unless params[:type].present?
+
+        # get the class - rescuing an invalid class name
+        begin
+          klass = params[:type].constantize
+
+          # if we have been given a class that is not a subclass
+          # we should return the original scope
+
+          unless self.descendants.include?(klass)
+            logger.error("#{klass} is not a descendant of #{self}")
+            return scope
+          end
+
+          # merge in our old scope and return
+          klass.all.merge(scope)
+        rescue NameError => e
+          logger.error(e.message)
+          logger.error(e.backtrace.pretty_inspect)
+          return scope
+        end
+      end
+
+      # adds scopes that take parameters to the scope
+      # passed in
+      #
+      # @param params [Hash]
+      # @param scope [ActiveRecord::Relation]
+      # @return [ActiveRecord::Relation]
+      #
+      # @example
+      #   class MyController < ActionController::Base
+      #     # GET /my_resources.json
+      #     def index
+      #       @my_resources = MyResource.add_static_scopes(params)
+      #     end
+      #   end
+      def add_dynamic_scopes(params, scope = self.all)
+        scope.klass.dynamic_scopes.each_pair do |scope_name, arg_def|
+
+          # skip scopes that are not defined
+          next if params[scope_name].blank?
+
+          # now apply the arguments
+          args_to_pass = []
+
+          # arg def tells us which args are required
+          arg_def.each_pair do |arg_name, arg_type|
+            case arg_type.to_sym
+            # this argument is required
+            when :req
+              args_to_pass << params[scope_name][arg_name]
+            when :opt
+              unless params[scope_name][arg_name].nil?
+                args_to_pass << params[scope_name][arg_name]
+              end
+            when :rest
+              args_to_pass.concat(params[scope_name][arg_name] || [])
+            end
+          end
+
+          # actually apply the scope
+          scope = scope.send(scope_name, *args_to_pass)
+        end
+
+        # return the final scope
+        scope
+      end
+
+      #
+      # Add pagination if it is supplied in the params
+      #
+      # @param  params [Hash]
+      # @param  scope = self.all [ActiveRecord::Relation]
+      #
+      # @return [ActiveRecord::Relation]
+      def add_pagination(params, scope = self.all)
+        if params[:page] || params[:per_page]
+          scope = scope.paginate(
+            page: params[:page] || 1,
+            per_page: params[:per_page] || 20
+          )
+        end
+        return scope
+      end
+
+      #
+      # Helper to extract scope options into something usable in a
+      # resource definition
+      #
+      # @param  proc [Proc] Scope proc
+      #
+      # @return [Hash<Symbol,Symbol>]
+      def get_scope_parameters(proc)
+        params = {}
+        proc.parameters.each do |type, param|
+          params[param] = type
+        end
+        params
+      end
+
+      #
+      # Set up a regular scope, but mark it as protected
+      # (not visible via the api)
+      #
+      # @param [Array<Mixed>] Args to create a scope
+      #
+      # @return [Class] self
+      def protected_scope(*args)
+        self.scope_without_resource_definition_addition(*args)
+      end
+
+      #
+      # set up a regular scope, making it visibule to the API
+      #
+      def scope_with_resource_definition_addition(name, scope_options = {}, &block)
+        # if it's a proc, we figure out its parameters
+        params = if scope_options.is_a?(Proc)
+          self.get_scope_parameters(scope_options)
+        # otherwise we just use a blank hash
+        else
+          {}
+        end
+
+        # update scope definition
+        self.scope_definition.merge!(
+          name.to_sym => params
+        )
+
+        # call the original scope definition method
+        self.scope_without_resource_definition_addition(
+          name,
+          scope_options,
+          &block
+        )
+      end
+
+      #
+      # list of all scopes that take an argument
+      #
+      # @return [Hash<Symbol, Hash>]
+      def dynamic_scopes
+        scopes = self.scope_definition.select { |k, v| v.present? }
+      end
+
+      #
+      # list of all scopes that don't take any arguments
+      #
+      # @return [Array<Hash>]
+      def static_scopes
+        scopes = self.scope_definition
+          .select { |k, v| v.blank? }
+          .keys
+        scopes | [:first, :last, :all]
+      end
+
+    end
+
+  end
+end

data/lib/autoscope/version.rb

@@ -0,0 +1,3 @@
+module Autoscope
+  VERSION = "0.0.1"
+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
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- 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.