action_policy 0.2.4 → 0.3.0.beta1

data/lib/action_policy/testing.rb

@@ -24,11 +24,50 @@ module ActionPolicy
         end
       end
 
+      class Scoping # :nodoc:
+        attr_reader :policy, :target, :type, :name, :scope_options
+
+        def initialize(policy, target, type, name, scope_options)
+          @policy = policy
+          @target = target
+          @type = type
+          @name = name
+          @scope_options = scope_options
+        end
+
+        def matches?(policy_class, actual_type, actual_name, actual_scope_options)
+          policy_class == policy.class &&
+            type == actual_type &&
+            name == actual_name &&
+            actual_scope_options === scope_options
+        end
+
+        def inspect
+          "#{policy.class} :#{name} for :#{type} #{scope_options_message}"
+        end
+
+        private
+
+        def scope_options_message
+          if scope_options
+            if defined?(::RSpec::Matchers::Composable) &&
+                scope_options.is_a?(::RSpec::Matchers::Composable)
+              "with scope options #{scope_options.description}"
+            else
+              "with scope options #{scope_options}"
+            end
+          else
+            "without scope options"
+          end
+        end
+      end
+
       class << self
         # Wrap code under inspection into this method
         # to track authorize! calls
         def tracking
           calls.clear
+          scopings.clear
           Thread.current[:__action_policy_tracking] = true
           yield
         ensure
@@ -41,10 +80,20 @@ module ActionPolicy
           calls << Call.new(policy, rule)
         end
 
+        # Called from Authorizer
+        def track_scope(target, policy, type:, name:, scope_options:)
+          return unless tracking?
+          scopings << Scoping.new(policy, target, type, name, scope_options)
+        end
+
         def calls
           Thread.current[:__action_policy_calls] ||= []
         end
 
+        def scopings
+          Thread.current[:__action_policy_scopings] ||= []
+        end
+
         def tracking?
           Thread.current[:__action_policy_tracking] == true
         end
@@ -57,6 +106,11 @@ module ActionPolicy
         AuthorizeTracker.track(*args)
         super
       end
+
+      def scopify(*args)
+        AuthorizeTracker.track_scope(*args)
+        super
+      end
     end
 
     ActionPolicy::Authorizer.singleton_class.prepend(AuthorizerExt)

data/lib/action_policy/utils/pretty_print.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+old_verbose = $VERBOSE
+
+begin
+  require "method_source"
+  # Ignore parse warnings when patch
+  # Ruby version mismatches
+  $VERBOSE = nil
+  require "parser/current"
+  require "unparser"
+rescue LoadError
+  # do nothing
+ensure
+  $VERBOSE = old_verbose
+end
+
+module ActionPolicy
+  unless "".respond_to?(:then)
+    require "action_policy/ext/yield_self_then"
+    using ActionPolicy::Ext::YieldSelfThen
+  end
+
+  # Takes the object and a method name,
+  # and returns the "annotated" source code for the method:
+  # code is split into parts by logical operators and each
+  # part is evaluated separately.
+  #
+  # Example:
+  #
+  #  class MyClass
+  #    def access?
+  #      admin? && access_feed?
+  #    end
+  #  end
+  #
+  #  puts PrettyPrint.format_method(MyClass.new, :access?)
+  #
+  #  #=> MyClass#access?
+  #  #=> ↳ admin? #=> false
+  #  #=> AND
+  #  #=> access_feed? #=> true
+  module PrettyPrint
+    class Visitor
+      attr_reader :lines, :object
+      attr_accessor :indent
+
+      def initialize(object)
+        @object = object
+      end
+
+      def collect(ast)
+        @lines = []
+        @indent = 0
+
+        visit_node(ast)
+
+        lines.join("\n")
+      end
+
+      def visit_node(ast)
+        if respond_to?("visit_#{ast.type}")
+          send("visit_#{ast.type}", ast)
+        else
+          visit_missing ast
+        end
+      end
+
+      def expression_with_result(sexp)
+        expression = Unparser.unparse(sexp)
+        "#{expression} #=> #{eval_exp(expression)}"
+      end
+
+      def eval_exp(exp)
+        object.instance_eval(exp)
+      rescue => e
+        "Failed: #{e.message}"
+      end
+
+      def visit_and(ast)
+        visit_node(ast.children[0])
+        lines << indented("AND")
+        visit_node(ast.children[1])
+      end
+
+      def visit_or(ast)
+        visit_node(ast.children[0])
+        lines << indented("OR")
+        visit_node(ast.children[1])
+      end
+
+      # Parens
+      def visit_begin(ast)
+        lines << indented("(")
+        self.indent += 2
+        visit_node(ast.children[0])
+        self.indent -= 2
+        lines << indented(")")
+      end
+
+      def visit_missing(ast)
+        lines << indented(expression_with_result(ast))
+      end
+
+      def indented(str)
+        "#{indent.zero? ? "↳ " : ""}#{" " * indent}#{str}".tap do
+          # increase indent after the first expression
+          self.indent += 2 if indent.zero?
+        end
+      end
+    end
+
+    class << self
+      if defined?(::Unparser) && defined?(::MethodSource)
+        def available?
+          true
+        end
+
+        def print_method(object, method_name)
+          ast = object.method(method_name).source.then(&Unparser.method(:parse))
+          # outer node is a method definition itself
+          body = ast.children[2]
+
+          Visitor.new(object).collect(body)
+        end
+      else
+        def available?
+          false
+        end
+
+        def print_method(_, _)
+          ""
+        end
+      end
+    end
+  end
+end

