miau 1.0.3 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '008262a0054143f56caffceb6dfa57f195963ff6b98cc07aa6452778f5ad87b5'
-  data.tar.gz: 1eca9f4196b9569d0515b9c14da47182fecdd1c05b6bbc388b1f16226bb3ee36
+  metadata.gz: 4ff4fcf400151bdd20347e5bc2cd8f215a11e8ea6b519840c6032ed3ac18a57b
+  data.tar.gz: bc678ee4c5c2029d66a5f9d7970ae81e0eb334bb4a493cde94f3445f5d1a9e25
 SHA512:
-  metadata.gz: 62497618e0cb83822bb448d9d6a7fbeac80943163284677033dc1e8b555b42440434ff3f16dec7ed16f1b3b1db629815bd42530cf0de1ea457b2eb2ec6cecc96
-  data.tar.gz: f2d0a731b6a61448790ab745332e2d6f4bf9225fbb9aa947a7fa4438f15bb0a1818df4cbec818c5546ced6b166825a8ecabb35b5fdc060482faee7fae097d18e
+  metadata.gz: a2f4c5d1a4b5947fe6d5ff836291909d5428de7e0745d7e50654327637b173c573646446c4846ca62789b1f590e13fe43f057fa82eac7a03c85faf7483115014
+  data.tar.gz: f87d22f71705710792a13a2490d71a632a3c55fd0f40bd7cf5e342d58b58c6066777e23dab777af0a0e674103182dec768caf04a73d9f6db58a35ed5453f2e9a

data/.github/workflows/rake.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby_version: ["2.7", "3.0", "3.2", head]
+        ruby_version: ["3.0", 3.2, 3.3]
         gemfile:
           - Gemfile
           - gemfiles/Gemfile.rails-7.1

data/.gitignore

@@ -1,7 +1,10 @@
 /.bundle/
-/Gemfile.lock
+/tmp/
 /coverage/
-.watchr
+/.watchr
 
-/doc/
-/tmp/
+*.gem
+*.log
+*.lock
+
+**/db/test.sqlite*

data/.ruby-version

@@ -1 +1 @@
-ruby-3.2.2
+ruby-3.3.0

data/Gemfile

@@ -1,10 +1,12 @@
 source "https://rubygems.org"
-
 gemspec
 
+gem "rails"
+
 group :test do
+  gem "benchmark-ips"
   gem "observr"
-  gem "standard", require: false
+  gem "ricecream"
   gem "simplecov", require: false
-  gem "benchmark-ips"
+  gem "standard", require: false
 end

data/Gemfile.lock

@@ -1,12 +1,75 @@
 PATH
   remote: .
   specs:
-    miau (1.0.3)
-      activesupport
+    miau (1.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.2)
+      actionpack (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.2)
+      actionpack (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activesupport (= 7.1.2)
+      marcel (~> 1.0)
     activesupport (7.1.2)
       base64
       bigdecimal
@@ -25,30 +88,119 @@ GEM
     base64 (0.2.0)
     benchmark-ips (2.13.0)
     bigdecimal (3.1.5)
+    builder (3.2.4)
+    combustion (1.3.7)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
     concurrent-ruby (1.2.2)
     connection_pool (2.4.1)
+    crass (1.0.6)
+    date (3.3.4)
     docile (1.4.0)
     drb (2.2.0)
       ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-console (0.7.1)
+    irb (1.11.1)
+      rdoc
+      reline (>= 0.4.2)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    minitest (5.20.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    minitest (5.21.1)
     mutex_m (0.2.0)
+    net-imap (0.4.9.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.0-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.0-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.0-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.0-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.0-x86_64-linux)
+      racc (~> 1.4)
     observr (1.0.5)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.24.0)
+    parser (3.3.0.3)
       ast (~> 2.4.1)
       racc
+    psych (5.1.2)
+      stringio
     racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.2)
+      actioncable (= 7.1.2)
+      actionmailbox (= 7.1.2)
+      actionmailer (= 7.1.2)
+      actionpack (= 7.1.2)
+      actiontext (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activemodel (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.1.0)
-    regexp_parser (2.8.3)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.2)
+      io-console (~> 0.5)
     rexml (3.2.6)
     ricecream (0.2.1)
