caravan 0.7.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f04af0c92d6322edaa0e750792d9377184adec46
-  data.tar.gz: d02d0c1601d98d6e0f1e33050113fbe5b7bb94e3
+  metadata.gz: 347b4140ddb514fb5e09308d12b9d36cca9456b1
+  data.tar.gz: 0a84aa9ec43f5f0957e6af0dd34c38a0bf95e6fa
 SHA512:
-  metadata.gz: 5bd169ffcb6a9f6caf6d9f912926085fce3a5cf3a09930690465ff0eb0b333d004344485fc0c0dbdacef86195a26d73ee3ddc865c4e76524bb006660ea05eb92
-  data.tar.gz: efb1b60eb0a047213f423f90f3c9a2270f10ccdc62b5100f6ec9034c23b7d192c4035ee422225cb4cc94b48df7315f47ba32d79f7c5d9c883ac1cd3293451190
+  metadata.gz: 97ee509584f9629bae857d6f1998b5db05137d2c44788af41a91fc45af09b8cf100600993fbcf19fa71989bd43df57e53006586ff6064547c58bf5927a155560
+  data.tar.gz: 4c2ecc7541ed788ed0e3aa8e5018843fcffb2eedcd4ce6f02dd57aed3d3322df134e31fe16dc8f076350640095f029f0589a52a5280d36ac695bdc62ab483891

data/.rubocop.yml

@@ -2,3 +2,5 @@ Style/StringLiterals:
   Enabled: false
 Metrics/MethodLength:
   Max: 30
+Style/Documentation:
+  Enabled: false

data/README.md

