anyway_config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c681a4243d4852f2ef8383624c6d2a8f1578b3a0
-  data.tar.gz: 4719dd86c4d8f21e55712861be1fd9c7e2691b57
+  metadata.gz: 40e4e0dd7f4d5e1fb19d83de0755be5f0054ac2f
+  data.tar.gz: 555132629ca863a88d84ba53ee9cfd6ce02a2fad
 SHA512:
-  metadata.gz: 592cc0e754e5cd9568102b2bcd8e142c86c3b769bd262f0dfb3afc24ed853ca2ce70f854cf9e19fe7f7f980cb1bd761c68997b658f58cbb20c8f6794430b3777
-  data.tar.gz: 26524cbd6a105d6d59a5775e06b8324f665d2428df3a3129531a63b91894c97c93362997154c60cbdf9c119467600600f9fdd2b21b41ec243a0ef79470a8c5eb
+  metadata.gz: 31e46f769ef2a2e550f195232c0fe76e127fc567d56de1c6a1d14e6c0f77e99a05c6f956746ca96a0647ad3edfd74e1d0f5e2301ab1c4f5af9dcc8ce119c939f
+  data.tar.gz: f19f0adfe0d2827c14c4ff83b718ae06f13a2614103dcc4e86cc5cfc5de91dbf4be5f36d885ea57f5cb1a862eca04a60f6e8eed8297eda368bfe2103a368eeb0

data/.travis.yml

@@ -1,20 +1,31 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0.0
-  - 2.1
+  - 2.2
 
-gemfile:
-  - Gemfile
+notifications:
+  email: false
 
 matrix:
+  allow_failures:
+    - rvm: :jruby
+
   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
 

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in anyway_config.gemspec
+gem 'rails', '~> 4.2'
+gem 'pry-byebug'
+gem 'sqlite3'
 gemspec

data/README.md

@@ -2,11 +2,13 @@
 
 # Anyway Config
 
-Rails plugin configuration using any source: YAML, _secrets_, environment.
+Rails plugin/application configuration using any source: YAML, _secrets_, environment.
 
-Requires Rails 4.
 
