policy_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9da007a15a7dec7f84d7752477e67a5ad9e157adba82d5927809770f25fa561
+  data.tar.gz: bfc62ac4ecc7cfd5d4647741b508ebea6614ad224bc27fa3cb042d61ec5dce51
+SHA512:
+  metadata.gz: 999496e740414550cc81955aaabf761a0e427d2c37261cb8a1fad61c91c3ff4767f0317ba50c400dca0ec3422d7e4353bfe03e92cb1569e156d2a57bc4064fff
+  data.tar.gz: 6268828a9de862256b57d6f66b5e7ebbfe7af5ef864c72e876418f042adf3a9a5c2e3296457c447ea46dcc26e7c12e18580fa5114cc46271a05650429e485b31

data/.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: lint
+
+on: [push, pull_request]
+
+permissions:  # added using https://github.com/step-security/secure-workflows
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    timeout-minutes: 10
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+
+      - name: Run rubocop
+        run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: test
+
+on: [push, pull_request]
+
+permissions:  # added using https://github.com/step-security/secure-workflows
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        ruby-version: [3.2, 3.1, '3.0', 2.7, ruby-head]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+/.ruby-version
+/policy_check-*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in policy_check.gemspec
+gemspec
+
+group :development do
+  gem "bundler"
+  gem "rake"
+  gem "rspec"
+  gem "rubocop"
+  gem "rubocop-rake"
+  gem "rubocop-rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    policy_check (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  policy_check!
+  rake
+  rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.4.5

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 yuhei mukoyama
+
+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

@@ -0,0 +1,85 @@
+[![test](https://github.com/hazi/policy_check/actions/workflows/test.yml/badge.svg)](https://github.com/hazi/policy_check/actions/workflows/test.yml) [![lint](https://github.com/hazi/policy_check/actions/workflows/lint.yml/badge.svg)](https://github.com/hazi/policy_check/actions/workflows/lint.yml)
+
+# PolicyCheck
+
+PolicyCheck provides a DSL for policy definitions and allows you to get reasons for policy violations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'policy_check', github: 'hazi/policy_check'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+### Inline policy
+
+```ruby
+class Post
+  extend PolicyCheck #-> only add `.policy` method
+
+  def initialize
+    @status = :draft
+    @body = ""
+  end
+
+  def not_draft?
+    @status != :draft
+  end
+
+  policy :publishable do #-> only create `#publishable?` and `#publishable_errors` method
+    error "status is not draft", &:not_draft?
+    error("body is empty") { @body.empty? }
+  end
+
+  def publish!
+    fail publishable_errors.join(", ") unless publishable?
+    publish
+  end
+end
+
+post = Post.new
+post.publishable_errors #=> ["body is empty"]
+post.publishable? #=> false
+```
+
+### Policy class
+
+```ruby
+class PostPublishablePolicy
+  extend PolicyCheck #-> only add `.policy`
+
+  def initialize(post, user)
+    @post = post
+    @user = user
+  end
+  attr_reader :post, :user
+
+  def not_admin?
+    !user.admin?
+  end
+
+  policy do #-> only create `#valid?` and `#error_messages` method
+    error "user is not admin", &:not_admin?
+    error("status is not `draft`") { post.status != :draft }
+    error("body is empty") { post.body.empty? }
+  end
+end
+
+post = Post.find(1)
+user = current_user
+PostPublishablePolicy.new(post, user).error_messages #=> ["body is empty", "write is not admin"]
+PostPublishablePolicy.new(post, user).valid? #=> false
+PostPublishablePolicy.new(post, user).invalid? #=> true
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "policy_check"
+
+# 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

@@ -0,0 +1,8 @@
+#!/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

data/lib/policy_check/error.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module PolicyCheck
+  # Determines the error
+  class Error
+    def initialize(model, message, &block)
+      @model = model
+      @block = block
+      @message = message
+    end
+    attr_reader :model, :message
+
+    def error?
+      model.instance_eval(&@block)
+    end
+
+    def error_message
+      error? ? message : nil
+    end
+  end
+end

data/lib/policy_check/error_list.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "policy_check/error"
+
+module PolicyCheck
+  # Create a summary error model and summarize the decision
+  class ErrorList
+    def initialize(model, &block)
+      @model = model
+      @block = block
+      @errors = instance_eval(&block)
+    end
+
+    # @return [Boolean] true if all errors are false
+    def valid?
+      errors.none?(&:error?)
+    end
+
+    # @return [Array<String>] error messages
+    def error_messages
+      errors.map(&:error_message).compact
+    end
+
+    private
+
+    attr_reader :model, :block, :errors
+
+    # called when a policy is defined
+    def error(message, &block)
+      @errors ||= []
+      @errors << Error.new(model, message, &block)
+    end
+  end
+end

data/lib/policy_check/module_builder.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "policy_check/error_list"
+
+module PolicyCheck
+  # Module Builder to define methods to make decisions
+  class ModuleBuilder < Module
+    def initialize(name, &block) # rubocop:disable Lint/MissingSuper, Metrics/MethodLength
+      define_method name ? "#{name}?" : "valid?" do
+        errors = ErrorList.new(self, &block)
+        errors.valid?
+      end
+
+      if name.nil?
+        define_method "invalid?" do
+          errors = ErrorList.new(self, &block)
+          !errors.valid?
+        end
+      end
+
+      define_method name ? "#{name}_errors" : "error_messages" do
+        errors = ErrorList.new(self, &block)
+        errors.error_messages
+      end
+    end
+  end
+end

data/lib/policy_check/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PolicyCheck
+  VERSION = "0.1.0"
+end

data/lib/policy_check.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "policy_check/version"
+require "policy_check/module_builder"
+
+# extend this module to add `.policy` method
+#
+# @example inline policy
+#   class Post
+#     extend PolicyCheck #-> only add `.policy` method
+#
+#     policy :publishable do #-> only create `#publishable?` and `#publishable_errors` method
+#       error 'status is not draft', &:not_draft?
+#       error('body is empty') { @body.empty? }
+#     end
+#   end
+#
+# @example policy class
+#   class Post
+#     extend PolicyCheck #-> only add `.policy` method
+#
+#     policy do #-> only create `#valid?`, `#invalid?` and `#error_messages` method
+#       error 'status is not draft', &:not_draft?
+#       error('body is empty') { @body.empty? }
+#     end
+#   end
+module PolicyCheck
+  # @param [#to_sym] name policy name, default is `nil`.
+  #   If a name is specified "#{name}?" and "#{name}_errors" method are added.
+  #   if `nil`, add `#error_messages`, `#valid?` and `#invalid?` method
+  def policy(name = nil, &block)
+    name = name&.to_sym
+    class_exec { include PolicyCheck::ModuleBuilder.new(name, &block) }
+  end
+end

data/policy_check.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "policy_check/version"
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.name          = "policy_check"
+  spec.version       = PolicyCheck::VERSION
+  spec.authors       = ["HAZI"]
+  spec.email         = ["yuhei.mukoyama@gmail.com"]
+
+  spec.summary       = "Create policies for models or policy class"
+  spec.homepage      = "https://github.com/hazi/policy_check"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["rubygems_mfa_required"] = "true"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+          "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: policy_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HAZI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-31 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- yuhei.mukoyama@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/policy_check.rb
+- lib/policy_check/error.rb
+- lib/policy_check/error_list.rb
+- lib/policy_check/module_builder.rb
+- lib/policy_check/version.rb
+- policy_check.gemspec
+homepage: https://github.com/hazi/policy_check
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Create policies for models or policy class
+test_files: []