methadone 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28edf03f317826eca04da77d8a6fb3bf4fb0c977
-  data.tar.gz: 64b4d8b287ec915faee422425d9054ef79f95b73
+  metadata.gz: 6f6cada4890a57e4aaee044b291ed1a345e0cdc0
+  data.tar.gz: 3c2616c59e9a043980fa2d690934ba6877da0d00
 SHA512:
-  metadata.gz: 1e4c6b2c4b41d4f25b6d60c1dc8a2975da51a39cc62bb8073457b61a6c306043b177705f75f10c06cb62452a779730db5263616c7d9e35b5ae6886afe29d8229
-  data.tar.gz: 1a0e5f3bc306390de60e25f4a248dc5343e97362fdc4afd7a17a7c854069520af02d480287743a54eb3a7ff358174344d8ed0d718855e3aa5c708997ee1471bc
+  metadata.gz: c5f40dd8ff1d8903c4447529b663c52c27063ccf718a8ece6937e6011ce53669840fb14e65c2094b8e92e460bf2156b1e1f15ed9ddc3c080e445d73edca8b0dc
+  data.tar.gz: 1c0d003dcf3cdc66937b8bfd3979a2b749e7b3fa09acdbc2a5a9ee5428e371834b243bcc38b23c3da100e1000b280e50db1e94679fe26bb4ede1d60b541bfc8b

data/README.rdoc

@@ -32,15 +32,12 @@ http://a1.mzstatic.com/us/r30/Publication/v4/2c/f7/90/2cf7902f-f709-9125-c73d-87
 == Platforms
 
 * The build runs on Travis for:
-  * MRI Ruby 1.8.7
   * MRI Ruby 1.9.2
   * MRI Ruby 1.9.3
-  * RBX
-  * REE
+  * MRI Ruby 2.0.0
+  * MRI Ruby 2.1.0
   * JRuby in both 1.8 and 1.9 mode
 
-It should work on 2.0.0 but there's a weird bundler issue where some of the aruba tests fail in odd ways.
-
 == Bootstrapping a new CLI App
 
 The +methadone+ command-line app will bootstrap a new command-line app, setting up a proper gem structure, unit tests, and cucumber-based tests with aruba:
@@ -129,7 +126,7 @@ Methadone::CLILogger is designed to handle this.  It's a proper subclass of Ruby
 See {CLILogger's rdoc}[http://davetron5000.github.com/methadone/rdoc/classes/Methadone/CLILogger.html] and then {CLILogging's}[http://davetron5000.github.com/methadone/rdoc/classes/Methadone/CLILogging.html] for more.
 
 
-Currently, there are classes the assist in directing output logger-style to the right place; basically ensuring that errors go to +STDERR+ and everything else goes to +STDOUT+.  All of this is, of course, configurable
+Currently, there are classes that assist in directing output logger-style to the right place; basically ensuring that errors go to +STDERR+ and everything else goes to +STDOUT+.  All of this is, of course, configurable
 
 == Cucumber Steps
 

data/lib/methadone/cli_logging.rb

@@ -74,7 +74,11 @@ module Methadone
     }
 
     # Call this *if* you've included Methadone::Main to set up a <tt>--log-level</tt> option for your app
-    # that will allow the user to configure the logging level.
+    # that will allow the user to configure the logging level. You can pass an optional hash with
+    # <tt>:toggle_debug_on_signal => <SIGNAME></tt> to enable runtime toggling of the log level by sending the
+    # signal <tt><SIGNAME></tt> to your app
+    #
+    # +args+:: optional hash
     #
     # Example:
     #
@@ -86,12 +90,48 @@ module Methadone
     #
     #     go!
     #
-    def use_log_level_option
+    # Example with runtime toggling:
+    #
+    #
+    #     main do 
+    #       # your app
+    #     end
+    #
+    #     use_log_level_option :toggle_debug_on_signal => 'USR1'
+    #
+    #     go!
+    def use_log_level_option(args = {})
       on("--log-level LEVEL",LOG_LEVELS,'Set the logging level',
                                         '(' + LOG_LEVELS.keys.join('|') + ')',
                                         '(Default: info)') do |level|
         @log_level = level
+        @log_level_original = level
+        @log_level_toggled = false
         logger.level = level
+
+        setup_toggle_trap(args[:toggle_debug_on_signal])
+      end
+    end
+
+  private
+
+    # Call this to toggle the log level between <tt>debug</tt> and its initial value
+    def toggle_log_level
+      @log_level_original = logger.level unless @log_level_toggled
+      logger.level = if @log_level_toggled
+                       @log_level_original
+                     else
+                       LOG_LEVELS['debug']
+                     end
+      @log_level_toggled = !@log_level_toggled
+      @log_level = logger.level
+    end
+
+    def setup_toggle_trap(signal)
+      if signal
+        Signal.trap(signal) do
+          toggle_log_level
+        end
       end
     end
   end

data/lib/methadone/execution_strategy/base.rb

@@ -18,17 +18,17 @@ module Methadone
       # <tt>[2]</tt>:: A Process::Status-like objects that responds to <tt>exitstatus</tt> which returns
       #                the exit code of the command (e.g. 0 for success).
       def run_command(command)
-        subclass_must_impelment!
+        subclass_must_implement!
       end
 
       # Returns the class that, if caught by calling #run_command, represents the underlying command
       # not existing.  For example, in MRI Ruby, if you try to execute a non-existent command,
       # you get a Errno::ENOENT.
       def exception_meaning_command_not_found
-        subclass_must_impelment!
+        subclass_must_implement!
       end
     protected
-      def subclass_must_impelment!; raise "subclass must implement"; end
+      def subclass_must_implement!; raise "subclass must implement"; end
     end
   end
 end

data/lib/methadone/version.rb

@@ -1,3 +1,3 @@
 module Methadone #:nodoc:
-  VERSION = "1.6.0" #:nodoc:
+  VERSION = "1.7.0" #:nodoc:
 end

data/templates/full/bin/executable.erb

@@ -37,7 +37,7 @@ class App
 
   version <%= module_name %>::VERSION
 
-  use_log_level_option
+  use_log_level_option :toggle_debug_on_signal => 'USR1'
 
   go!
 end

data/test/test_cli_logging.rb

@@ -5,6 +5,8 @@ require 'stringio'
 class TestCLILogging < BaseTest
   include Methadone
 
+  SLEEP_TIME = 0.1
+
   def setup
     @blank_format = proc do |severity,datetime,progname,msg|
       msg + "\n"
@@ -122,11 +124,61 @@ class TestCLILogging < BaseTest
     }
   end
 
+
+  test_that "when we enable runtime log level toggling, it toggles the log level on receiving the set signal" do
+    Given {
+      @app = MyAppThatActsLikeItUsesMain.new
+      @app.call_use_log_level_option( :toggle_debug_on_signal => 'USR2' )
+      @level = Logger::INFO
+      @app.use_option(@level)
+    }
+    When {
+      send_signal_and_wait_a_moment('USR2')
+    }
+    Then {
+      @app.logger.level.should == Logger::DEBUG
+    }
+  end
+
+  test_that "when we toggle the log level and change the logger, the new logger has also it's log level increased" do
+    Given {
+      @app = MyAppThatActsLikeItUsesMain.new
+      @app.call_use_log_level_option( :toggle_debug_on_signal => 'USR2' )
+      @level = Logger::INFO
+      @app.use_option(@level)
+    }
+    When {
+      send_signal_and_wait_a_moment('USR2')
+      @other_logger = OpenStruct.new
+      @app.change_logger(@other_logger)
+    }
+    Then {
+      @other_logger.level.should == Logger::DEBUG
+    }
+  end
+
+  test_that "when we enable runtime log level toggling and send the signal twice, the original log level is restored" do
+    Given {
+      @app = MyAppThatActsLikeItUsesMain.new
+      @app.call_use_log_level_option( :toggle_debug_on_signal => 'USR2' )
+      @level = Logger::INFO
+      @app.use_option(@level)
+    }
+    When {
+      send_signal_and_wait_a_moment('USR2')
+      send_signal_and_wait_a_moment('USR2')
+    }
+    Then {
+      @app.logger.level.should == Logger::INFO
+    }
+  end
+
+
   class MyAppThatActsLikeItUsesMain
     include Methadone::CLILogging
 
-    def call_use_log_level_option
-      use_log_level_option
+    def call_use_log_level_option(args = {})
+      use_log_level_option(args)
     end
 
     def use_option(level)
@@ -183,4 +235,9 @@ class TestCLILogging < BaseTest
 
     def logger_id; logger.object_id; end
   end
+
+  def send_signal_and_wait_a_moment(signal)
+    Process.kill(signal, $$)
+    sleep(SLEEP_TIME) # call sleep to give the trap handler a chance to kick in
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: methadone
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - davetron5000
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-17 00:00:00.000000000 Z
+date: 2014-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler