picky_guard 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c7b5243f86d60f1d6d927c973851977afc2cc24
-  data.tar.gz: a0a4a359a2650c3ad57e30fa300b8f3caa68a65f
+  metadata.gz: 85e21fc9a0ae52614b7d70dbebb39ab9019f3f11
+  data.tar.gz: 3e38e07bda2744f1e375211f58f116e1aa90260f
 SHA512:
-  metadata.gz: 94e91bc26e04e19cc974f21834d378a0d6d0ed027d6bc70964e9814c5f3b6c2d01c75868524b8602cb63042fde4c555f0753e1e36a0f1634c872e06bb2d8185e
-  data.tar.gz: cb1f864b6ed68eeb21d0772ba948ec2eb1a55bd3fda3c309159aaf3db1d9f171644e94f4974a9479f35d0d7992ed67490dec7004a607166ee52ff34003d91d0d
+  metadata.gz: 6aae898c5bc7ad35b4df8f927015c0501ca7ad7944d137564f41dc357473fe555496f14b604fc8316522ff271bb65eb51773306e58be62997052b72bb87eb79c
+  data.tar.gz: 99a83a8bab4bb4f568011a70a406564441c3b3338b74640e4142826f51a0de08b619da4b46da7e5ee47c5a3de3845234db9242fdb42ff40b6507428de781ec4d

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+os: osx
+language: ruby
+rvm:
+  - 2.4.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    picky_guard (0.1.0)
+    picky_guard (0.1.3)
       activerecord (>= 4.2)
       cancancan (>= 2.0)
 
@@ -20,12 +20,18 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
+    ast (2.4.0)
     cancancan (2.2.0)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (1.0.0)
+    i18n (1.0.1)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -40,10 +46,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     sqlite3 (1.3.13)
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    unicode-display_width (1.3.2)
 
 PLATFORMS
   ruby
@@ -53,6 +68,7 @@ DEPENDENCIES
   picky_guard!
   rake (~> 10.0)
   rspec (~> 3.2)
