reconfig 0.1.0

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Chris Maddox
+
+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,2 @@
+# Reconfig
+Redis configuration management

data/lib/reconfig.rb

@@ -0,0 +1,75 @@
+require 'set'
+require 'forwardable'
+require 'reconfig/type_mapper'
+require 'reconfig/redis_client'
+require 'reconfig/namespace'
+require 'reconfig/configuration'
+
+module Reconfig
+  class << self
+    extend Forwardable
+    delegate [:prefix, :meta_key] => :configuration
+
+    def configure
+      yield configuration if block_given?
+      apply_configuration
+    end
+
+    def [](namespace)
+      namespaces[namespace]
+    end
+
+    def refresh
+      read_namespaces
+    end
+
+    def respond_to?(method)
+      namespaces.keys.include?(method) || super
+    end
+
+    def method_missing(method, *args, &block)
+      if namespaces.keys.include? method.to_sym
+         return namespaces[method.to_sym]
+      end
+
+      super
+    end
+
+    private
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def redis_client
+      @redis_client ||= RedisClient.new
+    end
+
+    def apply_configuration
+      register_namespaces
+    end
+
+    def register_namespaces
+      configuration.namespaces.each do |namespace_name|
+        redis_client.sadd(meta_key, namespace_name)
+      end
+    end
+
+    def namespaces
+      @namespaces ||= read_namespaces
+    end
+
+    def read_namespaces
+      @namespaces = begin
+        redis_client.smembers(meta_key).reduce({}) do |namespaces, namespace_name|
+          namespaces[namespace_name.to_sym] = Namespace.new(namespace_key(namespace_name))
+          namespaces
+        end
+      end
+    end
+
+    def namespace_key(namespace_name)
+      configuration.prefix + namespace_name.to_s
+    end
+  end
+end

data/lib/reconfig/configuration.rb

@@ -0,0 +1,17 @@
+module Reconfig
+  class Configuration
+    attr_writer :namespaces, :meta_key, :prefix
+
+    def namespaces
+      @namespaces ||= []
+    end
+
+    def meta_key
+      @meta_key ||= "#{prefix}_meta"
+    end
+
+    def prefix
+      @prefix ||= 'reconf:'
+    end
+  end
+end

data/lib/reconfig/namespace.rb

@@ -0,0 +1,68 @@
+module Reconfig
+  class Namespace
+
+    attr_accessor :meta_key, :options
+
+    def initialize(meta_key, opts={})
+      @meta_key = meta_key
+      @options = {
+        prefix: meta_key + ':'
+      }.merge opts
+    end
+
+    def config
+      @config ||= refresh_config
+    end
+
+    def refresh
+      refresh_keyspace
+      refresh_config
+    end
+
+    def [](key)
+      config[key]
+    end
+
+    def []=(key, value)
+      set(key, value)
+      config[key] = value
+    end
+
+    private
+
+    def key_space
+      @keyspace ||= refresh_keyspace
+    end
+
+    def refresh_keyspace
+      @keyspace = redis_client.zrange(meta_key, 0, -1, with_scores: true)
+    end
+
+    def refresh_config
+      @config = key_space.reduce({}) do |config_hash, (stored_key, value_type)|
+        namespaced_key = namespaced_key(stored_key)
+        config_hash[stored_key] = redis_client.fetch_by_type(namespaced_key, value_type)
+        config_hash
+      end
+    end
+
+    def set(key, value)
+      stored_type = type_mapper.stored_type(value)
+      redis_client.set_by_type(namespaced_key(key), value)
+      redis_client.zadd(meta_key, stored_type, key)
+    end
+
+    def namespaced_key(key)
+      options[:prefix] + key.to_s
+    end
+
+    def redis_client
+      @redis_client ||= RedisClient.new
+    end
+
+    def type_mapper
+      @type_mapper ||= TypeMapper.new
+    end
+
+  end
+end

data/lib/reconfig/redis_client.rb

@@ -0,0 +1,66 @@
+require 'redis'
+module Reconfig
+  class RedisClient
+
+    def fetch_by_type(key, stored_type)
+      case stored_type
+        when type_mapper.string
+          connection.get(key)
+        when type_mapper.integer
+          connection.get(key).to_i
+        when type_mapper.float
+          connection.get(key).to_f
+        when type_mapper.hash
+          connection.hgetall(key)
+        when type_mapper.list
+          connection.lrange(key, 0, -1)
+        when type_mapper.set
+          connection.smembers(key)
+        else
+          raise UnknownTypeException.new("#{stored_type} is not a valid type.")
+      end
+    end
+
+    # Overwrites associated value
+    def set_by_type(key, value)
+      case type_mapper.stored_type(value)
+        when type_mapper.string, type_mapper.integer, type_mapper.float
+          connection.set(key, value)
+        when type_mapper.hash
+          connection.del key
+          connection.hmset(key, *value.to_a.flatten)
+        when type_mapper.list
+          connection.del key
+          connection.rpush key, *value
+        when type_mapper.set
+          connection.del key
+          connection.sadd key, *value
+        else
+          raise UnknownTypeException.new("Unable to store type #{value.class.name}.")
+      end
+    end
+
+    def respond_to?(method)
+      connection.respond_to?(method) || super
+    end
+
+    def method_missing(method, *args, &block)
+      if connection.respond_to?(method)
+        return connection.send(method, *args, &block)
+      end
+      super
+    end
+
+    private
+
+    def connection
+      connection = Redis.new
+    end
+
+    def type_mapper
+      TypeMapper.new
+    end
+  end
+end
+
+class UnknownTypeException < Exception; end

data/lib/reconfig/type_mapper.rb

@@ -0,0 +1,53 @@
+require 'set'
+module Reconfig
+  class TypeMapper
+
+    def stored_type(value)
+      case value
+      when String
+        string
+      when Integer
+        integer
+      when Float
+        float
+      when Hash
+        hash
+      when Array
+        list
+      when Set
+        set
+      else
+        raise UnknownTypeException.new("Cannot map #{value.class.name}.")
+      end
+    end
+
+    # Redis stores SCORES as floats, so types must be floats
+
+    def string
+      1.0
+    end
+
+    def integer
+      2.0
+    end
+
+    def float
+      3.0
+    end
+
+    def hash
+      4.0
+    end
+
+    def list
+      5.0
+    end
+
+    def set
+      6.0
+    end
+
+  end
+end
+
+class UnknownTypeException < Exception; end

data/lib/reconfig/version.rb

@@ -0,0 +1,18 @@
+module Reconfig
+  class Version
+    MAJOR = 0 unless defined? MAJOR
+    MINOR = 1 unless defined? MINOR
+    PATCH = 0 unless defined? PATCH
+    PRE = nil unless defined? PRE
+
+    class << self
+
+      # @return [String]
+      def to_s
+        [MAJOR, MINOR, PATCH, PRE].compact.join('.')
+      end
+
+    end
+
+  end
+end

data/reconfig.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'reconfig/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'redis', '= 3.0.5'
+  spec.authors     = ['Chris Maddox']
+  spec.date        = '2013-10-02'
+  spec.description = 'Redis configuration management.'
+  spec.email       = 'chris@zenpayroll.com'
+  spec.files       = %w(LICENSE.md README.md reconfig.gemspec)
+  spec.files      += Dir.glob('lib/**/*.rb')
+  spec.files      += Dir.glob('spec/**/*')
+  spec.homepage    = 'http://rubygems.org/gems/reconfig'
+  spec.licenses    = ['MIT']
+  spec.name        = 'reconfig'
+  spec.summary     = 'Redis configuration management'
+  spec.test_files += Dir.glob('spec/**/*')
+  spec.version     = Reconfig::Version.to_s
+end

data/spec/reconfig/configuration_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Reconfig::Configuration do
+  subject do
+    Reconfig::Configuration.new
+  end
+
+  describe '#namespaces' do
+    it 'memoizes an empty array' do
+      subject.namespaces.should eq []
+    end
+  end
+
+  describe '#meta_key' do
+    it 'memoizes to a default key' do
+      subject.meta_key.should eq 'reconf:_meta'
+    end
+
+    it 'takes into account a previously set prefix' do
+      subject.prefix = 'sooooo'
+      subject.meta_key.should eq 'sooooo_meta'
+    end
+  end
+
+  describe '#prefix' do
+    it 'memoizes a default prefix' do
+      subject.prefix.should eq 'reconf:'
+    end
+  end
+
+end

data/spec/reconfig/namespace_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Reconfig::Namespace do
+  let(:type_mapper) { Reconfig::TypeMapper.new }
+  let(:fake_redis) { Redis.new }
+
+  subject do
+    Reconfig::Namespace.new('Meta:World:Peace')
+  end
+
+  describe '#initialize' do
+    it 'sets the meta key' do
+      subject.meta_key.should eq 'Meta:World:Peace'
+    end
+
+    it 'sets a default for the prefix' do
+      subject.options[:prefix].should eq 'Meta:World:Peace:'
+    end
+  end
+
+  describe '#config' do
+    it 'defaults to an empty hash' do
+      subject.config.should eq Hash.new
+    end
+
+    it 'stores a value' do
+      subject[:gin] = 'St. George'
+      fake_redis.get('Meta:World:Peace:gin').should eq 'St. George'
+    end
+
+    it 'stores a value\'s key and type in the meta key' do
+      subject[:gin] = 'St. George'
+      key_type = fake_redis.zrange('Meta:World:Peace', 0, -1, with_scores: true).first
+      key_type.first.should eq 'gin'
+      key_type.last.should eq type_mapper.string
+    end
+
+    it 'fetchs configuration values from the meta key' do
+      fake_redis.zadd('Meta:World:Peace', type_mapper.integer, 'Crisco')
+      fake_redis.set('Meta:World:Peace:Crisco', 17)
+      subject['Crisco'].should eq 17
+    end
+
+    it 'only loads the config once' do
+      subject.config.should eq Hash.new
+      fake_redis.zadd('Meta:World:Peace', type_mapper.integer, 'Crisco')
+      fake_redis.set('Meta:World:Peace:Crisco', 17)
+      subject['Crisco'].should be_nil
+    end
+  end
+
+  describe '#refresh' do
+    before(:each) do
+      fake_redis.zadd('Meta:World:Peace', type_mapper.integer, 'Crisco')
+      fake_redis.set('Meta:World:Peace:Crisco', 17)
+    end
+
+    it 'refreshes configuration values' do
+      subject['Crisco'].should be 17
+      fake_redis.set('Meta:World:Peace:Crisco', 42)
+      subject.refresh
+      subject['Crisco'].should be 42
+    end
+  end
+end

data/spec/reconfig/redis_client_spec.rb

@@ -0,0 +1,127 @@
+require 'spec_helper'
+
+describe Reconfig::RedisClient do
+  let(:type_mapper) { Reconfig::TypeMapper.new }
+  let(:connection) { double(:connection) }
+
+  subject do
+    Reconfig::RedisClient.new
+  end
+
+  before(:each) { subject.stub(:connection).and_return(connection) }
+
+  describe '#fetch_by_type' do
+
+    it 'gets a string value' do
+      allow(connection).to receive(:get).with('Gin').and_return('Tonic')
+      subject.fetch_by_type('Gin', type_mapper.string).should eq 'Tonic'
+    end
+
+    it 'gets an integer value' do
+      allow(connection).to receive(:get).with('Bubbles').and_return('7')
+      subject.fetch_by_type('Bubbles', type_mapper.integer).should be 7
+    end
+
+    it 'gets a float value' do
+      allow(connection).to receive(:get).with('Stars').and_return('7.0')
+      subject.fetch_by_type('Stars', type_mapper.float).should eq 7.0
+    end
+
+    it 'gets a hash value' do
+      allow(connection).to receive(:hgetall).with('Months').and_return({ january: 1, february: 2 })
+      subject.fetch_by_type('Months', type_mapper.hash).should eq({ january: 1, february: 2 })
+    end
+
+    it 'gets a list value' do
+      allow(connection).to receive(:lrange).with('PescatarianSleepAid', 0, -1).and_return(['One Fish', 'Two Fish'])
+      subject.fetch_by_type('PescatarianSleepAid', type_mapper.list).should eq(['One Fish', 'Two Fish'])
+    end
+
+    it 'gets a set value' do
+      set = Set.new(['A', 'B', 'AB', 'O'])
+      allow(connection).to receive(:smembers).with('BloodTypes').and_return(set)
+      subject.fetch_by_type('BloodTypes', type_mapper.set).should eq(set)
+    end
+
+    it 'raises an error for an unknown type' do
+      expect { subject.fetch_by_type('Betty', 'Boop') }.to raise_error(UnknownTypeException)
+    end
+  end
+
+  describe '#set_by_type' do
+
+    context 'with a string' do
+      it 'sets the existing key' do
+        connection.should_not_receive(:del).with('Frank')
+        connection.should_receive(:set).with('Frank', 'Ocean')
+        subject.set_by_type('Frank', 'Ocean')
+      end
+    end
+
+    context 'with an integer' do
+      it 'sets the existing key' do
+        connection.should_not_receive(:del).with('Bubbles')
+        connection.should_receive(:set).with('Bubbles', 7)
+        subject.set_by_type('Bubbles', 7)
+      end
+    end
+
+    context 'with a float' do
+      it 'sets the existing key' do
+        connection.should_not_receive(:del).with('pi')
+        connection.should_receive(:set).with('pi', 3.14)
+        subject.set_by_type('pi', 3.14)
+      end
+    end
+
+    context 'with an hash' do
+      it 'deletes the existing hash, sets the hash' do
+        hash = { javascript: 1, chris: 0 }
+        connection.should_receive(:del).with('life')
+        connection.should_receive(:hmset).with('life', *hash.to_a.flatten)
+        subject.set_by_type('life', hash)
+      end
+    end
+
+    context 'with an array' do
+      it 'deletes the existing list, pushes all values' do
+        values = ['Jack', 'Jill']
+        connection.should_receive(:del).with('Chillins')
+        connection.should_receive(:rpush).with('Chillins', *values)
+        subject.set_by_type('Chillins', values)
+      end
+    end
+
+    context 'with a set' do
+      it 'deletes the existing set, adds all values' do
+        set = Set.new(['A', 'B', 'AB', 'O'])
+        connection.should_receive(:del).with('BloodTypes')
+        connection.should_receive(:sadd).with('BloodTypes', *set)
+        subject.set_by_type('BloodTypes', set)
+      end
+    end
+  end
+
+  describe 'respond_to?' do
+    let(:connection) { double(:connection, zadd: true, rpop: false, evalsha: 'whatever') }
+
+    it 'returns true for underlying redis commands' do
+      [:zadd, :rpop, :evalsha].each do |redis_command|
+        subject.respond_to?(redis_command).should be true
+      end
+    end
+
+    it 'returns false for arbitrary methods' do
+      subject.respond_to?(:bacon).should be false
+    end
+  end
+
+  describe 'method_missing' do
+    let(:connection) { double(:connection, zadd: true) }
+
+    it 'passes methods to the underlying redis connection' do
+      connection.should_receive(:zadd).with('key', 'a', 'b', 'c')
+      subject.zadd('key', 'a', 'b', 'c')
+    end
+  end
+end

