master_delivery 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d57694762f369b51254410b1275d131512d6ee485a7ead16ad8287e8ace819a5
-  data.tar.gz: 1adbdc9c1b0340d42c9c226b6ea6a7b82fb1954b6fb280cbf8e8f1b8778e8712
+  metadata.gz: b42150430f655e38f3b1c525f8a69e44131f0172d284caa86a9877797d347668
+  data.tar.gz: '05964dc0d64be2f97cdeb94644a7f54a96e543f904c6f71e2f392af9256ad24b'
 SHA512:
-  metadata.gz: dcd1c969e89bc5224b898acc9081ed95e9ce5cddd14ef4a7c26cf56d68e07f864a61ac948d69c76d61dc0c7a50a2ade1ec41ab7b39a9704c27fe96dfe1331a6e
-  data.tar.gz: aa87c276ff2bbc72c0b5fe3e8e0fd14c820b9afa2917f531dadc5e965c529303365940c01bb35f7666e93b3737c304e21c94fcd29321ec27570124628d9a5507
+  metadata.gz: bae487838a7e4a204bcac6defefe30d2f52e3e9491938af723cd2d0b434fe129eb830ed0029d13f23f71ee1eac35d660cac2333ddf4755e7674b9ff4acb04345
+  data.tar.gz: f6f964a1d3a613e9b8a5c4eeb985b065694dd46de861e81a273180e364d787acf573417e160009184aaccbc6f60bf67648a80515d73c1ca90c38e2375e306eb5

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [v1.0.6](https://github.com/shinyaohtani/master_delivery/tree/v1.0.6) (2020-05-06)
+
+[Full Changelog](https://github.com/shinyaohtani/master_delivery/compare/v1.0.5...v1.0.6)
+
+- Verbose mode has been introduced to trace delivery commands!
+
+
+**Implemented enhancements:**
+
+- Option to carefully trace delivery commands one by one [\#5](https://github.com/shinyaohtani/master_delivery/issues/5)
+
+**Merged pull requests:**
+
+- Feature/\#5 trace delivery commands [\#23](https://github.com/shinyaohtani/master_delivery/pull/23) ([shinyaohtani](https://github.com/shinyaohtani))
+
 ## [v1.0.5](https://github.com/shinyaohtani/master_delivery/tree/v1.0.5) (2020-05-03)
 
 [Full Changelog](https://github.com/shinyaohtani/master_delivery/compare/v1.0.4...v1.0.5)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    master_delivery (1.0.5)
+    master_delivery (1.0.6)
 
 GEM
   remote: https://rubygems.org/

data/lib/cli_master_delivery.rb

@@ -44,6 +44,11 @@ module MasterDelivery
     Suppress non-error messages
      (default: --no-quiet)
   QUIET
+  DESC_VERBOSE = <<~VERBOSE
+    Process actual commands for file operations, such as
+    moving files and creating folders, one by one.
+     (default: --no-verbose)
+  VERBOSE
   DESC_SKIP_CONF = <<~SKIP_CONF
     Skip confirmation. It is recommended to execute
     the command carefully without skipping confirmation.
@@ -89,17 +94,23 @@ module MasterDelivery
       return unless check_param_consistency
 
       fix_param_paths(%i[master delivery backup])
-      master = @params[:master]
-      md = MasterDelivery.new(File.dirname(master), @params[:backup])
-      arg_set = [File.basename(master), @params[:delivery]]
-      return unless md.confirm(*arg_set, @params.slice(:type, :quiet, :dryrun, :yes))
+      basics = delivery_basics
+      md = MasterDelivery.new(basics[:master_dir], basics[:backup_root])
+      return unless md.confirm(basics, @params.slice(:type, :quiet, :dryrun, :yes))
 
-      md.deliver(*arg_set, **@params.slice(:type, :dryrun))
-      puts 'done!' unless @params[:quiet]
+      mfiles, _tmpdir = md.deliver(basics, **@params.slice(:type, :dryrun, :verbose))
+      puts "done! (#{mfiles.size} master files are delivered.)" unless @params[:quiet]
     end
 
     private
 
+    def delivery_basics
+      { master_dir: File.dirname(@params[:master]),
+        master_id: File.basename(@params[:master]),
+        delivery_root: @params[:delivery],
+        backup_root: @params[:backup] }
+    end
+
     def define_options(opts) # rubocop:disable Metrics/AbcSize
       opts.version = VERSION
       opts.separator ' Required:'
@@ -111,10 +122,10 @@ module MasterDelivery
       opts.on('-b [BACKUP_ROOT]',   '--backup [BACKUP_ROOT]', *DESC_BACKUP_ROOT.split(/\R/)) { |v| v }
       opts.on('-D',                 '--[no-]dryrun', *DESC_DRYRUN.split(/\R/)) { |v| v }
       opts.on('-q',                 '--[no-]quiet', *DESC_QUIET.split(/\R/)) { |v| v }
+      opts.on('-v',                 '--[no-]verbose', *DESC_VERBOSE.split(/\R/)) { |v| v }
       opts.on('-y',                 '--[no-]yes', *DESC_SKIP_CONF.split(/\R/)) { |v| v }
       opts.separator ''
       opts.separator ' Common options:'
-      # opts.on('-v',    '--verbose', 'Verbose mode. default: no') { |v| v }
       opts.on_tail('-h', '--help', 'Show this message') do
         puts opts
         exit

data/lib/master_delivery/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MasterDelivery
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
   DESCRIPTION = <<~DESC
     Deliver all master files managed in a single master snapshot directory
     into the specified directory while maintaining the hierarchy of the

data/lib/master_delivery.rb

@@ -38,7 +38,7 @@ module MasterDelivery
 
     # @param master_id [String] Top directory name of master
     #
-    # @param target_prefix [String] Files will be delivered to this prefix location.
+    # @param delivery_root [String] Files will be delivered to this prefix location.
     #   If this prefix is empty, it will be placed in the root directory.
     #   This mechanism saves you from having to unnecessarily deepen the directory
     #   hierarchy under master_id.
@@ -46,36 +46,38 @@ module MasterDelivery
     #   Example of prefix
     #     master_id: MID
     #     master: $master_root/MID/a/b/readme.md
-    #     target_prefix: /Users/xxx/yyy
+    #     delivery_root: /Users/xxx/yyy
     #     delivery: /Users/xxx/yyy/a/b/readme.md
     #
     #   Example of no-prefix
     #     master_id: MID
     #     master: $master_root/MID/a/b/readme.md
-    #     target_prefix: (empty)
+    #     delivery_root: (empty)
     #     delivery: /a/b/readme.md
     #
     # @param type [symbol] only link (:symbolic_link) or copy master (:regular_file)
     # @param dryrun [boolean] if set this false, FileUtils::DryRun will be used.
     # note: Even if dryrun: true, @backup_dir is actually created! (for name-consistency)
-    def deliver(master_id, target_prefix, type: :symbolic_link, dryrun: false)
+    def deliver(basics, type: :symbolic_link, dryrun: false, verbose: false)
       FileUtils.mkdir_p(@backup_root)
       utils = dryrun ? FileUtils::DryRun : FileUtils
 
-      backup_dir = Dir.mktmpdir("#{master_id}-original-", @backup_root)
-      master_files(master_id).each do |master|
-        tfile = move_to_backup(master, utils, master_id, target_prefix, backup_dir)
-        deliver_to_target(master, utils, tfile, type)
+      backup_dir = Dir.mktmpdir("#{basics[:master_id]}-original-", @backup_root)
+      puts "mkdir -p #{backup_dir}" if verbose
+      mfiles = master_files(basics[:master_id])
+      mfiles.each do |master|
+        tfile = move_to_backup(master, utils, basics, backup_dir, verbose)
+        deliver_to_target(master, utils, tfile, type, verbose)
       end
-      backup_dir
+      [mfiles, backup_dir]
     end
 
     # @param params [Hash] :type, :dryrun, :yes, :quiet
-    def confirm(master_id, target_prefix, params)
+    def confirm(basics, params)
       unless params[:quiet]
         puts MSG_CONFIRMATION_INTRO unless params[:yes]
-        print_params(master_id, target_prefix, params.slice(:type, :dryrun))
-        print_sample(master_id, target_prefix)
+        print_params(basics, params.slice(:type, :dryrun))
+        print_sample(basics)
       end
       print MSG_CONFIRMATION.chomp unless params[:yes] # use print instead of puts for '\n'
       return true if params[:yes] || gets.chomp == 'y'
@@ -87,42 +89,42 @@ module MasterDelivery
     private
 
     # Move a master file currently used to backup/
-    def move_to_backup(master, utils, master_id, target_prefix, backup_dir)
-      backupfiledir = File.dirname(backup_file_path(master, master_id, backup_dir))
-      utils.mkdir_p(backupfiledir)
-      tfile = target_file_path(master, master_id, target_prefix)
-      utils.mv(tfile, backupfiledir, force: true)
+    def move_to_backup(master, utils, basics, backup_dir, verbose)
+      backupfiledir = File.dirname(backup_file_path(master, basics[:master_id], backup_dir))
+      utils.mkdir_p(backupfiledir, verbose: verbose)
+      tfile = target_file_path(master, basics)
+      utils.mv(tfile, backupfiledir, force: true, verbose: verbose)
       tfile
     end
 
     # Deliver a link to a master (or a copy of a master) in the appropriate directory
-    def deliver_to_target(master, utils, tfile, type)
+    def deliver_to_target(master, utils, tfile, type, verbose)
       tfiledir = File.dirname(tfile)
-      utils.mkdir_p(tfiledir)
+      utils.mkdir_p(tfiledir, verbose: verbose)
       case type
       when :symbolic_link
-        utils.ln_s(master, tfiledir)
+        utils.ln_s(master, tfiledir, verbose: verbose)
       when :regular_file
-        utils.cp(master, tfiledir)
+        utils.cp(master, tfiledir, verbose: verbose)
       end
     end
 
     # @param params [Hash] :type, :dryrun
-    def print_params(master_id, target_prefix, params)
-      mfiles = master_files(master_id)
-      msg =  "(-m) MASTER_DIR:   -m #{@master_root}/#{master_id} (#{mfiles.size} master files)\n"
-      msg += "(-d) DELIVER_ROOT: -d #{File.expand_path(target_prefix)}\n"
+    def print_params(basics, params)
+      mfiles = master_files(basics[:master_id])
+      msg =  "(-m) MASTER_DIR:   -m #{@master_root}/#{basics[:master_id]} (#{mfiles.size} master files)\n"
+      msg += "(-d) DELIVER_ROOT: -d #{File.expand_path(basics[:delivery_root])}\n"
       msg += "(-t) DELIVER_TYPE: -t #{params[:type]}\n"
       msg += "(-b) BACKUP_ROOT:  -b #{@backup_root}\n"
       msg += "(-D) DRYRUN:       #{params[:dryrun] ? '--dryrun' : '--no-dryrun'}\n"
       puts msg
     end
 
-    def print_sample(master_id, target_prefix)
-      mfiles = master_files(master_id)
-      sample_target = target_file_path(mfiles[0], master_id, target_prefix)
-      sample_backup = backup_file_path(mfiles[0], master_id,
-                                       @backup_root + "/#{master_id}-original-XXXX")
+    def print_sample(basics)
+      mfiles = master_files(basics[:master_id])
+      sample_target = target_file_path(mfiles[0], basics)
+      sample_backup = backup_file_path(mfiles[0], basics[:master_id],
+                                       @backup_root + "/#{basics[:master_id]}-original-XXXX")
       puts <<~SAMPLE
 
         Sample (from #{mfiles.size} master files):
@@ -152,8 +154,8 @@ module MasterDelivery
       Pathname.new(path).cleanpath.to_s
     end
 
-    def target_file_path(master, master_id, target_prefix)
-      path = relative_master_path(master, master_id).prepend(File.expand_path(target_prefix))
+    def target_file_path(master, basics)
+      path = relative_master_path(master, basics[:master_id]).prepend(File.expand_path(basics[:delivery_root]))
       Pathname.new(path).cleanpath.to_s
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_delivery
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Shinya Ohtani (shinyaohtani@github)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2020-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler