doeskeyvalue 0.2.2 → 0.9.0

data/lib/doeskeyvalue/state.rb

@@ -0,0 +1,48 @@
+# AWEXOME LABS
+# DoesKeyValue
+#
+# State -- Singleton state class representing the state of supported objects,
+#  known keys, and powered indexes
+
+require "singleton"
+
+module DoesKeyValue
+  class State
+
+    # There can be only one!
+    include Singleton
+
+    attr_reader :classes, :keys
+
+    # Add support for a single class of objects:
+    def add_class(klass, opts={})
+      DoesKeyValue.log("State: Add support for class #{klass.to_s} with opts:#{opts.inspect}")
+      @classes ||= Hash.new
+      @classes[klass.to_s] = opts
+    end
+
+    # Add a key for a given class:
+    def add_key(klass, key_name, opts={})
+      DoesKeyValue.log("State: Add key #{key_name} to class #{klass.to_s} with opts:#{opts.inspect}")
+      @keys ||= Hash.new
+      @keys[klass.to_s] ||= Array.new
+      @keys[klass.to_s] << {name:key_name, options:opts}
+    end
+
+    # Return the configuration for a given klass:
+    def options_for_class(klass)
+      DoesKeyValue.log("State: Querying options_for_class for class:#{klass.to_s}")
+      @classes[klass.to_s] rescue {}
+    end
+
+    # Return the list of keys for a given klass:
+    def options_for_key(klass, key_name)
+      DoesKeyValue.log("State: Querying options_for_key for class:#{klass.to_s} and key:#{key_name}")
+      key_def = (@keys[klass.to_s] || Array.new).find{|x| x[:name]==key_name.to_sym} || {}
+      opts = key_def[:options]
+    end
+
+
+  end # State
+end # DoesKeyValue
+

data/lib/doeskeyvalue/table_storage.rb

@@ -0,0 +1,79 @@
+# AWEXOME LABS
+# DoesKeyValue
+#
+# TableStorage -- Support and methods for key-value pairs stored in an altogether
+#  separate database table.
+
+module DoesKeyValue
+  module TableStorage
+
+    # Define a supported key
+    def has_key(key_name, opts={})
+      opts = {
+        index: true,
+        type: "string",
+        default: nil
+      }.merge(opts)
+
+      key_indexed = opts[:index]
+      key_type = opts[:type].to_sym
+      key_default_value = opts[:default]
+
+      raise Exception.new("Data type not supported: #{key_type}") unless DoesKeyValue::SUPPORTED_DATA_TYPES.include?(key_type.to_s)
+
+      DoesKeyValue::State.instance.add_key(self, key_name, opts)
+      storage_table = DoesKeyValue::State.instance.options_for_class(self)[:table]
+
+      # Accessor for new key with support for default value:
+      define_method(key_name) do
+        DoesKeyValue.log("Accessing BY TABLE key:#{key_name} for class:#{self.class}")
+        if self.new_record?
+          DoesKeyValue.log("-- Object does not have a database ID. No resource to query against.")
+          return nil
+        end
+
+        value = DoesKeyValue::Index.read_index(self, key_name)
+        if !value.nil?
+          return value
+        elsif default_value = self.class.key_options(key_name)[:default]
+          return default_value
+        end
+      end
+
+      # Manipulator for new key:
+      define_method("#{key_name}=") do |value|
+        DoesKeyValue.log("Modifying BY TABLE value for key:#{key_name} to value:#{value}")
+        unless self.new_record?
+          DoesKeyValue::Index.update_index(self, key_name, value)
+        else
+          DoesKeyValue.log("-- Object does not have a database ID. Holding back table index update.")
+        end
+      end
+
+      # All table-based key-value stores have index finders and scopes:
+      scope "with_#{key_name}", lambda {|value| 
+        DoesKeyValue::Index.find_objects(self, key_name, value)
+      }
+      DoesKeyValue.log("Scope with_#{key_name} added for table-storage key #{key_name}")
+      
+      # Delete the index after destroy:
+      define_method("destroy_index_for_#{key_name}") do
+        DoesKeyValue::Index.delete_index(self, key_name)
+      end
+      after_destroy "destroy_index_for_#{key_name}"
+
+    end
+
+
+    # Return a list of currently supported keys:
+    def keys
+      DoesKeyValue::State.instance.keys[self.to_s]
+    end
+
+    # Return the specific configuration for a given key:
+    def key_options(key_name)
+      DoesKeyValue::State.instance.options_for_key(self, key_name)
+    end
+
+  end # TableStorage
+end # DoesKeyValue

data/lib/doeskeyvalue/util.rb

@@ -1,27 +1,34 @@
 # AWEXOME LABS
 # DoesKeyValue
+#
+# Util -- Utility methods and helpers for use in data access and manipulation
 
+require "singleton"
 
 module DoesKeyValue
-  module Util
-  
-    module CondArray
-      def add_condition(cond, conj="AND")
-        if cond.is_a?(Array)
-          if self.empty?
-            (self << cond).flatten!
-          else
-            self[0] += " #{conj} #{cond.shift}"
-            (self << cond).flatten!
-          end
-        elsif cond.is_a?(String)
-          self[0] += " #{conj} #{cond}"
+  class Util
+
+    # Convert a value to the given type:
+    def self.to_type(value, type)
+      DoesKeyValue.log("Converting type of value:#{value} to type:#{type}")
+      case type.to_sym
+        when :string
+          value.to_s
+        when :integer
+          value.to_i
+        when :boolean
+          converted = true if value == true || value =~ /(true|t|yes|y|1)$/i
+          converted = false if value == false || value =~ /(false|f|no|n|0)$/i
+          converted
+        when :decimal
+          value.to_f
+        when :datetime
+          value.to_datetime
         else
-          raise "Condition must be an Array or String"
-        end
-        self
+          value
       end
     end
-  
-  end
+
+  end # Util
 end # DoesKeyValue
+

data/lib/generators/doeskeyvalue/doeskeyvalue_generator.rb

@@ -1,14 +1,15 @@
 # AWEXOME LABS
 # DoesKeyValue
 #
-# IndexTableGenerator -- generator for the Index database table
+# Generator -- Migration generator for the column-backed index table and/or
+#  the table-backed storage tables
 
-require 'rails/generators'
-require 'rails/generators/migration'
+require "rails/generators"
+require "rails/generators/migration"
 
 class DoeskeyvalueGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
-  source_root File.expand_path('../templates', __FILE__)
+  source_root File.expand_path("../templates", __FILE__)
   
   def self.next_migration_number(path)
     if ActiveRecord::Base.timestamped_migrations
@@ -19,7 +20,10 @@ class DoeskeyvalueGenerator < Rails::Generators::Base
   end
   
   def create_migration_file
-    migration_template 'create_key_value_index.rb', 'db/migrate/create_key_value_index.rb'
+    puts "Creating DoesKeyValue index table migration"
+    index_table_name = ARGV.first || "key_value_index"
+    puts "=> #{index_table_name} table to be created"
+    migration_template "create_key_value_index.rb", "db/migrate/create_#{index_table_name}.rb", table_name:index_table_name
   end
   
 end

data/lib/generators/doeskeyvalue/templates/create_key_value_index.rb

@@ -3,22 +3,37 @@
 #
 # CreateKeyValueIndex -- generated migration template for key/value index table
 
-class CreateKeyValueIndex < ActiveRecord::Migration
+<%
+  table_name = config[:table_name]
+-%>
+
+class Create<%=table_name.camelize-%> < ActiveRecord::Migration
   def self.up
-    create_table :key_value_index do |t|
+    create_table :<%=table_name-%> do |t|
+      # The object is linked by class type and id:
       t.string :obj_type
-      t.string :key_name
-      t.string :value
       t.integer :obj_id
+
+      # The key is identified by name and data type:
+      t.string :key_name
+      t.string :key_type
       
+      # The value is stored in various possible formats:
+      t.string :value_string
+      t.integer :value_integer
+      t.decimal :value_decimal
+      t.boolean :value_boolean
+      t.datetime :value_datetime
+
+      # Traditional record-keeping for the index:
       t.timestamps
     end
     
     # Index is important here:
-    add_index :key_value_index, [:obj_type, :key_name, :value]
+    add_index :<%=table_name-%>, [:obj_type, :key_name]
   end
 
   def self.down
-    drop_table :key_value_index
+    drop_table :<%=table_name%>
   end
-end
+end

data/spec/doeskeyvalue/column_storage_spec.rb

@@ -0,0 +1,139 @@
+# AWEXOME LABS
+# DoesKeyValue Test Suite : Column Storage
+
+# Get started:
+require File.expand_path(File.dirname(__FILE__)+"/../spec_helper")
+
+# Create schema for sample User model for testing column-based storage:
+ActiveRecord::Base.connection.drop_table(:users) if ActiveRecord::Base.connection.table_exists?(:users)
+ActiveRecord::Base.connection.create_table(:users) do |t|
+  t.string :name  
+  t.string :email
+  t.text :settings
+  t.timestamps
+end
+
+# Build the generator-style key value index table:
+ActiveRecord::Base.connection.drop_table(:key_value_index) if ActiveRecord::Base.connection.table_exists?(:key_value_index)
+ActiveRecord::Base.connection.create_table(:key_value_index) do |t|
+  t.string :obj_type
+  t.integer :obj_id
+  t.string :key_name
+  t.string :key_type
+  t.string :value_string
+  t.integer :value_integer
+  t.decimal :value_decimal
+  t.boolean :value_boolean
+  t.datetime :value_datetime
+  t.timestamps
+end
+
+
+# Define the sample User model which will exhibit column-based storage:
+class User < ActiveRecord::Base
+  attr_accessible :name, :email, :settings
+  has_many :posts
+
+  # Key-Value storage:
+  does_keys :column=>"settings"
+  has_key :string_key
+  has_key :integer_key, :type=>:integer
+  has_key :decimal_key, :type=>:decimal
+  has_key :bool_key, :type=>:boolean
+  has_key :date_key, :type=>:datetime
+  has_key :default_val_key, :default=>"The Default"
+  has_key :indexless_key, :index=>false
+end
+
+
+# Test the ColumnStorage Module against the sample User class
+describe "column_storage" do
+
+  before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+    @user = User.new
+  end
+
+  after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
+  it "defines key read accessors" do
+    %w(string_key integer_key decimal_key bool_key date_key default_val_key indexless_key).each do |key_name|
+      @user.respond_to?( key_name.to_sym )
+      @user.methods.include?( key_name.to_sym ).should be_true
+    end
+  end
+
+  it "defines key write accessors" do
+    %w(string_key integer_key decimal_key bool_key date_key default_val_key indexless_key).each do |key_name|
+      @user.respond_to?( "#{key_name}=".to_sym )
+      @user.methods.include?( "#{key_name}=".to_sym ).should be_true
+    end
+  end
+
+  it "returns default value if none defined" do
+    @user.default_val_key.should == "The Default"
+  end
+
+  it "saves and returns the same value for keys" do
+    @user.string_key = "Ron Swanson"
+    @user.save
+    @user.reload
+    @user.string_key.should == "Ron Swanson"
+  end
+
+  it "sets a string value when assigned" do 
+    @user.string_key = "Hello"
+    @user.string_key.should == "Hello"
+  end
+
+  it "sets an integer value when assigned" do 
+    @user.integer_key = 123
+    @user.integer_key.should == 123
+    @user.integer_key.class.should == Fixnum
+  end
+  
+  it "sets a decimal value when assigned" do 
+    @user.decimal_key = 12.21
+    @user.decimal_key.should == 12.21
+    @user.decimal_key.class.should == Float
+  end
+  
+  it "sets a boolean value when assigned" do 
+    @user.bool_key = true
+    @user.bool_key.should be_true
+    @user.bool_key = false
+    @user.bool_key.should be_false
+  end
+
+  it "sets a datetime value when assigned" do 
+    d0 = DateTime.now
+    @user.date_key = d0
+    @user.date_key.should == d0
+    @user.date_key.class.should == DateTime
+  end
+
+  it "defines with_ scope for indexed keys" do
+    %w(string_key integer_key decimal_key bool_key date_key default_val_key).each do |key_name|
+      User.methods.include?("with_#{key_name}".to_sym).should be_true
+    end
+  end
+
+  it "does not define with_ scope for non-indexed keys" do
+    User.methods.include?(:with_indexless_key).should be_false
+  end
+
+  it "finds objects via the scope and index" do
+    @user.string_key = "Champion"
+    @user.save
+    find_results = User.with_string_key("Champion")
+    find_results.length.should == 1
+    find_results.first.should == @user
+  end
+
+end # column_stage
+
+

data/spec/doeskeyvalue/table_storage_spec.rb

@@ -0,0 +1,140 @@
+# AWEXOME LABS
+# DoesKeyValue Test Suite : Table Storage
+
+# Get started:
+#require File.expand_path(File.dirname(__FILE__)+"/../spec_helper")
+
+# Create schema for sample User model for testing column-based storage:
+ActiveRecord::Base.connection.drop_table(:posts) if ActiveRecord::Base.connection.table_exists?(:posts)
+ActiveRecord::Base.connection.create_table(:posts) do |t|
+  t.integer :user_id
+  t.string :title  
+  t.text :body
+  t.timestamps
+end
+
+# Build the generator-style key value index table:
+ActiveRecord::Base.connection.drop_table(:post_preferences) if ActiveRecord::Base.connection.table_exists?(:post_preferences)
+ActiveRecord::Base.connection.create_table(:post_preferences) do |t|
+  t.string :obj_type
+  t.integer :obj_id
+  t.string :key_name
+  t.string :key_type
+  t.string :value_string
+  t.integer :value_integer
+  t.decimal :value_decimal
+  t.boolean :value_boolean
+  t.datetime :value_datetime
+  t.timestamps
+end
+
+
+# Define the sample Post model which will exhibit table-based storage:
+class Post < ActiveRecord::Base
+  attr_accessible :user_id, :title, :body
+  belongs_to :user
+
+  # Key-Value storage:
+  does_keys :table=>"post_preferences"
+  has_key :string_key
+  has_key :integer_key, :type=>:integer
+  has_key :decimal_key, :type=>:decimal
+  has_key :bool_key, :type=>:boolean
+  has_key :date_key, :type=>:datetime
+  has_key :default_val_key, :default=>"The Default"
+  has_key :indexless_key, :index=>false
+end
+
+
+# Test the ColumnStorage Module against the sample User class
+describe "table_storage" do
+
+  before(:each) do
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.begin_db_transaction
+    @post = Post.new
+    @post.save
+  end
+
+  after(:each) do
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
+  it "defines key read accessors" do
+    %w(string_key integer_key decimal_key bool_key date_key default_val_key indexless_key).each do |key_name|
+      @post.respond_to?( key_name.to_sym )
+      @post.methods.include?( key_name.to_sym ).should be_true
+    end
+  end
+
+  it "defines key write accessors" do
+    %w(string_key integer_key decimal_key bool_key date_key default_val_key indexless_key).each do |key_name|
+      @post.respond_to?( "#{key_name}=".to_sym )
+      @post.methods.include?( "#{key_name}=".to_sym ).should be_true
+    end
+  end
+
+  it "returns default value if none defined" do
+    @post.default_val_key.should == "The Default"
+  end
+
+  it "saves and returns the same value for keys" do
+    @post.string_key = "Ron Swanson"
+    @post.save
+    @post.reload
+    @post.string_key.should == "Ron Swanson"
+  end
+
+  it "sets a string value when assigned" do 
+    @post.string_key = "Hello"
+    @post.string_key.should == "Hello"
+  end
+
+  it "sets an integer value when assigned" do 
+    @post.integer_key = 123
+    @post.integer_key.should == 123
+    @post.integer_key.class.should == Fixnum
+  end
+  
+  it "sets a decimal value when assigned" do 
+    @post.decimal_key = 12.21
+    @post.decimal_key.should == 12.21
+    @post.decimal_key.class.should == Float
+  end
+  
+  it "sets a boolean value when assigned" do 
+    @post.bool_key = true
+    @post.bool_key.should be_true
+    @post.bool_key = false
+    @post.bool_key.should be_false
+  end
+
+  it "sets a datetime value when assigned" do 
+    d0 = DateTime.now
+    @post.date_key = d0
+    @post.date_key.should == d0
+    @post.date_key.class.should == DateTime
+  end
+
+  it "defines with_ scope for indexed keys" do
+    %w(string_key integer_key decimal_key bool_key date_key default_val_key).each do |key_name|
+      User.methods.include?("with_#{key_name}".to_sym).should be_true
+    end
+  end
+
+  it "does not define with_ scope for non-indexed keys" do
+    User.methods.include?(:with_indexless_key).should be_false
+  end
+
+  it "finds objects via the scope and index" do
+    @post.string_key = "Champion"
+    @post.save
+    find_results = User.with_string_key("Champion")
+    find_results.length.should == 1
+    find_results.first.should == @post
+  end
+
+end # column_stage
+
+