easy_app_helper 1.0.2 → 1.0.3

data/lib/easy_app_helper/core/merge_policies.rb

@@ -1,37 +1,37 @@
-################################################################################
-# EasyAppHelper
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-# This module proposes different merge policies for two hashes.
-module EasyAppHelper::Core::HashesMergePolicies
-
-  # Performs a merge at the second level of hashes.
-  # simple entries and arrays are overridden.
-  def hashes_second_level_merge(h1, h2)
-    h2.each do |key, v|
-      if h1[key] and h1[key].is_a?(Hash)
-        # Merges hashes
-        h1[key].merge! h2[key]
-      else
-        # Overrides the rest
-        h1[key] = h2[key] unless h2[key].nil?
-      end
-    end
-    h1
-  end
-
-  # Uses the standard "merge!" method
-  def simple_merge(h1, h2)
-    h1.merge! h2
-  end
-
-  # Brutal override
-  def override_merge(h1, h2)
-    h1 = nil
-    h1 = h2
-
-  end
-end
+################################################################################
+# EasyAppHelper
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+# This module proposes different merge policies for two hashes.
+module EasyAppHelper::Core::HashesMergePolicies
+
+  # Performs a merge at the second level of hashes.
+  # simple entries and arrays are overridden.
+  def hashes_second_level_merge(h1, h2)
+    h2.each do |key, v|
+      if h1[key] and h1[key].is_a?(Hash)
+        # Merges hashes
+        h1[key].merge! h2[key]
+      else
+        # Overrides the rest
+        h1[key] = h2[key] unless h2[key].nil?
+      end
+    end
+    h1
+  end
+
+  # Uses the standard "merge!" method
+  def simple_merge(h1, h2)
+    h1.merge! h2
+  end
+
+  # Brutal override
+  def override_merge(h1, h2)
+    h1 = nil
+    h1 = h2
+
+  end
+end

data/lib/easy_app_helper/core/places.rb

@@ -1,52 +1,52 @@
-################################################################################
-# EasyAppHelper
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-# Possible places regarding the OS
-# TODO: Add equivalent for Mac
-class EasyAppHelper::Core::Config::Places
-  module Unix
-    # Where could be stored admin configuration that rules all EasyAppHelper
-    # based applications.
-    POSSIBLE_PLACES = {
-
-        system: ["/etc"],
-
-        # Where could be stored global wide configuration
-        global: ["/etc",
-                 "/usr/local/etc"],
-
-        # Where could be stored user configuration
-        user:  ["#{ENV['HOME']}/.config"]
-    }
-  end
-
-  module Windows
-    # Where could be stored admin configuration that rules all EasyAppHelper
-    # based applications.
-    POSSIBLE_PLACES = {
-
-        system: ["#{ENV['systemRoot']}/Config"],
-
-        # Where could be stored global configuration
-        global: ['C:/Windows/Config',
-                 "#{ENV['ALLUSERSPROFILE']}/Application Data"],
-
-        # Where could be stored user configuration
-        user: [ENV['APPDATA']]
-    }
-  end
-
-  CONF ={
-      mingw32: Windows
-  }
-  DEFAULT = Unix
-
-  def self.get_OS_module
-    conf = CONF[RbConfig::CONFIG['target_os'].to_sym]
-    conf.nil? ? DEFAULT : conf
-  end
+################################################################################
+# EasyAppHelper
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+# Possible places regarding the OS
+# TODO: Add equivalent for Mac
+class EasyAppHelper::Core::Config::Places
+  module Unix
+    # Where could be stored admin configuration that rules all EasyAppHelper
+    # based applications.
+    POSSIBLE_PLACES = {
+
+        system: ["/etc"],
+
+        # Where could be stored global wide configuration
+        global: ["/etc",
+                 "/usr/local/etc"],
+
+        # Where could be stored user configuration
+        user:  ["#{ENV['HOME']}/.config"]
+    }
+  end
+
+  module Windows
+    # Where could be stored admin configuration that rules all EasyAppHelper
+    # based applications.
+    POSSIBLE_PLACES = {
+
+        system: ["#{ENV['systemRoot']}/Config"],
+
+        # Where could be stored global configuration
+        global: ['C:/Windows/Config',
+                 "#{ENV['ALLUSERSPROFILE']}/Application Data"],
+
+        # Where could be stored user configuration
+        user: [ENV['APPDATA']]
+    }
+  end
+
+  CONF ={
+      mingw32: Windows
+  }
+  DEFAULT = Unix
+
+  def self.get_OS_module
+    conf = CONF[RbConfig::CONFIG['target_os'].to_sym]
+    conf.nil? ? DEFAULT : conf
+  end
 end

