easy_app_helper 1.0.3 → 1.0.4

data/lib/easy_app_helper/version.rb

@@ -1,10 +1,10 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-module EasyAppHelper
-  EASY_APP_HELPER_VERSION = "1.0.3"
-end
+################################################################################
+# EasyAppHelper 
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+module EasyAppHelper
+  EASY_APP_HELPER_VERSION = "1.0.4"
+end

data/spec/config_spec.rb

@@ -0,0 +1,128 @@
+#-------------------------------------------------------------------------------
+#  
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+#-------------------------------------------------------------------------------
+
+require 'rspec'
+require 'easy_app_helper'
+
+
+#describe EasyAppHelper::Core::Config do
+describe EasyAppHelper.config do
+  SAMPLE_STRING = 'Sample String'
+
+
+  it 'should be fully initialized when first accessed' do
+    subject.should_not be nil
+    subject.logger.should_not be nil
+  end
+
+  it 'should be consistent regarding the way it is accessed' do
+    subject[:basic_test] = SAMPLE_STRING
+    expect(subject[]).to eq subject.to_hash
+    expect(subject[:basic_test]).to eq SAMPLE_STRING
+  end
+
+
+  it 'should be the same object accross different instances' do
+    expect(subject[:basic_test]).to eq SAMPLE_STRING
+  end
+
+  it 'should store the data in the :modified layer' do
+    expect(subject.find_layer :basic_test).to eq :modified
+    expect(subject.internal_configs[:modified][:content][:basic_test]).to eq subject[:basic_test]
+
+  end
+
+  it 'should provide a direct r/w access to layers' do
+    subject.internal_configs[:system][:content][:stupid_conf] = SAMPLE_STRING
+    expect(subject[:stupid_conf]).to eq SAMPLE_STRING
+  end
+
+  it 'should be reloaded when :config-file property changes changes' do
+    subject.should_receive(:force_reload)
+    subject[:'config-file'] = SAMPLE_STRING
+  end
+
+  it 'should be reloaded when script_filename changes' do
+    subject.should_receive(:force_reload)
+    subject.script_filename = SAMPLE_STRING
+  end
+
+
+  describe 'should override data when present in multiple layers' do
+    before(:all) do
+      EasyAppHelper.config.layers.each do |layer|
+        EasyAppHelper.config.internal_configs[layer][:content][:basic_test] = "#{SAMPLE_STRING} #{layer.to_s}"
+      end
+      EasyAppHelper.config.internal_configs[:command_line][:content][:'config-file'] = true
+    end
+
+    context "when requesting some data" do
+      let(:layers) {[:modified, :command_line, :specific_file, :user, :global, :system]}
+
+      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}"
+        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."
+          end
+          if already_removed.length > 1
+            test_descr += " and #{already_removed.join ', '} levels are not specified."
+          end
+        end
+
+        it test_descr, layers: layers.dup  do
+          layers = example.metadata[:layers]
+          expect(subject.find_layer :basic_test).to eq layer
+          expect(subject[:basic_test]).to eq "#{SAMPLE_STRING} #{layer.to_s}"
+          subject.internal_configs[layer][:content].delete :basic_test
+        end
+
+        layers.shift
+
+      end
+    end
+
+  end
+
+  context "when reset" do
+
+    it "should remove all modifications done the standard way" do
+      subject[:test_remove] = SAMPLE_STRING
+      subject.reset
+      expect(subject[:test_remove]).to be_nil
+    end
+
+    it "should keep modifications directly done on internal layers" do
+      subject.internal_configs[:system][:content][:stupid_conf] = SAMPLE_STRING
+      subject.reset
+      expect(subject.internal_configs[:system][:content][:stupid_conf]).to eq SAMPLE_STRING
+    end
+
+  end
+
+  context "when reloaded" do
+
+    it "should keep all modifications done the standard way" do
+      subject[:test_remove] = SAMPLE_STRING
+      subject.load_config
+      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.load_config
+      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

data/spec/logger_spec.rb

@@ -0,0 +1,33 @@
+#-------------------------------------------------------------------------------
+#  
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+#-------------------------------------------------------------------------------
+
+require 'rspec'
+require 'easy_app_helper'
+
+
+#describe EasyAppHelper::Core::Logger
+describe EasyAppHelper.logger do
+  let (:config) {EasyAppHelper.config}
+
+  context "to modify the log level" do
+
+    it 'should be ok to use the config object' do
+      Logger::Severity::DEBUG.upto(Logger::Severity::UNKNOWN) do |severity|
+        config[:'log-level'] = severity
+        expect(subject.level).to eq severity
+      end
+    end
+
+    it 'should be ok to use the #log_level= method' do
+      Logger::Severity::DEBUG.upto(Logger::Severity::UNKNOWN) do |severity|
+        subject.level= severity
+        expect(config[:'log-level']).to eq severity
+      end
+    end
+  end
+
+end

