anyway_config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c681a4243d4852f2ef8383624c6d2a8f1578b3a0
+  data.tar.gz: 4719dd86c4d8f21e55712861be1fd9c7e2691b57
+SHA512:
+  metadata.gz: 592cc0e754e5cd9568102b2bcd8e142c86c3b769bd262f0dfb3afc24ed853ca2ce70f854cf9e19fe7f7f980cb1bd761c68997b658f58cbb20c8f6794430b3777
+  data.tar.gz: 26524cbd6a105d6d59a5775e06b8324f665d2428df3a3129531a63b91894c97c93362997154c60cbdf9c119467600600f9fdd2b21b41ec243a0ef79470a8c5eb

data/.gitignore

@@ -0,0 +1,36 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+*.iml
+.idea/
+
+# Sublime
+*.sublime-project
+*.sublime-workspace
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+Thumbs.db
+
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/tmp/
+
+Gemfile.lock
+.rspec
+*.gem

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1
+
+gemfile:
+  - Gemfile
+
+matrix:
+  include:
+    - rvm: 2.0.0
+      gemfile: gemfiles/rails40.gemfile
+
+    - rvm: 2.1
+      gemfile: gemfiles/rails40.gemfile
+
+    - rvm: 2.1
+      gemfile: gemfiles/rails41.gemfile
+
+    - rvm: 2.1
+      gemfile: gemfiles/rails42.gemfile

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 palkan
+
+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,84 @@
+[![Build Status](https://travis-ci.org/palkan/anyway_config.svg?branch=master)](https://travis-ci.org/palkan/anyway_config)
+
+# Anyway Config
+
+Rails plugin configuration using any source: YAML, _secrets_, environment.
+
+Requires Rails 4.
+
+## Installation
+
+Configure your gemspec
+
+```ruby
+Gem::Specification.new do |s|
+  ...
+  s.add_dependancy 'anyway_config', "~>0.1"
+  ...
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anyway_config
+
+## Usage
+
+### Basic
+
+Create configuration class:
+
+```ruby
+module MyCoolGem
+  class Config < Anyway::Config
+    attr_config user: 'root', password: 'root', host: 'localhost'
+  end
+end
+```
+
+`attr_config` creates accessors and default values. If you don't need default values just write:
+
+```ruby
+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_*']`.  
+
+### Customize name
+
+If you want to load config params from, for example, "cool.yml" (secrets, env), just add one line:
+
+```ruby
+module MyCoolGem
+  class Config < Anyway::Config
+    config_name :cool
+    attr_config user: 'root', password: 'root', host: 'localhost', options: {}
+  end
+end
+```
+
+### 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.
+
+For example, if your module is called "MyCoolGem" then your env var "MYCOOLGEM_PASSWORD" is used as `config.password`.
+
+*Anyway Config* supports nested (_hashed_) environmental variables. Just separate keys with double-underscore.
+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
+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

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/anyway_config.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anyway/version'
+
+Gem::Specification.new do |s|
+  s.name        = "anyway_config"
+  s.version     = Anyway::VERSION
+  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.license     = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'rails', "~>4"
+
+  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"
+end

data/gemfiles/rails40.gemfile

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

data/gemfiles/rails41.gemfile

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

data/gemfiles/rails42.gemfile

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

data/lib/anyway.rb

@@ -0,0 +1,10 @@
+require "anyway/version"
+
+module Anyway
+  require "anyway/config"
+  require "anyway/env"
+
+  def self.env
+    @env ||= ::Anyway::Env.new
+  end
+end

data/lib/anyway/config.rb

@@ -0,0 +1,64 @@
+module Anyway
+  class Config
+    class << self
+      attr_reader :defaults, :config_attributes
+
+      def attr_config(*args,**hargs)
+        @defaults = hargs.dup.with_indifferent_access
+        @config_attributes = args+hargs.keys
+        attr_accessor *@config_attributes
+      end
+
+      def config_name(val = nil)
+        return (@config_name = val.to_s) unless val.nil?
+        @config_name ||= extract_name
+      end
+
+      private
+        def extract_name
+          self.name[/^(\w+)/].underscore
+        end
+    end
+
+    def initialize
+      load
+    end
+
+    def reload
+      clear
+      load
+      self
+    end 
+
+    def clear
+      self.class.config_attributes.each do |attr|
+        self.send("#{attr}=", nil)
+      end
+      self
+    end
+
+    def load
+      # first, copy defaults
+      config = self.class.defaults.deep_dup
+      config_name = self.class.config_name
+
+      # then load from YAML if any
+      config_path = Rails.root.join("config","#{config_name}.yml")
+      if File.file? config_path
+        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)||{})
+      end
+
+      # and then load from env
+      config.deep_merge! (Anyway.env.send(config_name) || {})
+
+      config.each do |key, val| 
+        self.send("#{key}=",val)
+      end
+    end
+  end
+end

