consul 0.12.4 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f26edaf1d93b7150757a61ab7ff678026e08bd5
-  data.tar.gz: 1c42642576f8d7f5fc41a64ee1a4b07a50fd4596
+  metadata.gz: ca9294f9af0f9456d5951b5bf1d8657060fbda67
+  data.tar.gz: 57ce0c814786137d801dd5fbc9d1595a05d1e076
 SHA512:
-  metadata.gz: 839f3d4d75529467aaef3b5fbab879a410c9fd53a63cb35c76c18757073cec47dd1fe83d18af7fe56a60eee641ec7c424be6aba9b7db14db6dd8d36846fe1cf3
-  data.tar.gz: d6b9d7a73176eaa0f07a2562a601189225a3b6f74ae1f2ce5a00f91b248936f728fa67ea9edc647a8b937a5a1293bfe22558a10bb2ab4cfa6af0b7859468a86d
+  metadata.gz: 69c0404a0afcee733ca00380bdae22620a897083be8c6d1d9ee055fd3d3abeae7f59a6ff834b6d76938f5b776bc27a50e9c784bdf3e5b3f475d2765a8dfdbe8f
+  data.tar.gz: 484ec20a1104eaaded3681807e28694de11f6d5c383f357372f94fefdab2fbc11809b3ecebc3a0381625fff192f34545715b0167b9d953bfea8a863bdf99cf76

data/.gitignore

@@ -3,6 +3,6 @@ pkg
 *.gem
 .idea
 *.db
-app_root/log/*
+*.log
 .bundle
 spec/shared/app_root/db/*.sqlite3

data/.travis.yml

@@ -3,7 +3,6 @@ sudo: false
 rvm:
   - "1.8.7"
   - "2.1.0"
-  - "2.2.6"
   - "2.4.1"
 before_install: gem install bundler # Fix bundler issues on 1.9.3
 before_script: rake travis_ci:prepare

data/README.md

@@ -8,7 +8,7 @@ Consul is an authorization solution for Ruby on Rails where you describe *sets o
 We have used Consul in combination with [assignable_values](https://github.com/makandra/assignable_values) to solve a variety of authorization requirements ranging from boring to bizarre.
 Also see our crash course video: [Solving bizare authorization requirements with Rails](http://bizarre-authorization.talks.makandra.com/).
 
-Consul is tested with Rails 2.3, 3.2, 4.1, 4.2.7, and 5.1.1 on Ruby 1.8.7, 2.1.0, 2.2.6, and 2.4.1 (only if supported, for each Ruby/Rails combination).
+Consul is tested with Rails 2.3, 3.2, 4.2, and 5.1 on Ruby 1.8.7, 2.1, and 2.4 (only if supported, for each Ruby/Rails combination).
 
 
 Describing access to your application
@@ -628,6 +628,25 @@ The `authorize_values_for` macro comes with many useful options and details best
 assignable_values_for :field, :through => lambda { Power.current }
 ```
 
+Memoization
+-----------
+
+All power methods are [memoized](https://www.justinweiss.com/articles/4-simple-memoization-patterns-in-ruby-and-one-gem/) for performance reasons. Multiple calls to the same method will only call your block the first time, and return a cached result afterwards:
+
+```
+power = Power.new
+power.projects! # calls the `power :projects { ... }` block
+power.projects! # returns the cached result from earlier
+power.projects! # returns the cached result from earlier
+```
+
+If you want to discard all cached results, call `#unmemoize_all`:
+
+```
+power.unmemoize_all
+```
+
+
 Dynamic power access
 --------------------
 

data/Rakefile

@@ -52,7 +52,7 @@ def for_each_directory_of(path, &block)
       puts 'Skipping - Rails 3.2.13 does not support Ruby 2.2+'
     elsif directory.include?('rails-4.2') && (RUBY_VERSION < '1.9.3' || RUBY_VERSION >= '2.4.0')
       puts 'Skipping - Rails 4.2 requires Ruby 1.9.3+ .. 2.3.x'
-    elsif directory.include?('rails-5.1.1') && RUBY_VERSION < '2.2.2'
+    elsif directory.include?('rails-5.1') && RUBY_VERSION < '2.2.2'
       puts 'Skipping - Rails 5 requires Ruby 2.2.2+'
     else
       block.call(directory)

data/lib/consul/controller.rb

@@ -46,6 +46,10 @@ module Consul
         elsif Rails.version.to_i < 5
           skip_before_action :unchecked_power, options
         else
+          # Every `power` in a controller will skip the power check filter. After the 1st time, Rails 5+ will raise
+          # an error because there is no `unchecked_power` action to skip any more.
+          # To avoid this, we add the following extra option. Note that it must not be added in Rails 4 to avoid errors.
+          # See http://api.rubyonrails.org/classes/ActiveSupport/Callbacks/ClassMethods.html#method-i-skip_callback
           skip_before_action :unchecked_power, { :raise => false }.merge!(options)
         end
       end

data/lib/consul/power.rb

@@ -63,8 +63,6 @@ module Consul
       self.class.singularize_power_name(name)
     end
 
-
-
     module ClassMethods
       include Consul::Power::DynamicAccess::ClassMethods
 
@@ -109,16 +107,34 @@ module Consul
         query_method = "#{name}?"
         bang_method = "#{name}!"
         define_method(query_method, &query)
+        memoize query_method
         define_method(bang_method) { |*args| send(query_method, *args) or powerless!(name, *args) }
+        # We don't memoize the bang method since memoizer can't memoize a thrown exception
+      end
+
+      def define_ids_method(name)
+        ids_method = power_ids_name(name)
+        define_method(ids_method) { |*args| default_power_ids(name, *args) }
+        # Memoize `ids_method` in addition to the collection method itself, since
+        # #default_include_object? directly accesses `ids_method`.
+        memoize ids_method
+      end
+
+      def define_main_method(name, &block)
+        define_method(name, &block)
+        memoize name
       end
 
       def define_power(name, &block)
         name = name.to_s
         if name.ends_with?('?')
+          # The developer is trying to register an optimized query method
+          # for singular object queries.
           name_without_suffix = name.chop
           define_query_and_bang_methods(name_without_suffix, &block)
         else
-          define_method(name, &block)
+          define_main_method(name, &block)
+          define_ids_method(name)
           define_query_and_bang_methods(name) { |*args| default_include_power?(name, *args) }
           begin
             singular = singularize_power_name(name)
@@ -127,9 +143,6 @@ module Consul
             # We do not define singularized power methods if it would
             # override the collection method
           end
-          ids_method = power_ids_name(name)
-          define_method(ids_method) { |*args| default_power_ids(name, *args) }
-          memoize ids_method
         end
         name
       end

data/lib/consul/version.rb

@@ -1,3 +1,3 @@
 module Consul
-  VERSION = '0.12.4'
+  VERSION = '0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consul
 version: !ruby/object:Gem::Version
-  version: 0.12.4
+  version: 0.13.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: memoizer
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A scope-based authorization solution for Ruby on Rails.