prezzo 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11bbbefd55c61e98dbbc825bd62914cf8c5db61e
-  data.tar.gz: 7e8964b2729124602136631ee8c7e7ae05880632
+  metadata.gz: af6eff6786cc37bdb7e4cca103f0eee8a7e2c5fa
+  data.tar.gz: fdbf73bbfe95b5328feb1b84db4c90db24b54b8c
 SHA512:
-  metadata.gz: 9766a2ecc37debfe6186f6ee7b5101458261391ea9b7ca0ceba6c4648bb0c2d51cae70db6d30752cf3506ed9ac6ca99c3d491b0085dccb048a1df44fb4d02e53
-  data.tar.gz: a106a37ad16a882536acad010229dfaa01e2b6c764173b90ca35458f742294d29ff98650693f8872f73562ec824a088c5c361283ccb259823704d549ceff564e
+  metadata.gz: 334ac63972f842fec450af16c3cbddd9037a283549e69c47ddbc20f7c26b592579c7dd9c7e976d87861c152c0b8955938eb78fb2e0b7d6145ec20c598e219f54
+  data.tar.gz: d1b24522f93fbd58093317165cfbf3f3e1dfc3ae7be0b2010899936613240f0c97b9b423dc63caa256fcaf2b6fb49bbc8825d5ac33844401c695e9e093f6422e

data/README.md

@@ -153,6 +153,84 @@ Uber::RidePriceCalculator.new(context).explain
 #=> { total: 25.6, components: { base_fare: 4.3, price_per_distance: 21.3 } }
 ```
 
+#### Multiline `explain_with`
+
+`explain_with` can be splitted into several lines.
+
+```ruby
+class RidePriceCalculator
+  include Prezzo::Explainable
+
+  explain_with :base_fare
+  explain_with :price_per_distance
+end
+```
+
+#### ` explain_with` with the `resursive: false` option
+
+```ruby
+class FooCalculator
+  include Prezzo::Calculator
+  include Prezzo::Explainable
+
+  explain_with :bar, :baz
+
+  def calculate
+    bar + baz
+  end
+
+  def bar
+    10
+  end
+
+  def baz
+    20
+  end
+end
+
+class QuxCalculator
+  include Prezzo::Calculator
+  include Prezzo::Composable
+  include Prezzo::Explainable
+
+  composed_by foo: FooCalculator
+
+  explain_with :foo, resursive: false
+
+  def calculate
+    foo + 5
+  end
+end
+```
+
+`QuxCalculator#explain` now produces
+
+```ruby
+{
+  total: 35,
+  components: {
+    foo: 30
+  }
+}
+```
+
+but not
+
+```ruby
+{
+  total: 35,
+  components: {
+    foo: {
+      total: 30,
+      components: {
+        bar: 10,
+        baz: 20
+      }
+    }
+  }
+}
+```
+
 Check the full [Uber pricing](/spec/integration/uber_pricing_spec.rb) for more complete example with many calculators and factors.
 
 ## Development

data/lib/prezzo/explainable.rb

@@ -7,27 +7,35 @@ module Prezzo
     end
 
     module ClassMethods
-      def explain_with(*component_names)
-        define_method(:explain) do
-          explanation = {
-            total: calculate,
-          }
+      def explain_with(*component_names, **options)
+        @explained_components ||= {}
+        component_names.each do |component_name|
+          @explained_components[component_name] = options
+        end
+      end
 
-          components = component_names.each_with_object({}) do |component, acc|
-            value = send(component)
-            if self.class.respond_to?(:components) && self.class.components.include?(component)
-              value = cached_components[component]
-            end
-            value = value.explain if value.respond_to?(:explain)
-            value = value.calculate if value.respond_to?(:calculate)
-            acc[component] = value
-          end
+      attr_reader :explained_components
+    end
 
-          explanation[:components] = components unless components.empty?
+    def explain
+      explained_components = self.class.explained_components || {}
 
-          explanation
+      explanation = {
+        total: calculate,
+        components: {},
+      }
+
+      explained_components.each do |component, options|
+        value = send(component)
+        if self.class.respond_to?(:components) && self.class.components.include?(component)
+          value = cached_components[component]
         end
+        value = value.explain if value.respond_to?(:explain) && options.fetch(:resursive, true)
+        value = value.calculate if value.respond_to?(:calculate)
+        explanation[:components][component] = value
       end
+
+      explanation
     end
   end
 end

data/lib/prezzo/version.rb

@@ -1,3 +1,3 @@
 module Prezzo
-  VERSION = "0.4.1".freeze
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prezzo
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Marcelo Boeira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-validations