hanami-cli 0.0.0 → 0.1.0.beta1

data/lib/hanami/cli/registry.rb

@@ -0,0 +1,122 @@
+require "hanami/cli/command_registry"
+
+module Hanami
+  class CLI
+    # Registry mixin
+    #
+    # @since 0.1.0
+    module Registry
+      # @since 0.1.0
+      # @api private
+      def self.extended(base)
+        base.class_eval do
+          @commands = CommandRegistry.new
+        end
+      end
+
+      # Register a command
+      #
+      # @param name [String] the command name
+      # @param command [NilClass,Hanami::CLI::Command] the optional command
+      # @param aliases [Array<String>] an optional list of aliases
+      # @param options [Hash] a set of options
+      #
+      # @since 0.1.0
+      #
+      # @example Register a command
+      #   require "hanami/cli"
+      #
+      #   module Foo
+      #     module Commands
+      #       extend Hanami::CLI::Registry
+      #
+      #       class Hello < Hanami::CLI::Command
+      #       end
+      #
+      #       register "hi", Hello
+      #     end
+      #   end
+      #
+      # @example Register a command with aliases
+      #   require "hanami/cli"
+      #
+      #   module Foo
+      #     module Commands
+      #       extend Hanami::CLI::Registry
+      #
+      #       class Hello < Hanami::CLI::Command
+      #       end
+      #
+      #       register "hello", Hello, aliases: ["hi", "ciao"]
+      #     end
+      #   end
+      #
+      # @example Register a group of commands
+      #   require "hanami/cli"
+      #
+      #   module Foo
+      #     module Commands
+      #       extend Hanami::CLI::Registry
+      #
+      #       module Generate
+      #         class App < Hanami::CLI::Command
+      #         end
+      #
+      #         class Action < Hanami::CLI::Command
+      #         end
+      #       end
+      #
+      #       register "generate", aliases: ["g"] do |prefix|
+      #         prefix.register "app",    Generate::App
+      #         prefix.register "action", Generate::Action
+      #       end
+      #     end
+      #   end
+      def register(name, command = nil, aliases: [], **options)
+        if block_given?
+          yield Prefix.new(@commands, name, aliases)
+        else
+          @commands.set(name, command, aliases, **options)
+        end
+      end
+
+      # @since 0.1.0
+      # @api private
+      def get(arguments)
+        @commands.get(arguments)
+      end
+
+      # Command name prefix
+      #
+      # @since 0.1.0
+      class Prefix
+        # @since 0.1.0
+        # @api private
+        def initialize(registry, prefix, aliases)
+          @registry = registry
+          @prefix   = prefix
+
+          registry.set(prefix, nil, aliases)
+        end
+
+        # @since 0.1.0
+        #
+        # @see Hanami::CLI::Registry#register
+        def register(name, command, aliases: [], **options)
+          command_name = "#{prefix} #{name}"
+          registry.set(command_name, command, aliases, **options)
+        end
+
+        private
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :registry
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :prefix
+      end
+    end
+  end
+end

data/lib/hanami/cli/usage.rb

@@ -0,0 +1,88 @@
+require "hanami/cli/program_name"
+
+module Hanami
+  class CLI
+    # Command(s) usage
+    #
+    # @since 0.1.0
+    # @api private
+    module Usage
+      # @since 0.1.0
+      # @api private
+      SUBCOMMAND_BANNER = " [SUBCOMMAND]".freeze
+
+      # @since 0.1.0
+      # @api private
+      def self.call(result, out)
+        out.puts "Commands:"
+        max_length, commands = commands_and_arguments(result)
+
+        commands.each do |banner, node|
+          usage = description(node.command) if node.leaf?
+          out.puts "#{justify(banner, max_length, usage)}#{usage}"
+        end
+      end
+
+      # @since 0.1.0
+      # @api private
+      def self.commands_and_arguments(result) # rubocop:disable Metrics/MethodLength
+        max_length = 0
+        ret        = commands(result).each_with_object({}) do |(name, node), memo|
+          args = if node.leaf?
+                   arguments(node.command)
+                 else
+                   SUBCOMMAND_BANNER
+                 end
+
+          partial       = "  #{command_name(result, name)}#{args}"
+          max_length    = partial.bytesize if max_length < partial.bytesize
+          memo[partial] = node
+        end
+
+        [max_length, ret]
+      end
+
+      # @since 0.1.0
+      # @api private
+      def self.arguments(command) # rubocop:disable Metrics/AbcSize
+        return unless CLI.command?(command)
+
+        required_arguments = command.required_arguments
+        optional_arguments = command.optional_arguments
+
+        required = required_arguments.map { |arg| arg.name.upcase }.join(' ') if required_arguments.any?
+        optional = optional_arguments.map { |arg| "[#{arg.name.upcase}]" }.join(' ') if optional_arguments.any?
+        result = [required, optional].compact
+
+        " #{result.join(' ')}" unless result.empty?
+      end
+
+      # @since 0.1.0
+      # @api private
+      def self.description(command)
+        return unless CLI.command?(command)
+
+        " # #{command.description}" unless command.description.nil?
+      end
+
+      # @since 0.1.0
+      # @api private
+      def self.justify(string, padding, usage)
+        return string.chomp(" ") if usage.nil?
+        string.ljust(padding + padding / 2)
+      end
+
+      # @since 0.1.0
+      # @api private
+      def self.commands(result)
+        result.children.sort_by { |name, _| name }
+      end
+
+      # @since 0.1.0
+      # @api private
+      def self.command_name(result, name)
+        ProgramName.call([result.names, name])
+      end
+    end
+  end
+end

data/lib/hanami/cli/version.rb

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

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: hanami-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-08-11 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.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0.beta1
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 description: Hanami framework to build command line interfaces with Ruby
 email:
 - me@lucaguidi.com
@@ -46,6 +88,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - README.md
 - Rakefile
@@ -53,9 +98,18 @@ files:
 - bin/setup
 - hanami-cli.gemspec
 - lib/hanami/cli.rb
+- lib/hanami/cli/banner.rb
+- lib/hanami/cli/command.rb
+- lib/hanami/cli/command_registry.rb
+- lib/hanami/cli/option.rb
+- lib/hanami/cli/parser.rb
+- lib/hanami/cli/program_name.rb
+- lib/hanami/cli/registry.rb
+- lib/hanami/cli/usage.rb
 - lib/hanami/cli/version.rb
 homepage: http://hanamirb.org
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org
 post_install_message: 
@@ -69,9 +123,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.6.11