data/test/test.yml

@@ -1,7 +1,7 @@
-stupid_config: true
-
-pipo: bimbo
-
-hash_example:
-  first: one
-  second: two
+stupid_config: true
+
+pipo: bimbo
+
+hash_example:
+  first: one
+  second: two

data/test/test2_app.rb

@@ -1,33 +1,33 @@
-#!/usr/bin/env ruby
-
-
-require 'easy_app_helper'
-
-
-# EasyAppHelper.logger.level = 0
-EasyAppHelper.puts_and_logs "Groovy baby !"
-EasyAppHelper.config[:zboubi] = "Hi shared"
-
-class A
-  include EasyAppHelper
-
-  def echo
-    puts_and_logs config[:zboubi]
-  end
-end
-
-A.new.echo
-EasyAppHelper.puts_and_logs EasyAppHelper.config[:zboubi]
-
-include EasyAppHelper
-puts_and_logs "ZBOUBI: #{config[:zboubi]}"
-config.reset
-puts_and_logs "ZBOUBI2: #{config[:zboubi]}"
-
-puts config.to_yaml
-config.script_filename = 'batch_audio_convert'
-puts 'Internal configs'
-puts config.internal_configs.to_yaml
-puts 'Resulting config'
-puts config.to_yaml
-
+#!/usr/bin/env ruby
+
+
+require 'easy_app_helper'
+
+
+# EasyAppHelper.logger.level = 0
+EasyAppHelper.puts_and_logs "Groovy baby !"
+EasyAppHelper.config[:zboubi] = "Hi shared"
+
+class A
+  include EasyAppHelper
+
+  def echo
+    puts_and_logs config[:zboubi]
+  end
+end
+
+A.new.echo
+EasyAppHelper.puts_and_logs EasyAppHelper.config[:zboubi]
+
+include EasyAppHelper
+puts_and_logs "ZBOUBI: #{config[:zboubi]}"
+config.reset
+puts_and_logs "ZBOUBI2: #{config[:zboubi]}"
+
+puts config.to_yaml
+config.script_filename = 'batch_audio_convert'
+puts 'Internal configs'
+puts config.internal_configs.to_yaml
+puts 'Resulting config'
+puts config.to_yaml
+

data/test/test3_app.rb

