daemons-rails 1.0.0 → 1.1.0.alpha

data/README.markdown

@@ -0,0 +1,66 @@
+Daemons Rails support (based on http://github.com/dougal/daemon_generator)
+================
+
+To get it work just add dependency to this gem in your Gemfile.
+
+## GENERATOR ##
+
+    rails generate daemon <name>
+
+Then insert your code in the lib/daemons/\<name\>.rb stub. All pids and logs will live in the normal log/ folder. This helps to make things Capistrano friendly.
+
+## CONTROL ##
+
+Individual control script:
+
+    ./lib/daemons/<name>_ctl [start|stop|restart|status]
+    rake daemon:<name>[:(start|stop|status)]
+
+Examples:
+
+    rake daemon:test - runs lib/daemons/test.rb not daemonized
+    rake daemon:test:start - start daemon using lib/daemons/test_ctl start
+    rake daemon:test:stop - stop daemon using lib/daemons/test_ctl stop
+    rake daemon:test:status - show running status for daemon using lib/daemons/test_ctl status
+
+App-wide control script:
+  
+    ./script/daemons [start|stop|restart]
+    rake daemons:(start|stop|status)
+
+## MONITORING API ##
+
+    Daemons::Rails::Monitoring.statuses - hash with all daemons and corresponding statuses
+    Daemons::Rails::Monitoring.start("test.rb") - start daemon using lib/daemons/test_ctl start
+    Daemons::Rails::Monitoring.stop("test.rb") - start daemon using lib/daemons/test_ctl stop
+    Daemons::Rails::Monitoring.controllers - list of controllers
+    Daemons::Rails::Monitoring.controller("test.rb") - controller for test.rb application
+  
+    controller = Daemons::Rails::Monitoring.controller("test.rb")
+    controller.path # => lib/daemons/test_ctl
+    controller.app_name # => test.rb
+    controller.start # => starts daemon
+    controller.stop # => stops daemon
+    controller.status # => :not_exists or :running
+    
+## CONFIGURATION ##
+
+You can set default settings for your daemons into config/daemons.yml file. Full list of options you can get from documentation to Daemons.daemonize method (http://daemons.rubyforge.org/classes/Daemons.html#M000007). Also it possible to set individual daemon options using file config/\<daemon_name\>-daemon.yml.
+If you want to use directory other than default lib/daemons then you should add to application initialization block following lines:
+    
+    class MyApp < Rails::Application
+        ...
+        Daemons::Rails.configure do |c|
+            c.daemons_path = Rails.root.join("new_daemons_path")
+        end
+        ...
+    end
+    
+If you change your mind, you can easily move content of this directory to other place and change config. 
+Notice: this feature available only from version 1.1 and old generated daemons can't be free moved, because uses hard-coded path to lib/daemons. So, you can generate daemons with same names and then move client code to generated templates.
+
+## CHANGES ##
+
+* 1.1.0 - supported custom directory for daemons
+* 1.0.0 - changed api for Daemons::Rails::Monitoring, fixed path in template for script, improved documentation, added RSpec
+* 0.0.3 - added rake for running script without daemonization (rake daemon:\<name\>)

data/lib/daemons/rails.rb

@@ -0,0 +1,14 @@
+require "daemons/rails/configuration"
+
+module Daemons
+  module Rails
+    # @return [Daemons::Rails::Configuration]
+    def self.configuration
+      @configuration ||= Daemons::Rails::Configuration.new
+    end
+
+    def self.configure
+      yield configuration
+    end
+  end
+end

data/lib/daemons/rails/config.rb

@@ -4,14 +4,14 @@ require 'erb'
 module Daemons
   module Rails
     class Config
-      def initialize(app_name, root_path)
+      def initialize(app_name, root_path, daemons_dir = File.join('lib', 'daemons'))
         @options = {}
         config_path = File.join(root_path, "config", "#{app_name}-daemon.yml")
         config_path = File.join(root_path, "config", "daemons.yml") unless File.exists?(config_path)
         options = YAML.load(ERB.new(IO.read(config_path)).result)
         options.each { |key, value| @options[key.to_sym] = value }
         @options[:dir_mode] = @options[:dir_mode].to_sym
-        @options[:script] ||= File.join(root_path, "lib", "daemons", "#{app_name}.rb")
+        @options[:script] ||= File.join(root_path, daemons_dir, "#{app_name}.rb")
       end
 
       def [](key)

data/lib/daemons/rails/configuration.rb

@@ -0,0 +1,37 @@
+module Daemons
+  module Rails
+    class Configuration
+      def detect_root
+        if defined?(::Rails)
+          ::Rails.root
+        else
+          root = Pathname.new(FileUtils.pwd)
+          root = root.parent unless root.directory?
+          root = root.parent until File.exists?(root.join('config.ru')) || root.root?
+          raise "Can't detect Rails application root" if root.root?
+          root
+        end
+      end
+
+      def daemons_path=(path)
+        @daemons_path = path && (path.is_a?(Pathname) ? path : Pathname.new(File.expand_path(path)))
+      end
+
+      def root=(path)
+        @root = path && (path.is_a?(Pathname) ? path : Pathname.new(File.expand_path(path)))
+      end
+
+      def root
+        @root ||= detect_root
+      end
+
+      def daemons_path
+        @daemons_path || root.join('lib', 'daemons')
+      end
+
+      def daemons_directory
+        daemons_path.relative_path_from(root)
+      end
+    end
+  end
+end

data/lib/daemons/rails/monitoring.rb

@@ -1,4 +1,5 @@
 require "daemons"
+require "daemons/rails"
 require "daemons/rails/config"
 require "daemons/rails/controller"
 
@@ -10,7 +11,7 @@ module Daemons
       end
 
       def self.daemons_directory
-        @daemons_directory ||= ::Rails.root.join('lib', 'daemons')
+        @daemons_directory || Daemons::Rails.configuration.daemons_path
       end
 
       def self.controller(app_name)

data/lib/daemons/rails/version.rb

@@ -1,5 +1,5 @@
 module Daemons
   module Rails
-    VERSION = "1.0.0"
+    VERSION = "1.1.0.alpha"
   end
 end

data/lib/generators/daemon_generator.rb

@@ -1,19 +1,23 @@
 require 'rails/generators'
+require 'daemons/rails'
 
 class DaemonGenerator < Rails::Generators::NamedBase
   source_root File.expand_path('../templates', __FILE__)
   argument :daemon_name, :type => :string, :default => "application"
 
   def generate_daemon
-    unless File.exists?(Rails.root.join("script", "daemons"))
-      copy_file "daemons", "script/daemons"
-      chmod 'script/daemons', 0755
+    daemons_dir = Daemons::Rails.configuration.daemons_directory
+
+    unless File.exists?(Rails.root.join(daemons_dir, 'daemons'))
+      copy_file "daemons", daemons_dir.join('daemons')
+      chmod daemons_dir.join('daemons'), 0755
     end
-    template "script.rb", "lib/daemons/#{file_name}.rb"
-    chmod "lib/daemons/#{file_name}.rb", 0755
 
-    template "script_ctl", "lib/daemons/#{file_name}_ctl"
-    chmod "lib/daemons/#{file_name}_ctl", 0755
+    template "script.rb", daemons_dir.join("#{file_name}.rb")
+    chmod daemons_dir.join("#{file_name}.rb"), 0755
+
+    template "script_ctl", daemons_dir.join("#{file_name}_ctl")
+    chmod daemons_dir.join("#{file_name}_ctl"), 0755
 
     unless File.exists?(Rails.root.join("config", "daemons.yml"))
       copy_file "daemons.yml", "config/daemons.yml"

data/lib/generators/templates/daemons

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 results = []
-Dir[File.dirname(__FILE__) + "/../lib/daemons/*_ctl"].each {|f| results << `#{f} #{ARGV.first}`}
+Dir[File.dirname(__FILE__) + "/*_ctl"].each {|f| results << `ruby #{f} #{ARGV.first}`}
 results.delete_if { |result| result.nil? || result.empty? }
 puts results.join unless results.empty?

data/lib/generators/templates/script.rb

@@ -3,7 +3,9 @@
 # You might want to change this
 ENV["RAILS_ENV"] ||= "production"
 
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "config", "environment"))
+root = File.expand_path(File.dirname(__FILE__))
+root = File.dirname(root) until File.exists?(File.join(root, 'config'))
+require File.join(root, "config", "environment")
 
 $running = true
 Signal.trap("TERM") do 

