commande 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d25e8ec7120ae92efec0d9213a85eb7406ba2cae
-  data.tar.gz: 511b45c1ca6eb7d0b9f45a2322cc1c8e41f74e73
+SHA256:
+  metadata.gz: 5334f1b703da19aebef8ef78454df5c22b1579200e4c6081849f1838c9590e09
+  data.tar.gz: 19e06efbfed90cf386054ac5c012f023e21f50f6ed770e88cabfb06544798195
 SHA512:
-  metadata.gz: 5866e974388a65b94f57d4b053db322734f68090e71c438b6f47ffd20440625ceb9e205cd2a8628f94c6424f5b61b58469d35697d842b75a869be9e49f98aa07
-  data.tar.gz: 602a9ffdd2b80d1c18cc3cef9702ce6bea0e230928c421151389bfaadd7aca264214cf6d75db2dc4dca4be658d0d33ddfd49f6e2d9680b4fdd8e7903386ce3a8
+  metadata.gz: '0392aa643a831494eb0ff6cfc1dbc9bd07b282a9a6d0394ee4d1d0a6c1d7eaa430b517a4baac6424f885ab7ed17da93525c6acef75e2c2ba6af14b64dbad822a'
+  data.tar.gz: 356fe5f2f6d97beecd770f11dfe7ba3cad4f4f4705786c1f4fb9a349cab2ec3492ac855b11ae09a82c0e7d1dedc42193a14fad5a9e1d58ebf72e1ce8785ed1fa

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.4.0
+- Add `Chain` for command chaining
+
 ## 0.3.1
 - Alias `output` as `outputs`
 

data/README.md

@@ -78,6 +78,61 @@ result.successful? # => false
 result.fetched # => nil
 ```
 
+### Chaining
+
+If you opt-in to chaining `require 'commande/chain'`, you can create a call chain that chains multiple `Commande`. The
+only limitation is that you can _only_ use named arguments. This is to ensure breakage on unexpected output, name
+mismatches and collisions.
+
+```ruby
+require 'command'
+require 'command/chain'
+
+class StartCommand
+  include Commande
+
+  output :foo, :baz
+
+  def valid?(test:)
+    error! 'test must at least be 3' if test < 3
+
+    true
+  end
+
+  def call(test:)
+    self.foo = 'foo' * test
+    self.not_an_output = 'not_an_output'
+  end
+
+  private
+
+  attr_accessor :foo, :baz, :not_an_output
+end
+
+class SecondCommand
+  include Commande
+
+  output :result
+
+  def call(foo:, **_opts)
+    self.result = foo
+  end
+
+  private
+
+  attr_accessor :result
+end
+
+chained = Chain.new(StartCommand, SecondCommand).call(test: 3)
+# => result is successful, and output matches `SecondCommand`
+chained.chain_result.result
+# => 'foofoofoo'
+
+boomed = Chain.new(StartCommand, SecondCommand).call(test: 2) 
+# => boomed has failed, and output matches nil
+boomed.error
+# => 'test must at least be 3'
+```
 ## Testing
 
 There are some `Minitest` assertions included in this library.

data/commande.gemspec

@@ -1,44 +1,44 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'commande/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'commande'
-  spec.version       = Commande::VERSION
-  spec.authors       = ['Derk-Jan Karrenbeld']
-  spec.email         = ['derk-jan+github@karrenbeld.info']
-
-  spec.summary       = 'Allows for Command pattern style POROs'
-  spec.license       = 'MIT'
-
-  spec.metadata = {
-    'bug_tracker_uri'   => 'https://github.com/SleeplessByte/command/issues',
-    'changelog_uri'     => 'https://github.com/SleeplessByte/command/CHANGELOG.md',
-    'homepage_uri'      => 'https://github.com/SleeplessByte/command',
-    'source_code_uri'   => 'https://github.com/SleeplessByte/command'
-  }
-
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = 'https://gems.sleeplessbyte.technology'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-end
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'commande/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'commande'
+  spec.version       = Commande::VERSION
+  spec.authors       = ['Derk-Jan Karrenbeld']
+  spec.email         = ['derk-jan+github@karrenbeld.info']
+
+  spec.summary       = 'Allows for Command pattern style POROs'
+  spec.license       = 'MIT'
+
+  spec.metadata = {
+    'bug_tracker_uri'   => 'https://github.com/SleeplessByte/command/issues',
+    'changelog_uri'     => 'https://github.com/SleeplessByte/command/CHANGELOG.md',
+    'homepage_uri'      => 'https://github.com/SleeplessByte/command',
+    'source_code_uri'   => 'https://github.com/SleeplessByte/command'
+  }
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'https://gems.sleeplessbyte.technology'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+end

data/lib/command/chain.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'commande/chain'

data/lib/command/minitest.rb

@@ -1,5 +1,3 @@
 # frozen_string_literal: true
 
-require 'command/minitest/assertions/assert_successful'
-require 'command/minitest/assertions/assert_valid'
-require 'command/minitest/assertions/assert_with_error'
+require 'commande/minitest/'

data/lib/commande/chain.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Commande
+  class Chain
+    include Commande
+
+    output :chain_result
+
+    def initialize(*commands)
+      self.commands = commands
+    end
+
+    def chain(*commands)
+      new(*self.commands, *commands)
+    end
+
+    def valid(**_args)
+      error! 'needs at least one command' if commands.empty?
+
+      true
+    end
+
+    def call(**args)
+      self.chain_result = commands.inject(InitialCommandResult.new(args)) do |last_result, current_command|
+        current_result = current_command.call(**last_result.payload.dup)
+
+        transfer_logs current_result
+        transfer_errors current_result
+
+        fail! unless transfer_success? current_result
+        current_result
+      end
+    end
+
+    private
+
+    attr_accessor :commands, :chain_result
+
+    class InitialCommandResult
+      def initialize(**args)
+        self.payload = args
+      end
+
+      attr_reader :payload
+
+      private
+
+      attr_writer :payload
+    end
+  end
+end

data/lib/commande/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Commande
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/lib/commande.rb

@@ -360,7 +360,7 @@ module Commande
     source.valid? && source.persisted?
   end
 
-  def transfer_errors(source, header:)
+  def transfer_errors(source, header: nil)
     errors = source.errors
     errors = source.errors.full_messages if errors.respond_to?(:full_messages)
     Array(errors).each do |e|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: commande
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Derk-Jan Karrenbeld
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-24 00:00:00.000000000 Z
+date: 2019-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     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'
 description: 
 email:
 - derk-jan+github@karrenbeld.info
@@ -72,11 +72,13 @@ files:
 - bin/setup
 - commande.gemspec
 - lib/command.rb
+- lib/command/chain.rb
 - lib/command/minitest.rb
 - lib/command/minitest/assertions/assert_successful.rb
 - lib/command/minitest/assertions/assert_valid.rb
 - lib/command/minitest/assertions/assert_with_error.rb
 - lib/commande.rb
+- lib/commande/chain.rb
 - lib/commande/minitest.rb
 - lib/commande/minitest/assertions/assert_successful.rb
 - lib/commande/minitest/assertions/assert_valid.rb
@@ -106,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Allows for Command pattern style POROs