data/lib/action_policy/utils/suggest_message.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActionPolicy
+  # Adds `suggest` method which uses did_you_mean
+  # to generate a suggestion message
+  module SuggestMessage
+    if defined?(::DidYouMean::SpellChecker)
+      def suggest(needle, heystack)
+        suggestion = ::DidYouMean::SpellChecker.new(
+          dictionary: heystack
+        ).correct(needle).first
+
+        suggestion ? "\nDid you mean? #{suggestion}" : ""
+      end
+    else
+      def suggest(*)
+        ""
+      end
+    end
+  end
+end

data/lib/action_policy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionPolicy
-  VERSION = "0.2.4"
+  VERSION = "0.3.0.beta1"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: action_policy
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0.beta1
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2019-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.65.0
 - !ruby/object:Gem::Dependency
   name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.36
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.36
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  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'
 description: Authorization framework for Ruby/Rails application
 email:
 - dementiev.vm@gmail.com
@@ -147,10 +175,13 @@ files:
 - docs/assets/styles.css
 - docs/assets/vue.min.css
 - docs/authorization_context.md
+- docs/behaviour.md
 - docs/caching.md
 - docs/controller_action_aliases.md
 - docs/custom_lookup_chain.md
 - docs/custom_policy.md
+- docs/debugging.md
+- docs/decorators.md
 - docs/favicon.ico
 - docs/i18n.md
 - docs/index.html
@@ -163,10 +194,12 @@ files:
 - docs/quick_start.md
 - docs/rails.md
 - docs/reasons.md
+- docs/scoping.md
 - docs/testing.md
 - docs/writing_policies.md
 - gemfiles/jruby.gemfile
 - gemfiles/rails42.gemfile
+- gemfiles/rails6.gemfile
 - gemfiles/railsmaster.gemfile
 - lib/action_policy.rb
 - lib/action_policy/authorizer.rb
@@ -175,14 +208,19 @@ files:
 - lib/action_policy/behaviours/memoized.rb
 - lib/action_policy/behaviours/namespaced.rb
 - lib/action_policy/behaviours/policy_for.rb
+- lib/action_policy/behaviours/scoping.rb
 - lib/action_policy/behaviours/thread_memoized.rb
 - lib/action_policy/cache_middleware.rb
+- lib/action_policy/ext/hash_transform_keys.rb
 - lib/action_policy/ext/module_namespace.rb
 - lib/action_policy/ext/policy_cache_key.rb
+- lib/action_policy/ext/proc_case_eq.rb
 - lib/action_policy/ext/string_constantize.rb
 - lib/action_policy/ext/string_match.rb
 - lib/action_policy/ext/string_underscore.rb
+- lib/action_policy/ext/symbol_classify.rb
 - lib/action_policy/ext/yield_self_then.rb
+- lib/action_policy/i18n.rb
 - lib/action_policy/lookup_chain.rb
 - lib/action_policy/policy/aliases.rb
 - lib/action_policy/policy/authorization.rb
@@ -193,14 +231,24 @@ files:
 - lib/action_policy/policy/execution_result.rb
 - lib/action_policy/policy/pre_check.rb
 - lib/action_policy/policy/reasons.rb
+- lib/action_policy/policy/scoping.rb
+- lib/action_policy/rails/authorizer.rb
 - lib/action_policy/rails/channel.rb
 - lib/action_policy/rails/controller.rb
+- lib/action_policy/rails/ext/active_record.rb
+- lib/action_policy/rails/policy/instrumentation.rb
+- lib/action_policy/rails/scope_matchers/action_controller_params.rb
+- lib/action_policy/rails/scope_matchers/active_record.rb
 - lib/action_policy/railtie.rb
 - lib/action_policy/rspec.rb
 - lib/action_policy/rspec/be_authorized_to.rb
+- lib/action_policy/rspec/dsl.rb
+- lib/action_policy/rspec/have_authorized_scope.rb
 - lib/action_policy/rspec/pundit_syntax.rb
 - lib/action_policy/test_helper.rb
 - lib/action_policy/testing.rb
+- lib/action_policy/utils/pretty_print.rb
+- lib/action_policy/utils/suggest_message.rb
 - lib/action_policy/version.rb
 homepage: https://github.com/palkan/action_policy
 licenses:
@@ -214,15 +262,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Authorization framework for Ruby/Rails application