climax 0.0.2 → 0.0.3

data/README.markdown

@@ -162,3 +162,51 @@ debugger will not begin until the current iteration of `main` has completed.
 This is excellent for stopping a long running process without interrupting its work.  By sending an
 :exit or :quit event, whether through the Control DRb or from your application itself, your
 application will be allowed to finish processing its current unit of work before exiting.
+
+Generating a New Application
+============================
+
+To help you get started quickly, you can easily generate a new application using climax by running
+the following command:
+
+    climax create <project-name>
+
+Climax will then create a new project for you that is ready to rock and roll.  Here is the file
+structure generated for a new project named "my_project":
+
+    my_project/
+      Gemfile
+      LICENSE.txt
+      README.md
+      Rakefile
+      bin/
+        my_project*
+      features/
+        step_definitions/
+        support/
+          io.rb
+          env.rb
+      lib/
+        my_project.rb
+        my_project/
+          version.rb
+      my_project.gemspec
+      pkg
+
+Your new application has the boilerplate code necessary to start running your application immediately:
+
+    cd my_project
+    ./bin/my_project --help
+    Usage: my_project [options]
+        -d, --daemon            Fork application and run in background
+            --log_level         Set to debug, info, warn, error, or fatal.  Default: info.
+            --log_file          File to log output to.  By default logs to stdout.
+            --control_port      Override the port for the control DRb to listen on.  Default is 7249
+        -h, --help              Display this help message.
+
+Running the application will simply print `"Hello World"` until you hit `Ctrl-C`.
+
+The three files you will want to modify are `README.md` (with info about your application),
+`<project-name>.gemspec` and `lib/<project-name>.rb`.
+
+You can bundle your application with `gem bundle *.gemspec`.

data/bin/climax

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'rubygems' rescue nil
+require 'climax/cli'
+Climax::CLI::Application.new(ARGV)

data/lib/climax.rb

@@ -1,218 +1 @@
-require "pry"
-require "slop"
-require "logger"
-require "pry-remote"
-require "climax/version"
-require "climax/control_drb"
-
-module Climax
-  module Application
-
-    def initialize(args=[])
-      @args = args.dup
-      options do
-        on :d, :daemon,    "Fork application and run in background"
-        on :log_level=,    "Set to debug, info, warn, error, or fatal.  Default: info.", :default => "info"
-        on :log_file=,     "File to log output to.  By default logs to stdout.", :default => nil
-        on :control_port=, "Override the port for the control DRb to listen on.  Default is 7249", :as => :int, :default => 7249
-      end
-      configure
-      _parse_options
-    end
-
-    def _pre_main
-      if daemonize?
-        exit 0 if !Process.fork.nil?
-        log.debug "Running in background (#{$$})"
-      end
-
-      log.debug "Starting Control DRb on port #{control_port}"
-      @control_drb = Climax::ControlDRb.new(self, control_port)
-    end
-
-    def _post_main
-      log.debug "Stopping Control DRb"
-      @control_drb.stop_service
-    end
-
-    def _parse_options
-      slop.parse!
-      @opts = slop
-      exit 0 if opts.help?
-    rescue => e
-      abort("#{e.message}\n#{slop.to_s}")
-    end
-
-    def daemonize?
-      @daemonize = opts[:daemon]
-    end
-
-    def log
-      if @log.nil?
-        @log = Logger.new(log_file || $stdout, "daily")
-        @log.level = log_level
-        if log_file
-          @log.formatter = proc do |severity, datetime, progname, msg|
-            datetime = datetime.strftime("%Y-%m-%d %H:%M:%S")
-            "[#{datetime}] #{$$} #{severity} -- #{msg}\n"
-          end
-        else
-          # Give a more concise format when logging to STDOUT
-          @log.formatter = proc do |severity, datetime, progname, msg|
-            "#{severity}: #{msg}\n"
-          end
-        end
-      end
-      @log
-    end
-
-    def control_port
-      @control_port ||= opts[:control_port]
-    end
-
-    def control_port= (port)
-      raise "Cannot set control port to #{port}: ControlDRb is already running!" if @control_drb
-      @control_port = port
-    end
-
-    def log_file
-      @log_file ||= opts[:log_file]
-    end
-
-    def log_file= (path)
-      if !@log.nil?
-        warning = "Changing log path to #{path}!"
-        $stderr.write(warning)
-        log.warn(warning)
-        @log = nil
-      end
-      @log_file = path
-    end
-
-    # Return current log_level
-    def log_level
-      @log_level ||= string_to_log_level opts[:log_level]
-    end
-
-    # Set log level to "debug", "warn", "info", etc. or use Logger::DEBUG, etc.
-    def log_level= (level)
-      log.level = @log_level = string_to_log_level(level)
-      log.warn("Changed log level to #{level}")
-    end
-
-    # Example: "debug" => Logger::DEBUG
-    def string_to_log_level (string)
-      return string if string.is_a? Fixnum
-      Logger.const_get(string.upcase)
-    end
-
-    # Raw command line arguments passed to application
-    def args
-      @args
-    end
-
-    # Return instance of Slop
-    def slop
-      @slop ||= Slop.new(:strict => true, :help => true)
-    end
-
-    # Method for wrapping calls to on() and banner().  Simply for readability.
-    # Example:
-    # options do
-    #   on 'v', 'verbose', 'More output'
-    # end
-    def options (&block)
-      yield
-    end
-
-    # Run the application
-    def run
-      _pre_main
-      pre_main
-      @exit_status = _event_loop
-      _post_main
-      post_main
-
-      exit exit_status if exit_status.is_a? Fixnum
-      abort(exit_status.to_s)
-    end
-
-    def exit_status
-      @exit_status
-    end
-
-    # Return current options.  nil until ClimaxApplication::new has finished running
-    def opts
-      @opts
-    end
-
-    # Set a command line option ala Slop
-    def on (*args)
-      slop.on(*args)
-    end
-
-    # Set help banner output ala Slop
-    def banner (*args)
-      slop.banner(*args)
-    end
-
-    def command (cmd, &block)
-      slop.command(cmd, block)
-    end
-
-    def _event_loop
-      while true
-
-        begin
-          event = _next_event
-
-          unless event.nil?
-            case event.type
-            when :set_log_level then log_level = event.payload
-            when :stop_control_drb then @control_drb && @control_drb.stop_service
-            when :start_remote_debugger then binding.remote_pry
-            when :quit, :exit then return 0
-            end
-          end
-        end while !event.nil?
-
-        result = main
-        return result if !result.nil?
-      end
-    end
-
-    def send_event (type, payload=nil)
-      events_mutex.synchronize {
-        events.unshift OpenStruct.new(:type => type, :payload => payload)
-      }
-    end
-
-    def events
-      @events ||= []
-    end
-
-    def _next_event
-      events_mutex.synchronize {
-        events.pop
-      }
-    end
-
-    def events_mutex
-      @events_mutex ||= Mutex.new
-    end
-
-    def configure
-    end
-
-    def main
-      raise "Please implement a main() method for your application."
-    end
-
-    def pre_main
-    end
-
-    def post_main
-    end
-
-  end
-end
+require 'climax/application'

data/lib/climax/application.rb

@@ -0,0 +1,218 @@
+require "pry"
+require "slop"
+require "logger"
+require "pry-remote"
+require "climax/version"
+require "climax/control_drb"
+
+module Climax
+  module Application
+
+    def initialize(args=[])
+      @args = args.dup
+      options do
+        on :d, :daemon,    "Fork application and run in background"
+        on :log_level=,    "Set to debug, info, warn, error, or fatal.  Default: info.", :default => "info"
+        on :log_file=,     "File to log output to.  By default logs to stdout.", :default => nil
+        on :control_port=, "Override the port for the control DRb to listen on.  Default is 7249", :as => :int, :default => 7249
+      end
+      configure
+      _parse_options
+    end
+
+    def _pre_main
+      if daemonize?
+        exit 0 if !Process.fork.nil?
+        log.debug "Running in background (#{$$})"
+      end
+
+      log.debug "Starting Control DRb on port #{control_port}"
+      @control_drb = Climax::ControlDRb.new(self, control_port)
+    end
+
+    def _post_main
+      log.debug "Stopping Control DRb"
+      @control_drb.stop_service
+    end
+
+    def _parse_options
+      slop.parse!
+      @opts = slop
+      exit 0 if opts.help?
+    rescue => e
+      abort("#{e.message}\n#{slop.to_s}")
+    end
+
+    def daemonize?
+      @daemonize = opts[:daemon]
+    end
+
+    def log
+      if @log.nil?
+        @log = Logger.new(log_file || $stdout, "daily")
+        @log.level = log_level
+        if log_file
+          @log.formatter = proc do |severity, datetime, progname, msg|
+            datetime = datetime.strftime("%Y-%m-%d %H:%M:%S")
+            "[#{datetime}] #{$$} #{severity} -- #{msg}\n"
+          end
+        else
+          # Give a more concise format when logging to STDOUT
+          @log.formatter = proc do |severity, datetime, progname, msg|
+            "#{severity}: #{msg}\n"
+          end
+        end
+      end
+      @log
+    end
+
+    def control_port
+      @control_port ||= opts[:control_port]
+    end
+
+    def control_port= (port)
+      raise "Cannot set control port to #{port}: ControlDRb is already running!" if @control_drb
+      @control_port = port
+    end
+
+    def log_file
+      @log_file ||= opts[:log_file]
+    end
+
+    def log_file= (path)
+      if !@log.nil?
+        warning = "Changing log path to #{path}!"
+        $stderr.write(warning)
+        log.warn(warning)
+        @log = nil
+      end
+      @log_file = path
+    end
+
+    # Return current log_level
+    def log_level
+      @log_level ||= string_to_log_level opts[:log_level]
+    end
+
+    # Set log level to "debug", "warn", "info", etc. or use Logger::DEBUG, etc.
+    def log_level= (level)
+      log.level = @log_level = string_to_log_level(level)
+      log.warn("Changed log level to #{level}")
+    end
+
+    # Example: "debug" => Logger::DEBUG
+    def string_to_log_level (string)
+      return string if string.is_a? Fixnum
+      Logger.const_get(string.upcase)
+    end
+
+    # Raw command line arguments passed to application
+    def args
+      @args
+    end
+
+    # Return instance of Slop
+    def slop
+      @slop ||= Slop.new(:strict => true, :help => true)
+    end
+
+    # Method for wrapping calls to on() and banner().  Simply for readability.
+    # Example:
+    # options do
+    #   on 'v', 'verbose', 'More output'
+    # end
+    def options (&block)
+      yield
+    end
+
+    # Run the application
+    def run
+      _pre_main
+      pre_main
+      @exit_status = _event_loop
+      _post_main
+      post_main
+
+      exit exit_status if exit_status.is_a? Fixnum
+      abort(exit_status.to_s)
+    end
+
+    def exit_status
+      @exit_status
+    end
+
+    # Return current options.  nil until ClimaxApplication::new has finished running
+    def opts
+      @opts
+    end
+
+    # Set a command line option ala Slop
+    def on (*args)
+      slop.on(*args)
+    end
+
+    # Set help banner output ala Slop
+    def banner (*args)
+      slop.banner(*args)
+    end
+
+    def command (cmd, &block)
+      slop.command(cmd, block)
+    end
+
+    def _event_loop
+      while true
+
+        begin
+          event = _next_event
+
+          unless event.nil?
+            case event.type
+            when :set_log_level then log_level = event.payload
+            when :stop_control_drb then @control_drb && @control_drb.stop_service
+            when :start_remote_debugger then binding.remote_pry
+            when :quit, :exit then return 0
+            end
+          end
+        end while !event.nil?
+
+        result = main
+        return result if !result.nil?
+      end
+    end
+
+    def send_event (type, payload=nil)
+      _events_mutex.synchronize {
+        _events.unshift OpenStruct.new(:type => type, :payload => payload)
+      }
+    end
+
+    def _events
+      @_events ||= []
+    end
+
+    def _next_event
+      _events_mutex.synchronize {
+        _events.pop
+      }
+    end
+
+    def _events_mutex
+      @_events_mutex ||= Mutex.new
+    end
+
+    def configure
+    end
+
+    def main
+      raise "Please implement a main() method for your application."
+    end
+
+    def pre_main
+    end
+
+    def post_main
+    end
+
+  end
+end

data/lib/climax/cli.rb

@@ -0,0 +1,34 @@
+require 'slop'
+
+require 'climax/commands/create'
+require 'climax/commands/control'
+
+module Climax
+  module CLI
+    class Application
+
+      def initialize (args)
+        @args = args.dup
+        @opts = Slop.parse(:strict => true, :help => true) do
+          command 'create' do
+            run do |options, args|
+              Climax::CLI::Command::Create.new(options, args).run
+            end
+          end
+
+          command 'control' do
+            on 'p', 'port=', 'Port of control drb to connect to.  Default: 7249', :default => 7249, :as => :int
+            run do |options, args|
+              Climax::CLI::Command::Control.new(options, args).run
+            end
+          end
+        end
+      end
+
+      def opts
+        @opts
+      end
+
+    end
+  end
+end

data/lib/climax/commands/control.rb

@@ -0,0 +1 @@
+

data/lib/climax/commands/create.rb

@@ -0,0 +1,77 @@
+require 'fileutils'
+require 'erb'
+
+module Climax
+  module CLI
+    module Command
+      class Create
+
+        def initialize (options, args)
+          @opts = options.dup
+          @args = args.dup
+        end
+
+        def run
+          raise "Too many arguments.  Just pass name of new climax application" if args.length > 1
+          raise "Not enough arguments.  Please pass name of new climax application" if args.length < 1
+          @full_path = args[0]
+          @name = File.basename(@full_path)
+          @dir = File.dirname(@full_path)
+
+          create_directory_structure @name, @dir
+        end
+
+        def in_directory (dir, &block)
+          cwd = FileUtils.pwd
+          FileUtils.mkpath(dir)
+          FileUtils.cd(dir)
+          begin
+            yield
+          ensure
+            FileUtils.cd(cwd)
+          end
+        end
+
+        def create_directory_structure (name, dir)
+          in_directory(dir) do
+            # Create standard bundler gem layout
+            %x[bundle gem #{name}]
+            # Add a couple extra directories
+            FileUtils.mkpath(["#{name}/bin", "#{name}/features", "#{name}/pkg"])
+
+            # Get bundler generated module path
+            gemspec = File.read("#{name}/#{name}.gemspec")
+            module_string = /gem.version\s+=\s+(.*)::VERSION/.match(gemspec)[1]
+            module_path = module_string.split("::")
+
+            template_dir = File.join(File.dirname(__FILE__), "..", "..", "..", "templates")
+
+            File.open("#{name}/bin/#{name}", "w") do |file|
+              file.write(ERB.new(File.read(File.join(template_dir, "application_wrapper.erb")), 0, '<>').result(binding))
+            end
+
+            FileUtils.chmod "+x", "#{name}/bin/#{name}"
+
+            File.open("#{name}/lib/#{name}.rb", "w") do |file|
+              file.write(ERB.new(File.read(File.join(template_dir, "application.rb.erb")), 0, '<>').result(binding))
+            end
+
+            gemspec.gsub!(/^end$/, "  gem.add_development_dependency \"cucumber\"\n  gem.add_runtime_dependency \"climax\"\nend")
+            File.open("#{name}/#{name}.gemspec", "w") do |file|
+              file.write(gemspec)
+            end
+
+          end
+        end
+
+        def opts
+          @opts
+        end
+
+        def args
+          @args
+        end
+      end
+    end
+  end
+end

data/lib/climax/version.rb

@@ -1,3 +1,3 @@
 module Climax
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/templates/application.rb.erb

@@ -0,0 +1,37 @@
+require "climax"
+require "<%= name %>/version"
+
+<% indent = 0 %>
+<% module_path.each do |m| %>
+<%=  (" "*indent) + "module #{m}\n" %>
+<%   indent = indent + 2 %>
+<% end %>
+
+  class Application
+    include Climax::Application
+
+    def configure
+      # options do
+      #   on 'v', 'verbose', 'More verbose'
+      # end
+    end
+
+    def pre_main
+      # log.debug "Application has is about to run"
+    end
+
+    def main
+      log.info "Hello World!"
+      sleep 1
+      return nil
+    end
+
+    def post_main
+      # log.debug "Application is shutting down."
+    end
+  end
+
+<% module_path.each do |_| %>
+<%   indent = indent - 2 %>
+<%=  (" "*indent) + "end\n" %>
+<% end %>

data/templates/application_wrapper.erb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+$:.unshift File.expand_path("../../lib", __FILE__)
+require "rubygems" rescue nil
+require "<%= name %>"
+<%= module_string %>::Application.new(ARGV).run

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: climax
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -96,7 +96,8 @@ description: Opinionated framework for Ruby CLI applications that provides loggi
   of long running processes
 email:
 - alfred.fazio@gmail.com
-executables: []
+executables:
+- climax
 extensions: []
 extra_rdoc_files: []
 files:
@@ -104,10 +105,17 @@ files:
 - Gemfile
 - README.markdown
 - Rakefile
+- bin/climax
 - climax.gemspec
 - lib/climax.rb
+- lib/climax/application.rb
+- lib/climax/cli.rb
+- lib/climax/commands/control.rb
+- lib/climax/commands/create.rb
 - lib/climax/control_drb.rb
 - lib/climax/version.rb
+- templates/application.rb.erb
+- templates/application_wrapper.erb
 - test/bin/hello_world
 - test/lib/hello_world.rb
 homepage: https://github.com/appriss/climax