easy_app_helper 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc54e601367ad38a97f650c2a3e1459a9a67b2ca
-  data.tar.gz: 47bbac78490b6c347d9bd21e4845c87e023fb8fc
+  metadata.gz: 7ecbc48dfd4704a478842023bb560f06c271bf05
+  data.tar.gz: 903c92b33e0a73983a1be10634fb15c24e506d89
 SHA512:
-  metadata.gz: 4886fb5031204dd4752962ec429f50c86cc8d4a6f81c9791de5303c9a2255ca6f0ce7926405a53ce160b775ba8fc924132d8d3c22354351e212869d6d1cd62ef
-  data.tar.gz: 22e6eea0d5239e883867c5d1c1c0c220b3cef8f5a53b5a55084b3ba137f67139bc65a41c44885ea86b70e71e44aefd9f597c7ed31caf8803a95274ba0eccd69b
+  metadata.gz: cde655e0c910beddfd6708ab94072d766e09094dc0d8d24f0dfe887f56dee45e1277ca5d78321f7385cf6c2270eefc224e091d7fc868a0b251c7ad4dd0d475c9
+  data.tar.gz: 86f57ebfa4d5046977f0e392b43239630e09189f1e79422c13dfae6bfd15abf0f8ee0d6b463cc556c75a8f977e3ccc0dd5ba6035b1de936861c53345551fa570

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rake spec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 TODO: Write your name
+Copyright (c) 2013 L.Briais
 
 MIT License
 

data/README.md

@@ -1,5 +1,8 @@
 # EasyAppHelper
 
