vuderacha-activekv 0.0.0

data/README.rdoc

@@ -0,0 +1,34 @@
+= ActiveKV: Active Key/Value objects
+ActiveKV provides a wrapper around Moneta to allow for active objects that can be
+searched and persisted into configured key value stores. Values are serialised JSON.
+
+== Getting Started
+Create an ActiveKV configuration file:
+  -- config/kv.yml
+  development:
+    default:
+      driver: memory
+  test:
+    default:
+      driver: memory
+
+Initialise the ActiveKV infrastructure:
+  require 'activekv'
+  ActiveKV::Base.configure('config/kv.yml')
+
+Create your ActiveKV object:
+  class MyPersistentObj < ActiveKV::Base
+    key           :name
+    attr_accessor :x
+  end
+
+Store your object:
+  o = MyPersistentObj.new
+  o.name = "asdasd"
+  o.x = 12
+  o.save! 
+
+Load your object:
+  r = MyPersistentObj.find("asdasd")
+  p r.name
+  p r.x

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all examples"
+Spec::Rake::SpecTask.new('examples') do |t|
+  t.spec_opts  = ["-cfs"]
+  t.spec_files = FileList['spec/**/*.rb']
+end
+
+desc "Print specdocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+	t.spec_opts = ["--format", "specdoc", "--dry-run"]
+	t.spec_files = FileList['spec/*_spec.rb']
+end
+
+desc "Generate RCov code coverage report"
+Spec::Rake::SpecTask.new('rcov') do |t|
+	t.spec_files = FileList['spec/*_spec.rb']
+	t.rcov = true
+	t.rcov_opts = ['--exclude', 'examples']
+end
+
+task :default => :spec
+
+######################################################
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+require 'jeweler'
+include FileUtils
+# $:.push File.join(File.dirname(__FILE__), 'lib')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "activekv"
+  	s.summary = "Ruby Active Key/Value Objects."
+  	s.description = "ActiveKV provides ActiveRecord style data storage for Key/Value stores."
+  	s.author = "Paul Jones"
+  	s.email = "pauljones23@gmail.com"
+  	s.homepage = "http://github.com/vuderacha/activekv/"
+  	
+  	s.files = %w(Rakefile README.rdoc) + Dir.glob("{bin,lib,spec}/**/*")
+  	s.require_path = "lib"
+  	s.add_dependency('activesupport', '>= 2.2.2')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+task :test => [ :spec ]
+
+Rake::RDocTask.new do |t|
+	t.rdoc_dir = 'rdoc'
+	t.title    = "ActiveKV -- Active Key/Value Objects"
+	t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+	t.options << '--charset' << 'utf-8'
+	t.rdoc_files.include('README.rdoc')
+	t.rdoc_files.include('lib/activekv/*.rb')
+end
+
+CLEAN.include [ 'build/*', '**/*.o', '**/*.so', '**/*.a', 'lib/*-*', '**/*.log', 'pkg', 'lib/*.bundle', '*.gem', '.config' ]

data/lib/activekv/base.rb

@@ -0,0 +1,150 @@
+module ActiveKV
+  class Base
+    # Default the key property and configured state to empty states
+    @@configured = nil, false
+    
+    def initialize(config = {})
+      apply_hash!(config)
+    end
+    
+    # Configures the ActiveKV support with the given configuration file
+    def self.configure(config_file)
+      # Determine our environment
+      env = if defined? RACK_ENV then RACK_ENV else :development end
+        
+      # Load the configuration, and find the appropriate section
+      config = YAML::load_file(config_file)
+      env_config = config[env.to_s]
+      if env_config.nil?
+        raise "No configuration found for environment #{env}"
+      end
+      
+      # Work through each store
+      @@stores = {}
+      @@default_store = nil
+      env_config.each do |store_name, store_config|
+        @@stores[store_name] = load_store(store_name, store_config)
+        @@default_store = @@stores[store_name] if @@default_store.nil?
+      end
+      
+      # Remember that we're configured
+      @@configured = true
+    end
+    
+    # Prepares a configuration store based on the given configuration
+    def self.load_store(name, config)
+      raise "No driver specified in configuration #{store_name}" if config['driver'].nil?
+      
+      # Try to create a store driver
+      driver_name = config.delete 'driver'
+      require "moneta/#{driver_name}"
+      class_name = Moneta.constants.find { |c| c.to_s.downcase == driver_name.gsub(/_/, "").downcase }
+      raise "No implementation found for driver #{config['driver']}" if class_name.nil?
+      driver_class = Moneta.const_get(class_name)
+      driver_class.new transform_hash(config)
+    end
+    
+    # Requests that the ActiveKV forget its configuration
+    def self.unconfigure!
+      @@configured = false
+    end
+    
+    class << self # Class Methods
+      # Sets the property that will be used to work out the key for the item
+      def key(key_prop = nil)
+        if key_prop.nil?
+          return nil if not defined? @key_prop
+          return @key_prop
+        end
+        
+        @key_prop = key_prop
+        attr_accessor key_prop
+      end
+    
+      # Changes the pattern used to build keys
+      def key_pattern(pattern = nil)
+        if pattern.nil?
+          return ":class/:key" if not defined? @key_pattern or @key_pattern.nil?
+          return @key_pattern
+        end
+        
+        @key_pattern = pattern
+      end
+      
+      # Sets the store that is used for instances of this class
+      def store(name)
+        @store = name
+      end
+      
+      # Finds a record with the given key
+      def find(key)
+        # Create the key and lookup the value
+        key_val = create_key key
+        found_val = store_instance[key_val]
+        return nil if found_val.nil? or found_val == {}
+          # Check if result is {}, because the memory implementation returns this as a default value
+          # when the real value isn't found
+        
+        # Decode the found value, then apply each property in the JSON to the object
+        vals = ActiveSupport::JSON.decode(found_val)
+        result = new
+        result.apply_hash!(vals)
+        result
+      end
+
+      # Creates a store key based on the pattern and provided key
+      def create_key(key)
+        key_pattern.gsub(':class', self.name).gsub(':key', key)
+      end
+      
+      # Retrieves an instance of the store that is used for this class
+      def store_instance
+        if defined? @store and defined? @@stores[@store] then 
+          @@stores[@store] 
+        else 
+          @@default_store 
+        end
+      end
+    end
+    
+    # Saves the record to the appropriate datastore
+    def save!
+      # Ensure that we have everything we need
+      raise NotConfiguredError unless @@configured
+      raise NoKeySpecifiedError if self.class.key.nil?
+      raise NilKeyError if send(self.class.key).nil?
+      
+      # Transform ourselves to json, and get our key
+      new_val = to_json
+      key_val = self.class.create_key send(self.class.key)
+      
+      # Retrieve the appropriate store, and save
+      self.class.store_instance[key_val] = new_val
+    end
+    
+    def apply_hash!(props)
+      props.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+    
+    # Transforms a hash so it also indexes by symbol
+    def self.transform_hash h
+      result = {}
+      h.each do |k,v|
+        result_v = if v.is_a? Hash then transform_hash(v) else v end
+        
+        result[k] = result_v
+        result[k.to_sym] = result_v
+      end
+      result
+    end
+  end
+  
+  class NotConfiguredError < Exception
+  end
+  class NilKeyError < Exception
+  end
+  class NoKeySpecifiedError < Exception
+  end
+end

