master_delivery 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aba61c0ea3104a071ce2c5987a4b7b0319cc87b1a64b3352c8e2b07551bc063
-  data.tar.gz: daa1a7f63bae834f2539d2ba1ff5bf0b9987449b758fedd18c6e6aab6aa3a738
+  metadata.gz: 4fd9a6ebb7e41f0328c46e274a36d8a0baf7e4b1549e0f88865bfcdae47462ec
+  data.tar.gz: 23dff41dd71f145e7bf5f3b835e049080d6ce210784b859a301f7c40aed1af2e
 SHA512:
-  metadata.gz: ace2378bde5c4f0d6e3fd70e1c301580d46892464fade2337959b326c82d7aa84cc931c0bc82f23eda231a8f7dcc621b18791d5a83ab345f2ac8bfb189c74daf
-  data.tar.gz: 509200607c8e606886795d02e7327b913cea049efcb8d698c2d5eed1eac3f30f06a24fc714e9d901e1a6f876a200b2ded7d3465fb068c15eb00a80cc0dc3a398
+  metadata.gz: 2b486c93913a8b1c7a572eb5fae14fb394a9ea94f4da36ffccf3fe0acdaeee70adef7addafbfa856b35e7eb22d5030308c6413e34a1caf88ecf584944151866c
+  data.tar.gz: 8155f6027b8af3e52ed1728f71dfc7a91d46f1e1e48f1fe8f47cef92a484db116b038dbf1cdf81d57de161019a260155580134f73f4168d7aad62c64e0d0abad

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [v1.0.3](https://github.com/shinyaohtani/master_delivery/tree/v1.0.3) (2020-04-28)
+
+[Full Changelog](https://github.com/shinyaohtani/master_delivery/compare/v1.0.2...v1.0.3)
+
+- Option to suppress non-error message
+- Described the difference with rsync on README.md
+
+**Implemented enhancements:**
+
+- Option to suppress messages [\#4](https://github.com/shinyaohtani/master_delivery/issues/4)
+
+**Merged pull requests:**
+
+- Implemented message suppressor  [\#12](https://github.com/shinyaohtani/master_delivery/pull/12) ([shinyaohtani](https://github.com/shinyaohtani))
+- release note [\#9](https://github.com/shinyaohtani/master_delivery/pull/9) ([shinyaohtani](https://github.com/shinyaohtani))
+
 ## [v1.0.2](https://github.com/shinyaohtani/master_delivery/tree/v1.0.2) (2020-04-27)
 
 [Full Changelog](https://github.com/shinyaohtani/master_delivery/compare/v1.0.1...v1.0.2)

data/Gemfile.lock

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

data/README.md

@@ -1,7 +1,41 @@
+[![Gem Version](https://badge.fury.io/rb/master_delivery.svg)](https://badge.fury.io/rb/master_delivery)
+
 # MasterDelivery
 
 `MasterDelivery` is a master file manager utility. `MasterDelivery` delivers all master files managed in a single master snapshot directory into the specified directory while maintaining the hierarchy of the master snapshot directory. If the destination file already exists, back it up first and then deliver the master file.
 
+**The difference with rsync** is that `MasterDelivery` creates a symlinks instead of copying the master files. They are symlinks, so you have to keep in mind that you have to keep the master files in the same location,
+but it also has the advantage that the master file is updated at the same time when you directly make changes to the delivered file.
+
+Do you have any experience that the master file is getting old gradually? `MasterDelivery` can prevent this.
+
+If the master directory is git or svn managed, you can manage revisions of files that are delivered here and there at once with commands like git diff and git commit.
+
+## Example
+
+If you specify command line arguments `MASTER_DIR` and `DELIVERY_ROOT` as follows:
+```bash
+$ master_delivery -m ~/master/my_home_setting -d /Users/foo
+```
+This means:
+```
+(-m) MASTER_DIR:   -m ~/master/my_home_setting
+(-d) DELIVER_ROOT: -d /Users/foo
+```
+
+and suppose master files now in `MASTER_DIR` are as follows:
+```
+~/master/my_home_setting/.zshrc
+~/master/my_home_setting/work/.rubocop.yml
+```
+
+then these files will be delivered as the following files:
+```
+/Users/foo/.zshrc
+/Users/foo/work/.rubocop.yml
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,19 +55,6 @@ Or install it yourself as:
 ## Usage
 
 ```
-Example:
-    If you specify MASTER_DIR and DELIVERY_ROOT as follows:
-       MASTER_DIR:    -m ~/masters/my_home_setting
-       DELIVERY_ROOT: -d /Users/foo
-
-    and suppose master files in MASTER_DIR are as follows:
-       ~/master/my_home_setting/.zshrc
-       ~/master/my_home_setting/work/.rubocop.yml
-
-    then these files will be delivered as the following files:
-       /Users/foo/.zshrc
-       /Users/foo/work/.rubocop.yml
-
 Usage: master_delivery -m <dir> -d <dir> [options]
  Required:
     -m, --master [MASTER_DIR]        Master snapshot directory. All master files in this
@@ -60,6 +81,17 @@ Usage: master_delivery -m <dir> -d <dir> [options]
                                      the commands on stderr.
                                      We strongly recommend "--dryrun" before running.
                                       (default: --no-dryrun)
+    -q, --[no-]quiet                 Suppress non-error messages
+                                      (default: --no-quiet)
+    -y, --[no-]yes                   Skip confirmation. It is recommended to execute
+                                     the command carefully without skipping confirmation.
+                                     With the "--yes" option, if you want to change the
+                                     command line argument even a little, remove the
+                                     "--yes" option once, execute it several times,
+                                     and experience confirmation several times.
+                                     Also, it's a good idea to add the "--yes" option
+                                     only after you start to feel confirmation annoying.
+                                      (default: --no-yes)
 
  Common options:
     -h, --help                       Show this message
@@ -75,8 +107,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/master_delivery. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/master_delivery/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome!
+1. Fork it ( https://github.com/shinyaohtani/master_delivery )
+1. Create your feature branch (git checkout -b my-new-feature)
+1. Commit your changes (git commit -am 'Add some feature')
+1. Push to the branch (git push origin my-new-feature)
+1. Create a new Pull Request
 
 ## License
 
@@ -84,4 +120,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the MasterDelivery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/master_delivery/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the MasterDelivery project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shinyaohtani/master_delivery/blob/master/CODE_OF_CONDUCT.md).

data/lib/cli_master_delivery.rb

@@ -39,6 +39,10 @@ module MasterDelivery
     We strongly recommend "--dryrun" before running.
      (default: --no-dryrun)
   DRYRUN
+  DESC_QUIET = <<~QUIET
+    Suppress non-error messages
+     (default: --no-quiet)
+  QUIET
   DESC_SKIP_CONF = <<~SKIP_CONF
     Skip confirmation. It is recommended to execute
     the command carefully without skipping confirmation.
@@ -70,7 +74,7 @@ module MasterDelivery
     attr_accessor :params
 
     def initialize
-      @params = { type: VALUE_DELIVERY_TYPE[0].to_sym, dryrun: false }
+      @params = { type: VALUE_DELIVERY_TYPE[0].to_sym, dryrun: false, quiet: false }
     end
 
     def parse_options
@@ -86,11 +90,10 @@ module MasterDelivery
       master_dir = File.expand_path(@params[:master])
       md = MasterDelivery.new(File.dirname(master_dir), @params[:backup])
       arg_set = [File.basename(master_dir), @params[:delivery]]
-      arg_hash = { type: @params[:type], dryrun: @params[:dryrun] }
-      return unless md.confirm(*arg_set, skip_conf: @params[:yes], **arg_hash)
+      return unless md.confirm(*arg_set, **(@params.slice(:type, :quiet, :dryrun, :skip_conf)))
 
-      md.deliver(*arg_set, **arg_hash)
-      puts 'done!'
+      md.deliver(*arg_set, **(@params.slice(:type, :dryrun)))
+      puts 'done!' unless @params[:quiet]
     end
 
     private
@@ -105,6 +108,7 @@ module MasterDelivery
       opts.on('-t [DELIVERY_TYPE]', '--type [DELIVERY_TYPE]', *DESC_DELIVERY_TYPE.split(/\R/), &:to_sym)
       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('-y',                 '--[no-]yes', *DESC_SKIP_CONF.split(/\R/)) { |v| v }
       opts.separator ''
       opts.separator ' Common options:'

data/lib/master_delivery.rb

@@ -69,14 +69,18 @@ module MasterDelivery
       backup_dir
     end
 
-    def confirm(master_id, target_prefix, type: :symbolic_link, dryrun: false, skip_conf: false)
-      puts MSG_CONFIRMATION_INTRO unless skip_conf
+    def confirm(master_id, target_prefix, 
+                type: :symbolic_link, dryrun: false, skip_conf: false, quiet: false)
 
-      print_params(master_id, target_prefix, type: type, dryrun: dryrun)
-      print_sample(master_id, target_prefix)
+      unless quiet
+        puts MSG_CONFIRMATION_INTRO unless skip_conf
+        print_params(master_id, target_prefix, type: type, dryrun: dryrun)
+        print_sample(master_id, target_prefix)
+      end
       print MSG_CONFIRMATION.chomp unless skip_conf # use print instead of puts for '\n'
       return true if skip_conf || gets.chomp == 'y'
 
+      puts 'aborted.'
       false
     end
 

data/lib/master_delivery/version.rb

@@ -1,11 +1,24 @@
 # frozen_string_literal: true
 
 module MasterDelivery
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
   DESCRIPTION = <<~DESC
     Deliver all master files managed in a single master snapshot directory
     into the specified directory while maintaining the hierarchy of the
     master snapshot directory. If the destination file already exists,
     back it up first and then deliver the master file.
+
+    The difference with rsync is that master_delivery creates a symlinks
+    instead of copying the master files. They are symlinks, so you have to
+    keep in mind that you have to keep the master files in the same location,
+    but it also has the advantage that the master file is updated at the same
+    time when you directly make changes to the delivered file.
+
+    Do you have any experience that the master file is getting old gradually?
+    master_delivery can prevent this.
+
+    If the master directory is git or svn managed, you can manage revisions
+    of files that are delivered here and there at once with commands
+    like git diff and git commit.
   DESC
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_delivery
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Shinya Ohtani (shinyaohtani@github)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -141,6 +141,19 @@ description: |
   into the specified directory while maintaining the hierarchy of the
   master snapshot directory. If the destination file already exists,
   back it up first and then deliver the master file.
+
+  The difference with rsync is that master_delivery creates a symlinks
+  instead of copying the master files. They are symlinks, so you have to
+  keep in mind that you have to keep the master files in the same location,
+  but it also has the advantage that the master file is updated at the same
+  time when you directly make changes to the delivered file.
+
+  Do you have any experience that the master file is getting old gradually?
+  master_delivery can prevent this.
+
+  If the master directory is git or svn managed, you can manage revisions
+  of files that are delivered here and there at once with commands
+  like git diff and git commit.
 email:
 - shinya_ohtani@yahoo.co.jp
 executables: