ergane 0.0.1 → 0.1.0

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.1.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,118 @@ 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/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/debug.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'
+  homepage_uri: https://github.com/TwilightCoders/ergane
+  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 +185,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/ergane/command_definition.rb

@@ -1,176 +0,0 @@
-# IDEA: "switches" are just "inline commands".
-#       They share a similar structure to a command.
-#       They have a label, description, and optionally a "run block"
-
-require 'pry'
-require 'helpers/hashall'
-require 'switch_definition'
-
-module Ergane
-
-  class CommandDefinition < Hashall
-
-    attr_reader :label
-    attr_reader :chain
-    attr_reader :description
-    attr_reader :switch_definitions
-    attr_reader :switch_parser
-    attr_reader :requirements_block
-    attr_reader :run_block
-
-    def pretty_print(q)
-      q.text "#{self.class.name} (#{label})"
-      q.text "\n\tCommands:"
-      q.group(1, " {", "}") do
-        self.each_pair do |key, value|
-          q.breakable
-          q.text "#{key}: #{value}"
-        end
-      end
-    end
-
-    def run(*args)
-      if run_block
-        instance_exec(&requirements_block) if requirements_block
-        instance_exec(*args, &run_block) if run_block
-      else
-        puts "show help for this command"
-      end
-    end
-
-    def self.define(label, chain: [], &block)
-      new(label, *chain).tap do |c|
-        c.define(chain: chain, &block)
-      end
-    end
-
-    def define(chain: [], &block)
-      dsl_parse(&block)
-    end
-
-    def commands
-      self.to_h
-    end
-
-    def arguments
-      if commands.any?
-        commands.keys
-      else
-        instance_method(:run).parameters.map { |arg| arg[1] }
-      end
-    end
-
-    def default_switches
-      @default_switches ||= switch_definitions.inject({}) do |collector, (label, switch)|
-        collector[label] = switch.default
-        collector
-      end
-      @default_switches.dup
-    end
-
-    def parse_args(args, path = [])
-      if args.any? && args.first.match(/\A(\w+)\z/) && word = args.first.to_sym
-        case command = self[word]
-        when CommandDefinition
-          path << args.shift
-          command.parse_args(args, path)
-        else
-          puts "no such subcommand #{word} for #{self}"
-        end
-      else
-        # These are args for this command now.
-        Ergane.logger.debug "Now, process these args #{args} for #{label}"
-        switch_parser.order_recognized!(args)
-        [self, args || []]
-      end
-    end
-
-    protected
-
-    def dsl_parse(&block)
-      dsl = DSL.new.tap do |dsl|
-        dsl.instance_eval(&block)
-      end
-      @switch_definitions.merge!(dsl.config.delete(:switch_definitions))
-      dsl.config.each do |k, v|
-        begin
-          instance_variable_set("@#{k}", v)
-        rescue
-          binding.pry
-        end
-      end
-
-      switches = default_switches
-      switch_definitions.values.each do |o|
-        o.attach(@switch_parser, self) do |value|
-          value = case o.kind
-          when TrueClass
-            true
-          when FalseClass
-            false
-          else
-            value.nil? ? true : value
-          end
-          Ergane.logger.debug "Setting switches[#{o.label}] = #{value.inspect}"
-          switches[o.label] = value
-        end
-      end
-    end
-
-    private
-
-    def initialize(label, *chain)
-      super()
-      @chain = chain
-      @label = label
-      @switch_definitions = {}
-      @requirement_options = {
-        inherit: true
-      }
-      @run_options = {
-        inherit: true
-      }
-      @switch_parser = OptionParser.new
-    end
-
-    class DSL
-      attr_reader :config
-
-      def initialize
-        @config = {
-          switch_definitions: {},
-          run_block: nil,
-          requirements_block: nil
-        }
-      end
-
-      def method_missing(k, v)
-        @config[k] = v
-      end
-
-      def switches(inherit: true, drop: [], &block)
-        def option(label, short: nil, kind: nil, description: nil, default: nil, &block)
-          label, argument = case label
-            when Hash
-              [label.keys.first, "=#{label.values.first}"]
-            else
-              [label, nil]
-            end
-          warn "Warning! #{label.inspect} option is being redefined.".red if @config[:switch_definitions][label]
-          @config[:switch_definitions][label] = SwitchDefinition.new(label, argument: argument, short: short, kind: kind, description: description, default: default, &block)
-        end
-        block.call if block_given?
-        @config[:switch_definitions]
-      end
-
-      def requirements(options, &block)
-        @config[:requirements_block] = block
-      end
-
-      def run(&block)
-        # puts "setting run_block"
-        @config[:run_block] = block
-      end
-    end
-  end
-end

data/lib/ergane/debug.rb

@@ -1,75 +0,0 @@
-module Ergane
-  module Debug
-
-    class << self
-
-      @nl = false
-
-      def enable_break!
-        class << self
-          define_method(:break, &binding.method(:pry))
-        end
-      end
-
-      def suppress
-        original_stdout, original_stderr = $stdout.clone, $stderr.clone
-        $stderr.reopen File.new('/dev/null', 'w')
-        $stdout.reopen File.new('/dev/null', 'w')
-        yield
-      ensure
-        $stdout.reopen original_stdout
-        $stderr.reopen original_stderr
-      end
-
-      def break
-        puts "Breakpoints Not Enabled"
-      end
-
-      def format_print(m)
-        case m
-        when String
-          format_print(m.split("\n"))
-        when Array
-          m.join("\n\t")
-        else
-          m
-        end
-      end
-
-      def puts(m=nil, prefix: false, &block)
-        prefix ||= $debug ? 'DEBUG' : false
-        if (prefix)
-          if @nl || m.blank?
-            $stdout.puts format_print(m)
-          else
-            $stdout.print "[#{prefix.upcase.light_magenta}] " unless prefix.blank?
-            $stdout.puts format_print(m)
-          end
-        else
-          yield if block_given?
-        end
-        @nl = false
-      end
-
-      def print(m=nil, prefix: false, &block)
-        @nl = true
-        prefix ||= $debug ? 'DEBUG' : false
-        if (prefix)
-          if (m.blank?)
-            $stdout.print format_print(m)
-          else
-            $stdout.print "[#{prefix.upcase.light_magenta}] " unless prefix.blank?
-            $stdout.print format_print(m)
-          end
-        else
-          yield if block_given?
-        end
-      end
-
-    end
-
-    enable_break! if $debug
-
-  end
-
-end

data/lib/ergane/helpers/hashall.rb

@@ -1,8 +0,0 @@
-module Ergane
-  class Hashall < Hash
-    def initialize(*args)
-      super()
-      self.default_proc = -> (h, k) { h[k] = self.class.new(*args) }
-    end
-  end
-end