ergane 0.0.1 → 0.2.0

data/lib/ergane/tool.rb

@@ -1,116 +1,70 @@
-module Ergane
-  class Tool < CommandDefinition
-    attr_reader :title #capitalized :label
-    attr_reader :version
+# frozen_string_literal: true
 
-    def initialize(label, *paths)
-      super(label)
+module Ergane
+  class Tool < Command
+    self.abstract_class = true
 
-      @title = label.capitalize
-      @version = VERSION
+    class << self
+      extend DSL::Macros
 
-      # Dogfood-ing
-      define do
-        description "Basic CLI Tool"
-        switches do
-          switch :help, default: false, kind: TrueClass, description: "Display this help block" do
-            raise Help
-          end
-          switch :version, default: false, kind: TrueClass, description: "Display the version" do
-            # TODO: Push ARGV into a variable at the command level that can be manipulated by flags/switches
-            # NOTE: This would allow a --version to morph into a version command and we could push all this logic to that.
-            # Additional logic for --version would be -1 or --short etc.
-            puts "#{@title} Version: #{Ergane::VERSION}"
-            exit
-          end
-          # switch verbose: FalseClass, short: :v, "Turn on verbose logging"
-        end
+      dsl_value :version
 
-        run do
-          begin
-            command, args = self, []
-            Process.setproctitle(label.to_s)
-            command, args = self.parse_args(ARGV.dup)
-
-            command.run(*args)
-            puts "Finished running #{label}"
-          rescue Interrupt
-            puts "\nOkay. Aborting."
-          rescue RuntimeError
-            puts "RuntimeError"
-            binding.pry
-          rescue Help
-            puts help(command, args)
-          ensure
-            system "printf '\033]0;\007'"
-          end
+      def command_class(klass = nil)
+        if klass
+          @command_class = klass
+          wire_command_class(klass)
+        else
+          @command_class
         end
       end
 
-      Pry.config.prompt_name = "#{title} ".light_blue
+      def tool_name(name = nil)
+        name ? (self.command_name = name) : command_name
+      end
 
-      load_commands(paths)
-    end
+      def start(argv = ARGV)
+        Runner.new(self, argv.dup).execute
+      rescue Interrupt
+        $stderr.puts "\nAborted."
+        exit 130
+      rescue Ergane::Error => e
+        $stderr.puts e.message
+        exit 1
+      end
 
-    def help(command, args=[])
-      missing_args = command.arguments.product([false]).to_h.merge(args.product([true]).to_h).map do |arg, is_missing|
-        a = arg.to_s.light_black.underline.tap do |b|
-          b.blink if is_missing
+      def load_commands(*patterns)
+        patterns.flatten.each do |pattern|
+          Dir[pattern].sort.each { |file| require file }
         end
-      end.join(' ')
+      end
 
-      command.switch_parser.banner = [].tap do |text|
-        text << "About: #{description}"
-        text << "Version:  #{version.to_s.light_blue}"
-        text << "Usage: #{([label] + chain).join(' ').light_red} #{'[options]'.light_cyan} "
-        if commands.any?
-          text.last << "[subcommand]".light_black.underline
-          text << ("    ┌" + ("─" * (text.last.uncolorize.length - 12)) + "┘").light_black
-          commands.each do |key, command|
-            # text << "    ├─┐".light_black + " #{(klass.terms.join(', ')).ljust(24, ' ')} ".send(Athena::Util.next_color) + klass.description.light_black
-            text << "    ├─┐".light_black + " #{key.to_s.ljust(24, ' ')} " + command.description.light_black
-          end
-          text << ("    └" + "─" * 64).light_black
-        else
-          # text.last << command.arguments(missing_args.keys)
-        end
-        # text << list_examples if examples.any?
-        text << "Options:".light_cyan
-      end.join("\n")
-      switch_parser
-    end
+      def inherited(subclass)
+        super
+        create_command_base(subclass) if self == Tool
+      end
 
-    def self.define(label, chain: [], &block)
-      c = CommandDefinition.define(label, chain: chain, &block)
+      private
 
-      parent_command = if chain.any?
-        Ergane.active_tool.dig(*chain)
-      else
-        Ergane.active_tool
+      def command_base_for(_name)
+        command_class || self
       end
 
-      parent_command[label] = c
-    end
+      def create_command_base(tool_subclass)
+        return if tool_subclass.command_class
 
-    def load_commands(paths)
-      activate_tool do
-        Ergane.logger.debug "Loading paths:"
-        Array.wrap(paths).each do |path|
-          Ergane.logger.debug "  - #{path}"
-          Dir[path].each do |path|
-            file = path.split('/').last
-            Ergane.logger.debug "  - loading #{path.split('/').last(4).join('/')}"
-            instance_eval(File.read(path), file)
-          end
-        end
+        base = Class.new(Ergane::Command)
+        base.abstract_class = true
+        tool_subclass.const_set(:Command, base)
+        tool_subclass.command_class(base)
       end
