rsm 0.1.beta4 → 0.1.rc1

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 0.1.rc1 / August 31, 2011
+
+  * Refactored tasks heirarchy
+  * Fixed class options in `Rsm::Base`
+  * Unicorn: added `start` and `stop` commands
+
 # 0.1.beta4 / August 31, 2011
 
   * `unicorn` command as method in `Runner`

data/README.md

@@ -7,16 +7,12 @@ RSM created for make easier some actons on server like:
   * manipulation of files
   * running commands
 
-and other Rails application tasks.
-
 This version can:
 
   * create Nginx virtual server config from template
-  * enable Nginx virtual server config
+  * automaticly enable Nginx virtual server config
   * clone from Git repo or download and unpack Rails application from TGZ or TBZ2 archive
-  * set permission for Rails application
-  * create Unicorn config from template
-  * run unicorn server
+  * start and stop unicorn server
 
 Homepage
 --------
@@ -43,7 +39,13 @@ Install from RubyGems:
 Ussage
 -----
 
-Run `rsm -T` for details
+List avalable tasks:
+  
+    $ rsm -T
+  
+Help for certain task:
+
+    $ rsm help TASK
 
 Documentation
 -------------

data/VERSION

@@ -1 +1 @@
-0.1.beta4
+0.1.rc1

data/lib/rsm/base.rb

@@ -7,11 +7,16 @@ module Rsm
 
     argument :name
 
-    class_option :apps_root, :defualt => "/var/www", :aliases => "-r", :desc => "Rails apps root (default: /var/www)"
-    class_option :capistrano, :defualt => false, :aliases => "-c", :desc => "Application's Capistrano stage"
+    class_option :apps_root, :default => "/var/www", :aliases => "-r", :desc => "Rails apps root"
+    class_option :capistrano, :default => false, :aliases => "-c", :desc => "Application's Capistrano stage"
 
+
+    def self.template_path
+      Thor::Util.snake_case(name.to_s).squeeze(":").gsub(":", "/")
+    end
+    
     def self.source_root
-      File.expand_path('../../../templates', __FILE__)
+      File.expand_path("../../../templates/#{template_path}", __FILE__)
     end
 
     def application_root

data/lib/rsm/runner.rb

@@ -1,5 +1,13 @@
+require 'thor'
+require 'thor/group'
+require 'thor/util'
+
 module Rsm
+  class Error < Thor::Error; end
+  
   class Runner < Thor
+    map '-T' => :list, '-v' => :version
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        #
     include Thor::Actions
 
     desc "version", "RSM gem version"
@@ -8,18 +16,119 @@ module Rsm
       say "RSM version #{Rsm::VERSION}"
     end
 
-    register Rsm::Install::Nginx, "install:nginx", "install:nginx NAME", "Install Nginx config"
-    register Rsm::Install::Rails, "install:rails", "install:rails NAME", "Install Rails application"
+    # If a task is not found on Thor::Runner, method missing is invoked and
+    # Thor::Runner is then responsable for finding the task in all classes.
+    #
+    def method_missing(meth, *args)
+      meth = meth.to_s
+      initialize_thorfiles(meth)
+      klass, task = Thor::Util.find_class_and_task_by_namespace(meth)
+      args.unshift(task) if task
+      klass.start(args, :shell => self.shell)
+    end
+    
+    desc "list [SEARCH]", "List the available thor tasks (--substring means .*SEARCH)"
+    method_options :substring => :boolean, :group => :string, :all => :boolean, :debug => :boolean
+    def list(search="")
+      initialize_thorfiles
+  
+      search = ".*#{search}" if options["substring"]
+      search = /^#{search}.*/i
+      group  = options[:group] || "standard"
+  
+      klasses = Thor::Base.subclasses.select do |k|
+        (options[:all] || k.group == group) && k.namespace =~ search
+      end
+  
+      display_klasses(false, false, klasses)
+    end
+    
+    # Override Thor#help so it can give information about any class and any method.
+    #
+    def help(meth = nil)
+      if meth && !self.respond_to?(meth)
+        initialize_thorfiles(meth)
+        klass, task = Thor::Util.find_class_and_task_by_namespace(meth)
+        klass.start(["-h", task].compact, :shell => self.shell)
+      else
+        super
+      end
+    end
+
+    private
 
-    desc "install NAME", "Install Nginx config and Rails application"
-    def install(name)
-      invoke "install:nginx"
-      invoke "install:rails"
+    def self.banner(task, all = false, subcommand = false)
+      "rsm " + task.formatted_usage(self, all, subcommand)
+    end
+    
+    def thor_root
+      File.expand_path("../../tasks", __FILE__)
     end
