consent 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66e7e1705d61760713253718eabda896ffa49f25ea6e1a9a6c4fc1a188730cfb
-  data.tar.gz: 4dc120c6f1e89a3cb612a62cf9fdbac565e51b9fabe9d04a68c64c3d9a8fd193
+  metadata.gz: 925e2e71db7ce7b4c7104784bbd54cfeb8273b2502f0f73f599e64754d5a010a
+  data.tar.gz: 256326fbd83020d39881b53eadc1b3b7cb9c5169bedee5aac5491661a0e3023b
 SHA512:
-  metadata.gz: 9ca74d2788b689711966b38e11ce4b857009064d1fce59c2b5335adc437c1b20a9298acb61a0e71cf3aac2eef1f13f6b8b06570014938ef757374b6a4f98b9c4
-  data.tar.gz: 9d4e6cf5d18d0671c9aade10a33933cc93b0cb704c623d6705332de55a1a02b3952b01fdee9d357a1c0ba9f37d570910ac1fe54614087cd88c94d3d890b5761d
+  metadata.gz: 84ee14b357d0edd8c7be190cc4f79e67d6a0a7f8e0f869d1bf15b0d1ebe87e6f076939aa9db684c172eec8f489bb83f8794c3ca0946a4edc569c07f04a6a9889
+  data.tar.gz: 490da917b1363a0b5d2f209df9363978764874fbe74d500c548b91a95f16f3ca35fab2a80a1ab7ac4de7364e7892101efc4e4a022d25683d0dc82896c7b39da9

data/consent.gemspec

@@ -20,9 +20,12 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
+  spec.add_development_dependency 'activerecord', '>= 5'
   spec.add_development_dependency 'bundler', '>= 1.17.3'
   spec.add_development_dependency 'cancancan', '~> 1.15.0'
+  spec.add_development_dependency 'pry', '~> 0.14.1'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.65.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.2'
 end

data/lib/consent.rb

@@ -5,7 +5,6 @@ require 'consent/subject'
 require 'consent/view'
 require 'consent/action'
 require 'consent/dsl'
-require 'consent/permission'
 require 'consent/ability' if defined?(CanCan)
 require 'consent/railtie' if defined?(Rails)
 
@@ -13,6 +12,8 @@ require 'consent/railtie' if defined?(Rails)
 # concise DSL for authorization so that all abilities do not have
 # to be in your `Ability` class.
 module Consent
+  ViewNotFound = Class.new(StandardError)
+
   # Default views available to every permission
   #
   # i.e.:
@@ -35,7 +36,7 @@ module Consent
   #
   # @return [Array<Consent::Subject>]
   def self.find_subjects(subject_key)
-    @subjects.find_all do |subject|
+    subjects.find_all do |subject|
       subject.key.eql?(subject_key)
     end
   end
@@ -44,21 +45,20 @@ module Consent
   #
   # @return [Consent::Action,nil]
   def self.find_action(subject_key, action_key)
-    Consent.find_subjects(subject_key)
-           .map(&:actions).flatten
-           .find do |action|
-             action.key.eql?(action_key)
-           end
+    find_subjects(subject_key)
+      .flat_map(&:actions)
+      .find do |action|
+        action.key.eql?(action_key)
+      end
   end
 
   # Finds a view within a subject context
   #
   # @return [Consent::View,nil]
-  def self.find_view(subject_key, view_key)
-    views = Consent.find_subjects(subject_key)
-                   .map(&:views)
-                   .reduce({}, &:merge)
-    views[view_key]
+  def self.find_view(subject_key, action_key, view_key)
+    find_action(subject_key, action_key)&.yield_self do |action|
+      action.views[view_key] || raise(Consent::ViewNotFound)
+    end
   end
 
   # Loads all permission (ruby) files from the given directory
@@ -87,11 +87,4 @@ module Consent
       DSL.build(subject, defaults, &block)
     end
   end
-
-  # Maps a permissions hash to a Consent::Permissions
-  #
-  # @return [Consent::Permissions]
-  def self.permissions(permissions)
-    Permissions.new(permissions)
-  end
 end

data/lib/consent/ability.rb

@@ -10,17 +10,26 @@ module Consent
       apply_defaults! if apply_defaults
     end
 
-    def consent(permission: nil, subject: nil, action: nil, view: nil)
-      permission ||= Permission.new(subject, action, view)
-      return unless permission.valid?
+    def consent!(subject: nil, action: nil, view: nil)
+      view = case view
+             when Consent::View
+               view
+             when Symbol
+               Consent.find_view(subject, action, view)
+             end
 
       can(
-        permission.action_key, permission.subject_key,
-        permission.conditions(*@context),
-        &permission.object_conditions(*@context)
+        action, subject,
+        view&.conditions(*@context), &view&.object_conditions(*@context)
       )
     end
 
