rake-commander 0.1.4 → 0.2.0

data/lib/rake-commander/patcher/helpers.rb

@@ -0,0 +1,44 @@
+class RakeCommander
+  module Patcher
+    # Helpers to patch
+    module Helpers
+      # For a given method `meth` it gives the index of the parameter `arg_name`
+      # @return [Integer, NilClass] the position of `arg_name` in parameters.
+      def method_argument_idx(meth, arg_name)
+        arg_name = arg_name.to_sym
+        meth.parameters.each_with_index do |(_type, name), i|
+          return i if name == arg_name
+        end
+      end
+
+      # Its usage only makes sense if you extended an existing method you are patching.
+      # Therefore it is expected that `super` exists, so the original parameters definition
+      # of the method can be accessed.
+      # @note although the signature of a method can change through different versions
+      #   the name of the parameters is generally preserved (specially when they are core parameters).
+      # @example
+      #     module Rake
+      #       class Application
+      #         def init(*args)
+      #           args = RakeCommander::Patcher.change_method_argument(:argv, method: method(__method__), args: args) do |value|
+      #             RakeCommander.argv_rake_native_arguments(value)
+      #           end
+      #           super(*args)
+      #         end
+      #       end
+      #     end
+      #
+      # @param arg_name [Symbol, String] the name of the parameter as it reads in the original method.
+      # @param method [Method] the extended method (not its `super` method)
+      # @return [Array] the original arguments where `arg_name` has been changed.
+      def change_method_argument(arg_name, method:, args:)
+        raise ArgumentError, 'Expecting block' unless block_given?
+        raise ArgumentError, "Expecting Method. Given #{method.class}" unless method.is_a?(Method)
+        if idx = method_argument_idx(method.super_method, arg_name.to_sym)
+          args[idx] = yield(args[idx])
+        end
+        args
+      end
+    end
+  end
+end

data/lib/rake-commander/patcher.rb

@@ -0,0 +1,26 @@
+require_relative 'patcher/helpers'
+require_relative 'patcher/debug'
+require_relative 'patcher/base'
+require_relative 'patcher/application'
+
+class RakeCommander
+  module Patcher
+    extend RakeCommander::Patcher::Helpers
+    include RakeCommander::Patcher::Base
+
+    class << self
+      def patch_include(base)
+        base.send :include, Application
+      end
+
+      def debug=(value)
+        @debug = !!value
+      end
+
+      def debug?
+        @debug = false unless instance_variable_defined?(:@debug)
+        @debug
+      end
+    end
+  end
+end

data/lib/rake-commander/rake_context/wrapper.rb

@@ -1,6 +1,8 @@
 class RakeCommander
   module RakeContext
     class Wrapper
+      include Rake::DSL
+
       # Allows to interact with rake
       # @note this prevents subclass overlap methods to be used
       def context(object = global_instance, &block)

data/lib/rake-commander/rake_task.rb

@@ -3,66 +3,52 @@ require_relative 'rake_context/wrapper'
 class RakeCommander
   module RakeTask
     NAMESPACE_DELIMITER = /:/.freeze
-    RAKE_END_COMMAND    = '--'.freeze
     INHERITABLE_ATTRS   = [:namespace].freeze
 
     class << self
       def included(base)
         super(base)
+        base.extend RakeCommander::Base::ClassHelpers
+        base.extend RakeCommander::Base::ClassInheritable
         base.extend ClassMethods
-        base.inheritable_attrs(*INHERITABLE_ATTRS)
+        base.attr_inheritable(*INHERITABLE_ATTRS)
       end
     end
 
     module ClassMethods
-      include RakeCommander::Base::ClassHelpers
-
       # The rake context wrapper (to invoke rake commands)
       def rake
         @rake ||= RakeCommander::RakeContext::Wrapper.new
       end
 
-      # Does the final rake `task` definition
-      def install_task(&task_method)
-        raise "Expected task_block." unless task_method
-
-        # ensure options are parsed before calling task
-        # and that ARGV is only parsed after `--`
-        # do an `exit(0)` right at the end
-        task_method = task_context(&task_method) if options?
-
-        if namespaced?
-          namespaced do
-            rake.desc desc
-            rake.task task, &task_method
-          end
-        else
-          rake.desc desc
-          rake.task task, &task_method
-        end
+      # Give a description to the task
+      # @return [String] the description of the task
+      def desc(str = :not_used)
+        return @desc if str == :not_used
+        @desc = str.to_s
       end
 
       # Give a name to the task
       # @return [Symbol] the task name
-      def task(name = nil)
-        return @task if name.nil?
+      def task(name = :not_used)
+        return @task if name == :not_used
         @task = name.to_sym
       end
 
-      # Give a description to the task
-      # @return [String] the description of the task
-      def desc(str = nil)
-        return @desc if str.nil?
-        @desc = str.to_s
-      end
-
       # It can be hierarchical by using `NAMESPACE_DELIMITER`
       # @return [String] the namespace defined for this `RakeCommander` class.
