anyway_config 0.4.0 → 0.5.1.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 458041a187fa4057159e72a80b71b2f5c2110b18
-  data.tar.gz: e96284b36eea6da6390ea0ebf2e029f7ebda186c
+  metadata.gz: 2bccd0227df51b6e96f2036d7863eadd0b0bbc07
+  data.tar.gz: 70d571464f14b6881c9cfcafe5af9ad367e24161
 SHA512:
-  metadata.gz: 4b677bda47bc679d8d50b80a930904f13678ffb36533fc9ccbc05f1e5dd39d549173995abd532dc47b7a70958fe7f381e423a6b77524a0fbcec69ebaa649c481
-  data.tar.gz: a9ca0a93fbfc54679a06665a0b67ce9b9fa8be644a62c81be196c392cf511d01a4e3a54eaf68ea07de7591eb5e3bace8acb6a221761225e191c64c243c329047
+  metadata.gz: 38d485231332fdb6d4be36a5a12a20eef21d0c4cbbfdb9077c2a5454998b36ed4c1ff4cfd522b0e91bb5bb3f97fd118f8df47ff1a20c42d85f2fdd452bd364ab
+  data.tar.gz: 1e52529cd706d22621e6ef6d50fe2605f727d92c6d8b643ba17224745a40c4e6b0b4f4b448b2e9b83cf5e7d80353278ea55516c8b0a1d039699a2cce28505e31

data/.gitignore

@@ -32,5 +32,8 @@ spec/dummy/db/*.sqlite3-journal
 spec/dummy/tmp/
 
 Gemfile.lock
+Gemfile.local
 .rspec
-*.gem
+*.gem
+
+tmp/

data/.rubocop.yml

@@ -0,0 +1,38 @@
+AllCops:
+  Include:
+    - 'lib/**/*.rb'
+    - 'lib/**/*.rake'
+    - 'spec/**/*.rb'
+    - 'Gemfile'
+    - 'Rakefile'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/dummy/**/*'
+    - 'tmp/**/*'
+    - 'gemfiles/vendor/**/*'
+    - 'vendor/**/*'
+  DisplayCopNames: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.3
+
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/StringLiterals: 
+  Enabled: false
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -1,33 +1,26 @@
 language: ruby
 cache: bundler
-rvm:
-  - 2.2
+
+dist: trusty
+sudo: false
 
 notifications:
   email: false
 
-matrix:
-  allow_failures:
-    - rvm: :jruby
+before_install:
+  - gem install bundler
+  - gem update bundler
 
