rake-commander 0.1.2

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

@@ -0,0 +1,39 @@
+class RakeCommander
+  module RakeContext
+    class Wrapper
+      # Allows to interact with rake
+      # @note this prevents subclass overlap methods to be used
+      def context(object = global_instance, &block)
+        raise ArgumentError, "Block required" unless block_given?
+        object.instance_eval(&block)
+      end
+
+      def respond_to_missing?(meth, *args)
+        global_instance.send(:respond_to_missing?, meth, *args) || super
+      end
+
+      def respond_to?(meth, with_private = true)
+        global_instance.respond_to?(meth, with_private) || super
+      end
+
+      # Forward
+      def method_missing(meth, *args, **kargs, &block)
+        if respond_to?(meth)
+          context do
+            send(meth, *args, **kargs, &block)
+          end
+        else
+          super
+        end
+      end
+
+      private
+
+
+      # Refers to the top level object
+      def global_instance
+        @global_instance ||= eval('self', TOPLEVEL_BINDING, __FILE__, __LINE__)
+      end
+    end
+  end
+end

data/lib/rake-commander/rake_task.rb

@@ -0,0 +1,157 @@
+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 ClassMethods
+        base.inheritable_attrs(*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 `--`
+        task_method = invoke_options_before_task(&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
+      end
+
+      # Give a name to the task
+      # @return [Symbol] the task name
+      def task(name = nil)
+        return @task if name.nil?
+        @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?
+        @namespace = namespace_str(name)
+      end
+
+      # Is this rake context namespaced?
+      # @note Rake allows to namespace tasks (i.e. `task :"run:this"`)
+      #   Although supported by this integration, namespace detection
+      #   is left to the core `rake` gem. This method will return `false`.
+      # @return [Boolean]
+      def namespaced?
+        !!namespace
+      end
+
+      # It builds the nested `namespace` **rake** blocks
+      def namespaced(name = namespace, &block)
+        spaces = namespace_split(name)
+        top    = spaces.shift
+        block  = spaces.reverse.reduce(block) do |blk, nm|
+          namespace_block(nm, &blk)
+        end
+        rake.namespace top, &block
+      end
+
+      protected
+
+      # Converstion of `namespace` name to string
+      # @return [String]
+      def namespace_str(name)
+        name = name.to_s   if name.is_a?(Symbol)
+        name = name.to_str if name.respond_to?(:to_str)
+        raise ArgumentError, "Expected a String or Symbol for a namespace name. Given: #{name.class}" unless name.is_a?(String)
+        name
+      end
+
+      # @return [String, NilClass] generic banner for options
+      def task_options_banner
+        str_space = respond_to?(:namespace)? "#{namespace}:" : ''
+        str_task  = respond_to?(:task)     ? "Usage: #{str_space}#{task} -- [options]" : nil
+      end
+
+      private
+
+      # Split into `Array` the namespace based on `NAMESPACE_DELIMITER`
+      # @return [Array<String>]
+      def namespace_split(name)
+        namespace_str(name).split(NAMESPACE_DELIMITER)
+      end
+
+      # Helper to build the rake `namespace` blocks
+      # @return [Proc] which will invoke `namspace name` from the global context when called.
+      def namespace_block(name, &block)
+        rake.context do
+          proc { namespace name, &block }
+        end
+      end
+
+      # Rake command ends at `--` (`RAKE_END_COMMAND`).
+      # We only want to parse the options that come afterwards
+      # @note without this approach, it will throw `OptionParser::InvalidOption` error
+      # @return [Proc]
+      def invoke_options_before_task(&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)
+        end
+      end
+    end
+
+    def initialize
+      super if defined?(super)
+      install_task
+    end
+
+    # def task
+    #   raise "You should override/define this method"
+    # end
+
+    protected
+
+    def install_task
+      return unless task_block = task_method
+      self.class.install_task(&task_block)
+    end
+
+    def task_method
+      method(:task)
+    rescue NameError
+      nil
+    end
+  end
+end

data/lib/rake-commander/version.rb

@@ -0,0 +1,3 @@
+class RakeCommander
+  VERSION = '0.1.2'.freeze
+end

data/lib/rake-commander.rb

@@ -0,0 +1,9 @@
+require 'rake'
+require_relative 'rake-commander/base'
+
+class RakeCommander
+  include RakeCommander::Base
+end
+
+require_relative 'rake-commander/version'
+require_relative 'rake-commander/custom'

data/rake-commander.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rake-commander/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rake-commander"
+  spec.version       = RakeCommander::VERSION
+  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.homepage      = "https://www.ecoportal.com"
+  spec.licenses      = %w[MIT]
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.7.2'
+
+  spec.add_development_dependency "bundler",   ">= 2.4.9",  "< 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"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: rake-commander
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Oscar Segura Samper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !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: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '14'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description:
+email:
+- oscar@ecoportal.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- examples/basic.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/custom.rb
+- lib/rake-commander/option.rb
+- lib/rake-commander/options.rb
+- lib/rake-commander/options/arguments.rb
+- lib/rake-commander/options/error.rb
+- lib/rake-commander/options/error_rely.rb
+- lib/rake-commander/options/name.rb
+- lib/rake-commander/options/set.rb
+- lib/rake-commander/rake_context/wrapper.rb
+- lib/rake-commander/rake_task.rb
+- lib/rake-commander/version.rb
+- rake-commander.gemspec
+homepage: https://www.ecoportal.com
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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.
+test_files: []