miau 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11d358ab5fa86e9112dec38bcd2a30cf8f2001b35982eb9f68c4e354cbbedd17
-  data.tar.gz: 4380f2fe177ef71910d1456f357793b2822ca5a1d3a31cdd00ab76b57b1a25fa
+  metadata.gz: 9f13c1ca4815ddfd75626afa968a0a5544facd84bd57e1d2f12c7c537fc5a1c2
+  data.tar.gz: 424d58b4351a0f6c6c84e3e16940ca7bc38f175af133bfb7f49550b3fb5a2645
 SHA512:
-  metadata.gz: 560524d2fb53017cd0d5070d101ff29fc80ba573f4ef8c83df925c6a67355973887882ce7ad75f2936807580dcec666ac7fc1bb7ce1dbe13ab37566064c78ba5
-  data.tar.gz: 29e32b602528826c9a53ae14b7b8a9cf93bb77949775bea00d862dfbd6a60039140d7f15adb8728013eb733782e7870f9e726a2c8490ca82fe6d47e8c2fde1f5
+  metadata.gz: de5c532eda2225455344017188f2e298bd57b4d8039a36a5e07234e04f44f9be485f1f33f7106c99df4e62340e7c102d8431d9585c25680e50c8b7c44413c333
+  data.tar.gz: 68f1825816a29c44ebb6c6597d8c9d93c2f7b751bb284a73b8e60f859060ea93d66d48881073ed42c804b6484145e296b1e1ef1010c3ba898d67e7a3f505c661

data/.github/workflows/rake.yml

@@ -13,7 +13,7 @@ jobs:
         os: [ubuntu-latest]
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
 #        ruby: [2.5, 2.6, 2.7, '3.0', head, jruby, jruby-head, truffleruby, truffleruby-head]
-        ruby: ["2.7.2", "2.7.3", "3.0.2"]
+        ruby: ["2.7.2", "3.0.1", 3.1.0]
         test_command: ["bundle exec rake test"]
     runs-on: ${{ matrix.os }}
 

data/.ruby-gemset

@@ -1 +1 @@
-rails-6.1
+rails-7.0

data/.ruby-version

@@ -1 +1 @@
-ruby-3.0.2
+ruby-3.1.0

data/Gemfile.lock

@@ -1,78 +1,45 @@
 PATH
   remote: .
   specs:
