econfig 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ba24341ee1636314ae2fa645edd20fddacedf8
-  data.tar.gz: 8741ff1333019ae2ef21773bedf700beb497a3e0
+  metadata.gz: b0662ed0e8cd53281753072640fe6b72f715410b
+  data.tar.gz: e32b3e83e8197a4c353e184f01ad91bdbf89248d
 SHA512:
-  metadata.gz: 8cdb9f56898c683166eb2fa29dc107fcba153e2daa0ea8358419504be251e39013339f9fd438835a368db05385bddc531fe391baac13923f3abff052f0c48f55
-  data.tar.gz: 6c1e783e2e0c2ba72ec2df956370da81269ee185faf6f1cec7bf2c92cb245bef4939eab20accaf7456e847a58b971c4c450170f770e980004579ef61b9b2f92e
+  metadata.gz: 3411a8decc879040d95eaff1124220939c735857777d35689d117cb6198893dae30a44e4d4144066bc427dd33bf021f827554599f507a647ac240265cd4ed742
+  data.tar.gz: ccb73c2eb936443fd533620a2bead57c656325897cd97becec2feaadcff048f757ec3403e0d34d1b96f8d093ee53f3e90b8decf189dfe2a7bc730a1d5b22bc4f

data/README.md

@@ -19,20 +19,36 @@ gem "econfig", require: "econfig/rails"
 
 ## Accessing config options
 
-Extend your main application module with the Econfig shortcut. In Rails, you'll
-want to add this in `config/application.rb`:
+Extend your main application module with the Econfig shortcut.
+
+In Rails, you'll want to add this in `config/application.rb`:
 
 ``` ruby
 module MyApp
   extend Econfig::Shortcut
 
   class Application < Rails::Application
-    …
+    # …
   end
 end
 ```
 