-## Installation
+Apps using Anyway Config: 
+- [influxer](https://github.com/palkan/influxer).
+
+## Using with Gem
 
 Configure your gemspec
 
@@ -26,13 +28,12 @@ Or install it yourself as:
 
     $ gem install anyway_config
 
-## Usage
-
-### Basic
+### Usage
 
 Create configuration class:
 
 ```ruby
+require 'anyway'
 module MyCoolGem
   class Config < Anyway::Config
     attr_config user: 'root', password: 'root', host: 'localhost'
@@ -61,7 +62,44 @@ module MyCoolGem
 end
 ```
 
-### How to set env vars
+### Config clear and reload
+
+You can use `clear` and `reload` functions on your config (which do exactly what they state).
+
+
+## Using with Rails app
+
+In your Gemfile
+
+```ruby
+require 'anyway_config', "~>0.2"
+```
+
+In your code
+
+```ruby
+
+config = Anyway::Config.for(:my_app) # load data from config/my_app.yml, secrets.my_app, ENV["MYAPP_*"]
+
+```
+
+## `Rails.application.config_for` vs `Anyway::Config.for`
+
+Rails 4.2 introduces new feature: `Rails.application.config_for`. It looks very similar to 
+`Anyway::Config.for`, but there are some differences:
+
+| Feature       | Rails         | Anyway  |
+| ------------- |:-------------:| -----:|
+| load data from `config/app.yml`     | yes | yes |
+| 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 |
+| 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.
+
+## 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.
 
@@ -71,10 +109,6 @@ For example, if your module is called "MyCoolGem" then your env var "MYCOOLGEM_P
 For example, "MYCOOLGEM_OPTIONS__VERBOSE" is transformed to `config.options.verbose`.
 
 
-### Config clear and reload
-
-You can use `clear` and `reload` functions on your config (which do exactly what they state).
-
 ## Contributing
 
 1. Fork it

data/anyway_config.gemspec

@@ -9,18 +9,15 @@ Gem::Specification.new do |s|
   s.authors     = ["Vlad Dem"]
   s.email       = ["dementiev.vm@gmail.com"]
   s.homepage    = "http://github.com/palkan/anyway_config"
-  s.summary     = "Configuration for Rails plugins"
-  s.description = "Configuration for Rails plugins"
+  s.summary     = "Configuration for Rails plugins and applications"
+  s.description = "Configuration for Rails plugins and applications"
   s.license     = "MIT"
 
   s.files         = `git ls-files`.split($/)
   s.require_paths = ["lib"]
-  
-  s.add_dependency 'rails', "~>4"
+  s.required_ruby_version = '>= 1.9.3'
 
-  s.add_development_dependency 'sqlite3'
   s.add_development_dependency 'pry'
-  s.add_development_dependency 'pry-byebug'
   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"

data/gemfiles/rails32.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'sqlite3', platform: :mri
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'rails', '~> 3.2'
+
+gemspec path: '..'

data/lib/anyway/config.rb

@@ -3,7 +3,7 @@ module Anyway
     class << self
       attr_reader :defaults, :config_attributes
 
-      def attr_config(*args,**hargs)
+      def attr_config(*args,hargs)
         @defaults = hargs.dup.with_indifferent_access
         @config_attributes = args+hargs.keys
         attr_accessor *@config_attributes
@@ -14,14 +14,25 @@ module Anyway
         @config_name ||= extract_name
       end
 
+      # Load config as Hash by any name
+      #
+      # Example:
+      #   
+      #   my_config = Anyway::Config.for(:my_app) 
+      #   # will load data from config/my_app.yml, secrets.my_app, ENV["MY_APP_*"] 
+      def for(name)
+        self.new(name,false).load_from_sources
+      end
+
       private
         def extract_name
           self.name[/^(\w+)/].underscore
         end
     end
 
-    def initialize
-      load
+    def initialize(config_name=nil, do_load=true)
+      @config_name = config_name || self.class.config_name
+      load if do_load
     end
 
     def reload
@@ -38,27 +49,28 @@ module Anyway
     end
 
     def load
-      # first, copy defaults
-      config = self.class.defaults.deep_dup
-      config_name = self.class.config_name
+      config = load_from_sources self.class.defaults.deep_dup
+      config.each do |key, val| 
+        self.send("#{key}=",val)
+      end
+    end
 
+    def load_from_sources(config={}.with_indifferent_access)        
       # then load from YAML if any
-      config_path = Rails.root.join("config","#{config_name}.yml")
+      config_path = Rails.root.join("config","#{@config_name}.yml")
       if File.file? config_path
+        require 'yaml'
         config.deep_merge! (YAML.load_file(config_path)[Rails.env] || {})
       end
 
       # then load from Rails secrets
-      unless Rails.application.try(:secrets).nil?
-        config.deep_merge! (Rails.application.secrets.send(config_name)||{})
+      if Rails.application.respond_to?(:secrets)
+        config.deep_merge! (Rails.application.secrets.send(@config_name)||{})
       end
 
       # and then load from env
-      config.deep_merge! (Anyway.env.send(config_name) || {})
-
-      config.each do |key, val| 
-        self.send("#{key}=",val)
-      end
+      config.deep_merge! (Anyway.env.send(@config_name) || {})
+      config
     end
   end
 end

data/lib/anyway/version.rb

@@ -1,3 +1,3 @@
 module Anyway
-  VERSION = "0.1.0"
-end
+  VERSION = "0.2.0"
+end

data/spec/config_spec.rb

@@ -29,7 +29,7 @@ describe Anyway::Config do
         expect(conf.host).to eq "test.host"
       end
 
-      unless Rails.application.try(:secrets).nil?
+      if Rails.application.respond_to?(:secrets)
         it "should load config from secrets" do
           expect(conf.user[:name]).to eq "test"
           expect(conf.user[:password]).to eq "test"   
@@ -96,4 +96,19 @@ describe Anyway::Config do
       expect(test_conf.test).to eq "test"
     end
   end
+
+  describe "config for name" do
+    after(:each) { Anyway.env.clear }
+    it "should load data by config name" do
+      ENV['MYAPP_TEST'] = '1'
+      ENV['MYAPP_NAME'] = 'my_app'
+      Anyway.env.reload
+      data = Anyway::Config.for(:my_app)
+      expect(data[:test]).to eq '1'
+      expect(data[:name]).to eq 'my_app'
+      if Rails.application.respond_to?(:secrets)
+        expect(data[:secret]).to eq 'my_secret' 
+      end
+    end
+  end
 end

data/spec/dummy/config/environments/test.rb

@@ -13,7 +13,7 @@ Dummy::Application.configure do
   config.eager_load = false
 
   # Configure static asset server for tests with Cache-Control for performance.
-  config.serve_static_assets  = true
+  config.serve_static_files  = true
   config.static_cache_control = 'public, max-age=3600'
 
   # Show full error reports and disable caching.

data/spec/dummy/config/secrets.yml

@@ -19,6 +19,9 @@ test:
     user:
       name: test
       password: test
+  my_app:
+    name: 'app'
+    secret: 'my_secret'
 
 # Do not keep production secrets in the repository,
 # instead read values from the environment.

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: anyway_config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Vlad Dem
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Configuration for Rails plugins
+description: Configuration for Rails plugins and applications
 email:
 - dementiev.vm@gmail.com
 executables: []
@@ -122,6 +80,7 @@ files:
 - README.md
 - Rakefile
 - anyway_config.gemspec
+- gemfiles/rails32.gemfile
 - gemfiles/rails40.gemfile
 - gemfiles/rails41.gemfile
 - gemfiles/rails42.gemfile
@@ -189,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -200,5 +159,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Configuration for Rails plugins
+summary: Configuration for Rails plugins and applications
 test_files: []