climax 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in climax.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/climax.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8; mode: ruby -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "climax/version"
+
+Gem::Specification.new do |s|
+  s.name        = "climax"
+  s.version     = Climax::VERSION
+  s.authors     = ["Alfred J. Fazio"]
+  s.email       = ["alfred.fazio@gmail.com"]
+  s.homepage    = "https://github.com/afazio/climax"
+  s.summary     = %q{Ruby command line application framework}
+  s.description = %q{Opinionated framework for Ruby CLI applications that provides logging, cli argument parsing, daemonizing, configuration, testing, and even remote control of long running processes}
+
+  s.rubyforge_project = "climax"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_development_dependency "cucumber"
+
+  s.add_runtime_dependency "pry"
+  s.add_runtime_dependency "slop"
+  s.add_runtime_dependency "rspec"
+  s.add_runtime_dependency "cucumber"
+  s.add_runtime_dependency "pry-remote"
+end

data/lib/climax/control_drb.rb

@@ -0,0 +1,39 @@
+require 'drb/drb'
+
+module Climax
+  class ControlServer
+    def initialize(app)
+      @app = app
+    end
+
+    def log_level
+      @app.log_level
+    end
+
+    def log_level= (level)
+      @app.send_event(:set_log_level, level)
+    end
+
+    def start_debugger
+      @app.send_event(:start_remote_debugger)
+    end
+  end
+
+  class ControlDRb
+    def initialize(app, port)
+      @port = port
+      server = ControlServer.new(app)
+      DRb.start_service(uri, server)
+    end
+
+    def port
+      @port
+    end
+
+    def uri
+      "druby://localhost:#{port}"
+    end
+
+  end
+
+end

data/lib/climax/version.rb

@@ -0,0 +1,3 @@
+module Climax
+  VERSION = "0.0.1"
+end

data/lib/climax.rb

@@ -0,0 +1,181 @@
+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 :control_port=, "Override the port for the control DRb to listen on.  Default is 7249", :as => :int, :default => 7249
+        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
+      end
+      post_initialize
+      slop.parse
+      @opts = slop
+      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)
+      run
+    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
+    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
+      _event_loop
+      post_main
+    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
+        event = _next_event
+
+        unless event.nil?
+          case event.type
+          when :set_log_level then log_level = event.payload
+          when :start_remote_debugger then binding.remote_pry
+          when :quit then exit
+          end
+        end
+
+        result = main
+
+        exit result if result.is_a? Fixnum
+        raise result if result.is_a? String
+        raise "Unrecognized return value type: (#{result.class}: #{result}).  Only recognize strings, ints, or nil" 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
+
+
+  end
+end

data/test/bin/hello_world

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# -*- ruby-mode -*-
+$:.unshift(File.expand_path("../../lib", __FILE__))
+require "hello_world"
+HelloWorld::Application.new(ARGV).run

data/test/lib/hello_world.rb

@@ -0,0 +1,19 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+require 'climax'
+
+module HelloWorld
+  class Application
+    include Climax::Application
+
+    def post_initialize
+      options do
+        on 'v', 'verbose', 'More verbose'
+      end
+    end
+
+    def main
+      puts "Hello World!"
+      sleep 3
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: climax
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alfred J. Fazio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Opinionated framework for Ruby CLI applications that provides logging,
+  cli argument parsing, daemonizing, configuration, testing, and even remote control
+  of long running processes
+email:
+- alfred.fazio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- climax.gemspec
+- lib/climax.rb
+- lib/climax/control_drb.rb
+- lib/climax/version.rb
+- test/bin/hello_world
+- test/lib/hello_world.rb
+homepage: https://github.com/afazio/climax
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: climax
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Ruby command line application framework
+test_files:
+- test/bin/hello_world
+- test/lib/hello_world.rb