easy_app_helper 0.0.9 → 1.0.0

data/lib/easy_app_helper/common.rb

@@ -1,88 +0,0 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-require 'singleton'
-require 'logger'
-
-##
-# This contains very basic default values and methods.
-#
-module EasyAppHelper::Common
-
-  # Default log-level
-  DEFAULT_LOG_LEVEL = Logger::Severity::WARN
-  
-  def self.override_config(h1, h2)
-    EasyAppHelper::Common::HashesMergePolicies.merge_hashes_second_level h1, h2
-  end
-
-end
-
-
-# Ancestor of all module instanciators.
-module EasyAppHelper::Common::Instanciator
-  # Default module priority
-  MODULE_PRIORITY = 10000
-
-  def self.add_cmd_line_options(app, opt)
-    # Does nothing
-  end
-
-  def self.provides_config(app, script_filename, app_name, app_description, app_version)
-    # Does nothing
-    {}
-  end
-
-  def self.post_config_action(app)
-    # Does nothing
-  end
-end
-
-
-
-
-
-# This guy will never log something anywhere... :)
-# It mays be used as the logger until someone replaces by a real one
-# EasyAppHelper::Logger would do that efficiently
-class EasyAppHelper::Common::DummyLogger
-  include Singleton
-  def method_missing(method_name, *args, &block)
-    # Do nothing !
-  end  
-end
-
-# Implements different merge policies for the configs.
-module EasyAppHelper::Common::HashesMergePolicies
-  # Performs a merge at the second level of hashes.
-  # simple entries and arrays are overriden.
-  def self.merge_hashes_second_level(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 self.simple_merge(h1, h2)
-    h1.merge! h2
-  end
-
-  # Brutal override
-  def self.complete_override(h1, h2)
-    h1 = nil
-    h1 = h2
-
-  end
-
-end

data/lib/easy_app_helper/config.rb

@@ -1,129 +0,0 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-# Config file format
-require 'yaml'
-
-# This module defines:
-# - Some basic command line options(see --help), with their underlying
-#   mechanism.
-# - A mechanism (based on Slop) to add your own command line options.
-# - A generated inline help.
-# This module provides the following 5 levels of configuration:
-# - Admin wide YAML config file, for options common to all your EasyAppHelper applications.
-# - System wide YAML config file.
-# - User YAML config file.
-# These 3 levels depends on you OS (see EasyAppHelper::Config::Places).
-# - Command line options.
-# - Command line supplied YAML config file(any option defined here will override the previous).
-# All these 5 levels of configuration override with consistent override mechanism. 
-# Config files are in YAML but can have different extensions.
-module EasyAppHelper::Config
-
-  include EasyAppHelper::Common
-
-  # If the option --config-file has been specified, it will be loaded and override
-  # current configuration according to rules
-  def load_custom_config
-  end
-
-end
-
-
-module EasyAppHelper::Config::Instanciator
-  extend EasyAppHelper::Common::Instanciator
-
-  # Default module priority
-  MODULE_PRIORITY = 10
-  ADMIN_CONFIG_FILENAME = EasyAppHelper.name
-
-  # include paths specific to the OS
-  include EasyAppHelper::Config::Places.get_OS_module
-
-  # Potential extensions a config file can have
-  CONFIG_FILE_POSSIBLE_EXTENSIONS = ['conf', 'yml', 'cfg', 'yaml', 'CFG', 'YML', 'YAML', 'Yaml']
-
-  # Adds a command line options for this module.
-  # - +--config-file+ +filename+ To specify a config file from the command line.
-  def self.add_cmd_line_options(app, slop_definition)
-    slop_definition.separator "\n-- Configuration options -------------------------------------"
-    slop_definition.on 'config-file', 'Specify a config file.', :argument => true
-  end
-
-
-  # Loads the configuration files (admin, system, user).
-  #
-  # Config files may define any type of structure supported by YAML.
-  # The override policy is that, if an entry in the config is a hash and the next
-  # level defines the same hash, they are merged.
-  # For any other type (scalar, array), the overrider... overrides ;)
-  #
-  # Config files can be at different places and have different extensions (see
-  # CONFIG_FILE_POSSIBLE_EXTENSIONS). They have the same base name as the script_filename.
-  def self.provides_config(app, script_filename, app_name, app_description, app_version)
-    config = load_admin_wide_config app
-    config = EasyAppHelper::Common.override_config config, load_system_wide_config(app, script_filename)
-    EasyAppHelper::Common.override_config config, load_user_config(app, script_filename)
-  end
-
-  def self.post_config_action(app)
-    return unless app.app_config[:'config-file']
-    begin
-      app.app_config = EasyAppHelper::Common.override_config app.app_config, load_config_file(app, app.app_config[:'config-file'])
-    rescue => e
-      app.logger.error "Problem with \"#{app.app_config[:'config-file']}\" config file!\n#{e.message}\nIgnoring..."
-    end
-  end
-
-  ################################################################################
-  private
-
-  # Reads config from admin config file.
-  def self.load_admin_wide_config(app)
-    load_config_file app, find_file(app, ADMIN_CONFIG_POSSIBLE_PLACES, ADMIN_CONFIG_FILENAME)
-  end
-
-  # Reads config from system config file.
-  def self.load_system_wide_config(app, script_filename)
-    load_config_file app, find_file(app, SYSTEM_CONFIG_POSSIBLE_PLACES, script_filename)
-  end
-
-  # Reads config from user config file.
-  def self.load_user_config(app, script_filename)
-    load_config_file app, find_file(app, USER_CONFIG_POSSIBLE_PLACES, script_filename)
-  end
-
-  # Loads a config file.
-  def self.load_config_file(app, conf_filename)
-    conf = {}
-    return conf if conf_filename.nil?
-    # A file exists
-    begin
-      app.logger.debug "Loading config file \"#{conf_filename}\""
-      conf = Hash[YAML::load(open(conf_filename)).map { |k, v| [k.to_sym, v] }]
-    rescue => e
-      app.logger.error "Invalid config file \"#{conf_filename}\". Not respecting YAML syntax!\n#{e.message}"
-    end
-    conf
-  end
-
-  # Tries to find config files according to places (array) given and possible extensions
-  def self.find_file(app, places, filename)
-    places.each do |dir|
-      CONFIG_FILE_POSSIBLE_EXTENSIONS.each do |ext|
-        filename_with_path = dir + '/' + filename + '.' + ext
-        if File.exists? filename_with_path
-          return filename_with_path
-        else
-          app.logger.debug "Trying \"#{filename_with_path}\" as config file."
-        end
-      end
-    end
-    nil
-  end
-
-end

data/lib/easy_app_helper/logger.rb

@@ -1,104 +0,0 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
-require 'logger'
-
-
-# This module provides access to logger(Logger) fully configured according to command line options
-# or config files.
-#
-# It will replace the stupid EasyAppHelper::Common::DummyLogger if the
-# module is included.
-#
-# It brings as well some command line options to manipulate debug.
-# See --help
-module EasyAppHelper::Logger
-
-  # This module has the highest priority in order to be processed the first by
-  # the framework and therefore give a chance to other modules to use it to log.
-  MODULE_PRIORITY = 1
-
-  include EasyAppHelper::Common
-
-
-  # Returns the current log_level.
-  def log_level
-    app_config[:"log-level"]
-  end
-
-  # Enables to hot-change the log level.
-  def log_level=(level)
-    app_config[:"log-level"] = level
-    logger.level = level
-  end
-
-  def logger=(logger)
-    @logger = logger
-  end
-
-  # Displays the message according to application verbosity and logs it as info.
-  def puts_and_logs(msg)
-    puts msg if app_config[:verbose]
-    logger.info(msg)
-  end
-
-
-end
-
-
-module EasyAppHelper::Logger::Instanciator
-  extend EasyAppHelper::Common::Instanciator
-
-  # Default module priority
-  MODULE_PRIORITY = 1
-
-  # Adds some command line options for this module.
-  # - +--debug+
-  # - +--debug-on-err+ to have the debugging going to STDERR. Should be used on top of 
-  #   --debug.
-  # - +--log-file+ +filename+ To log to a specific file. 
-  # - +--log-level+ +0-5+ Log level according to Logger::Severity
-  def self.add_cmd_line_options(app, slop_definition)
-    slop_definition.separator "\n-- Debug and logging options ---------------------------------"
-    slop_definition.on :debug, 'Run in debug mode.', :argument => false
-    slop_definition.on 'debug-on-err', 'Run in debug mode with output to stderr.', :argument => false
-    slop_definition.on 'log-level', "Log level from 0 to 5, default #{EasyAppHelper::Common::DEFAULT_LOG_LEVEL}.", :argument => true, :as => Integer
-    slop_definition.on 'log-file', 'File to log to.', :argument => true
-  end
-
-  # Creates the application logger
-  def self.post_config_action(app)
-  # Build logger for the application. Depending on config may end-up up to nowhere 
-  # (by default), STDOUT, STDERR or a file. See --help or EasyAppHelper::Config#help
-  # for all options.
-    @logger = EasyAppHelper::Common::DummyLogger.instance
-    issue_report = nil
-    if app.app_config[:debug]
-      unless app.app_config[:"log-file"].nil?
-        begin
-          if File.exists? app.app_config[:"log-file"]
-            logger_type = File.open(app.app_config[:"log-file"], File::WRONLY | File::APPEND)
-          else
-            logger_type = File.open(app.app_config[:"log-file"], File::WRONLY | File::CREAT)
-          end
-        rescue Exception => e
-          logger_type = STDOUT
-          issue_report = e.message
-        end
-      else
-        logger_type =  STDOUT
-      end
-      logger_type = STDERR if app.app_config[:"debug-on-err"]
-      app.logger = Logger.new(logger_type)
-    end
-    app.app_config[:'log-level'] = EasyAppHelper::Common::DEFAULT_LOG_LEVEL if app.app_config[:'log-level'].nil?
-    app.logger.level = app.app_config[:"log-level"]
-    app.logger.error issue_report if issue_report
-    app.logger.debug "Logger is created."
-  end
-
-end

data/lib/easy_app_helper/places.rb

@@ -1,42 +0,0 @@
-
-module EasyAppHelper
-  module Config
-    module UnixPlaces
-      # Where could be stored admin configuration that rules all EasyAppHelper
-      # based applications.
-      ADMIN_CONFIG_POSSIBLE_PLACES = ["/etc"]
-
-      # Where could be stored system wide configuration
-      SYSTEM_CONFIG_POSSIBLE_PLACES = ["/etc",
-                                       "/usr/local/etc"]
-
-      # Where could be stored user configuration
-      USER_CONFIG_POSSIBLE_PLACES = ["#{ENV['HOME']}/.config"]
-    end
-
-    module WindowsPlaces
-      # Where could be stored admin configuration that rules all EasyAppHelper
-      # based applications.
-      ADMIN_CONFIG_POSSIBLE_PLACES = ["#{ENV['systemRoot']}/Config"]
-
-      # Where could be stored system wide configuration
-      SYSTEM_CONFIG_POSSIBLE_PLACES = ['C:/Windows/Config', "#{ENV['ALLUSERSPROFILE']}/Application Data"]
-
-      # Where could be stored user configuration
-      USER_CONFIG_POSSIBLE_PLACES = [ENV['APPDATA']]
-    end
-
-    module Places
-      CONF ={
-        mingw32: EasyAppHelper::Config::WindowsPlaces
-      }
-      DEFAULT = EasyAppHelper::Config::UnixPlaces
-
-      def self.get_OS_module
-        conf = CONF[RbConfig::CONFIG['target_os'].to_sym]
-        conf.nil? ? DEFAULT : conf
-      end
-    end
-  end
-end
-