entity_storage 2.0.0 → 2.1.0

data/README.rdoc

@@ -13,26 +13,26 @@ Additionally, allows users to set a list of default keys that auto-initializes b
 == SYNOPSIS:
 
 You can use the entity store like so:
-     
-    # Get key value. 
+
+    # Get key value.
     e = EntityStore["testkey"]
     e = EntityStore.testkey
     e = EntityStore[:testkey]
-    
+
     # sets key named 'happened' to a Time object of now
     EntityStore[:happened] = Time.now
     EntityStore["happened"] = Time.now
     EntityStore.happened = Time.now
-    
+
     # 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)
-    
+
     # delete an item
     EntityStore.delete(key)
 
@@ -43,41 +43,37 @@ If you access a key that doesn't exist, and is specified in default list, will b
 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.
 
 == REQUIREMENTS:
-As of 1.0.5, requires ActiveRecord 3.0.0.beta4 or greater.
+As of 2.1.0, the MySQL2 gem and Ruby 1.9.3 are now supported.
 
-Version up to 1.0.4 requires Ruby 1.8.7 and ActiveRecord 2.2.3 or above (probably works with earlier versions, but has not been tested.)
+As of 2.0.0, Rails 3.0.3 gems or above required.
 
+Version up to 1.0.4 requires Ruby 1.8.7 and ActiveRecord 2.2.3 or above (probably works with earlier versions, but has not been tested.)
+(earlier versions had an incorrect gem name, and are installed with 'gem install entity_storage')
 == INSTALL:
-To install from github:
+Install the gem(s):
 
-    Run the following if you haven't already:
-    
-    gem sources -a http://gems.github.com
-    
-    Install the gem(s):
-    
-    sudo gem install eatenbyagrue-entity_storage
+    sudo gem install entity_storage
 
-Or download the souce above and run, customized for version and environment:
+Or download the source above and run, customized for version and environment:
 
-    sudo gem install PATH/entity_storage.#.#.#.gem 
+    sudo gem install PATH/entity_storage.#.#.#.gem
 
-Put the following at the bottom of your environment.rb file, or in an initializer.
+Put the following in an initializer file named RAILS_ROOT/config/initializers/entity_storage.rb
 
     require 'entity_storage'
     DEFAULT_KEYS = { "testkey" => DateTime.parse("1-1-900"), "also test" => 2, "long ass key that I probably wouldn't use" => false }
-    EntityStore = EntityStorage::Storage.new(DEFAULT_KEYS) 
+    EntityStore = EntityStorage::Storage.new(DEFAULT_KEYS)
 
 On initialization, if the table "entity_storage" doesn't exist, it will be created. If you already have a table with that name, it must be in the correct format (previously created by this gem.)
 
-You can pass a hash full of default key/value pairs. If the application accesses one of the keys, and it doesn't already exist, it will initiliaze that key with the default value. Good for getting your app to an intial starting state.
+You can pass a hash full of default key/value pairs. If the application accesses one of the keys, and it doesn't already exist, it will initiliaze that key with the default value. Good for getting your app to an initial starting state.
 
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 Joshua Siler
+Copyright (c) 2009, 2010, 2011 Joshua Siler
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -96,4 +92,4 @@ 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.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -17,8 +17,8 @@ $hoe = Hoe.spec 'entity-storage' do
   self.extra_deps         = [['activerecord','>= 3.0.3']]
 end
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+#require 'newgem/tasks'
+#Dir['tasks/**/*.rake'].each { |t| load t }
 
 # TODO - want other tests/tasks run by default? Add them to the list
 # remove_task :default

data/config/database.yml

@@ -1,8 +1,8 @@
 
-    adapter: mysql
+    adapter: mysql2
     database: entity_test
     username: root
-    password: bnjstyle
+    password: sillier2
     host: localhost
 
 

data/lib/entity_storage.rb

@@ -9,18 +9,26 @@ require 'active_record'
 
 
 module EntityStorage
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 
   class Storage
     attr_accessor :defaults
 
     # Checks for the existence of the necessary Entities table... if not here, creates it.
     def initialize(defaults={})
