jewelbox 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 TODO: Write your name
+Copyright (c) 2012 Steve Jang
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -4,6 +4,7 @@ Useful Ruby utility classes that handle:
 
 - configuration
 - time stamp
+- object serialization
 
 ## Installation
 
@@ -73,10 +74,6 @@ you might store your configuration in a YAML file under conf/ directory.
    Jewelbox.config.service.log_dir     => "/opt/myrailsapp/current/log"
    Jewelbox.config.service.bin_dir     => "/opt/myrailsapp/current/bin"
 
-3. And my unicorn configuration looks like this:
- 
-   TBD
-
 ## Contributing
 
 1. Fork it

data/lib/jewelbox.rb

@@ -1,4 +1,5 @@
 require "jewelbox/version"
-require "jewelbox/config"
 require "jewelbox/ext/object"
 require "jewelbox/ext/time"
+require "jewelbox/config"
+require "jewelbox/command"

data/lib/jewelbox/command.rb

@@ -0,0 +1,179 @@
+require 'jewelbox/ext/object'
+require 'jewelbox/ext/string'
+require 'optparse'
+module Jewelbox
+
+  # === Description
+  # Simple wrapper around Ruby OptionParser to factor out common code that
+  # you have to repeat every time you write a command line tool. This is a
+  # simple wrapper. There is minimum additional functionality.
+  #
+  # === Example Code
+  # Creating a new command line tool or service runner.
+  #
+  # class MyApp < Jewelbox::Command
+  #
+  #   class MyCustomException < RuntimeError; end
+  #   exit_code 1, RuntimeError,      "Unexpected error"
+  #   exit_code 2, MyCustomException, "Some good explanation"
+  #
+  #   def initialize
+  #     @address = "default address"
+  #     @name    = "default name"
+  #     @arg1    = ""
+  #     @arg2    = ""
+  #   end
+  #
+  #   def define_options(opt)
+  #     opt.banner = "Usage: #{opt.program_name} [options] arg1 arg2"
+  #     opt.on("-a addr", "--address addr", String, "Address to work with") {|s| @address = s}
+  #     opt.on("-n name", "--name name", String, "Name to work with")       {|s| @name = s}
+  #   end
+  #
+  #   # Main entry point of the application
+  #   #
+  #   def main(argv)
+  #     @arg1 = argv[0]
+  #     @arg2 = argv[1]
+  #     # write application code here
+  #   end
+  #
+  # end
+  #
+  # MyApp.new.run
+  #
+  # === Help Output Example
+  # With the above example, you will get the following help text:
+  #
+  # Usage: myapp [options] arg1 arg2
+  #     -a, --address addr               Address to work with
+  #     -n, --name name                  Name to work with
+  #     -h, --help                       Display help
+  #     -v, --verbose                    Verbose output
+  #
+  # Exit codes:
+  #      1 [RuntimeError]                Unexpected error
+  #      2 [MyApp::MyCustomException]    Some good explanation
+  #
+  # === Notes
+  #
+  # 1. The following options are automatically added.
+  #   opt.on("-h", "--help",    "Display help")   { @help = true }
+  #   opt.on("-v", "--verbose", "Verbose output") { @verbose = true }
+  #
+  # 2. You can map exception type to exit code by using exit_code method
+  #    When exception happens during "run", we exit with the matching exit code (default = 1)
+  #    Also, exception message + "[ERROR]" will be displayed to STDERR.
+  #
+  # 3. Make sure to override "define_options" and "main" methods.
+  #
+  class Command
+    @@exit_code_map = {}
+
+    # === Description
+    # Maps exception class to the exit code.
+    #
+    # === Parameters
+    # number:: (Integer) exit code to return on given exception
+    # eClass:: (Class) exception class
+    # message:: (String) explanation of the exception
+    #
+    def self.exit_code(number, eClass, message = "")
+      @@exit_code_map[eClass] = [number.to_i, eClass, message]
+    end
+
+    private
+
+    def default_options(opt) # :nodoc:
+      opt.on("-h", "--help", "Display help")      {@help = true}
+      opt.on("-v", "--verbose", "Verbose output") {@verbose = true}
+    end
+
+    def define_exit_codes(opt) # :nodoc:
+      opt.separator ""
+      arr = @@exit_code_map.values.sort {|a,b| a[0] <=> b[0]}
+      unless arr.empty?
+        opt.separator "Exit codes:"
+        arr.each do |code, eClass, msg|
+          opt.separator "%6d %-29s %s" % [code, "[#{eClass}]", msg]
+        end
+      end
+    end
+
+    public
+
+    # === Description
+    # Your application should override this method.
+    # Define application command line options.
+    #
+    # === Parameters
+    # opt:: (OptionParser) use this to define options
+    #
+    def define_options(opt)
+      # override this; no additional options by default
+    end
+
+    # === Description
+    # Your application should override this method.
+    # Implement the main entry point.
+    #
+    # === Parameters
+    # argv:: (Array) of positional arguments
+    #        Basically left over after processing command line options
+    #        starting with dash(s) as defined in get_options.
+    #
+    # === Returns
+    # (Integer) exit code
+    #
+    def main(argv)
+      # override this; no default action in main
+    end
+
+    # === Description
+    # Parse options, and run the main method
+    # 
+    # === Returns
+    # (Integer) exit code
+    #
+    def run
+      code = 0
+      opt = OptionParser.new
+      define_options(opt)
+      default_options(opt)
+      define_exit_codes(opt)
+      argv = opt.parse!
+
+      if @help
+        puts_msg(opt.help)
+
+      else
+        begin
+          main(argv)
+        rescue Exception => e
+          arr = @@exit_code_map[e.class]
+          code = arr ? arr[0] : 1
+          puts_err e.to_s
+          puts_err "[ERROR]"
+        end
+      end
+
+      exit(code)
+    end
+
+    # === Description
+    # Print out msg to STDOUT
+    #
+    def puts_msg(msg)
+      STDOUT.puts(msg)
+    end
+
+    # === Description
+    # Print out msg to STDERR in red color
+    #
+    def puts_err(msg)
+      STDERR.puts(msg.to_s.red)
+    end
+
+  end
+end
+

data/lib/jewelbox/ext/string.rb

@@ -0,0 +1,32 @@
+class String
+
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+
+  def magenta
+    colorize(35)
+  end
+
+  def cyan
+    colorize(36)
+  end
+
+end
+

data/lib/jewelbox/version.rb

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

data/test/bin/myapp

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+require 'jewelbox/command'
+
+class MyApp < Jewelbox::Command
+
+  class MyCustomException < RuntimeError; end
+  exit_code 1, RuntimeError,      "Unexpected error"
+  exit_code 2, MyCustomException, "Some good explanation"
+
+  def initialize
+    @address = "default address"
+    @name    = "default name"
+  end
+
+  def define_options(opt)
+    opt.banner = "Usage: #{opt.program_name} [options] file1 file2"
+    opt.on("-a addr", "--address addr", String, "Address to work with") {|s| @address = s}
+    opt.on("-n name", "--name name", String, "Name to work with")       {|s| @name = s}
+  end
+
+  def do_something_with_address
+    puts "@address is #{@address}"
+  end
+
+  def do_something_with_name
+    puts "@name is #{@name}"
+  end
+
+  # Entry point of the application
+  #
+  def main(argv)
+    do_something_with_address
+    do_something_with_name
+    puts_msg "regular message"
+    puts_err "error message"
+    if argv[0] == "err"
+      raise MyCustomException.new("Some bad thing happened")
+    end
+  end
+
+end
+
+MyApp.new.run
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jewelbox
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-20 00:00:00.000000000 Z
+date: 2012-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &19426280 !ruby/object:Gem::Requirement
+  requirement: &13114440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19426280
+  version_requirements: *13114440
 description: A set of useful Ruby functions to be used when creating a new service
   or rails application
 email:
@@ -37,10 +37,13 @@ files:
 - Rakefile
 - jewelbox.gemspec
 - lib/jewelbox.rb
+- lib/jewelbox/command.rb
 - lib/jewelbox/config.rb
 - lib/jewelbox/ext/object.rb
+- lib/jewelbox/ext/string.rb
 - lib/jewelbox/ext/time.rb
 - lib/jewelbox/version.rb
+- test/bin/myapp
 - test/unit/conf/additional.yml
 - test/unit/conf/service.yml
 - test/unit/config_test.rb
@@ -72,6 +75,7 @@ specification_version: 3
 summary: Contains functions that support service configuration, useful ruby methods
   (such as eigenclass), and other functionality commonly used by Ruby services
 test_files:
+- test/bin/myapp
 - test/unit/conf/additional.yml
 - test/unit/conf/service.yml
 - test/unit/config_test.rb