guard-combustion 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29e25af5ba5e505b6ec2402a10fa2ecbda39a49c
-  data.tar.gz: 9789486bf45c5e349ee3a64ea24e85c4afec018e
+  metadata.gz: fa81a552ad020ab25bdf5848cfdf3f0a570c60a9
+  data.tar.gz: c0af917e393b7133b313ce49cdf66879f37dbee1
 SHA512:
-  metadata.gz: 574efb532093a8f57edc146487168971089498965b9cddab9afef21cbdb52267864702bd660a996b6c87748df0f1ff0b62b0fac4b78220c4cbae849cc84833de
-  data.tar.gz: e1948770da602a40fff110178ab95b5f1642a2bf4db3146d7e25a56196f9d54ea71f6e5b68bd1c8788293078715f06fdae564646a944e40cd1e1f22f9e560b78
+  metadata.gz: bbe00e633279bbb26c8d24e02566874ec11f4d13cf7deaee39480616bb9ab2e2a23646273e90895ee5ae7505c77250a7da82c4e98e8c5d61d8e8c5c8cbde37c5
+  data.tar.gz: bb5bc2580e258362d3c79d0141795e5b63c44873b1316f0b40b6b41437dcfe4d5b706b845ccf11e69223e444c25d5f8de75bd9c94b5c6f6cb13eebdc6d4fa703

data/README.md

@@ -12,7 +12,7 @@ Install the gem with:
 
 Or add it to your Gemfile:
 
-    gem "guard-combustion", "~> 0.1.1"
+    gem "guard-combustion", "~> 1.0.0"
 
 And then add a basic setup to your Guardfile:
 
@@ -20,14 +20,63 @@ And then add a basic setup to your Guardfile:
 
 ## Configuration
 
-### Combustion port
+### Options
 
-Combustion listens on the port 9292 by default.
-You can choose another port (e.g. 3000) modifying (or creating) the file `/path/to/your/engine/.guard_combustion_port`
+You can use some options to configure guard-combustion from the Guardfile.
 
-	3001
+#### Port
 
-If ".guard_combustion_port" doesn't exists, it will be generated and configured with the default port at the first use of guard-combustion.
+Combustion listens by default on the port 9292. To change the port, use the `:port` option. E.g.
+
+```ruby
+guard :combustion, port: 3000 do
+  watch(%r{^(app|config|lib|spec)/(.*)})
+end
+```
+
+#### Pid File
+
+Guard::Combustion saves the PID of Combustion into a file when it has been just created, and deletes it when Combustion stops.
+
+By default, the pid file is `./tmp/.combustion_pid`, but if you want to change the path, you can set the `:pid_file` option (make sure that the path already exists, or create the required directories).
+
+```ruby
+guard :combustion, pid_file: './my_dir/my_new_pid_file.example' do
+  watch(%r{^(app|config|lib|spec)/(.*)})
+end
+```
+
+#### Colors
+
+If you want to turn off the colored prints, set the `:color` option to `false`
+
+```ruby
+guard :combustion, color: false do
+  watch(%r{^(app|config|lib|spec)/(.*)})
+end
+```
+
+#### Custom Port File
+
+The `:port` option mentioned above is a perfect solution if you are working alone, or with people that all want to use the same listening port.
+
+But... what if you want to use a different port from your team mates?
+
+No worries: you can set your custom port by writing it (and only it!) into the file `.guard_combustion_port` at the root of your project. This file has major priority than the port set into the Guardfile.
+
+.guard_combustion_port file: E.g.
+
+        8080
+
+If you add `.guard_combustion_port` to the `.gitignore` file, your team mates won't even notice the difference.
+
+If you don't like to add files at the root of your project, you can also change the custom port file, setting the `:custom_port_file` option.
+
+```ruby
+guard :combustion, custom_port_file: "my_new_custom_port_file.example" do
+  watch(%r{^(app|config|lib|spec)/(.*)})
+end
+```
 
 ### Integration with guard-rspec (or any other guard)
 
@@ -37,9 +86,11 @@ to avoid conflicts with the instance of Combustion created by Rspec.
 
 For doing that, you have to add theese lines into the `guard :rspec` block
 
-    callback(:run_all_begin) { CombustionHelper.stop_combustion }
-    callback(:run_on_modifications_begin) { CombustionHelper.stop_combustion }
-    callback(:run_all_end) { CombustionHelper.start_combustion }
-    callback(:run_on_modifications_end) { CombustionHelper.start_combustion }
+```ruby
+callback(:run_all_begin) { Guard::CombustionHelper.stop_combustion }
+callback(:run_on_modifications_begin) { Guard::CombustionHelper.stop_combustion }
+callback(:run_all_end) { Guard::CombustionHelper.start_combustion }
+callback(:run_on_modifications_end) { Guard::CombustionHelper.start_combustion }
+```
 
 For more informations about callbacks, see https://github.com/guard/guard/wiki/Hooks-and-callbacks

