thor_enhance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29e06b1db0b1f965fc4896f15781ab95d11999a03b3c8d87d3bde9a7ce7505b4
-  data.tar.gz: 503883577bd91606b5007adecc6592077b571978abd02c017b7222144fb45c62
+  metadata.gz: b07825b4f1216de172d6ce7b7ec2052bccee6793c38ceca8b50f094bcbf3deae
+  data.tar.gz: 4458ad58f0148f4a77da324893a538e40c1def979eb26305cdb2e005afa500f7
 SHA512:
-  metadata.gz: 9640892f989be7e49445b89c5345b4993b29203bd0d58cf638244bb92f861154e11afa19408a4b69f6e09b828369c9d7fee55f81725639bf6cf8ef34c58ca1a0
-  data.tar.gz: a1dbc442d2a09e0aed8a50f08eee393e9b2a67624dea27629d4951d88472c060cbff102364a7953310d74af531fe75eb11bb680f1488a0faa62b023ab3717c0b
+  metadata.gz: a10dfebf316a1ad8a5c6b63a91f90b7fe95391b3f40379bbe37dcfd2e89f9cffe8d48a975fa147210a229376ec736927301eaa042def05a146960646ac0e81ba
+  data.tar.gz: 0d96db3833f42a605f7c341dd8a0a43788f1d447767df9d632a0950543bec63f05adc620b8c298b46184e44f236ac39692ecafe7cf857c091261ecda005e3031

data/.gitignore

@@ -13,3 +13,5 @@
 
 # generated gems
 *.gem
+
+spec/examples.txt

data/Gemfile.lock

@@ -1,27 +1,19 @@
 PATH
   remote: .
   specs:
