mandate 0.1.0 → 0.4.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ab8741425fa1f9095c3eebf35e5a613cfda2838
-  data.tar.gz: ae13f53731aad90ae41f1021cfdabe15b0757a0e
+SHA256:
+  metadata.gz: b09d224e7ec0f4d9b2f7c3b4e15a87a2f28afb4447391172b8cb7c400d9d3a1f
+  data.tar.gz: bf5866603824cb3ee5702476c04759bee58a263606265642dacd92f7b89f5abe
 SHA512:
-  metadata.gz: 49e945ea25eb6e058fb1636cc6dabaf83c88cfe25ae5f8ce7bf133e495dfdc428af0162b40af08d25ace04f41cc259b4f1b552f91d013f0a30e36b0ab8fb1519
-  data.tar.gz: 5b8e3f2ba24641cedcc8666d089dd6ff127b65e0f66077862bc3685bb7ed4839cbcca10f4dfd6bbb17e4f2be32a3af12ad260dbfb6ffaad2090a33adb19a0814
+  metadata.gz: f71376313ee4ebe4409a16a1b2bfe394a6b7c847e6ca3c93e633614f36adc8a7845cf8a0191365e03da77c65e3a7c413e93e771d5e811d1ef4b6c3e0657db866
+  data.tar.gz: c1f28ac5099779f02b1d57712d9dabd27df43be73ba1bd7032ff1d2d1098683f3170da39abf1ea07030f54948f77dae914958880cacc8cd508fb91c6f6a05a1d

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+*.gem

data/CHANGELOG.md

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

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Thalamus AI Ltd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -25,11 +25,7 @@ Or install it yourself as:
 class Multiplies
   include Mandate
 
-  attr_reader :number_1, :number_2
-  def initialize(number_1, number_2)
-    @number_1 = number_1
-    @number_2 = number_2
-  end
+  initialize_with :number_1, :number_2
 
   def call
     do_the_maths
@@ -48,6 +44,68 @@ Multiplies.(20, 3)
 # => 60
 ```
 
+### `initialize_with`
+
+The `initialize_with` method creates an initializer and private attr_readers for the specified variables.
+
+For example `initialize_with :foo, :bar` is the equivalent of:
+
+```ruby
+def initialize(foo, bar)
+  @foo = foo
+  @bar = bar
+end
+
+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.
@@ -56,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

@@ -1,10 +1,13 @@
 require "mandate/version"
 require "mandate/memoize"
 require "mandate/call_injector"
+require "mandate/initializer_injector"
+require "mandate/callbacks"
 
 module Mandate
   def self.included(base)
     base.extend(Memoize)
     base.extend(CallInjector)
+    base.extend(InitializerInjector)
   end
 end

data/lib/mandate/call_injector.rb

@@ -1,9 +1,21 @@
 module Mandate
   module CallInjector
     def self.extended(base)
+      # Defining call allows us to do use the syntax:
+      #   Foobar.(some, args)
+      # which internally calls:
+      #   Foobar.new(some, args).call()
       class << base
         def call(*args)
-          new(*args).call
+          # If the last argument is a hash and the last param is a keyword params (signified by 
+          # its type being :key, the we should pass the hash in in using the **kwords syntax.
+          # This fixes a deprecation issue in Ruby 2.7.
+          if args.last.is_a?(Hash) && 
+            :key == instance_method(:initialize).parameters.last&.first
+            new(*args[0..-2], **args[-1]).call
+          else
+            new(*args).call
+          end
         end
       end
     end

data/lib/mandate/callbacks.rb

@@ -0,0 +1,91 @@
+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
+
+      base.send(:define_method, :add_error!) do |error|
+        @__mandate_results.add_error(error)
+      end
+      base.send(:private, :add_error!)
+
+      base.send(:define_method, :abort!) do |error = nil|
+        add_error!(error) if error
+        raise AbortError
+      end
+      base.send(:private, :abort!)
+
+      base.send(:define_method, :abort_if_errored!) do
+        raise AbortError if @__mandate_results.errors.size > 0
+      end
+      base.send(:private, :abort_if_errored!)
+    end
+  end
+end

data/lib/mandate/initializer_injector.rb

@@ -0,0 +1,55 @@
+module Mandate
+  module InitializerInjector
+    def self.extended(base)
+      class << base
+        def initialize_with(*attrs, **kwattrs)
+          if kwattrs.empty?
+            define_method :initialize do |*args|
+              unless args.length == attrs.length
+                raise ArgumentError.new("wrong number of arguments (given #{args.length}, expected #{attrs.length})")
+              end
+
+              attrs.zip(args).each do |attr,arg|
+                instance_variable_set("@#{attr}", arg)
+              end
+            end
+          else
+            define_method :initialize do |*args, **kwargs|
+              unless args.length == attrs.length
+                raise ArgumentError.new("wrong number of arguments (given #{args.length}, expected #{attrs.length})")
+              end
+
+              attrs.zip(args).each do |attr,arg|
+                instance_variable_set("@#{attr}", arg)
+              end
+
+              kwargs.each do |name,value|
+                if kwattrs.keys.include?(name)
+                  instance_variable_set("@#{name}", value)
+                else
+                  raise ArgumentError.new("unknown keyword: #{name}")
+                end
+              end
+            end
+          end
+
+          attrs.each do |attr|
+            define_method attr do instance_variable_get("@#{attr}") end
+            private attr
+          end
+
+          kwattrs.each do |attr,default|
+            define_method attr do
+              if instance_variable_defined?("@#{attr}")
+                instance_variable_get("@#{attr}")
+              else
+                default
+              end
+            end
+            private attr
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mandate/memoize.rb

@@ -1,15 +1,35 @@
 module Mandate
   module Memoize
+
+    # This method is called on the line before a
+    # define statement. It puts mandate into memoizing mode
     def memoize
       @__mandate_memoizing = true
     end
 
+    # Intercept a method being added.
+    # Create the method as normal, then if we are in
+    # memoize mode, call out to the memozie function and
+    # reset out of memozing mode.
     def method_added(method_name)
       super
-      return unless @__mandate_memoizing
 
+      if instance_variable_defined?("@__mandate_memoizing") && @__mandate_memoizing
+        __mandate_memoize(method_name)
+        @__mandate_memoizing = false
+      end
+    end
+
+    # Create an anonymous module that defines a method
+    # with the same name as main method being defined.
+    # Add some memoize code to check whether the method
+    # has been previously called or not. If it's not
+    # been then call the underlying method and store the result.
+    #
+    # We then prepend this module so that its method
+    # comes first in the method-lookup chain.
+    def __mandate_memoize(method_name)
       memoizer = Module.new do
-        p method_name
         define_method method_name do
           @__mandate_memoized_results ||= {}
 
@@ -20,10 +40,7 @@ module Mandate
           end
         end
       end
-
       prepend memoizer
-
-      @__mandate_memoizing = false
     end
   end
 end

data/lib/mandate/version.rb

@@ -1,3 +1,3 @@
 module Mandate
-  VERSION = "0.1.0"
+  VERSION = "0.4.0.beta.1"
 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)/})
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0.beta.1
 platform: ruby
 authors:
 - Jeremy Walker
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -62,21 +62,25 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- LICENCE
 - README.md
 - Rakefile
 - bin/console
 - 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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,14 +91,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A simple command-pattern helper gem for Ruby
 test_files: []
-has_rdoc: