easy_app_helper 1.0.8 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b48b1a40cca25e007c8c9482b38bcc1ba7745c80
-  data.tar.gz: 5292526ca66ed1672d56a6263f3508b6d95c4b04
+  metadata.gz: 70bf9f13848d8863f18d949d02b4c741fceb8185
+  data.tar.gz: c49ba93f589254ee9ce4a6e539fd02dacb6102d1
 SHA512:
-  metadata.gz: 065768a14395a003b9af518d290331a55d70de2ee48e99ad10f9d74618da61a45b5f9e3487911f32662510f660c82636114dc9aa556ccb814427d008d51c75d1
-  data.tar.gz: ad52ae962932ecf91632c86c94bb8ae20c5e415ffd0ee798e3b11e3dda434aa5ba5daba2f1569945fa5fb1f287695ad1764e85a6363db13d2185bd25df21a80a
+  metadata.gz: c4ea7b8676fa7bf3ad627cf99b3bcfe38c45c32c787c8d0d26e65c90076919ce7670af4526b42328d3eac58c0fe465d0a918b9462d661761d86b67c929aaba3d
+  data.tar.gz: 8b6c6ab66f91bed56ecf62f0e091aff5c37b99b283f1abb67c904b446134d533c3c03b695e95be54eaf26378e8c564992ecdb128322161e17fa4628d234688d2

data/README.md

@@ -7,8 +7,8 @@
 
 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
-(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
+(anyway you always specify your gem dependencies using [semantic versioning](http://semver.org/) and the [pessimistic version operator]
+(http://robots.thoughtbot.com/post/2508037841/rubys-pessimistic-operator), don't you ? More info [here](http://guides.rubygems.org/patterns/#declaring_dependencies)). 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...
 
@@ -34,7 +34,7 @@ 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.
 
-[Why this gem][4] ?
+[Why this gem][wiki] ?
 
 
 
@@ -63,7 +63,7 @@ To use it, once you installed them, you just need to require it:
 require 'easy_app_helper'
 ```
 
-Then can can immediately access the logger or the config objects. Here under a first example:
+Then you can immediately access the logger or the config objects. Here under a first example:
 
 ```ruby
 require 'easy_app_helper'
@@ -110,6 +110,10 @@ puts config.internal_configs.to_yaml
 #  :content: {}
 #  :source:
 #  :origin: EasyAppHelper
+#:internal:
+#  :content: {}
+#  :source:
+#  :origin: ''
 #:global:
 #  :content: {}
 #  :source:
@@ -183,7 +187,8 @@ regarding the rules described above, the framework will for the following files
 
 ### Internal config file
 
-This is an internal config file for the Gem itself. It will be located in the etc directory **inside** the Gem.
+This is an internal config file for the Gem itself. It will be located in the ```etc/``` or ```config/``` directory **inside** the Gem.
+It is a way for a Gem to define a system default configuration.
 
 ```text
 # The :internal layer
@@ -195,6 +200,14 @@ etc/myscript.CFG
 etc/myscript.YML
 etc/myscript.YAML
 etc/myscript.Yaml
+config/myscript.conf
+config/myscript.yml
+config/myscript.cfg
+config/myscript.yaml
+config/myscript.CFG
+config/myscript.YML
+config/myscript.YAML
+config/myscript.Yaml
 ```
 
 
@@ -393,6 +406,15 @@ D, [2013-06-23T19:43:47.977031 #16294] DEBUG -- : Temporary initialisation logge
 D, [2013-06-23T19:43:47.977861 #16294] DEBUG -- : Trying "/etc/EasyAppHelper.conf" as config file.
 D, [2013-06-23T19:43:47.977908 #16294] DEBUG -- : Trying "/etc/EasyAppHelper.yml" as config file.
 D, [2013-06-23T19:43:47.977938 #16294] DEBUG -- : Loading config file "/etc/EasyAppHelper.cfg"
+D, [2013-06-23T19:43:47.977961 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.conf" as config file.
+D, [2013-06-23T19:43:47.977982 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.yml" as config file.
+D, [2013-06-23T19:43:47.977995 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.cfg" as config file.
+D, [2013-06-23T19:43:47.978032 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.yaml" as config file.
+D, [2013-06-23T19:43:47.978082 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.CFG" as config file.
+D, [2013-06-23T19:43:47.978119 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.YML" as config file.
+D, [2013-06-23T19:43:47.978163 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.YAML" as config file.
+D, [2013-06-23T19:43:47.978206 #16294] DEBUG -- : Trying "/home/laurent/devel/ruby/gems/test4_app/etc/test4_app.Yaml" as config file.
+I, [2013-06-23T19:43:47.978255 #16294]  INFO -- : No config file found for layer internal.
 D, [2013-06-23T19:43:47.978300 #16294] DEBUG -- : Trying "/etc/test4_app.conf" as config file.
 D, [2013-06-23T19:43:47.978332 #16294] DEBUG -- : Trying "/etc/test4_app.yml" as config file.
 D, [2013-06-23T19:43:47.978355 #16294] DEBUG -- : Trying "/etc/test4_app.cfg" as config file.
@@ -516,8 +538,8 @@ did eventually end-up in the same log...
 That's all folks.
 
 
-[EAP]: https://rubygems.org/gems/easy_app_helper        "**EasyAppHelper** gem"
+[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"
-[doc]: http://rubydoc.info/github/lbriais/easy_app_helper/master        "**EasyAppHelper** documentation"
-[4]: https://github.com/lbriais/easy_app_helper/wiki          "**EasyAppHelper** wiki"
+[doc]: http://rubydoc.info/github/lbriais/easy_app_helper/master        "EasyAppHelper documentation"
+[wiki]: https://github.com/lbriais/easy_app_helper/wiki          "EasyAppHelper wiki"

data/easy_app_helper.gemspec

@@ -4,24 +4,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'easy_app_helper/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "easy_app_helper"
+  spec.name          = 'easy_app_helper'
   spec.version       = EasyAppHelper::EASY_APP_HELPER_VERSION
-  spec.authors       = ["L.Briais"]
-  spec.email         = ["lbnetid+rb@gmail.com"]
+  spec.authors       = ['L.Briais']
+  spec.email         = ['lbnetid+rb@gmail.com']
   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.homepage      = 'https://github.com/lbriais/easy_app_helper'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/).delete_if { |file| file =~ /^(bin|\.)/ or file =~ /test\d*_app\.rb$/ }
   # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features|etc)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rspec', '~> 2.0'
 
-  spec.add_runtime_dependency "slop"
+  spec.add_runtime_dependency 'slop'
 end

data/lib/easy_app_helper/core/places.rb

@@ -5,14 +5,16 @@
 # http://opensource.org/licenses/MIT
 ################################################################################
 
-# Possible places regarding the OS
+# The goal of this class is to return a module containing the POSSIBLE_PLACES hash
+# that provides a list of OS dependant paths.
+# The only method that should be used is the #get_os_module method that returns this module.
 # TODO: Add equivalent for Mac
 class EasyAppHelper::Core::Config::Places
 
   module Helper
 
     def get_internal_config_place
-      File.expand_path('../../etc', $PROGRAM_NAME)
+      [File.expand_path('../../etc', $PROGRAM_NAME), File.expand_path('../../config', $PROGRAM_NAME)]
     end
 
     def possible_config_places key
@@ -22,34 +24,33 @@ class EasyAppHelper::Core::Config::Places
   end
 
 
+  # Defines some places for Unix machines
   module Unix
-    # Where could be stored admin configuration that rules all EasyAppHelper
-    # based applications.
+
     extend Helper
 
     POSSIBLE_PLACES = {
 
-        internal: ["#{self.get_internal_config_place}"],
+        internal: self.get_internal_config_place,
 
-        system: ["/etc"],
+        system: ['/etc'],
 
         # Where could be stored global wide configuration
-        global: ["/etc",
-                 "/usr/local/etc"],
+        global: ['/etc',
+                 '/usr/local/etc'],
 
         # Where could be stored user configuration
         user:  ["#{ENV['HOME']}/.config"]
     }
   end
 
+  # Defines some places for Windows machines
   module Windows
-    # Where could be stored admin configuration that rules all EasyAppHelper
-    # based applications.
     extend Helper
 
     POSSIBLE_PLACES = {
 
-        internal: ["#{self.get_internal_config_place}"],
+        internal: self.get_internal_config_place,
 
         system: ["#{ENV['systemRoot']}/Config"],
 

data/lib/easy_app_helper/version.rb

@@ -6,5 +6,5 @@
 ################################################################################
 
 module EasyAppHelper
-  EASY_APP_HELPER_VERSION = "1.0.8"
+  EASY_APP_HELPER_VERSION = "1.0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.10
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-28 00:00:00.000000000 Z
+date: 2014-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0.rc.2
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Provides cool helpers to your application, including configuration and logging
@@ -134,4 +134,3 @@ test_files:
 - spec/config_spec.rb
 - spec/logger_spec.rb
 - test/test.yml
-has_rdoc: