easy_app_helper 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23d7222b6e27c900ec97f2f7a9883abbcae4e3a7
-  data.tar.gz: 5c3958d362af194d4c44f74153093bc74074e9ed
+  metadata.gz: 53c79c3ab7f1d5d579b339daf801ddbf4075d52a
+  data.tar.gz: 1751310aea289a04187b81ea8234d3fce516d63b
 SHA512:
-  metadata.gz: 42b3f9ce66bc4bb1cd0f633d83b9150b54bc907ea255e533d021be5835fd810b464ca5ebf85237601604174fed6ec7ca013fe07ab9478087cb123735de8b0b73
-  data.tar.gz: 8c12f53068eb99052ca400241823a2ab1fb1c6cbfe6b35e7bb9c5b9c7cdbb594479d15eec83b52b6252aa8a8a833b2577d768c05d3064e34c9c9267480061f20
+  metadata.gz: 880f828c67d419ac672e9d04733b821f705dec3854e73625e6963ee662beebb6110317a02c821585f1748a23653d0195cf3efbae7df91ae8c51bdaab5ff121fb
+  data.tar.gz: a0099a111124742ff41ad1b9f594dd3eff987bdc35c1f6cf470d193ae3dc2dbd812a49ad9621d86560cdfb046f8d6a59df889f7f11a4ffdd2c94d4e1dcca56d7

data/README.md

@@ -6,12 +6,13 @@ Every Ruby script on Earth has basically the same fundamental needs:
 
 * Config files everywhere accross the system, some of them belonging to the administrator some to the user
   running the application, some coming from the command line options and more...
-* Display a nice command-line help
+* Support command line options directly overriding some of the properties defined in config files.
+* Display a nice command-line options help
 * Logging stuff either to STDOUT, STDERR or to a specific log file.
 
-__If, like everyone, you have those basic needs, then this [gem][EAP] is definitely for you.__
+__If, like everyone, you have those basic needs, then this [gem][EAH] is definitely for you.__
 
-This is a complete rewrite of the [easy_app_helper gem v1.x][EAP1] now based on the [stacked_config Gem][SC] for the
+This is a complete rewrite of the [easy_app_helper gem v1.x][EAH1] now based on the [stacked_config Gem][SC] for the
 config file management part, but it maintains some compatibility with previous version. See
 [compatibility issues with previous versions](#compatibility-issues-with-previous-versions) for more information.
 
@@ -102,7 +103,7 @@ puts_and_logs 'Hello world'
 ### The command line options
 
 The command line options is one of the config layers maintained by the [stacked_config Gem][SC], and therefore there
-is not much to say except that [easy_app_helper][EAP] adds itself some options related to the logging as seen in the
+is not much to say except that [easy_app_helper][EAH] adds itself some options related to the logging as seen in the
 [logger part](#the-logger).
 
 Of course as described in the [stacked_config Gem][SC] documentation, you can define your own options:
@@ -167,12 +168,87 @@ See [stacked_config Gem][SC] documentation for more options.
 
 ## Compatibility issues with previous versions
 
-[easy_app_helper][EAP] v2.x is not fully compatible with previous branch 1.x. But for common usage it should
+[easy_app_helper][EAH] v2.x is not fully compatible with previous branch 1.x. But for common usage it should
 nevertheless be the case.
 
 There is a (not perfect) compatibility mode that you can trigger by setting the `easy_app_helper_compatibility_mode`
 property to true in one of your config files.
 
+## Complete example of a script based on `easy_app_helper`
+
+Save the following file somewhere as `example.rb`.
+
+You can use this as a template for your own scripts:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'easy_app_helper'
+
+class MyApp
+
+  include EasyAppHelper
+
+  VERSION = '0.0.1'
+  NAME = 'My brand new Application'
+  DESCRIPTION = 'Best app ever'
+
+  def initialize
+    config.describes_application app_name: NAME,
+                                 app_version: VERSION,
+                                 app_description: DESCRIPTION
+    add_script_options
+  end
+
+  def add_script_options
+    config.add_command_line_section('Options for the script') do |slop|
+      slop.on :u, :useless, 'Stupid option', :argument => false
+      slop.on :an_int, 'Stupid option with integer argument', :argument => true, :as => Integer
+    end
+  end
+
+  def run
+    # An example of testing a command line option
+    config[:an_int] ||= 10
+
+    # Displaying command line help
+    if config[:help]
+      puts config.command_line_help
+      exit 0
+    end
+
+    begin
+      do_some_processing
+    rescue => e
+      puts "Program aborted with message: '#{e.message}'."
+      if config[:debug]
+        logger.fatal "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+      else
+        puts '  Use --debug option for more detail.'
+      end
+    end
+  end
+
+  def do_some_processing
+    # Here you would really start your process
+    puts_and_logs 'Starting processing'
+    config[:something] = 'Added something...'
+
+    # When in debug mode, will log the config used by the application
+    logger.debug config[].to_yaml
+
+    if config[:verbose]
+      puts ' ## Here is a display of the config sources and contents'
+      puts config.detailed_layers_info
+      puts ' ## This the resulting merged config'
+      puts config[].to_yaml
+    end
+  end
+
+end
+
+MyApp.new.run
+```
 
 ## Contributing
 
@@ -186,6 +262,6 @@ property to true in one of your config files.
 __That's all folks.__
 
 
-[EAP]:  https://rubygems.org/gems/easy_app_helper                        "EasyAppHelper gem"
-[EAP1]: https://rubygems.org/gems/easy_app_helper/tree/old_release_1_x   "EasyAppHelper gem DEPRECATED branch"
+[EAH]:  https://rubygems.org/gems/easy_app_helper                        "EasyAppHelper gem"
+[EAH1]: https://github.com/lbriais/easy_app_helper/tree/old_release_1_x  "EasyAppHelper gem DEPRECATED branch"
 [SC]:   https://github.com/lbriais/stacked_config                        "The stacked_config Gem"

data/easy_app_helper.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency 'stacked_config', '~> 0.1', '>= 0.1.2'
+  spec.add_runtime_dependency 'stacked_config', '~> 0.1', '>= 0.1.3'
 end

data/lib/easy_app_helper/version.rb

@@ -1,3 +1,3 @@
 module EasyAppHelper
-  VERSION = '2.0.2'
+  VERSION = '2.0.3'
 end

data/spec/easy_app_helper_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 describe EasyAppHelper do
 
   %i(config logger puts_and_logs safely_exec).each do |m|
-    it "should have module method #{m.to_s}" do
+    it "should have a :#{m.to_s} module method" do
       expect(subject).to respond_to m
     end
   end
@@ -18,7 +18,7 @@ describe EasyAppHelper do
     }
 
     %i(config logger puts_and_logs safely_exec).each do |m|
-      it "should have a #{m.to_s} method " do
+      it "should have a :#{m.to_s} method " do
         expect(subject).to respond_to m
       end
 

data/spec/logger_spec.rb

@@ -7,7 +7,7 @@ describe EasyAppHelper.logger do
     expect(subject).to be_a_kind_of ::Logger
   end
 
-  it 'should respond to puts_and_logs' do
+  it 'should respond to :puts_and_logs' do
     expect(subject).to respond_to :puts_and_logs
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ dependencies:
         version: '0.1'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,7 +85,7 @@ dependencies:
         version: '0.1'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
 description: Easy Application Helpers framework
 email:
 - lbnetid+rb@gmail.com
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Provides cool helpers to your application, including configuration and logging