easy_app_helper 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 030db560ddded5c43b3a7a05d0c50b93a701063c
-  data.tar.gz: 99d2e5c614f4837aa5057f7f429b01eb51956f84
+  metadata.gz: 50d87ed053be2fd95061ffa2437b85d54624733d
+  data.tar.gz: 49c874b9d20f77fbd39dd0b1e85dfe3ac6b59dd5
 SHA512:
-  metadata.gz: aa9f1af598819d3ccfbc442728ae981d67a37b52aa6a562094566dc2797e865badea91628e6671ebdde0ab7f56c3a5ec7e1719261f9c92272300acd12ff7022d
-  data.tar.gz: 17d17a90a5be2f62125556cc283d719be7e583bda0980c72215022aeb376aee8105496cd12543c9b5ceac92d1ab96f65d02535fddd617f031364580cae466de8
+  metadata.gz: 07a81b4154ce7c2325d64b7d471063e458fca4d14e161fa97ad612523dad0475b85dbb3d7e5988ce3136d6cacaea3b09c860bb81ef87daf67d480d121201b72d
+  data.tar.gz: 2b2d0d30cd08aa7d3e6a1d847734d2c60937b653d39f5498289e8e98dc9a07a0768bfd84066f205b996699126b5c70ba0d8c68cfb955e6dab6456e34f5e943bc

data/README.md

@@ -1,9 +1,10 @@
 # EasyAppHelper
 
-This gem provides a suite of helpers for command line applications.
-The goal is to be as transparent as possible for application whilst providing consistent helpers that add dedidacted behaviours to your application.
 
-Currently the only dependency is on "slop" (https://rubygems.org/gems/slop).
+This [gem] [1] provides a suite of helpers for command line applications.
+The goal is to be as transparent as possible for the application whilst providing consistent helpers that add dedidacted behaviours to your application.
+
+Currently the only runtime dependency is on the [Slop gem] [2].
 
 
 
@@ -25,28 +26,59 @@ Or install it yourself as:
 
 To benefit from the different helpers. Once you installed the gem, the only thing you need to do is:
 
+```ruby
 require 'easy_app_helper'
+```
 
 and then in the "main class" of your application, include the modules you want to use and call init_app_helper in the initialize method. Then what you can do with each 
 module is defined by each module.
 
-The basic behaviour (when you include EasyAppHelper), actually adds basic command line handling (actually handled by slop), and provides the mechanism to enable you
-to add any other EasyAppHelper module.
+The basic behaviour (when you include EasyAppHelper), actually adds basic command line handling (actually handled by slop), and provides the mechanism to enable you to add any other EasyAppHelper module.
 
 ex:
 
+```ruby
 require 'easy_app_helper'
 
 class MyApp
-      include EasyAppHelper
+ 	include EasyAppHelper
+	def initialize
+		init_app_helper "my_app"
+	end
+end
+```
+
+This basically does... nothing. I mean the only behaviour it adds to your application is the ability to pass --help to the application to see the inline help (that it builds). On top of this you then have access to some other command line options like --auto, --simulate, --verbose, but for those it is up to your application to check their value using the app_config attribute which is available in your MyApp instance.
+
+You could then do something like:
 
-      def initialize
-      	  init_app_helper "my_app"
-      end
+```ruby
+require 'easy_app_helper'
+
+class MyApp
+ 	include EasyAppHelper
+	def initialize
+		"my_app" init_app_helper "my_app", "My Super Application", "This is the application everybody was waiting for.", "v 1.0"
+		if app_config[:verbose]
+			 puts "Waouh, hello World !!"
+		end
+	end
 end
+```
 
-This basically does... nothing.
+You can actually access any field from your application configuration through the app_config attribute.
 
+### Other modules
+Some other modules are provided:
+
+* EasyAppHelper::Logger	provides logging facilities and config line options including log-level, log-file etc...
+* EasyAppHelper::Config provides easy YAML based configuration to your script with multiple level of override (admin wide -> system wide -> user -> command line options -> --config-file). All the configuration being accessible through the app_config hash attribute
+
+See [classes documentation] [3] for more information.
+
+### Debugging
+
+If you want to debug what happens during the framework instanciation, you can use the DEBUG_EASY_MODULES environment variable.
 
 ## Contributing
 
@@ -55,3 +87,8 @@ This basically does... nothing.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+[1]: https://rubygems.org/gems/easy_app_helper        "EasyAppHelper gem"
+[2]: https://rubygems.org/gems/slop        "Slop gem"
+[3]: http://rubydoc.info/github/lbriais/easy_app_helper/master/frames        "EasyAppHelper documentation"

data/easy_app_helper.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = EasyAppHelper::VERSION
   spec.authors       = ["L.Briais"]
   spec.email         = ["lbnetid+rb@gmail.com"]
-  spec.description   = %q{Desktop application framework}
-  spec.summary       = %q{Provides cool helpers to your desktop application, including configuration and logging features}
-  spec.homepage      = ""
+  spec.description   = %q{Easy Application Helpers framework}
+  spec.summary       = %q{Provides cool helpers to your application, including configuration and logging features}
+  spec.homepage      = "https://github.com/lbriais/easy_app_helper"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
 

data/lib/easy_app_helper/version.rb

@@ -6,5 +6,5 @@
 ################################################################################
 
 module EasyAppHelper
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - L.Briais
@@ -14,16 +14,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Desktop application framework
+description: Easy Application Helpers framework
 email:
 - lbnetid+rb@gmail.com
 executables: []
@@ -85,7 +85,7 @@ files:
 - lib/easy_app_helper/config.rb
 - lib/easy_app_helper/logger.rb
 - lib/easy_app_helper/version.rb
-homepage: ''
+homepage: https://github.com/lbriais/easy_app_helper
 licenses:
 - MIT
 metadata: {}
@@ -108,6 +108,6 @@ rubyforge_project:
 rubygems_version: 2.0.0.rc.2
 signing_key: 
 specification_version: 4
-summary: Provides cool helpers to your desktop application, including configuration
-  and logging features
+summary: Provides cool helpers to your application, including configuration and logging
+  features
 test_files: []