-    end
-
-    private
 
-    def activate_tool(&block)
-      Ergane.activate_tool(self, &block)
+      # Gives the tool's command base (and everything below it) a reference
+      # back to the tool, so Command#registration_target can route
+      # subcommands to the tool's registry.
+      def wire_command_class(klass)
+        tool = self
+        klass.define_singleton_method(:tool) { tool }
+      end
     end
-
   end
 end

data/lib/ergane/util/formatting.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Ergane
+  module Util
+    module Formatting
+      extend self
+
+      COLORS = %i[light_red light_yellow light_green light_blue light_cyan light_magenta].freeze
+
+      def color_cycle
+        @color_cycle ||= COLORS.cycle
+      end
+
+      def next_color
+        color_cycle.next
+      end
+
+      def reset_colors!
+        @color_cycle = COLORS.cycle
+      end
+
+      def rainbow(string, delimiter = " ")
+        string.split(delimiter).map { |word| word.to_s.send(next_color) }.join(delimiter)
+      end
+
+      def colorize_list(items)
+        items.map { |item| item.to_s.send(next_color) }
+      end
+    end
+  end
+end

data/lib/ergane/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ergane
-  VERSION = '0.0.1'
+  VERSION = "0.2.0"
 end

data/lib/ergane.rb

@@ -1,85 +1,40 @@
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_support/dependencies'
-require 'optparse'
-require 'colorize'
-require 'notifier'
-require 'pry-byebug'
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path("#{__dir__}/ergane")
+require "zeitwerk"
+require "optparse"
+require "colorize"
 
-require 'ergane/version'
-require 'ergane/command_definition'
-require 'ergane/tool'
+# Eager-loaded (not autoloadable by convention)
+require_relative "ergane/errors"
+require_relative "ergane/core_ext/string"
+require_relative "ergane/core_ext/object"
+require_relative "ergane/core_ext/array"
+require_relative "ergane/core_ext/hash"
+require_relative "ergane/core_ext/option_parser"
 
 module Ergane
-
-  Help = Class.new(StandardError)
-  Interrupt = Class.new(StandardError)
-
-  class << self
-    attr_reader :logger
-
-    def root(*args)
-      (@root ||= Pathname.new(File.expand_path('../', __dir__))).join(*args)
-    end
-
-    def logger
-      @logger ||= Logger.new($stdout).tap do |log|
-        log.progname = @@active_tool&.title || self.name
-        log.level = :warn
-      end
-    end
-
-    # def debug(string)
-    #   old_level = logger.level
-    #   logger.level = :debug if $debug
-    #   logger.debug(string)
-    # ensure
-    #   logger.level = old_level
-    # end
-
-    @@active_tool = nil
-
-    def active_tool
-      @@active_tool
-    end
-
-    def activate_tool(tool)
-      previous_tool = @@active_tool
-      @@active_tool = tool
-      yield if block_given?
-    ensure
-      @@active_tool = previous_tool
-    end
-
-    def notify(message, title: nil, sound: nil, icon: nil, group: nil)
-      cmd = ['terminal-notifier']
-      cmd << "-group #{Process.pid}#{group}"
-      cmd << "-title #{active_tool.label}"
-      cmd << "-subtitle #{title}" if title
-      cmd << "-appIcon 'assets/athena md-light-shadow.png'" if icon
-      cmd << "-message '#{message}'"
-      cmd << "-activate 'com.apple.Terminal'" # if macos
-      cmd << "-sound #{sound}" if sound
-      Thread.new { `afplay /System/Library/Sounds/#{sound == true ? 'Blow' : sound}.aiff` } unless sound == false
-
-      `#{cmd.join(' ')}`
-      # Notifier.notify(title: title, message: message, image: 'assets/athena md-light-shadow.png')
-    end
-
-    # Show a list of available extensions to use
-    def extensions
-      Extension.library
-    end
+  LOADER = Zeitwerk::Loader.new.tap do |loader|
+    loader.tag = "ergane"
+    loader.inflector.inflect(
+      "dsl" => "DSL",
+      "command_dsl" => "CommandDSL",
+      "block_dsl" => "BlockDSL"
+    )
+    loader.push_dir(File.expand_path("..", __FILE__))
+    loader.ignore(File.expand_path("ergane/errors.rb", __dir__))
+    loader.ignore(File.expand_path("ergane/core_ext", __dir__))
+    loader.ignore(File.expand_path("ergane.rb", __dir__))
+    loader.setup
   end
