easy_key_value 0.1.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Intrepidd
+
+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,110 @@
+# EasyKeyValue
+
+This gem provides a handy key/value store for your ActiveRecord models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'easy_key_value'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_key_value
+
+
+Once installed, please run the following commands :
+
+```
+rails generate ekv:migrations
+```
+
+This will generate a new migration used by easy_key_value
+
+Don't forget to run ```rake db:migrate``` in order to apply the new migration.
+
+## Usage
+
+Because an example is better than a precept :
+
+```ruby
+class MyModel < ActiveRecord::base
+
+  acts_as_key_value_store # Add this line in order to use the key/value store
+
+end
+```
+
+You have now access to methods that will help you manipulate the data stored for objects of this class.
+
+### Adding / Updating a key
+
+```ruby
+model = MyModel.find(42)
+
+model.key('foo', 'bar') # The key will be created if it does not exist
+
+model.key('foo', 'baz') # The key will be updated if it exists
+```
+
+### Fetching the value of a key
+
+```ruby
+model.key('foo') # => 'baz'
+```
+
+### Destroying a key
+
+```ruby
+model.del_key('foo')
+
+model.key('foo') # => nil
+```
+
+### Playing with default values
+
+You can specify default values for a given model.
+
+```ruby
+
+class MyModel < ActiveRecord::base
+
+  acts_as_key_value_store # Add this line in order to use the key/value store
+
+  key_value_store_defaults {
+    'author'   => 'Intrepidd',
+    'language' => 'ruby'
+  }
+
+end
+
+```
+
+Then, if the key is not set, the default value will be returned.
+
+```ruby
+
+model = MyModel.new
+model.save
+
+model.key('author') # => 'Intrepidd'
+
+model.key('language') # => 'ruby'
+
+model.key('language', 'whatever')
+
+model.key('language') => 'whatever'
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added 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 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/easy_key_value.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/easy_key_value/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Adrien Siami(Intrepidd)"]
+  gem.email         = ["adrien.siami@gmail.com"]
+  gem.description   = "A simple gem that allows active record models to contain a key / value store for configuration"
+  gem.summary       = "A simple gem that allows active record models to contain a key / value store for configuration"
+  gem.homepage      = "https://github.com/WizVille/easy_key_value"
+
+  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.name          = "easy_key_value"
+  gem.require_paths = ["lib"]
+  gem.version       = EKV::VERSION
+
+  gem.add_dependency 'activerecord', '>= 3.1.0'
+
+end
+

data/lib/easy_key_value/class_methods.rb

@@ -0,0 +1,14 @@
+module EKV
+  module ModelExtensions
+    module ClassMethods
+
+      # Sets default values for this model
+      #
+      # @param [Hash] defaults A hash containing default values
+      def key_value_store_defaults(defaults)
+        class_variable_set(:@@ekv_defaults, defaults)
+      end
+
+    end
+  end
+end

data/lib/easy_key_value/easy_key_value.rb

@@ -0,0 +1,22 @@
+require 'active_record'
+
+class EasyKeyValue < ActiveRecord::Base
+
+  # The key must be unique for a given instance
+  validates :key, :uniqueness => {:scope => [:ekv_id, :ekv_type]}
+
+  # Adds a key with a given value for a given object
+  #
+  # @param [ActiveRecord::Base] object An Active Record instance
+  # @param [String] key The key
+  # @param [String] value The value of this key
+  def self.add_key(object, key, value)
+    ekv = EasyKeyValue.new
+    ekv.ekv_id = object.id
+    ekv.ekv_type = object.class.to_s
+    ekv.key = key
+    ekv.value = value
+    ekv.save
+  end
+
+end

data/lib/easy_key_value/key_value_store.rb

@@ -0,0 +1,102 @@
+module EKV
+  module ModelExtensions
+    module KeyValueStore
+
+      def self.included(base)
+        class_variable_set(:@@ekv_defaults, {})
+        base.send(:extend, ModelExtensions::ClassMethods)
+      end
+
+      # Accesses a key, or sets / updates it depending on its existence
+      #
+      # @param [String] key The name of the key
+      # @param [String, nil] value The value to be set or nil if we just want to read the value
+      # @return [String, boolean] The value of the key if value is nil
+      def key(key, value = nil)
+        return self.get_key(key) if value.nil?
+
+        if @ekv.key? key
+          #Update
+          self.update_key(key, value)
+        else
+          # Add a key
+          self.add_key(key, value)
+        end
+
+      end
+
+      # Adds a key with its value
+      #
+      # @param [String] key The key
+      # @param [String] value The value
+      def add_key(key, value)
+        self.load_ekv
+        if EasyKeyValue.add_key(self, key, value) == true
+          @ekv[key] = value
+          return true
+        end
+        false
+      end
+
+      # Returns the value of a given key
+      #
+      # @param [String] key The key we want the value of
+      # @return [String, nil] The value or nil if it does not exist
+      def get_key(key)
+        self.load_ekv
+        @ekv[key] || @@ekv_defaults[key]
+      end
+
+      # Removes a given key
+      #
+      # @param [String] key The key we want to destroy
+      # @return [Boolean] Wether or not the key was destroyed
+      def del_key(key)
+        self.load_ekv
+        return false unless @ekv.key? key
+        ekv = EasyKeyValue.find_by_ekv_id_and_ekv_type_and_key(self.id, self.class.to_s, key)
+        return false if ekv.nil?
+        ekv.destroy
+        @ekv.delete key
+        true
+      end
+
+      # Updates a given key with the given value
+      #
+      # @param [String] key The key we want to change
+      # @param [String] value The new value for this key
+      # @return [Boolean] true if the key was updated, false if the key did not exist
+      def update_key(key, value)
+        return false unless @ekv.key? key
+        ekv = EasyKeyValue.find_by_ekv_id_and_ekv_type_and_key(self.id, self.class.to_s, key)
+        return false if ekv.nil?
+        ekv.value = value
+        ekv.save
+        @ekv[key] = value
+        true
+      end
+
+      # Gets a hash containing the key and values
+      #
+      # @return [Hash] The hash containing key and values for this object
+      def kv_store
+        self.load_ekv
+        @ekv.clone.freeze
+      end
+
+protected
+
+      # Loads The key and values for the current model
+      def load_ekv
+        return if defined? @ekv and !@ekv.nil?
+
+        keys = EasyKeyValue.find_all_by_ekv_id_and_ekv_type(self.id, self.class.to_s)
+        @ekv = {}
+        keys.each do |k|
+          @ekv[k.key] = k.value
+        end
+      end
+
+    end
+  end
+end

data/lib/easy_key_value/model_extensions.rb

@@ -0,0 +1,20 @@
+require "easy_key_value/key_value_store"
+require "easy_key_value/class_methods"
+
+module EKV
+  module ModelExtensions
+
+    def self.included(base)
+      base.send(:extend, EKV::ClassMethods)
+    end
+  end
+
+  module ClassMethods
+
+    # Marks the model as a key / value store
+    def acts_as_key_value_store
+      include ModelExtensions::KeyValueStore
+    end
+
+  end
+end

data/lib/easy_key_value/version.rb

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

data/lib/easy_key_value.rb

@@ -0,0 +1,9 @@
+require "easy_key_value/version"
+require "easy_key_value/easy_key_value"
+require "easy_key_value/model_extensions"
+
+
+if defined? ActiveRecord::Base
+  ActiveRecord::Base.send(:include, EKV::ModelExtensions)
+end
+

data/lib/generators/ekv/migrations/migrations_generator.rb

@@ -0,0 +1,26 @@
+module Ekv
+  module Generators
+    class MigrationsGenerator < Rails::Generators::Base
+      desc "Generates the default migrations for easy_key_value"
+
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @_ekv_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def self.next_migration_number(dirname)
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def create_migrations
+        Dir["#{self.class.source_root}/migrations/*.rb"].sort.each do |filepath|
+          name = File.basename(filepath)
+          migration_template "migrations/#{name}", "db/migrate/#{name.gsub(/^\d+_/,'')}"
+          sleep 1
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/ekv/migrations/templates/migrations/1_easy_key_value_migration.rb

@@ -0,0 +1,16 @@
+class EasyKeyValueMigration < ActiveRecord::Migration
+
+  def change
+    create_table :easy_key_values do |t|
+      t.integer :ekv_id
+      t.string :ekv_type
+
+      t.string :key
+      t.text :value
+    end
+
+    add_index :easy_key_values, :ekv_id, :name => 'ekv_id_ix'
+    add_index :easy_key_values, :value, :name => 'value_ix'
+  end
+
+end

data/test/init_tests.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => 'test.sqlite3')

data/test/models/Foo.rb

@@ -0,0 +1,10 @@
+require 'active_record'
+require 'easy_key_value'
+
+class Foo < ActiveRecord::Base
+
+  acts_as_key_value_store
+
+  key_value_store_defaults 'mama' => 'mia'
+
+end

data/test/schema.rb

@@ -0,0 +1,24 @@
+
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'foos'")
+ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'easy_key_values'")
+
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :foos do |t|
+
+  end
+
+  create_table :easy_key_values do |t|
+
+    t.integer :ekv_id
+    t.string :ekv_type
+
+    t.string :key
+    t.text :value
+
+  end
+
+  add_index :easy_key_values, :ekv_id, :name => 'ekv_id_ix'
+  add_index :easy_key_values, :value, :name => 'value_ix'
+
+end

data/test/test_ekv.rb

@@ -0,0 +1,75 @@
+require 'init_tests'
+require 'easy_key_value'
+require 'test/unit'
+require 'models/Foo'
+
+load 'schema.rb'
+
+class EayKeyValueTest < Test::Unit::TestCase
+
+
+  def test_get_set_del
+    foo = Foo.new
+    foo.save
+
+    assert_equal true, foo.add_key('foo', 'bar')
+    assert_equal false, foo.add_key('foo', 'bar')
+
+    assert_equal 'bar', foo.get_key('foo')
+    assert_equal true, foo.del_key('foo')
+    assert_equal false, foo.del_key('foo')
+    assert_equal false, foo.del_key('bar')
+    assert_equal nil, foo.get_key('foo')
+
+    foo.add_key('toto', 'tata')
+
+    foo = Foo.last
+
+    assert_equal 'tata', foo.get_key('toto')
+
+    assert_equal 'tata', foo.kv_store['toto']
+
+    assert_equal true, foo.kv_store.frozen?
+
+    assert_equal true, foo.update_key('toto', 'tutu')
+    assert_equal false, foo.update_key('totu', 'tutu')
+
+    assert_equal 'tutu', foo.get_key('toto')
+    foo = Foo.last
+    assert_equal 'tutu', foo.get_key('toto')
+
+  end
+
+  def test_key
+    foo = Foo.new
+    foo.save
+
+    assert_equal nil, foo.key('foo')
+
+    assert_equal true, foo.key('foo', 'bar')
+    assert_equal 'bar', foo.key('foo')
+
+    foo = Foo.last
+
+    assert_equal 'bar', foo.key('foo')
+    assert_equal true, foo.key('foo', 'baz')
+    assert_equal 'baz', foo.key('foo')
+
+    foo = Foo.last
+    assert_equal 'baz', foo.key('foo')
+
+  end
+
+  def test_default_values
+    foo = Foo.new
+    foo.save
+
+    assert_equal 'mia', foo.key('mama')
+
+    foo.key('mama', 'nomia')
+
+    assert_equal 'nomia', foo.key('mama')
+  end
+
+end
+

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: easy_key_value
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Adrien Siami(Intrepidd)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: A simple gem that allows active record models to contain a key / value
+  store for configuration
+email:
+- adrien.siami@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- easy_key_value.gemspec
+- lib/easy_key_value.rb
+- lib/easy_key_value/class_methods.rb
+- lib/easy_key_value/easy_key_value.rb
+- lib/easy_key_value/key_value_store.rb
+- lib/easy_key_value/model_extensions.rb
+- lib/easy_key_value/version.rb
+- lib/generators/ekv/migrations/migrations_generator.rb
+- lib/generators/ekv/migrations/templates/migrations/1_easy_key_value_migration.rb
+- test/init_tests.rb
+- test/models/Foo.rb
+- test/schema.rb
+- test/test_ekv.rb
+homepage: https://github.com/WizVille/easy_key_value
+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.24
+signing_key: 
+specification_version: 3
+summary: A simple gem that allows active record models to contain a key / value store
+  for configuration
+test_files:
+- test/init_tests.rb
+- test/models/Foo.rb
+- test/schema.rb
+- test/test_ekv.rb
+has_rdoc: