easy_app_helper 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e26f7e3e20c41919179c83e8afbef9e91f80686
-  data.tar.gz: b76f54662fb9ef9146724ce1721b430d0c6c1a14
+  metadata.gz: e9ce79a31fbe4f16b495bd2294ede7ba73491d2d
+  data.tar.gz: d1acf48488b95bed0a1d738de3ff883bda3b727b
 SHA512:
-  metadata.gz: f6f59da41828b98e70e5bfbc27805a74efa8c8a8c63481c135dc74726a1792edb102dbc73868b52fbaefe49e3e6e99badea4fbb686c3c34ccf7de2f9bdcf2075
-  data.tar.gz: 44385236b44fcb4b3b928a7cc81fb13ef59168f35bfd538ee7e8834b2cfaf6c773aed7f5e1d052ebf911bfa006989d059f584f001708ee009f173b0f30dcb9c1
+  metadata.gz: 640e370407ffa4f3e777be1891655c25ba56de8a365c693e1fa7c59839fa14146b986099b20bab3968c116a323b57e0a8dab572d9dccc2e1826fd7732c942160
+  data.tar.gz: a9e0e012fb026e52c1715048f64612fa786db77f9ffcb3eb6909759ec38e6466c5c3c8a66ac3b95b3f982fb71fbc61dfb5c9146aa7369ff2daec9a748d80464b

data/README.md

@@ -3,29 +3,30 @@
 **This [gem][EAP] aims at providing useful helpers for command line applications.**
 
 This is a complete rewrite of the initial easy_app_helper gem. **It is not compatible with
-apps designed for easy_app_helper prior to version 1.0.0**, although they could be very easily adapted.
-But anyway you always specify your gem dependencies using the [pessimistic version operator]
-(http://docs.rubygems.org/read/chapter/16#page74), don't you ? Older applications should do it to tell your application
-to use the latest version of the 0.x.x series instead.
+apps designed for easy_app_helper prior to version 1.0.0**, although they could be very easily adapted
+(anyway you always specify your gem dependencies using the [pessimistic version operator]
+(http://docs.rubygems.org/read/chapter/16#page74), don't you ?). Older applications should explicitly
+require to use the latest version of the 0.x.x series instead. The config files themselves remain
+compatible with all versions of **EasyAppHelper**, as they are actually just plain Yaml files...
 
-The new **EasyAppHelper** module prodides:
+The new **EasyAppHelper** module provides:
 
-* A **super charged  Config class** that:
+* A **super charged Config class** that:
  * Manages **multiple sources of configuration**(command line, multiple config files...) in a **layered config**.
- * Provides an **easy to customize merge mechanism** for the different **config layers** that exposes a "live view"
+ * Provides an **easy to customize merge mechanism** for the different **config layers** that renders a "live view"
    of the merged configuration, while keeping a way to access or modify independently any of them.
  * Allows **flexibility** when dealing with modification and provides a way to roll back modifications done to config
    anytime, fully reload it, blast it... Export feature could be very easily added and will probably.
-* A **Logger tightly coupled with the Config** class, that will behave correctly regarding options specified be it from
-  command line or from any source of the config object...
-* Embeds [Slop][slop] to handle **command line parameters** and keeps any parameter defined in a **separated layer of
-  the global config object**.
+* A **Logger tightly coupled with the Config** class, that will behave regarding options specified be it from
+  command line or from any source(layer) of the config object...
+* Embeds [Slop][slop] to handle **command line parameters** and keeps all parameters specified from the command
+  line in a **dedicated layer of the config object**.
 * A mechanism that ensures that as soon as you access any of the objects or methods exposed by EasyAppHelper,
   all of them are **fully configured and ready to be used**.
   
-If you are writing command line applications, I hope you will like because it's very easy to use, and as unobtrusive as
-possible (you choose when you want to include or use as a module) while providing a ready-for-prod config, logger
-and command line management.
+If you are writing command line applications, I hope you will like it because it's very easy to use,
+and as unobtrusive as possible (you choose when you want to include or use as a module) while providing
+a ready-for-prod config, logger and command line management.
 
 
 Currently the only runtime dependency is the cool [Slop gem][slop] which is used to process the command line options.
@@ -157,7 +158,7 @@ EasyAppHelper.logger.puts_and_logs "Hi world... 3 is enough."
 **EasyAppHelper** will look for files in numerous places. **Both Unix and Windows places are handled**.
 All the files are [Yaml][yaml] files but could have names with different extensions.
 
-You can look in the classes documentation to know exactly which extensions and places the config
+You can look in the [classes documentation][doc] to know exactly which extensions and places the config
 files are looked for.
 
 ### System config file
@@ -179,9 +180,9 @@ regarding the rules described above, the framework will for the following files
 
 ### Application config files
 
-An application config file names are determined from the config.script_filename property. This initially contains
-the bare name of the script, but you can replace with whatever you want. Changing this property causes actually
-the impacted files to be reloaded.
+Application config file names are determined from the config.script_filename property. It initially contains
+the bare name of the script(path and extension removed), but you can replace with whatever you want. Changing
+this property causes actually the impacted files to be reloaded.
 
 It is in fact a two level configuration. One is global (the :global layer) and the other is at user level (the
 :user layer).
@@ -339,6 +340,25 @@ I, [2013-06-23T19:39:05.712834 #11768]  INFO -- My super application: Starting s
 
 So far so good...
 
+### Specifying command line parameters
+
+As said, internally **EasyAppHelper** uses the [Slop gem][slop] to handle the command line parameters.
+You can configure the internal Slop object by calling the add_command_line_section method of the config
+object. You could create a method that setup your application command line parameters like this:
+
+```ruby
+  def add_cmd_line_options
+    config.add_command_line_section do |slop|
+      slop.on :u, :useless, 'Stupid option', :argument => false
+      slop.on :anint, 'Stupid option with integer argument', :argument => true, :as => Integer
+    end
+  end
+
+```
+
+See [Slop gem][slop] API documentation for more options.
+
+
 ### Debugging the framework itself
 
 If you want, you can even debug what happens during **EasyAppHelper** initialisation, for this you can use the
@@ -475,5 +495,5 @@ That's all folks.
 [EAP]: https://rubygems.org/gems/easy_app_helper        "**EasyAppHelper** gem"
 [slop]: https://rubygems.org/gems/slop        "Slop gem"
 [yaml]: http://www.yaml.org/    "The Yaml official site"
-[3]: http://rubydoc.info/github/lbriais/easy_app_helper/master/frames        "**EasyAppHelper** documentation"
+[doc]: http://rubydoc.info/github/lbriais/easy_app_helper/master        "**EasyAppHelper** documentation"
 [4]: https://github.com/lbriais/easy_app_helper/wiki          "**EasyAppHelper** wiki"

data/lib/easy_app_helper/core/base.rb

@@ -56,6 +56,12 @@ class EasyAppHelper::Core::Base
     @slop_definition.banner = build_banner
   end
 
+  # helper to add in one command any of the four base properties used
+  # by the logger and the config objects.
+  # @param [String] app_name
+  # @param [String] script_filename
+  # @param [String] app_version
+  # @param [String] app_description
   def describes_application(app_name: nil, script_filename: nil, app_version: nil, app_description: nil)
     self.app_name = app_name unless app_name.nil?
     self.app_version = app_version unless app_version.nil?

data/lib/easy_app_helper/core/config.rb

@@ -17,8 +17,8 @@ require 'yaml'
 # complex rules. First the place where to search them depends on the OS
 # (Provided by {EasyAppHelper::Core::Config::Places}), and then multiple file extensions are
 # tested ({EasyAppHelper::Core::Config::CONFIG_FILE_POSSIBLE_EXTENSIONS}). This is basically
-# performed by the private method {#find_file}. The config specified on command (if any) is loaded the
-# same way.
+# performed by the private method {#find_file}. The config specified on command line (if any)
+# is loaded the same way.
 #
 # == Command line:
 # Any option can be declared as being callable from the command line. Modules add already some
@@ -26,8 +26,8 @@ require 'yaml'
 # {EasyAppHelper::Core::Base#add_command_line_section}).
 #
 # Each of the config sources are kept in a separated "layer" and addressed this way using the
-# #internal_config attribute reader. But of course the config object provides a "merged" config
-# result of the computation of all the sources. See the #to_hash method to see the order for the
+# #internal_configs attribute reader. But of course the config object provides a "merged" config
+# result of the computation of all the sources. See the {#to_hash} method to see the order for the
 # merge.
 # Any option can be accessed or modified directly using the {#[]} and {#[]=} methods.
 # Any change to the global config should be done using the {#[]=} method and is kept in the last separated

data/lib/easy_app_helper/core/logger.rb

@@ -23,7 +23,9 @@ class Logger
   end
 end
 
-# This is the logger that will be used by the application and any class that include {#EasyAppHelper} module.
+# This is the logger that will be used by the application and any class that include {EasyAppHelper} module. It is
+# configured by the {EasyAppHelper::Core::Config Config} object, and provides a temporary logger until the config
+# is fully loaded.
 class EasyAppHelper::Core::Logger < Logger
   include Singleton
 

data/lib/easy_app_helper/version.rb

@@ -6,5 +6,5 @@
 ################################################################################
 
 module EasyAppHelper
-  EASY_APP_HELPER_VERSION = "1.0.0"
+  EASY_APP_HELPER_VERSION = "1.0.1"
 end

data/test/test_app.rb

@@ -40,8 +40,8 @@ class TestApp
 
   def add_cmd_line_options
     config.add_command_line_section do |slop|
-      slop.on :s, :stupid, 'Stupid option', :argument => false
-      slop.on :i, :intarg, 'Stupid option with integer argument', :argument => true, :as => Integer
+      slop.on :u, :useless, 'Stupid option', :argument => false
+      slop.on :anint, 'Stupid option with integer argument', :argument => true, :as => Integer
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-23 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler