policy_check 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a1e72d0560846575b9f7058c0143f736ba327fff679202f6b50630c6cf87907
-  data.tar.gz: c5dcf2ee63df0890a9ef835109b271b88ff0e8adf4648a98755ff4918e8add81
+  metadata.gz: a4b25415b61494e375278f7c2279d387004e91120f2331bb4553614a26857bd3
+  data.tar.gz: 4ba22e0be2d3f2e43a356259ad2398df00622e8ab233e1eb6df6820e9f75b316
 SHA512:
-  metadata.gz: 3621a014b73eda77689c064437c8fbbd267b05b541c6d2b5516f74f3c0841b86282e0194fb60e74f43ad1509fcb83f419919eef600c0f57641111baaae71e266
-  data.tar.gz: 3333297547cb1e00b83fb8e4b2d9fba03ca4a00657ea8cc00864a30480374f045ff5d07cffb1db4f26a2e3fd6c4a50c1e39281aadbe4cd1725e2b31cd6957fe5
+  metadata.gz: 571ee7602757f70b7e635497a50dd44211ac5342a115120f39ecfa1e6ec3861efba4797b36f1d5ebdac15a2d982f41fde9c741b5369936ff801d56794ea9f069
+  data.tar.gz: cff979634a25bed373743eadc0ee8519dfd43410ae6f96b0cffaecb2412e222030d81ac105aacc2b0ff2782d650ccc03afc11d8de0e327a6010c7bd568b4c3df

data/Gemfile.lock

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

data/README.md

@@ -83,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.1"
+  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) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: policy_check
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - HAZI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2023-02-05 00:00:00.000000000 Z
 dependencies: []
 description:
 email: