configureasy 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27a4dc67f6dbb0c1a719a09453e3621c91365ea1
+  data.tar.gz: 7110800425b8880687c7a78e5c23b285b58d3705
+SHA512:
+  metadata.gz: eb1870f7f84b47e4b08483dc958dc3de2cc4859b66d4066e38786c9f553cf28bc220a278797a8cc43aea450d244fb79365b5d398df0d5a0cd087abac4e35b23a
+  data.tar.gz: 2f88c2dfe20f5ed7b34ec131691c81a228e9b39104583b289620d1c81c98ffe4b548a65b62a25ad83d84806aac2429692e6d9c6e16d85db2137a3152c46592c3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+clearing :on
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alexandre Prates
+
+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,68 @@
+Configureasy
+=============
+
+A forma mais simples de carregar arquivos de configuração em suas Classe/Módulos.
+
+## Instalação
+
+Basta adicionar esta linha no seu Gemfile
+
+```ruby
+gem 'configureasy'
+```
+
+E entao executar:
+
+    $ bundle
+
+Ou instale manualmente:
+
+    $ gem install configureasy
+
+## Como usar
+
+Basta incluir na classe e começar a usar
+
+```ruby
+class Foo
+  include Configureasy
+end
+
+Foo.config.some_key_in_config
+# => 'some value for that key'
+```
+
+Por padrão ele busca um arquivo (.yml) no diretório _config_, caso precise especificar um nome diferente utilize o método _config_name_.
+
+```ruby
+class Foo
+  include Configureasy
+  # load APP_ROOT/config/foo_config.yml
+  config_name :foo_config
+end
+```
+
+Caso precise você tambem pode especificar de onde carregar a configuração usando o método _config_filename_.
+
+```ruby
+class Foo
+  include Configureasy
+  # load APP_ROOT/.hide_dir/secrets.yml
+  config_filename '.hide_dir/secrets.yml'
+end
+```
+
+Caso precise ver o conteúdo original do arquivo utilize o método _raw_content_.
+
+```ruby
+class Foo
+  include Configureasy
+end
+
+Foo.config.raw_content
+# => {'foo' => 'bar'}
+```
+
+## Duvidas, questões e desconfianças em geral
+
+mail me: ajfprates@gmail.com

data/Rakefile

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

data/configureasy.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configureasy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "configureasy"
+  spec.version       = Configureasy::VERSION
+  spec.authors       = ["Alexandre Prates"]
+  spec.email         = ["ajfprates@gmail.com"]
+  spec.summary       = %q{A Simple way to get configs in your Classes/Modules.}
+  spec.description   = %q{A Simple way to get configs in your Classes/Modules.}
+  spec.homepage      = "https://gitlab.ir7.com.br/videos/configureasy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "guard", "~> 2.10"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+end

data/lib/configureasy.rb

@@ -0,0 +1,38 @@
+require "configureasy/version"
+
+# Configureasy is a easy way to getting configs into you class/model
+#
+# Example
+#
+#   class Foo
+#     include Configureasy
+#   end
+#   Foo.config.some_key
+#   => 'some value'
+#
+#  class Bar
+#    include Configureasy
+#    config_name :barz #looks for APP_DIR/config/barz.yml
+#  end
+#
+#   class FooBar
+#     include Configureasy
+#     def internal_access
+#       value = self.class.some_key
+#       ...
+#     end
+#   end
+#
+module Configureasy
+  # Class to raise error on missing config file _yaml_
+  class ConfigNotFound < Exception; end
+  # Class to raise error on invalid config file
+  class ConfigInvalid < Exception; end
+
+  def self.included(receiver)
+    receiver.extend Configurable
+  end
+end
+
+require 'configureasy/config'
+require 'configureasy/configurable'

data/lib/configureasy/config.rb

@@ -0,0 +1,15 @@
+require 'ostruct'
+
+##
+# Class for store and retrive config values
+#
+# Example
+#   >> Confugureasy::Config.new(foo: 'foo').foo
+#   => 'foo'
+#
+class Configureasy::Config < OpenStruct
+  # return config as hash
+  def raw_content
+    @table
+  end
+end

data/lib/configureasy/configurable.rb

@@ -0,0 +1,57 @@
+require 'yaml'
+
+module Configureasy::Configurable
+  # Setting config file name
+  #
+  # Example
+  #   config_name :foo
+  #   => APP_ROOT/config/foo.yml
+  #
+  #   config_name :bar
+  #   => APP_ROOT/config/bar.yml
+  #
+  def config_name(name = nil)
+    @config_name = name if name
+    @config_name || self.name.downcase
+  end
+
+  def config_filename(filename = nil)
+    @config_filename = File.expand_path filename if filename
+    @config_filename || File.expand_path("./config/#{config_name}.yml")
+  end
+
+  # Load the config yaml and return Configureasy::Config instance
+  def config
+    @config ||= load_configs
+  end
+
+  # Looks for config file an return true if file exists
+  def have_config?
+    File.exist? config_filename
+  end
+
+  # Reload configs
+  def reset_config!
+    @config = nil
+    config
+  end
+
+  private
+
+  def load_configs
+    configs_hash = parse_configs
+    raise Configureasy::ConfigInvalid, "invalid config file '#{config_filename}'", caller unless configs_hash.is_a? Hash
+
+    Configureasy::Config.new configs_hash[_current_env] || configs_hash
+  end
+
+  def parse_configs
+    raise Configureasy::ConfigNotFound, "file not found '#{config_filename}'", caller unless have_config?
+    YAML.load_file config_filename
+  end
+
+  def _current_env
+    ENV['RAILS_ENV'] || ENV['RUBY_ENV'] || ENV['RACK_ENV'] || 'development'
+  end
+
+end

data/lib/configureasy/version.rb

@@ -0,0 +1,3 @@
+module Configureasy
+  VERSION = "0.0.2"
+end

data/spec/lib/configureasy/config_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Configureasy::Config do
+  describe ".new" do
+    it "should store key/value as methods" do
+      expect(Configureasy::Config.new(foo: 'bar').foo).to eq('bar')
+    end
+  end
+
+  describe "#as_hash" do
+
+  end
+end

data/spec/lib/configureasy/configurable_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+class Foo
+  extend Configureasy::Configurable
+end
+
+describe Configureasy::Configurable do
+  describe ".config_name" do
+    it "by default config name is class name" do
+      expect(Foo.config_name).to eq('foo')
+    end
+
+    it "changes config name" do
+      expect(Foo.config_name).to eq('foo')
+      Foo.config_name "bar"
+      expect(Foo.config_name).to eq('bar')
+    end
+
+    it "config name reflects on config_filename" do
+      Foo.config_name "other_conf"
+      expect(Foo.send :config_filename).to match(/other_conf\.yml$/)
+    end
+  end
+
+  describe '.config_filename' do
+    it "set config filename" do
+      Foo.config_filename '.hidedir/secret_config.yml'
+      expect(Foo.config_filename).to end_with('.hidedir/secret_config.yml')
+    end
+  end
+
+  describe '#config' do
+    let(:yaml_content) { {'development' => {'foo' => 'bar'}, 'test' => {'foo' => 'test'} } }
+
+    it "raise excepion when file missing" do
+      expect { Foo.config }.to raise_exception Configureasy::ConfigNotFound
+    end
+
+    it "raise exception when file content is not valid yaml" do
+      allow(YAML).to receive(:load_file).and_return("wrong yaml content")
+      allow(File).to receive(:exist?).and_return(true)
+
+      expect { Foo.config }.to raise_exception Configureasy::ConfigInvalid
+    end
+
+    it "access values on config file" do
+      allow(YAML).to receive(:load_file).and_return(yaml_content)
+      allow(File).to receive(:exist?).and_return(true)
+
+      expect(Foo.config).to respond_to(:foo)
+      expect(Foo.config.foo).to eq('bar')
+    end
+
+    it "load contend for current environment" do
+      allow(YAML).to receive(:load_file).and_return(yaml_content)
+      allow(File).to receive(:exist?).and_return(true)
+
+      ENV['RUBY_ENV'] = 'development'
+      expect(Foo.reset_config!.foo).to eq('bar')
+
+      ENV['RUBY_ENV'] = 'test'
+      expect(Foo.reset_config!.foo).to eq('test')
+
+      ENV['RUBY_ENV'] = nil
+
+      ENV['RACK_ENV'] = 'development'
+      expect(Foo.reset_config!.foo).to eq('bar')
+      ENV['RACK_ENV'] = nil
+
+      ENV['RAILS_ENV'] = 'test'
+      expect(Foo.reset_config!.foo).to eq('test')
+    end
+
+    it "config is kind of Configs class" do
+      allow(YAML).to receive(:load_file).and_return(yaml_content)
+      allow(File).to receive(:exist?).and_return(true)
+
+      expect(Foo.config).to be_kind_of(Configureasy::Config)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require './lib/configureasy'
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: configureasy
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Alexandre Prates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+description: A Simple way to get configs in your Classes/Modules.
+email:
+- ajfprates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- configureasy.gemspec
+- lib/configureasy.rb
+- lib/configureasy/config.rb
+- lib/configureasy/configurable.rb
+- lib/configureasy/version.rb
+- spec/lib/configureasy/config_spec.rb
+- spec/lib/configureasy/configurable_spec.rb
+- spec/lib/configureasy_spec.rb
+- spec/spec_helper.rb
+homepage: https://gitlab.ir7.com.br/videos/configureasy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A Simple way to get configs in your Classes/Modules.
+test_files:
+- spec/lib/configureasy/config_spec.rb
+- spec/lib/configureasy/configurable_spec.rb
+- spec/lib/configureasy_spec.rb
+- spec/spec_helper.rb