+  rubocop (~> 0.55.0)
   sqlite3 (~> 1.3.13)
 
 BUNDLED WITH

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Paul Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/picky_guard.svg)](https://badge.fury.io/rb/picky_guard)
+[![Build Status](https://travis-ci.org/eunjae-lee/picky_guard.svg?branch=master)](https://travis-ci.org/eunjae-lee/picky_guard)
+
 # PickyGuard
 
 PickyGuard is an opinionated authorization library which wraps [CanCanCan](https://github.com/CanCanCommunity/cancancan).
@@ -100,7 +103,7 @@ The generated file is like this:
 ```ruby
 class ResourceActions < PickyGuard::ResourceActions
   def initialize
-    map(Report, [:create, :read, :update, :delete])
+    map Report, [:create, :read, :update, :delete]
   end
 end
 ```
@@ -116,13 +119,18 @@ The generated file is like this:
 ```ruby
 class RolePolicies < PickyGuard::RolePolicies
   def initialize
-    map(:role_report_manager, [ManageAllReports])
-    # map(:role_report_reader, [AnotherPolicy])
+    map :report_manager, [ManageAllReports]
+    # map :report_reader, [AnotherPolicy]
   end
 end
 ```
 
-This class defines which role has which policies. From the example code above, we could assume there is a role named `:role_report_manager` and it has one policy named `ManageAllReports`.
+This class defines which role has which policies. The method `map` takes two parameters.
+
+1. `role` : It can be a string or a symbol
+2. `policies` : An array of policies
+
+From the example code above, we could assume there is a role named `:report_manager` and it has one policy named `ManageAllReports`.
 
 Then how do we define policy?
 
@@ -146,14 +154,14 @@ $ rails generate picky_guard:policy reports/manage_all_reports
 
 Then it will generate `app/picky_guard/policies/reports/manage_all_reports.rb`.
 
-The generated file is like this:
+Here is a sample of policy. 
 
 ```ruby
 class ManageAllReports < PickyGuard::Policy
   def initialize(current_user)
     statement_for Campaign do
       allow
-      actions [:create]
+      actions [:read]
       conditions({})
     end
 

data/lib/generators/picky_guard/install_generator.rb

@@ -3,16 +3,14 @@
 module PickyGuard
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
-      # rubocop:disable Metrics/LineLength
       def generate_install
         copy_file 'ability.rb', 'app/models/ability.rb'
         copy_file 'role_policies.rb', 'app/picky_guard/role_policies.rb'
         copy_file 'resource_actions.rb', 'app/picky_guard/resource_actions.rb'
         copy_file 'user_role_checker.rb', 'app/picky_guard/user_role_checker.rb'
       end
-      # rubocop:enable Metrics/LineLength
     end
   end
 end

data/lib/generators/picky_guard/policy_generator.rb

@@ -3,7 +3,7 @@
 module PickyGuard
   module Generators
     class PolicyGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path('templates', __dir__)
 
       desc 'Generates a policy with the given NAME'
 
@@ -21,7 +21,7 @@ module PickyGuard
       def content(name)
         class_name = class_name(name)
         puts "class_name : #{class_name}"
-        path = File.join(File.expand_path('../templates', __FILE__), 'policy.rb.erb')
+        path = File.join(File.expand_path('templates', __dir__), 'policy.rb.erb')
         ERB.new(File.read(path)).result binding
       end
 

data/lib/picky_guard/loader.rb

@@ -6,7 +6,7 @@ module PickyGuard
   class Loader
     include CanCan::Ability
 
-    def initialize(user, *resources_whitelist)
+    def initialize(_user, *resources_whitelist)
       @resources_whitelist = resources_whitelist
     end
 
@@ -17,6 +17,14 @@ module PickyGuard
       adjust_statements(statements)
     end
 
+    def can(_action = nil, _subject = nil, _conditions = nil, &_block)
+      raise 'You cannot use `can` method directly with PickyGuard.'
+    end
+
+    def cannot(_action = nil, _subject = nil, _conditions = nil, &_block)
+      raise 'You cannot use `cannot` method directly with PickyGuard.'
+    end
+
     private
 
     def validate_parameters(user_role_checker_class, resource_actions_class, role_policies_class)

data/lib/picky_guard/policy.rb

@@ -10,7 +10,9 @@ module PickyGuard
     end
 
     def statements(resource_whitelist)
-      @cached_statements ||= gather_statements(resource_whitelist)
+      filtered_array(resource_whitelist).map do |_resource, statement|
+        Validator.validate_statement!(statement)
+      end
     end
 
     def statement_for(resource, &statement_definition)
@@ -23,23 +25,16 @@ module PickyGuard
 
     def register(resource, statement)
       safe_array << [resource, statement]
-      @cached_statements = nil
-    end
-
-    def gather_statements(resource_whitelist)
-      filtered_array(resource_whitelist).map do |_resource, statement|
-        Validator.validate_statement!(statement)
-      end
     end
 
     def filtered_array(resource_whitelist)
-      return safe_array if resource_whitelist.empty?
+      return safe_array if resource_whitelist.nil? || resource_whitelist.empty?
 
       safe_array.select { |item| resource_whitelist.include? item[0] }
     end
 
     def safe_array
-      (@statements ||= [])
+      (@safe_array ||= [])
     end
   end
 end

data/lib/picky_guard/resource_actions.rb

@@ -17,7 +17,7 @@ module PickyGuard
     private
 
     def safe_hash
-      (@map ||= {})
+      (@safe_hash ||= {})
     end
 
     def validate_parameters(actions, resource)

data/lib/picky_guard/role_policies.rb

@@ -20,7 +20,7 @@ module PickyGuard
     private
 
     def safe_map
-      (@map ||= {})
+      (@safe_map ||= {})
     end
 
     def validate_parameters(policies, role)

data/lib/picky_guard/statement_proxy.rb

@@ -18,6 +18,7 @@ module PickyGuard
       @effect = PickyGuard::Statement::EFFECT_DENY
     end
 
+    # rubocop:disable Style/TrivialAccessors
     def actions(actions)
       @actions = actions
     end
@@ -25,6 +26,7 @@ module PickyGuard
     def conditions(conditions)
       @conditions = conditions
     end
+    # rubocop:enable Style/TrivialAccessors
 
     def instance_resource
       @resource_type = PickyGuard::Statement::RESOURCE_TYPE_INSTANCE

data/lib/picky_guard/user_role_checker.rb

@@ -2,7 +2,7 @@
 
 module PickyGuard
   class UserRoleChecker
-    def self.check(user, role)
+    def self.check(_user, _role)
       raise 'fill me'
     end
   end

data/lib/picky_guard/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PickyGuard
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/picky_guard.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'picky_guard/version'
 
@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'rubocop', '~> 0.55.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3.13'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: picky_guard
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Eunjae Lee
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-23 00:00:00.000000000 Z
+date: 2018-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.55.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -105,9 +119,11 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console