+    def consent(**kwargs)
+      consent!(**kwargs)
+    rescue Consent::ViewNotFound
+      nil
+    end
+
     private
 
     def apply_defaults!

data/lib/consent/action.rb

@@ -2,20 +2,23 @@
 
 module Consent
   class Action # :nodoc:
-    attr_reader :key, :label, :options
+    attr_reader :subject, :key, :label, :options
 
-    def initialize(key, label, options = {})
+    def initialize(subject, key, label, options = {})
+      @subject = subject
       @key = key
       @label = label
       @options = options
     end
 
-    def view_keys
-      @options.fetch(:views, [])
+    def views
+      @views ||= @subject.views.slice(*@options.fetch(:views, []))
     end
 
     def default_view
-      @options[:default_view]
+      return unless @options.key?(:default_view)
+
+      @default_view ||= @subject.views[@options[:default_view]]
     end
   end
 end

data/lib/consent/dsl.rb

@@ -27,7 +27,8 @@ module Consent
     end
 
     def action(key, label, options = {})
-      @subject.actions << Action.new(key, label, @defaults.merge(options))
+      @subject.actions << Action.new(@subject, key, label,
+                                     @defaults.merge(options))
     end
 
     def self.build(subject, defaults = {}, &block)

data/lib/consent/rspec.rb

@@ -2,6 +2,9 @@
 
 require 'consent'
 
+require_relative 'rspec/consent_action'
+require_relative 'rspec/consent_view'
+
 module Consent
   # RSpec helpers for consent. Given permissions are loaded,
   # gives you the ability of defining permission specs like
@@ -20,7 +23,11 @@ module Consent
   #   let(:user) { double(department_id: 15) }
   #
   #   it do
-  #     is_expected.to consent_view(:department, department_id: 15).to(user)
+  #     is_expected.to(
+  #       consent_view(:department)
+  #         .with_conditions(department_id: 15)
+  #         .to(user)
+  #     )
   #   end
   #   it { is_expected.to consent_action(:read) }
   #   it { is_expected.to consent_action(:update).with_views(:department) }
@@ -29,79 +36,12 @@ module Consent
   # Find more examples at:
   # https://github.com/powerhome/consent
   module Rspec
-    extend RSpec::Matchers::DSL
-
-    matcher :consent_action do |action_key|
-      chain :with_views do |*views|
-        @views = views
-      end
-
-      match do |subject_key|
-        action = Consent.find_action(subject_key, action_key)
-        if action && @views
-          values_match?(action.view_keys.sort, @views.sort)
-        else
-          !action.nil?
-        end
-      end
-
-      failure_message do |subject_key|
-        action = Consent.find_action(subject_key, action_key)
-        message = format(
-          'expected %<skey>s (%<sclass>s) to provide action %<action>s',
-          skey: subject_key.to_s, sclass: subject.class, action: action_key
-        )
-
-        if action && @views
-          format(
-            '%<message>s with views %<views>s, but actual views are %<keys>p',
-            message: message, views: @views, keys: action.view_keys
-          )
-        else
-          message
-        end
-      end
+    def consent_view(view_key, conditions = nil)
+      ConsentView.new(view_key, conditions)
     end
 
-    matcher :consent_view do |view_key, conditions|
-      chain :to do |*context|
-        @context = context
-      end
-
-      match do |subject_key|
-        view = Consent.find_view(subject_key, view_key)
-        if conditions
-          view&.conditions(*@context).eql?(conditions)
-        else
-          !view.nil?
-        end
-      end
-
-      failure_message do |subject_key|
-        view = Consent.find_view(subject_key, view_key)
-        message = format(
-          'expected %<skey>s (%<sclass>s) to provide view %<view>s with` \
-          `%<conditions>p, but',
-          skey: subject_key.to_s, sclass: subject.class,
-          view: view_key, conditions: conditions
-        )
-
-        if view && conditions
-          actual_conditions = view.conditions(*@context)
-          format(
-            '%<message>s conditions are %<conditions>p',
-            message: message, conditions: actual_conditions
-          )
-        else
-          actual_views = Consent.find_subjects(subject_key)
-                                .map(&:views)
-                                .map(&:keys).flatten
-          format(
-            '%<message>s available views are %<views>p',
-            message: message, views: actual_views
-          )
-        end
-      end
+    def consent_action(action_key)
+      ConsentAction.new(action_key)
     end
   end
 end