+ [![Build Status](https://travis-ci.org/lbriais/easy_app_helper.png?branch=master)](https://travis-ci.org/lbriais/easy_app_helper)
+ [![Gem Version](https://badge.fury.io/rb/easy_app_helper.png)](http://badge.fury.io/rb/easy_app_helper)
+
 **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
@@ -23,7 +26,7 @@ The new **EasyAppHelper** module provides:
   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 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.
@@ -118,7 +121,7 @@ puts config.internal_configs.to_yaml
 #:specific_file:
 #  :content: {}
 
-# You see of course that the two modifications we did are in the modified sub-hash
+# You see of course that the three modifications we did appear actually in the modified sub-hash
 # And now the merged config
 puts config.to_hash
 

data/easy_app_helper.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|rspec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"

data/lib/easy_app_helper/core/base.rb

@@ -86,6 +86,7 @@ class EasyAppHelper::Core::Base
   # Sets the :command_line layer of internal_configs to the computed {#command_line_config}
   def load_config
     internal_configs[:command_line] = {content: command_line_config, source: 'Command line'}
+    self
   end
 
   # Any modification done to the config is in fact stored in the :modified layer of internal_configs
@@ -98,6 +99,7 @@ class EasyAppHelper::Core::Base
   # Reset the :modified layer of internal_configs rolling back any change done to the config
   def reset
     internal_configs[:modified] = {content: {}, source: CHANGED_BY_CODE}
+    self
   end
 
 

data/lib/easy_app_helper/core/config.rb

@@ -42,14 +42,12 @@ require 'easy_app_helper/core/merge_policies'
 
 class EasyAppHelper::Core::Config
   include EasyAppHelper::Core::HashesMergePolicies
-  include EasyAppHelper::Core::Config::Places.get_OS_module
+  include EasyAppHelper::Core::Config::Places.get_os_module
 
   ADMIN_CONFIG_FILENAME = EasyAppHelper.name
 
-
   # Potential extensions a config file can have
   CONFIG_FILE_POSSIBLE_EXTENSIONS = %w(conf yml cfg yaml CFG YML YAML Yaml)
-  ADMIN_CONFIG_FILENAME
 
   # @param [EasyAppHelper::Core::Logger] logger
   # The logger passed to this constructor should be a temporary logger until the full config is loaded.
@@ -85,6 +83,7 @@ class EasyAppHelper::Core::Config
     load_layer_config :global, script_filename, force
     load_layer_config :user, script_filename, force
     load_layer_config :specific_file, internal_configs[:command_line][:content][:'config-file'], force
+    self
   end
 
   # @see #load_config
@@ -117,7 +116,7 @@ class EasyAppHelper::Core::Config
   # @param [Object] key: The key to access the data in the merged_config hash (see {#to_hash})
   # @return [String] Value for this key in the merged config.
   def [](key = nil)
-    key.nil? ? self.to_hash : self.to_hash[key]
+    key.nil? ? to_hash : to_hash[key]
   end
 
 

data/lib/easy_app_helper/core/logger.rb

@@ -12,7 +12,7 @@ require 'singleton'
 # to the definitive one.
 # TODO: Ensure only the messages that are above the current level are displayed when handing over to the definitive logger.
 class Logger
-  def handing_over_to(log)
+  def hand_over_to(log)
     history = []
     history = @logdev.dev.history if @logdev.dev.respond_to? :history
     @logdev.close
@@ -58,11 +58,11 @@ class EasyAppHelper::Core::Logger < Logger
     debug "Merged config:\n#{@config.to_yaml}"
     if config[:debug]
       if config[:'log-file']
-        handing_over_to config[:'log-file']
+        hand_over_to config[:'log-file']
       elsif config[:"debug-on-err"]
-        handing_over_to STDERR
+        hand_over_to STDERR
       else
-        handing_over_to STDOUT
+        hand_over_to STDOUT
       end
     else
       close

data/lib/easy_app_helper/core/places.rb

@@ -32,7 +32,7 @@ class EasyAppHelper::Core::Config::Places
         system: ["#{ENV['systemRoot']}/Config"],
 
         # Where could be stored global configuration
-        global: ['C:/Windows/Config',
+        global: ["#{ENV['systemRoot']}/Config",
                  "#{ENV['ALLUSERSPROFILE']}/Application Data"],
 
         # Where could be stored user configuration
@@ -40,12 +40,13 @@ class EasyAppHelper::Core::Config::Places
     }
   end
 
-  CONF ={
-      mingw32: Windows
+  CONF = {
+      mingw32: Windows,
+      linux: Unix
   }
   DEFAULT = Unix
 
-  def self.get_OS_module
+  def self.get_os_module
     conf = CONF[RbConfig::CONFIG['target_os'].to_sym]
     conf.nil? ? DEFAULT : conf
   end

data/lib/easy_app_helper/version.rb

@@ -6,5 +6,5 @@
 ################################################################################
 
 module EasyAppHelper
-  EASY_APP_HELPER_VERSION = "1.0.4"
+  EASY_APP_HELPER_VERSION = "1.0.5"
 end

data/spec/config_spec.rb

@@ -41,7 +41,7 @@ describe EasyAppHelper.config do
     expect(subject[:stupid_conf]).to eq SAMPLE_STRING
   end
 
-  it 'should be reloaded when :config-file property changes changes' do
+  it 'should be reloaded when :config-file property changes' do
     subject.should_receive(:force_reload)
     subject[:'config-file'] = SAMPLE_STRING
   end
@@ -66,14 +66,14 @@ describe EasyAppHelper.config do
       original_ordered_layers = [:modified, :command_line, :specific_file, :user, :global, :system]
       layers = original_ordered_layers.dup
       original_ordered_layers.each do |layer|
-        test_descr = "should find the data in #{layer} if present in #{layer}"
+        test_descr = "should find the data in #{layer} layer if present in #{layer} layer"
         unless layers.length == original_ordered_layers.length
           already_removed = original_ordered_layers - layers
           if already_removed.length == 1
-            test_descr += " and #{already_removed[0]} level is not specified."
+            test_descr += " and not present in #{already_removed[0]} layer"
           end
           if already_removed.length > 1
-            test_descr += " and #{already_removed.join ', '} levels are not specified."
+            test_descr += " and not present in #{already_removed.join ', '} layers"
           end
         end
 
@@ -125,4 +125,22 @@ describe EasyAppHelper.config do
 
   end
 
+  context "when reloaded (forced)" do
+
+    it "should keep all modifications done the standard way" do
+      subject[:test_remove] = SAMPLE_STRING
+      subject.force_reload
+      expect(subject[:test_remove]).to eq SAMPLE_STRING
+    end
+
+    it "should remove all modifications directly done on internal layers" do
+      subject.internal_configs[:system][:content][:stupid_conf] = SAMPLE_STRING
+      subject.internal_configs[:command_line][:content][:stupid_conf] = SAMPLE_STRING
+      subject.force_reload
+      expect(subject.internal_configs[:system][:content][:stupid_conf]).to be_nil
+      expect(subject.internal_configs[:command_line][:content][:stupid_conf]).to be_nil
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-07 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -134,6 +135,8 @@ specification_version: 4
 summary: Provides cool helpers to your application, including configuration and logging
   features
 test_files:
+- spec/config_spec.rb
+- spec/logger_spec.rb
 - test/test.yml
 - test/test2_app.rb
 - test/test3_app.rb