-      unless ActiveRecord::Base.connection.table_exists?('entity_storage')
+      if !ActiveRecord::Base.connection.table_exists?('entity_storage')
+				puts "Creating entity table..."
 				AddEntitiesTable.create
-      end
+			end
 
       self.defaults = defaults
+      
+      # this will need to be updated for future version changes
+      if self['ENTITY_STORAGE_MASTER_VERSION'].nil? || self['ENTITY_STORAGE_MASTER_VERSION']!='2.1.0'
+				self['ENTITY_STORAGE_MASTER_VERSION']='2.1.0'
+				puts "Migrating to new 2.1.0 binary format..."
+				ActiveRecord::Base.connection.execute("alter table entity_storage modify value blob")
+			end
     end
 
     # Read a value.
@@ -51,7 +59,7 @@ module EntityStorage
 
     # Allows EntityStorage[:whatever] to be accessed via EntityStorage.whatever.
     def method_missing(*args)
-      if args.length == 1
+			if args.length == 1
 				self[args[0]]
 			elsif args.length == 2 and args[0].to_s =~ /^(.*)=$/
 				self[$1.intern] = args[1]
@@ -68,7 +76,8 @@ module EntityStorage
     def self.create
       create_table "entity_storage", :force => true do |t|
 				t.string   "key",        :limit => 512, :null => false
-				t.text     "value"
+				#t.text     "value"
+				t.binary     "value"
 				t.datetime "created_at"
 				t.datetime "updated_at"
       end
@@ -78,11 +87,8 @@ module EntityStorage
       add_index "entity_storage", ["updated_at"], :name => "updated_at"
     end
 
-    #def self.down
-    #  drop_table :entities
-    #end
   end
-
+  
 
   class Entity < ActiveRecord::Base
     set_table_name "entity_storage"

data/test/test_entity_storage.rb

@@ -13,7 +13,7 @@ class TestEntityStorage < Test::Unit::TestCase
 	EntityStore = EntityStorage::Storage.new(DEFAULT_KEYS)
 	
   def setup
-    ActiveRecord::Base.connection.execute("delete from entity_storage")
+    #ActiveRecord::Base.connection.execute("delete from entity_storage")
   end
   
   def test_instantiation
@@ -24,6 +24,7 @@ class TestEntityStorage < Test::Unit::TestCase
   
   # tests value setting and getting functionality, along with default creation  
   def test_defaultkeys
+		ActiveRecord::Base.connection.execute("delete from entity_storage")
     DEFAULT_KEYS.each { |key,value| 
       EntityStore.delete(key)
       
@@ -34,7 +35,7 @@ class TestEntityStorage < Test::Unit::TestCase
       EntityStore.delete(key)
       
       # set and try method missing access
-      if key[/\w/] == key
+			if key[/\w/] == key
 				eval("e = EntityStore."+key)
 				assert_equal e, value
 			end
@@ -58,7 +59,7 @@ class TestEntityStorage < Test::Unit::TestCase
       
       # set it to something else using method missing
       if key[/\w/] == key
-				eval("e = EntityStore."+key +" = Time.now.to_s")
+				eval("e = EntityStore." + key + " = Time.now.to_s")
 				assert_equal e, value
       end 
     }

metadata

@@ -1,87 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: entity_storage
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 2
-  - 0
-  - 0
-  version: 2.0.0
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Joshua Siler
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-10 00:00:00 -08:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &71589300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 0
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.3
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *71589300
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &71588720 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 0
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.3
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *71588720
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &71588360 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 2
-        - 3
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.3.3
   type: :development
-  version_requirements: *id003
-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: 
+  prerelease: false
+  version_requirements: *71588360
+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: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
-files: 
+files:
 - History.txt
 - Manifest.txt
 - README.rdoc
@@ -93,43 +74,32 @@ files:
 - config/database.yml
 - test/test_entity_storage.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/eatenbyagrue/entity_storage
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: entity-storage
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: An easy to use Key/Value store for any Ruby on Rails project
-test_files: 
+test_files:
 - test/test_entity_storage.rb
 - test/test_helper.rb