data/lib/consent/rspec/consent_action.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'consent'
+RSpec::Support.require_rspec_support 'fuzzy_matcher'
+
+module Consent
+  module Rspec
+    # @private
+    class ConsentAction
+      def initialize(action_key)
+        @action_key = action_key
+      end
+
+      def with_views(*views)
+        @views = views
+        self
+      end
+
+      def description
+        message = "consents action #{@action_key}"
+        "#{message} with views #{@views}" if @views
+      end
+
+      def matches?(subject_key)
+        @subject_key = subject_key
+        @action = Consent.find_action(@subject_key, @action_key)
+        if @action && @views
+          RSpec::Support::FuzzyMatcher.values_match?(
+            @action.views.keys.sort,
+            @views.sort
+          )
+        else
+          !@action.nil?
+        end
+      end
+
+      def failure_message
+        failure_message_base 'to'
+      end
+
+      def failure_message_when_negated
+        failure_message_base 'to not'
+      end
+
+      private
+
+      def failure_message_base(failure) # rubocop:disable Metrics/MethodLength
+        message = format(
+          'expected %<skey>s (%<sclass>s) %<failure> provide action %<action>s',
+          skey: @subject_key.to_s, sclass: @subject_key.class,
+          action: @action_key, failure: failure
+        )
+
+        if @action && @views
+          format(
+            '%<message>s with views %<views>s, but actual views are %<keys>p',
+            message: message, views: @views, keys: @action.views.keys
+          )
+        else
+          message
+        end
+      end
+    end
+  end
+end

data/lib/consent/rspec/consent_view.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Consent
+  module Rspec
+    # @private
+    class ConsentView
+      def initialize(view_key, conditions)
+        @conditions = comparable_conditions(conditions) if conditions
+        @view_key = view_key
+      end
+
+      def to(*context)
+        @context = context
+        self
+      end
+
+      def description
+        message = "consents view #{@view_key}"
+        "#{message} with conditions #{@conditions}" if @conditions
+      end
+
+      def with_conditions(conditions)
+        @conditions = comparable_conditions(conditions)
+        self
+      end
+
+      def matches?(subject_key)
+        @subject_key = subject_key
+        @target = Consent.find_subjects(subject_key)
+                         .map do |subject|
+                           subject.views[@view_key]&.conditions(*@context)
+                         end
+                         .compact
+                         .map(&method(:comparable_conditions))
+        @target.include?(@conditions)
+      end
+
+      def failure_message
+        failure_message_base 'to'
+      end
+
+      def failure_message_when_negated
+        failure_message_base 'to not'
+      end
+
+      private
+
+      def comparable_conditions(conditions)
+        return conditions.to_sql if conditions.respond_to?(:to_sql)
+
+        conditions
+      end
+
+      def failure_message_base(failure) # rubocop:disable Metrics/MethodLength
+        message = format(
+          'expected %<skey>s (%<sclass>s) %<fail>s provide view %<view>s with`\
+          `%<conditions>p, but',
+          skey: @subject_key.to_s, sclass: @subject_key.class,
+          view: @view_key, conditions: @conditions, fail: failure
+        )
+
+        if @target.any?
+          format(
+            '%<message>s conditions are %<conditions>p',
+            message: message, conditions: @target
+          )
+        else
+          actual_views = Consent.find_subjects(subject_key)
+                                .map(&:views)
+                                .map(&:keys).flatten
+          format(
+            '%<message>s available views are %<views>p',
+            message: message, views: actual_views
+          )
+        end
+      end
+    end
+  end
+end

data/lib/consent/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consent
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: consent
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Carlos Palhares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.65.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 description: Consent
 email:
 - chjunior@gmail.com
@@ -105,10 +147,11 @@ files:
 - lib/consent/ability.rb
 - lib/consent/action.rb
 - lib/consent/dsl.rb
-- lib/consent/permission.rb
 - lib/consent/railtie.rb
 - lib/consent/reloader.rb
 - lib/consent/rspec.rb
+- lib/consent/rspec/consent_action.rb
+- lib/consent/rspec/consent_view.rb
 - lib/consent/subject.rb
 - lib/consent/version.rb
 - lib/consent/view.rb

data/lib/consent/permission.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Consent
-  class Permission # :nodoc:
-    attr_reader :subject_key, :action_key, :view_key, :view
-
-    def initialize(subject_key, action_key, view_key = nil)
-      @subject_key = subject_key
-      @action_key = action_key
-      @view_key = view_key
-      @view = Consent.find_view(subject_key, view_key) if view_key
-    end
-
-    def action
-      @action ||= Consent.find_action(subject_key, action_key)
-    end
-
-    def valid?
-      action && (@view_key.nil? == @view.nil?)
-    end
-
-    def conditions(*args)
-      @view.nil? ? nil : @view.conditions(*args)
-    end
-
-    def object_conditions(*args)
-      @view.nil? ? nil : @view.object_conditions(*args)
-    end
-  end
-end