kiki 0.1.1

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.0"
+  gem "yard", "~> 0.6.0"
+  gem "rcov", ">= 0"
+end
+
+group :test do
+  gem "rspec", "~> 2.3.0"
+end

data/README.rdoc

@@ -0,0 +1,74 @@
+                            
+                            
+                              /~\
+                             C oo
+                             _( ^)  kiki
+                            /   ~\
+                            
+                            
+
+
+A lightweight, flexible key generator for NoSQL / Key-Value stores, such as Redis, Memcached, Riak, Tokyo Cabinet, etc.
+
+== Examples
+
+  class User
+    include Kiki
+  
+    cache_key :redis
+  
+    cache_key :memcached,
+              :domain     => 'people',
+              :delimiter  => '/',
+              :identifier => :username
+  end
+
+  User.redis_key                  # => #<Keytar::Key:0x000001008ea9a8 @namespace="redis", @delimitter=":", @domain="users", @identifier=:id>
+  User.redis_key("count")         # => redis:users:count
+  User.find(1).redis_key          # => redis:users:1
+  User.find(1).redis_key("items") # => redis:users:1:items
+
+  User.find(1).memcached_key      # => memcached/people/schneems
+
+  # Configuration can be done on the key object
+  User.memcached_key.identifier = :email
+  User.find(1).memcached_key      # => memcached/people/mistersnowman@example.com
+
+== Configuration
+
+[namespace]   the first argument for +cache_key+, the instance and class method +[namespace]_key+ will be added, which generate keys prefixed by the namespace (eg. "redis" would add the method "redis_key", generating a key like "redis:users:1")
+
+[domain]      optional, defaults to the downcase, pluralized name of your class (eg. "class User" would have the domain "users")
+
+[delimiter]   optional, defaults to ":"
+
+[identifier]  this is the method that is sent when calling "*_key" on an instance, or passing non-string / non-numeric arguments into a "*_key" method. optional, defaults to ":id"
+
+== Credit
+
+This project was inspired by [Richard Schneeman](https://github.com/schneems/)'s awesome library [Keytar](https://github.com/schneems/keytar/). Essentially, this my alternative take on the problem, focusing on simplicity of API and implementation.
+
+== License
+
+kiki is licensed under the MIT License:
+
+Copyright (c) 2011 Mattt Thompson (http://mattt.me/)
+
+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/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development, :test)
+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.name = "kiki"
+  gem.homepage = "http://github.com/mattt/kiki"
+  gem.license = "MIT"
+  gem.summary = %Q{A lightweight, flexible key generator for NoSQL / Key-Value stores, such as Redis, Memcached, Riak, Tokyo Cabinet, etc.}
+  gem.description = %Q{kiki is a dead-simple module that you can include in your Models that provides convenient, DRY way of generating unique keys for your favorite K/V or NoSQL databases. }
+  gem.email = "m@mattt.me"
+  gem.authors = ["Mattt Thompson"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/kiki.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require 'kiki/extensions'
+
+module Kiki
+  autoload :Key,        'kiki/key'
+  autoload :Version,    'kiki/version'
+
+  def self.included(klass)
+    klass.class_eval { extend ClassMethods }
+  end
+
+  module ClassMethods
+    def cache_key(namespace, options = {})
+      class_eval(<<-EVAL, __FILE__, __LINE__)
+        class << self
+          @@#{namespace}_key = Key.new "#{namespace}",
+                                       "#{options[:delimiter] || ":"}",
+                                       "#{options[:domain] || self.name.downcase.pluralize}",
+                                       :"#{options[:identifier] || :id}"
+
+          def #{namespace}_key(*args)
+            return args.empty? ? @@#{namespace}_key : @@#{namespace}_key.for(*args)
+          end
+        end
+
+        def #{namespace}_key(*args)
+          return self.class.#{namespace}_key(*[self, *args])
+        end
+      EVAL
+
+      return self.send("#{namespace}_key")
+    end
+  end
+end

data/lib/kiki/extensions.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+# Fallback to monkeypatch version of +String#pluralize+ if ActiveSupport Inflector (or another class) has not defined it already
+unless String.respond_to? :pluralize
+  String.class_eval do
+    def pluralize
+      self[(self.length - 1), 1] =~ /s/i ? self : "#{self}s"
+    end
+  end
+end

data/lib/kiki/key.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Kiki
+  class Key
+    attr_reader :namespace
+    attr_accessor :delimiter, :domain, :identifier
+
+    def initialize(namespace, delimiter, domain, identifier)
+      @namespace = namespace
+      @delimiter = delimiter
+      @domain = domain
+      @identifier = identifier
+    end
+
+    def for(*args)
+      components = [@namespace, @domain] + args.collect do |arg|
+        case arg
+        when String, Numeric then arg
+        else
+          arg.respond_to?(@identifier) ? arg.send(@identifier) : arg.to_s
+        end
+      end
+
+      components.compact.join(@delimiter)
+    end
+  end
+end

data/lib/kiki/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Kiki
+  Version = '0.1.1'
+end

data/spec/kiki_spec.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Kiki" do
+
+  before :each do
+    @user = User.new(3, "ramona")
+  end
+  
+  it "should add *_key class methods" do
+    User.should respond_to(:redis_key)
+    User.should respond_to(:memcached_key)
+  end
+  
+  it "should add *_key instance methods" do
+    @user.should respond_to(:redis_key)
+    @user.should respond_to(:memcached_key)
+  end
+  
+  it "should respond to configuration" do
+    User.redis_key.identifier = :username
+    @user.redis_key("likes").should eql("redis:users:ramona:likes")
+    
+    User.redis_key.identifier = :id
+    @user.redis_key("likes").should eql("redis:users:3:likes")
+  end
+  
+  describe "Redis key" do
+    it "should be correct for instance" do
+      @user.redis_key.should eql("redis:users:3")
+    end
+    
+    it "should be correct with arguments" do
+      User.redis_key("stats").should eql("redis:users:stats")
+      @user.redis_key("likes").should eql("redis:users:3:likes")
+      @user.redis_key("likes", "recent").should eql("redis:users:3:likes:recent")
+    end
+  end
+  
+  describe "Memcached key" do
+    it "should be correct for instance" do
+      @user.memcached_key.should eql("memcached/people/ramona")
+    end
+    
+    it "should be correct with arguments" do
+      User.memcached_key("comments").should eql("memcached/people/comments")
+      @user.memcached_key("comments").should eql("memcached/people/ramona/comments")
+      @user.memcached_key("comments", 42).should eql("memcached/people/ramona/comments/42")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'kiki'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/user.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+class User < Struct.new(:id, :username)
+  include Kiki
+
+  cache_key :redis
+
+  cache_key :memcached,
+            :delimiter  => '/',
+            :domain     => 'people',
+            :identifier => :username
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification 
+name: kiki
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Mattt Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  name: jeweler
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id004
+description: "kiki is a dead-simple module that you can include in your Models that provides convenient, DRY way of generating unique keys for your favorite K/V or NoSQL databases. "
+email: m@mattt.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/kiki.rb
+- lib/kiki/extensions.rb
+- lib/kiki/key.rb
+- lib/kiki/version.rb
+- spec/kiki_spec.rb
+- spec/spec_helper.rb
+- spec/support/user.rb
+has_rdoc: true
+homepage: http://github.com/mattt/kiki
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A lightweight, flexible key generator for NoSQL / Key-Value stores, such as Redis, Memcached, Riak, Tokyo Cabinet, etc.
+test_files: []
+