easy_app_helper 1.0.14 → 2.0.2

data/lib/easy_app_helper/config/compatibility.rb

@@ -0,0 +1,22 @@
+module EasyAppHelper
+  module Config
+
+    module Compatibility
+
+      # For backward compatibility with EasyAppHelper v1.x
+      def help
+        command_line_help
+      end
+
+      def command_line_config
+        command_line_layer.slop_definition.to_hash
+      end
+
+    end
+
+    def self.set_compatibility_mode(config=EasyAppHelper.config)
+      config.extend EasyAppHelper::Config::Compatibility
+    end
+
+  end
+end

data/lib/easy_app_helper/config/initializer.rb

@@ -0,0 +1,15 @@
+module EasyAppHelper
+  module Config
+
+    module Initializer
+
+      def self.build_config
+        config = StackedConfig::Orchestrator.new
+        EasyAppHelper::Config.set_compatibility_mode(config) if config[:easy_app_helper_compatibility_mode]
+        config
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/config.rb

@@ -0,0 +1,11 @@
+
+module EasyAppHelper
+  ManagedConfig = EasyAppHelper::Config::Initializer.build_config
+
+  extend self
+
+  def config
+    EasyAppHelper::ManagedConfig
+  end
+
+end

data/lib/easy_app_helper/logger/initializer.rb

@@ -0,0 +1,46 @@
+module EasyAppHelper
+  module Logger
+
+    module Initializer
+
+      def self.init_command_line_options
+        EasyAppHelper.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 #{::Logger::Severity::WARN}.", argument: true, as: Integer
+          slop.on 'log-file', 'File to log to.', argument: true, as: String
+        end
+      end
+
+      def self.setup_logger(logger)
+        logger.level = EasyAppHelper.config[:'log-level'] ? EasyAppHelper.config[:'log-level'] : ::Logger::Severity::WARN
+        logger.extend EasyAppHelper::Logger::Wrapper
+        logger
+      end
+
+      def self.build_logger
+        log_device = if EasyAppHelper.config[:debug]
+                       if EasyAppHelper.config[:'log-file']
+                         EasyAppHelper.config[:'log-file']
+                       elsif EasyAppHelper.config[:'debug-on-err']
+                         STDERR
+                       else
+                         STDOUT
+                       end
+                     else
+                       File::NULL
+                     end
+        setup_logger(::Logger.new log_device)
+      end
+
+      init_command_line_options
+
+    end
+
+  end
+end
+
+
+
+
+

data/lib/easy_app_helper/logger/wrapper.rb

@@ -0,0 +1,12 @@
+module EasyAppHelper
+  module Logger
+
+    module Wrapper
+      def puts_and_logs(*args)
+        puts *args if EasyAppHelper.config[:verbose]
+        info(*args)
+      end
+    end
+
+  end
+end

data/lib/easy_app_helper/managed_logger.rb

@@ -0,0 +1,9 @@
+module EasyAppHelper
+
+  ManagedLogger = EasyAppHelper::Logger::Initializer.build_logger
+
+  def logger
+    EasyAppHelper::ManagedLogger
+  end
+
+end

data/lib/easy_app_helper/version.rb

@@ -1,10 +1,3 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
-
 module EasyAppHelper
-  EASY_APP_HELPER_VERSION = '1.0.14'
+  VERSION = '2.0.2'
 end

data/lib/easy_app_helper.rb

@@ -1,20 +1,29 @@
-################################################################################
-# EasyAppHelper 
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-################################################################################
+require 'stacked_config'
+
+require 'logger'
 
 require 'easy_app_helper/version'
+require 'easy_app_helper/config/compatibility'
+require 'easy_app_helper/config/initializer'
+require 'easy_app_helper/config'
+require 'easy_app_helper/logger/initializer'
+require 'easy_app_helper/logger/wrapper'
+require 'easy_app_helper/managed_logger'
 
-# 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
+
+  def puts_and_logs(*args)
+    logger.puts_and_logs *args
+  end
+
+  def safely_exec(message, *args, &block)
+    if self[:simulate]
+      puts_and_logs "SIMULATING: #{message}" unless message.nil?
+    else
+      puts_and_logs message
+      yield(*args)
+    end
+  end
 
 
+end

data/spec/config_spec.rb

@@ -1,201 +1,31 @@
-#-------------------------------------------------------------------------------
-#  
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-#-------------------------------------------------------------------------------
+require 'spec_helper'
 
-require 'rspec'
-require 'easy_app_helper'
 
+describe EasyAppHelper.config do
 
