ngauthier-active-listener 0.2.0 → 0.2.1

data/README.markdown

@@ -3,22 +3,62 @@
 ## Description
 This gem allows you to define tasks that can be run at specific time intervals. In the future, we plan to allow event listening and firing.
 
-## Configuration
-
-### Add a config file
-
-### Include in your boot
-
 ## Installation
 
 ### Latest Stable
+
     sudo gem install ngauthier-active-listener
 
 ### Cutting Edge
+
     git clone git@github.com:ngauthier/active-listener.git active-listener
     cd active-listener
     rake gem install
 
+## Configuration
+
+### Add a config file
+In your rails project, add a config file like this:
+
+
+    ---
+      tasks:
+        - task: my:rake:task
+          period: 5
+
+
+This instructs active-listener to run "rake my:rake:task" every 5 seconds.
+
+Usually, these config files go in RAILS_ROOT/config/active-listener.yml.
+
+### Include an initializer
+Create a file in the initializers directory, like RAILS_ROOT/config/initializers/active-listener.rb that has this in it:
+
+    require 'active-listener'
+    ActiveListener.autostart(
+      :config => File.join(RAILS_ROOT, 'config', 'active-listener.yml'),
+      :log_file => File.join(RAILS_ROOT, 'log', 'active-listener-'+RAILS_ENV+'.log'),
+      :pid_file => File.join(RAILS_ROOT, 'log', 'active-listener-'+RAILS_ENV+'.pid'),
+      :rake_root => File.join(RAILS_ROOT)
+    )
+
+This will use the config file "config/active-listener.yml". It will put the log file in "log/active-listener.log" and the pid file for tracking the process in "log/active-listener.pid".
+
+## Usage
+
+Active Listener will automatically start whenever the rails environment is loaded. It will replace an existing instance of active-listener if the pid file is the same and there is one running.
+
+So, you don't need to run the executable, it will "autostart" thanks to the initializer. Keep in mind this means that it will be running during your tests, development server, production, and any other environments you have. If you run your tests, the daemon keeps going after the tests are done. It doesn't stop when the server stops.
+
+If you run your tests and you run the app in dev mode, there will be two instances running simultaneously and they'll both be running the tasks (but in the appropriate environment).
+
+If you want to stop active-listener, run:
+
+    active-listener --stop log/active-listener.pid
+
+Make sure to point it to your pid file.
+
+
 ## Other notes
 This gem uses Jeweler.
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 2
-:patch: 0
+:patch: 1
 :major: 0

data/lib/active-listener.rb

@@ -79,8 +79,11 @@ class ActiveListener
     def fire(opts = {})
       self.last_fire = Time.now.to_f
       Dir.chdir(opts[:rake_root]) if opts[:rake_root]
-      `rake #{task}`
-      opts[:rake_root]
+      begin
+        `RAILS_ENV=#{RAILS_ENV} rake #{task}`
+      rescue
+        `rake #{task}`
+      end
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ngauthier-active-listener
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Nick Gauthier