-Now you can access configuration like this:
+In a modular Sinatra application, extend your controller class and copy its settings to Econfig in `app.rb`:
+``` ruby
+require 'sinatra'
+require 'econfig'
+
+class MyApp < Sinatra::Base
+  extend Econfig::Shortcut
+
+  Econfig.env = settings.environment.to_s
+  Econfig.root = settings.root
+
+  # …
+end
+```
+
+In either case, you can now you can access configuration like this:
 
 ``` ruby
 MyApp.config.aws_access_key_id

data/lib/econfig.rb

@@ -16,7 +16,7 @@ module Econfig
 
     attr_accessor :root, :env, :instance
 
-    def_delegators :instance, :backends, :default_write_backend, :default_write_backend=
+    def_delegators :instance, :backends, :cast, :default_write_backend, :default_write_backend=
   end
 end
 

data/lib/econfig/active_record.rb

@@ -1,5 +1,16 @@
+require "active_record"
+
 module Econfig
   class ActiveRecord
+    MISSING_TABLE_WARNING = <<-WARNING.gsub(/^ */, "")
+      =======================================================================
+      Econfig table not found. Please add the configuration table by running:
+
+      rails generate econfig:migration
+      rake db:migrate
+      =======================================================================
+    WARNING
+
     class Option < ::ActiveRecord::Base
       attr_accessible :key, :value rescue nil
       self.table_name = "econfig_options"
@@ -7,13 +18,28 @@ module Econfig
       validates_presence_of :key
     end
 
+    def keys
+      Set.new(Option.pluck(:key))
+    rescue ::ActiveRecord::StatementInvalid
+      warn MISSING_TABLE_WARNING
+      Set.new([])
+    end
+
     def get(key)
-      Option.find_by_key(key).try(:value)
+      if option = Option.find_by_key(key)
+        option.value
+      else
+        yield if block_given?
+      end
+    rescue ::ActiveRecord::StatementInvalid
+      warn MISSING_TABLE_WARNING
     end
 
     def set(key, value)
       option = Option.where(:key => key).first_or_initialize
       option.update_attributes!(:value => value)
+    rescue ::ActiveRecord::StatementInvalid
+      warn MISSING_TABLE_WARNING
     end
   end
 end

data/lib/econfig/backend_collection.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 module Econfig
   class BackendCollection
     include Enumerable
@@ -6,6 +7,16 @@ module Econfig
       @backends = []
     end
 
+    def keys
+      @backends.reduce(Set.new) do |agg, (name, backend)|
+        if backend.respond_to?(:keys)
+          agg.union(backend.keys)
+        else
+          agg
+        end
+      end
+    end
+
     def [](name)
       pair = @backends.assoc(name)
       pair.last if pair
@@ -20,23 +31,23 @@ module Econfig
     end
 
     def push(name, backend)
-      exists‽(name)
+      exists?(name)
       @backends.push([name, backend])
     end
     alias_method :use, :push
 
     def unshift(name, backend)
-      exists‽(name)
+      exists?(name)
       @backends.unshift([name, backend])
     end
 
     def insert_before(other, name, backend)
-      exists‽(name)
+      exists?(name)
       @backends.insert(index_of!(other), [name, backend])
     end
 
     def insert_after(other, name, backend)
-      exists‽(name)
+      exists?(name)
       @backends.insert(index_of!(other) + 1, [name, backend])
     end
 
@@ -44,14 +55,27 @@ module Econfig
       @backends.delete_at(index_of!(name))
     end
 
-    def backend_for(key)
-      result = @backends.find { |(n, b)| b.has_key?(key) }
-      result[1] if result
+    def get(key)
+      @backends.each do |(name, backend)|
+        has_key = true
+
+        if backend.respond_to?(:has_key?)
+          has_key = backend.has_key?(key)
+          value = backend.get(key) if has_key
+        else
+          value = backend.get(key) { has_key = false }
+        end
+
+        has_key or next
+        return value
+      end
+
+      yield if block_given?
     end
 
   private
 
-    def exists‽(name)
+    def exists?(name)
       raise KeyError, "#{name} is already set" if index_of(name)
     end
 

data/lib/econfig/configuration.rb

@@ -2,27 +2,39 @@ module Econfig
   class Configuration
     attr_accessor :default_write_backend
 
-    def backends
+    attr_reader :backends, :casts
+
+    def initialize
       @backends ||= BackendCollection.new
+      @casts ||= {}
+    end
+
+    def cast(key, &block)
+      casts[key.to_s] = block
+    end
+
+    def keys
+      backends.keys
     end
 
     def fetch(key)
-      key = key.to_s
-      backend = backends.backend_for(key)
-      if backend
-        backend.get(key)
-      else
+      get(key) do
         raise Econfig::NotFound, "configuration key '#{key}' is not set"
       end
     end
 
-    def [](key)
+    def get(key)
       key = key.to_s
-      backend = backends.backend_for(key)
-      backend.get(key) if backend
+      value = backends.get(key) do
+        yield if block_given?
+        return nil
+      end
+      value = casts[key].call(value) if casts[key]
+      value
     end
+    alias_method :[], :get
 
-    def []=(backend_name = default_write_backend, key, value)
+    def set(backend_name = default_write_backend, key, value)
       raise ArgumentError, "no backend given" unless backend_name
       if backend = backends[backend_name]
         backend.set(key.to_s, value)
@@ -30,6 +42,7 @@ module Econfig
         raise KeyError, "#{backend_name} is not set"
       end
     end
+    alias_method :[]=, :set
 
     def method_missing(name, *args)
       if respond_to?(name)

data/lib/econfig/memory.rb

@@ -5,6 +5,10 @@ module Econfig
       @options = {}
     end
 
+    def keys
+      Set.new(@options.keys)
+    end
+
     def has_key?(key)
       @options.has_key?(key)
     end
@@ -18,5 +22,11 @@ module Econfig
         @options[key] = value
       end
     end
+
+    def clear
+      @mutex.synchronize do
+        @options.clear
+      end
+    end
   end
 end

data/lib/econfig/redis.rb

@@ -4,6 +4,10 @@ module Econfig
       @redis = redis
     end
 
+    def keys
+      Set.new(@redis.keys)
+    end
+
     def has_key?(key)
       @redis.exists(key)
     end

data/lib/econfig/version.rb

@@ -1,3 +1,3 @@
 module Econfig
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/econfig/yaml.rb

@@ -9,6 +9,10 @@ module Econfig
       @options = nil
     end
 
+    def keys
+      Set.new(options.keys)
+    end
+
     def get(key)
       options[key]
     end

data/spec/active_record_spec.rb

@@ -17,6 +17,15 @@ describe Econfig::ActiveRecord do
       raise ActiveRecord::Rollback
     end
   end
+
+  describe "#keys" do
+    it "returns a list of set keys" do
+      backend.set("foo", "123")
+      backend.set("bar", "664")
+      backend.keys.should eq(Set.new(["foo", "bar"]))
+    end
+  end
+
   describe "#get" do
     it "fetches a previously set option" do
       backend.set("foo", "bar")
@@ -31,6 +40,15 @@ describe Econfig::ActiveRecord do
     it "returns nil if option is not set" do
       backend.get("foo").should be_nil
     end
+
+    it "yields if option is not set" do
+      backend.get("foo") { "blah" }.should eq("blah")
+    end
+
+    it "ignores block if set" do
+      backend.set("foo", "bar")
+      backend.get("foo") { raise "blah" }.should eq("bar")
+    end
   end
 
   describe "#set" do

data/spec/configuration_spec.rb

@@ -1,6 +1,6 @@
 describe Econfig::Configuration do
-  let(:backend) { double }
-  let(:other_backend) { double }
+  let(:backend) { double("backend") }
+  let(:other_backend) { double("other backend") }
   let(:config) { Econfig::Configuration.new }
 
   before do
@@ -8,6 +8,19 @@ describe Econfig::Configuration do
     config.backends.push(:other, other_backend)
   end
 
+  describe "#keys" do
+    it "returns the union of all keys" do
+      backend.stub(:keys).and_return(Set.new(["foo", "bar", "baz"]))
+      other_backend.stub(:keys).and_return(Set.new(["bar", "monkey"]))
+      config.keys.should == Set.new(["foo", "bar", "baz", "monkey"])
+    end
+
+    it "skips over backends which don't return keys" do
+      other_backend.stub(:keys).and_return(Set.new(["bar", "monkey"]))
+      config.keys.should == Set.new(["bar", "monkey"])
+    end
+  end
+
   describe "#[]" do
     it "returns response from first backend" do
       backend.stub(:has_key?).with("foobar").and_return(true)
@@ -21,6 +34,19 @@ describe Econfig::Configuration do
       config[:foobar].should == "elephant"
     end
 
+    it "casts value if it exists" do
+      config.cast(:foobar) { |val| val.to_i + 10 }
+      backend.stub(:get).with("foobar").and_return("123")
+      config[:foobar].should == 133
+    end
+
+    it "does not cast if there is no value" do
+      config.cast(:foobar) { |val| raise "should not be here" }
+      backend.stub(:has_key?).with("foobar").and_return(false)
+      other_backend.stub(:has_key?).with("foobar").and_return(false)
+      config[:foobar].should == nil
+    end
+
     it "tries multiple backends until it finds a response" do
       backend.stub(:has_key?).with("foobar").and_return(false)
       other_backend.stub(:has_key?).with("foobar").and_return(true)
@@ -28,6 +54,12 @@ describe Econfig::Configuration do
       config["foobar"].should == "elephant"
     end
 
+    it "tries multiple backends which yield from get until it finds one which doesn't" do
+      backend.stub(:get).with("foobar").and_yield
+      other_backend.stub(:get).with("foobar").and_return("elephant")
+      config["foobar"].should == "elephant"
+    end
+
     it "returns nil if the key can't be found in any backend" do
       backend.stub(:has_key?).with("foobar").and_return(false)
       other_backend.stub(:has_key?).with("foobar").and_return(false)
@@ -69,6 +101,19 @@ describe Econfig::Configuration do
       config.fetch("foobar").should == "elephant"
     end
 
+    it "casts value if it exists" do
+      config.cast(:foobar) { |val| val.to_i + 10 }
+      backend.stub(:get).with("foobar").and_return("123")
+      config.fetch(:foobar).should == 133
+    end
+
+    it "does not cast if there is no value" do
+      config.cast(:foobar) { |val| raise "should not be here" }
+      backend.stub(:has_key?).with("foobar").and_return(false)
+      other_backend.stub(:has_key?).with("foobar").and_return(false)
+      expect { config.fetch("foobar") }.to raise_error(Econfig::NotFound)
+    end
+
     it "tries multiple backends until it finds a response" do
       backend.stub(:has_key?).with("foobar").and_return(false)
       other_backend.stub(:has_key?).with("foobar").and_return(true)

data/spec/env_spec.rb

@@ -5,6 +5,12 @@ describe Econfig::ENV do
     ENV["FOO_BAR"] = "monkey"
   end
 
+  describe "#keys" do
+    it "is not supported because it would return a lot of junk" do
+      backend.respond_to?(:keys).should be_falsy
+    end
+  end
+
   describe "#has_key?" do
     it "returns true if key exists" do
       backend.has_key?("foo_bar").should eq(true)

data/spec/memory_spec.rb

@@ -1,6 +1,14 @@
 describe Econfig::Memory do
   let(:backend) { Econfig::Memory.new }
 
+  describe "#keys" do
+    it "returns a list of set keys" do
+      backend.set("foo", "123")
+      backend.set("bar", "664")
+      backend.keys.should eq(Set.new(["foo", "bar"]))
+    end
+  end
+
   describe "#has_key?" do
     it "returns true if key exists" do
       backend.set("foo", "bar")
@@ -18,4 +26,12 @@ describe Econfig::Memory do
       backend.get("foo").should == "bar"
     end
   end
+
+  describe "#clear" do
+    it "clears all set keys" do
+      backend.set("foo", "bar")
+      backend.clear
+      backend.has_key?("foo").should be_falsy
+    end
+  end
 end

data/spec/redis_spec.rb

@@ -8,6 +8,14 @@ describe Econfig::Redis do
     redis.flushdb
   end
 
+  describe "#keys" do
+    it "returns a list of set keys" do
+      backend.set("foo", "123")
+      backend.set("bar", "664")
+      backend.keys.should eq(Set.new(["foo", "bar"]))
+    end
+  end
+
   describe "#has_key?" do
     it "returns true if key exists" do
       backend.set("foo", "bar")

data/spec/spec_helper.rb

@@ -2,3 +2,13 @@ require "econfig"
 
 Econfig.root = File.dirname(__FILE__)
 Econfig.env = "test"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+end

data/spec/yaml_spec.rb

@@ -1,6 +1,12 @@
 describe Econfig::YAML do
   let(:backend) { Econfig::YAML.new("config/app.yml") }
 
+  describe "#keys" do
+    it "returns keys set in backend" do
+      expect(backend.keys).to eq(Set.new(["quox", "envir"]))
+    end
+  end
+
   describe "#has_key?" do
     it "returns true if option exists" do
       expect(backend.has_key?("quox")).to eq(true)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: econfig
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Jonas Nicklas
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2018-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Congifure Ruby apps