eatenbyagrue-entity_storage 1.0.2 → 1.0.4

data/History.txt

@@ -1,3 +1,9 @@
+=== 1.0.4 2009-09-23
+* Fixed edge case bug with defaults and accessors with underscores
+
+=== 1.0.3 2009-09-23
+* updated tests and example docs
+
 === 1.0.2 2009-09-21
 * changed method of table discovery for auto table creation
 

data/README.rdoc

@@ -4,16 +4,17 @@ http://github.com/eatenbyagrue/entity_storage
 
 == DESCRIPTION:
 
-An easy to use, persistent Key/Value store for any Ruby on Rails project. Designed to store config values & application wide state that need to survive server restarts.
+An easy to use Key/Value store for any Ruby on Rails project. Like Memcache, only persistent. Stores config values & application wide state in the database in order to survive server restarts.
 
-Additionally, allows users to set a list of default keys that auto-initiliazes baseline key/value pairs in the database for easy initialization.
+Designed to allow you to add persistent value storage to any Rails project in about 5 minutes.
+
+Additionally, allows users to set a list of default keys that auto-initializes baseline key/value pairs in the database for easy initialization.
 
 == SYNOPSIS:
 
 You can use the entity store like so:
      
-    # Get key value. If it doesn't exist and is specified in default list, will be initialized and returned.
-    # If not in default list, will return nil.
+    # Get key value. 
     e = EntityStore["testkey"]
     e = EntityStore.testkey
     e = EntityStore[:testkey]
@@ -25,6 +26,9 @@ You can use the entity store like so:
     
     # find out it's default, even if it's been changed
     e = EntityStore.default(:testkey)
+    
+    # or
+    e = EntityStore.defaults[:testkey]
    
     # set it back to default
     EntityStore.default!(:testkey)
@@ -32,7 +36,9 @@ You can use the entity store like so:
     # delete an item
     EntityStore.delete(key)
 
-All EntityStorage operations sync immediately with the database, so a server shutdown will not impact stored values. 
+All EntityStorage operations sync immediately with the database, so a server shutdown will not impact stored values.
+
+If you access a key that doesn't exist, and is specified in default list, will be initialized and returned. If not in default list, will return nil.
 
 Keys can be up to 512 characters in length. Values can be practically any size, and consist of any object. Objects are marshalled back and forth between database.
 

data/config/database.yml

@@ -1,8 +1,8 @@
 
     adapter: mysql
-    database: test
+    database: careers
     username: root
-    password: 
+    password: bnjstyle
     host: localhost
 
 

data/lib/entity_storage.rb

@@ -5,7 +5,7 @@ require 'rubygems'
 require 'activerecord'
 
 module EntityStorage
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
   
   class Storage
     attr_accessor :defaults
@@ -21,7 +21,7 @@ module EntityStorage
     
     # Read a value.
     def [](index)
-      Entity.get_value(index,defaults[index])
+      Entity.get_value(index,@defaults[index.to_s])
     end
     
     # Write a value.
@@ -37,23 +37,23 @@ module EntityStorage
     # Returns the default value of a key contained in DEFAULT_KEYS global constant.
     # Does not change the stored value. Use default! to reset the value.
     def default(index)
-      self.defaults[:index]
+      @defaults[index.to_s]
     end
   
     # Resets the default value of a key contained in DEFAULT_KEYS global constant and returns the value.
     def default!(index)
-      Entity.reset_value(index,defaults[index])
+      Entity.reset_value(index,@defaults[index.to_s])
     end
     
     # Allows EntityStorage[:whatever] to be accessed via EntityStorage.whatever.
     def method_missing(*args)
       if args.length == 1
-	  self[args[0]]
-	elsif args.length == 2 and args[0].to_s =~ /^(.*)=$/
-	  self[$1.intern] = args[1]
-	else
-	  super
-	end
+				self[args[0]]
+			elsif args.length == 2 and args[0].to_s =~ /^(.*)=$/
+				self[$1.intern] = args[1]
+			else
+			 super
+			end
     end
   end
   
@@ -88,8 +88,8 @@ module EntityStorage
     # If not found, will initialize according to defaults set in DEFAULT_KEYS global constant.
     def self.get_value(search_key,default_value)
       e = Entity.find_by_key(search_key.to_s)
-      if e.nil?
-	e = initialize_value(search_key,default_value)
+      if e.nil? || e.value.nil?
+				e = initialize_value(search_key,default_value)
       end
       e.value rescue nil
     end
@@ -98,7 +98,7 @@ module EntityStorage
     def self.set_value(search_key, new_value)
       e = Entity.find_by_key(search_key.to_s)
       if e.nil?
-	e = new
+				e = new
       end
       e.key = search_key
       e.value = new_value

data/test/test_entity_storage.rb

@@ -1,89 +1,106 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
+ActiveRecord::Base.establish_connection(YAML::load(File.read(File.dirname(__FILE__) + '/../config/database.yml')))
 
 class TestEntityStorage < Test::Unit::TestCase
-  DEFAULT_KEYS = { "test" => DateTime.parse("1-1-900"), "also test" => 2, "long ass key that I probably wouldn't use" => false }
-  attr_accessor :entity_storage
+  DEFAULT_KEYS = { "test" => DateTime.parse("1-1-900"), "also test" => 2, "long ass key that I probably wouldn't use" => false,
+	# last time the hiring manager notifications have been run 
+  "new_applicant_last_run" => DateTime.parse("1-1-1900"),
+  # last time the new job notifications have been run 
+  "new_jobs_last_run" => DateTime.parse("1-1-1900"),
+  "email_test_address" => "joshuas@bnj.com" }
   
+  attr_accessor :EntityStore
+	EntityStore = EntityStorage::Storage.new(DEFAULT_KEYS)
+	
   def setup
-    ActiveRecord::Base.establish_connection(YAML::load(File.read(File.dirname(__FILE__) + '/../config/database.yml'))) unless ActiveRecord::Base.connected?
-    self.entity_storage ||= EntityStorage::Storage.new(DEFAULT_KEYS) 
+    ActiveRecord::Base.connection.execute("delete from entity_storage")
+  end
+  
+  def test_instantiation
+		# test nasty weird bug with underscore characters
+		entityStore2 = EntityStorage::Storage.new(DEFAULT_KEYS)
+		assert_equal entityStore2.email_test_address, 'joshuas@bnj.com'
   end
   
   # tests value setting and getting functionality, along with default creation  
   def test_defaultkeys
     DEFAULT_KEYS.each { |key,value| 
-      self.entity_storage.delete(key)
+      EntityStore.delete(key)
       
       # set key when it doesn't exist, should go to default
-      e = self.entity_storage[key]
+      e = EntityStore[key]
       assert_equal e, value
       
+      EntityStore.delete(key)
+      
       # set and try method missing access
       if key[/\w/] == key
-	eval("e = self.entity_storage."+key)
-	assert_equal e, value
-      end
+				eval("e = EntityStore."+key)
+				assert_equal e, value
+			end
       
       # change it to something else
-      self.entity_storage[key] = Time.now.to_s
-      e = self.entity_storage[key]
+      EntityStore[key] = Time.now.to_s
+      e = EntityStore[key]
       assert_not_equal e, value
       
       # find out it's default
-      e = self.entity_storage.default(key)
-      assert_not_equal e, value
+      e = EntityStore.default(key)
+      assert_equal e, value
+      
+      e = EntityStore.defaults[key]
+      assert_equal e, value
       
       # set it back to default
-      self.entity_storage.default!(key)
-      e = self.entity_storage[key]
+      EntityStore.default!(key)
+      e = EntityStore[key]
       assert_equal e, value
       
       # set it to something else using method missing
       if key[/\w/] == key
-	eval("e = self.entity_storage."+key +" = Time.now.to_s")
-	eval("e = self.entity_storage."+key)
-	assert_equal e, value
+				eval("e = EntityStore."+key +" = Time.now.to_s")
+				assert_equal e, value
       end 
     }
   end
   
   # tests setting values when no DEFAULT_KEY exists
   def test_settingvalues
-    self.entity_storage.delete('test')
+    EntityStore.delete('test')
     
     # key that can't be accessed via method missing
     # set value and check it
-    self.entity_storage['big long key that cannot be accessed via method missing'] = 'what up'
-    e = self.entity_storage['big long key that cannot be accessed via method missing']
+    EntityStore['big long key that cannot be accessed via method missing'] = 'what up'
+    e = EntityStore['big long key that cannot be accessed via method missing']
     assert_equal e, 'what up'
     
     # set another value and check it
-    self.entity_storage['big long key that cannot be accessed via method missing'] = 'another value'
-    e = self.entity_storage['big long key that cannot be accessed via method missing']
+    EntityStore['big long key that cannot be accessed via method missing'] = 'another value'
+    e = EntityStore['big long key that cannot be accessed via method missing']
     assert_equal e, 'another value'
     
-    self.entity_storage['test'] = 'what up'
-    e = self.entity_storage['test']
+    EntityStore['test'] = 'what up'
+    e = EntityStore['test']
     assert_equal e, 'what up'
     
-    self.entity_storage['test'] = 'another value'
-    e = self.entity_storage['test']
+    EntityStore['test'] = 'another value'
+    e = EntityStore['test']
     assert_equal e, 'another value'
     
     # try the method missing version of the tests
-    e = self.entity_storage.test = 'what up'
-    e = self.entity_storage.test
+    e = EntityStore.test = 'what up'
+    e = EntityStore.test
     assert_equal e, 'what up'
     
-    e = self.entity_storage.test = 'another value'
-    e = self.entity_storage.test
+    e = EntityStore.test = 'another value'
+    e = EntityStore.test
     assert_equal e, 'another value'
     
   end
   
   def test_getunknownvalue
-    self.entity_storage.delete('does not exist')
-    e = self.entity_storage['does not exist']
+    EntityStore.delete('does not exist')
+    e = EntityStore['does not exist']
     assert_nil e
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eatenbyagrue-entity_storage
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors: 
 - Joshua Siler
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-21 00:00:00 -07:00
+date: 2009-09-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.3
     version: 
-description: An easy to use, persistent Key/Value store for any Ruby on Rails project. Designed to store config values & application wide state that need to survive server restarts.  Additionally, allows users to set a list of default keys that auto-initiliazes baseline key/value pairs in the database for easy initialization.
+description: An easy to use Key/Value store for any Ruby on Rails project. Like Memcache, only persistent. Stores config values & application wide state in the database in order to survive server restarts.  Designed to allow you to add persistent value storage to any Rails project in about 5 minutes.  Additionally, allows users to set a list of default keys that auto-initializes baseline key/value pairs in the database for easy initialization.
 email: 
 - joshua.siler@gmail.com
 executables: []
@@ -81,7 +81,7 @@ rubyforge_project: entity_storage
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: An easy to use, persistent Key/Value store for any Ruby on Rails project
+summary: An easy to use Key/Value store for any Ruby on Rails project
 test_files: 
 - test/test_entity_storage.rb
 - test/test_helper.rb