config_reader 0.0.9 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae749330c14b4055e3f45286b3c30036f5e8eeee
+  data.tar.gz: 87e0b4ec76ad3f9a923bd0124732f8de3909c499
+SHA512:
+  metadata.gz: ce883b8f16a952fb8f9e459c43d2702e32f8f5c98fe2066b0363b3d676370926ef96b09380e97b5f65639a64e7699d49327e980840dc68d6e50e4e968bea9862
+  data.tar.gz: ddf297e0d4e4eb77f8e2d9b7af228c22b067034af11cd36ceaf3ed579ee8799b473ebf9598d10b213f21ce2bfb1f2cd7a4207f57cd36a7a767df97bd866703f8

data/.gitignore

@@ -1,2 +1,3 @@
+.bundle
 pkg
 *.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - '1.9.3'
+  - '2.0.0'
+  - '2.1.1'

data/Gemfile.lock

@@ -1,18 +1,45 @@
 PATH
   remote: .
   specs:
-    config_reader (0.0.9)
+    config_reader (1.0.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
+    arrayfields (4.9.2)
+    chronic (0.10.2)
+    coderay (1.1.0)
+    coerce (0.0.6)
+      chronic (>= 0.6.2)
+    fattr (2.2.2)
+    highline (1.6.21)
+    main (6.0.0)
+      arrayfields (>= 4.7.4)
+      chronic (>= 0.6.2)
+      fattr (>= 2.2.0)
+      map (>= 5.1.0)
+    map (6.5.3)
+    method_source (0.8.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rake (0.9.2.2)
     rspec (1.3.2)
+    sekrets (1.7.0)
+      coerce (>= 0.0.3)
+      fattr (>= 2.2.1)
+      highline (>= 1.6.15)
+      main (>= 5.1.1)
+      map (>= 6.3.0)
+    slop (3.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   config_reader!
+  pry
   rake
   rspec (= 1.3.2)
+  sekrets (~> 1.7.0)

data/README.rdoc

@@ -1,19 +1,21 @@
 = ConfigReader
 
+{<img src="https://codeclimate.com/github/UnderpantsGnome/config_reader-gem.png" />}[https://codeclimate.com/github/UnderpantsGnome/config_reader-gem] {<img src="https://travis-ci.org/UnderpantsGnome/config_reader-gem.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/UnderpantsGnome/config_reader-gem]
+
 Provides a way to manage environment specific configuration settings. It will use the defaults for any environment and override any values you specify for an environment.
 
 Example config file:
 
   defaults:
     site_url: http://localhost:3000
-    host_name: CHANGE-ME.com
-    mail_from: noreply@CHANGE_ME.com
-    site_name: CHANGE-ME
-    admin_email: admin@CHANGE-ME.com
+    host_name: example.com
+    mail_from: noreply@example.com
+    site_name: example
+    admin_email: admin@example.com
     blackbird: true
 
   production:
-    site_url: http://CHANGE-ME.com
+    site_url: http://example.com
     blackbird: false
 
   test:
@@ -25,13 +27,25 @@ Example class:
     self.config_file = 'config/my_config.yml'
   end
 
+== Sekrets
+Now also includes Sekrets integration. https://github.com/ahoward/sekrets
+
+The format of the sekrets file is the same as the regular file.
+
+Example class with Sekrets:
+
+  class MyConfig < ConfigReader
+    self.config_file = 'config/my_config.yml'
+    self.sekrets_file = 'config/my_config.yml.enc'
+  end
+
 Usage:
 
-  MyConfig.mail_from   #=> noreply@CHANGE_ME.com
-  MyConfig[:mail_from] #=> noreply@CHANGE_ME.com
+  MyConfig.mail_from   #=> noreply@example.com
+  MyConfig[:mail_from] #=> noreply@example.com
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/Rakefile

@@ -1,4 +1,4 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|

data/config_reader.gemspec

@@ -1,24 +1,26 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "config_reader/version"
+$:.push File.expand_path('../lib', __FILE__)
+require 'config_reader/version'
 
 Gem::Specification.new do |s|
-  s.name        = "config_reader"
+  s.name        = 'config_reader'
   s.version     = ConfigReader::VERSION
-  s.authors     = ["Michael Moen"]
-  s.email       = ["michael@underpantsgnome.com"]
-  s.homepage    = ""
+  s.authors     = ['Michael Moen']
+  s.email       = ['michael@underpantsgnome.com']
+  s.homepage    = ''
   s.summary     = %q{Provides a way to manage environment specific configuration settings.}
   s.description = %q{Provides a way to manage environment specific configuration settings.}
 
-  s.rubyforge_project = "config_reader"
+  s.rubyforge_project = 'config_reader'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   # specify any dependencies here; for example:
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec", "1.3.2"
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '1.3.2'
+  s.add_development_dependency 'sekrets', '~> 1.7.0'
+  s.add_development_dependency 'pry'
 end

data/lib/config_reader/version.rb

@@ -1,3 +1,3 @@
 class ConfigReader
-  VERSION = "0.0.9"
+  VERSION = "1.0.0"
 end

data/lib/config_reader.rb

@@ -9,10 +9,9 @@ rescue LoadError
 end
 
 class ConfigReader
-  @config_file = nil
-  @config = nil
-
   class << self
+    attr_accessor :config_file, :config, :sekrets_file
+
     def config
       @config = nil unless defined?(@config)
       @config ||= reload
@@ -23,27 +22,9 @@ class ConfigReader
     end
 
     def reload
-      raise 'No config file set' unless @config_file
-
-      if defined?(ERB)
-        conf = YAML.load(ERB.new(File.open(find_config).read).result)
-      else
-        conf = YAML.load(File.open(find_config).read)
-      end
-
-      raise 'No config found' unless conf
-
-      if defined?(Rails) && Rails.env
-        env = Rails.env
-      elsif defined?(RAILS_ENV)
-        env = RAILS_ENV
-      elsif defined?(APP_ENV)
-        env = APP_ENV
-      end
-
-      _conf = conf['defaults']
-      _conf.merge!(conf[env]) if conf[env]
-      ConfigReader::MagicHash.convert_hash(_conf)
+# require 'pry'
+# binding.pry
+      merge_configs(find_env, load_config, load_sekrets)
     end
 
     def [](key)
@@ -57,6 +38,7 @@ class ConfigReader
         config_file = File.join(dir, @config_file)
         return config_file if File.exist?(config_file)
       end
+
       ''
     end
 
@@ -67,5 +49,59 @@ class ConfigReader
     def inspect
       puts config.inspect
     end
+
+    def find_env
+      if defined?(Rails) && Rails.env
+        Rails.env
+      elsif defined?(RAILS_ENV)
+        RAILS_ENV
+      elsif defined?(Padrino) && Padrino.env
+        Padrino.env.to_s
+      elsif defined?(PADRINO_ENV)
+        PADRINO_ENV
+      elsif ENV['RACK_ENV']
+        ENV['RACK_ENV']
+      elsif defined?(APP_ENV)
+        APP_ENV
+      end
+    end
+
+    def load_config
+      raise 'No config file set' unless @config_file
+
+      if defined?(ERB)
+        conf = YAML.load(ERB.new(File.open(find_config).read).result)
+      else
+        conf = YAML.load(File.open(find_config).read)
+      end
+
+      raise 'No config found' unless conf
+
+      conf
+    end
+
+    def load_sekrets
+      sekrets = {}
+
+      if @sekrets_file
+        begin
+          require 'sekrets'
+          sekrets = ::Sekrets.settings_for(@sekrets_file)
+          raise 'No sekrets found' unless sekrets
+        rescue LoadError
+          $stderr.puts "You specified a sekrets_file, but the sekrets gem isn't available."
+        end
+      end
+
+      sekrets
+    end
+
+    def merge_configs(env, conf, sekrets)
+      _conf = conf['defaults']
+      _conf.merge!(sekrets['defaults']) if sekrets && sekrets['defaults']
+      _conf.merge!(conf[env]) if conf[env]
+      _conf.merge!(sekrets[env]) if sekrets && sekrets[env]
+      ConfigReader::MagicHash.convert_hash(_conf)
+    end
   end
 end

data/spec/config_reader_spec.rb

@@ -3,18 +3,18 @@ require 'spec_helper'
 describe "ConfigReader" do
   describe "parsing a YAML file" do
     it "should find values with method_missing" do
-      TestConfig.app_name.should == 'default_app'
+      TestConfig.app_name.should == 'test_app'
     end
 
     it "should find values using [] and a string" do
-      TestConfig['app_name'].should == 'default_app'
+      TestConfig['app_name'].should == 'test_app'
     end
 
     it "should find values using [] and a symbol" do
-      TestConfig[:app_name].should == 'default_app'
+      TestConfig[:app_name].should == 'test_app'
     end
 
-    it "should find nested values using using method_missing" do
+    it "should find nested values using method_missing" do
       TestConfig.nested_key.value.should == 'test'
     end
 
@@ -25,5 +25,60 @@ describe "ConfigReader" do
     it "should find nested values using [] and a string" do
       TestConfig['nested_key']['value'].should == 'test'
     end
+
+    it "should not find sekrets only nested values using method_missing" do
+      lambda { TestConfig.sekrets_only }.should raise_error
+    end
+
+    it "should not find sekrets only nested values using [] and a symbol" do
+      lambda { TestConfig[:sekrets_only][:value] }.should raise_error
+    end
+
+    it "should not find sekrets only nested values using [] and a string" do
+      lambda { TestConfig['sekrets_only']['value'] }.should raise_error
+    end
+
+  end
+
+  context 'using sekrets' do
+    ENV['SEKRETS_KEY'] = 'shhh'
+
+    describe "parsing a YAML file" do
+      it "should find values with method_missing" do
+        SekretsConfig.app_name.should == 'test_app_sekret'
+      end
+
+      it "should find values using [] and a string" do
+        SekretsConfig['app_name'].should == 'test_app_sekret'
+      end
+
+      it "should find values using [] and a symbol" do
+        SekretsConfig[:app_name].should == 'test_app_sekret'
+      end
+
+      it "should find nested values using method_missing" do
+        SekretsConfig.nested_key.value.should == 'test_sekret'
+      end
+
+      it "should find nested values using [] and a symbol" do
+        SekretsConfig[:nested_key][:value].should == 'test_sekret'
+      end
+
+      it "should find nested values using [] and a string" do
+        SekretsConfig['nested_key']['value'].should == 'test_sekret'
+      end
+
+      it "should find sekrets only nested values using method_missing" do
+        SekretsConfig.nested_key.value.should == 'test_sekret'
+      end
+
+      it "should find sekrets only nested values using [] and a symbol" do
+        SekretsConfig[:nested_key][:value].should == 'test_sekret'
+      end
+
+      it "should find sekrets only nested values using [] and a string" do
+        SekretsConfig['nested_key']['value'].should == 'test_sekret'
+      end
+    end
   end
 end

data/spec/sekrets_config.rb

@@ -0,0 +1,4 @@
+class SekretsConfig < ConfigReader
+  self.config_file = 'spec/test_config.yml'
+  self.sekrets_file = 'spec/sekrets_config.yml.enc'
+end

data/spec/spec_helper.rb

@@ -4,7 +4,7 @@ require 'spec'
 # require 'spec/autorun'
 require 'config_reader'
 require 'test_config'
+require 'sekrets_config'
 
-Spec::Runner.configure do |config|
-
-end
+ENV['RACK_ENV'] = 'test'
+ENV['SEKRETS_KEY'] = 'shhh'

data/spec/test_config.yml

@@ -1,8 +1,8 @@
---- 
+---
 defaults:
   app_name: default_app
-  nested_key: 
-    value: 'test'
+  nested_key:
+    value: test
 
 test:
   app_name: test_app

metadata

@@ -1,38 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: config_reader
 version: !ruby/object:Gem::Version
-  version: 0.0.9
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Michael Moen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-03 00:00:00.000000000Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70272720215240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70272720215240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70272720194600 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70272720194600
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+- !ruby/object:Gem::Dependency
+  name: sekrets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: Provides a way to manage environment specific configuration settings.
 email:
 - michael@underpantsgnome.com
@@ -40,7 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - History.rdoc
@@ -52,43 +86,38 @@ files:
 - lib/config_reader/magic_hash.rb
 - lib/config_reader/version.rb
 - spec/config_reader_spec.rb
-- spec/spec.opts
+- spec/sekrets_config.rb
+- spec/sekrets_config.yml.enc
 - spec/spec_helper.rb
 - spec/test_config.rb
 - spec/test_config.yml
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4112497528289826160
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4112497528289826160
 requirements: []
 rubyforge_project: config_reader
-rubygems_version: 1.8.10
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides a way to manage environment specific configuration settings.
 test_files:
 - spec/config_reader_spec.rb
-- spec/spec.opts
+- spec/sekrets_config.rb
+- spec/sekrets_config.yml.enc
 - spec/spec_helper.rb
 - spec/test_config.rb
 - spec/test_config.yml

data/spec/spec.opts

@@ -1 +0,0 @@
---colour