data/lib/anyway/env.rb

@@ -0,0 +1,59 @@
+module Anyway
+  class Env
+    def initialize
+      @data = {}
+      load
+    end
+
+    def reload
+      clear
+      load
+      self
+    end
+
+    def clear
+      @data.clear
+      self
+    end
+
+    def method_missing(meth, *args, &block)
+      meth = meth.to_s.gsub(/\_/,'')
+      if args.empty? and @data.key?(meth)
+        @data[meth]
+      end
+    end
+
+    private
+      def load
+        ENV.each_pair do |key, val|
+          if config_key?(key)
+            mod, path = extract_module_path(key)
+            set_by_path(get_hash(@data, mod), path, val)
+          end
+        end
+      end
+    
+      def config_key?(key)
+        key =~ /^[A-Z\d]+\_[A-Z\d\_]+/
+      end
+
+      def extract_module_path(key)
+        _, mod, path = key.split(/^([^\_]+)/)
+        path.sub!(/^[\_]+/,'')
+        [mod.downcase, path.downcase]
+      end
+
+      def set_by_path(to, path, val)
+        parts = path.split("__")
+
+        while parts.length > 1
+          to = get_hash(to, parts.shift)
+        end
+        to[parts.first] = val        
+      end
+
+      def get_hash(from, name)
+        (from[name] ||= {}.with_indifferent_access)
+      end
+  end
+end

data/lib/anyway/version.rb

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

data/spec/config_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+describe Anyway::Config do
+  let(:conf) { CoolConfig.new }
+  let(:test_conf) { Anyway::TestConfig.new }
+
+  describe "config with name" do
+    specify { expect(CoolConfig.config_name).to eq "cool" }
+    
+    describe "defaults" do
+      specify { expect(CoolConfig.defaults[:port]).to eq 8080 }
+      specify { expect(CoolConfig.defaults[:host]).to eq 'localhost' }
+    end
+
+    specify do
+      expect(conf).to respond_to(:meta)
+      expect(conf).to respond_to(:data)
+      expect(conf).to respond_to(:port)
+      expect(conf).to respond_to(:host)
+      expect(conf).to respond_to(:user)
+    end
+
+    describe "load from files" do
+      it "should set defauls" do 
+        expect(conf.port).to eq 8080
+      end
+
+      it "should load config from YAML" do
+        expect(conf.host).to eq "test.host"
+      end
+
+      unless Rails.application.try(:secrets).nil?
+        it "should load config from secrets" do
+          expect(conf.user[:name]).to eq "test"
+          expect(conf.user[:password]).to eq "test"   
+        end
+      else
+        it "should load config from file if no secrets" do
+          expect(conf.user[:name]).to eq "root"
+          expect(conf.user[:password]).to eq "root"   
+        end
+      end
+    end
+
+    describe "load from env" do
+      after(:each) { Anyway.env.clear }
+      it "should work" do
+        ENV['COOL_PORT'] = '80'
+        ENV['COOL_USER__NAME'] = 'john'
+        Anyway.env.reload
+        expect(conf.port).to eq '80'
+        expect(conf.user[:name]).to eq 'john'
+      end
+    end
+
+    describe "clear" do
+      let(:conf_cleared) { conf.clear }
+
+      specify do
+        expect(conf_cleared.meta).to be_nil
+        expect(conf_cleared.data).to be_nil
+        expect(conf_cleared.host).to be_nil
+        expect(conf_cleared.user).to be_nil
+        expect(conf_cleared.port).to be_nil
+      end
+    end
+
+    describe "reload" do
+      after(:each) { Anyway.env.clear }
+      it do
+        expect(conf.port).to eq 8080
+        ENV['COOL_PORT'] = '80'
+        ENV['COOL_USER__NAME'] = 'john'
+        Anyway.env.reload
+        conf.reload
+        expect(conf.port).to eq '80'
+        expect(conf.user[:name]).to eq 'john'
+      end
+    end
+  end
+
+  describe "config with default name" do
+    after(:each) { Anyway.env.clear }
+    specify { expect(Anyway::TestConfig.config_name).to eq "anyway" }
+
+    specify do
+      expect(test_conf).to respond_to(:test)
+      expect(test_conf).to respond_to(:api)
+    end
+
+    it "should work" do
+      ENV['ANYWAY_API__KEY'] = 'test1'
+      ENV['ANYWAY_TEST'] = 'test'
+      Anyway.env.reload
+      expect(test_conf.api[:key]).to eq "test1"
+      expect(test_conf.test).to eq "test"
+    end
+  end
+end