data/lib/activekv.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+begin
+  require 'moneta'
+rescue LoadError
+  puts "You need the moneta gem to use ActiveKV"
+  exit
+end
+begin
+  require 'active_support'
+rescue LoadError
+  puts "You need the ActiveSupport gem to use ActiveKV"
+  exit
+end
+require 'activekv/base'

data/spec/base.rb

@@ -0,0 +1,115 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')
+require 'activekv'
+
+RACK_ENV = :test unless defined? RACK_ENV
+
+describe "ActiveKV::Base" do
+  before do
+    ActiveKV::Base.unconfigure!
+  end
+  
+  it "should be inheritable" do
+    class InheritanceTest < ActiveKV::Base
+    end
+  end
+
+  it "should allow a configuration file to be provided" do
+    ActiveKV::Base.configure File.join(File.dirname(__FILE__), 'simple-config.yml')
+  end
+  
+  it "should fail to save an object if not configured" do
+    class Unconfigured < ActiveKV::Base
+    end
+    
+    u = Unconfigured.new
+    begin
+      u.save!
+      raise "Should not have allowed an instance to be saved when not configured"
+    rescue ActiveKV::NotConfiguredError
+    end
+  end
+  
+  it "should make the key available on the class" do
+    class WithKeyA < ActiveKV::Base
+      key  :a
+    end
+    class WithKeyB < ActiveKV::Base
+      key  :b
+    end
+    
+    WithKeyA.key.should == :a
+    WithKeyB.key.should == :b
+  end
+end
+
+describe "ActiveKV::Base when configured" do
+  before do
+    ActiveKV::Base.unconfigure!
+    ActiveKV::Base.configure File.join(File.dirname(__FILE__), 'simple-config.yml')
+  end
+  
+  it "should fail to save an object if no key is specified" do
+    class NoKey < ActiveKV::Base
+    end
+
+    u = NoKey.new
+    begin
+      u.save!
+      raise "Should not have allowed an instance to be saved when it does not specify a key"
+    rescue ActiveKV::NoKeySpecifiedError
+    end
+  end
+
+  it "should fail to save an object if key is nil" do
+    class WithKey < ActiveKV::Base
+      key :name
+    end
+
+    u = WithKey.new
+    begin
+      u.save!
+      raise "Should not have allowed an instance to be saved when key value is nil"
+    rescue ActiveKV::NilKeyError
+    end
+  end
+
+  it "should allow an object to be saved if configured and a key is specified" do
+    class WithKey < ActiveKV::Base
+      key :name
+    end
+
+    u = WithKey.new
+    u.name = 'TestName'
+    u.save!  
+  end
+  
+  it "should not find an object that has not been created" do
+    class NotFound < ActiveKV::Base
+    end
+    
+    NotFound.find('missing').should be_nil
+  end
+  
+  it "should find an object that has previously been saved" do
+    class Found < ActiveKV::Base
+      key :name
+    end
+    
+    f = Found.new
+    f.name = 'myname'
+    f.save!
+    
+    Found.find('myname').name.should == 'myname'
+  end
+  
+  it "should allow an object to be created with a hash of parameters" do
+    class WithSomeParams < ActiveKV::Base
+      key           :name
+      attr_accessor :another_prop
+    end
+    
+    p = WithSomeParams.new :name => 'asr', :another_prop => 'world'
+    p.name.should == 'asr'
+    p.another_prop.should == 'world'
+  end
+end

data/spec/simple-config.yml

@@ -0,0 +1,3 @@
+test:
+    default:
+        driver: memory

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: vuderacha-activekv
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Paul Jones
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.2
+    version: 
+description: ActiveKV provides ActiveRecord style data storage for Key/Value stores.
+email: pauljones23@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/activekv
+- lib/activekv/base.rb
+- lib/activekv.rb
+- spec/base.rb
+- spec/simple-config.yml
+has_rdoc: true
+homepage: http://github.com/vuderacha/activekv/
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby Active Key/Value Objects.
+test_files: []
+