activerecord_idnamecache 0.0.3 → 0.0.4

data/README.markdown

@@ -0,0 +1,59 @@
+activerecord_idnamecache
+==========================================
+Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string.
+It means to reduce the database storage size, and improve query performance.
+
+All cache will store in process memory, and will never be expired, until the process dies, so the less kvs you use, the better performance you will get. BTW, 100,0000 general strings use 10MB memory.
+
+Some relatived articles:
+http://en.wikipedia.org/wiki/Correlation_database
+
+Usage
+------------------------------------------
+## setup
+
+```ruby
+create_table :kv_browser_names, :options => 'ENGINE=MyISAM DEFAULT CHARSET=utf8' do |t|
+  t.string :name
+  t.timestamps
+end
+
+class KvBrowserName < ActiveRecord::Base
+  include IdNameCache
+end
+```
+
+or
+
+```ruby
+create_table :common_tag, :options => 'ENGINE=MyISAM DEFAULT CHARSET=utf8' do |t|
+  t.integer :tagid
+  t.string  :tagname
+end
+
+class CommonTag < ActiveRecord::Base
+  self.table_name = :common_tag
+  self.primary_key = :tagid
+
+  include IdNameCache; set_key_value :tagid, :tagname
+  # include IdNameCache; set_key_value_without_create :tagid, :tagname # if you dont want create it automately
+end
+```
+
+### use cases
+
+```text
+ruby-1.9.3-rc1 :001 > QuizTag[1]
+  QuizTag Load (0.3ms)  SELECT `common_tag`.* FROM `common_tag` WHERE `common_tag`.`tagid` = 1 LIMIT 1
+ => "Android"
+ruby-1.9.3-rc1 :002 > QuizTag[1]
+ => "Android"
+ruby-1.9.3-rc1 :003 > QuizTag['Android']
+  QuizTag Load (0.5ms)  SELECT `common_tag`.* FROM `common_tag` WHERE `common_tag`.`tagname` = 'Android' LIMIT 1
+ => 1
+ruby-1.9.3-rc1 :004 > QuizTag['Android']
+ => 1
+ ```
+
+== Copyright
+MIT, David Chen at eoe.cn

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/activerecord_idnamecache.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'activerecord_idnamecache'
   s.version     = File.read("VERSION").strip
-  s.date        = '2013-05-31'
-  s.summary     = "Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string."
-  s.description = s.summary + " If cache hit ratio is high, performance will be better, and so does the memory usage rate"
+  s.date        = '2013-06-22'
+  s.summary     = File.read("README.markdown").split(/===+/)[0].strip
+  s.description = s.summary
   s.authors     = ["David Chen"]
   s.email       = 'mvjome@gmail.com'
   s.homepage    = 'http://github.com/mvj3/activerecord_idnamecache'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord_idnamecache
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-31 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies: []
-description: Use Mysql AUTO_INCREMENT to support key value cache, which should be
-  combined by an integer and string. If cache hit ratio is high, performance will
-  be better, and so does the memory usage rate
+description: activerecord_idnamecache
 email: mvjome@gmail.com
 executables: []
 extensions: []
@@ -22,8 +20,7 @@ files:
 - .document
 - .gitignore
 - Gemfile
-- LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - activerecord_idnamecache.gemspec
@@ -53,6 +50,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Use Mysql AUTO_INCREMENT to support key value cache, which should be combined
-  by an integer and string.
+summary: activerecord_idnamecache
 test_files: []

data/LICENSE.txt

@@ -1,20 +0,0 @@
-Copyright (c) 2013 David Chen
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-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.

data/README.rdoc

@@ -1,60 +0,0 @@
-= activerecord_idnamecache
-
-Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string.
-It means to reduce the database storage size, and improve query performance.
-
-Some relatived articles:
-http://en.wikipedia.org/wiki/Correlation_database
-
-== Usage
-
-=== setup
-  create_table :kv_browser_names, :options => 'ENGINE=MyISAM DEFAULT CHARSET=utf8' do |t|
-    t.string :name
-    t.timestamps
-  end
-
-  class KvBrowserName < ActiveRecord::Base
-    include IdNameCache
-  end
-
-or
-
-  create_table :common_tag, :options => 'ENGINE=MyISAM DEFAULT CHARSET=utf8' do |t|
-    t.integer :tagid
-    t.string  :tagname
-  end
-
-  class CommonTag < ActiveRecord::Base
-    self.table_name = :common_tag
-    self.primary_key = :tagid
-
-    include IdNameCache; set_key_value :tagid, :tagname
-    # include IdNameCache; set_key_value_without_create :tagid, :tagname # if you dont want create it automately
-  end
-
-=== use cases
-ruby-1.9.3-rc1 :001 > QuizTag[1]
-  QuizTag Load (0.3ms)  SELECT `common_tag`.* FROM `common_tag` WHERE `common_tag`.`tagid` = 1 LIMIT 1
- => "Android"
-ruby-1.9.3-rc1 :002 > QuizTag[1]
- => "Android"
-ruby-1.9.3-rc1 :003 > QuizTag['Android']
-  QuizTag Load (0.5ms)  SELECT `common_tag`.* FROM `common_tag` WHERE `common_tag`.`tagname` = 'Android' LIMIT 1
- => 1
-ruby-1.9.3-rc1 :004 > QuizTag['Android']
- => 1
-
-== Contributing to activerecord_idnamecache
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 David Chen at eoe.cn. See LICENSE.txt for further details.