+matrix:
   include:
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails32.gemfile
-
-    - rvm: jruby
-      gemfile: gemfiles/rails32.gemfile
-
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails40.gemfile
-
-    - rvm: 2.1
-      gemfile: gemfiles/rails40.gemfile
-
-    - rvm: jruby
-      gemfile: gemfiles/rails41.gemfile
-
-    - rvm: 2.1
-      gemfile: gemfiles/rails41.gemfile
-
-    - rvm: 2.1
-      gemfile: gemfiles/rails42.gemfile
+    - rvm: ruby-head
+      gemfile: gemfiles/railsmaster.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails5.gemfile
+    - rvm: 2.3.1
+      gemfile: gemfiles/rails42.gemfile
+    - rvm: 2.2.3
+      gemfile: gemfiles/rails42.gemfile
+  allow_failures:
+    - rvm: ruby-head
+      gemfile: gemfiles/railsmaster.gemfile

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Change log
+
+## 1.0.0 (2017-06-20)
+
+- Lazy load and parse ENV configurtaion (https://github.com/palkan/anyway_config/commit/5fe407c75fefec8994ca201ea7b4691b5ddd96e5). ([@palkan][])
+
+- Add support for ERB in YML configuration (https://github.com/palkan/anyway_config/commit/8d8a47dbda6858a43ff509aaa4cddf4f938dd660). ([@palkan][])
+
+## 0.5.0 (2017-01-20)
+
+- Drop `active_support` dependency. ([@palkan][])
+
+Use custom refinements instead of requiring `active_support`.
+
+No we're dependency-free!
+
+## 0.1.0 (2015-01-20)
+
+Initial version.
+
+[@palkan]: https://github.com/palkan

data/Gemfile

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in anyway_config.gemspec
-gem 'rails', '~> 4.2'
-gem 'pry-byebug'
 gem 'sqlite3'
-gemspec
+gemspec
+
+local_gemfile = "#{File.dirname(__FILE__)}/Gemfile.local"
+
+if File.exist?(local_gemfile)
+  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
+else
+  gem 'rails', '~> 5.0'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 palkan
+Copyright (c) 2017 palkan
 
 MIT License
 

data/README.md

@@ -1,39 +1,52 @@
-[![Build Status](https://travis-ci.org/palkan/anyway_config.svg?branch=master)](https://travis-ci.org/palkan/anyway_config)
+[![Gem Version](https://badge.fury.io/rb/anyway_config.svg)](https://rubygems.org/gems/anyway_config) [![Build Status](https://travis-ci.org/palkan/anyway_config.svg?branch=master)](https://travis-ci.org/palkan/anyway_config)
 
 # Anyway Config
 
-Rails/Ruby plugin/application configuration using any source: YAML, _secrets_, environment.
+Rails/Ruby plugin/application configuration tool which allows you to load parameters from different sources: YAML, Rails secrets, environment.
 
+Apps using AnywayConfig:
 
-Apps using Anyway Config: 
-- [influxer](https://github.com/palkan/influxer).
+- [Influxer](https://github.com/palkan/influxer)
 
-## Using with Gem
+- [AnyCable](https://github.com/anycable/anycable)
 
-Configure your gemspec
+- [and others](https://github.com/palkan/anyway_config/network/dependents).
+
+## Installation
+
+1) Adding to a gem:
 
 ```ruby
-Gem::Specification.new do |s|
+# my-cool-gem.gemspec
+Gem::Specification.new do |spec|
   ...
-  s.add_dependancy 'anyway_config', "~>0.4"
+  spec.add_dependancy "anyway_config", "~> 1.0"
   ...
 end
 ```
 
-And then execute:
+2) Adding to your project:
 
-    $ bundle
+```ruby
+# Gemfile
+gem "anyway_config", "~> 1.0"
+```
 
-Or install it yourself as:
+3) Install globally:
 
-    $ gem install anyway_config
+```sh
+$ gem install anyway_config
+```
 
-### Usage
+## Usage
+
+### Pre-defined configuration
 
 Create configuration class:
 
 ```ruby
 require 'anyway'
+
 module MyCoolGem
   class Config < Anyway::Config
     attr_config user: 'root', password: 'root', host: 'localhost'
@@ -47,11 +60,21 @@ end
 attr_config :user, :password, host: 'localhost'
 ```
 
-Your config will be filled up with values from `RAILS_ROOT/config/my_cool_gem.yml`, `Rails.application.secrets.my_cool_gem` (if using Rails) and `ENV['MYCOOLGEM_*']`.  
+Then create an instance of the config class and use it:
+
+```ruby
+module MyCoolGem
+  def self.config
+    @config ||= Config.new
+  end
+end
+
+MyCoolGem.config.user #=> 'root'
+```
 
-### Customize name
+#### Customize name
 
-If you want to load config params from, for example, "cool.yml" (secrets, env), just add one line:
+By default, AnywayConfig uses the namespace (the outer module name) as the config name, but you can set it manually:
 
 ```ruby
 module MyCoolGem
@@ -62,30 +85,41 @@ module MyCoolGem
 end
 ```
 
-### Config clear and reload
+### Dynamic configuration
 
-You can use `clear` and `reload` functions on your config (which do exactly what they state).
+You can also create configuration objects without pre-defined schema (just like `Rails.application.config_for` but more [powerful](#railsapplicationconfig_for-vs-anywayconfigfor)):
 
+```ruby
+# load data from config/my_app.yml, secrets.my_app (if using Rails), ENV["MYAPP_*"]
+config = Anyway::Config.for(:my_app)
+```
 
-## Using with Rails app
+### Using with Rails
 
-In your Gemfile
+Your config will be filled up with values from the following sources (ordered by priority from low to high):
 
-```ruby
-require 'anyway_config', "~>0.4"
-```
+- `RAILS_ROOT/config/my_cool_gem.yml` (for the current `RAILS_ENV`, supports `ERB`)
 
-In your code
+- `Rails.application.secrets.my_cool_gem`
 
-```ruby
+- `ENV['MYCOOLGEM_*']`.
 
-config = Anyway::Config.for(:my_app) # load data from config/my_app.yml, secrets.my_app, ENV["MYAPP_*"]
+### Using with Ruby
+
+By default AnywayConfig is looking for a config YAML at `./config/<config-name>.yml`. You can override this setting
+through special environment variable – 'MYGEM_CONF' – containing the path to the YAML file.
+
+Environmental variables work the same way as with Rails. 
+
+
+### Config clear and reload
+
+There are `#clear` and `#reload` functions on your config (which do exactly what they state).
 
-```
 
 ## `Rails.application.config_for` vs `Anyway::Config.for`
 
-Rails 4.2 introduces new feature: `Rails.application.config_for`. It looks very similar to 
+Rails 4.2 introduced new feature: `Rails.application.config_for`. It looks very similar to 
 `Anyway::Config.for`, but there are some differences:
 
 | Feature       | Rails         | Anyway  |
@@ -94,27 +128,33 @@ Rails 4.2 introduces new feature: `Rails.application.config_for`. It looks very
 | load data from `secrets`      | no      |   yes |
 | load data from environment | no   |   yes |
 | return Hash with indifferent access | no | yes | 
-| support ERB within `config/app.yml` | yes | no |
+| support ERB within `config/app.yml` | yes | yes* |
 | raise errors if file doesn't exist | yes | no |
 
-But the main advantage of Anyway::Config is that it's supported in Rails >= 3.2, Ruby >= 1.9.3.
-And it can be even used [without Rails](#using-without-rails)!
+<sub><sup>*</sup>make sure that ERB is loaded</sub>
+
+But the main advantage of Anyway::Config is that it can be used [without Rails](#using-with-ruby)!)
 
 ## How to set env vars
 
-Environmental variables for your config should start with your module name (or config name if any), uppercased and underscore-free.
+Environmental variables for your config should start with your config name, uppercased and underscore-free.
+
+For example, if your module is called "MyCoolGem" then the env var "MYCOOLGEM_PASSWORD" is used as `config.password`.
 
-For example, if your module is called "MyCoolGem" then your env var "MYCOOLGEM_PASSWORD" is used as `config.password`.
+Environment variables are type-casted (case-insensitive).
 
-Environment variables are type-casted (case-insensitive). 
 Examples:
-- "True", "T" and "yes" to `true`;
-- "False", "f" and "no" to `false`;
-- "nil" and "null" to `nil` (do you really need it?);
-- "123" to 123 and "3.14" to 3.14.
 
-*Anyway Config* supports nested (_hashed_) environmental variables. Just separate keys with double-underscore.
-For example, "MYCOOLGEM_OPTIONS__VERBOSE" is transformed to `config.options.verbose`.
+- `"True"`, `"t"` and `"yes"` to `true`;
+
+- `"False"`, `"f"` and `"no"` to `false`;
+
+- `"nil"` and `"null"` to `nil` (do you really need it?);
+
+- `"123"` to 123 and `"3.14"` to 3.14.
+
+*Anyway Config* supports nested (_hashed_) env variables. Just separate keys with double-underscore.
+For example, "MYCOOLGEM_OPTIONS__VERBOSE" is parsed as `config.options.verbose`.
 
 Array values are also supported:
 
@@ -123,21 +163,16 @@ Array values are also supported:
 config.ids #=> [1,2,3]
 ```
 
-If you want to provide text-like env variable which contain commas then wrap it into quotes:
+If you want to provide a text-like env variable which contains commas then wrap it into quotes:
 
 ```ruby
 MYCOOLGEM="Nif-Nif, Naf-Naf and Nouf-Nouf"
 ```
 
-## Using without Rails
-
-AnywayConfig can be used without Rails too. 
-Environmental variables remain the same. To load config from YAML add special environment variable 'MYGEM_CONF' containing path to config. But you cannot use one file for different environments (unless you do it yourself).
-
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+5. Create a new Pull Request

data/Rakefile

@@ -1,10 +1,23 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task(:spec).clear
+desc "Run specs with Rails app"
+RSpec::Core::RakeTask.new("spec") do |task|
+  task.exclude_pattern = "spec/**/*_norails.rb"
+  task.verbose = false
+end
 
-RSpec::Core::RakeTask.new(:spec2) do |t|
-  t.pattern = "./spec/**/*_norails.rb"
+desc "Run acceptance specs without Rails"
+RSpec::Core::RakeTask.new("spec:norails") do |task|
+  task.pattern = "spec/**/*_norails.rb"
+  task.verbose = false
 end
 
-task :default => [:spec2, :spec]
+desc "Run the all specs and linters"
+task default: %w[spec:norails spec rubocop]

data/anyway_config.gemspec

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'anyway/version'
@@ -6,21 +8,23 @@ require 'anyway/version'
 Gem::Specification.new do |s|
   s.name        = "anyway_config"
   s.version     = Anyway::VERSION
-  s.authors     = ["Vlad Dem"]
+  s.authors     = ["Vladimir Dementyev"]
   s.email       = ["dementiev.vm@gmail.com"]
   s.homepage    = "http://github.com/palkan/anyway_config"
-  s.summary     = "Configuration for Rails plugins and applications"
-  s.description = "Configuration for Rails plugins and applications"
-  s.license     = "MIT"
+  s.summary     = "Configuration DSL for Ruby libraries and applications"
+  s.description = %{
+    Configuration DSL for Ruby libraries and applications.
 
-  s.files         = `git ls-files`.split($/)
-  s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 1.9.3'
+    Allows you to easily follow the twevle factor application principles (https://12factor.net/config).
+  }
 
-  s.add_dependency "activesupport", ">= 3.2"
+  s.license = "MIT"
+
+  s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 2'
 
-  s.add_development_dependency 'pry'
   s.add_development_dependency "simplecov", ">= 0.3.8"
-  s.add_development_dependency "rspec", "~> 3.0.0"
-  s.add_development_dependency "rspec-rails", "~> 3.0.0"
+  s.add_development_dependency "rspec", "~> 3.5.0"
+  s.add_development_dependency "rubocop", "~> 0.49"
 end