nifty-key-value-store 1.0.0

data/lib/nifty/key_value_store.rb

@@ -0,0 +1,2 @@
+require 'nifty/key_value_store/version'
+require 'nifty/key_value_store/railtie' if defined?(Rails)

data/lib/nifty/key_value_store/key_value_pair.rb

@@ -0,0 +1,21 @@
+# == Schema Information
+#
+# Table name: nifty_key_value_pairs
+#
+#  id          :integer          not null, primary key
+#  parent_id   :integer
+#  parent_type :string(255)
+#  group       :string(255)
+#  name        :string(255)
+#  value       :string(255)
+#
+module Nifty
+  module KeyValueStore
+    
+    class KeyValuePair < ::ActiveRecord::Base
+      self.table_name = 'nifty_key_value_store'
+      belongs_to :parent, :polymorphic => true
+    end
+    
+  end
+end

data/lib/nifty/key_value_store/migration.rb

@@ -0,0 +1,14 @@
+class CreateNiftyKeyValueStoreTable < ActiveRecord::Migration
+  
+  def up
+    create_table :nifty_key_value_store do |t|
+      t.integer :parent_id
+      t.string  :parent_type, :group, :name, :value
+    end
+  end
+  
+  def down
+    drop_table :nifty_key_value_store
+  end
+  
+end

data/lib/nifty/key_value_store/migration_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Nifty
+  module KeyValueStore
+    class MigrationGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      
+      source_root File.expand_path("../", __FILE__)
+      
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+      
+      def create_model_file
+        migration_template 'migration.rb', "db/migrate/create_nifty_key_value_store_table"
+      end
+      
+    end
+  end
+end

data/lib/nifty/key_value_store/model_extension.rb

@@ -0,0 +1,87 @@
+module Nifty
+  module KeyValueStore
+    module ModelExtension
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def key_value_stores
+          @key_value_stores ||= []
+        end
+  
+        def key_value_store(*names)
+          
+          unless self.reflect_on_all_associations(:has_many).map(&:name).include?(:nifty_key_value_pairs)
+            has_many :nifty_key_value_pairs, :as => :parent, :dependent => :destroy, :class_name => 'Nifty::KeyValueStore::KeyValuePair'
+            after_save :save_custom_values_to_db
+          end
+          
+          names.each do |name|
+            key_value_stores << name
+      
+            # Getter
+            define_method name do
+              if value = instance_variable_get("@#{name}")
+                value
+              else
+                instance_variable_set "@#{name}", get_custom_values_for(name)
+              end
+            end
+      
+            # JSON Getter
+            define_method "#{name}_json" do
+              send(name).to_json
+            end
+      
+            # Setter
+            define_method "#{name}=" do |value|
+              instance_variable_set("@#{name}", value)
+            end
+      
+            # JSON Setter
+            define_method "#{name}_json=" do |value|
+              send("#{name}=", JSON.parse(value))
+            end
+      
+          end
+        end
+      end
+
+      # Get the values for a given group as a hash from the database without caching
+      def get_custom_values_for(group)
+        nifty_key_value_pairs.where(:group => group).inject({}) do |hash, value|
+          hash[value.name] = value.value
+          hash
+        end
+      end
+
+      # Save all custom values in the appropriate methods to the 
+      def save_custom_values_to_db
+        # get the existing joins ready
+        existing_joins = self.nifty_key_value_pairs
+        # go through all groups
+        self.class.key_value_stores.each do |group|
+          db_values     = get_custom_values_for(group)
+          local_values  = self.send(group).delete_if { |k,v| v.blank? }
+    
+          # remove any keys which no longer exist
+          keys_to_remove = db_values.keys - local_values.keys
+          self.nifty_key_value_pairs.where(:group => group, :name => keys_to_remove).destroy_all unless keys_to_remove.empty?
+    
+          # add/update all remaining keys
+          local_values.each do |key, value|
+            if existing_join = existing_joins.select { |j| j.group == group.to_s && j.name == key}.first
+              existing_join.value = value
+              existing_join.save
+            else
+              self.nifty_key_value_pairs.create(:group => group, :name => key, :value => value)
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/nifty/key_value_store/railtie.rb

@@ -0,0 +1,21 @@
+module Nifty
+  module KeyValueStore
+    class Railtie < Rails::Railtie #:nodoc:
+      
+      initializer 'nifty.key_value_store.initialize' do
+
+        ActiveSupport.on_load(:active_record) do
+          require 'nifty/key_value_store/key_value_pair'
+          require 'nifty/key_value_store/model_extension'
+          ::ActiveRecord::Base.send :include, Nifty::KeyValueStore::ModelExtension
+        end
+        
+      end
+      
+      generators do
+        require 'nifty/key_value_store/migration_generator'
+      end
+      
+    end
+  end
+end

data/lib/nifty/key_value_store/version.rb

@@ -0,0 +1,5 @@
+module Nifty
+  module KeyValueStore
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: nifty-key-value-store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-06 00:00:00.000000000 Z
+dependencies: []
+description: A key value store controller for Rails models
+email:
+- adam@niftyware.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nifty/key_value_store/key_value_pair.rb
+- lib/nifty/key_value_store/migration.rb
+- lib/nifty/key_value_store/migration_generator.rb
+- lib/nifty/key_value_store/model_extension.rb
+- lib/nifty/key_value_store/railtie.rb
+- lib/nifty/key_value_store/version.rb
+- lib/nifty/key_value_store.rb
+homepage: https://github.com/niftyware/key-value-store
+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: A key value store controller for Rails models
+test_files: []