data/lib/generators/templates/script_ctl

@@ -2,7 +2,8 @@
 require 'rubygems'
 require "daemons"
 require "daemons/rails/config"
+require "daemons/rails"
 
-config = Daemons::Rails::Config.new("<%= file_name %>", File.dirname(__FILE__) + "/../../")
+config = Daemons::Rails::Config.new("<%= file_name %>", Daemons::Rails.configuration.root, Daemons::Rails.configuration.daemons_directory)
 
 Daemons.run File.dirname(__FILE__) + "/<%= file_name %>.rb", config.to_hash

data/lib/tasks/daemons.rake

@@ -3,21 +3,23 @@ require 'rake'
 desc "Show status of daemons"
 task :daemons => "daemons:status"
 
+daemons_dir = Daemons::Rails.configuration.daemons_directory
+
 namespace :daemons do
   %w[start stop status].each do |arg|
     desc "#{arg.capitalize} all daemons."
     task :"#{arg}" do
-      puts `script/daemons #{arg}`
+      puts `#{daemons_dir}/daemons #{arg}`
     end
   end
 end
 
 namespace :daemon do
-  Dir['lib/daemons/*_ctl'].each do |controller|
+  Dir[daemons_dir.join('*_ctl')].each do |controller|
     app_name = controller.sub(/.*\/(\w+)_ctl/, '\1')
     desc "Start #{app_name} script"
     task app_name do
-      FileUtils.cd 'lib/daemons' do
+      FileUtils.cd daemons_dir do
         load "#{app_name}.rb"
       end
     end

data/spec/fixtures/daemons/test2.rb

@@ -0,0 +1 @@
+#Test 2 script

data/spec/fixtures/daemons/test2_ctl

@@ -0,0 +1 @@
+# Test 2 controller

data/spec/lib/daemons/rails/configuration_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+require "daemons/rails/configuration"
+require "daemons/rails/monitoring"
+require "daemons/rails"
+
+describe Daemons::Rails::Configuration do
+  subject { Daemons::Rails.configuration }
+
+  describe "Default configuration" do
+    describe "rails env" do
+      its(:root) { should == Rails.root }
+      its(:daemons_path) { should == Rails.root.join('lib', 'daemons') }
+      its(:daemons_directory) { should == Pathname.new('lib').join('daemons') }
+    end
+
+    describe "no rails" do
+      before :all do
+        Dir.chdir Rails.root
+        Object.const_set :Rails_, Rails
+        Object.send :remove_const, :Rails
+      end
+      after :all do
+        Object.const_set :Rails, Rails_
+        Object.send :remove_const, :Rails_
+        Dir.chdir Rails.root.parent.parent
+      end
+      its(:root) { should == Rails_.root }
+      its(:daemons_path) { should == Rails_.root.join('lib', 'daemons') }
+      its(:daemons_directory) { should == Pathname.new('lib').join('daemons') }
+    end
+  end
+
+  describe "Overridden daemons directory" do
+    around :each do |example|
+      Daemons::Rails.configure do |c|
+        c.daemons_path = Rails.root.join('daemons')
+      end
+      example.run
+      Daemons::Rails.configure do |c|
+        c.daemons_path = nil
+      end
+    end
+
+    its(:daemons_path) { should == Rails.root.join('daemons') }
+    its(:daemons_directory) { should == Pathname.new('daemons') }
+
+    it "should override daemons directory" do
+      Daemons::Rails::Monitoring.daemons_directory.should == Rails.root.join('daemons')
+      Daemons::Rails::Monitoring.controllers.map(&:app_name).should == %w(test2.rb)
+    end
+  end
+end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: daemons-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0.alpha
+  prerelease: 6
 platform: ruby
 authors:
 - mirasrael
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-13 00:00:00.000000000Z
+date: 2012-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &14263920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *14263920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &14260740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *14260740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &14257180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *14257180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14233540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14233540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14228840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +85,12 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *14228840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 description: daemons gem support for Rails 3
 email: []
 executables: []
