rake-commander 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79568da769a6523e7024fa641eb8d792b2fd4dfcc600f11f0cbf56e6bb1f45d9
-  data.tar.gz: e8e55e77085b67e37fd9befdb1b0b77cd0f8403ff1c0ab939160c3659c0cd67f
+  metadata.gz: 72eaeab3395a3cb86ee6740a4dc90669f673af8ee30f6ba6dc40572a245d3b88
+  data.tar.gz: c75023ec7f58039781627a052e870982af0e546beefc91d2e8a54df2e58383e9
 SHA512:
-  metadata.gz: fe77e58170a2e2bed3c9d52202e8deaa039422bda0ded1284f0d8fb316c83a6609fffb6753d2387d573b0ed70c7d5a2c74b5d868e8a89f5ba96dfa2d472b8587
-  data.tar.gz: f75fa6017995dd942cd37cc6494db0a0c9d5273eb28e1b9ef9fe7d909fa39abffc25b6aa681c05ba1dce868b2265fb0bf54f01c55a31fd4298aaf6f70f3b435c
+  metadata.gz: 42e24e489d42e44de71162a4faee64dba5f72555afcfcb0742a6506c238f6f0ea480f0185f926a4f65f418005b3d30eb185d3311ca4aacd89e53eea6c31577ad
+  data.tar.gz: f8a70b443fbfd5717595d99faf4c12620a4adcb5f4cd9e4f01259622046de923fef3bc01db75382a17c272b7dbf5738163584f10cd8607aea50c3b92e8efbcca

data/.rubocop.yml

@@ -17,6 +17,8 @@ Metrics/MethodLength:
   Max: 50
 Metrics/ClassLength:
   Max: 200
+Metrics/ModuleLength:
+  Max: 200
 Metrics/AbcSize:
   Max: 50
 Metrics/CyclomaticComplexity:

data/CHANGELOG.md

@@ -2,13 +2,28 @@
 All notable changes to this project will be documented in this file.
 
 ## TO DO
