bizness 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac397c6a08c4dd66a3f50a7fe2f5f7611ca50495
-  data.tar.gz: 1f37cf2e9e7a5a0e949f6ed9c9735459ab100405
+  metadata.gz: 6599bbc343ef41b029d10213194246af4bf30afd
+  data.tar.gz: 60a1e05ced98e4e7f0856fb49f5f6bd82f82280e
 SHA512:
-  metadata.gz: 069c309dea1de0c942e95afe8112dda7d8b7dccded8034c2d11144f5e58b6e502495fae69e232eea8fa961ac5c7e6fa4740751f916af5706de60c798ce52c2e5
-  data.tar.gz: 63e95eb213397a8d0908c1fe0232af435b0a9de5d591ed93efdbaec9093d45615dc01b12807e7037442dbbe9020cd2e95901433b9a63e5509bacbeb73c422eb9
+  metadata.gz: 7cb2e525513591afec3878242ef25024a4798dde1522c32e9299cbfae899df7843537998c88ac5aa46ceb118b9f81243cc1aad2cd6bb64be930801c5e5b5a8df
+  data.tar.gz: 464f51d50728f652d3ce2f04582bf262ed79e90d572f32845d4ecc0720f9e088a108696c8f7b30c98472d127df3155ecedbd7c7fe8b91e77b160fe455769705e

data/README.md

@@ -114,20 +114,25 @@ class Policies::StringFormatPolicy
 end
 
 policy = Policies::StringFormatPolicy.new(string: "abc123")
-policy.successful?
+policy.obeyed?
 #=> false
 
+policy.violated?
+#=> true
+
 policy.violations
 #=> ["String must be alphanumeric", "Characters must be all uppercase"]
 ```
 
-By including the module, the object gets the `successful?` method which does the following when called:
+By including the module, the object gets the `obeyed?` method which does the following when called:
 
 1. Introspects all private predicate methods (methods that end with a question mark) and executes them
 2. If the method returns false, it looks for a translation in an I18n YAML file
 3. It composes an 118n key using the policy's class and method name (without the question mark). For example: `policies.mock_policy.violations.all_caps`  
 4. It adds the result of the translation to the list of `violations`
 5. It returns false if any violations are found
+
+The inverse method `violated?` for `obeyed?` is also included.
                                                                                                            
 An example I18n translation file looks like this:
                                                                                                            

data/lib/bizness/policy.rb

@@ -33,9 +33,12 @@
 # Example usage:
 #
 # policy = StringFormatPolicy.new("abcd")
-# policy.successful?
+# policy.obeyed?
 # => false
 #
+# policy.violated?
+# => true
+#
 # policy.violations
 # => ["Must be an uppercase string"]
 #
@@ -48,7 +51,7 @@ module Bizness::Policy
     @violations || []
   end
 
-  def successful?
+  def obeyed?
     self.violations = []
     self.class.__requirements__.each do |m|
       self.violations << self.class.violation_message(m) unless send(m)
@@ -56,6 +59,10 @@ module Bizness::Policy
     violations.empty?
   end
 
+  def violated?
+    !obeyed?
+  end
+
   module ClassMethods
     def violation_message(method)
       message_key = "#{__violation_key_prefix__}.#{method.to_s.delete("?")}"

data/lib/bizness/version.rb

@@ -1,3 +1,3 @@
 module Bizness
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bizness
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - ShippingEasy