consent 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79adf851fbc13c53c81e784d654c34e6da171a57c78767148b7da5ee9241181b
-  data.tar.gz: a9d032376facd18c89f8d0cfa4b8b2cd60661447649a51717c5a0923576fd531
+  metadata.gz: d3254860bde068adbf1c32b4896bb40f39fb1bc44bfa41c78b776829f749911f
+  data.tar.gz: 9124b3b1e01bdc677666a0934062000a1760e36773ac698abc82e0f37bd24039
 SHA512:
-  metadata.gz: 229130ac93dc5d6f7705d67ac85e147d3f36013eb121cc92e5e6b43c7cd33b220c79c00df50ae873bee92b56be6fa7b73ecf7fa0ddae9375c87db5cf73b58e84
-  data.tar.gz: f68312f4f3bf1f3ce60911793a0149d5681adb99f02b3c44e86639d1a91aff86000debb0476c119fea123a89d76a7f296a48d9a8aaee237838f0522932b9302f
+  metadata.gz: 93db20c8fdbeadf56bb9e49db970410cb2e527c720955eb60d5df2e05764e08942323ea1328a6ef07bb9f27bac4393a9a57e002762c0a30afe066699dd8ce12c
+  data.tar.gz: 0e6ed845b8785fbb570eff561f49de1d2c9b5d1a2a7c06ef9eeb248f4b087f20d5066f4b891aa40b5b7fec23360b45ec17717086ea30cb6713d5e2645bb7afba

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,21 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-11-20 02:06:29 -0300 using RuboCop version 0.65.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/consent/rspec.rb'
+
+# Offense count: 9
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'

data/.travis.yml

@@ -4,6 +4,9 @@ rvm:
 - 2.2.2
 - 2.5.0
 before_install: gem install bundler -v 1.17.3
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
 deploy:
   provider: rubygems
   api_key:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in consent.gemspec

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "consent"
+require 'bundler/setup'
+require 'consent'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "consent"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/consent.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'consent/version'
 
@@ -18,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'activesupport', '>= 4.1.11'
+  spec.add_development_dependency 'bundler', '>= 1.17.3'
   spec.add_development_dependency 'cancancan', '~> 1.15.0'
-  spec.add_development_dependency 'bundler', '~> 1.17.3'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.65.0'
 end

data/lib/consent.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'consent/version'
 require 'consent/subject'
 require 'consent/view'
@@ -8,23 +10,42 @@ require 'consent/permissions'
 require 'consent/ability' if defined?(CanCan)
 require 'consent/railtie' if defined?(Rails)
 
+# Consent makes defining permissions easier by providing a clean,
+# concise DSL for authorization so that all abilities do not have
+# to be in your `Ability` class.
 module Consent
-  FULL_ACCESS = %w(1 true).freeze
+  FULL_ACCESS = %w[1 true].freeze
 
+  # Default views available to every permission
+  #
+  # i.e.:
+  #  Defining a view with no conditions:
+  #  Consent.default_views[:all] = Consent::View.new(:all, "All")
+  #
+  # @return [Hash<Symbol,Consent::View>]
   def self.default_views
     @default_views ||= {}
   end
 
+  # Subjects defined in Consent
+  #
+  # @return [Array<Consent::Subject>]
   def self.subjects
     @subjects ||= []
   end
 
+  # Finds all subjects defined with the given key
+  #
+  # @return [Array<Consent::Subject>]
   def self.find_subjects(subject_key)
     @subjects.find_all do |subject|
       subject.key.eql?(subject_key)
     end
   end
 
+  # Finds an action within a subject context
+  #
+  # @return [Consent::Action,nil]
   def self.find_action(subject_key, action_key)
     Consent.find_subjects(subject_key)
            .map(&:actions).flatten
@@ -33,18 +54,36 @@ module Consent
            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{|subject| subject.views}
+                   .map(&:views)
                    .reduce({}, &:merge)
     views[view_key]
   end
 
-  def self.load_subjects!(paths)
+  # Loads all permission (ruby) files from the given directory
+  # and using the given mechanism (default: :require)
+  #
+  # @param paths [Array<String,#to_s>] paths where the ruby files are located
+  # @param mechanism [:require,:load] mechanism to load the files
+  def self.load_subjects!(paths, mechanism = :require)
     permission_files = paths.map { |dir| File.join(dir, '*.rb') }
-    Dir[*permission_files].each(&Kernel.method(:require))
+    Dir[*permission_files].each(&Kernel.method(mechanism))
   end
 
+  # Defines a subject with the given key, label and options
+  #
+  # i.e:
+  #   Consent.define :users, "User management" do
+  #     view :department, "Same department only" do |user|
+  #       { department_id: user.department_id }
+  #     end
+  #     action :read, "Can view users"
+  #     action :update, "Can edit existing user", views: :department
+  #   end
   def self.define(key, label, options = {}, &block)
     defaults = options.fetch(:defaults, {})
     subjects << Subject.new(key, label).tap do |subject|
@@ -52,6 +91,9 @@ module Consent
     end
   end
 
+  # Maps a permissions hash to a Consent::Permissions
+  #
+  # @return [Consent::Permissions]
   def self.permissions(permissions)
     Permissions.new(permissions)
   end

data/lib/consent/ability.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 module Consent
+  # Defines a CanCan(Can)::Ability class based on a permissions hash
   class Ability
     include CanCan::Ability
 
     def initialize(permissions, *args)
       Consent.permissions(permissions).each do |permission|
         conditions = permission.conditions(*args)
-        object_conditions = permission.object_conditions(*args)
-        can permission.action_key, permission.subject_key, conditions, &object_conditions
+        ocond = permission.object_conditions(*args)
+        can permission.action_key, permission.subject_key, conditions, &ocond
       end
     end
   end

data/lib/consent/action.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Consent
-  class Action
+  class Action # :nodoc:
     attr_reader :key, :label, :options
 
     def initialize(key, label, options = {})

data/lib/consent/dsl.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Consent
-  class DSL
+  class DSL # :nodoc:
     attr_reader :subject
 
     def initialize(subject, defaults)
@@ -11,13 +13,13 @@ module Consent
       DSL.build(@subject, @defaults.merge(new_defaults), &block)
     end
 
-    # rubocop:disable Link/UnusedBlockArgument, Link/Eval
+    # rubocop:disable Lint/UnusedBlockArgument, Security/Eval
     def eval_view(key, label, collection_conditions)
       view key, label do |user|
         eval(collection_conditions)
       end
     end
-    # rubocop:enable Link/UnusedBlockArgument, Link/Eval
+    # rubocop:enable Lint/UnusedBlockArgument, Security/Eval
 
     def view(key, label, instance = nil, collection = nil, &block)
       collection ||= block

data/lib/consent/permission.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Consent
-  class Permission
+  class Permission # :nodoc:
     def initialize(subject, action, view = nil)
       @subject = subject
       @action = action
@@ -14,6 +16,9 @@ module Consent
       @action.key
     end
 
+    # Disables Sytle/SafeNavigation to keep this code
+    # compatible with ruby < 2.3
+    # rubocop:disable Style/SafeNavigation
     def view_key
       @view && @view.key
     end
@@ -25,5 +30,6 @@ module Consent
     def object_conditions(*args)
       @view && @view.object_conditions(*args)
     end
+    # rubocop:enable Style/SafeNavigation
   end
 end

data/lib/consent/permissions.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Consent
-  class Permissions
+  class Permissions # :nodoc:
     include Enumerable
 
     def initialize(permissions)
@@ -25,12 +27,14 @@ module Consent
 
     def full(subject, action, view_key)
       return unless Consent::FULL_ACCESS.include?(view_key.to_s.strip)
+
       Permission.new(subject, action)
     end
 
     def partial(subject, action, view_key)
       view = subject.view_for(action, view_key.to_s.to_sym)
       return if view.nil?
+
       Permission.new(subject, action, view)
     end
   end

data/lib/consent/railtie.rb

@@ -1,19 +1,26 @@
+# frozen_string_literal: true
+
+require 'consent/reloader'
+
 module Consent
   # Plugs consent permission load to the Rails class loading cycle
   class Railtie < Rails::Railtie
-    config.before_configuration do
-      default_path = Rails.root.join('app', 'permissions')
-      config.consent = Struct.new(:paths).new([default_path])
+    config.before_configuration do |app|
+      default_path = app.root.join('app', 'permissions')
+      config.consent = Consent::Reloader.new(
+        default_path,
+        ActiveSupport::Dependencies.mechanism
+      )
     end
 
-    config.to_prepare do
-      Consent.subjects.clear
-      Consent.load_subjects! Rails.application.config.consent.paths
+    config.after_initialize do |app|
+      app.config.consent.execute
     end
 
-    config.after_initialize do
-      permissions_paths = config.consent.paths.map(&:to_s)
-      ActiveSupport::Dependencies.autoload_paths -= permissions_paths
+    initializer 'initialize consent permissions reloading' do |app|
+      app.reloaders << config.consent
+      ActiveSupport::Dependencies.autoload_paths -= config.consent.paths
+      config.to_prepare { app.config.consent.execute_if_updated }
     end
   end
 end

data/lib/consent/reloader.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Consent
+  # Rails file reloader to detect permission changes and apply them to consent
+  class Reloader
+    attr_reader :paths
+    delegate :updated?, :execute, :execute_if_updated, to: :updater
+
+    def initialize(default_path, mechanism)
+      @paths = [default_path]
+      @mechanism = mechanism
+    end
+
+    private
+
+    def reload!
+      Consent.subjects.clear
+      Consent.load_subjects! paths, @mechanism
+    end
+
+    def updater
+      @updater ||= ActiveSupport::FileUpdateChecker.new([], globs) { reload! }
+    end
+
+    def globs
+      pairs = paths.map { |path| [path.to_s, %w[rb]] }
+      Hash[pairs]
+    end
+  end
+end

