bizness 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5763645a9f422b6ffffcd1c7d2479e5e90d954ee
-  data.tar.gz: 544d347d96ca56f02295460f2a81b66450b03bfa
+  metadata.gz: b714a39badf727a99d3bdc0c66d973cefba362b6
+  data.tar.gz: 44a55bee700c1836c0ede38fa362e5a83f51d5e2
 SHA512:
-  metadata.gz: 47de010ec86cd7ab359631bff52169b20de0a43418f066947b555b0bc1e726b3913f42390a486d54d9358fc200241e2c643b8d8311ecf80843b99c28dfa96590
-  data.tar.gz: 385b68bd06eeaacba49548a8d51caad440b23eda8892f6d7b7aff251d95e58389c72804f3d339dfd326fa089605dd97135be2bf4c3a6ff801be16e6f89b963a8
+  metadata.gz: 142c588c8ce88f7116812c104b5259d3d3eb3916d3bfcd2edba351a0a7669650576a5ff1284c6a85d0cc0f3c09f999ffc8651493aacc8bf816d8459f97c0ec4c
+  data.tar.gz: 7cb79a4e410349489b9fbeb906536d13bee55b3825142271fa914eabc9d65d421d8d4d13c8367f11927580a14ebd2c378e25f3a3fe7c6a526c0642dd75eda1b6

data/README.md

@@ -1,6 +1,6 @@
 # Bizness
 
-Get your bizness right and organize your business logic into operations.
+Get your bizness right and organize your business logic into operations and policies.
 
 ## Installation
 
@@ -29,8 +29,8 @@ ShippingEasy adopted this strategy, but we opted to use the term Operation rathe
 
 As we wrote more and more operations, some insights emerged:
 
-  1. We always ran an operation in a transaction
-  2. An operation nearly always corresponded to an important system event ("Complete Registration")
+  1. We almost always ran an operation in a transaction
+  2. An operation often corresponded to an important system event ("Complete Registration")
   3. Logging these events into a dashboard like Kibana could provide us with valuable metrics and insight into how our system was performing at a business logic level
 
 Bizness, therefore, allows you to create PORO operation objects and easily augment their business logic execution via a series of filters. Out of the box there are filters to wrap every operation in a transaction as well as automatically broadcasting every operation as a series of events.
@@ -88,21 +88,23 @@ op.to_h
 
 Operations are expected to run to completion, otherwise a runtime error should be raised. Before executing an operation, you should generally ensure that the object or objects being operated against pass a certain set of criteria.
 
-We typically wrap this set of criteria in a Policy object, and if the object passes the policy we kick off the operation. You can call this policy during input validation and return the violations to the end user. However, we also like to use the policy object inside the operation as a final guard before running the operation. If the policy fails, we raise a runtime exception containing the list of violations.
+We typically wrap this set of criteria in a Policy object, and if the object passes the policy we kick off the operation. You can also call this policy during input validation (for example, in a Form object) and return the violations to the end user. However, we also like to use the policy object inside the operation as a final guard before running the operation. If the policy fails, we raise a runtime exception containing the list of violations.
 
 Since this is such a common pattern, we created the `Bizness::Policy` module. Here's an example:
 
 ```ruby
 class Policies::StringFormatPolicy
   include Bizness::Policy
-
-  attr_reader :string
+  
+  policy_enforces :alphanumeric?, :all_caps?
 
   def initialize(string:)
     @string = string
   end
 
   private
+  
+  attr_reader :string
 
   def alphanumeric?
     string.match(/^[[:alpha:]]+$/)
@@ -126,7 +128,7 @@ policy.violations
 
 By including the module, the object gets the `violated?` (and `obeyed?`) method which does the following when called:
 
-1. Introspects all private predicate methods (methods that end with a question mark) and executes them
+1. Executes the methods listed via the `policy_enforces` macro
 2. If the method returns false, it looks for a translation in an I18n YAML file
 3. It composes an I18n 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`

data/lib/bizness/filters/event_filter.rb

@@ -10,7 +10,9 @@ module Bizness::Filters
 
     def evented_call
       result = filtered_operation.call
-      Hey.publish!("#{event_name}#{delimiter}#{successful? ? "succeeded" : "failed"}", payload(result))
+      event_status = (respond_to?(:successful?) && !successful?) ? "failed" : "succeeded"
+      Hey.publish!("#{event_name}#{delimiter}#{event_status}", payload(result))
+      result
     rescue Exception => e
       Hey.publish!("#{event_name}#{delimiter}aborted", payload.merge(error: e.message, stacktrace: e.backtrace, exception: e.class.name))
       raise e

data/lib/bizness/version.rb

@@ -1,3 +1,3 @@
 module Bizness
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bizness
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - ShippingEasy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2016-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Get your bizness right and organize your business logic into operations.