data/lib/guard/combustion.rb

@@ -1,12 +1,29 @@
 require 'guard'
-require 'guard/guard'
+require 'guard/plugin'
 require 'guard/combustion/version'
 require 'guard/combustion/combustion_helper'
 
+# 
+# The guard module
+# 
+# @author [chosko]
+# 
 module Guard
-  class Combustion < Guard
- 
+
+  # 
+  # The Guard::Combustion class
+  # 
+  # @author [chosko]
+  #   
+  class Combustion < Plugin
+
+    def initialize (options = {})
+      super
+      CombustionHelper.set_options(options)
+    end
+
     def start
+      ::Guard::UI.info "Guard::Combustion is running"
       CombustionHelper.start_combustion
     end
  

data/lib/guard/combustion/combustion_helper.rb

@@ -1,129 +1,196 @@
-#
-# This class contains some useful functions to automatically manage the interaction between combustion and guard.
-#
-class CombustionHelper
+module Guard
+  #
+  # This class contains some useful functions to automatically manage the interaction between combustion and guard.
+  # 
+  # @author [chosko]
+  # 
+  class CombustionHelper
 
-  @@default_port = 9292
-  @@last_start = Time.now - 5
-  @@combustion_pid_file = "./tmp/.combustion_pid"
-  @@guard_combustion_port = ".guard_combustion_port"
+    #
+    # Default options
+    # 
+    DEFAULTS = {
+      # The listening port of combustion
+      port: 9292,
+
+      # The file where is stored the pid of combustion
+      pid_file: "./tmp/.combustion_pid",
+
+      # The file where is stored the port used by combustion
+      custom_port_file: ".guard_combustion_port",
+      
+      # Coloured prints
+      colors: true
+    }.freeze
+
+    #
+    # The options for combustion
+    # 
+    @@options = DEFAULTS
 
-  class << self
     #
-    # Start combustion
+    # This variable records the last time that combustion was started
     # 
-    def start_combustion
-      if get_combustion_pid.nil?
-        puts "starting combustion..."
-        combustion_port = get_guard_combustion_port
-        `#{combustion_cmd(combustion_port)}`
-        sleep(1)
-        @@last_start = Time.now
+    @@last_start = Time.now - 5
+
+    class << self
+      #
+      # Set the options for combustion
+      # 
+      def set_options(options = {})
+        @@options = _deep_merge(DEFAULTS, options)
+      end
+
+      #
+      # Start combustion
+      # 
+      def start_combustion
         pid = get_combustion_pid
         if pid.nil?
-          puts "\033[22;31msomething went wrong, likely combustion was not started\x1b[0m"
+          ::Guard::UI.info "Starting combustion..."
+          combustion_port = get_guard_combustion_port
+          `#{combustion_cmd(combustion_port)}`
+          sleep(1)
+          @@last_start = Time.now
+          pid = get_combustion_pid
+          if pid.nil?
+            ::Guard::UI.error "Something went wrong, likely Combustion was not started"
+          else
+            ::Guard::UI.info strcolor("Combustion started with pid #{pid} and listening on port #{combustion_port}", "green")
+          end
         else
-          puts "\033[22;32mcombustion started with pid #{pid} and listening on port #{combustion_port}\x1b[0m"
+          ::Guard::UI.warning "Another instance of Combustion is already running with pid #{pid}"
+          restart_combustion
         end
-      else
-        puts "another instance of combustion is already running with pid #{pid}"
-        restart_combustion
       end
-    end
 
-    #
-    # Stop combustion
-    # 
-    def stop_combustion
-      puts "stopping combustion..."
-      pid = get_combustion_pid
-      if pid.nil?
-        puts "no instances of combustion were found"
-      else
-        `kill -9 #{pid}`
-        puts "\033[22;31mcombustion stopped\x1b[0m"
-        delete_combustion_pid
+      #
+      # Stop combustion
+      # 
+      def stop_combustion
+        ::Guard::UI.info "Stopping combustion..."
+        pid = get_combustion_pid
+        if pid.nil?
+          ::Guard::UI.warning "No instances of combustion were found"
+        else
+          `kill -9 #{pid}`
+          ::Guard::UI.info strcolor("Combustion stopped", "red")
+          delete_combustion_pid
+        end
       end
-    end
 
-    #
-    # Restart combustion
-    # 
-    def restart_combustion
-      if Time.now > @@last_start + 1 # Check if the server started less than a second ago
-        puts "\033[01;33mrestarting combustion...\x1b[0m"
-        stop_combustion
-        start_combustion
+      #
+      # Restart combustion
+      # 
+      def restart_combustion
+        if Time.now > @@last_start + 1 # Check if the server started less than a second ago
+          ::Guard::UI.info "Restarting combustion..."
+          stop_combustion
+          start_combustion
+        end
       end
-    end
 
-  private
+    private
 
-    #
-    # Write the port that will be used by combustion into .guard_combustion_port
-    # 
-    def set_guard_combustion_port
-      file = File.open(@@guard_combustion_port, "w")
-      file.write(@@default_port.to_s)
-      file.close
-      @@default_port
-    end
 
-    #
-    # Read the port from .guard_combustion_port
-    # If .guard_combustion_port doesn't exists, create it and fill it with the default port.
-    # 
-    def get_guard_combustion_port
-      begin
-        if File.exists? @@guard_combustion_port
-          file = File.open(@@guard_combustion_port, "r")
-          contents = file.read
-          combustion_port = Integer(contents.split("\n")[0])
-          file.close
-          combustion_port
+      # 
+      # Make a string colored
+      # @param  string [String] The string to make colored
+      # @param  color=nil [String] The name of the color (e.g. 'yellow')
+      # 
+      # @return [String] the input string colored
+      def strcolor(string, color=nil)
+        return string if !@@options[:colors] || color.nil?
+
+        case color
+        when "green"
+          "\033[22;32m#{string}\x1b[0m"
+        when "red"
+          "\033[22;31m#{string}\x1b[0m"
+        when "yellow"
+          "\033[01;33m#{string}\x1b[0m"
         else
-          set_guard_combustion_port
+          string
         end
-      rescue ArgumentError => e
-        file.close
-        set_guard_combustion_port
       end
-    end
 
-    # 
-    # Read combustion's pid from .combustion_pid
-    # 
-    def get_combustion_pid
-      begin
-        if File.exists? @@combustion_pid_file
-          file = File.open(@@combustion_pid_file, "r")
-          contents = file.read
-          combustion_pid = Integer(contents.split("\n")[0])
+      # 
+      # Recursively merge two hashes, with major priority for the second hash
+      # @param  hash1 [Hash] The first hash
+      # @param  hash2 [Hash] The second hash
+      # 
+      # @return [Hash] The merged hash
+      def _deep_merge(hash1, hash2)
+        hash1.merge(hash2) do |key, oldval, newval|
+          if oldval.instance_of?(Hash) && newval.instance_of?(Hash)
+            _deep_merge(oldval, newval)
+          else
+            newval
+          end
+        end
+      end
+
+      #
+      # Read the port from .guard_combustion_port, if the file exists.
+      # 
+      # Else, use the port configured by option, or the default port.
+      # 
+      def get_guard_combustion_port
+        begin
+          if File.exists? @@options[:custom_port_file]
+            file = File.open(@@options[:custom_port_file], "r")
+            contents = file.read
+            combustion_port = Integer(contents.split("\n")[0])
+            file.close
+            ::Guard::UI.info "Custom port configuration file detected at #{@@options[:custom_port_file]} - Using port #{combustion_port} instead of #{@@options[:port]}."
+            ::Guard::UI.info "If you want to use the port defined into the Guardfile, please remove #{@@options[:custom_port_file]}"
+            combustion_port
+          else
+            @@options[:port]
+          end
+        rescue ArgumentError => e
+          file.close
+          ::Guard::UI.error "Failed to load custom port from " + @@options[:custom_port_file] + ", because it contains non-integer value."
+          ::Guard::UI.warning "Using the default port: " + @@options[:port].to_s
+          @@options[:port]
+        end
+      end
+
+      # 
+      # Read combustion's pid from .combustion_pid
+      # 
+      def get_combustion_pid
+        begin
+          if File.exists? @@options[:pid_file]
+            file = File.open(@@options[:pid_file], "r")
+            contents = file.read
+            combustion_pid = Integer(contents.split("\n")[0])
+            file.close
+            combustion_pid
+          else
+            nil
+          end
+        rescue ArgumentError => e
           file.close
-          combustion_pid
-        else
           nil
         end
-      rescue ArgumentError => e
-        file.close
-        nil
       end
-    end
 
-    # 
-    # Delete .combustion_pid
-    # 
-    def delete_combustion_pid
-      if File.exists? @@combustion_pid_file
-        File.delete(@@combustion_pid_file)
+      # 
+      # Delete .combustion_pid
+      # 
+      def delete_combustion_pid
+        if File.exists? @@options[:pid_file]
+          File.delete(@@options[:pid_file])
+        end
       end
-    end
 
-    #
-    # Return a string with the shell command used for starting combustion
-    # 
-    def combustion_cmd combustion_port
-      "rackup -p #{combustion_port} -D -P #{@@combustion_pid_file}"
+      #
+      # Return a string with the shell command used for starting combustion
+      # 
+      def combustion_cmd combustion_port
+        "rackup -p #{combustion_port} -D -P #{@@options[:pid_file]}"
+      end
     end
   end
 end

data/lib/guard/combustion/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module CombustionVersion
-    VERSION = '0.1.1'
+    VERSION = '1.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-combustion
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ruben Caliandro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -63,3 +63,4 @@ signing_key:
 specification_version: 4
 summary: Guard gem for running Combustion
 test_files: []
+has_rdoc: