guard-combustion 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13d535c12e2065b16c6dd2c39d63912cd62b94e0
-  data.tar.gz: 9db93c30fd2be56cfff66abaf2a8a0fe188138af
+  metadata.gz: 29e25af5ba5e505b6ec2402a10fa2ecbda39a49c
+  data.tar.gz: 9789486bf45c5e349ee3a64ea24e85c4afec018e
 SHA512:
-  metadata.gz: cbf395173ea18af253b85c2ef38100b0ab47477ba5ba83c909384dcbc706cdc90d8c7328bc60fed0e6202b9d53510dc5871f039ffb26b4673320ebc06fd602bf
-  data.tar.gz: 36810e84b4ab5c3a2063248bb8025ec01b0cceabf3c0e21e98c011b3f58ea194af8355389a2852ec8d718735c252e420ea614e7f1936d49f8d9adf2c43760dbe
+  metadata.gz: 574efb532093a8f57edc146487168971089498965b9cddab9afef21cbdb52267864702bd660a996b6c87748df0f1ff0b62b0fac4b78220c4cbae849cc84833de
+  data.tar.gz: e1948770da602a40fff110178ab95b5f1642a2bf4db3146d7e25a56196f9d54ea71f6e5b68bd1c8788293078715f06fdae564646a944e40cd1e1f22f9e560b78

data/README.md

@@ -0,0 +1,45 @@
+# Guard::Combustion
+
+This guard allows you to easily develop Rails engines with [Combustion](https://github.com/pat/combustion) with no need to manually restart the dummy application after every change.
+
+## Install
+
+Make sure you have [guard](http://github.com/guard/guard) installed and Combustion fully configured on your Rails engine.
+
+Install the gem with:
+
+    gem install guard-combustion
+
+Or add it to your Gemfile:
+
+    gem "guard-combustion", "~> 0.1.1"
+
+And then add a basic setup to your Guardfile:
+
+    guard init combustion
+
+## Configuration
+
+### Combustion port
+
+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`
+
+	3001
+
+If ".guard_combustion_port" doesn't exists, it will be generated and configured with the default port at the first use of guard-combustion.
+
+### Integration with guard-rspec (or any other guard)
+
+If you are using guard-rspec, or any other guard that uses Combustion, 
+you may want to stop the server while running the tests 
+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 }
+
+For more informations about callbacks, see https://github.com/guard/guard/wiki/Hooks-and-callbacks

data/lib/guard/combustion/combustion_helper.rb

@@ -1,31 +1,16 @@
 #
-# Questa classe contiene funzioni utili per la gestione automatica di combustion con guard
-# 
-# Per configurare la porta utilizzata da combustion, inserire in un file ".guard_combustion_port" la porta desiderata (solo il numero).
-# Se questo file non esiste, viene creato automaticamente al primo utilizzo di guard, utilizzando la porta di default.
-# 
-# NB: .guard_combustion_port è gitignored.
+# This class contains some useful functions to automatically manage the interaction between combustion and guard.
 #
 class CombustionHelper
 
-  #
-  # La porta di default utilizzata da combustion.
-  # Questa porta viene utilizzata solo se non è già stata configurata in .guard_combustion_port
-  # 
-  # NB: per modificare la porta che si vuole far utilizzare a combustion non modificare direttamente questa variabile.
-  #     Leggere invece le istruzioni in cima alla classe
-  # 
   @@default_port = 9292
   @@last_start = Time.now - 5
   @@combustion_pid_file = "./tmp/.combustion_pid"
   @@guard_combustion_port = ".guard_combustion_port"
 
-  #
-  # Definisce tutti i metodi come statici
-  # 
   class << self
     #
-    # Avvia combustion
+    # Start combustion
     # 
     def start_combustion
       if get_combustion_pid.nil?
@@ -36,9 +21,9 @@ class CombustionHelper
         @@last_start = Time.now
         pid = get_combustion_pid
         if pid.nil?
-          puts "something went wrong, likely combustion were not started"
+          puts "\033[22;31msomething went wrong, likely combustion was not started\x1b[0m"
         else
-          puts "\033[22;32mcombustion started and listening at port #{combustion_port} with pid #{pid}\x1b[0m"
+          puts "\033[22;32mcombustion started with pid #{pid} and listening on port #{combustion_port}\x1b[0m"
         end
       else
         puts "another instance of combustion is already running with pid #{pid}"
@@ -47,7 +32,7 @@ class CombustionHelper
     end
 
     #
-    # Uccide combustion
+    # Stop combustion
     # 
     def stop_combustion
       puts "stopping combustion..."
@@ -62,10 +47,10 @@ class CombustionHelper
     end
 
     #
-    # Riavvia combustion
+    # Restart combustion
     # 
     def restart_combustion
-      if Time.now > @@last_start + 1 # Controlla che il server non sia stato già avviato meno di 1 secondo fa
+      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
@@ -75,7 +60,7 @@ class CombustionHelper
   private
 
     #
-    # Scrive la porta di default che verrà utilizzata per combustion in un file .guard_combustion_port
+    # 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")
@@ -85,8 +70,8 @@ class CombustionHelper
     end
 
     #
-    # Legge la porta di default che viene utilizzata per combustion dal file .guard_combustion_port
-    # Se il file non esiste, lo crea e gli assegna la porta di default
+    # 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
@@ -106,7 +91,7 @@ class CombustionHelper
     end
 
     # 
-    # Legge il pid di combustion dal file .combustion_pid
+    # Read combustion's pid from .combustion_pid
     # 
     def get_combustion_pid
       begin
@@ -126,7 +111,7 @@ class CombustionHelper
     end
 
     # 
-    # Elimina il file .combustion_pid   
+    # Delete .combustion_pid
     # 
     def delete_combustion_pid
       if File.exists? @@combustion_pid_file
@@ -135,7 +120,7 @@ class CombustionHelper
     end
 
     #
-    # Restituisce su una stringa il comando shell utilizzato per avviare combustion
+    # 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}"

data/lib/guard/combustion/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-combustion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ruben Caliandro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -33,7 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- Readme.md
+- README.md
 - lib/guard/combustion.rb
 - lib/guard/combustion/combustion_helper.rb
 - lib/guard/combustion/templates/Guardfile
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Guard gem for running Combustion

data/Readme.md

@@ -1,33 +0,0 @@
-# Guard::Combustion
-
-This guard allows you to easily develop Rails engines with [Combustion](https://github.com/pat/combustion) with no need to restart the dummy application after every change.
-
-
-## Install
-
-Make sure you have [guard](http://github.com/guard/guard) installed and Combustion fully configured on your Rails engine.
-
-Install the gem with:
-
-    gem install guard-combustion
-
-Or add it to your Gemfile:
-
-    gem 'guard-combustion'
-
-And then add a basic setup to your Guardfile:
-
-    guard init combustion
-
-
-## Integration with guard-rspec
-
-If you are using guard-rspec, maybe you want to stop Combustion while running tests,
-just 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 }