mandate 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e2c86ccab594b7a9c1df7a455ab4949c36f23b9face3e07b91beab615398ded
-  data.tar.gz: 64fa8dbae3945ff3b5dc4fe7d5a1118dc4d64745351a3213a8297eedcebc2144
+  metadata.gz: 941eb8ffe29c4078c8137e331db4b798e856f3bb746b6a988a835c5010d5a5c7
+  data.tar.gz: 34ce742d20c88fb3cecde1f624268f47192113f17be3606ad42bff6d90c4b04b
 SHA512:
-  metadata.gz: e06458866a07824be2b0901778cd0f65b73a0b33458de8e92995028c7a2720e906f29dfc3b7c17ffb0b7d79d3bfb6c5669caceba730610eee729f53f2e5803fc
-  data.tar.gz: 007c3108ec701f6571ba7ea051d9c1933dc1dbe7645ccfd543a7173c43e9f29b428c12705726e776a1825df4bbfd58d3305983cb76b5b17639c0ffa19630c425
+  metadata.gz: 56b303c59f85575ad40b296682db47a97969631fd0611b2f536b665ad388981d218d5ca06c0ba5dfe2f8d25016bd57c1e8ed74ab889d32f6ab41d9d28b15db7b
+  data.tar.gz: e4d0917116cfb2a5dd346ded9db25c3f2ba5367913c9f9595dcea08bf3bff5e15fb85a1b8b74575886a8d2e2690c056f1795bf74e9a9de9f534265d7c0475d91

data/CHANGELOG.md

@@ -1,2 +1,5 @@
+# 0.3.0 / 2019-09-06
+* [FEATURE] Add success/failure callbacks
+
 # 0.2.0 / 2018-08-11
 * [FEATURE] Add initialize_with

data/README.md

@@ -48,9 +48,9 @@ Multiplies.(20, 3)
 
 The `initialize_with` method creates an initializer and private attr_readers for the specified variables.
 
-For example `initialize_with :foo, :bar` is the equivelent of:
+For example `initialize_with :foo, :bar` is the equivalent of:
 
-```
+```ruby
 def initialize(foo, bar)
   @foo = foo
   @bar = bar
@@ -60,6 +60,52 @@ private
 attr_reader :foo, :bar
 ```
 
+### Using on_success/on_failure callbacks
+
+Sometimes it is helpful for the class to return on_success/on_failure callbacks rather than just the resulting value.
+This can be achieved by including the `Mandate::Callbacks` module as follows:
+
+```ruby
+class Sumer
+  include Mandate
+  include Mandate::Callbacks
+
+  initialize_with :num1, :num2
+
+  def call
+    abort!("num1 must be an Integer") unless num1.is_a?(Integer)
+    abort!("num2 must be an Integer") unless num2.is_a?(Integer)
+
+    num1 + num2
+  end
+end
+
+res = Sumer.(1,2)
+res.on_success { |result| p result } # puts 3
+res.on_failure { |errors| p errors } # Noop
+res.succeeded? # true
+res.result # 3
+res.errors # []
+
+res = Sumer.("1","2")
+res.on_success { |result| p result } # Noop
+res.on_failure { |errors| p errors } # puts ["num1 must be an Integer"]
+
+res = Sumer.("1","2")
+res.on_failure { |errors| p errors } # puts ["num1 must be an Integer", "num2 must be an Integer"]
+res.errors # ["num1 must be an Integer", "num2 must be an Integer"]
+```
+
+It is also possible to chain methods, for example:
+
+```ruby
+Sumer.(1,2).
+  on_success { |result| p result }.
+  on_failure { |errors| p errors }
+```
+
+The `succeeded?` method is also aliased as `success?`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -68,4 +114,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ThalamusAI/mandate.
+Bug reports and pull requests are welcome on GitHub at https://github.com/iHiD/mandate.

data/lib/mandate.rb

@@ -2,6 +2,7 @@ require "mandate/version"
 require "mandate/memoize"
 require "mandate/call_injector"
 require "mandate/initializer_injector"
+require "mandate/callbacks"
 
 module Mandate
   def self.included(base)

data/lib/mandate/callbacks.rb

@@ -0,0 +1,90 @@
+module Mandate
+  module Callbacks
+    class AbortError < RuntimeError
+    end
+
+    class Results
+      attr_reader :result, :errors
+
+      def initialize
+        @succeeded = false
+        @errors = []
+      end
+
+      def succeeded!(result)
+        @result = result
+        @succeeded = true
+      end
+
+      def add_error(error)
+        errors << error
+      end
+
+      def succeeded?
+        !!succeeded
+      end
+      alias_method :success?, :succeeded?
+
+      def on_success(&block)
+        block.call(result) if succeeded?
+        self
+      end
+
+      def on_failure(&block)
+        block.call(errors) unless succeeded?
+        self
+      end
+
+      private
+      attr_reader :succeeded
+    end
+
+    def self.included(base)
+      # Override self.call to call the internal call_with_callbacks
+      # function which returns a method with on_success/on_failure callbacks
+      class << base
+        # Remove the existing created by the "include Mandate"
+        remove_method(:call)
+
+        # Define a new call methods which calls the instance call
+        # method but with the added callbacks needed for on_success/on_failure
+        def call(*args)
+          new(*args).call_with_callbacks
+        end
+      end
+
+      base.extend(Callbacks)
+    end
+
+    def self.extended(base)
+      base.send(:define_method, :call_with_callbacks) do
+        begin
+          # Create results object
+          @__mandate_results = Results.new
+
+          # Run the actual command
+          # If call fails, succeeded! will never get called
+          @__mandate_results.succeeded!(call)
+        rescue AbortError
+        end
+
+        @__mandate_results
+      end
+
+      private
+
+      base.send(:define_method, :add_error!) do |error|
+        @__mandate_results.add_error(error)
+      end
+
+      base.send(:define_method, :abort!) do |error = nil|
+        add_error!(error) if error
+        raise AbortError
+      end
+
+      base.send(:define_method, :abort_if_errored!) do
+        raise AbortError if @__mandate_results.errors.size > 0
+      end
+    end
+  end
+end

data/lib/mandate/version.rb

@@ -1,3 +1,3 @@
 module Mandate
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/mandate.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A simple command-pattern helper gem for Ruby}
   spec.description   = %q{This Ruby Gem adds functionality for the command pattern in Ruby, and for memoization.}
-  spec.homepage      = "https://github.com/thalamusai/mandate"
+  spec.homepage      = "https://github.com/iHiD/mandate"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandate
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jeremy Walker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-13 00:00:00.000000000 Z
+date: 2019-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,11 +71,12 @@ files:
 - bin/setup
 - lib/mandate.rb
 - lib/mandate/call_injector.rb
+- lib/mandate/callbacks.rb
 - lib/mandate/initializer_injector.rb
 - lib/mandate/memoize.rb
 - lib/mandate/version.rb
 - mandate.gemspec
-homepage: https://github.com/thalamusai/mandate
+homepage: https://github.com/iHiD/mandate
 licenses:
 - MIT
 metadata: {}
@@ -94,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple command-pattern helper gem for Ruby