enum-rb 0.1.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 jake
+
+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,96 @@
+# Enum-rb
+
+Enum-rb tries to be a flexible way to store arbitrary data that your
+application needs to function but doesn't really fit anywhere and
+has no defined structure.
+
+The idea is to use it to store things like `key => value` mappings for
+your `select` boxes, or any mappings for that matter. Anytime you need
+to just have some bit of formless data, Enum should be able to hold it.
+
+Have more of these mappings than it would be smart to store in-memory?
+No worries, Enum-rb comes with a `RedisStore` that will store your
+enums in Redis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enum-rb'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enum-rb
+
+## Usage
+
+You can use Enum-rb in two ways. If having a single store is all you need,
+you can set
+
+     Enum.default_backend
+  
+     # to either a populated `MemoryStore`, which you can get with
+     
+     Enum.default_backend = Enum::MemoryStore.new({your: {'enum' => 'data'}})
+     
+     # or a configured `RedisStore`, which you can get with
+     
+     Enum.default_backend = Enum::RedisStore.new(configured_redis_namespace)
+     
+     # and then use
+     
+     Enum[:your]            # => {'enum' => 'data'}
+     Enum.fetch(:your)      # => {'enum' => 'data'}
+     
+     # unknown Enums cause exceptions
+     
+     Enum[:nope]            # => ArgumentError
+
+Or you can alternatively have multiple enum stores by creating an instance
+of `Enum` and passing it the store to use.
+
+     @enum = Enum.new(Enum::MemoryStore.new({a: 'small', amount: ['of', 'enums']}))
+     
+     @enum[:a]             # => 'small'
+     @enum.fetch(:amount)  # => ['of', 'enums']
+     
+     # unknown Enums cause exceptions
+     
+     @enum.feth(:nope)     # => ArgumentError
+
+If you are using the `RedisStore`, you can use `RedisStore#load_hash` or
+`RedisStore#load_yaml` to load the store. In redis, you can't use symbols
+as names, but the `RedisStore` will handle storing nested hashes or arrays.
+
+For instance you could call:
+
+     Enum::RedisStore.new(configured_redis).load_hash(
+       {
+         'select_options' => [
+           {'name' => 'howdy', 'value' => 'hello'},
+           {'name' => 'later', 'value' => 'bye'}
+         ],
+         'other_stuff' => {
+           ['somehow', 'this', 'seems', 'important']
+         },
+
+         '2 + 2' => '5'
+       }
+     )
+
+and the `RedisStore` will get all that saved so that
+
+     Enum['select_options']
+     # => [{'name' => 'howdy', 'value' => 'hello'}, {...}]
+
+## 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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << File.join(File.dirname(__FILE__), 'lib')
+  t.test_files = FileList['test/**/test*.rb']
+  t.verbose = true
+end

data/enum-rb.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enum/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "enum-rb"
+  gem.version       = Enum::VERSION
+  gem.authors       = ["jake"]
+  gem.email         = ["pablo_honey@me.com"]
+  gem.description   = %q{Ruby Enum storage.}
+  gem.summary       = %q{Store some things vaguely similar to enums. In Ruby}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'redis-namespace'
+end

data/lib/enum/store/memory_store.rb

@@ -0,0 +1,23 @@
+
+class Enum
+  class MemoryStore
+
+    def initialize(store = nil)
+      @store = store || Hash.new
+    end
+
+    def get_value(key)
+      @store.fetch(key) rescue fail_fetch(key)
+    end
+
+    def set_value(name, value)
+      @store[name] = value
+    end
+
+    private
+
+    def fail_fetch(key)
+      raise ArgumentError.new("#{key} is not defined.")
+    end
+  end # => MemoryStore
+end # => Enum

data/lib/enum/store/redis_store.rb

