easy_app_helper 1.0.3 → 1.0.4

data/lib/easy_app_helper/core/logger.rb

@@ -1,111 +1,111 @@
-################################################################################
-# EasyAppHelper
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-require 'logger'
-require 'singleton'
-
-# Official Ruby Logger re-opened to introduce a method to hand-over the temporary history from a temporary logger
-# 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)
-    history = []
-    history = @logdev.dev.history if @logdev.dev.respond_to? :history
-    @logdev.close
-    @logdev = LogDevice.new log
-    history.each do |msg|
-      @logdev.write msg if ENV['DEBUG_EASY_MODULES'] or (msg =~ /^[WE]/)
-    end
-  end
-end
-
-# This is the logger that will be used by the application and any class that include {EasyAppHelper} module. It is
-# configured by the {EasyAppHelper::Core::Config Config} object, and provides a temporary logger until the config
-# is fully loaded.
-class EasyAppHelper::Core::Logger < Logger
-  include Singleton
-
-
-  def initialize
-    @config = {}
-    super(TempLogger.new)
-    self.level = Severity::DEBUG
-    debug "Temporary initialisation logger created..."
-  end
-
-  # Change the log level while keeping the config in sync.
-  def level=(level)
-    super
-    @config[:'log-level'] = level
-  end
-
-  # Displays the message according to application verbosity and logs it as info.
-  def puts_and_logs(msg)
-    puts msg if @config[:verbose]
-    info(msg)
-  end
-
-  # Reset the logger regarding the config provided
-  def set_app_config(config)
-    @config = config
-    add_cmd_line_options
-    @config.load_config
-    debug "Config layers:\n#{@config.internal_configs.to_yaml}"
-    debug "Merged config:\n#{@config.to_yaml}"
-    if config[:debug]
-      if config[:'log-file']
-        handing_over_to config[:'log-file']
-      elsif config[:"debug-on-err"]
-        handing_over_to STDERR
-      else
-        handing_over_to STDOUT
-      end
-    else
-      close
-    end
-    self.level = config[:'log-level'] ? config[:'log-level'] : Severity::WARN
-    self
-  end
-
-  private
-
-
-  def add_cmd_line_options
-    @config.add_command_line_section('Debug and logging options') do |slop|
-      slop.on :debug, 'Run in debug mode.', :argument => false
-      slop.on 'debug-on-err', 'Run in debug mode with output to stderr.', :argument => false
-      slop.on 'log-level', "Log level from 0 to 5, default #{Severity::WARN}.", :argument => true, :as => Integer
-      slop.on 'log-file', 'File to log to.', :argument => true
-    end
-  end
-
-  # This class will act as a temporary logger, actually just keeping the history until the real
-  # configuration for the logger is known. Then the history is displayed or not regarding the
-  # definitive logger configuration.
-  class TempLogger
-    attr_reader :history
-
-    def initialize
-      @history = []
-    end
-
-    def write(data)
-      return if closed?
-      @history << data if @history
-    end
-
-    def close
-      @closed = true
-    end
-
-    def opened?() not @closed ; end
-    def closed?() @closed ; end
-  end
-
-end
-
-
+################################################################################
+# EasyAppHelper
+#
+# Copyright (c) 2013 L.Briais under MIT license
+# http://opensource.org/licenses/MIT
+################################################################################
+
+require 'logger'
+require 'singleton'
+
+# Official Ruby Logger re-opened to introduce a method to hand-over the temporary history from a temporary logger
+# 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)
+    history = []
+    history = @logdev.dev.history if @logdev.dev.respond_to? :history
+    @logdev.close
+    @logdev = LogDevice.new log
+    history.each do |msg|
+      @logdev.write msg if ENV['DEBUG_EASY_MODULES'] or (msg =~ /^[WE]/)
+    end
+  end
+end
+
+# This is the logger that will be used by the application and any class that include {EasyAppHelper} module. It is
+# configured by the {EasyAppHelper::Core::Config Config} object, and provides a temporary logger until the config
+# is fully loaded.
+class EasyAppHelper::Core::Logger < Logger
+  include Singleton
+
+
+  def initialize
+    @config = {}
+    super(TempLogger.new)
+    self.level = Severity::DEBUG
+    debug "Temporary initialisation logger created..."
+  end
+
+  # Change the log level while keeping the config in sync.
+  def level=(level, update_config = true)
+    super(level)
+    @config[:'log-level'] = level if update_config
+  end
+
+  # Displays the message according to application verbosity and logs it as info.
+  def puts_and_logs(msg)
+    puts msg if @config[:verbose]
+    info(msg)
+  end
+
+  # Reset the logger regarding the config provided
+  def set_app_config(config)
+    @config = config
+    add_cmd_line_options
+    @config.load_config
+    debug "Config layers:\n#{@config.internal_configs.to_yaml}"
+    debug "Merged config:\n#{@config.to_yaml}"
+    if config[:debug]
+      if config[:'log-file']
+        handing_over_to config[:'log-file']
+      elsif config[:"debug-on-err"]
+        handing_over_to STDERR
+      else
+        handing_over_to STDOUT
+      end
+    else
+      close
+    end
+    self.level = config[:'log-level'] ? config[:'log-level'] : Severity::WARN
+    self
+  end
+
+  private
+
+
+  def add_cmd_line_options
+    @config.add_command_line_section('Debug and logging options') do |slop|
+      slop.on :debug, 'Run in debug mode.', :argument => false
+      slop.on 'debug-on-err', 'Run in debug mode with output to stderr.', :argument => false
+      slop.on 'log-level', "Log level from 0 to 5, default #{Severity::WARN}.", :argument => true, :as => Integer
+      slop.on 'log-file', 'File to log to.', :argument => true
+    end
+  end
+
+  # This class will act as a temporary logger, actually just keeping the history until the real
+  # configuration for the logger is known. Then the history is displayed or not regarding the
+  # definitive logger configuration.
+  class TempLogger
+    attr_reader :history
+
+    def initialize
+      @history = []
+    end
+
+    def write(data)
+      return if closed?
+      @history << data if @history
+    end
+
+    def close
+      @closed = true
+    end
+
+    def opened?() not @closed ; end
+    def closed?() @closed ; end
+  end
+
+end
+
+

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,68 +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
-
-  # 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
-
+################################################################################
+# 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