-#describe EasyAppHelper::Core::Config do
-describe "The EasyAppHelper config object" do
-  SAMPLE_STRING = 'TestConfig'
-  subject {EasyAppHelper.config}
-
-
-  it 'should be fully initialized when first accessed' do
-    subject.should_not be nil
-    subject.logger.should_not be nil
+  it 'should be a StackedConfig::Orchestrator' do
+    expect(subject).to be_a_kind_of StackedConfig::Orchestrator
   end
 
-  it 'should be consistent regardless 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.set_value :stupid_conf, SAMPLE_STRING, :system
-    expect(subject[:stupid_conf]).to eq SAMPLE_STRING
-  end
 
-  it 'should be reloaded when :config-file property changes' do
-    subject.should_receive(:force_reload)
-    subject[:'config-file'] = SAMPLE_STRING
+  it 'should have the compatibility mode set if :easy_app_helper_compatibility_mode is set in the config' do
+    expect(subject).to_not respond_to :help
+    expect(subject).to_not respond_to :command_line_config
+    EasyAppHelper::Config.set_compatibility_mode subject
+    expect(subject).to respond_to :help
+    expect(subject).to respond_to :command_line_config
   end
 
-  it 'should be reloaded when script_filename changes' do
-    subject.should_receive(:force_reload)
-    subject.script_filename = SAMPLE_STRING
-  end
-
-
-  context 'when dealing with the multiple layers of the config' do
-
-    before(:all) do
-      EasyAppHelper.config.layers.each do |layer|
-        EasyAppHelper.config.set_value :basic_test, "#{SAMPLE_STRING} #{layer.to_s}", layer
-      end
-      EasyAppHelper.config.set_value :'config-file', true, :command_line
-    end
-
-    context "when trying to access some data" do
-      let(:layers) {subject.layers}
-      #subject {EasyAppHelper.config}
-
-      original_ordered_layers = EasyAppHelper.config.layers
-      layers = original_ordered_layers.dup
-      original_ordered_layers.each do |layer|
-        test_descr = "It should find the data in #{layer} layer if present in #{layer} layer"
-        unless layers.length == original_ordered_layers.length
-          already_removed = original_ordered_layers - layers
-          if already_removed.length == 1
-            test_descr += " and not present in #{already_removed[0]} layer"
-          end
-          if already_removed.length > 1
-            test_descr += " and not present in #{already_removed.join ', '} layers"
-          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
-
+  context 'when mixing-in the EasyAppHelper module' do
+    subject {
+      class A
+        include EasyAppHelper
       end
-    end
-
-    context "when accessing a non existing layer" do
-      context "in read mode" do
-
-        it "should log a warning and return nil" do
-          subject.logger.should_receive(:warn)
-          expect(subject.get_value :non_existing_value, :another_non_existing_layer).to be_nil
-        end
-      end
-
-      context "in write mode" do
-
-        it "should log a warning and create it" do
-          subject.logger.should_receive(:warn)
-          subject.set_value :non_existing_value, SAMPLE_STRING, :another_non_existing_layer
-          expect(subject.get_value :non_existing_value, :another_non_existing_layer).to be SAMPLE_STRING
-          expect(subject[:non_existing_value]).to be SAMPLE_STRING
-        end
-      end
-    end
-
-    context "when manually creating a layer" do
-
-      it "should be handled with the lowest priority" do
-        subject.set_value :unused_option, SAMPLE_STRING, :non_existing_layer
-        expect(subject[:unused_option]).to eq SAMPLE_STRING
-        subject.set_value :unused_option, 'Not the sample string', :system
-        expect(subject[:unused_option]).to_not eq SAMPLE_STRING
-      end
-
+      A.new
+    }
+    it 'should be the exact same object' do
+      expect(subject.config.equal? EasyAppHelper.config).to be_truthy
     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.set_value :stupid_conf, SAMPLE_STRING, :system
-      subject.reset
-      expect(subject.get_value :stupid_conf, :system).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.set_value :stupid_conf, SAMPLE_STRING, :system
-      subject.set_value :stupid_conf, SAMPLE_STRING, :command_line
-      subject.load_config
-      expect(subject.get_value :stupid_conf,:system).to be_nil
-      expect(subject.get_value :stupid_conf,:command_line).to be_nil
-    end
-
-  end
-
-  context "when reloaded (forced)" do
-
-    it "should keep all modifications done the standard way" do
-      subject[:test_remove] = SAMPLE_STRING
-      subject.force_reload
-      expect(subject[:test_remove]).to eq SAMPLE_STRING
-    end
-
-    it "should remove all modifications directly done on internal layers" do
-      subject.set_value :stupid_conf, SAMPLE_STRING, :system
-      subject.set_value :stupid_conf, SAMPLE_STRING, :command_line
-      subject.force_reload
-      expect(subject.get_value :stupid_conf,:system).to be_nil
-      expect(subject.get_value :stupid_conf,:command_line).to be_nil
-    end
-
-  end
-
-
-  context "When dealing with command line" do
-
-    it 'should have the same content using #command_line_config and #internal_configs[:command_line][:content]' do
-      subject.add_command_line_section('Scripts analysis') do |slop|
-        slop.on :p, :pipo, 'Directory path where SQL files are located.', argument: false
-      end
-      expect(subject.command_line_config).to eq subject.internal_configs[:command_line][:content]
-    end
-
-  end
-
-  context "When a gem has its own :internal config file" do
-    before(:all) do
-      EasyAppHelper.config.script_filename = 'test_internal'
-    end
-
-    it "should take its data in account" do
-      expect(subject[:internal_credits]).to_not be_nil
-    end
-
-  end
-
 end

data/spec/easy_app_helper_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+
+describe EasyAppHelper do
+
+  %i(config logger puts_and_logs safely_exec).each do |m|
+    it "should have module method #{m.to_s}" do
+      expect(subject).to respond_to m
+    end
+  end
+
+  context 'when mixing-in the EasyAppHelper module' do
+    subject {
+      class A
+        include EasyAppHelper
+      end
+      A.new
+    }
+
+    %i(config logger puts_and_logs safely_exec).each do |m|
+      it "should have a #{m.to_s} method " do
+        expect(subject).to respond_to m
+      end
+
+    end
+
+  end
+end

data/spec/logger_spec.rb

@@ -1,34 +1,15 @@
-#-------------------------------------------------------------------------------
-#  
-#
-# Copyright (c) 2013 L.Briais under MIT license
-# http://opensource.org/licenses/MIT
-#-------------------------------------------------------------------------------
+require 'spec_helper'
 
-require 'rspec'
-require 'easy_app_helper'
 
+describe EasyAppHelper.logger do
 
-#describe EasyAppHelper::Core::Logger
-describe "The EasyAppHelper logger object" do
-  subject {EasyAppHelper.logger}
-  let (:config) {EasyAppHelper.config}
-
-  context "to modify the log level, it should be possible " do
-
-    it '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 a valid logger' do
+    expect(subject).to be_a_kind_of ::Logger
+  end
 
-    it 'or directly the #log_level= method of the logger object' do
-      Logger::Severity::DEBUG.upto(Logger::Severity::UNKNOWN) do |severity|
-        subject.level= severity
-        expect(config[:'log-level']).to eq severity
-      end
-    end
+  it 'should respond to puts_and_logs' do
+    expect(subject).to respond_to :puts_and_logs
   end
 
+
 end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'easy_app_helper'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.14
+  version: 2.0.2
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2014-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,28 +58,34 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: stacked_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.1'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
 description: Easy Application Helpers framework
 email:
 - lbnetid+rb@gmail.com
@@ -87,23 +93,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - easy_app_helper.gemspec
-- etc/test_internal.conf
 - lib/easy_app_helper.rb
-- lib/easy_app_helper/core/base.rb
-- lib/easy_app_helper/core/config.rb
-- lib/easy_app_helper/core/logger.rb
-- lib/easy_app_helper/core/merge_policies.rb
-- lib/easy_app_helper/core/places.rb
-- lib/easy_app_helper/module_manager.rb
+- lib/easy_app_helper/config.rb
+- lib/easy_app_helper/config/compatibility.rb
+- lib/easy_app_helper/config/initializer.rb
+- lib/easy_app_helper/logger/initializer.rb
+- lib/easy_app_helper/logger/wrapper.rb
+- lib/easy_app_helper/managed_logger.rb
 - lib/easy_app_helper/version.rb
 - spec/config_spec.rb
+- spec/easy_app_helper_spec.rb
 - spec/logger_spec.rb
-- test/test.yml
+- spec/spec_helper.rb
 homepage: https://github.com/lbriais/easy_app_helper
 licenses:
 - MIT
@@ -124,13 +133,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Provides cool helpers to your application, including configuration and logging
   features
 test_files:
-- etc/test_internal.conf
 - spec/config_spec.rb
+- spec/easy_app_helper_spec.rb
 - spec/logger_spec.rb
-- test/test.yml
+- spec/spec_helper.rb

data/etc/test_internal.conf

@@ -1,3 +0,0 @@
-# This file is used for test only and should not be deployed with the Gem
-
-internal_credits: The EasyAppHelper Gem