caravan 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21f5e8e75b19d676bb4530c970b37eceaa6cab66
+  data.tar.gz: 10c5083012689210fe745b4ad9e5b7f13e35f217
+SHA512:
+  metadata.gz: eaf0c5a0d1d4adb039339b82072cf694b83508856e5378e5fb561c1df015212d3d04035a8f1da03f457d5aca4a3020ae59ca0c69c6ad8fa63eeed944bff43fc1
+  data.tar.gz: f77c3c4033fd6146b1a748871bd164e9adf239a3417b865fa15e2c9a8f7160ff2f63385413602189510b92bebbb3c9e3223899f09b54e53068acdcb9179b3ad9

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# 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
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+caravan.yml

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.0
+env:
+  - CODECLIMATE_REPO_TOKEN: b72ccd136db6874a3d5dd842c50c1dc0933a1f49a02c55ce8567ec7311600af3
+after_success:
+  - bundle exec codeclimate-test-reporter
+notifications:
+  email: false
+  slack: navyblue-team:ioO5diAGc5WUQVDKc5BH1UbE

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at zhangwanlong@bytedance.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 David Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# [Caravan](https://crispgm.github.io/caravan/)
+
+[![Gem Version](https://badge.fury.io/rb/caravan.svg)](https://badge.fury.io/rb/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.
+
+## Installation
+
+```
+$ gem install caravan
+```
+
+## Usage
+
+```
+$ caravan --help
+```
+
+Example:
+
+```
+$ caravan -s /path/to/project/. -d /path/to/deploy -m shell
+```
+
+## LICENSE
+
+[MIT](/LICENSE)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/caravan.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "caravan/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "caravan"
+  spec.version       = Caravan::VERSION
+  spec.authors       = ["David Zhang"]
+  spec.email         = ["crispgm@gmail.com"]
+
+  spec.summary       = %q{Simple watcher and deployer}
+  spec.description   = %q{Caravan is a simple file watcher and deployer for local development.}
+  spec.homepage      = "https://crispgm.github.io/caravan/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "listen"
+  spec.add_dependency "colorize"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "shoulda-context"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
+end

data/docs/_config.yml

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

data/exe/caravan

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w(.. lib)))
+
+require "optparse"
+require "caravan"
+
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Caravan #{Caravan::VERSION}\nCopyright (c) David Zhang 2017\n"
+  opts.separator ""
+
+  opts.on("-s SOURCE_PATH", "--source SOURCE_PATH", "Source path") do |value|
+    options[:src] = value
+  end
+
+  opts.on("-d DEST_PATH", "--dest DEST_PATH", "Destination path") do |value|
+    options[:dst] = value
+  end
+
+  opts.on("-m DEPLOY_MODE", "--mode DEPLOY_MODE", "Deploy mode") do |value|
+    options[:mode] = value || "shell"
+  end
+
+  opts.on("-i IGNORE_FILES", "--ignore IGNORE_FILES", "Ignore files") do |value|
+    options[:ignore] = value || "\.(git|svn)$"
+  end
+
+  options[:debug] = false
+  opts.on("-b", "--debug", "Debug mode") do
+    options[:debug] = true
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts Caravan::VERSION
+    exit
+  end
+end.parse!(ARGV)
+
+if options.key?(:src) && options.key?(:dst)
+    Caravan.start(options)
+end

data/lib/caravan/command.rb

@@ -0,0 +1,11 @@
+module Caravan
+  class Command
+    class << self
+      def run(cmd, debug = false)
+        output = `#{cmd}`
+        Caravan::Message.debug(cmd) if debug
+        return $?.exitstatus, output
+      end
+    end
+  end
+end

data/lib/caravan/config.rb

@@ -0,0 +1,40 @@
+require "yaml"
+
+module Caravan
+  class Config < Hash
+    DEFAULT_CONFIG = {
+      "deploy_mode" => "rsync_local",
+      "incremental" => true,
+      "exclude" => %w(
+        .git .svn
+      )
+    }.freeze
+
+    class << self
+      def default_conf
+        DEFAULT_CONFIG
+      end
+
+      def from(user_config_path)
+        if File.exist?(user_config_path)
+          YAML.load_file(user_config_path)
+        else
+          dump_conf(user_config_path, default_conf)
+          default_conf
+        end
+      end
+
+      def dump_conf(user_config_path, user_config)
+        File.open(user_config_path, "w") do |f|
+          f.write(user_config.to_yaml)
+        end
+      end
+
+      def pretty_puts(conf)
+        conf.each do |k, v|
+          Message.info("    => #{k}: #{v}")
+        end
+      end
+    end
+  end
+end

data/lib/caravan/deploy.rb

