eco-rake 0.2.7 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb719b1d4007c97f0d94b045c9fdb61573feec430243333a324e078445e519d9
-  data.tar.gz: 1349f5045662ea64d24a8a60ee4d972b25c9086698eb1711896937a729091e2b
+  metadata.gz: c004dd6f96343a455cce5a5a0939345996995999760df5d3b33db9e7227f2881
+  data.tar.gz: 5e0203f40d13999298c397701ab2e9c28e06fe5512ccd94cafaf007fbf91bc9d
 SHA512:
-  metadata.gz: '0969c6c5dd289cd62aad753ae0349b4fb7c00fd412c77e9e0c49da6a79def74dd06fed98ff5d2f48077defbaaccbde645a50f83e92fde542d85958b89d093186'
-  data.tar.gz: b1d8a5183b981a97e7a1f1c1ec3c42fd65c1d0f83e0bbe31cc76db7245a702ff1eb3703ba49d0ff49e89d75a079e16aeaafc21b7289a03df27ae3fd7998cdce0
+  metadata.gz: 17e3c7a7303fb4f9751b0d70c012cccbfb9d19f9ac81726c6f3621254dc166a11f8c1421f3f6e8dee11dd6ef975d6cfebe866945cf6386ca992c60c2284df778
+  data.tar.gz: e93498897b7c7d82a4739acf95f31c595ebdac7a653b230bf037b58b470645e83a56de1a4939509ef7be05531abe1fc3f620d7390b411fed3ae7738e2a628af5

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.9] - 2025-02-xx
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.2.9] - 2025-02-20
+
+### Fixed
+
+- `EcoRake::Lib::People::SyncLaunch` should forward `space`
+
+## [0.2.8] - 2025-02-20
+
+### Added
+
+- `REMOTE_ARCHIVE` [Boolean] whether or not should archive remote files.
+- Integration option for target `space`
+- (sub)tasks declarion and invokation as `Enum`
+
+### Changed
+
+- code tidy up
+- upgrade core gem dependency
+
+### Fixed
+
+- typo on `Options::Library#names`
+
 ## [0.2.7] - 2024-12-16
 
 ### Added
@@ -9,8 +40,6 @@ All notable changes to this project will be documented in this file.
 - `EcoRake::Lib::People::SyncLaunch`
   - New constant `TARGET_NAMESPACE`: to build up the target task based on a different namespace (i.e. not nested).
 
-### Fixed
-
 ### Changed
 
 - code tidy up

data/eco-rake.gemspec

@@ -24,14 +24,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 3.2.2'
 
   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_development_dependency "redcarpet", ">= 3.6.0",  "< 4"
 
-  #spec.add_dependency 'aws-sdk-s3',    '>= 1.142.0', '< 2'
   spec.add_dependency 'aws-sdk-ses',    '~> 1', '>= 1.58.0'
   spec.add_dependency 'dotenv',         '~> 3'
   spec.add_dependency 'nokogiri',       '>= 1.13', '< 1.17'
-  spec.add_dependency 'rake-commander', '~> 0.4'
+  spec.add_dependency 'rake-commander', '~> 0.4.1'
   spec.add_dependency 'sendgrid-ruby',  '~> 6.7.0'
 end

data/lib/eco-rake/base.rb

@@ -6,12 +6,14 @@ require_relative 'shell'
 require_relative 'rake_task'
 require_relative 'option'
 require_relative 'options'
+require_relative 'subtask'
 
 class EcoRake
   module Base
     class << self
       def included(base)
         super
+
         base.autoloads_children_of RakeCommander
         base.extend ClassMethods
         base.send :include, RakeTask

data/lib/eco-rake/lib/concern/enviro.rb

@@ -6,7 +6,8 @@ class EcoRake
 
         class << self
           def included(base)
-            super(base)
+            super
+
             base.option '-e', '--enviro ENVIRO', default_lookup: :default_enviro
           end
         end

data/lib/eco-rake/lib/export/payload.rb