-      def namespace(name = nil)
-        return @namespace if name.nil?
+      def namespace(name = :not_used)
+        return @namespace if name == :not_used
         @namespace = namespace_str(name)
       end
 
+      # It gives the task full name (including namespacing)
+      # @return [String]
+      def task_fullname
+        "#{namespace}:#{task}"
+      end
+      alias_method :name, :task_fullname
+
       # Is this rake context namespaced?
       # @note Rake allows to namespace tasks (i.e. `task :"run:this"`)
       #   Although supported by this integration, namespace detection
@@ -82,6 +68,28 @@ class RakeCommander
         rake.namespace top, &block
       end
 
+      # Does the final rake `task` definition
+      # @note although it will exist, the task won't be listed with `rake -T`
+      #   unless it has a description (`desc`).
+      # @note this method is extended by some modules
+      #   1. `RakeCommander::Options::Result`: Ensure options are parsed before calling task
+      #   2. `RakeCommander::Options::Arguments`: `exit(0)` when `Rake` interprets the full `ARGV`
+      #     rather than stopping at the delimiter (`--`)
+      # @return [@see Rake::Task] same results as if you used `task :name {}` or `namespace :space {}`
+      def install_task(&task_method)
+        raise "Expected task_block." unless task_method
+
+        if namespaced?
+          namespaced do
+            rake.desc desc
+            rake.task task, &task_method
+          end
+        else
+          rake.desc desc
+          rake.task task, &task_method
+        end
+      end
+
       protected
 
       # Converstion of `namespace` name to string
@@ -99,6 +107,14 @@ class RakeCommander
         respond_to?(:task) ? "Usage: #{str_space}#{task} -- [options]" : nil
       end
 
+      # Offer a wrapper to build the task conext througout all inheritance chain.
+      # @note
+      #   - This method offers children classes a way to add their on middleware.
+      # @return [Proc] our wrapped task block.
+      def task_context(&task_method)
+        task_method
+      end
+
       private
 
       # Split into `Array` the namespace based on `NAMESPACE_DELIMITER`
@@ -114,27 +130,6 @@ class RakeCommander
           proc { namespace name, &block }
         end
       end
-
-      # Rake command ends at `--` (`RAKE_END_COMMAND`).
-      # We only want to parse the options that come afterwards
-      # @note
-      #   1. Without `ARGV` cut, it will throw `OptionParser::InvalidOption` error
-      #   2. **Work-around**: We also add an `exit(0)` at the end to prevent `Rake` chaining
-      #     option arguments as if they were actual tasks.
-      # @return [Proc]
-      def task_context(&task_method)
-        object = eval('self', task_method.binding, __FILE__, __LINE__)
-        return task_method unless object.is_a?(self)
-        proc do |*args|
-          argv = ARGV
-          if idx = argv.index(RAKE_END_COMMAND)
-            argv = argv[idx+1..-1]
-          end
-          object.options(argv)
-          task_method.call(*args)
-          exit(0)
-        end
-      end
     end
 
     def initialize

data/lib/rake-commander/version.rb

@@ -1,3 +1,3 @@
 class RakeCommander
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/rake-commander.rb

@@ -1,9 +1,13 @@
 require 'rake'
 require_relative 'rake-commander/base'
+require_relative 'rake-commander/patcher'
 
 class RakeCommander
   include RakeCommander::Base
+  include RakeCommander::Patcher
 end
 
 require_relative 'rake-commander/version'
 require_relative 'rake-commander/custom'
+
+RakeCommander.self_load

data/rake-commander.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Oscar Segura Samper"]
   spec.email         = ["oscar@ecoportal.co.nz"]
 
-  spec.summary       = 'The classed version of rake with task options. Create re-usable tasks and samples.'
+  spec.summary       = 'Classing rake tasks with options. Creating re-usable tasks, options and samples thereof.'
   spec.homepage      = "https://github.com/rellampec/rake-commander"
   spec.licenses      = %w[MIT]
 
@@ -22,8 +22,11 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.7.2'
 
   spec.add_development_dependency "bundler",   ">= 2.4.9",  "< 3"
+  spec.add_development_dependency 'dotenv',    '>= 2.7.6',  '< 3'
   spec.add_development_dependency "rake",      ">= 13.0.6", "< 14"
   spec.add_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
   spec.add_development_dependency "rspec",     ">= 3.10.0", "< 4"
   spec.add_development_dependency "yard",      ">= 0.9.34", "< 1"
+
+  spec.add_dependency "rake", ">= 13.0.6", "< 14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake-commander
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,6 +30,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +130,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
 description:
 email:
 - oscar@ecoportal.co.nz