-    miau (0.1.1)
+    miau (1.0.0)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4.1)
-      actionview (= 6.1.4.1)
-      activesupport (= 6.1.4.1)
-      rack (~> 2.0, >= 2.0.9)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4.1)
-      activesupport (= 6.1.4.1)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.4.1)
-      activesupport (= 6.1.4.1)
-    activesupport (6.1.4.1)
+    activesupport (7.0.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     benchmark-ips (2.9.2)
-    builder (3.2.4)
     concurrent-ruby (1.1.9)
-    crass (1.0.6)
     docile (1.4.0)
-    erubi (1.10.0)
     i18n (1.8.11)
       concurrent-ruby (~> 1.0)
-    loofah (2.13.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    minitest (5.14.4)
-    nokogiri (1.12.5-x86_64-linux)
-      racc (~> 1.4)
+    minitest (5.15.0)
     observr (1.0.5)
     parallel (1.21.0)
-    parser (3.0.3.2)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.2.0)
     rexml (3.2.5)
-    ricecream (0.2.0)
-    rubocop (1.23.0)
+    ricecream (0.2.1)
+    rubocop (1.25.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.14.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
-    rubocop-performance (1.12.0)
+    rubocop-performance (1.13.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
@@ -82,24 +49,19 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    standard (1.5.0)
-      rubocop (= 1.23.0)
-      rubocop-performance (= 1.12.0)
+    standard (1.7.0)
+      rubocop (= 1.25.0)
+      rubocop-performance (= 1.13.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  actionpack
-  activemodel
   benchmark-ips
-  bundler
   miau!
-  minitest
   observr
   rake
   ricecream
@@ -107,4 +69,4 @@ DEPENDENCIES
   standard
 
 BUNDLED WITH
-   2.2.22
+   2.3.3

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Dittmar Krall
+Copyright (c) 2021-2022 Dittmar Krall
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -2,7 +2,7 @@ Miau
 ====
 [![Gem Version](https://badge.fury.io/rb/miau.png)](http://badge.fury.io/rb/miau)
 
-Miau (MIcro AUthorization) is a simple authorization library for Rails
+Miau (MIcro AUthorization) is a simple authorization gem for Rails
 inspired by Pundit and Banken.
 Miau provides a set of helpers which restricts what resources
 a given user is allowed to access.
@@ -14,7 +14,6 @@ Installation
 # Gemfile
 gem "miau"
 ~~~
-
 and run "bundle install".
 
 Usage (as intended)
@@ -51,11 +50,6 @@ end
       @user = user                                   end
       @resource = resource                           ...
     end                                            end
-    ...
-    def update
-      false
-    end
-    ...
   end
 ~~~
 
@@ -64,6 +58,7 @@ in case a policy returns "false" or isn't available.
 
 "authorized?" will return the value of the policy.
 
+"app/policies/application_policy.rb" is included in the gem.
 
 Internals
 ---------
@@ -84,7 +79,7 @@ The policy method has access to the "user" and the "resource".
   ...
 ~~~
 
-The default value for "policy" is inferred from "params[:controller]".
+The default value for "policy" is inferred from "params[:controller]",
 i.e. "authorize!" called from "PostsController" will
 set the "policy" to "PostsPolicy".
 
@@ -95,7 +90,7 @@ The default value for "action" is set by "params[:action]".
 A full blown sample :
 
 ~~~
-  authorize! article, policy: :Comments, action: :extract
+  authorize! article, policy: :posts, action: :show
 ~~~
 
 Usage (more elaborated)
@@ -132,10 +127,30 @@ Rescue's may be inserted previously in the exception chain.
 
 "verify_authorized" checks that an "authorize!" has been called.
 
+DRYing
+------
+
+~~~ ruby
+# app/policies/posts_policy.rb          -->      # app/policies/posts_policy.rb
+  class PostsPolicy < ApplicationPolicy            class PostsPolicy < ApplicationPolicy
+    def new                                          miau %i[create edit], :new
+      user.admin? && Time.now.monday?
+    end                                              def new
+                                                       user.admin? && Time.now.monday?
+    def create                                       end
+      user.admin? && Time.now.monday?                ...
+    end                                            end
+
+    def edit
+      user.admin? && Time.now.monday?
+    end
+    ...
+  end
+~~~
 
 PORO
 ----
-Miau is a very small library, it just provides a few helpers.
+Miau is a small gem, it just provides a few helpers.
 All of the policy classes are just plain Ruby classes,
 allowing DRY, encapsulation, aliasing and inheritance.
 

data/lib/miau/application_policy.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ApplicationPolicy
+  attr_accessor :user, :resource
+
+  def self.miau(actions, meth = nil, &block)
+    [actions].flatten.each { |action|
+      Miau::PolicyStorage.instance.add(self, action, meth)
+    }
+  end
+end

data/lib/miau/storage.rb

@@ -6,37 +6,94 @@ module Miau
   class PolicyStorage
     include Singleton
 
+    # Example @policies:
+    # {
+    #   posts: {
+    #     delete: :delete,
+    #     remove: :delete
+    #   },
+    #   application: {
+    #     admin: :check
+    #   }
+    # }
     attr_reader :policies
+    attr_reader :instances # { posts: PostsPolicy.new }
 
     def initialize
+      reset
+    end
+
+    def reset
       @policies = {}
+      @instances = {}
+    end
+
+    def add(klass, action, meth)
+      kls = klass.name.underscore[0..-8] # remove "_policy"
+      kls = kls.to_sym
+      @policies[kls] ||= {}
+      @instances[kls] ||= klass.new
+      @policies[kls][action.to_sym] = meth.to_sym
+    end
+
+    # return instance of policy (may be nil) and the method
+    # klass and action are symbols
+    # Priority:
+    #   - method of <klass>Policy
+    #   - method of <klass>Policy specified by "miau action, method"
+    #   - method of ApplicationPolicy (independent of klass)
+    #   - method of ApplicationPolicy specified by "miau action, method"
+    #   - nil
+
+    # returns policy: [instance, method]
+    def find_policy(klass, action)
+      kls = instance_of(klass)
+      act = policy_method(klass, action)
+      return [kls, act] if kls.respond_to?(act)
+
+      klass = :application
+      kls = instance_of(klass)
+      act = policy_method(klass, action)
+      return [kls, act] if kls.respond_to?(act)
+
+      # return nil
     end
 
     def run(klass, action, user, resource)
-      policy = policy(klass, user, resource)
-      return policy.send(action) if policy.respond_to?(action)
+      arr = find_policy(klass, action)
+      unless arr
+        msg = "class <#{klass}> action <#{action}>"
+        raise Miau::NotDefinedError, msg
+      end
+
+      policy, meth = arr
+      policy.user = user
+      policy.resource = resource
+      policy.send(meth)
+    end
 
-      msg = "class <#{klass} action <#{action}>"
-      raise Miau::NotDefinedError, msg
+    def to_yaml
+      "# === @policies ===\n" + YAML.dump(@policies) +
+        "# === @instances ===\n" + YAML.dump(@instances)
     end
 
     private
 
-    def policy(klass, user, resource)
-      result = @policies[klass]
-      if result
-        result.user = user
-        result.resource = resource
-        return result
-      end
+    def instance_of(klass)
+      res = @instances[klass]
+      return res if res
+
+      name = "#{klass.to_s.camelcase}Policy"
+      return nil unless Object.const_defined?(name)
 
-      create_policy(klass, user, resource)
+      @instances[klass] = name.constantize.new
     end
 
-    def create_policy(klass, user, resource)
-      str = "#{klass}Policy"
-      result = str.constantize.new(user, resource)
-      @policies[klass] = result
+    def policy_method(klass, action)
+      act = @policies[klass]
+      return action unless act
+
+      act[action] || action
     end
   end
 end

data/lib/miau/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Miau
-  VERSION = "0.1.2" # 2021-12-10
+  VERSION = "1.0.0" # 2022-01-23
+  # VERSION = "0.1.2" # 2021-12-10
   # VERSION = "0.1.1" # 2021-11-06
   # VERSION = "0.1.0" # 2021-09-13
   # VERSION = "0.0.2" # 2021-09-11

data/lib/miau.rb

@@ -4,6 +4,7 @@ require "active_support/concern"
 require "miau/version"
 require "miau/error"
 require "miau/storage"
+require "miau/application_policy"
 
 module Miau
   extend ActiveSupport::Concern
@@ -49,10 +50,9 @@ module Miau
 
   def klass_action(hsh)
     klass = hsh[:class]
-    klass ||= params[:controller].camelize
+    klass ||= params[:controller]
     action = hsh[:action]
     action ||= params[:action]
-
     [klass, action]
   end
 end

data/miau.gemspec

@@ -18,17 +18,12 @@ Gem::Specification.new do |s|
 
   s.authors = ["Dittmar Krall"]
   s.email = "dittmar.krall@matique.com"
-  s.homepage = "https://github.com/matique/miau"
+  s.homepage = "https://matique.com"
 
   s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|features)/}) }
 
   s.add_runtime_dependency "activesupport"
-
-  s.add_development_dependency "activemodel"
-  s.add_development_dependency "actionpack"
-  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
 
-  s.add_development_dependency "minitest"
   s.add_development_dependency "ricecream"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: miau
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Dittmar Krall
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2022-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,48 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  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'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  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'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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'
 - !ruby/object:Gem::Dependency
   name: ricecream
   requirement: !ruby/object:Gem::Requirement
@@ -127,11 +71,12 @@ files:
 - README.md
 - Rakefile
 - lib/miau.rb
+- lib/miau/application_policy.rb
 - lib/miau/error.rb
 - lib/miau/storage.rb
 - lib/miau/version.rb
 - miau.gemspec
-homepage: https://github.com/matique/miau
+homepage: https://matique.com
 licenses:
 - MIT
 metadata:
@@ -151,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Simple and lightweight authorization solution for Rails.