easy_app_helper 0.0.7 → 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4a396d8e647a55809d2da33c85316587cff1663
+  data.tar.gz: 8b6fd6361da1c97cea0681dbe87ad03c06418439
+SHA512:
+  metadata.gz: 0c9db25b1668515ed811c09d526281f5f6638cf8ca4fb95a385fcef32161a28945441c84e0946a59c86180f7a4bf21115ec1a895c41397750ec21931f332f949
+  data.tar.gz: d196eca609e0d2b5693510683d31a992f822cf651c1920aaad935958815df470d85a5ae5f5cc266c37592f98d28257782c661a54fde50de4b5c77f057167f7f8

data/README.md

@@ -6,7 +6,7 @@ The goal is to be as transparent as possible for the application whilst providin
 
 Currently the only runtime dependency is on the [Slop gem] [2].
 
-
+[Why this gem][4] ?
 
 ## Installation
 
@@ -24,6 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Including the basic module
+
 To benefit from the different helpers. Once you installed the gem, you just need to require it:
 
 ```ruby
@@ -247,7 +249,7 @@ ex:
 		 D, [2013-03-20T13:14:32.164733 #10564] DEBUG -- : Processing helper module: EasyAppHelper::Base::Instanciator
 		 D, [2013-03-20T13:14:32.164733 #10564] DEBUG -- : Processing helper module: EasyAppHelper::Common::Instanciator
 
-You can observe that for each included module, the framwork uses its related so-called instanciator in order to know how to start the module, externalizing the methods into a separated module to avoid poluting your own application with methods useless for you when you include the module.
+You can observe that for each of the included module, the framework uses its related so-called instanciator in order to know how to start the module, externalizing the methods into a separated module to avoid poluting your own application with methods useless for you when you include the module.
 
 ## Contributing
 
@@ -257,7 +259,17 @@ You can observe that for each included module, the framwork uses its related so-
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
+### Creating your own EasyAppHelper module
+
+You need to write two modules
+
+* One EasyAppHelper::MyModule that will provide the features mixed in your application.
+* One EasyAppHelper::MyModule::Instanciator that will extend (not include) EasyAppHelper::Common::Instanciator and that will be responsible to initialize your module.
+
+That's all folks.
+
 
 [1]: https://rubygems.org/gems/easy_app_helper        "EasyAppHelper gem"
 [2]: https://rubygems.org/gems/slop        "Slop gem"
-[3]: http://rubydoc.info/github/lbriais/easy_app_helper/master/frames        "EasyAppHelper documentation"
+[3]: http://rubydoc.info/github/lbriais/easy_app_helper/master/frames        "EasyAppHelper documentation"
+[4]: https://github.com/lbriais/easy_app_helper/wiki          "EasyAppHelper wiki"

data/easy_app_helper.gemspec

@@ -5,7 +5,7 @@ require 'easy_app_helper/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "easy_app_helper"
-  spec.version       = EasyAppHelper::VERSION
+  spec.version       = EasyAppHelper::EASY_APP_HELPER_VERSION
   spec.authors       = ["L.Briais"]
   spec.email         = ["lbnetid+rb@gmail.com"]
   spec.description   = %q{Easy Application Helpers framework}

data/lib/easy_app_helper/common.rb

@@ -12,6 +12,7 @@ require 'logger'
 # This contains very basic default values and methods.
 #
 module EasyAppHelper::Common
+
   # Default log-level
   DEFAULT_LOG_LEVEL = Logger::Severity::WARN
   

data/lib/easy_app_helper/logger.rb

@@ -36,35 +36,14 @@ module EasyAppHelper::Logger
     logger.level = level
   end
 
+  def logger=(logger)
+    @logger = logger
+  end
 
-  # 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.
-  def build_logger
-    @logger = EasyAppHelper::Common::DummyLogger.instance
-    issue_report = nil
-    if app_config[:debug]
-      unless app_config[:"log-file"].nil?
-        begin
-          if File.exists? app_config[:"log-file"]
-            logger_type = File.open(app_config[:"log-file"], File::WRONLY | File::APPEND)
-          else
-            logger_type = File.open(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_config[:"debug-on-err"]
-      @logger = Logger.new(logger_type)
-    end
-    app_config[:'log-level'] = DEFAULT_LOG_LEVEL if app_config[:'log-level'].nil?
-    logger.level = app_config[:"log-level"]
-    logger.error issue_report if issue_report
-    logger.debug "Logger is created."
+  # 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
 
 
@@ -93,7 +72,33 @@ module EasyAppHelper::Logger::Instanciator
 
   # Creates the application logger
   def self.post_config_action(app)
-    app.build_logger
+  # 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/version.rb

@@ -6,5 +6,6 @@
 ################################################################################
 
 module EasyAppHelper
-  VERSION = "0.0.7"
+  # Framework version
+  EASY_APP_HELPER_VERSION = "0.0.8"
 end

metadata

@@ -1,78 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.0.8
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Easy Application Helpers framework
@@ -97,27 +88,26 @@ files:
 homepage: https://github.com/lbriais/easy_app_helper
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides cool helpers to your application, including configuration and logging
   features
 test_files: []