caravan 0.3.1 → 0.4.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21f5e8e75b19d676bb4530c970b37eceaa6cab66
-  data.tar.gz: 10c5083012689210fe745b4ad9e5b7f13e35f217
+  metadata.gz: 9e2ece0ac4cc244e44066c307bd42ecc2783ce27
+  data.tar.gz: 4c43af6c423ad75213ee3e5d752753b2fa3e44dc
 SHA512:
-  metadata.gz: eaf0c5a0d1d4adb039339b82072cf694b83508856e5378e5fb561c1df015212d3d04035a8f1da03f457d5aca4a3020ae59ca0c69c6ad8fa63eeed944bff43fc1
-  data.tar.gz: f77c3c4033fd6146b1a748871bd164e9adf239a3417b865fa15e2c9a8f7160ff2f63385413602189510b92bebbb3c9e3223899f09b54e53068acdcb9179b3ad9
+  metadata.gz: e0b3518e2c18b8b232a77e1662d5a809e3c308cd74f47e809071193f6c0c2718b665eed0343f3f09672f904348e03724ce5f0e189966b35ce1ceeda3811fd5c1
+  data.tar.gz: f14925bf61bb43e1eee9edd1b3fd76cf4627fffd0a70310e889eac212d4abccd149112a9f348eda2fa8ec7c4de8b32af1c0fedc9780c9533f15ea58f5ad5c229

data/.gitignore

@@ -42,7 +42,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/.travis.yml

@@ -2,10 +2,8 @@ language: ruby
 cache: bundler
 rvm:
   - 2.3.0
-env:
-  - CODECLIMATE_REPO_TOKEN: b72ccd136db6874a3d5dd842c50c1dc0933a1f49a02c55ce8567ec7311600af3
 after_success:
-  - bundle exec codeclimate-test-reporter
+  - CODECLIMATE_REPO_TOKEN=b72ccd136db6874a3d5dd842c50c1dc0933a1f49a02c55ce8567ec7311600af3 bundle exec codeclimate-test-reporter
 notifications:
   email: false
   slack: navyblue-team:ioO5diAGc5WUQVDKc5BH1UbE

data/README.md

@@ -1,10 +1,13 @@
 # [Caravan](https://crispgm.github.io/caravan/)
 
-[![Gem Version](https://badge.fury.io/rb/caravan.svg)](https://badge.fury.io/rb/Caravan)
+[![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)
 
-(WIP) Simple watcher and deployer.
+Simple watcher and deployer.
+
+The background is when you are developing in your local workspace and the program only runs in specific runtime. You have to setup by yourself to make the program run and debug on runtime folders or ,remote machines. Caravan is designed for solving such kind of problems by watching the file changes, and deploy them automatically to the its destination.
 
 ## Installation
 
@@ -24,6 +27,15 @@ Example:
 $ caravan -s /path/to/project/. -d /path/to/deploy -m shell
 ```
 
+## Plan
+
+- [x] Basic watching and deploying
+- [x] Exclude watching unwanted files
+- [x] `caravan.yml` for project-specialized configuration
+- [ ] Watch and deploy only the changed file instead of the whole folder
+- [ ] Callback for deployment
+- [ ] Multiple deployment configurations
+
 ## LICENSE
 
 [MIT](/LICENSE)

data/_config.yml

@@ -0,0 +1,3 @@
+theme: jekyll-theme-modernist
+exclude:
+  - Gemfile

data/exe/caravan

@@ -23,7 +23,11 @@ option_parser = OptionParser.new do |opts|
   end
 
   opts.on("-i IGNORE_FILES", "--ignore IGNORE_FILES", "Ignore files") do |value|
-    options[:ignore] = value || "\.(git|svn)$"
+    if options.key?(:ignore)
+      options[:ignore] << value
+    else
+      options[:ignore] = [value]
+    end
   end
 
   options[:debug] = false
@@ -35,8 +39,13 @@ option_parser = OptionParser.new do |opts|
     puts Caravan::VERSION
     exit
   end
-end.parse!(ARGV)
+end
+
+if ARGV.size == 1 && ARGV[0] == "init"
+  Caravan.dump_default_conf
+end
 
+option_parser.parse!(ARGV)
 if options.key?(:src) && options.key?(:dst)
-    Caravan.start(options)
+  Caravan.start(options)
 end

data/lib/caravan.rb

@@ -15,53 +15,67 @@ DEFAULT_CONFIG_NAME = "caravan.yml".freeze
 module Caravan
   class << self
     def start(options)
-      src_path = options[:src]
-      target_path = options[:dst]
-      mode = options[:mode]
-      ignores = options[:ignore]
-      debug = options[:debug]
+      merged_conf = Caravan::Config.merge(options, process_conf(options[:src]))
+      src_path = merged_conf["src"]
+      target_path = merged_conf["dst"]
+      deploy_mode = merged_conf["deploy_mode"]
+      ignores = merged_conf["exclude"]
+      debug = merged_conf["debug"]
 
-      deployer = Deploy.create_deployer(mode)
+      Caravan::Config.pretty_puts(merged_conf)
+
+      deployer = Caravan::Deploy.create_deployer(deploy_mode)
       deployer.debug = true if debug
       if deployer.nil?
         exit -1
       end
 
-      # process_conf
-
-      listener = Listen.to(src_path) do |modified, added, removed|
-        unless (modified.empty? && added.empty? && removed.empty?)
-          (added + modified + removed).each do |change|
-            Message.info("#{change} was changed.")
-          end
-
-          deployer.run(src_path, target_path)
-        end
+      listener = create_listener(deployer, src_path, target_path)
+      ignores.each do |item|
+        listener.ignore(Regexp.compile(item))
       end
 
-      listener.ignore(ignores)
-
-      Message.success("Starting to watch #{src_path}...")
+      Caravan::Message.success("Starting to watch #{src_path}...")
       deployer.run(src_path, target_path)
       listener.start
       
       trap("INT") do
         listener.stop
-        Message.success("\tHalting watching.")
+        Caravan::Message.success("\tHalting watching.")
         exit 0
       end
 
       sleep_forever
     end
 
-    def process_conf
-      Message.success("Reading configuration...")
-      conf = Caravan::Config.from(DEFAULT_CONFIG_NAME)
-      Config.pretty_puts(conf)
+    def create_listener(deployer, src_path, target_path)
+      Listen.to(src_path) do |modified, added, removed|
+        unless (modified.empty? && added.empty? && removed.empty?)
+          (added + modified + removed).each do |change|
+            Caravan::Message.info("#{change} was changed.")
+          end
+
+          deployer.run(src_path, target_path)
+        end
+      end
+    end
+
+    def process_conf(src_path)
+      Caravan::Message.success("Reading configuration...")
+      user_config_path = File.join(File.expand_path(src_path), DEFAULT_CONFIG_NAME)
+      conf = Caravan::Config.from(user_config_path)
+      conf
     end
 
     def sleep_forever
       loop { sleep 1000 }
     end
+
+    def dump_default_conf
+      user_config_path = File.join(File.expand_path("."), DEFAULT_CONFIG_NAME)
+      default_conf = Caravan::Config.default_conf
+
+      Caravan::Config.dump(user_config_path, default_conf)
+    end
   end
 end

data/lib/caravan/config.rb

@@ -3,6 +3,7 @@ require "yaml"
 module Caravan
   class Config < Hash
     DEFAULT_CONFIG = {
+      "debug" => false,
       "deploy_mode" => "rsync_local",
       "incremental" => true,
       "exclude" => %w(
@@ -19,20 +20,33 @@ module Caravan
         if File.exist?(user_config_path)
           YAML.load_file(user_config_path)
         else
-          dump_conf(user_config_path, default_conf)
-          default_conf
+          Caravan::Message.warning("User configuration [caravan.yml] not found.")
+          Caravan::Message.warning("Use `caravan init` to generate.")
+          default_conf.dup
         end
       end
 
-      def dump_conf(user_config_path, user_config)
+      def dump(user_config_path, user_config)
         File.open(user_config_path, "w") do |f|
           f.write(user_config.to_yaml)
         end
       end
 
+      def merge(options, conf)
+        merged_conf = conf
+        merged_conf["src"] = options[:src]
+
+        merged_conf["dst"] = options[:dst] if options.key?(:dst)
+        merged_conf["debug"] = options[:debug] if options.key?(:debug)
+        merged_conf["deploy_mode"] = options[:mode] if options.key?(:mode)
+        merged_conf["exclude"] = options[:ignore] if options.key?(:ignore)
+
+        merged_conf
+      end
+
       def pretty_puts(conf)
         conf.each do |k, v|
-          Message.info("    => #{k}: #{v}")
+          Caravan::Message.info("=> #{k}: #{v}")
         end
       end
     end

data/lib/caravan/deploy.rb

@@ -3,7 +3,7 @@ require "colorize"
 module Caravan
   module Deploy
     class << self
-      def create_deployer(method = 'shell')
+      def create_deployer(method = "shell")
         case method
         when "shell"
           return Caravan::DeployMethods::Shell.new

data/lib/caravan/version.rb

@@ -1,3 +1,3 @@
 module Caravan
-  VERSION = "0.3.1".freeze
+  VERSION = "0.4.0.beta".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caravan
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0.beta
 platform: ruby
 authors:
 - David Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -120,12 +120,11 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
+- _config.yml
 - caravan.gemspec
-- docs/_config.yml
 - exe/caravan
 - lib/caravan.rb
 - lib/caravan/command.rb
@@ -152,9 +151,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '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

data/Gemfile.lock

@@ -1,46 +0,0 @@
-PATH
-  remote: .
-  specs:
-    Caravan (0.3.0)
-      colorize
-      listen
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    codeclimate-test-reporter (1.0.8)
-      simplecov (<= 0.13)
-    colorize (0.8.1)
-    docile (1.1.5)
-    ffi (1.9.18)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    minitest (5.10.3)
-    rake (10.5.0)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    ruby_dep (1.5.0)
-    shoulda-context (1.2.2)
-    simplecov (0.13.0)
-      docile (~> 1.1.0)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  Caravan!
-  bundler (~> 1.15)
-  codeclimate-test-reporter (~> 1.0.0)
-  minitest (~> 5.0)
-  rake (~> 10.0)
-  shoulda-context
-
-BUNDLED WITH
-   1.15.4

data/docs/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-modernist