@@ -123,21 +163,49 @@ files:
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
-- examples/basic.rb
+- examples/01_basic_example.rb
+- examples/02_a_chainer_example.rb
+- examples/02_a_chainer_options_set.rb
+- examples/02_b_chained_example.rb
+- examples/03_a_chainer_plus_example.rb
+- examples/03_b_chained_plus_example.rb
+- examples/Examples.rake
+- examples/README.md
+- examples/libs/shell_helpers.rb
 - lib/rake-commander.rb
 - lib/rake-commander/base.rb
 - lib/rake-commander/base/class_auto_loader.rb
 - lib/rake-commander/base/class_helpers.rb
+- lib/rake-commander/base/class_inheritable.rb
+- lib/rake-commander/base/custom_error.rb
+- lib/rake-commander/base/object_helpers.rb
 - lib/rake-commander/custom.rb
 - lib/rake-commander/option.rb
 - lib/rake-commander/options.rb
 - lib/rake-commander/options/arguments.rb
+- lib/rake-commander/options/description.rb
 - lib/rake-commander/options/error.rb
-- lib/rake-commander/options/error_rely.rb
+- lib/rake-commander/options/error/base.rb
+- lib/rake-commander/options/error/handling.rb
+- lib/rake-commander/options/error/invalid_argument.rb
+- lib/rake-commander/options/error/invalid_option.rb
+- lib/rake-commander/options/error/missing_argument.rb
+- lib/rake-commander/options/error/missing_option.rb
+- lib/rake-commander/options/error/unknown_argument.rb
 - lib/rake-commander/options/name.rb
+- lib/rake-commander/options/result.rb
 - lib/rake-commander/options/set.rb
+- lib/rake-commander/patcher.rb
+- lib/rake-commander/patcher/README.md
+- lib/rake-commander/patcher/application.rb
+- lib/rake-commander/patcher/application/run_method.rb
+- lib/rake-commander/patcher/application/top_level_method.rb
+- lib/rake-commander/patcher/base.rb
+- lib/rake-commander/patcher/debug.rb
+- lib/rake-commander/patcher/helpers.rb
 - lib/rake-commander/rake_context/wrapper.rb
 - lib/rake-commander/rake_task.rb
 - lib/rake-commander/version.rb
@@ -164,6 +232,6 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: The classed version of rake with task options. Create re-usable tasks and
-  samples.
+summary: Classing rake tasks with options. Creating re-usable tasks, options and samples
+  thereof.
 test_files: []

data/examples/basic.rb

@@ -1,30 +0,0 @@
-require_relative File.join(__dir__, '../lib/rake-commander')
-class RakeCommander::Custom::Basic < RakeCommander
-  namespace :examples
-
-  desc 'A simple example to get started'
-  task :basic
-
-  #banner "Usage: basic:example -- [options]"
-  option '-s', '--say [SOMETHING]', "It says 'something'", default: %q(I don't know what to "say"...)
-  option :d, '--folder NAME', default: '.', desc: 'Source local folder', required: true
-  option '-e', '--enviro ENV', 'The target environment to run this task', required: true
-  option '-t', :show_time, TrueClass, desc: 'Displays the local time'
-  option :v, :debug, TrueClass, 'Shows the parsed options'
-
-  def task(*_args)
-    if options[:v]
-      puts 'We got these options:'
-      pp options
-    end
-    puts Time.now.strftime('%d %b at %H:%M') if options[:t]
-    puts options[:s] if options.key?(:s)
-  end
-end
-
-RakeCommander.self_load
-Rake::Task[:'examples:basic'].invoke
-# ruby basic.rb -- -v -d /some/folder -t
-
-#RakeCommander::Custom::Basic.parse_options %w[--help]
-#RakeCommander::Custom::Basic.parse_options %w[-d]

data/lib/rake-commander/options/error_rely.rb

@@ -1,58 +0,0 @@
-class RakeCommander
-  module Options
-    # Relies between OptionParser and RakeCommander errors
-    class ErrorRely < StandardError
-      extend RakeCommander::Options::Name
-
-      OPTION_REGEX = /(?:argument|option): (?<option>.+)/i.freeze
-
-      def initialize(value)
-        case value
-        when OptionParser::MissingArgument, OptionParser::InvalidArgument
-          super(value.message)
-        when String
-          super(value)
-        else
-          raise ArgumentError, "Expecting String or OptionParser error. Given: #{value.class}"
-        end
-      end
-
-      def name?
-        option_sym.to_s.length > 1
-      end
-
-      def short?
-        option_sym.to_s.length == 1
-      end
-
-      def option_sym
-        return @option_sym if @option_sym
-        return nil unless match = message.match(self.class::OPTION_REGEX)
-        option = match[:option]
-        @option_sym = \
-          if option.length > 1
-            self.class.name_word_sym(option)
-          else
-            self.class.short_sym(option)
-          end
-      end
-
-      private
-
-      def to_description(value)
-        case value
-        when Hash
-          to_description(value.values.uniq)
-        when Array
-          value.map do |v|
-            to_description(v)
-          end.join(', ')
-        when RakeCommander::Option
-          "#{value.name_hyphen} (#{value.short_hyphen})"
-        else
-          value
-        end
-      end
-    end
-  end
-end