data/lib/consent/rspec.rb

@@ -1,6 +1,33 @@
+# frozen_string_literal: true
+
 require 'consent'
 
 module Consent
+  # RSpec helpers for consent. Given permissions are loaded,
+  # gives you the ability of defining permission specs like
+  #
+  # Given "users" permissions
+  # Consent.define :users, "User management" do
+  #   view :department, "Same department only" do |user|
+  #     { department_id: user.department_id }
+  #   end
+  #   action :read, "Can view users"
+  #   action :update, "Can edit existing user", views: :department
+  # end
+  #
+  # RSpec.describe "User permissions" do
+  #   include Consent::Rspec
+  #   let(:user) { double(department_id: 15) }
+  #
+  #   it do
+  #     is_expected.to consent_view(:department, department_id: 15).to(user)
+  #   end
+  #   it { is_expected.to consent_action(:read) }
+  #   it { is_expected.to consent_action(:update).with_views(:department) }
+  # end
+  #
+  # Find more examples at:
+  # https://github.com/powerhome/consent
   module Rspec
     extend RSpec::Matchers::DSL
 
@@ -11,17 +38,25 @@ module Consent
 
       match do |subject_key|
         action = Consent.find_action(subject_key, action_key)
-        action && @views ? action.view_keys.sort.eql?(@views.sort) : !action.nil?
+        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 = "expected %s (%s) to provide action %s" % [
-          subject_key.to_s, subject.class, 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
-          '%s with views %s, but actual views are %p' % [message, @views, action.view_keys]
+          format(
+            '%<message>s with views %<views>s, but actual views are %<keys>p',
+            message: message, views: @views, keys: action.view_keys
+          )
         else
           message
         end
@@ -35,21 +70,36 @@ module Consent
 
       match do |subject_key|
         view = Consent.find_view(subject_key, view_key)
-        conditions ? view.try(:conditions, *@context).eql?(conditions) : !view.nil?
+        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 = "expected %s (%s) to provide view %s with %p, but" % [
-          subject_key.to_s, subject.class, view_key, conditions
-        ]
+        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)
-          '%s conditions are %p' % [message, actual_conditions]
+          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
-          '%s available views are %p' % [message, actual_views]
+          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

data/lib/consent/subject.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Consent
-  class Subject
+  class Subject # :nodoc:
     attr_reader :key, :label, :actions, :views
 
     def initialize(key, label)

data/lib/consent/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Consent
-  VERSION = '0.4.3'.freeze
+  VERSION = '0.5.0'
 end

data/lib/consent/view.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Consent
-  class View
+  class View # :nodoc:
     attr_reader :key, :label
 
     def initialize(key, label, instance = nil, collection = nil)
@@ -11,11 +13,13 @@ module Consent
 
     def conditions(*args)
       return @collection unless @collection.respond_to?(:call)
+
       @collection.call(*args)
     end
 
     def object_conditions(*args)
       return @instance unless @instance.respond_to?(:curry)
+
       @instance.curry[*args]
     end
   end

data/lib/generators/consent/permissions_generator.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
 module Consent
-  class PermissionsGenerator < Rails::Generators::NamedBase
-    source_root File.expand_path('../templates', __FILE__)
+  class PermissionsGenerator < Rails::Generators::NamedBase # :nodoc:
+    source_root File.expand_path('templates', __dir__)
     argument :description, type: :string, required: false
 
     def create_permissions
-      template "permissions.rb.erb", "app/permissions/#{file_path}.rb", assigns: {
-        description: description
-      }
+      template(
+        'permissions.rb.erb',
+        "app/permissions/#{file_path}.rb",
+        assigns: { description: description }
+      )
 
-      template "permissions_spec.rb.erb", "spec/permissions/#{file_path}_spec.rb"
+      template(
+        'permissions_spec.rb.erb',
+        "spec/permissions/#{file_path}_spec.rb"
+      )
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: consent
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Carlos Palhares
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-02 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.1.11
 - !ruby/object:Gem::Dependency
-  name: cancancan
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.17.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.17.3
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.3
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
 description: Consent
 email:
 - chjunior@gmail.com
@@ -89,6 +103,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -105,6 +121,7 @@ files:
 - lib/consent/permission.rb
 - lib/consent/permissions.rb
 - lib/consent/railtie.rb
+- lib/consent/reloader.rb
 - lib/consent/rspec.rb
 - lib/consent/subject.rb
 - lib/consent/version.rb
@@ -131,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Consent