scopie_rails 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5010bb357210ad76c8bddbfba9786d2f4806a89
-  data.tar.gz: d14954d7b994d237c71279fe37f4538d04d4d3f9
+  metadata.gz: c74975fde612d205c6c5e0f74b0c4939d6ba0ac6
+  data.tar.gz: 445d27e9da50cc477811e561fa208ddc991a510b
 SHA512:
-  metadata.gz: 2c42060708b27571d46d63d80222f7e902aac086100431c9537de68f3347c768b31ed89e0dd110e31a1e4774b5dcb55e587fb543704c573c59fb0f7c3d8f56b1
-  data.tar.gz: ce2891386b44af6db7efbeeb7989c0afcd67f325259eb7417de553da9082bd823605f5dead6b2c101e48c8a6c907932857ad2c01fe348ff81c4bed9fef21784d
+  metadata.gz: 2ac70de4033ed79c3da88cd517264c7e3831e4732cbbe6561370172f66a967954236819cdfe59d9d8fb7a3f109f46ae54c97b2df669e9fb7da1aad7b0d94d50b
+  data.tar.gz: fbeb34488d40978aa21100de898ef086aaa7cad144bbdaa27be2fed41c0eddbdad4d34a181fe5f7e8dedabeff6ad579447b36dbcdf6ecfbf1b17580b826de940

data/README.md

@@ -13,8 +13,8 @@ ScopieRails allows you to map incoming controller parameters to named scopes in
 Motivation:
 
 * Dedicated class for scopes mapping, so that the logic is isolated and your controller is skinny.
-* Ability to override default mapping behavior by definition of a method with the same name as scope in the scopie class.
-* Ability to DRY your custom scopes mapping logic using private methods defined in scopie class and use the same scopie class in multiple controllers.
+* Ability to override default mapping behavior by definition of a method having the same name as a scope in the scopie class.
+* Ability to use the object oriented approach to DRY your custom scopes mapping logic and reuse the scopie class.
 
 Imagine the following model called graduations:
 
@@ -121,6 +121,10 @@ Add `scopie_rails` to your Gemfile or install it from Rubygems.
 gem 'scopie_rails'
 ```
 
+## Mutation testing
+
+    mutant --include lib --require scopie_rails --use rspec ScopieRails*
+
 ## Options
 
 Scopie supports several options:
@@ -137,17 +141,19 @@ Scopie supports several options:
 
 * `:allow_blank` - Blank values are not sent to scopes by default. Set to true to overwrite.
 
+* `:ignore_blank` - Set to true to not apply the scope if blank value is given.
+
 * `:default` - Default value for the scope. Whenever supplied the scope is always called.
 
 ## Rails
 
 ScopieRails provides Rails integration for [Scopie][s].
 
-Among other things it adds a 'controller' method to scopies.
+Among other things it adds a `controller` method to scopies.
 
 ## Thanks
 
-Scopie was inspired by [has_scope](http://github.com/plataformatec/has_scope) and [pundit](http://github.com/elabs/pubdit).
+Scopie was inspired by [has_scope](http://github.com/plataformatec/has_scope) and [pundit](http://github.com/elabs/pundit).
 
 Thanks to both.
 

data/lib/generators/rspec/scopie_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class ScopieGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_scopie_spec
+        template 'scopie_spec.rb', File.join('spec/scopies', class_path, "#{file_name}_scopie_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/scopie_spec.rb

@@ -0,0 +1,4 @@
+require '<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>'
+
+RSpec.describe <%= class_name %>Scopie do
+end

data/lib/generators/scopie_rails/scopie/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a scopie for a controller with the given name.
+
+Example:
+    rails generate scopie_rails:scopie items
+
+    This will create:
+app/scopies/items_scopie.rb

data/lib/generators/scopie_rails/scopie/scopie_generator.rb

@@ -0,0 +1,13 @@
+module ScopieRails
+  module Generators
+    class ScopieGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def create_scopie
+        template 'scopie.rb', File.join('app/scopies', class_path, "#{file_name}_scopie.rb")
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/scopie_rails/scopie/templates/scopie.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Scopie < ScopieRails::Base
+end
+<% end -%>

data/lib/scopie_rails.rb

@@ -7,8 +7,9 @@ require 'active_support/core_ext/string/inflections'
 
 module ScopieRails
 
-  SCOPIE_SUFFIX = '_scopie'
+  SCOPIE_SUFFIX = '_scopie'.freeze
 
+  require 'scopie_rails/version'
   require 'scopie_rails/engine' if defined?(Rails)
   require 'scopie_rails/base'
   require 'scopie_rails/controller'

data/lib/scopie_rails/controller.rb

@@ -10,21 +10,35 @@ module ScopieRails::Controller
     @default_scopie ||= find_scopie_class.new(self)
   end
 
+  # Receives an object where scopes will be applied to.
+  #
+  #   class GraduationsScopie < Scopie::Base
+  #     has_scope :featured, type: :boolean
+  #     has_scope :by_degree, :by_period
+  #   end
+  #
+  #   class GraduationsController < ApplicationController
+  #     include ScopieRails::Controller
+  #
+  #     def index
+  #       @graduations = apply_scopes(Graduation).all
+  #     end
+  #   end
+  #
   def apply_scopes(target, scopie: default_scopie, hash: params)
     Scopie.apply_scopes(target, hash, method: hash[:action], scopie: scopie)
   end
 
+  # Returns the scopes used in this action.
   def current_scopes(scopie: default_scopie, hash: params)
     Scopie.current_scopes(hash, method: hash[:action], scopie: scopie)
   end
 
   def find_scopie_class
-    return self.class.scopie_class if self.class.scopie_class
+    return scopie_class if scopie_class
 
     scopie_name = params[:controller] + ScopieRails::SCOPIE_SUFFIX
 
-    self.class.scopie_class = scopie_name.camelize.constantize
-
-    self.class.scopie_class
+    self.scopie_class = scopie_name.camelize.constantize
   end
 end

data/lib/scopie_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScopieRails
-  VERSION = '1.0.1'
+  VERSION = '1.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scopie_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Yury Kotov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2016-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scopie
@@ -73,6 +73,11 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
+- lib/generators/rspec/scopie_generator.rb
+- lib/generators/rspec/templates/scopie_spec.rb
+- lib/generators/scopie_rails/scopie/USAGE
+- lib/generators/scopie_rails/scopie/scopie_generator.rb
+- lib/generators/scopie_rails/scopie/templates/scopie.rb
 - lib/scopie_rails.rb
 - lib/scopie_rails/base.rb
 - lib/scopie_rails/controller.rb