data/spec/reconfig/type_mapper_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Reconfig::TypeMapper do
+  subject do
+    Reconfig::TypeMapper.new
+  end
+
+  describe '#stored_type' do
+    it 'returns 1.0 for a string' do
+      subject.stored_type('Aquarius').should eq 1.0
+    end
+
+    it 'returns 2.0 for a fixnum' do
+      subject.stored_type(4815162342).should eq 2.0
+    end
+
+    it 'returns 2.0 for a bignum' do
+      subject.stored_type(983209180398120983012).should eq 2.0
+    end
+
+    it 'returns 3.0 for a float' do
+      subject.stored_type(7.0).should eq 3.0
+    end
+
+    it 'returns 4.0 for a hash' do
+      subject.stored_type(walrus: 'bubbles').should eq 4.0
+    end
+
+    it 'returns 5.0 for an array' do
+      subject.stored_type(['The Plague', 'The Fall', 'The Stranger']).should eq 5.0
+    end
+
+    it 'returns 6.0 for a set' do
+      subject.stored_type(Set.new([1])).should eq 6.0
+    end
+
+    it 'raises an UnknownTypeException for things it cannot handle.' do
+      expect { subject.stored_type BasicObject }.to raise_error UnknownTypeException
+    end
+  end
+end

data/spec/reconfig_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe Reconfig do
+  let(:redis_client) { Redis.new }
+
+  after(:each) do
+    Reconfig.instance_variable_set(:@configuration, nil)
+    Reconfig.instance_variable_set(:@namespaces, nil)
+  end
+
+  describe '.configure' do
+    it 'sets prefix and meta_key' do
+      Reconfig.configure do |config|
+        config.prefix = 'Re'
+        config.meta_key = 'Cola'
+      end
+
+      Reconfig.prefix.should eq 'Re'
+      Reconfig.meta_key.should eq 'Cola'
+    end
+
+    describe 'setting namespaces' do
+      before(:each) do
+        Reconfig.configure do |config|
+          config.namespaces = [:circle, :square]
+        end
+      end
+
+      it 'generates namespaces for the passed in options' do
+        Reconfig[:circle].meta_key.should eq 'reconf:circle'
+        Reconfig[:square].meta_key.should eq 'reconf:square'
+      end
+
+      it 'adds the keys to the meta_key' do
+        redis_client.smembers('reconf:_meta').should eq ['square', 'circle']
+      end
+    end
+  end
+
+  describe '#method_missing' do
+    before(:each) do
+      Reconfig.configure do |config|
+        config.namespaces = [:circle, :square]
+      end
+    end
+
+    it 'delegates to stored namespaces by key' do
+      Reconfig.circle.should_not be_nil
+    end
+  end
+
+  describe '#refresh' do
+    before(:each) do
+      Reconfig.configure do |config|
+        config.namespaces = [:gold, :silver]
+      end
+    end
+
+    it 'adds new namespaces and deletes old ones' do
+      Reconfig.gold.should_not be_nil
+      redis_client.srem('reconf:_meta', 'gold')
+      Reconfig.refresh
+      expect{ Reconfig.gold }.to raise_error(NoMethodError)
+      Reconfig[:gold].should be_nil
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'reconfig'
+require 'rspec'
+require 'rspec/autorun'
+require 'fakeredis/rspec'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: reconfig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Maddox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+description: Redis configuration management.
+email: chris@zenpayroll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- reconfig.gemspec
+- lib/reconfig/configuration.rb
+- lib/reconfig/namespace.rb
+- lib/reconfig/redis_client.rb
+- lib/reconfig/type_mapper.rb
+- lib/reconfig/version.rb
+- lib/reconfig.rb
+- spec/reconfig/configuration_spec.rb
+- spec/reconfig/namespace_spec.rb
+- spec/reconfig/redis_client_spec.rb
+- spec/reconfig/type_mapper_spec.rb
+- spec/reconfig_spec.rb
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/reconfig
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Redis configuration management
+test_files:
+- spec/reconfig/configuration_spec.rb
+- spec/reconfig/namespace_spec.rb
+- spec/reconfig/redis_client_spec.rb
+- spec/reconfig/type_mapper_spec.rb
+- spec/reconfig_spec.rb
+- spec/spec_helper.rb