hanami-cli 0.3.0 → 2.0.0.alpha3

data/lib/hanami/cli/parser.rb

@@ -1,142 +0,0 @@
-require "optparse"
-require "hanami/cli/program_name"
-
-module Hanami
-  class CLI
-    # Parse command line arguments and options
-    #
-    # @since 0.1.0
-    # @api private
-    module Parser
-      # @since 0.1.0
-      # @api private
-      #
-      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      def self.call(command, arguments, names)
-        original_arguments = arguments.dup
-        parsed_options = {}
-
-        OptionParser.new do |opts|
-          command.options.each do |option|
-            opts.on(*option.parser_options) do |value|
-              parsed_options[option.name.to_sym] = value
-            end
-          end
-
-          opts.on_tail("-h", "--help") do
-            return Result.help
-          end
-        end.parse!(arguments)
-
-        parsed_options = command.default_params.merge(parsed_options)
-        parse_required_params(command, arguments, names, parsed_options)
-      rescue ::OptionParser::ParseError
-        Result.failure("Error: \"#{command.command_name}\" was called with arguments \"#{original_arguments.join(' ')}\"")
-      end
-      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
-
-      # @since 0.1.0
-      # @api private
-      def self.full_command_name(names)
-        ProgramName.call(names)
-      end
-
-      # @since 0.1.0
-      # @api private
-      #
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/MethodLength
-      def self.parse_required_params(command, arguments, names, parsed_options)
-        parsed_params          = match_arguments(command.arguments, arguments)
-        parsed_required_params = match_arguments(command.required_arguments, arguments)
-        all_required_params_satisfied = command.required_arguments.all? { |param| !parsed_required_params[param.name].nil? }
-
-        unused_arguments = arguments.drop(command.required_arguments.length)
-
-        unless all_required_params_satisfied
-          parsed_required_params_values = parsed_required_params.values.compact
-
-          usage = "\nUsage: \"#{full_command_name(names)} #{command.required_arguments.map(&:description_name).join(' ')}\""
-
-          if parsed_required_params_values.empty? # rubocop:disable Style/GuardClause
-            return Result.failure("ERROR: \"#{full_command_name(names)}\" was called with no arguments#{usage}")
-          else
-            return Result.failure("ERROR: \"#{full_command_name(names)}\" was called with arguments #{parsed_required_params_values}#{usage}")
-          end
-        end
-
-        parsed_params.reject! { |_key, value| value.nil? }
-        parsed_options = parsed_options.merge(parsed_params)
-        parsed_options = parsed_options.merge(args: unused_arguments) if unused_arguments.any?
-        Result.success(parsed_options)
-      end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
-
-      def self.match_arguments(command_arguments, arguments)
-        result = {}
-
-        command_arguments.each_with_index do |cmd_arg, index|
-          if cmd_arg.array?
-            result[cmd_arg.name] = arguments[index..-1]
-            break
-          else
-            result[cmd_arg.name] = arguments.at(index)
-          end
-        end
-
-        result
-      end
-
-      # @since 0.1.0
-      # @api private
-      class Result
-        # @since 0.1.0
-        # @api private
-        def self.help
-          new(help: true)
-        end
-
-        # @since 0.1.0
-        # @api private
-        def self.success(arguments = {})
-          new(arguments: arguments)
-        end
-
-        # @since 0.1.0
-        # @api private
-        def self.failure(error = "Error: Invalid param provided")
-          new(error: error)
-        end
-
-        # @since 0.1.0
-        # @api private
-        attr_reader :arguments
-
-        # @since 0.1.0
-        # @api private
-        attr_reader :error
-
-        # @since 0.1.0
-        # @api private
-        def initialize(arguments: {}, error: nil, help: false)
-          @arguments = arguments
-          @error     = error
-          @help      = help
-        end
-
-        # @since 0.1.0
-        # @api private
-        def error?
-          !error.nil?
-        end
-
-        # @since 0.1.0
-        # @api private
-        def help?
-          @help
-        end
-      end
-    end
-  end
-end

data/lib/hanami/cli/program_name.rb

@@ -1,19 +0,0 @@
-module Hanami
-  class CLI
-    # Program name
-    #
-    # @since 0.1.0
-    # @api private
-    module ProgramName
-      # @since 0.1.0
-      # @api private
-      SEPARATOR = " ".freeze
-
-      # @since 0.1.0
-      # @api private
-      def self.call(names = [], program_name: $PROGRAM_NAME)
-        [File.basename(program_name), names].flatten.join(SEPARATOR)
-      end
-    end
-  end
-end

data/lib/hanami/cli/registry.rb

