snfoil-policy 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 111becd9c6e60e5d7deda40f9f0f3325d06e30652a68558ebeb2282b6bd35986
-  data.tar.gz: f3b278ef4ac6665e59a6707c0e17dd60bd56d1eb5262599649fb26d0cf5ef20a
+  metadata.gz: a6dab1a607349ecc86d023e26ad1d9ba97e96e57318cd129bafef7589b125e1e
+  data.tar.gz: 66fabe2a19f859d6cd50b707987ee34f51e0e85a19abe8fb2e16e880a570f16b
 SHA512:
-  metadata.gz: 404e9808b598cbf50be0f931e7e48691015e5a6ff7ded650ccd11030d2150e2e2eb9f4ea8a12162807369b237826cfdd63c186bcff141e8e1e6eeb31b16b4ea0
-  data.tar.gz: 3898c4814640ae1a18bc1561f8773dc428fe937f608f5323c5e6629bc09056ecb287a270618937e2213f084319e2294fba093a8a7609919293e277e377eeae10
+  metadata.gz: 2f4dca9af08516db9b3abfd4075eb568adf576c27da6d2e1a372b93e33a72d9fd0753d07a4700d65f8ef5dc683c1d894e1f48127a46dbcb88ed92e62465f50dd
+  data.tar.gz: 64e48295ab0086b1291ea394e44d93a5859c22a1f9e0c1652621cce81f788734897fd8b254c4c5afbaaaf3dad69003737b8387a01a1c663971aba4fbf87be04b

data/README.md