@@ -0,0 +1,45 @@
+require "colorize"
+
+module Caravan
+  module Deploy
+    class << self
+      def create_deployer(method = 'shell')
+        case method
+        when "shell"
+          return Caravan::DeployMethods::Shell.new
+        when "scp"
+          return Caravan::DeployMethods::Scp.new
+        when "rsync"
+          return Caravan::DeployMethods::Rsync.new
+        when "rsync_local"
+          return Caravan::DeployMethods::RsyncLocal.new
+        else
+          Message.error("Unknown deploy method \"#{method}\"")
+          return nil
+        end
+      end
+    end
+
+    class Base
+      attr_accessor :debug
+
+      def initialize
+        Message.info("Creating #{self.class.name}...")
+        @debug = false
+      end
+
+      def run(src, dst)
+        time_str = Time.now.strftime("%H:%M:%S").green
+        Message.info("#{time_str} Deploying #{src} to #{dst}...")
+
+        status = 0
+        if block_given?
+          status, output = yield src, dst
+        end
+
+        Message.error("deploying block returned false") unless status == 0
+        return status
+      end
+    end
+  end
+end

data/lib/caravan/deploy_methods/rsync.rb

@@ -0,0 +1,13 @@
+require "caravan/deploy"
+
+module Caravan
+  module DeployMethods
+    class Rsync < Deploy::Base
+      def run(src, dst)
+        super(src, dst) do |s, d|
+          Caravan::Command.run("rsync -avl #{s} #{d}", @debug)
+        end
+      end
+    end
+  end
+end

data/lib/caravan/deploy_methods/rsync_local.rb

@@ -0,0 +1,13 @@
+require "caravan/deploy"
+
+module Caravan
+  module DeployMethods
+    class RsyncLocal < Deploy::Base
+      def run(src, dst)
+        super(src, dst) do |s, d|
+          Caravan::Command.run("rsync -rv #{s} #{d}", @debug)
+        end
+      end
+    end
+  end
+end

data/lib/caravan/deploy_methods/scp.rb

@@ -0,0 +1,13 @@
+require "caravan/deploy"
+
+module Caravan
+  module DeployMethods
+    class Scp < Deploy::Base
+      def run(src, dst)
+        super(src, dst) do |s, d|
+          Caravan::Command.run("scp -r #{s} #{d}", @debug)
+        end
+      end
+    end
+  end
+end

data/lib/caravan/deploy_methods/shell.rb

@@ -0,0 +1,11 @@
+module Caravan
+  module DeployMethods
+    class Shell < Caravan::Deploy::Base
+      def run(src, dst)
+        super(src, dst) do |s, d|
+          Caravan::Command.run("cp -r #{s} #{d}", @debug)
+        end
+      end
+    end
+  end
+end

data/lib/caravan/message.rb

@@ -0,0 +1,27 @@
+require "colorize"
+
+module Caravan
+  module Message
+    class << self
+      def debug(msg)
+        puts "[DEBUG] #{msg}".light_black
+      end
+
+      def info(msg)
+        puts "[INFO] #{msg}"
+      end
+
+      def error(msg)
+        puts "[ERROR] #{msg}".red
+      end
+
+      def warning(msg)
+        puts "[WARN] #{msg}".yellow
+      end
+
+      def success(msg)
+        puts "#{msg}".green
+      end
+    end
+  end
+end

data/lib/caravan/version.rb

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

data/lib/caravan.rb

@@ -0,0 +1,67 @@
+require "caravan/command"
+require "caravan/config"
+require "caravan/deploy"
+require "caravan/deploy_methods/shell"
+require "caravan/deploy_methods/scp"
+require "caravan/deploy_methods/rsync"
+require "caravan/deploy_methods/rsync_local"
+require "caravan/message"
+require "caravan/version"
+
+require "listen"
+
+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]
+
+      deployer = Deploy.create_deployer(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
+      end
+
+      listener.ignore(ignores)
+
+      Message.success("Starting to watch #{src_path}...")
+      deployer.run(src_path, target_path)
+      listener.start
+      
+      trap("INT") do
+        listener.stop
+        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)
+    end
+
+    def sleep_forever
+      loop { sleep 1000 }
+    end
+  end
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: caravan
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- David Zhang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Caravan is a simple file watcher and deployer for local development.
+email:
+- crispgm@gmail.com
+executables:
+- caravan
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- caravan.gemspec
+- docs/_config.yml
+- exe/caravan
+- lib/caravan.rb
+- lib/caravan/command.rb
+- lib/caravan/config.rb
+- lib/caravan/deploy.rb
+- lib/caravan/deploy_methods/rsync.rb
+- lib/caravan/deploy_methods/rsync_local.rb
+- lib/caravan/deploy_methods/scp.rb
+- lib/caravan/deploy_methods/shell.rb
+- lib/caravan/message.rb
+- lib/caravan/version.rb
+homepage: https://crispgm.github.io/caravan/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Simple watcher and deployer
+test_files: []