+  - Specify what options are REQUIRED in help lines.
   - Rake task parameters (see: https://stackoverflow.com/a/825832/4352306)
   - `OptionParser#parse` result (what to do with unknown ARGV `leftovers`)
 
-## [0.1.2] - 2023-04-19
+## [0.1.5] - 2023-04-xx
 
 ### Added
-  - First commit
-
 ### Fixed
 ### Changed
+
+## [0.1.4] - 2023-04-20
+
+### Fixed
+  - `rubocop` offenders
+  - Added implicity `exit(0)` when wrapping the `task` block
+
+## [0.1.3] - 2023-04-20
+
+### Fixed
+  - Reference to repo and gem
+
+## [0.1.2] - 2023-04-19
+
+### Added
+  - First commit

data/Gemfile

@@ -2,5 +2,5 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-# Specify your gem's dependencies in ecoportal-api.gemspec
+# Specify your gem's dependencies in rake-commander.gemspec
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# Ecoportal::API
+# RakeCommander
 
 Another way to define re-usable rake tasks and samples.
 

data/Rakefile

@@ -23,7 +23,7 @@ YARD::Rake::YardocTask.new(:doc) do |t|
 end
 
 desc "Examples: Run examples (rake examples[basic] -- -h)"
-task :examples, [:sample] do |t, args|
+task :examples, [:sample] do |_t, args|
   require_relative "examples/#{args[:sample]}"
 end
 

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

@@ -25,7 +25,7 @@ class RakeCommander
       # @param argv [Array<String>]
       # @param options [Hash] the defined `RakeCommander::Option` to re-arrange `argv` with.
       # @return [Array<String>] the re-arranged `argv`
-      def pre_parse_arguments(argv = ARGV, options)
+      def pre_parse_arguments(argv = ARGV, options:)
         pre_parsed = explicit_argument_options(argv, options)
         compact_short = ''
         pre_parsed.each_with_object([]) do |(opt_ref, args), out|

data/lib/rake-commander/options.rb

@@ -70,21 +70,19 @@ class RakeCommander
       # It builds the `OptionParser` injecting the `middleware` block.
       # @return [Hash] with `short` option as `key` and final value as `value`.
       def parse_options(argv = ARGV, leftovers: [], &middleware)
-        left_overs = []
         options_parser_with_results(middleware) do |options_parser|
-          argv = pre_parse_arguments(argv, options_hash)
+          argv = pre_parse_arguments(argv, options: options_hash)
+          pp argv
           leftovers.push(*options_parser.parse(argv))
         rescue OptionParser::MissingArgument => e
           raise RakeCommander::Options::MissingArgument, e, cause: nil
         rescue OptionParser::InvalidArgument => e
           error = RakeCommander::Options::InvalidArgument
           error = error.new(e)
-          if (opt = options_hash[error.option_sym]) && opt.argument_required?
-            msg = "missing required argument: #{opt.name_hyphen} (#{opt.short_hyphen})"
-            raise RakeCommander::Options::MissingArgument, msg, cause: nil
-          else
-            raise error, e, cause: nil
-          end
+          opt   = options_hash[error.option_sym]
+          msg = "missing required argument: #{opt&.name_hyphen} (#{opt&.short_hyphen})"
+          raise RakeCommander::Options::MissingArgument, msg, cause: nil if opt&.argument_required?
+          raise error, e, cause: nil
         end.tap do |results|
           check_required_presence!(results)
         end
@@ -124,7 +122,7 @@ class RakeCommander
         {}.tap do |res_def|
           options.select do |opt|
             (results_with_all_defaults && opt.default?) \
-            ||  (opt.required? && opt.default?)
+            || (opt.required? && opt.default?)
           end.each do |opt|
             res_def[opt.short] = opt.default
           end
@@ -134,12 +132,10 @@ class RakeCommander
       # It throws an exception if any of the required options
       # is missing in results
       def check_required_presence!(results)
-        missing = options.select do |opt|
-          opt.required?
-        end.reject do |opt|
+        missing = options.select(&:required?).reject do |opt|
           results.key?(opt.short) || results.key?(opt.name)
         end
-        raise RakeCommander::Options::MissingOption.new(missing) unless missing.empty?
+        raise RakeCommander::Options::MissingOption, missing unless missing.empty?
       end
 
       def add_to_options(opt)
@@ -158,7 +154,7 @@ class RakeCommander
     end
 
     def options(argv = ARGV)
-      @options ||= self.class.parse_options(argv, leftovers: self.options_leftovers)
+      @options ||= self.class.parse_options(argv, leftovers: options_leftovers)
     end
 
     def options_leftovers

data/lib/rake-commander/rake_task.rb

@@ -28,7 +28,8 @@ class RakeCommander
 
         # ensure options are parsed before calling task
         # and that ARGV is only parsed after `--`
-        task_method = invoke_options_before_task(&task_method) if options?
+        # do an `exit(0)` right at the end
+        task_method = task_context(&task_method) if options?
 
         if namespaced?
           namespaced do
@@ -95,7 +96,7 @@ class RakeCommander
       # @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
+        respond_to?(:task) ? "Usage: #{str_space}#{task} -- [options]" : nil
       end
 
       private
@@ -116,9 +117,12 @@ class RakeCommander
 
       # 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
+      # @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 invoke_options_before_task(&task_method)
+      def task_context(&task_method)
         object = eval('self', task_method.binding, __FILE__, __LINE__)
         return task_method unless object.is_a?(self)
         proc do |*args|
@@ -128,6 +132,7 @@ class RakeCommander
           end
           object.options(argv)
           task_method.call(*args)
+          exit(0)
         end
       end
     end

data/lib/rake-commander/version.rb

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

data/rake-commander.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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.homepage      = "https://github.com/rellampec/rake-commander"
   spec.licenses      = %w[MIT]
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-commander
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Oscar Segura Samper
@@ -142,7 +142,7 @@ files:
 - lib/rake-commander/rake_task.rb
 - lib/rake-commander/version.rb
 - rake-commander.gemspec
-homepage: https://www.ecoportal.com
+homepage: https://github.com/rellampec/rake-commander
 licenses:
 - MIT
 metadata: {}