caravan 0.4.0 → 0.5.0.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3056289441f97341f8e54ae2e285dbf7720e0d64
-  data.tar.gz: a65424290ac39ba323ba1608366cd206f2d68c32
+  metadata.gz: ba029c54b538361378d648eb8e1bd8cc78079a1b
+  data.tar.gz: cc59b3a03e11ae33e636aa4feac5261c5a239de8
 SHA512:
-  metadata.gz: b6879a9ce50b92bc462c22f02133416d892c962c9c3d1aed742c48adf28c57e8794aa169ec1b82a6e11266f7ef1e4dfa5200b6af09f50996ab3b7d0156d08dfe
-  data.tar.gz: 495b3c418566110b17ffecdfa8052a29e1c035a3949da42117e5feb2d7d7c3376b8d0bd426ca34bc2a952b191025e4447335c1474d033361a9088c534083ce7d
+  metadata.gz: 6425491bd500a8ce5d21362b8d01667a317d15a9f61772c8f70b09341605049dae897d13058545b9f1600ad8ad93c059438adef9ec131b9ebd05abe6f3ac197d
+  data.tar.gz: 4350a3578c5c0bfdfe99763f5a0c6d34ba04cc255c3b8619bf68bb5db721477f536df68c7b4a5a939915ee0d686f687592b31a2a997e655484b13d05884024cf

data/.codeclimate.yml

@@ -1,10 +1,7 @@
 ---
 engines:
   duplication:
-    enabled: true
-    config:
-      languages:
-      - ruby
+    enabled: false
   fixme:
     enabled: true
   rubocop:

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 cache: bundler
 rvm:
   - 2.3.0
+  - 2.4.0
 after_success:
   - CODECLIMATE_REPO_TOKEN=b72ccd136db6874a3d5dd842c50c1dc0933a1f49a02c55ce8567ec7311600af3 bundle exec codeclimate-test-reporter
 notifications:

data/README.md

@@ -60,7 +60,12 @@ exclude:
 - [x] Exclude watching unwanted files
 - [x] `caravan.yml` for project-specialized configuration
 - [ ] Watch and deploy only the changed file instead of the whole folder
-- [ ] Callbacks for deployment
+- [x] Callbacks for deployment
+    - [x] `after_create`
+    - [x] `after_change`
+    - [x] `before_deploy`
+    - [x] `after_deploy`
+    - [x] `before_destroy`
 - [ ] Multiple deployment configurations
 
 ## LICENSE

data/caravan.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   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.summary       = %q{Simple project files watcher and deployer}
+  spec.description   = %q{Caravan is a simple file watcher and deployer of project files for local development.}
   spec.homepage      = "https://crispgm.github.io/caravan/"
   spec.license       = "MIT"
 

data/lib/caravan/deploy.rb

@@ -3,42 +3,132 @@ require "colorize"
 module Caravan
   module Deploy
     class << self
-      def create_deployer(method = "shell")
+      def create_deployer(src, dst, method = "shell")
         case method
         when "shell"
-          return Caravan::DeployMethods::Shell.new
+          Caravan::DeployMethods::Shell.new(src, dst)
         when "scp"
-          return Caravan::DeployMethods::Scp.new
+          Caravan::DeployMethods::Scp.new(src, dst)
         when "rsync"
-          return Caravan::DeployMethods::Rsync.new
+          Caravan::DeployMethods::Rsync.new(src, dst)
         when "rsync_local"
-          return Caravan::DeployMethods::RsyncLocal.new
+          Caravan::DeployMethods::RsyncLocal.new(src, dst)
         else
           Message.error("Unknown deploy method \"#{method}\"")
-          return nil
+          nil
         end
       end
     end
 
     class Base
       attr_accessor :debug
+      attr_reader :src, :dst
 
-      def initialize
+      def initialize(src, dst)
         Message.info("Creating #{self.class.name}...")
+        @src = src
+        @dst = dst
         @debug = false
       end
 
-      def run(src, dst)
+      def handle_change(modified, added, removed)
+        @modified = modified
+        @added = added
+        @removed = removed
+
+        after_change
+      end
+
+      def after_create
+        Message.info("#{self.class.name} is created.")
+
+        if block_given?
+          ret_val = yield
+          debug_msg("Block `after_create` returned #{ret_val}")
+          false if ret_val == false
+        end
+
+        true
+      end
+
+      def after_change
+        @modified.each do |change|
+          Caravan::Message.info("#{change} was changed.")
+        end
+
+        @added.each do |change|
+          Caravan::Message.info("#{change} was created.")
+        end
+
+        @removed.each do |change|
+          Caravan::Message.info("#{change} was removed.")
+        end
+
+        if block_given?
+          ret_val = yield @modified, @added, @removed
+          debug_msg("Block `after_change` returned #{ret_val}")
+          false if ret_val == false
+        end
+
+        true
+      end
+
+      def before_deploy
+        if block_given?
+          ret_val = yield
+          debug_msg("Block `before_deploy` returned #{ret_val}")
+          false if ret_val == false
+        end
+
+        true
+      end
+
+      def run
         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
