hanami-cli 0.0.0 → 0.1.0.beta1

data/lib/hanami/cli/command_registry.rb

@@ -0,0 +1,184 @@
+require "concurrent/hash"
+
+module Hanami
+  class CLI
+    # Command registry
+    #
+    # @since 0.1.0
+    # @api private
+    class CommandRegistry
+      # @since 0.1.0
+      # @api private
+      def initialize
+        @root = Node.new
+      end
+
+      # @since 0.1.0
+      # @api private
+      def set(name, command, aliases, **options)
+        node = @root
+        command = command_for(name, command, **options)
+        name.split(/[[:space:]]/).each do |token|
+          node = node.put(node, token)
+        end
+
+        node.aliases!(aliases)
+        node.leaf!(command) unless command.nil?
+
+        nil
+      end
+
+      # @since 0.1.0
+      # @api private
+      def get(arguments)
+        node   = @root
+        args   = []
+        names  = []
+        result = LookupResult.new(node, args, names, node.leaf?)
+
+        arguments.each_with_index do |token, i|
+          tmp = node.lookup(token)
+
+          if tmp.nil?
+            result = LookupResult.new(node, args, names, false)
+            break
+          elsif tmp.leaf?
+            args   = arguments[i + 1..-1]
+            names  = arguments[0..i]
+            node   = tmp
+            result = LookupResult.new(node, args, names, true)
+            break
+          else
+            names  = arguments[0..i]
+            node   = tmp
+            result = LookupResult.new(node, args, names, node.leaf?)
+          end
+        end
+
+        result
+      end
+
+      private
+
+      # @since 0.1.0
+      # @api private
+      def command_for(name, command, **options)
+        if command.nil?
+          command
+        else
+          command.new(command_name: name, **options)
+        end
+      end
+
+      # Node of the registry
+      #
+      # @since 0.1.0
+      # @api private
+      class Node
+        # @since 0.1.0
+        # @api private
+        attr_reader :parent
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :children
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :aliases
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :command
+
+        # @since 0.1.0
+        # @api private
+        def initialize(parent = nil)
+          @parent   = parent
+          @children = Concurrent::Hash.new
+          @aliases  = Concurrent::Hash.new
+          @command  = nil
+        end
+
+        # @since 0.1.0
+        # @api private
+        def put(parent, key)
+          children[key] ||= self.class.new(parent)
+        end
+
+        # @since 0.1.0
+        # @api private
+        def lookup(token)
+          children[token] || aliases[token]
+        end
+
+        # @since 0.1.0
+        # @api private
+        def leaf!(command)
+          @command = command
+        end
+
+        # @since 0.1.0
+        # @api private
+        def alias!(key, child)
+          @aliases[key] = child
+        end
+
+        # @since 0.1.0
+        # @api private
+        def aliases!(aliases)
+          aliases.each do |a|
+            parent.alias!(a, self)
+          end
+        end
+
+        # @since 0.1.0
+        # @api private
+        def leaf?
+          !command.nil?
+        end
+      end
+
+      # Result of a registry lookup
+      #
+      # @since 0.1.0
+      # @api private
+      class LookupResult
+        # @since 0.1.0
+        # @api private
+        attr_reader :names
+
+        # @since 0.1.0
+        # @api private
+        attr_reader :arguments
+
+        # @since 0.1.0
+        # @api private
+        def initialize(node, arguments, names, found)
+          @node      = node
+          @arguments = arguments
+          @names     = names
+          @found     = found
+        end
+
+        # @since 0.1.0
+        # @api private
+        def found?
+          @found
+        end
+
+        # @since 0.1.0
+        # @api private
+        def children
+          @node.children
+        end
+
+        # @since 0.1.0
+        # @api private
+        def command
+          @node.command
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/option.rb

@@ -0,0 +1,125 @@
+require "hanami/utils/string"
+
+module Hanami
+  class CLI
+    # Command line option
+    #
+    # @since 0.1.0
+    # @api private
+    class Option
+      # @since 0.1.0
+      # @api private
+      attr_reader :name
+
+      # @since 0.1.0
+      # @api private
+      attr_reader :options
+
+      # @since 0.1.0
+      # @api private
+      def initialize(name, options = {})
+        @name = name
+        @options = options
+      end
+
+      # @since 0.1.0
+      # @api private
+      def aliases
+        options[:aliases] || []
+      end
+
+      # @since 0.1.0
+      # @api private
+      def desc
+        desc = options[:desc]
+        values ? "#{desc}: (#{values.join('/')})" : desc
+      end
+
+      # @since 0.1.0
+      # @api private
+      def required?
+        options[:required]
+      end
+
+      # @since 0.1.0
+      # @api private
+      def type
+        options[:type]
+      end
+
+      # @since 0.1.0
+      # @api private
+      def values
+        options[:values]
+      end
+
+      # @since 0.1.0
+      # @api private
+      def boolean?
+        type == :boolean
+      end
+
+      # @since 0.1.0
+      # @api private
+      def default
+        options[:default]
+      end
+
+      # @since 0.1.0
+      # @api private
+      def description_name
+        options[:label] || name.upcase
+      end
+
+      # @since 0.1.0
+      # @api private
+      def argument?
+        false
+      end
+
+      # @since 0.1.0
+      # @api private
+      #
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def parser_options
+        dasherized_name = Hanami::Utils::String.dasherize(name)
+        parser_options  = []
+
+        if type == :boolean
+          parser_options << "--[no-]#{dasherized_name}"
+        else
+          parser_options << "--#{dasherized_name}=#{name}"
+          parser_options << "--#{dasherized_name} #{name}"
+        end
+
+        parser_options << values if values
+        parser_options.unshift(alias_name) unless alias_name.nil?
+        parser_options << desc if desc
+        parser_options
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      # @since 0.1.0
+      # @api private
+      def alias_name
+        aliases.join(" ") if aliases.any?
+      end
+    end
+
+    # Command line argument
+    #
+    # @since 0.1.0
+    # @api private
+    class Argument < Option
+      # @since 0.1.0
+      # @api private
+      def argument?
+        true
+      end
+    end
+  end
+end

data/lib/hanami/cli/parser.rb

@@ -0,0 +1,123 @@
+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/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def self.call(command, arguments, names)
+        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.dup)
+
+        parsed_options = command.default_params.merge(parsed_options)
+        parse_required_params(command, arguments, names, parsed_options)
+      rescue ::OptionParser::ParseError
+        return Result.failure
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable 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)
+        parse_params = Hash[command.arguments.map(&:name).zip(arguments)]
+        parse_required_params = Hash[command.required_arguments.map(&:name).zip(arguments)]
+        all_required_params_satisfied = command.required_arguments.all? { |param| !parse_required_params[param.name].nil? }
+
+        unless all_required_params_satisfied
+          parse_required_params_values = parse_required_params.values.compact
+
+          usage = "\nUsage: \"#{full_command_name(names)} #{command.required_arguments.map(&:description_name).join(' ')}\""
+
+          if parse_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 #{parse_required_params_values}#{usage}")
+          end
+        end
+
+        Result.success(parse_params.merge(parsed_options))
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      # @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

@@ -0,0 +1,19 @@
+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