@@ -2,8 +2,7 @@
 
 ![build](https://github.com/limited-effort/snfoil-policy/actions/workflows/main.yml/badge.svg) [![maintainability](https://api.codeclimate.com/v1/badges/81c3abdb068a2305d4ce/maintainability)](https://codeclimate.com/github/limited-effort/snfoil-policy/maintainability)
 
-SnFoil Policies are an easy and intuitive way to built [Pundit](https://github.com/varvet/pundit) style authorization files with a little extra base functionality added in.
-
+SnFoil Policies are an easy and intuitive way to build [Pundit](https://github.com/varvet/pundit) style authorization files with a little extra base functionality added in.
 
 While it isn't required you use [Pundit](https://github.com/varvet/pundit) with it, we highly recommend it.
 
@@ -21,7 +20,7 @@ gem 'snfoil-policy'
 
 SnFoil Policies are meant to be used just like Pundit policies except you can build the actions using a helper and some of the setup work has been done for you.
 
-The entity being authorizated (usually a User) is accessible via the `entity` instance variable.
+The entity being authorized (usually a User) is accessible via the `entity` instance variable.
 And the record the entity is trying to work with is accessible as the `record` instance variable.
 
 Use `permission` to start setting up some checks.
@@ -88,7 +87,7 @@ end
 permission :update?, with: :create?
 ```
 
-For more complex authorization mechanisms where more than one type of entity can operate against a record you can supply the type of the entity to check against.
+For more complex authorization mechanisms where more than one type of entity can operate against a record, you can supply the type of entity to check against.
 
 ```ruby
 permission :create?, User do
@@ -115,7 +114,7 @@ end
 
 ### Scope
 
-There is nothing special about SnFoil Policy Scopes.  They are just defined to make life a little easier. Go ahead an check out how to use Scopes in [Pundit](https://github.com/varvet/pundit#scopes), we highly recommend them.
+There is nothing special about SnFoil Policy Scopes.  They are just defined to make life a little easier. Check out how to use Scopes in [Pundit](https://github.com/varvet/pundit#scopes), we highly recommend them.
 
 
 ## Development
@@ -134,4 +133,4 @@ The gem is available as open source under the terms of the [Apache 2 License](ht
 
 ## Code of Conduct
 
-Everyone interacting in the Snfoil::Policy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/limited-effort/snfoil-policy/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Snfoil::Policy project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/limited-effort/snfoil-policy/blob/main/CODE_OF_CONDUCT.md).

data/lib/snfoil/policy/version.rb

@@ -2,6 +2,6 @@
 
 module SnFoil
   module Policy
-    VERSION = '0.0.1'
+    VERSION = '1.0.1'
   end
 end

data/lib/snfoil/policy.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2021 Matthew Howes, Cliff Campbell
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -28,21 +28,29 @@ module SnFoil
     extend ActiveSupport::Concern
 
     class_methods do
-      def i_permissions
-        @i_permissions ||= {}
+      def snfoil_permissions
+        @snfoil_permissions ||= {}
       end
 
       def permission(authorization_type, entity_class = nil, with: nil, &block)
-        @i_permissions ||= {}
-        @i_permissions[authorization_type] ||= {}
-        if @i_permissions[authorization_type][entity_class]
+        @snfoil_permissions ||= {}
+        @snfoil_permissions[authorization_type] ||= {}
+        if @snfoil_permissions[authorization_type][entity_class]
           raise SnFoil::Policy::Error,
                 "permission #{entity_class} #{authorization_type} already defined for #{name}"
         end
 
-        @i_permissions[authorization_type][entity_class] = build_permission_exec(with, block)
+        @snfoil_permissions[authorization_type][entity_class] = build_permission_exec(with, block)
         define_permission_method(authorization_type)
       end
+
+      def inherited(subclass)
+        super
+
+        instance_variables.grep(/@snfoil_.+/).each do |i|
+          subclass.instance_variable_set(i, instance_variable_get(i).dup)
+        end
+      end
     end
 
     attr_reader :record, :entity
@@ -83,7 +91,7 @@ module SnFoil
 
       def define_permission_method(authorization_type)
         define_method authorization_type do
-          self.class.i_permissions[authorization_type].each do |klass, exec|
+          self.class.snfoil_permissions[authorization_type].each do |klass, exec|
             return instance_eval(&exec) if klass.nil? || entity.is_a?(klass)
           end
 

data/snfoil-policy.gemspec

@@ -5,24 +5,24 @@ require_relative 'lib/snfoil/policy/version'
 Gem::Specification.new do |spec|
   spec.name          = 'snfoil-policy'
   spec.version       = SnFoil::Policy::VERSION
-  spec.authors       = ['Matthew Howes']
-  spec.email         = ['howeszy@gmail.com']
+  spec.authors       = ['Matthew Howes', 'Cliff Campbell']
+  spec.email         = ['howeszy@gmail.com', 'cliffcampbell@hey.com']
 
   spec.summary       = 'Pundit Style Permissions Builder'
   spec.description   = 'A set of helper functions to build permission files inspired by Pundit.'
   spec.homepage      = 'https://github.com/limited-effort/snfoil-policy'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '>= 2.6'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = 'https://github.com/limited-effort/snfoil-policy/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
-  end
+  ignore_list = %r{\A(?:test/|spec/|bin/|features/|Rakefile|\.\w)}
+  spec.files = Dir.chdir(File.expand_path(__dir__)) { `git ls-files -z`.split("\x0").reject { |f| f.match(ignore_list) } }
 
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
@@ -30,10 +30,12 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 5.2.6'
 
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  spec.add_development_dependency 'fasterer', '~> 0.10.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.21'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.11'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.5'
+  spec.add_development_dependency 'rubocop', '1.33'
+  spec.add_development_dependency 'rubocop-performance', '1.14.3'
+  spec.add_development_dependency 'rubocop-rspec', '2.12.1'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-policy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Matthew Howes
+- Cliff Campbell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +25,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.6
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -70,73 +99,68 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.21'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: 2.12.1
 description: A set of helper functions to build permission files inspired by Pundit.
 email:
 - howeszy@gmail.com
+- cliffcampbell@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/snfoil/policy.rb
 - lib/snfoil/policy/version.rb
 - snfoil-policy.gemspec
 homepage: https://github.com/limited-effort/snfoil-policy
 licenses:
-- MIT
+- Apache-2.0
 metadata:
   homepage_uri: https://github.com/limited-effort/snfoil-policy
   source_code_uri: https://github.com/limited-effort/snfoil-policy
   changelog_uri: https://github.com/limited-effort/snfoil-policy/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -145,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/main.yml

@@ -1,46 +0,0 @@
-name: build
-on: 
-  push:
-    branches: [ main ]
-  pull_request:
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby-version: [2.7, 2.6, 2.5]
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@v1.81.0
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-      - name: Install dependencies
-        run: bundle install
-      - name: Run tests
-        run: bundle exec rspec
-  lint:
-
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        ruby-version: [2.7, 2.6, 2.5, '3.0']
-
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@v1.81.0
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-      - name: Install dependencies
-        run: bundle install
-      - name: Run rubocop
-        run: bundle exec rubocop
-

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# GEMFILE
-Gemfile.lock

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,39 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rspec
-
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: 2.5.0
-
-# ================ LAYOUT ==============
-Layout/LineLength:
-  Max: 150
-
-# ================ LINT ================
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - spec/**/*_spec.rb
-
-Lint/EmptyClass:
-  Exclude:
-    - spec/**/*_spec.rb
-
-# ================ Metics ================
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*_spec.rb
-
-# ================ RSPEC ================
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Max: 5
-
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 5

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'snfoil/policy'
-
-# 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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here