activerecord_idnamecache 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,56 @@
+= activerecord_idnamecache
+
+Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string.
+
+== 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.

data/Rakefile

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "activerecord_idnamecache"
+  gem.homepage = "http://github.com/mvj3/activerecord_idnamecache"
+  gem.license = "MIT"
+  gem.summary = "Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string."
+  gem.description = gem.summary
+  gem.email = "mvjome@gmail.com"
+  gem.authors = ["David Chen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+=begin
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+=end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord_idnamecache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/activerecord_idnamecache.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activerecord_idnamecache"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David Chen"]
+  s.date = "2013-01-21"
+  s.description = "Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string."
+  s.email = "mvjome@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "activerecord_idnamecache.gemspec",
+    "lib/activerecord_idnamecache.rb",
+    "test/helper.rb",
+    "test/test_activerecord_idnamecache.rb"
+  ]
+  s.homepage = "http://github.com/mvj3/activerecord_idnamecache"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Use Mysql AUTO_INCREMENT to support key value cache, which should be combined by an integer and string."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord_idnamecache>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<bundler>, ["= 1.2.3"])
+    else
+      s.add_dependency(%q<activerecord_idnamecache>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<bundler>, ["= 1.2.3"])
+    end
+  else
+    s.add_dependency(%q<activerecord_idnamecache>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<bundler>, ["= 1.2.3"])
+  end
+end
+

data/lib/activerecord_idnamecache.rb

@@ -0,0 +1,62 @@
+# encoding: UTF-8
+
+require 'active_record'
+
+class ActiveRecord::Base
+  module IdNameCache
+    extend ActiveSupport::Concern
+
+    # TODO support memcache, if key is big
+    included do
+      cattr_accessor :idname_id, :idname_name
+      cattr_accessor :_hash_cache
+      cattr_accessor :could_create
+      self._hash_cache = Hash.new # Trie和Hash察看单个字符串性能比较 http://code.eoe.cn/code/32/
+      self.idname_id = :id
+      self.idname_name = :name
+      self.could_create = false
+    end
+
+    module ClassMethods
+      def [] key = nil
+        return nil if key.nil?
+
+        _k, _v = case key
+        when Fixnum, Integer
+          [:idname_id, :idname_name]
+        when String
+          key = key.strip
+          [:idname_name, :idname_id]
+        end
+        raise "#{key.inspect} [#{key.class}] Please use Integer or String" if _k.nil?
+
+        k = "#{self.send(_v)}/#{key}"[0..249]
+        v = self._hash_cache[k]
+        if v.nil?
+          m = self.could_create ? "find_or_create_by_" : "find_by_"
+          record = self.send("#{m}#{self.send(_k)}", key)
+          v = record.send(self.send(_v)) if record
+          self._hash_cache[k] = v
+        end
+        v
+      end
+
+      def set_key_value key, value
+        self.could_create = true
+        _set_key_value key, value
+      end
+      def set_key_value_without_create key, value
+        self.could_create = false
+        _set_key_value key, value
+      end
+
+      private
+      def _set_key_value key, value
+        raise "key and value should not be the same column" if key === value
+        self.idname_id = key
+        self.idname_name = value
+      end
+    end
+
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'activerecord_idnamecache'
+
+class Test::Unit::TestCase
+end

data/test/test_activerecord_idnamecache.rb

@@ -0,0 +1,4 @@
+require 'helper'
+
+class TestActiverecordIdnamecache < Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_idnamecache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord_idnamecache
+  requirement: &2151835520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151835520
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2151830260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2151830260
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2151844640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *2151844640
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2151842680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *2151842680
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2151840540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :development
+  prerelease: false
+  version_requirements: *2151840540
+description: Use Mysql AUTO_INCREMENT to support key value cache, which should be
+  combined by an integer and string.
+email: mvjome@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- activerecord_idnamecache.gemspec
+- lib/activerecord_idnamecache.rb
+- test/helper.rb
+- test/test_activerecord_idnamecache.rb
+homepage: http://github.com/mvj3/activerecord_idnamecache
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2691184980539978926
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Use Mysql AUTO_INCREMENT to support key value cache, which should be combined
+  by an integer and string.
+test_files: []