-end
 
-if ARGV.include?('--debug')
-  $debug = true
-  Ergane.logger.level = :debug
-end
+  def self.root
+    @root ||= Pathname.new(File.expand_path("../..", __FILE__))
+  end
 
-Dir[Ergane.root('lib', 'core_ext', "*.rb")].each do |path|
-  require path
+  # The shared registry of path-prefix abbreviations used by
+  # Command#abbreviate_path. Seeded with $HOME → "~"; consumers may
+  # register additional substitutions.
+  def self.paths
+    @paths ||= PathRegistry.new.register("~", "~")
+  end
 end

metadata

@@ -1,65 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: ergane
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dale Stevens
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: terminal-notifier
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: notifier
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -73,7 +58,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,105 +66,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: ruby-prof
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.50'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: simplecov-json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 description: |
-  Library for creating lightweight, yet powerful CLI tools in Ruby.
-  Emphasis and priority on load speed and flexibility.
+  A lightweight, powerful CLI framework for Ruby. Define commands using
+  class inheritance or block DSL — both produce the same command tree.
+  An alternative to Thor with a cleaner, more Ruby-native design.
 email:
 - dale@twilightcoders.net
-executables:
-- ergane
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- app/commands/ergane/console.rb
-- bin/ergane
-- lib/core_ext/option_parser.rb
 - lib/ergane.rb
-- lib/ergane/command_definition.rb
-- lib/ergane/debug.rb
-- lib/ergane/helpers/hashall.rb
-- lib/ergane/switch_definition.rb
+- lib/ergane/argument_definition.rb
+- lib/ergane/command.rb
+- lib/ergane/concerns/inheritance.rb
+- lib/ergane/concerns/option_handling.rb
+- lib/ergane/core_ext/array.rb
+- lib/ergane/core_ext/hash.rb
+- lib/ergane/core_ext/object.rb
+- lib/ergane/core_ext/option_parser.rb
+- lib/ergane/core_ext/string.rb
+- lib/ergane/dsl/block_dsl.rb
+- lib/ergane/dsl/command_dsl.rb
+- lib/ergane/dsl/macros.rb
+- lib/ergane/errors.rb
+- lib/ergane/formatter.rb
+- lib/ergane/help_formatter.rb
+- lib/ergane/option_definition.rb
+- lib/ergane/path_registry.rb
+- lib/ergane/runner.rb
 - lib/ergane/tool.rb
-- lib/ergane/util.rb
+- lib/ergane/util/formatting.rb
 - lib/ergane/version.rb
 homepage: https://github.com/TwilightCoders/ergane
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
-post_install_message:
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/TwilightCoders/ergane
+  changelog_uri: https://github.com/TwilightCoders/ergane/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -187,15 +184,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Ergane — The patron goddess of craftsmen and artisans
+summary: Ergane — a CLI framework forged for mortals
 test_files: []

data/app/commands/ergane/console.rb

@@ -1,22 +0,0 @@
-define :console do
-
-  description "Jump into an interactive REPL console"
-
-  requirements inherit: true do
-    require 'colorize'
-
-  end
-
-  switches(inherit: false) do
-    # option(:help, description: "display help")
-  end
-
-  run do
-    Pry.config.prompt_name = "#{Process.argv0.split('/').last.capitalize} #{label} ".light_blue
-    Pry.start
-  end
-
-  def support_method
-
-  end
-end

data/bin/ergane

@@ -1,24 +0,0 @@
-#!/usr/bin/env ruby
-
-profile = nil
-if ARGV.include?('--profile')
-  require 'ruby-prof'
-  profile = RubyProf::Profile.new
-  profile.exclude_common_methods!
-  profile.start
-end
-
-require 'bundler/setup'
-require 'ergane'
-require 'ergane/tool'
-
-tool = Ergane::Tool.new :ergane, 'lib/ergane/commands/**/*.rb', 'app/**/commands/**/*.rb'
-tool.run
-
-if profile
-  result = profile.stop
-  File.open "profile-graph.html", 'w+' do |file|
-    # RubyProf::GraphHtmlPrinter.new(results).print(file)
-    RubyProf::CallStackPrinter.new(result).print(file)
-  end
-end

data/lib/core_ext/option_parser.rb

@@ -1,15 +0,0 @@
-class OptionParser
-
-  # Like order!, but leave any unrecognized --switches alone
-  def order_recognized!(args)
-    extra_opts = []
-    begin
-      order!(args) { |a| extra_opts << a }
-    rescue OptionParser::InvalidOption => e
-      extra_opts << e.args[0]
-      retry
-    end
-    args[0, 0] = extra_opts
-  end
-
-end