@@ -1,90 +1,90 @@
-#!/usr/bin/env ruby
-
-require 'easy_app_helper'
-
-# You can directly access the config or the logger through the EasyAppHelper module
-puts "The application verbose flag is #{EasyAppHelper.config[:verbose]}"
-
-# You can directly use the logger according to the command line flags
-# This will do nothing unless --debug is set and --log-level is set to the correct level
-EasyAppHelper.logger.info "Hi guys!"
-
-# Fed up with the EasyAppHelper prefix ? Just include the module where you want
-include EasyAppHelper
-
-# You can override programmatically any part of the config
-config[:debug] = true
-logger.level = 1
-config[:test] = 'Groovy'
-EasyAppHelper.logger.info "Hi guys!... again"
-
-# You can see the internals of the config
-puts config.internal_configs.to_yaml
-# Which will output
-#:modified:
-#  :content:
-#    :log-level: 1
-#    :debug: true
-#    :test: cool
-#  :source: Changed by code
-#:command_line:
-#  :content:
-#    :auto:
-#    :simulate:
-#    :verbose: true
-#    :help:
-#    :config-file:
-#    :config-override:
-#    :debug:
-#    :debug-on-err:
-#    :log-level:
-#    :log-file:
-#  :source: Command line
-#:system:
-#  :content: {}
-#  :source:
-#  :origin: EasyAppHelper
-#:global:
-#  :content: {}
-#  :source:
-#  :origin: ''
-#:user:
-#  :content: {}
-#  :source:
-#  :origin: ''
-#:specific_file:
-#  :content: {}
-
-# You see of course that the two modifications we did are in the modified sub-hash
-# And now the merged config
-puts config.to_hash
-
-# But you can see the modified part as it is:
-puts config.internal_configs[:modified]
-
-# Of course you can access it from any class
-class Dummy
-  include EasyAppHelper
-
-  def initialize
-    puts "#{config[:test]} baby !"
-    # Back to the original
-    config.reset
-    puts config.internal_configs[:modified]
-  end
-end
-
-Dummy.new
-
-# Some methods are provided to ease common tasks. For example this one will log at info level
-# (so only displayed if debug mode and log level low enough), but will also puts on the console
-# if verbose if set...
-puts_and_logs "Hi world"
-
-# It is actually one of the few methods added to regular Logger class (The added value of this logger
-# is much more to be tightly coupled with the config object). Thus could access it like that:
-logger.puts_and_logs "Hi world"
-
-# or even
-EasyAppHelper.logger.puts_and_logs "Hi world... 3 is enough."
-
+#!/usr/bin/env ruby
+
+require 'easy_app_helper'
+
+# You can directly access the config or the logger through the EasyAppHelper module
+puts "The application verbose flag is #{EasyAppHelper.config[:verbose]}"
+
+# You can directly use the logger according to the command line flags
+# This will do nothing unless --debug is set and --log-level is set to the correct level
+EasyAppHelper.logger.info "Hi guys!"
+
+# Fed up with the EasyAppHelper prefix ? Just include the module where you want
+include EasyAppHelper
+
+# You can override programmatically any part of the config
+config[:debug] = true
+logger.level = 1
+config[:test] = 'Groovy'
+EasyAppHelper.logger.info "Hi guys!... again"
+
+# You can see the internals of the config
+puts config.internal_configs.to_yaml
+# Which will output
+#:modified:
+#  :content:
+#    :log-level: 1
+#    :debug: true
+#    :test: cool
+#  :source: Changed by code
+#:command_line:
+#  :content:
+#    :auto:
+#    :simulate:
+#    :verbose: true
+#    :help:
+#    :config-file:
+#    :config-override:
+#    :debug:
+#    :debug-on-err:
+#    :log-level:
+#    :log-file:
+#  :source: Command line
+#:system:
+#  :content: {}
+#  :source:
+#  :origin: EasyAppHelper
+#:global:
+#  :content: {}
+#  :source:
+#  :origin: ''
+#:user:
+#  :content: {}
+#  :source:
+#  :origin: ''
+#:specific_file:
+#  :content: {}
+
+# You see of course that the two modifications we did are in the modified sub-hash
+# And now the merged config
+puts config.to_hash
+
+# But you can see the modified part as it is:
+puts config.internal_configs[:modified]
+
+# Of course you can access it from any class
+class Dummy
+  include EasyAppHelper
+
+  def initialize
+    puts "#{config[:test]} baby !"
+    # Back to the original
+    config.reset
+    puts config.internal_configs[:modified]
+  end
+end
+
+Dummy.new
+
+# Some methods are provided to ease common tasks. For example this one will log at info level
+# (so only displayed if debug mode and log level low enough), but will also puts on the console
+# if verbose if set...
+puts_and_logs "Hi world"
+
+# It is actually one of the few methods added to regular Logger class (The added value of this logger
+# is much more to be tightly coupled with the config object). Thus could access it like that:
+logger.puts_and_logs "Hi world"
+
+# or even
+EasyAppHelper.logger.puts_and_logs "Hi world... 3 is enough."
+

data/test/test4_app.rb

@@ -1,36 +1,36 @@
-#!/usr/bin/env ruby
-
-require 'easy_app_helper'
-
-class MyApp
-  include EasyAppHelper
-
-  APP_NAME = "My super application"
-  # SCRIPT_NAME = File.basename($0, '.*')
-  VERSION = '0.0.1'
-  DESCRIPTION = 'This application is a proof of concept for EasyAppHelper.'
-
-
-  def initialize
-    # Providing this data is optional
-    config.describes_application(app_name: APP_NAME, app_version: VERSION, app_description: DESCRIPTION)
-  end
-
-
-  def run
-    if config[:help]
-      puts config.help
-      exit 0
-    end
-    puts_and_logs "Application is starting"
-    do_some_processing
-  end
-
-  def do_some_processing
-    puts_and_logs "Starting some heavy processing"
-  end
-
-end
-
-
+#!/usr/bin/env ruby
+
+require 'easy_app_helper'
+
+class MyApp
+  include EasyAppHelper
+
+  APP_NAME = "My super application"
+  # SCRIPT_NAME = File.basename($0, '.*')
+  VERSION = '0.0.1'
+  DESCRIPTION = 'This application is a proof of concept for EasyAppHelper.'
+
+
+  def initialize
+    # Providing this data is optional
+    config.describes_application(app_name: APP_NAME, app_version: VERSION, app_description: DESCRIPTION)
+  end
+
+
+  def run
+    if config[:help]
+      puts config.help
+      exit 0
+    end
+    puts_and_logs "Application is starting"
+    do_some_processing
+  end
+
+  def do_some_processing
+    puts_and_logs "Starting some heavy processing"
+  end
+
+end
+
+
 MyApp.new.run