@@ -1,328 +0,0 @@
-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
-
-      # Register a before callback.
-      #
-      # @param command_name [String] the name used for command registration
-      # @param callback [Class, #call] the callback object. If a class is given,
-      #   it MUST respond to `#call`.
-      # @param blk [Proc] the callback espressed as a block
-      #
-      # @raise [Hanami::CLI::UnknownCommandError] if the command isn't registered
-      # @raise [Hanami::CLI::InvalidCallbackError] if the given callback doesn't
-      #   implement the required interface
-      #
-      # @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
-      #
-      # @example Register an object as callback
-      #   require "hanami/cli"
-      #
-      #   module Callbacks
-      #     class Hello
-      #       def call(*)
-      #         puts "world"
-      #       end
-      #     end
-      #   end
-      #
-      #   module Foo
-      #     module Commands
-      #       extend Hanami::CLI::Registry
-      #
-      #       class Hello < Hanami::CLI::Command
-      #         def call(*)
-      #           puts "I'm about to say.."
-      #         end
-      #       end
-      #
-      #       register "hello", Hello
-      #       before "hello", Callbacks::Hello.new
-      #     end
-      #   end
-      #
-      # @example Register a class as callback
-      #   require "hanami/cli"
-      #
-      #   module Callbacks
-      #     class Hello
-      #       def call(*)
-      #         puts "world"
-      #       end
-      #     end
-      #   end
-      #
-      #   module Foo
-      #     module Commands
-      #       extend Hanami::CLI::Registry
-      #
-      #       class Hello < Hanami::CLI::Command
-      #         def call(*)
-      #           puts "I'm about to say.."
-      #         end
-      #       end
-      #
-      #       register "hello", Hello
-      #       before "hello", Callbacks::Hello
-      #     end
-      #   end
-      def before(command_name, callback = nil, &blk)
-        command(command_name).before_callbacks.append(&_callback(callback, blk))
-      end
-
-      # Register an after callback.
-      #
-      # @param command_name [String] the name used for command registration
-      # @param callback [Class, #call] the callback object. If a class is given,
-      #   it MUST respond to `#call`.
-      # @param blk [Proc] the callback espressed as a block
-      #
-      # @raise [Hanami::CLI::UnknownCommandError] if the command isn't registered
-      # @raise [Hanami::CLI::InvalidCallbackError] if the given callback doesn't
-      #   implement the required interface
-      #
-      # @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
-      #
-      # @example Register an object as callback
-      #   require "hanami/cli"
-      #
-      #   module Callbacks
-      #     class World
-      #       def call(*)
-      #         puts "world"
-      #       end
-      #     end
-      #   end
-      #
-      #   module Foo
-      #     module Commands
-      #       extend Hanami::CLI::Registry
-      #
-      #       class Hello < Hanami::CLI::Command
-      #         def call(*)
-      #           puts "hello"
-      #         end
-      #       end
-      #
-      #       register "hello", Hello
-      #       after "hello", Callbacks::World.new
-      #     end
-      #   end
-      #
-      # @example Register a class as callback
-      #   require "hanami/cli"
-      #
-      #   module Callbacks
-      #     class World
-      #       def call(*)
-      #         puts "world"
-      #       end
-      #     end
-      #   end
-      #
-      #   module Foo
-      #     module Commands
-      #       extend Hanami::CLI::Registry
-      #
-      #       class Hello < Hanami::CLI::Command
-      #         def call(*)
-      #           puts "hello"
-      #         end
-      #       end
-      #
-      #       register "hello", Hello
-      #       after "hello", Callbacks::World
-      #     end
-      #   end
-      def after(command_name, callback = nil, &blk)
-        command(command_name).after_callbacks.append(&_callback(callback, blk))
-      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 UnknownCommandError.new(command_name) unless result.found?
-        end
-      end
-
-      # @since 0.2.0
-      # @api private
-      #
-      # rubocop:disable Metrics/MethodLength
-      def _callback(callback, blk)
-        return blk if blk.respond_to?(:to_proc)
-
-        case callback
-        when ->(c) { c.respond_to?(:call) }
-          callback.method(:call)
-        when Class
-          begin
-            _callback(callback.new, blk)
-          rescue ArgumentError
-            raise InvalidCallbackError.new(callback)
-          end
-        else
-          raise InvalidCallbackError.new(callback)
-        end
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      # 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

@@ -1,89 +0,0 @@
-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/script/ci

@@ -1,61 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-prepare_build() {
-  if [ -d coverage ]; then
-    rm -rf coverage
-  fi
-}
-
-print_ruby_version() {
-  echo "Using $(ruby -v)"
-  echo
-}
-
-run_code_quality_checks() {
-  bundle exec rubocop .
-}
-
-run_unit_tests() {
-  bundle exec rake spec:unit
-}
-
-run_integration_tests() {
-  local pwd=$PWD
-  local root="$pwd/spec/integration"
-
-  for test in $(find $root -name '*_spec.rb')
-  do
-    run_test $test
-
-    if [ $? -ne 0 ]; then
-      local exit_code=$?
-      echo "Failing test: $test"
-      exit $exit_code
-    fi
-  done
-}
-
-run_test() {
-  local test=$1
-  local hash="$(shasum "$test" | cut -b 1-40)"
-
-  printf "\n\n\nRunning: $test\n"
-  SIMPLECOV_COMMAND_NAME=$hash bundle exec rspec $test
-}
-
-upload_code_coverage() {
-  bundle exec rake codecov:upload
-}
-
-main() {
-  prepare_build &&
-    print_ruby_version &&
-    run_code_quality_checks &&
-    run_unit_tests &&
-    run_integration_tests &&
-    upload_code_coverage
-}
-
-main