@@ -75,12 +100,14 @@ files:
 - .gitignore
 - .rspec
 - Gemfile
-- README
+- README.markdown
 - Rakefile
 - daemons-rails.gemspec
 - install.rb
 - lib/daemons-rails.rb
+- lib/daemons/rails.rb
 - lib/daemons/rails/config.rb
+- lib/daemons/rails/configuration.rb
 - lib/daemons/rails/controller.rb
 - lib/daemons/rails/monitoring.rb
 - lib/daemons/rails/version.rb
@@ -91,9 +118,13 @@ files:
 - lib/generators/templates/script.rb
 - lib/generators/templates/script_ctl
 - lib/tasks/daemons.rake
+- spec/fixtures/config.ru
 - spec/fixtures/config/daemons.yml
+- spec/fixtures/daemons/test2.rb
+- spec/fixtures/daemons/test2_ctl
 - spec/fixtures/lib/daemons/test.rb
 - spec/fixtures/lib/daemons/test_ctl
+- spec/lib/daemons/rails/configuration_spec.rb
 - spec/lib/daemons/rails/monitoring_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -108,22 +139,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1263531604415930102
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: -1263531604415930102
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: daemons gem support for Rails 3
 test_files: []
+has_rdoc: 

data/README

@@ -1,46 +0,0 @@
-Daemons Rails support (based on http://github.com/dougal/daemon_generator)
-================
-
-To get it work just add dependency to this gem in your Gemfile.
-
-== GENERATOR ==
-
-rails generate daemon <name>
-
-Then insert your code in the lib/daemons/<name>.rb stub. All pids and logs will live in the normal log/ folder. This helps to make things Capistrano friendly.
-
-== CHANGES ==
-
-1.0.0 - changed api for Daemons::Rails::Monitoring, fixed path in template for script, improved documentation, added RSpec
-0.0.3 - added rake for running script without daemonization (rake daemon:<name>)
-
-== CONTROL ==
-
-Individual control script:
-> ./lib/daemons/<name>_ctl [start|stop|restart|status]
-> rake daemon:<name>[:(start|stop|status)]
-
-Examples:
-rake daemon:test - runs lib/daemons/test.rb not daemonized
-rake daemon:test:start - start daemon using lib/daemons/test_ctl start
-rake daemon:test:stop - stop daemon using lib/daemons/test_ctl stop
-rake daemon:test:status - show running status for daemon using lib/daemons/test_ctl status
-
-App-wide control script:
-> ./script/daemons [start|stop|restart]
-> rake daemons:(start|stop|status)
-
-== MONITORING API ==
-
-Daemons::Rails::Monitoring.statuses - hash with all daemons and corresponding statuses
-Daemons::Rails::Monitoring.start("test.rb") - start daemon using lib/daemons/test_ctl start
-Daemons::Rails::Monitoring.stop("test.rb") - start daemon using lib/daemons/test_ctl stop
-Daemons::Rails::Monitoring.controllers - list of controllers
-Daemons::Rails::Monitoring.controller("test.rb") - controller for test.rb application
-
-controller = Daemons::Rails::Monitoring.controller("test.rb")
-controller.path # => lib/daemons/test_ctl
-controller.app_name # => test.rb
-controller.start # => starts daemon
-controller.stop # => stops daemon
-controller.status # => :not_exists or :running