@@ -0,0 +1,138 @@
+require 'redis/namespace'
+
+class Enum
+  class RedisStore
+
+    attr_reader :connection
+
+    def initialize(redis = nil)
+      @connection = redis || Redis::Namespace.new(:enum, redis: Redis.new)
+    end
+
+    def get_value(key)
+      Getter.get_value(connection, key)
+    end
+
+    def set_value(key, value)
+      Setter.set_value(connection, key, value)
+    end
+
+    def load_yaml(file)
+      require 'yaml'
+      load_hash(YAML.load_file(file))
+    end
+
+    def load_hash(hash)
+      hash.each_pair do |key, value|
+        Setter.set_value(connection, key, value)
+      end
+    end
+
+    module Setter
+
+      module_function
+
+      def set_value(connection, key, value)
+        meth = :"set_#{value.class.to_s.downcase}_value"
+        raise_cannot_store_value_type(value) unless self.respond_to?(meth)
+
+        send(meth, connection, key, value)
+      end
+
+      def set_string_value(connection, key, value)
+        connection.set(key, value)
+      end
+
+      def set_array_value(connection, key, value)
+        connection.multi do
+          value.each_with_index do |v, index|
+            (connection.rpush(key, v) && next) if v.is_a?(String)
+            nested_value_key(key, index).tap do |nvkey|
+              set_value(connection, nvkey, v)
+              connection.rpush(key, "ENUM_KEY:#{nvkey}")
+            end
+          end
+        end
+      end
+
+      def set_hash_value(connection, key, value)
+        connection.multi do
+          settable_hash = value.inject(Hash.new) do |out, pair|
+            if pair.last.is_a?(String) || pair.last.is_a?(Fixnum)
+              out[pair.first] = pair.last
+            else
+              nested_value_key(key, pair.first).tap do |nvkey|
+                set_value(connection, nvkey, pair.last)
+                out[pair.first] = "ENUM_KEY:#{nvkey}"
+              end
+            end
+            out
+          end
+
+          connection.hmset(key, *settable_hash.to_a.flatten)
+        end
+      end
+
+      def nested_value_key(base, addy)
+        "nested.value:#{base}.#{addy}"
+      end
+
+      def namespace_name(name)
+        return name if name[0..@name.length] == @name
+        "#@name.#{name}"
+      end
+
+      def raise_cannot_store_value_type(value)
+        raise "Enum cannot store values of class #{value.class}."
+      end
+
+    end # => Setter
+
+    module Getter
+
+      module_function
+
+      def get_value(connection, key)
+        raise_unknown_key(key) unless connection.exists(key)
+
+        meth = :"get_#{connection.type(key)}_value"
+
+        raise_unknown_value_type(meth, key) unless self.respond_to?(meth)
+
+        send(meth, connection, key)
+      end
+
+      def get_string_value(connection, key)
+        connection.get(key)
+      end
+
+      def get_list_value(connection, key)
+        connection.lrange(key, 0, -1).map do |value|
+          is_enum_key?(value) ? get_value(connection, value[9..-1]) : value
+        end
+      end
+
+      def get_hash_value(connection, key)
+        connection.hgetall(key).inject(Hash.new) do |out, pair|
+          k, v = pair
+          out[k] = is_enum_key?(v) ? get_value(connection, v[9..-1]) : v
+          out
+        end
+      end
+
+      def is_enum_key?(key)
+        !/ENUM_KEY:.*/.match(key.to_s).nil?
+      end
+
+      def raise_unknown_value_type(meth, key)
+        raise "#{key} has unknown value type: #{meth} is not defined."
+      end
+
+      def raise_unknown_key(key)
+        raise ArgumentError.new("Enum [ #{key} ] is not defined.")
+      end
+
+    end # => Getter
+
+  end
+end

data/lib/enum/version.rb

@@ -0,0 +1,3 @@
+module Enum
+  VERSION = "0.1.1"
+end

data/lib/enum.rb

@@ -0,0 +1,35 @@
+
+class Enum
+
+  class << self
+
+    def default_backend
+      @default_backend ||= begin
+        require 'enum/store/memory_store'
+        Enum::MemoryStore.new
+      end
+    end
+
+    def default_backend=(arg)
+      @default_backend = arg
+    end
+
+    def [](arg)
+      default_backend.get_value(arg)
+    end
+    alias fetch []
+
+  end
+
+  attr_reader :name, :backend
+
+  def initialize(backend = nil)
+    @backend = backend || Enum.default_backend
+  end
+
+  def fetch(name)
+    backend.get_value(name)
+  end
+  alias [] fetch
+
+end

data/test/enum/store/test_memory_store.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'enum'
+require 'enum/store/memory_store'
+
+class TestEnumStoreMemoryStore < Test::Unit::TestCase
+
+  def setup
+    @store = Enum::MemoryStore.new({'test' => 'foobar'})
+  end
+
+  def test_set_value
+    @store.set_value('test', 'foobar')
+
+    assert_equal 'foobar', @store.instance_variable_get(:@store)['test']
+  end
+
+  def test_get_value
+    @store.instance_variable_set(:@store, {'test' => 'foobar'})
+
+    assert_equal 'foobar', @store.get_value('test')
+  end
+
+  def test_raises_on_undefined_value
+    assert_raises ArgumentError do
+      @store.get_value(:test)
+    end
+  end
+
+end

data/test/enum/store/test_redis_store.rb

@@ -0,0 +1,121 @@
+require 'test/unit'
+require 'enum'
+require 'enum/store/redis_store'
+
+
+class TestEnumStoreRedisStore < Test::Unit::TestCase
+  def setup
+    @store = Enum::RedisStore.new(
+      Redis::Namespace.new(:test_enums, redis: Redis.new, db: 11))
+    @store.connection.flushdb
+  end
+
+  def teardown
+    @store.connection.flushdb
+  end
+
+  def test_load_hash
+    @store.load_hash({'foo' => 'bar', 'baz' => 'bat'})
+
+    assert_equal 'bar', @store.get_value('foo')
+    assert_equal 'bat', @store.get_value('baz')
+  end
+
+  def test_sets_string_values
+    @store.set_value('test', 'hat')
+
+    assert_equal 'hat', @store.connection.get('test')
+  end
+
+  def test_gets_string_values
+    @store.connection.set('test', 'hat')
+
+    assert_equal 'hat', @store.get_value('test')
+  end
+
+  def test_sets_list_values
+    arr = %w{1 2 3}
+    @store.set_value('test', arr)
+
+    assert_equal 'list', @store.connection.type('test')
+    assert_equal arr, @store.connection.lrange('test', 0, -1)
+  end
+
+  def test_sets_list_values_with_complex_entries
+    arr = [['1','2'], {'3' => '4'}, '5']
+    @store.set_value('test', arr)
+
+    assert_equal 'list', @store.connection.type('test')
+    assert_equal(
+      ['ENUM_KEY:nested.value:test.0', 'ENUM_KEY:nested.value:test.1', '5'],
+      @store.connection.lrange('test', 0, -1))
+
+    assert_equal 'list', @store.connection.type('nested.value:test.0')
+    assert_equal ['1', '2'], @store.connection.lrange('nested.value:test.0', 0, -1)
+
+    assert_equal 'hash', @store.connection.type('nested.value:test.1')
+    assert_equal({'3' => '4'}, @store.connection.hgetall('nested.value:test.1'))
+  end
+
+  def test_gets_list_values
+    %w{1 2 3}.each {|i| @store.connection.rpush('test', i)}
+
+    assert_equal %w{1 2 3}, @store.get_value('test')
+  end
+
+  def test_gets_list_values_with_complex_types
+    %w{1 2}.each {|i| @store.connection.rpush('nested.value:test.0', i)}
+    @store.connection.hmset('nested.value:test.1', '3', '4')
+    %w{ENUM_KEY:nested.value:test.0 ENUM_KEY:nested.value:test.1 5}.each do |s|
+      @store.connection.rpush('test', s)
+    end
+    arr = [['1', '2'], {'3' => '4'}, '5']
+
+    assert_equal arr, @store.get_value('test')
+  end
+
+  def test_sets_hash_values
+    hsh = {'1' => '2', '3' => '4'}
+    @store.set_value('test', hsh)
+
+    assert_equal 'hash', @store.connection.type('test')
+    assert_equal hsh, @store.connection.hgetall('test')
+  end
+
+  def test_sets_hash_values_with_complex_types
+    hsh = {'1' => ['2', '3'], '4' => {'5' => '6'}, '7' => '8'}
+    @store.set_value('test', hsh)
+
+    assert_equal(
+      {'1' => 'ENUM_KEY:nested.value:test.1',
+       '4' => 'ENUM_KEY:nested.value:test.4', '7' => '8'},
+      @store.connection.hgetall('test'))
+
+    assert_equal ['2', '3'],
+      @store.connection.lrange('nested.value:test.1', 0, -1)
+    assert_equal({'5' => '6'},
+                 @store.connection.hgetall('nested.value:test.4'))
+  end
+
+  def test_gets_hash_values
+    @store.connection.hmset('test', '1', '2', '3', '4')
+
+    assert_equal({'1' => '2', '3' => '4'}, @store.get_value('test'))
+  end
+
+  def test_gets_hash_values_with_complex_types
+    %w{2 3}.each {|i| @store.connection.rpush('nested.value:test.1', i)}
+    @store.connection.hmset('nested.value:test.4', '5', '6')
+    @store.connection.hmset('test', 1, 'ENUM_KEY:nested.value:test.1', 4,
+               'ENUM_KEY:nested.value:test.4', 7, 8)
+
+    hsh = {'1' => ['2', '3'], '4' => {'5' => '6'}, '7' => '8'}
+    assert_equal hsh, @store.get_value('test')
+  end
+
+  def test_raises_on_unset_values
+    assert_raises ArgumentError do
+      @store.get_value('unset.test')
+    end
+  end
+end

data/test/test_enum.rb

@@ -0,0 +1,28 @@
+require 'test/unit'
+require 'enum'
+
+class TestEnum < Test::Unit::TestCase
+
+  def setup
+    @enum = Enum.new()
+  end
+
+  def test_class_fetch
+    Enum.default_backend = Enum::MemoryStore.new({test: 'ahoy!'})
+
+    assert_equal 'ahoy!', Enum.fetch(:test)
+    assert_equal 'ahoy!', Enum[:test]
+  end
+
+  def test_initializes_with_defaults
+    assert_equal Enum.default_backend, @enum.instance_variable_get(:@backend)
+  end
+
+  def test_value_calls_backend
+    @enum.instance_variable_get(:@backend).set_value(:test, 'foobar')
+
+    assert_equal 'foobar', @enum.fetch(:test)
+    assert_equal 'foobar', @enum[:test]
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: enum-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- jake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby Enum storage.
+email:
+- pablo_honey@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enum-rb.gemspec
+- lib/enum.rb
+- lib/enum/store/memory_store.rb
+- lib/enum/store/redis_store.rb
+- lib/enum/version.rb
+- test/enum/store/test_memory_store.rb
+- test/enum/store/test_redis_store.rb
+- test/test_enum.rb
+homepage: ''
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Store some things vaguely similar to enums. In Ruby
+test_files:
+- test/enum/store/test_memory_store.rb
+- test/enum/store/test_redis_store.rb
+- test/test_enum.rb
+has_rdoc: