hanami-cli 0.1.1 → 0.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2637f9e319848200c09ef2c4722edf57a1c98c6bafed69d8ec2a9e1102cbd79
-  data.tar.gz: c68a7b04d298ee216ad0ea019ede253ab4bc16726f8e72b9efcde209edef68bc
+  metadata.gz: a068faee4ac4b225d048b6552c2f3c996dcebaeb2c4b45e7496882bd1633507b
+  data.tar.gz: 51c34e8bd8306949cf344507bbf906a7876e47d5d39a26b70e94ad78e4191f0f
 SHA512:
-  metadata.gz: 0c8efe76cf2730a6a7275c635a338d7f44b1df691cd7930372caefc5693a4925676ef0a1f05057d00e9a8e1c1c89b721d55cc377dcd2bb1af3fe666dbc57c99c
-  data.tar.gz: 12b1afc361a418e06670da8c40e4ce2e6eb38bc68c32d584a7a80c5b85ef5a67f696fa2ae42fcb53734a4124664a9138ac4fd72a13c314c22df4a999d578673f
+  metadata.gz: 5c5817a42a314f553bc42b24f04e9a574e44efae82d462721ff9c27bb37ab4ef3c9096156a6166e94ce11728d1e6f0e4a009b8feb3e48e0a670e034e3e5c6d16
+  data.tar.gz: 349d5bcc6d5214feb852a01cbf57a185a8448072f1590e6160a4878cb550a80361c7abbec463cd787ed621c80046322351ec67d611f59f19ac2423ba4beb3176

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Hanami::CLI
 General purpose Command Line Interface (CLI) framework for Ruby
 
+## v0.2.0.beta1 - 2018-02-28
+### Added
+- [Anton Davydov] Register `before`/`after` callbacks for commands
+
 ## v0.1.1 - 2018-02-27
 ### Added
 - [Luca Guidi] Official support for Ruby: MRI 2.5

data/Gemfile

@@ -6,6 +6,6 @@ unless ENV['TRAVIS']
   gem 'yard',   require: false
 end
 
-gem 'hanami-utils', '~> 1.1', require: false, git: 'https://github.com/hanami/utils.git', branch: '1.1.x'
+gem 'hanami-utils', '1.2.0.beta1', require: false, git: 'https://github.com/hanami/utils.git', branch: 'develop'
 
 gem 'hanami-devtools', require: false, git: 'https://github.com/hanami/devtools.git'

data/README.md