+          debug_msg("Block `run` returned #{status}")
+        end
+
+        Message.error("Deploying block returned false") unless status == 0
+        status
+      end
+
+      def after_deploy
+        if block_given?
+          ret_val = yield
+          debug_msg("Block `after_deploy` returned #{ret_val}")
+          false if ret_val == false
+        end
+
+        true
+      end
+
+      def before_destroy
+        if block_given?
+          ret_val = yield
+          debug_msg("Block `before_destroy` returned #{ret_val}")
+          false if ret_val == false
         end
 
-        Message.error("deploying block returned false") unless status == 0
-        return status
+        true
+      end
+
+      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
+
+        path_routes[-1]
+      end
+
+      private
+
+      def debug_msg(msg)
+        Caravan::Message.debug(msg) if @debug
       end
     end
   end

data/lib/caravan/deploy_methods/rsync.rb

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

data/lib/caravan/deploy_methods/rsync_local.rb

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

data/lib/caravan/deploy_methods/scp.rb

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

data/lib/caravan/deploy_methods/shell.rb

@@ -1,11 +1,35 @@
 module Caravan
   module DeployMethods
     class Shell < Caravan::Deploy::Base
-      def run(src, dst)
-        super(src, dst) do |s, d|
+      def after_create
+        super do
+          Caravan::Message.info("Notice: Shell Deployer is like copy, mainly designed for test.")
+        end
+      end
+
+      def before_deploy
+        super do
+          Caravan::Message.info("Hook: before_deploy")
+        end
+      end
+
+      def run
+        super do |s, d|
           Caravan::Command.run("cp -r #{s} #{d}", @debug)
         end
       end
+
+      def after_deploy
+        super do
+          Caravan::Message.info("Hook: after_deploy")
+        end
+      end
+
+      def before_destroy
+        super do
+          Caravan::Message.info("Deployer destroyed")
+        end
+      end
     end
   end
 end

data/lib/caravan/version.rb

@@ -1,3 +1,3 @@
 module Caravan
-  VERSION = "0.4.0".freeze
+  VERSION = "0.5.0.alpha1".freeze
 end

data/lib/caravan.rb

@@ -24,39 +24,36 @@ module Caravan
 
       Caravan::Config.pretty_puts(merged_conf)
 
-      deployer = Caravan::Deploy.create_deployer(deploy_mode)
+      deployer = Caravan::Deploy.create_deployer(src_path, target_path, deploy_mode)
       deployer.debug = true if debug
-      if deployer.nil?
-        exit -1
-      end
+      exit(-1) if deployer.nil?
 
-      listener = create_listener(deployer, src_path, target_path)
+      listener = create_listener(deployer, src_path)
       ignores.each do |item|
         listener.ignore(Regexp.compile(item))
       end
 
       Caravan::Message.success("Starting to watch #{src_path}...")
-      deployer.run(src_path, target_path)
+      deployer.after_create
       listener.start
       
       trap("INT") do
         listener.stop
+        deployer.before_destroy
         Caravan::Message.success("\tHalting watching.")
-        exit 0
+        exit(0)
       end
 
       sleep_forever
     end
 
-    def create_listener(deployer, src_path, target_path)
+    def create_listener(deployer, src_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
+        # rubocop:disable Lint/NonLocalExitFromIterator
+        return unless deployer.handle_change(modified, added, removed)
+        return unless deployer.before_deploy
+        deployer.run
+        deployer.after_deploy
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: caravan
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0.alpha1
 platform: ruby
 authors:
 - David Zhang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-08 00:00:00.000000000 Z
+date: 2017-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: listen
@@ -108,7 +108,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
-description: Caravan is a simple file watcher and deployer for local development.
+description: Caravan is a simple file watcher and deployer of project files for local
+  development.
 email:
 - crispgm@gmail.com
 executables:
@@ -152,13 +153,13 @@ 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
 signing_key: 
 specification_version: 4
-summary: Simple watcher and deployer
+summary: Simple project files watcher and deployer
 test_files: []