@@ -2,8 +2,8 @@
 
 [![Gem Version](https://badge.fury.io/rb/caravan.svg)](https://badge.fury.io/rb/caravan)
 [![](https://api.travis-ci.org/crispgm/gsm.svg)](https://travis-ci.org/crispgm/caravan)
-[![Code Climate](https://codeclimate.com/github/crispgm/caravan/badges/gpa.svg)](https://codeclimate.com/github/crispgm/caravan)
-[![Test Coverage](https://codeclimate.com/github/crispgm/caravan/badges/coverage.svg)](https://codeclimate.com/github/crispgm/caravan/coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3d0007620855bd6ffea0/maintainability)](https://codeclimate.com/github/crispgm/caravan/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3d0007620855bd6ffea0/test_coverage)](https://codeclimate.com/github/crispgm/caravan/test_coverage)
 
 Simple project files watcher and deployer.
 
@@ -11,7 +11,7 @@ The scenario is when we are developing in your local workspace and the program o
 
 ![](/assets/civ-5-caravan.png)
 
-This is the caravan in [Sid Meier's Civilization V](http://www.civilization5.com/), which the project name originally comes from.
+This is the caravan in [Sid Meier's Civilization V](http://www.civilization5.com/), where the project name originally comes from.
 
 ## Installation
 
@@ -30,6 +30,7 @@ $ caravan --help
     -i, --ignore IGNORE_FILES        Ignore files
     -o, --once                       Deploy for once
     -b, --debug                      Debug mode
+    -l, --load YAML_FILE             YAML file (Default: ./caravan.yml)
         --version                    Show version
 ```
 
@@ -79,11 +80,17 @@ You may also write `src` and `dst` to `caravan.yml`. Hence, deployment made even
 $ caravan
 ```
 
+`caravan.yml` can be named as you like. To load your own YAML file, use `--load`:
+
+```
+$ caravan --load my-caravan.yml
+```
+
 ### Deploy Modes
 
-* shell
+* Shell
     * `cp` in local.
-* scp
+* Secure copy (scp)
     * `scp` to remote machines, _not recommended_.
 * [rsync](https://rsync.samba.org/)
     * `rsync` to remote machines, which is the default and recommended mode because it is incremental. Thus, it performs much better.
@@ -101,8 +108,9 @@ $ caravan
     - [x] `before_deploy`
     - [x] `after_deploy`
     - [x] `before_destroy`
-- [ ] Multiple deployment configurations
+- [ ] ~~Multiple deployment configurations~~
+- [ ] Extension to deploy methods
 
-## LICENSE
+## License
 
 [MIT](/LICENSE)

data/docs/.gitignore

@@ -0,0 +1,4 @@
+_site
+.sass-cache
+.jekyll-metadata
+gh-pages

data/docs/Gemfile

@@ -0,0 +1,30 @@
+source "https://rubygems.org"
+
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 3.8.1"
+
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.0"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+  gem "black-white-blue"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0" if Gem.win_platform?

data/docs/Rakefile

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+namespace :site do
+  desc "Serve site"
+  task :serve do
+    sh "bundle exec jekyll serve --draft --future --livereload"
+  end
+
+  desc "Build jekyll and push to gh-pages branch"
+  task :build do
+    # Clone to gh-pages
+    unless File.exist?("gh-pages")
+      sh "git clone -b gh-pages https://github.com/crispgm/caravan.git gh-pages"
+    end
+    # Checkout and pull
+    Dir.chdir("gh-pages") do
+      sh "git checkout gh-pages"
+      sh "git pull origin gh-pages"
+    end
+    # Build site
+    Dir.chdir(".") do
+      sh "bundle exec jekyll build --destination=./gh-pages/"
+    end
+    # Push
+    Dir.chdir("gh-pages") do
+      sh "git add ."
+      sh "git commit --allow-empty -m \"Deployed at #{Time.now}\""
+      sh "git push origin gh-pages"
+    end
+  end
+end

data/docs/_config.yml

@@ -0,0 +1,34 @@
+baseurl: "/caravan"
+project:
+  name: Caravan
+  subtitle: Simple project files watcher and deployer
+  description: >- # this means to ignore newlines until "baseurl:"
+    The scenario is when we are developing in your local workspace and the program only runs in specific runtime environment, we have to setup by ourself to make the program run and debug on runtime folders, or remote machines. Caravan is the automation tool designed for solving such kind of problems by watching the file changes, and deploy them automatically to its destination.
+  repo: "crispgm/caravan"
+  logo: "/caravan/assets/civ-5-caravan.png"
+  author: "David Zhang"
+  author_link: "https://crispgm.com/"
+  email: crispgm@gmail.com
+  twitter: crispgm
+  medium: "@crispgm"
+highlightjs: true
+
+# Build settings
+markdown: kramdown
+theme: black-white-blue
+plugins:
+  - jekyll-feed
+exclude:
+  - gh-pages
+  - Rakefile
+# Exclude from processing.
+# The following items will not be processed, by default. Create a custom list
+# to override the default setting.
+# exclude:
+#   - Gemfile
+#   - Gemfile.lock
+#   - node_modules
+#   - vendor/bundle/
+#   - vendor/cache/
+#   - vendor/gems/
+#   - vendor/ruby/

data/docs/_data/changelog.yml

@@ -0,0 +1,36 @@
+- version: "0.7.0"
+  changes:
+    - text: "Specify caravan.yml's name"
+      hash: 77df905
+- version: "0.6.2"
+  changes:
+    - text: "Set default deploy_mode: rsync"
+      hash: 1ab105b
+- version: "0.6.1"
+  changes:
+    - text: "Bugfix: use the right conf when merging with options"
+      hash: 6408066
+- version: "0.6.0"
+  changes:
+    - text: "Use --init to generate caravan.yml"
+    - text: "Bugfix: exit after init caravan.yml"
+    - text: "Docs on examples and confs"
+- version: "0.5.2"
+  changes:
+    - text: "Add deploy at once"
+    - text: "Parse caravan.yml for src & dst"
+      issue: 4
+- version: "0.5.1"
+  changes:
+    - text: "Implement Hooks"
+- version: "0.4.0"
+  changes:
+    - text: "Add full options in docs"
+      hash: b2d3774
+- version: "0.4.0.beta"
+  changes:
+    - text: "Add caravan init to generate default conf file"
+- version: "0.2.0"
+  changes:
+    - text: "Basically works"
+      hash: 7f0a548

data/docs/about.md

@@ -0,0 +1,10 @@
+---
+layout: page
+title: About
+---
+
+Copyright © [David Zhang](https://crispgm.com/), 2018.
+
+Caravan is licensed under MIT License.
+
+Site theme is [Black White Blue](https://crispgm.github.io/black-white-blue/).

data/docs/changelog.html

@@ -0,0 +1,23 @@
+---
+layout: changelog
+title: Changelog
+---
+
+<div class="article" id="changelog">
+  {% for change in site.data.changelog %}
+    <h3>Version {{ change.version }}</h3>
+    <ul>
+      {% for log in change.changes %}
+        <li>
+          {{ log.text }}
+          {% if log.issue != nil %}
+            <a href="https://github.com/{{ site.project.repo }}/issues/{{ log.issue }}">#{{ log.issue }}</a></li>
+          {% endif %}
+          {% if log.hash != nil %}
+            <a href="https://github.com/{{ site.project.repo }}/commit/{{ log.hash }}">#{{ log.hash }}</a>
+          {% endif %}
+        </li>
+      {% endfor %}
+    </ul>
+  {% endfor %}
+</div>

data/docs/docs.md

@@ -0,0 +1,114 @@
+---
+layout: page
+title: Documentation
+---
+
+Simple project files watcher and deployer.
+
+The scenario is when we are developing in your local workspace and the program only runs in specific runtime environment, we have to setup by ourself to make the program run and debug on runtime folders, or remote machines. Caravan is the automation tool designed for solving such kind of problems by watching the file changes, and deploy them automatically to its destination.
+
+![](/assets/civ-5-caravan.png)
+
+This is the caravan in [Sid Meier's Civilization V](http://www.civilization5.com/), where the project name originally comes from.
+
+## Installation
+
+```
+$ gem install caravan
+```
+
+## Usage
+
+```
+$ caravan --help
+
+    -s, --source SOURCE_PATH         Source path
+    -d, --dest DEST_PATH             Destination path
+    -m, --mode DEPLOY_MODE           Deploy mode
+    -i, --ignore IGNORE_FILES        Ignore files
+    -o, --once                       Deploy for once
+    -b, --debug                      Debug mode
+    -l, --load YAML_FILE             YAML file (Default: ./caravan.yml)
+        --version                    Show version
+```
+
+## Examples
+
+Deploy to local directory:
+
+```
+$ caravan -s /path/to/project/. -d /path/to/deploy -m shell
+```
+
+Deploy to remote machines:
+
+```
+$ caravan -s /path/to/project/. -d user@remote_machines:/path/to/deploy -m rsync
+```
+
+Deploy only once:
+
+```
+$ caravan -s /path/to/project/. -d user@remote_machines:/path/to/deploy -m rsync --once
+```
+
+## Configuration
+
+Generate default configuration:
+
+```
+$ cd /path/to/src
+$ caravan --init
+```
+
+A `caravan.yml` will be generated as `/path/to/src/caravan.yml`. You may specify any options in command arguments except source path.
+
+```
+debug: false
+deploy_mode: rsync_local
+incremental: true
+exclude:
+- ".git"
+- ".svn"
+```
+
+You may also write `src` and `dst` to `caravan.yml`. Hence, deployment made even easier.
+
+```
+$ caravan
+```
+
+`caravan.yml` can be named as you like. To load your own YAML file, use `--load`:
+
+```
+$ caravan --load my-caravan.yml
+```
+
+### Deploy Modes
+
+* Shell
+    * `cp` in local.
+* Secure copy (scp)
+    * `scp` to remote machines, _not recommended_.
+* [rsync](https://rsync.samba.org/)
+    * `rsync` to remote machines, which is the default and recommended mode because it is incremental. Thus, it performs much better.
+* rsync_local
+    * `rsync` in local.
+
+## Plan
+
+- [x] Basic watching and deploying
+- [x] Exclude watching unwanted files
+- [x] `caravan.yml` for project-specialized configuration
+- [x] Callbacks for deployment
+    - [x] `after_create`
+    - [x] `after_change`
+    - [x] `before_deploy`
+    - [x] `after_deploy`
+    - [x] `before_destroy`
+- [ ] ~~Multiple deployment configurations~~
+- [ ] Extension to deploy methods
+
+## License
+
+[MIT](/LICENSE)

data/docs/index.html

@@ -0,0 +1,50 @@
+---
+layout: index
+title: Home
+---
+
+<div class="section intro" id="introduction">
+  {% if site.project.logo != nil and site.project.logo != "" %}
+  <div class="intro-logo">
+    <img src="{{ site.project.logo }}">
+  </div>
+  {% endif %}
+
+  <div class="intro-text">
+    {{ site.project.subtitle }}
+  </div>
+
+  <div class="intro-desc">
+    {{ site.project.description }}
+  </div>
+
+  <div class="intro-button">
+    <div class="install-item">
+      <a href="{{ site.baseurl }}/docs.html#getting-started">Getting Started</a>
+    </div>
+  </div>
+
+  <div class="intro-version">
+    <span>Version <a href="{{ site.baseurl }}/changelog.html">{{ site.data.changelog[0].version }}</a> ·</span>
+    <span>Created by <a href="{{ site.project.author_link }}">{{ site.project.author }}</a></span>
+  </div>
+
+  <div class="social">
+    <a class="github-button"
+       href="https://github.com/{{ site.project.repo }}"
+       data-icon="octicon-star"
+       data-count-href="/{{ site.project.repo }}/stargazers"
+       data-count-api="/repos/{{ site.project.repo }}#stargazers_count"
+       data-count-aria-label="# stargazers on GitHub"
+       aria-label="Star {{ site.project.repo }} on GitHub">Star
+     </a>
+    <a class="github-button"
+       href="https://github.com/{{ site.project.repo }}/fork"
+       data-icon="octicon-repo-forked"
+       data-count-href="/{{ site.project.repo }}/network"
+       data-count-api="/repos/{{ site.project.repo }}#forks_count"
+       data-count-aria-label="# forks on GitHub"
+       aria-label="Fork {{ site.project.repo }} on GitHub">Fork
+    </a>
+  </div>
+</div>

data/exe/caravan

@@ -6,6 +6,7 @@ require "optparse"
 require "caravan"
 
 options = {}
+# rubocop:disable Metrics/BlockLength
 option_parser = OptionParser.new do |opts|
   opts.banner = "Caravan #{Caravan::VERSION}\nCopyright (c) David Zhang 2018\n"
   opts.separator ""
@@ -14,6 +15,10 @@ option_parser = OptionParser.new do |opts|
     options[:yaml] = value
   end
 
+  opts.on("-c SPEC_NAME", "--spec SPEC_NAME", "Spec name") do |value|
+    options[:spec] = value
+  end
+
   opts.on("-s SOURCE_PATH", "--source SOURCE_PATH", "Source path") do |value|
     options[:src] = value
   end
@@ -53,19 +58,32 @@ option_parser = OptionParser.new do |opts|
     exit
   end
 end
+# rubocop:enable Metrics/BlockLength
 
-if ARGV.length == 0
-  merged_conf = Caravan::Config.merge({}, Caravan.process_conf("."))
+spec_name = options[:spec] || Caravan::Config.default_spec_name
+
+if ARGV.length.zero?
+  merged_conf = Caravan::Config.merge({}, Caravan.process_conf("."), spec_name)
 else
   option_parser.parse!(ARGV)
-  if options.key?(:yaml)
-    merged_conf = Caravan::Config.merge(options, Caravan.process_conf(options[:src], options[:yaml]))
-  else
-    merged_conf = Caravan::Config.merge(options, Caravan.process_conf(options[:src]))
-  end
+  merged_conf = if options.key?(:yaml)
+                  Caravan::Config.merge(
+                    options,
+                    Caravan.process_conf(options[:src], options[:yaml]),
+                    spec_name
+                  )
+                else
+                  Caravan::Config.merge(
+                    options,
+                    Caravan.process_conf(options[:src]),
+                    spec_name
+                  )
+                end
 end
 
-if merged_conf.key?("src") && merged_conf.key?("dst") && merged_conf.key?("deploy_mode")
+if merged_conf.key?("src") &&
+   merged_conf.key?("dst") &&
+   merged_conf.key?("deploy_mode")
   Caravan.start(merged_conf)
 else
   Caravan::Message.error("No src, dst, deploy_mode specified. Cannot deploy.")

data/lib/caravan.rb

@@ -21,7 +21,11 @@ module Caravan
 
       Caravan::Config.pretty_puts(merged_conf)
 
-      deployer = Caravan::Deploy.create_deployer(src_path, target_path, deploy_mode)
+      deployer = Caravan::Deploy.create_deployer(
+        src_path,
+        target_path,
+        deploy_mode
+      )
       deployer.debug = true if debug
       exit(-1) if deployer.nil?
 
@@ -62,6 +66,7 @@ module Caravan
         return unless deployer.before_deploy
         deployer.run
         deployer.after_deploy
+        # rubocop:enable Lint/NonLocalExitFromIterator
       end
     end
 
@@ -78,7 +83,10 @@ module Caravan
     end
 
     def dump_default_conf
-      user_config_path = File.join(File.expand_path("."), Caravan::Config.default_conf_name)
+      user_config_path = File.join(
+        File.expand_path("."),
+        Caravan::Config.default_conf_name
+      )
       default_conf = Caravan::Config.default_conf
 
       Caravan::Config.dump(user_config_path, default_conf)

data/lib/caravan/command.rb

@@ -4,7 +4,7 @@ module Caravan
       def run(cmd, debug = false)
         output = `#{cmd}`
         Caravan::Message.debug(cmd) if debug
-        return $?.exitstatus, output
+        return $CHILD_STATUS.exitstatus, output
       end
     end
   end

data/lib/caravan/config.rb

@@ -3,16 +3,19 @@ require "yaml"
 module Caravan
   class Config < Hash
     DEFAULT_CONFIG = {
-      "debug" => false,
-      "deploy_mode" => "rsync",
-      "incremental" => true,
-      "exclude" => %w(
-        .git .svn
-      ),
-      "once" => false
+      "master" => {
+        "debug" => false,
+        "deploy_mode" => "rsync",
+        "incremental" => true,
+        "exclude" => %w(
+          .git .svn
+        ),
+        "once" => false
+      }
     }.freeze
 
     DEFAULT_CONFIG_NAME = "caravan.yml".freeze
+    DEFAULT_SPEC_NAME = "master".freeze
 
     class << self
       def default_conf
@@ -23,6 +26,10 @@ module Caravan
         DEFAULT_CONFIG_NAME
       end
 
+      def default_spec_name
+        DEFAULT_SPEC_NAME
+      end
+
       def from(user_config_path)
         if File.exist?(user_config_path)
           YAML.load_file(user_config_path)
@@ -34,20 +41,24 @@ module Caravan
       end
 
       def dump(user_config_path, user_config)
+        # rubocop:disable Metrics/LineLength
         File.open(user_config_path, "w") do |f|
           f.write("# Generated Caravan's configuration file.\n")
           f.write("# Use `caravan --help` for instructions on all the configuration values.\n")
           f.write("# Add `src` and `dst` to specify the source and destination.\n")
           f.write(user_config.to_yaml)
         end
+        # rubocop:enable Metrics/LineLength
       end
 
-      def merge(options, conf)
-        if conf.nil?
-          merged_conf = Caravan::Config.default_conf
-        else
-          merged_conf = conf
-        end
+      def merge(options, conf, spec = Caravan::Config.default_spec_name)
+        merged_conf = if conf.nil?
+                        Caravan::Message.warn("Fail to load conf. Use default instead.")
+                        default_spec_name = Caravan::Config.default_spec_name
+                        Caravan::Config.default_conf[default_spec_name]
+                      else
+                        stringify_keys(conf)[spec]
+                      end
 
         merged_conf["src"] = options[:src] if options.key?(:src)
         merged_conf["dst"] = options[:dst] if options.key?(:dst)
@@ -64,6 +75,16 @@ module Caravan
           Caravan::Message.info("=> #{k}: #{v}")
         end
       end
+
+      private
+
+      def stringify_keys(conf)
+        new_conf = {}
+        conf.each do |sym, v|
+          new_conf[sym.to_s] = v
+        end
+        new_conf
+      end
     end
   end
 end

data/lib/caravan/deploy.rb

@@ -89,11 +89,11 @@ module Caravan
 
         status = 0
         if block_given?
-          status, output = yield src, dst
+          status, _output = yield src, dst
           debug_msg("Block `run` returned #{status}")
         end
 
-        Message.error("Deploying block returned false") unless status == 0
+        Message.error("Deploying block returned false") unless status.zero?
         status
       end
 
@@ -120,7 +120,9 @@ module Caravan
       def relative_path(path)
         working_dir = Dir.pwd
         path_routes = path.split(working_dir)
-        return nil if path_routes.nil? || path_routes.empty? || path_routes.size < 2
+        return nil if path_routes.nil? ||
+                      path_routes.empty? ||
+                      path_routes.size < 2
 
         path_routes[-1]
       end

data/lib/caravan/version.rb

@@ -1,3 +1,3 @@
 module Caravan
-  VERSION = "0.7.0".freeze
+  VERSION = "1.0.0.beta1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caravan
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - David Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -128,6 +128,16 @@ files:
 - Rakefile
 - _config.yml
 - caravan.gemspec
+- docs/.gitignore
+- docs/Gemfile
+- docs/Rakefile
+- docs/_config.yml
+- docs/_data/changelog.yml
+- docs/about.md
+- docs/assets/civ-5-caravan.png
+- docs/changelog.html
+- docs/docs.md
+- docs/index.html
 - exe/caravan
 - lib/caravan.rb
 - lib/caravan/command.rb
@@ -154,9 +164,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.11