policy_check 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9da007a15a7dec7f84d7752477e67a5ad9e157adba82d5927809770f25fa561
-  data.tar.gz: bfc62ac4ecc7cfd5d4647741b508ebea6614ad224bc27fa3cb042d61ec5dce51
+  metadata.gz: a4b25415b61494e375278f7c2279d387004e91120f2331bb4553614a26857bd3
+  data.tar.gz: 4ba22e0be2d3f2e43a356259ad2398df00622e8ab233e1eb6df6820e9f75b316
 SHA512:
-  metadata.gz: 999496e740414550cc81955aaabf761a0e427d2c37261cb8a1fad61c91c3ff4767f0317ba50c400dca0ec3422d7e4353bfe03e92cb1569e156d2a57bc4064fff
-  data.tar.gz: 6268828a9de862256b57d6f66b5e7ebbfe7af5ef864c72e876418f042adf3a9a5c2e3296457c447ea46dcc26e7c12e18580fa5114cc46271a05650429e485b31
+  metadata.gz: 571ee7602757f70b7e635497a50dd44211ac5342a115120f39ecfa1e6ec3861efba4797b36f1d5ebdac15a2d982f41fde9c741b5369936ff801d56794ea9f069
+  data.tar.gz: cff979634a25bed373743eadc0ee8519dfd43410ae6f96b0cffaecb2412e222030d81ac105aacc2b0ff2782d650ccc03afc11d8de0e327a6010c7bd568b4c3df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    policy_check (0.1.0)
+    policy_check (0.1.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,14 +2,14 @@
 
 # PolicyCheck
 
-PolicyCheck provides a DSL for policy definitions and allows you to get reasons for policy violations.
+DSL for policy definitions and allows get reasons for policy violations.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'policy_check', github: 'hazi/policy_check'
+gem 'policy_check'
 ```
 
 And then execute:
@@ -19,11 +19,19 @@ And then execute:
 
 ## Usage
 
+```ruby
+class Post
+  extend PolicyCheck #-> only add `.policy` method
+end
+```
+
+## Example
+
 ### Inline policy
 
 ```ruby
 class Post
-  extend PolicyCheck #-> only add `.policy` method
+  extend PolicyCheck
 
   def initialize
     @status = :draft
@@ -54,7 +62,7 @@ post.publishable? #=> false
 
 ```ruby
 class PostPublishablePolicy
-  extend PolicyCheck #-> only add `.policy`
+  extend PolicyCheck
 
   def initialize(post, user)
     @post = post
@@ -66,7 +74,7 @@ class PostPublishablePolicy
     !user.admin?
   end
 
-  policy do #-> only create `#valid?` and `#error_messages` method
+  policy do #-> only create `#valid?`, `#invalid?` 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? }
@@ -75,11 +83,32 @@ 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).error_messages #=> ["body is empty", "user is not admin"]
 PostPublishablePolicy.new(post, user).valid? #=> false
 PostPublishablePolicy.new(post, user).invalid? #=> true
 ```
 
+## Compatibility
+
+PolicyCheck officially supports the following runtime Ruby implementations:
+
+- MRI 2.7, 3.0, 3.1, 3.2
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rspec` to run the tests.
+Before committing, run `bundle exec rubocop` to perform a style check.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contribution
+
+1. Fork it ( https://github.com/hazi/policy_check/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/policy_check/error.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PolicyCheck
-  # Determines the error
+  # Model representing one error defined in the {PolicyCheck#policy} block
   class Error
     def initialize(model, message, &block)
       @model = model

data/lib/policy_check/error_list.rb

@@ -3,12 +3,13 @@
 require "policy_check/error"
 
 module PolicyCheck
-  # Create a summary error model and summarize the decision
+  # A model that summarizes the errors defined in the {PolicyCheck#policy} block
   class ErrorList
     def initialize(model, &block)
       @model = model
       @block = block
-      @errors = instance_eval(&block)
+      @errors = []
+      instance_eval(&block)
     end
 
     # @return [Boolean] true if all errors are false
@@ -27,7 +28,6 @@ module PolicyCheck
 
     # called when a policy is defined
     def error(message, &block)
-      @errors ||= []
       @errors << Error.new(model, message, &block)
     end
   end

data/lib/policy_check/module_builder.rb

@@ -5,6 +5,7 @@ require "policy_check/error_list"
 module PolicyCheck
   # Module Builder to define methods to make decisions
   class ModuleBuilder < Module
+    # {PolicyCheck#policy} method will call this method to create a ModuleBuilder instance
     def initialize(name, &block) # rubocop:disable Lint/MissingSuper, Metrics/MethodLength
       define_method name ? "#{name}?" : "valid?" do
         errors = ErrorList.new(self, &block)

data/lib/policy_check/version.rb

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

data/lib/policy_check.rb

@@ -25,9 +25,9 @@ require "policy_check/module_builder"
 #     end
 #   end
 module PolicyCheck
+  # If a name is specified "#\\{name}?" and "#\\{name}_errors" method are added.
+  # if name is `nil`, add `#error_messages`, `#valid?` and `#invalid?` method
   # @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) }

data/policy_check.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["HAZI"]
   spec.email         = ["yuhei.mukoyama@gmail.com"]
 
-  spec.summary       = "Create policies for models or policy class"
+  spec.summary       = "DSL for policy definitions and allows get reasons for policy violations."
   spec.homepage      = "https://github.com/hazi/policy_check"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: policy_check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - HAZI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-02-05 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -59,5 +59,5 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Create policies for models or policy class
+summary: DSL for policy definitions and allows get reasons for policy violations.
 test_files: []