-    rubocop (1.57.2)
+    rubocop (1.59.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -56,14 +208,14 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
     ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     simplecov (0.22.0)
@@ -72,36 +224,56 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.32.1)
+    sqlite3 (1.7.0-aarch64-linux)
+    sqlite3 (1.7.0-arm-linux)
+    sqlite3 (1.7.0-arm64-darwin)
+    sqlite3 (1.7.0-x86-linux)
+    sqlite3 (1.7.0-x86_64-darwin)
+    sqlite3 (1.7.0-x86_64-linux)
+    standard (1.33.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.57.2)
+      rubocop (~> 1.59.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.2)
+      standard-performance (~> 1.3)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.2.1)
+    standard-performance (1.3.1)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.19.1)
+      rubocop-performance (~> 1.20.2)
+    stringio (3.1.0)
     thor (1.3.0)
+    timeout (0.4.1)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
 
 PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
   x86_64-linux
 
 DEPENDENCIES
   appraisal
   benchmark-ips
+  combustion
   miau!
   minitest
   observr
-  rake
+  rails
   ricecream
   simplecov
+  sqlite3
   standard
 
 BUNDLED WITH
-   2.4.22
+   2.5.3

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021-2023 Dittmar Krall (www.matiq.com)
+Copyright (c) 2021-2024 Dittmar Krall (www.matiq.com)
 
 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

@@ -1,5 +1,5 @@
-Miau
-====
+# Miau
+
 [![Gem Version](https://badge.fury.io/rb/miau.png)](http://badge.fury.io/rb/miau)
 [![GEM Downloads](https://img.shields.io/gem/dt/miau?color=168AFE&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/miau)
 
@@ -44,13 +44,12 @@ end
 ```ruby
 # app/policies/application_policy.rb             # app/policies/posts_policy.rb
   class ApplicationPolicy                          class PostsPolicy < ApplicationPolicy
-    attr_reader :user, :resource                     ...
+    attr_reader :user, :resource, :action                     ...
                                                      def update
-    def initalize(user, resource)                      user.admin? && resource.published?
-      @user = user                                   end
-      @resource = resource                           ...
-    end                                            end
-  end
+    ...                                                user.admin? && resource.published?
+  end                                                end
+                                                     ...
+                                                   end
 ```
 
 "authorize!" will raise an exception (which can be handled by "rescue")
@@ -60,14 +59,15 @@ in case a policy returns "false" or isn't available.
 
 "app/policies/application_policy.rb" is included in the gem.
 
-Internals
----------
+## Internals
 
 At the bottom line based on a "policy" and an "action"
 a corresponding policy method is called.
 
 The policy method has access to the "user" and the "resource".
 
+The "controller" policy method has access to the "user" and the "action".
+
 "user" is set by the default method "miau_user" (can be overwritten) as:
 
 ```ruby
@@ -93,8 +93,7 @@ A full blown sample :
   authorize! article, policy: :posts, action: :show
 ```
 
-Usage (more elaborated)
------------------------
+## Usage (more elaborated)
 
 ```ruby
 # app/models/application_controller.rb
@@ -127,8 +126,27 @@ Rescue's may be inserted previously in the exception chain.
 
 "verify_authorized" checks that an "authorize!" has been called.
 
-DRYing
-------
+## Authorize Controller
+
+Sometimes a whole controller can be authorized,
+e.g. all actions requires admin priviledges.
+
+The corresponding authorization is triggered by
+a "before_action :authorize_controller!".
+The corresponding policy is
+defined by (e.g):
+
+```ruby
+class PostsPolicy < ApplicationPolicy
+...
+  def controller
+    user.is_admin?
+  end
+...
+end
+```
+
+## DRYing
 
 ```ruby
 # app/policies/posts_policy.rb          -->      # app/policies/posts_policy.rb
@@ -148,8 +166,8 @@ DRYing
   end
 ```
 
-PORO
-----
+## PORO
+
 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.
@@ -159,5 +177,5 @@ Just the embedding in Rails required some specific knowledge.
 
 ## Miscellaneous
 
-Copyright (c) 2021-2023 Dittmar Krall (www.matiq.com),
+Copyright (c) 2021-2024 Dittmar Krall (www.matiq.com),
 released under the [MIT license](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,12 +1,10 @@
-require "rubygems"
-require "bundler/gem_tasks"
 require "rake/testtask"
 
-desc "Run all tests"
+desc "Run the tests."
 Rake::TestTask.new do |t|
-  t.libs.push "test"
-  t.pattern = "test/*_test.rb"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
 end
 
-desc "Default: run unit tests."
 task default: :test

data/gemfiles/rails_6.1.gemfile

@@ -6,10 +6,11 @@ gem "rails", "~> 6.1"
 gem "dryer-config", "~> 6.0"
 
 group :test do
+  gem "benchmark-ips"
   gem "observr"
-  gem "standard", require: false
+  gem "ricecream"
   gem "simplecov", require: false
-  gem "benchmark-ips"
+  gem "standard", require: false
 end
 
 gemspec path: "../"

data/gemfiles/rails_7.0.gemfile

@@ -6,10 +6,11 @@ gem "rails", "~> 7.0"
 gem "dryer-config", "~> 7.0"
 
 group :test do
+  gem "benchmark-ips"
   gem "observr"
-  gem "standard", require: false
+  gem "ricecream"
   gem "simplecov", require: false
-  gem "benchmark-ips"
+  gem "standard", require: false
 end
 
 gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -5,10 +5,11 @@ source "https://rubygems.org"
 gem "rails", "~> 7.1"
 
 group :test do
+  gem "benchmark-ips"
   gem "observr"
-  gem "standard", require: false
+  gem "ricecream"
   gem "simplecov", require: false
-  gem "benchmark-ips"
+  gem "standard", require: false
 end
 
 gemspec path: "../"

data/lib/miau/application_policy.rb

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

data/lib/miau/error.rb

@@ -11,4 +11,7 @@ module Miau
 
   class AuthorizationNotPerformedError < Error
   end
+
+  class OverwriteError < Error
+  end
 end

data/lib/miau/run.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "singleton"
+require "yaml"
+
+module Miau
+  class PolicyRun
+    include Singleton
+
+    # return method[s]
+    # 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 method_name[s]
+
+    def find_methods(policy, klass, action)
+      return action if policy.respond_to?(action)
+
+      hsh = PolicyStorage.instance.policies[klass]
+      return nil unless hsh
+
+      hsh[action]
+    end
+
+    def runs(policy, actions)
+      [actions].flatten.each { |action|
+        raise_undef(policy, action) unless policy&.respond_to?(action)
+
+        return false unless policy.send(action)
+      }
+      true
+    end
+
+    def raise_undef(policy, action)
+      msg = "NotDefined policy <#{policy}> action <#{action}>"
+      raise NotDefinedError, msg
+    end
+
+    def raise_authorize(controller, action)
+      msg = "NotAuthorized controller <#{controller}> action <#{action}>"
+      raise NotAuthorizedError, msg
+    end
+  end
+end

data/lib/miau/storage.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "singleton"
+require "yaml"
 
 module Miau
   class PolicyStorage
@@ -17,7 +18,7 @@ module Miau
     #   }
     # }
     attr_reader :policies
-    attr_reader :instances # { posts: PostsPolicy.new }
+    attr_reader :instances # e.g. { posts: PostsPolicy.new }
 
     def initialize
       reset
@@ -28,70 +29,35 @@ module Miau
       @instances = {}
     end
 
-    def add(klass, action, meth)
-      kls = klass.name.underscore[0..-8] # remove "_policy"
+    def add_policy(kls, action, meth)
       kls = kls.to_sym
+      action = action.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)
-      [kls, act] if kls.respond_to?(act)
-    end
-
-    def run(klass, action, user, resource)
-      arr = find_policy(klass, action)
-      unless arr
-        msg = "class <#{klass}> action <#{action}>"
-        raise Miau::NotDefinedError, msg
+      if @policies[kls][action]
+        raise OverwriteError, "Can't overwrite policy(#{kls}, #{action})"
       end
 
-      policy, meth = arr
-      policy.user = user
-      policy.resource = resource
-      policy.send(meth)
-    end
-
-    def to_yaml
-      "# === @policies ===\n" + YAML.dump(@policies) +
-        "# === @instances ===\n" + YAML.dump(@instances)
+      if meth.is_a?(Array)
+        meths = [meth].flatten.collect(&:to_sym)
+        @policies[kls][action] = meths
+      else
+        @policies[kls][action] = meth.to_sym
+      end
     end
 
-    private
-
-    def instance_of(klass)
+    def find_or_create_policy(klass)
       res = @instances[klass]
-      return res if res
+      return res unless res.nil?
 
       name = "#{klass.to_s.camelcase}Policy"
       return nil unless Object.const_defined?(name)
 
-      @instances[klass] = name.constantize.new
+      instances[klass] = name.constantize.new
     end
 
-    def policy_method(klass, action)
-      act = @policies[klass]
-      return action unless act
-
-      act[action] || action
+    def to_yaml
+      "# === @policies ===\n" + YAML.dump(@policies) +
+        "# === @instances ===\n" + YAML.dump(@instances)
     end
   end
 end