-    thor_enhance (0.1.0)
-      class_composer
-      faraday
+    thor_enhance (0.2.0)
+      thor (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    base64 (0.2.0)
     byebug (11.1.3)
-    class_composer (1.0.2)
     coderay (1.1.3)
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
     faker (3.2.2)
       i18n (>= 1.8.11, < 2)
-    faraday (2.7.11)
-      base64
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
@@ -47,13 +39,13 @@ GEM
     rspec-support (3.12.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    ruby2_keywords (0.0.5)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    thor (1.3.0)
 
 PLATFORMS
   aarch64-linux

data/lib/thor_enhance/command.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ThorEnhance
+  module Command
+    def self.thor_enhance_injection!
+      return false unless ThorEnhance::Configuration.allow_changes?
+
+      # Create Thor::Command getter and setter methods -- Validation gets done on setting
+      ThorEnhance.configuration.command_method_enhance.each do |name, object|
+        define_method(name) { instance_variable_get("@#{name}") }
+        define_method("#{name}=") { instance_variable_set("@#{name}", _1) }
+      end
+
+      # Prepend it so we can call this run method first
+      ::Thor::Command.prepend ThorEnhance::CommandHook
+
+      ::Thor::Command.include ThorEnhance::Command
+    end
+  end
+end

data/lib/thor_enhance/command_hook.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ThorEnhance
+  module CommandHook
+    def run(instance, args = [])
+      raw_args = instance.instance_variable_get(:@_initializer)[1]
+      ThorEnhance::Configuration::HOOKERS.each do |hook|
+        object = ThorEnhance.configuration.option_enhance[hook]
+        # Iterate the options list based on each hook type
+        instance.options.each do |name, given_value|
+          option = options[name.to_s] || options[name.to_sym]
+          next if option.nil?
+
+          # If the hook exists on the method option, retreive it
+          # if not, move on
+          proclamation = option.send(hook)
+          next if proclamation.nil?
+
+          # if input tags is included in raw args, the user inputted the value
+          # hooks should only get called if the value was inputted
+          input_tags = [option.switch_name] + option.aliases
+          next unless input_tags.any? { raw_args.include?(_1) }
+
+          proc_value = proclamation.(given_value)
+
+          case object[:behavior]
+          when :raise
+            raise ThorEnhance::OptionDeprecated, "Passing value for option #{option.switch_name} is deprecated. Provided `#{given_value}`. #{proc_value}"
+          when :warn
+            Kernel.warn("WARNING: Provided `#{given_value}` for option #{option.switch_name}. #{proc_value}")
+          end
+        end
+      end
+
+      super
+    end
+  end
+end

data/lib/thor_enhance/command_method.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ThorEnhance
+  module CommandMethod
+
+    def self.thor_enhance_injection!
+      return false unless ThorEnhance::Configuration.allow_changes?
+
+      # This will dynamically define a class on the Thor module
+      # This allows us to add convenience helpers per method
+      ThorEnhance.configuration.command_method_enhance.each do |name, object|
+        # This is how thor works -- at the class level using memoization
+        # Interesting approach and it works because thor should boot before everything else -- and only boots once
+        ClassMethods.define_method("#{name}") do |input|
+          value = instance_variable_get("@#{name}")
+          value ||= {}
+          if @usage.nil?
+            raise ArgumentError, "Usage is not set. Please ensure `#{name}` is defined after usage is set"
+          end
+          if object[:repeatable]
+            value[@usage] ||= []
+            value[@usage] << input
+          else
+            value[@usage] = input
+          end
+
+          instance_variable_set("@#{name}", value)
+        end
+      end
+
+      ::Thor.include ThorEnhance::CommandMethod
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Call all things super for it (super in thor also calls super as well)
+      # If the command exists, then add the initi
+      def method_added(meth)
+        super(meth)
+
+        # Skip if the we should not be creating the command
+        if command = all_commands[meth.to_s]
+          ThorEnhance.configuration.command_method_enhance.each do |name, object|
+            # When value is not required and not present, it will not exist. Rescue and return nil
+            value = instance_variable_get("@#{name}")[meth.to_s] rescue nil
+            command.send("#{name}=", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/thor_enhance/configuration.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ThorEnhance
+  class Configuration
+
+    # Order is important -- Ensure deoreacte is first
+    HOOKERS = [DEPRECATE = :deprecate, WARNING = :warn, HOOK = :hook]
+
+    class << self
+      attr_accessor :allow_changes
+
+      def allow_changes?(raise_error: true)
+        return true if allow_changes.nil?
+
+        if raise_error
+          raise BaseError, "Configuration changes are halted. Unable to change ThorEnhancements"
+        else
+          false
+        end
+      end
+
+      def disallow_changes!
+        allow_changes = true
+      end
+    end
+
+    def inject_thor!
+      self.class.allow_changes?
+
+      ThorEnhance::Option.thor_enhance_injection!
+      ThorEnhance::Command.thor_enhance_injection!
+      ThorEnhance::CommandMethod.thor_enhance_injection!
+      self.class.disallow_changes!
+    end
+
+    def command_method_enhance
+      @command_method_enhance ||= {}
+    end
+
+    def option_enhance
+      @option_enhance ||= {
+        WARNING => { allowed_klasses: [Proc], behavior: :warn, required: false },
+        DEPRECATE => { allowed_klasses: [Proc], behavior: :raise, required: false },
+        HOOK => { allowed_klasses: [Proc], behavior: nil, required: false },
+      }
+    end
+
+    # Adding a new method to enhance the overall command
+    def add_command_method_enhance(name, allowed_klasses: nil, enums: nil, required: false, repeatable: false)
+      self.class.allow_changes?
+
+      add_to_variable(command_method_enhance, ::Thor::Command.instance_methods, name, allowed_klasses, enums, required, repeatable)
+    end
+
+    # add a new flag on the command option
+    def add_option_enhance(name, allowed_klasses: nil, enums: nil, required: false)
+      self.class.allow_changes?
+
+      add_to_variable(option_enhance, ::Thor::Option.instance_methods, name, allowed_klasses, enums, required)
+    end
+
+    private
+
+    def add_to_variable(storage, methods, name, allowed_klasses, enums, required, repeatable = false)
+      if methods.include?(name.to_sym)
+        raise OptionNotAllowed, "[#{name}] is not allowed as an enhancement"
+      end
+
+      if storage.key?(name.to_sym)
+        raise OptionNotAllowed, "Duplicate detected. [#{name}] was already added."
+      end
+
+      # if enums is present and not an array
+      if !enums.nil? && !enums.is_a?(Array)
+        raise ArgumentError, "Recieved enum of #{enums}. When present, it is expected to be an Array"
+      end
+
+      storage[name.to_sym] = { allowed_klasses: allowed_klasses, enums: enums, required: required, repeatable: repeatable }
+    end
+  end
+end

data/lib/thor_enhance/option.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ThorEnhance
+  module Option
+    def self.thor_enhance_injection!
+      return false unless ThorEnhance::Configuration.allow_changes?
+
+      # Create getter method for the enhance instance variable
+      ThorEnhance.configuration.option_enhance.each do |name, object|
+        define_method(name) { instance_variable_get("@#{name}") }
+      end
+
+      ::Thor::Option.include ThorEnhance::Option
+    end
+
+    def initialize(name, options = {})
+      super
+
+      thor_enhance_definitions(options)
+    end
+
+    def thor_enhance_definitions(options)
+      ThorEnhance.configuration.option_enhance.each do |name, object|
+        if options[name.to_sym].nil? && object[:required]
+          raise RequiredOption, "#{@name} does not have required option #{name}. Please add it to the option"
+        end
+
+        value = options[name.to_sym]
+        if value.nil? && object[:required] == false
+          # no op when it is nil and not required
+        elsif !object[:enums].nil?
+          unless object[:enums].include?(value)
+            raise ValidationFailed, "#{@name} recieved option #{name} with incorrect enum. Received: [#{value}]. Expected: [#{object[:enums]}]"
+          end
+        elsif !object[:allowed_klasses].nil?
+          unless object[:allowed_klasses].include?(value.class)
+            raise ValidationFailed, "#{@name} recieved option #{name} with incorrect class type. Received: [#{value.class}]. Expected: [#{object[:allowed_klasses]}]"
+          end
+        end
+
+        instance_variable_set("@#{name}", value)
+      end
+    end
+  end
+end

data/lib/thor_enhance/tree.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ThorEnhance
+  class Tree
+    DEFAULT_IGNORE_COMMANDS = ["help"]
+
+    def self.add_ignore_commands(command)
+      return false if ignore_commands.include?(command)
+
+      ignore_commands << command
+      true
+    end
+
+    def self.ignore_commands
+      @ignore_commands ||= DEFAULT_IGNORE_COMMANDS.dup
+    end
+
+    def self.reset_ignore_commands!
+      @ignore_commands = DEFAULT_IGNORE_COMMANDS.dup
+    end
+
+    def self.tree(base:, parent: nil)
+      base.all_commands.map do |k, command|
+        next if ignore_commands.include?(k)
+
+        [k, new(command: command, base: base, parent: parent)]
+      end.compact.to_h
+    end
+
+    attr_reader :command, :base, :parent, :children
+
+    # command: Thor::Command struct
+    # base: Root level class where the command is from
+    # parent: 1 level up if nested subcommand
+    def initialize(command:, base:, parent: nil)
+      @parent = parent
+      @base = base
+      @command = command
+      @children = []
+
+      if !base.subcommand_classes.nil? && base.subcommand_classes[command.name]
+        @children = self.class.tree(parent: self, base: base.subcommand_classes[command.name])
+      end
+    end
+
+    def children?
+      children.count > 0
+    end
+  end
+end

data/lib/thor_enhance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ThorEnhance
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/thor_enhance.rb

@@ -1,24 +1,26 @@
 # frozen_string_literal: true
 
-require "faraday"
+require "thor_enhance/command"
+require "thor_enhance/command_hook"
+require "thor_enhance/command_method"
+require "thor_enhance/configuration"
+require "thor_enhance/option"
+require "thor_enhance/tree"
 
 module ThorEnhance
+  class BaseError < StandardError; end
+  class OptionNotAllowed < StandardError; end
+  class ValidationFailed < StandardError; end
+  class RequiredOption < StandardError; end
+  class OptionDeprecated < StandardError; end
 
   def self.configure
     yield configuration if block_given?
+
+    configuration.inject_thor!
   end
 
   def self.configuration
     @configuration ||= ThorEnhance::Configuration.new
   end
-
-  def self.configuration=(object)
-    raise ConfigError, "Expected configuration to be a ThorEnhance::Configuration" unless object.is_a?(ThorEnhance::Configuration)
-
-    @configuration = object
-  end
-
-  def self.reset_configuration!
-    @configuration = ThorEnhance::Configuration.new
-  end
 end

data/thor_enhance.gemspec

@@ -8,12 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors = ["Matt Taylor"]
   spec.email   = ["mattius.taylor@gmail.com"]
 
-  spec.summary     = ""
-  spec.description = ""
+  spec.summary     = "Add hooks and human readable components to Thor Options and Thor Commands"
+  spec.description = "Have you ever wanted your thor commands to tell a story of what they are? Or have you ever wanted to deprecate an option over time easily? ThorEnhance allows to to annote methods and commands in a human readable way"
   spec.homepage    = "https://github.com/matt-taylor/thor_enhance"
   spec.license     = "MIT"
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3")
 
   spec.metadata = {
     "homepage_uri" => spec.homepage,
@@ -29,8 +29,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "class_composer"
-  spec.add_dependency "faraday"
+  spec.add_dependency "thor", "~> 1.3"
 
   spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 12.0"

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: thor_enhance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-19 00:00:00.000000000 Z
+date: 2023-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: class_composer
+  name: thor
   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: faraday
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +80,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.0
-description: ''
+description: Have you ever wanted your thor commands to tell a story of what they
+  are? Or have you ever wanted to deprecate an option over time easily? ThorEnhance
+  allows to to annote methods and commands in a human readable way
 email:
 - mattius.taylor@gmail.com
 executables: []
@@ -115,6 +103,12 @@ files:
 - bin/setup
 - docker-compose.yml
 - lib/thor_enhance.rb
+- lib/thor_enhance/command.rb
+- lib/thor_enhance/command_hook.rb
+- lib/thor_enhance/command_method.rb
+- lib/thor_enhance/configuration.rb
+- lib/thor_enhance/option.rb
+- lib/thor_enhance/tree.rb
 - lib/thor_enhance/version.rb
 - thor_enhance.gemspec
 homepage: https://github.com/matt-taylor/thor_enhance
@@ -131,7 +125,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,5 +135,5 @@ requirements: []
 rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
-summary: ''
+summary: Add hooks and human readable components to Thor Options and Thor Commands
 test_files: []