empezar 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in empezar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Xavier Via
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,16 @@
+# Empezar
+
+A simple Ruby library to enforce a convention for configuration, logging and execution
+
+## Install
+
+    gem install empezar
+
+## Usage
+
+```ruby
+require 'empezar'
+
+Runner.run        # Maps config/main.yaml to Configuration as SymbolMatrix
+                  # Gets ready Log as a logger in log/main.log
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/empezar.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'empezar/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "empezar"
+  gem.version       = Empezar::VERSION
+  gem.authors       = ["Xavier Via"]
+  gem.email         = ["xavierviacanel@gmail.com"]
+  gem.description   = %q{A simple Ruby library to enforce a convention for configuration, logging and execution}
+  gem.summary       = %q{A simple Ruby library to enforce a convention for configuration, logging and execution}
+  gem.homepage      = "http://github.com/Fetcher/empezar"
+
+  gem.add_dependency 'symbolmatrix'
+
+  gem.add_development_dependency 'rspec'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/empezar/configuration.rb

@@ -0,0 +1,13 @@
+module Empezar
+  class Configuration < SymbolMatrix
+    include Singleton
+  end
+end
+
+class Configuration
+  class << self
+    def method_missing *args
+      Empezar::Configuration.instance.send *args
+    end
+  end
+end

data/lib/empezar/exceptions.rb

@@ -0,0 +1,3 @@
+module Empezar
+  class ConfigurationFileMissingException < StandardError; end
+end

data/lib/empezar/log.rb

@@ -0,0 +1,21 @@
+module Empezar
+  class Log
+    include Singleton
+
+    def self.instance
+      @logger
+    end
+
+    def self.start logger
+      @logger = logger
+    end
+  end
+end
+
+class Log
+  class << self
+    def method_missing *args
+      Empezar::Log.instance.send *args
+    end
+  end
+end

data/lib/empezar/runner.rb

@@ -0,0 +1,28 @@
+module Empezar
+  class Runner
+    def self.run argument = 'config/main.yaml'
+      self.start_logger
+      self.start_configuration argument
+    end
+
+    def self.start_configuration argument
+      unless File.exist? argument
+        raise ConfigurationFileMissingException, "The configuration file is missing from '#{argument}'"
+      end
+      Empezar::Configuration.instance.merge SymbolMatrix.new argument
+    end
+
+    def self.start_logger
+      Dir.mkdir 'log' unless Dir.exist? 'log'
+      Empezar::Log.start Logger.new 'log/main.log', 'daily'
+    end
+  end
+end
+
+class Runner
+  class << self
+    def method_missing *args
+      Empezar::Runner.send *args
+    end
+  end
+end

data/lib/empezar/version.rb

@@ -0,0 +1,3 @@
+module Empezar
+  VERSION = "0.0.1"
+end

data/lib/empezar.rb

@@ -0,0 +1,9 @@
+require 'singleton'
+require 'symbolmatrix'
+require 'logger'
+
+require 'empezar/version'
+require 'empezar/exceptions'
+require 'empezar/configuration'
+require 'empezar/runner'
+require 'empezar/log'

data/spec/configuration_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Configuration do 
+  it 'should redirect random calls to the instance of Empezar::Configuration' do 
+    Empezar::Configuration.instance.should_receive :hola
+    Configuration.hola
+
+    Empezar::Configuration.instance.should_receive :aaaaaaaa
+    Configuration.aaaaaaaa
+
+    Empezar::Configuration.instance.should_receive(:oo=).with "hola"
+    Configuration.oo = "hola"
+  end
+end

data/spec/empezar/configuration_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Empezar::Configuration do 
+  it 'should be a Singleton' do 
+    Empezar::Configuration.ancestors.should include Singleton
+  end
+
+  it 'should inherit from SymbolMatrix' do 
+    Empezar::Configuration.superclass.should == SymbolMatrix
+  end
+end

data/spec/empezar/log_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Empezar::Log do 
+  it 'should be a Singleton' do 
+    Empezar::Log.ancestors.should include Singleton
+  end
+
+  describe '#instance' do 
+    it 'should be as initialized in the start' do 
+      logger_stub = stub 'logger'
+      Empezar::Log.start logger_stub
+      Empezar::Log.instance.should == logger_stub
+    end
+  end
+end

data/spec/empezar/runner_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Empezar::Runner do 
+  describe '.run' do 
+    it 'should call start_logger' do 
+      Empezar::Runner.stub :start_configuration
+      Empezar::Runner.should_receive(:start_logger)
+      Empezar::Runner.run
+    end
+
+    context 'without argument' do 
+      it 'should call start_configuration with config/main.yaml' do 
+        Empezar::Runner.stub :start_logger
+        Empezar::Runner.should_receive(:start_configuration).with('config/main.yaml')
+        Empezar::Runner.run
+      end
+    end
+
+    context 'with argument' do 
+      it 'should call start_configuration with the argument' do 
+        Empezar::Runner.stub :start_logger
+        Empezar::Runner.should_receive(:start_configuration).with('hola')
+        Empezar::Runner.run 'hola'
+      end
+    end
+  end
+
+  describe '.start_logger' do 
+    it 'should initialize the log as logger pointing to log/main.log, daily' do 
+      Dir.should_receive(:exist?).with('log').and_return true
+      demo_logger = stub 'logger'
+      Logger.should_receive(:new).with('log/main.log', 'daily').and_return demo_logger
+      Empezar::Log.should_receive(:start).with demo_logger
+
+      Empezar::Runner.start_logger
+    end
+
+    context 'the dir log does not exist' do
+      it 'should create the dir log' do 
+        Dir.should_receive(:exist?).with('log').and_return false
+        Dir.should_receive(:mkdir).with('log')
+
+        demo_logger = stub 'logger'
+        Logger.should_receive(:new).with('log/main.log', 'daily').and_return demo_logger
+        Empezar::Log.should_receive(:start).with demo_logger
+
+        Empezar::Runner.start_logger
+      end
+    end
+  end
+
+  describe '.start_configuration' do 
+    context 'the configuration file exists' do 
+      it 'should initialize the configuration with the argument' do 
+        File.stub :exist? => true
+        config_stub = stub 'config'
+        SymbolMatrix.should_receive(:new).with('config/main.yaml').and_return config_stub
+        Empezar::Configuration.instance.should_receive(:merge).with(config_stub)
+
+        Empezar::Runner.start_configuration 'config/main.yaml'
+      end
+    end
+
+    context 'the configuration file is missing' do 
+      it 'should raise a relevant error' do
+        File.should_receive(:exist?).with('config/main.yaml').and_return false
+        expect { Empezar::Runner.start_configuration 'config/main.yaml'
+        }.to raise_error Empezar::ConfigurationFileMissingException, 
+          "The configuration file is missing from 'config/main.yaml'"
+      end
+    end
+  end
+end

data/spec/log_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Log do 
+  it 'should redirect random calls to the instance of Empezar::Log' do 
+    Empezar::Log.instance.should_receive :hola
+    Log.hola
+
+    Empezar::Log.instance.should_receive :aaaaaaaa
+    Log.aaaaaaaa
+
+    Empezar::Log.instance.should_receive(:oo=).with "hola"
+    Log.oo = "hola"
+  end
+end

data/spec/runner_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Runner do 
+  it 'should redirect random calls to Empezar::Runner' do 
+    Empezar::Runner.should_receive :hola
+    Runner.hola
+
+    Empezar::Runner.should_receive :aaaaaaaa
+    Runner.aaaaaaaa
+
+    Empezar::Runner.should_receive(:oo=).with "hola"
+    Runner.oo = "hola"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'empezar'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: empezar
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Via
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: symbolmatrix
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A simple Ruby library to enforce a convention for configuration, logging
+  and execution
+email:
+- xavierviacanel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- empezar.gemspec
+- lib/empezar.rb
+- lib/empezar/configuration.rb
+- lib/empezar/exceptions.rb
+- lib/empezar/log.rb
+- lib/empezar/runner.rb
+- lib/empezar/version.rb
+- spec/configuration_spec.rb
+- spec/empezar/configuration_spec.rb
+- spec/empezar/log_spec.rb
+- spec/empezar/runner_spec.rb
+- spec/log_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Fetcher/empezar
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: A simple Ruby library to enforce a convention for configuration, logging
+  and execution
+test_files:
+- spec/configuration_spec.rb
+- spec/empezar/configuration_spec.rb
+- spec/empezar/log_spec.rb
+- spec/empezar/runner_spec.rb
+- spec/log_spec.rb
+- spec/runner_spec.rb
+- spec/spec_helper.rb