@@ -25,6 +25,7 @@ General purpose Command Line Interface (CLI) framework for Ruby.
     - [Subcommands](#subcommands-1)
     - [Aliases](#aliases)
     - [Subcommand aliases](#subcommand-aliases)
+    - [Callbacks](#callbacks)
   - [Development](#development)
   - [Contributing](#contributing)
   - [Alternatives](#alternatives)
@@ -451,6 +452,52 @@ Commands:
 generated configuration
 ```
 
+### Callbacks
+
+Third party gems can register _before_ and _after_ callbacks to enhance a command.
+
+From the `foo` gem we have a command `hello`.
+
+```ruby
+#!/usr/bin/env ruby
+require "hanami/cli"
+
+module Foo
+  module CLI
+    module Commands
+      extend Hanami::CLI::Registry
+
+      class Hello < Hanami::CLI::Command
+        argument :name, required: true
+
+        def call(name:, **)
+          puts "hello #{name}"
+        end
+      end
+    end
+  end
+end
+
+Foo::CLI::Commands.register "hello", Foo::CLI::Commands::Hello
+
+cli = Hanami::CLI.new(Foo::CLI::Commands)
+cli.call
+```
+
+The `foo-bar` gem enhances `hello` command with callbacks:
+
+```
+Foo::CLI::Commands.before("hello") { |args| puts "debug: #{args.inspect}" } # syntax 1
+Foo::CLI::Commands.after "hello", &->(args) { puts "bye, #{args.fetch(:name)}" } # syntax 2
+```
+
+```shell
+% foo hello Anton
+debug: {:name=>"Anton"}
+hello Anton
+bye, Anton
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/hanami-cli.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.add_dependency "hanami-utils",    "~> 1.1"
+  spec.add_dependency "hanami-utils",    "1.2.0.beta1"
   spec.add_dependency "concurrent-ruby", "~> 1.0"
 
   spec.add_development_dependency "bundler"

data/lib/hanami/cli.rb

@@ -7,6 +7,7 @@ module Hanami
   # @since 0.1.0
   class CLI
     require "hanami/cli/version"
+    require "hanami/cli/errors"
     require "hanami/cli/command"
     require "hanami/cli/registry"
     require "hanami/cli/parser"
@@ -51,7 +52,10 @@ module Hanami
 
       if result.found?
         command, args = parse(result, out)
+
+        result.before_callbacks.run(self, args)
         command.call(args)
+        result.after_callbacks.run(self, args)
       else
         usage(result, out)
       end

data/lib/hanami/cli/command.rb

@@ -1,6 +1,6 @@
 require "forwardable"
-require "hanami/cli/option"
 require "concurrent/array"
+require "hanami/cli/option"
 
 module Hanami
   class CLI

data/lib/hanami/cli/command_registry.rb

@@ -1,4 +1,5 @@
 require "concurrent/hash"
+require 'hanami/utils/callbacks'
 
 module Hanami
   class CLI
@@ -96,6 +97,14 @@ module Hanami
         # @api private
         attr_reader :command
 
+        # @since 0.1.0
+        # @api private
+        attr_reader :before_callbacks
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :after_callbacks
+
         # @since 0.1.0
         # @api private
         def initialize(parent = nil)
@@ -103,6 +112,9 @@ module Hanami
           @children = Concurrent::Hash.new
           @aliases  = Concurrent::Hash.new
           @command  = nil
+
+          @before_callbacks = Utils::Callbacks::Chain.new
+          @after_callbacks = Utils::Callbacks::Chain.new
         end
 
         # @since 0.1.0
@@ -183,6 +195,18 @@ module Hanami
         def command
           @node.command
         end
+
+        # @since 0.2.0
+        # @api private
+        def before_callbacks
+          @node.before_callbacks
+        end
+
+        # @since 0.2.0
+        # @api private
+        def after_callbacks
+          @node.after_callbacks
+        end
       end
     end
   end

data/lib/hanami/cli/errors.rb

@@ -0,0 +1,16 @@
+module Hanami
+  class CLI
+    # @since 0.2.0
+    class Error < StandardError
+    end
+
+    # @since 0.2.0
+    class UnkwnownCommandError < Error
+      # @since 0.2.0
+      # @api private
+      def initialize(command_name)
+        super("unknown command: `#{command_name}'")
+      end
+    end
+  end
+end

data/lib/hanami/cli/registry.rb

@@ -80,12 +80,84 @@ module Hanami
         end
       end
 
+      # Register a before callback.
+      #
+      # @param command_name [String] the name used for command registration
+      # @param callback [Proc] the callback
+      #
+      # @raise [Hanami::CLI::UnkwnownCommandError] if the command isn't registered
+      #
+      # @since 0.2.0
+      #
+      # @example
+      #   require "hanami/cli"
+      #
+      #   module Foo
+      #     module Commands
+      #       extend Hanami::CLI::Registry
+      #
+      #       class Hello < Hanami::CLI::Command
+      #         def call(*)
+      #           puts "hello"
+      #         end
+      #       end
+      #
+      #       register "hello", Hello
+      #       before "hello", -> { puts "I'm about to say.." }
+      #     end
+      #   end
+      def before(command_name, &callback)
+        command(command_name).before_callbacks.append(&callback)
+      end
+
+      # Register an after callback.
+      #
+      # @param command_name [String] the name used for command registration
+      # @param callback [Proc] the callback
+      #
+      # @raise [Hanami::CLI::UnkwnownCommandError] if the command isn't registered
+      #
+      # @since 0.2.0
+      #
+      # @example
+      #   require "hanami/cli"
+      #
+      #   module Foo
+      #     module Commands
+      #       extend Hanami::CLI::Registry
+      #
+      #       class Hello < Hanami::CLI::Command
+      #         def call(*)
+      #           puts "hello"
+      #         end
+      #       end
+      #
+      #       register "hello", Hello
+      #       after "hello", -> { puts "world" }
+      #     end
+      #   end
+      def after(command_name, &callback)
+        command(command_name).after_callbacks.append(&callback)
+      end
+
       # @since 0.1.0
       # @api private
       def get(arguments)
         @commands.get(arguments)
       end
 
+      private
+
+      COMMAND_NAME_SEPARATOR = " ".freeze
+
+      # @since 0.2.0
+      # @api private
+      def command(command_name)
+        get(command_name.split(COMMAND_NAME_SEPARATOR)).tap do |result|
+          raise UnkwnownCommandError.new(command_name) unless result.found?
+        end
+      end
+
       # Command name prefix
       #
       # @since 0.1.0

data/lib/hanami/cli/version.rb

@@ -1,6 +1,6 @@
 module Hanami
   class CLI
     # @since 0.1.0
-    VERSION = "0.1.1".freeze
+    VERSION = "0.2.0.beta1".freeze
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hanami-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-27 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ files:
 - lib/hanami/cli/banner.rb
 - lib/hanami/cli/command.rb
 - lib/hanami/cli/command_registry.rb
+- lib/hanami/cli/errors.rb
 - lib/hanami/cli/option.rb
 - lib/hanami/cli/parser.rb
 - lib/hanami/cli/program_name.rb
@@ -126,9 +127,9 @@ 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.7.5