data/lib/easy_app_helper/module_manager.rb

@@ -1,61 +1,68 @@
-################################################################################
-# EasyAppHelper
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-module EasyAppHelper::Core
-
-end
-
-require 'easy_app_helper/core/logger'
-require 'easy_app_helper/core/base'
-require 'easy_app_helper/core/config'
-
-# This module contains the exposed methods of the framework
-# It is included and extended into EasyAppHelper
-module EasyAppHelper::ModuleManager
-
-  # @return [EasyAppHelper::Core::Logger] The application logger
-  def logger
-    @@logger
-  end
-
-  # @return [EasyAppHelper::Core::Config] The application config
-  def config
-    @@config
-  end
-
-  # Convenient method that logs at info level, but also outputs the message to STDOUT if
-  # verbose is set in the config.
-  # @param [String] msg to be displayed
-  def puts_and_logs(msg)
-    @@logger.puts_and_logs msg
-  end
-
-  def self.included(base)
-    init_core_modules
-    base.extend self
-  end
-
-  ################################################################################
-  private
-
-  def self.init_logger
-    @@logger ||= EasyAppHelper::Core::Logger.instance
-    @@logger
-  end
-
-  def self.init_config
-    @@config ||= EasyAppHelper::Core::Config.new @@logger
-    @@logger.set_app_config(@@config)
-    @@config
-  end
-
-  def self.init_core_modules
-    init_logger
-    init_config
-  end
-
+################################################################################
+# EasyAppHelper
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+module EasyAppHelper::Core
+
+end
+
+require 'easy_app_helper/core/logger'
+require 'easy_app_helper/core/base'
+require 'easy_app_helper/core/config'
+
+# This module contains the exposed methods of the framework
+# It is included and extended into EasyAppHelper
+module EasyAppHelper::ModuleManager
+
+  # @return [EasyAppHelper::Core::Logger] The application logger
+  def logger
+    @@logger
+  end
+
+  # @return [EasyAppHelper::Core::Config] The application config
+  def config
+    @@config
+  end
+
+  # Convenient method that logs at info level, but also outputs the message to STDOUT if
+  # verbose is set in the config.
+  # @param [String] msg to be displayed
+  def puts_and_logs(msg)
+    @@logger.puts_and_logs msg
+  end
+
+  # Method to do something (expects a block) unless --simulate is specified on the command line.
+  # See {EasyAppHelper::Core::Base#safely_exec original implementation}.
+  def safely_exec(message, *args, &block)
+    @@config.safely_exec message, *args, &block
+  end
+
+
+  def self.included(base)
+    init_core_modules
+    base.extend self
+  end
+
+  ################################################################################
+  private
+
+  def self.init_logger
+    @@logger ||= EasyAppHelper::Core::Logger.instance
+    @@logger
+  end
+
+  def self.init_config
+    @@config ||= EasyAppHelper::Core::Config.new @@logger
+    @@logger.set_app_config(@@config)
+    @@config
+  end
+
+  def self.init_core_modules
+    init_logger
+    init_config
+  end
+
 end

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.2"
-end
+################################################################################
+# EasyAppHelper 
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+module EasyAppHelper
+  EASY_APP_HELPER_VERSION = "1.0.3"
+end

data/lib/easy_app_helper.rb

@@ -1,20 +1,20 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-require 'easy_app_helper/version'
-
-# When this module is included in any class, it mixes in automatically
-# EasyAppHelper::ModuleManager methods both into the
-# instance and the class of the instance that includes it.
-# Thus to have access to the helper methods, the only requirement is to include
-# this module...
-module EasyAppHelper
-  require 'easy_app_helper/module_manager'
-  include ModuleManager
-end
-
-
+################################################################################
+# EasyAppHelper 
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+require 'easy_app_helper/version'
+
+# When this module is included in any class, it mixes in automatically
+# EasyAppHelper::ModuleManager methods both into the
+# instance and the class of the instance that includes it.
+# Thus to have access to the helper methods, the only requirement is to include
+# this module...
+module EasyAppHelper
+  require 'easy_app_helper/module_manager'
+  include ModuleManager
+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."
+