+    
+    def thorfiles(relevant_to=nil, skip_lookup=false)
+      Dir["#{thor_root}/**/*.rb"]
+    end
+    
+    # Load the thorfiles. If relevant_to is supplied, looks for specific files
+    # in the thor_root instead of loading them all.
+    #
+    # By default, it also traverses the current path until find Thor files, as
+    # described in thorfiles. This look up can be skipped by suppliying
+    # skip_lookup true.
+    #
+    def initialize_thorfiles(relevant_to=nil, skip_lookup=false)
+      thorfiles(relevant_to, skip_lookup).each do |f|
+        require f unless Thor::Base.subclass_files.keys.include?(File.expand_path(f))
+      end
+    end
+    
+    # Display information about the given klasses. If with_module is given,
+    # it shows a table with information extracted from the yaml file.
+    #
+    def display_klasses(with_modules=false, show_internal=false, klasses=Thor::Base.subclasses)
+      klasses -= [Thor, Thor::Group, Rsm::Runner, Rsm::Base] unless show_internal
+
+      raise Error, "No Thor tasks available" if klasses.empty?
+      # show_modules if with_modules && !thor_yaml.empty?
+
+      list = Hash.new { |h,k| h[k] = [] }
+      groups = klasses.select { |k| k.ancestors.include?(Thor::Group) }
+
+      # Get classes which inherit from Thor
+      (klasses - groups).each { |k| list[k.namespace.split(":").first] += k.printable_tasks(false) }
+
+      # Get classes which inherit from Thor::Base
+      groups.map! { |k| k.printable_tasks(false).first }
+      list["root"] = groups
+
+      # Order namespaces with default coming first
+      list = list.sort{ |a,b| a[0].sub(/^default/, '') <=> b[0].sub(/^default/, '') }
+      list.each { |n, tasks| display_tasks(n, tasks) unless tasks.empty? }
+    end
+
+    def display_tasks(namespace, list) #:nodoc:
+      list.sort!{ |a,b| a[0] <=> b[0] }
+
+      say shell.set_color(namespace, :blue, true)
+      say "-" * namespace.size
+
+      print_table(list, :truncate => true)
+      say
+    end
+
+    def show_modules #:nodoc:
+      info  = []
+      labels = ["Modules", "Namespaces"]
+
+      info << labels
+      info << [ "-" * labels[0].size, "-" * labels[1].size ]
+
+      thor_yaml.each do |name, hash|
+        info << [ name, hash[:namespaces].join(", ") ]
+      end
 
-    desc "unicorn NAME", "Run Unicorn server"
-    def unicorn(name)
-      invoke Rsm::Unicorn
+      print_table info
+      say ""
     end
   end
 end

data/lib/rsm.rb

@@ -1,16 +1,5 @@
-require 'pathname'
-require 'thor'
-require 'thor/group'
-require 'thor/util'
-
 module Rsm
   autoload :Actions, 'rsm/actions'
   autoload :Runner, 'rsm/runner'
   autoload :Base, 'rsm/base'
-  autoload :Unicorn, 'rsm/unicorn'
-
-  module Install
-    autoload :Nginx, 'rsm/install/nginx'
-    autoload :Rails, 'rsm/install/rails'
-  end
 end

data/lib/tasks/unicorn/start.rb

@@ -0,0 +1,18 @@
+module Rsm
+  module Unicorn
+    class Start < Rsm::Base
+      class_option :environment, :aliases => "-e", :default => "production"
+  
+      def unicorn_rails
+        rvmrc = application_root.join(".rvmrc")
+        if rvmrc.exist?
+          ruby_cmd = File.new(rvmrc).readline.strip + " exec"
+        else
+          ruby_cmd = "#{Thor::Util.ruby_command} -S"
+        end
+        run "#{ruby_cmd} unicorn_rails -D -E #{options[:environment]} -c #{application_root.join("config", "unicorn.rb")}"
+      end
+      
+    end
+  end
+end

data/lib/tasks/unicorn/stop.rb

@@ -0,0 +1,12 @@
+module Rsm
+  module Unicorn
+    class Stop < Rsm::Base
+  
+      def unicorn_rails
+        pidfile = application_root.join("tmp", "pids", "unicorn.pid")
+        run "kill $(cat #{pidfile})"
+      end
+      
+    end
+  end
+end

data/rsm.gemspec

@@ -24,6 +24,5 @@ Gem::Specification.new do |s|
   s.requirements << 'A coreutils installed'
   s.requirements << 'A Git installed'
   s.requirements << 'A Nginx installed'
-  s.requirements << 'You must have super-user access'
   s.add_dependency 'thor', '~> 0.14.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsm
 version: !ruby/object:Gem::Version
-  version: 0.1.beta4
+  version: 0.1.rc1
   prerelease: 4
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &82486100 !ruby/object:Gem::Requirement
+  requirement: &19351848 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *82486100
+  version_requirements: *19351848
 description: Thor tasks for rapid deployment new rails apps on server
 email: a.ulyanitsky@gmail.com
 executables:
@@ -43,14 +43,15 @@ files:
 - lib/rsm.rb
 - lib/rsm/actions.rb
 - lib/rsm/base.rb
-- lib/rsm/install/nginx.rb
-- lib/rsm/install/rails.rb
 - lib/rsm/runner.rb
-- lib/rsm/unicorn.rb
 - lib/rsm/version.rb
+- lib/tasks/install/nginx.rb
+- lib/tasks/install/rails.rb
+- lib/tasks/unicorn/start.rb
+- lib/tasks/unicorn/stop.rb
 - rsm.gemspec
-- templates/nginx-unicorn.conf.erb
-- templates/unicorn.rb.erb
+- templates/rsm/install/nginx/nginx-unicorn.conf.erb
+- templates/rsm/install/rails/unicorn.rb.erb
 homepage: https://github.com/asux/rsm
 licenses:
 - MIT
@@ -77,7 +78,6 @@ requirements:
 - A coreutils installed
 - A Git installed
 - A Nginx installed
-- You must have super-user access
 rubyforge_project: 
 rubygems_version: 1.8.6
 signing_key: 

data/lib/rsm/unicorn.rb

@@ -1,16 +0,0 @@
-module Rsm
-  class Unicorn < Base
-
-    class_option :environment, :aliases => "-e", :default => "production"
-
-    def unicorn_rails
-      rvmrc = application_root.join(".rvmrc")
-      if rvmrc.exist?
-        ruby_cmd = File.new(rvmrc).readline.strip + " exec"
-      else
-        ruby_cmd = "#{Thor::Util.ruby_command} -S"
-      end
-      run "#{ruby_cmd} unicorn_rails -D -E #{options[:environment]} -c #{application_root.join("config", "unicorn.rb")}"
-    end
-  end
-end