@@ -11,6 +11,7 @@ class EcoRake
         INCLUDED_OPTIONS = %i[csv simulate].freeze
         FORWARD_RULES    = {
           enviro:   ->(enviro) { "-#{enviro}" },
+          space:    :mirror,
           simulate: '-simulate',
           csv:      '-csv',
           full:     ->(full) { full ? nil : '-delta' },
@@ -20,6 +21,7 @@ class EcoRake
         options_with_defaults true
         option '-s', '--simulate', TrueClass, 'Do a dry-run (with no changes)'
         option '-e', '--enviro ENVIRO', String, desc: 'Target environment to run against (i.e. org, live)', required: true # , default_lookup: :default_enviro
+        option '-w', '--space SPACE', String, desc: 'Target space of the envionment (i.e. uat)'
         option '-f', '--[no-]full', TrueClass, default: false, desc: 'If the PAYLOAD file is a full file (false: means delta)'
         option '-c', '--csv', TrueClass, default: true, desc: 'Generate files in csv format?'
         option '-a', '--asat [DATE]', Time, default: Time.now.iso8601, desc: 'Specifies the date when the export was done (default: now).' do |value|
@@ -63,14 +65,21 @@ class EcoRake
 
         def forward_command(use, *opts)
           raise "Expecting String with usecase. Given: #{use.class}" unless use.is_a?(String)
+
           cmd = [base_command(use)]
           cmd.push(*forward_options(*self.class::INCLUDED_OPTIONS, *opts))
+
           cmd = yield(cmd) if block_given?
+
           string_cmd(*cmd)
         end
 
         def base_command(use = nil)
-          string_cmd(ruby_runner, forward_option(:enviro), use)
+          string_cmd(
+            ruby_runner,
+            forward_option(:enviro),
+            use
+          )
         end
       end
     end

data/lib/eco-rake/lib/files/purge.rb

@@ -5,12 +5,13 @@ class EcoRake
         options_with_defaults true
 
         option '-e', '--enviro ENVIRO', String, desc: 'Target environment to run against (i.e. org, live)', required: true
+        option '-w', '--space SPACE', String, desc: 'Target space of the envionment (i.e. uat)'
         option '-d', '--folder NAME', desc: 'Source local folder'
         option '-l', '--list', TrueClass, desc: 'Lists files that will be deleted'
         option '-o', '--older-than [DAYS]', Integer, desc: 'Number of days files to archive should be older than'
         option '-r', '--remove', TrueClass, desc: "It deletes those files"
 
-        def task(*_args)
+        def task(*_args) # rubocop:disable Metrics/AbcSize
           if target_files.empty?
             puts "There were no files in folder '#{source_folder}' to be #{str_op}"
           elsif options[:list]

data/lib/eco-rake/lib/files/sftp.rb

@@ -4,6 +4,7 @@ class EcoRake
       class Sftp < EcoRake::Lib::BaseTask
         FORWARD_RULES = {
           enviro:           ->(enviro) { "-#{enviro}" },
+          space:            :mirror,
           folder:           ->(folder) { "-local-folder #{folder}"},
           list:             '-list',
           get_last:         '-get-last',
@@ -16,6 +17,7 @@ class EcoRake
         options_with_defaults true
 
         option '-e', '--enviro ENVIRO', String, desc: 'Target environment to run against (i.e. org, live)', required: true
+        option '-w', '--space SPACE', String, desc: 'Target space of the envionment (i.e. uat)'
         option '-d', '--folder NAME', default: '.', desc: 'Source local folder'
         option '-l', '--list', TrueClass, desc: 'Lists available CSV feed files'
         option '-g', '--get', TrueClass, desc: 'Gets all available CSV feed files'
@@ -49,7 +51,12 @@ class EcoRake
         end
 
         def base_command
-          string_cmd(ruby_runner, forward_option(:enviro), '-sftp')
+          string_cmd(
+            ruby_runner,
+            forward_option(:enviro),
+            forward_option(:space),
+            '-sftp'
+          )
         end
       end
     end

data/lib/eco-rake/lib/people/base_task.rb

@@ -3,7 +3,8 @@ class EcoRake
     module People
       class BaseTask < EcoRake::Lib::BaseTask
         FORWARD_RULES = {
-          enviro: ->(enviro) { "-#{enviro}" }
+          enviro: ->(enviro) { "-#{enviro}" },
+          space:  :mirror
         }.freeze
 
         options_with_defaults true

data/lib/eco-rake/lib/people/sync_launch.rb

@@ -4,9 +4,11 @@ class EcoRake
       # @todo on_error_email to ensure always notified
       # @todo ping some back-end that it was run
       #   - Should be able to log at debug level.
+      # @note in integration repos this is used to be called `run:hris`
       class SyncLaunch < EcoRake::Lib::People::BaseTask
         ADDITIONAL_OPTIONS = %i[only_stats no_policy simulate no_email].freeze
         FORWARD_RULES = {
+          space:      :mirror,
           schema:     ->(schema) { "-schema-id \"#{schema}\"" },
           only_stats: '-feed-only-stats',
           no_policy:  '-skip-batch-policy',
@@ -73,6 +75,7 @@ class EcoRake
           cmd = []
           cmd << ruby_runner
           cmd << forward_option(:enviro)
+          cmd << forward_option(:space)
           cmd << forward_option(:schema)
           cmd << '-get-partial' if delta? || delta_last?
           cmd << base_command(file)
@@ -83,7 +86,12 @@ class EcoRake
 
         # Generate command string to get people
         def people_get_command
-          string_cmd(ruby_runner, forward_option(:enviro), '-get-people')
+          string_cmd(
+            ruby_runner,
+            forward_option(:enviro),
+            forward_option(:space),
+            '-get-people'
+          )
         end
 
         # Base command scoping.
@@ -120,7 +128,7 @@ class EcoRake
           snapshot_mode.to_s.downcase.to_sym == :delta_last
         end
 
-        # Amont the `target_files` the last in alphabetic order.
+        # Among the `target_files`, the last in alphabetic order.
         def latest_file
           @latest_file ||= ''.then do
             next options[:folder] if join_files

data/lib/eco-rake/lib/people/sync_options.rb

@@ -4,6 +4,7 @@ class EcoRake
       class SyncOptions < EcoRake::Options::Set
         option '-s', '--simulate', TrueClass, 'Do a dry-run (with no changes)'
         option '-e', '--enviro ENVIRO', String, desc: 'Target environment to run against (i.e. org, live)', required: true
+        option '-w', '--space SPACE', String, desc: 'Target space of the envionment (i.e. uat)'
         option '-c', '--schema NAME', "Target person schema."
         option '-d', '--folder NAME', desc: 'Source local folder'
         option '-o', '--only-stats', TrueClass, desc: 'To display only stats in the feedback'

data/lib/eco-rake/lib/people/sync_process.rb

@@ -2,6 +2,7 @@ class EcoRake
   module Lib
     module People
       # The top level task that organizes all the people sync
+      # @note in integration repos this is used to be called `run:feed`
       class SyncProcess < EcoRake::Lib::People::SyncRely
         attr_const :do_decrypt, default: false
         attr_const :pull_driver, default: 'sftp'
@@ -11,10 +12,11 @@ class EcoRake
         option_reopen :enviro, default_lookup: :target_enviro
 
         attr_const :local_folder, default: '.'
-        attr_const :mail_to
-
         option_reopen :folder, default_lookup: :local_folder
 
+        attr_const :mail_to
+        attr_const :remote_archive, default: true
+
         def task(*_args)
           upsert_local_dir(options[:folder])
           sh_continue pull_file
@@ -23,7 +25,7 @@ class EcoRake
           sh_continue rake_sync_command
           return if options[:simulate]
 
-          sh_continue rake_sftp_archive if pull_driver == 'sftp'
+          sh_continue rake_sftp_archive if remote_archive && pull_driver == 'sftp'
           sh_continue rake_files_purge('cache')
           sh_continue rake_files_purge('requests')
         end
@@ -40,15 +42,15 @@ class EcoRake
         end
 
         def rake_sftp_get
-          rake_command('csv:sftp', *forward_options(:enviro, :folder), '-t')
+          rake_command('csv:sftp', *forward_options(:enviro, :space, :folder), '-t')
         end
 
         def rake_url_get
-          rake_command("csv:#{options[:enviro]}:url", *forward_options(:folder))
+          rake_command("csv:#{options[:enviro]}:url", *forward_options(:space, :folder))
         end
 
         def rake_sftp_archive
-          rake_command('csv:sftp', *forward_options(:enviro, :folder), '-a')
+          rake_command('csv:sftp', *forward_options(:enviro, :space, :folder), '-a')
         end
 
         def rake_decrypt
@@ -56,7 +58,7 @@ class EcoRake
         end
 
         def rake_files_purge(folder, operation: '--remove')
-          rake_command('logs:purge', *forward_options(:enviro), "-d #{folder}", operation)
+          rake_command('logs:purge', *forward_options(:enviro, :space), "-d #{folder}", operation)
         end
 
         def failed_decryption_notify
@@ -64,7 +66,7 @@ class EcoRake
           puts msg
           exit 1 if options[:simulate]
           exit 1 if options[:no_email]
-          exit 1 unless inbox = mail_to
+          exit 1 unless (inbox = mail_to)
 
           email(enviro: target_enviro, to: inbox, subject: msg, body: msg)
           exit 1

data/lib/eco-rake/lib/people/sync_rely.rb

@@ -5,6 +5,7 @@ class EcoRake
       class SyncRely < EcoRake::Lib::People::BaseTask
         FORWARD_RULES = {
           enviro:     :mirror,
+          space:      :mirror,
           schema:     :mirror,
           folder:     :mirror,
           only_stats: :mirror,

data/lib/eco-rake/lib/task/runner_launch.rb

@@ -4,6 +4,7 @@ class EcoRake
       class RunnerLaunch < EcoRake::Lib::BaseTask
         FORWARD_RULES = {
           enviro:   ->(enviro) { "-#{enviro}"},
+          space:    :mirror,
           simulate: '-simulate'
         }.freeze
 
@@ -13,20 +14,62 @@ class EcoRake
         attr_const :target_enviro, required: true
         option_reopen :enviro, default_lookup: :target_enviro
 
+        option_reopen :task, type: [], desc: 'Target task to run', required: true
+
+        # Offer native way to declare tasks
+        class << self
+          def subtask(name, desc = nil, **kargs, &block)
+            EcoRake::Subtask.new(name, desc, **kargs, &block).tap do |subtask|
+              raise "Task '#{name}' is already defined" if subtasks.key?(subtask.name)
+
+              option_get(:task).tap do |option|
+                option.enum_options.push(subtask.name)
+                subtasks[subtask.name] = subtask
+              end
+            end
+          end
+
+          def subtasks
+            @subtasks ||= {}
+          end
+        end
+
         option_forwarding(**FORWARD_RULES)
 
+        def task(*args)
+          if (callback = target_subtask.callback)
+            instance_exec(*args, &callback)
+          elsif respond_to?(target_subtask.name, true)
+            send(target_subtask.name)
+          else
+            msg = "Undefined method to perform '#{target_subtask.name}'"
+            raise msg
+          end
+        end
+
+        protected
+
+        def target_subtask
+          subtask_name = options[:task].to_sym
+          self.class.subtasks[subtask_name].tap do |ts|
+            next if ts
+
+            raise "Couldn't find any (sub)task named '#{subtask_name}'"
+          end
+        end
+
         private
 
         def command(*args)
           cmd = [ruby_runner]
-          cmd.push(*forward_options(:enviro, :simulate))
+          cmd.push(*forward_options(:enviro, :space, :simulate))
           cmd.push(*args)
           cmd = yield(cmd) if block_given?
           string_cmd(*cmd)
         end
 
         def people_get_command
-          string_cmd(ruby_runner, forward_option(:enviro), '-get-people')
+          string_cmd(ruby_runner, *forward_options(:enviro, :space), '-get-people')
         end
       end
     end

data/lib/eco-rake/lib/task/runner_options.rb

@@ -4,6 +4,7 @@ class EcoRake
       class RunnerOptions < EcoRake::Options::Set
         option '-s', '--simulate', TrueClass, 'Do a dry-run (with no changes)'
         option '-e', '--enviro ENVIRO', String, desc: 'Target environment to run against (i.e. org, live)', required: true
+        option '-w', '--space SPACE', String, desc: 'Target space of the envionment (i.e. uat)'
         option '-t', '--task NAME', String, desc: 'Target task to run', required: true
       end
     end

data/lib/eco-rake/lib/task/runner_rely.rb

@@ -4,7 +4,8 @@ class EcoRake
       class RunnerRely < EcoRake::Lib::BaseTask
         FORWARD_RULES = {
           simulate: :mirror,
-          task:     :mirror
+          task:     :mirror,
+          space:    :mirror
         }.freeze
 
         options_with_defaults true

data/lib/eco-rake/option/default_lookup.rb

@@ -6,7 +6,8 @@ class EcoRake
     module DefaultLookup
       class << self
         def included(base)
-          super(base)
+          super
+
           base.extend EcoRake::Base::SymbolResolver
         end
       end
@@ -14,6 +15,7 @@ class EcoRake
       # Default may be a lookup
       def default(&block)
         return @default unless default_lookup?
+
         result = self.class.safe_call(@default, parent, &block)
         result = self.class.safe_call(result, &block) if [Proc, Method].any? {|k| result.is_a?(k)}
         result
@@ -23,9 +25,11 @@ class EcoRake
       # @return [Class, NilClass]
       def type_coercion
         return @type_coercion if @type_coercion
-        return nil            unless default?
+        return                unless default?
+
         value = default
-        return nil if value.nil?
+        return if value.nil?
+
         value.class
       end
 

data/lib/eco-rake/option/mirror.rb

@@ -24,7 +24,7 @@ class EcoRake
         opt = name_hyphened
         # puts "boolean_mirror (#{value}): #{opt}" if name == :no_get
 
-        return nil unless [TrueClass, NilClass, FalseClass].any? {|klass| type_coercion == klass}
+        return unless [TrueClass, NilClass, FalseClass].any? {|klass| type_coercion == klass}
 
         enabled_value = !boolean_name? || [TrueClass, NilClass].any? {|klass| type_coercion == klass}
         return opt       if value == enabled_value

data/lib/eco-rake/option/parented.rb

@@ -3,7 +3,7 @@ class EcoRake
     module Parented
       attr_accessor :parent
 
-      def initialize(*args, _parent: nil, **kargs, &block)
+      def initialize(*args, _parent: nil, **kargs, &block) # rubocop:disable Lint/UnderscorePrefixedVariableName
         self.parent = _parent
         super(*args, **kargs, &block)
       end

data/lib/eco-rake/options/library.rb

@@ -17,6 +17,7 @@ class EcoRake
         # Iterator
         def each(&block)
           return to_enum(:each) unless block_given?
+
           sets.values.each(&block)
         end
 
@@ -29,12 +30,13 @@ class EcoRake
         # @return [Boolean]
         def set?(name)
           raise "Expected String or Symbol. Given: #{name.class}" unless name.respond_to?(:to_sym)
+
           sets.key?(name.to_sym)
         end
 
         # @return [Array<Symbol>] names list of all available option sets.
         def names
-          setes.keys
+          sets.keys
         end
 
         # Add a new options set.

data/lib/eco-rake/subtask.rb

@@ -0,0 +1,12 @@
+class EcoRake
+  class Subtask
+    attr_reader :name, :desc, :params, :callback
+
+    def initialize(name, desc = nil, **kargs, &callback)
+      @name     = name.to_sym
+      @desc     = desc || kargs.delete(:desc)
+      @params   = kargs
+      @callback = callback
+    end
+  end
+end

data/lib/eco-rake/version.rb

@@ -1,5 +1,5 @@
 require 'rake-commander'
 
 class EcoRake < RakeCommander
-  VERSION = '0.2.7'.freeze
+  VERSION = '0.2.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eco-rake
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.9
 platform: ruby
 authors:
 - Oscar Segura Samper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-16 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,12 +31,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '14'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
@@ -46,50 +46,50 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.6.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 3.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.34
+        version: 3.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 0.9.34
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 0.9.34
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ses
   requirement: !ruby/object:Gem::Requirement
@@ -150,14 +150,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: sendgrid-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -245,6 +245,7 @@ files:
 - lib/eco-rake/shell/eco_helpers.rb
 - lib/eco-rake/shell/files.rb
 - lib/eco-rake/shell/gpg.rb
+- lib/eco-rake/subtask.rb
 - lib/eco-rake/utils.rb
 - lib/eco-rake/utils/mailer.rb
 - lib/eco-rake/utils/mailer/aws_provider.rb