keytar 1.1.0 → 1.2.0

data/README.md

@@ -3,11 +3,23 @@ Keytar
 
 **1.** A keyboard that is designed to be played standing up, like a guitar.  
 **2.** A crazy simple ruby-on-rails library for making re-usable keys (the kind you use in key/value stores)
+It is an amazingly easy way generate keys for all of your NOSQL key needs. Are you using Redis, Memcache, MongoDB, Cassandra, or another hot key-value store? Then use **keytar**! It generates keys based on class name instead of cluttering model definitions with tons of redundant key method declarations. 
 
-It Builds Keys
-----------
 
-Keytar is an amazingly easy way generate keys for all of your NOSQL key needs. Are you using Redis, Memcache, MongoDB, Cassandra, or another hot key-value store? Then use **keytar**! It auto-magically generates keys based on class name instead of cluttering model definitions with tons of redundant key method declarations. 
+It Builds Keys: 
+--------
+keytar auto-magically generates keys using method names ending in `"_key"` or simply "key"
+
+    User.key #=> "user"
+    User.friends_key #=> "user:friends"
+    
+    u = User.new
+    u.last_web_access_cache_key #=> "users:last_web_access_cache"
+    u.favorite_spots_key("some_argument") #=> "users:favorite_spots:some_argument"
+    
+    u = User.create(:id => 2)
+    u.sweet_key #=> "users:sweet:2"
+    
 
 ___quit___ littering your code with junk like this:
 
@@ -17,7 +29,7 @@ ___quit___ littering your code with junk like this:
       end
     end
 
-Seriously, ___quit it___!
+Seriously, ___quit it___! Use Keytar instead ^_^
 
 
 Installation
@@ -33,38 +45,23 @@ then run
 Then drop `include Keytar` in any Ruby model you want and you're good to go
 
 
-Example: 
---------
-keytar auto-magically generates keys using method names ending in `"_key"` or simply "key"
-
-    User.key #=> "user"
-    User.friends_key #=> "user:friends"
-    
-    u = User.new
-    u.last_web_access_cache_key #=> "users:last_web_access_cache"
-    u.favorite_spots_key("some_argument") #=> "users:favorite_spots:some_argument"
-    
-    u = User.create(:id => 2)
-    u.sweet_key #=> "users:sweet:2"
-    
-
 
 It's that simple
 
-Configuration
+Define Keys
 -------------
-Keys can be pre-defined and configured on a per key basis by calling **define\_keys**:
+Keys should be pre-defined and configured by calling **define\_keys**:
 
     class User
       include Keytar
-      define_keys [:friend_ids, :email_subscriptions, :news_feed], :delimiter => "|", :version => "v2"
+      define_keys :friend_ids, :email_subscriptions, :news_feed, :delimiter => "|", :version => "v2"
       define_keys :favorite_spots, :delimiter => "/", :version => 3, :key_prefix => "lol"
     end
 
     User.respond_to? :friend_ids_key #=> true
     User.friend_ids_key #=> "user|friend_ids|v2"
 
-Where the first argument is the key (or keys) to be defined, and the second argument is a hash of configurations. Using **define\_keys** is the recommended configuration method. 
+Where the first argument is the key (or keys) to be defined, and the second argument is a hash of configurations.
 
 
 Global options can also be configured per class by passing in a hash to **key_config**:
@@ -90,7 +87,7 @@ Here is a run down of what each does
 **order** sets the location of key parts, if a symbol is omitted, it will not show up in the final key (note the location of "favorite_spots" and "user" is flipped)
 
     define_keys :favorite_spots, :order => [:name, :base]
-    User.favorite_spots_key #=> "favorite_spots:user:1"
+    User.favorite_spots_key #=> "favorite_spots:user"
     
 **unique** sets the unique value of the instance that is used to build the key
 
@@ -190,5 +187,6 @@ Contribution
 Fork away. If you want to chat about a feature idea, or a question you can find me on the twitters [@schneems](http://twitter.com/schneems).  Put any major changes into feature branches. Make sure all tests stay green, and make sure your changes are covered. 
 
 
+licensed under MIT License
 Copyright (c) 2011 Schneems. See LICENSE.txt for
 further details.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/keytar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keytar}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]
-  s.date = %q{2011-06-20}
+  s.date = %q{2011-06-21}
   s.description = %q{
     Keytar is a Ruby on Rails wrapper for KeyBuilder.
     Use KeyBuilder to automatically generate keys based on class name instead of cluttering model

data/lib/keytar/key_builder.rb

@@ -1,10 +1,8 @@
 require File.join(File.dirname(__FILE__), 'key_utility') ## gives us support for Object#blank, Object#present?, String.pluralize without require ActiveSupport
 
 module KeyBuilder
-  alias :original_method_missing :method_missing
-
   DEFAULTS = {:key_delimiter => ":",
-                :key_order => [:prefix, :base, :name, :unique, :args, :suffix, :version, :v],
+                :key_order => [:shard, :prefix, :base, :name, :unique, :args, :suffix, :version, :v],
                 :key_prefix => nil,
                 :key_suffix => nil,
                 :key_pluralize_instances => true,
@@ -141,7 +139,7 @@ module KeyBuilder
     if method_name.to_s =~ /.*key$/
       build_key(:name => method_name, :args => args)
     else
-      original_method_missing(method_name, *args, &blk)
+      super
     end
   end
 end

data/license.txt

@@ -1,3 +1,5 @@
+licensed under MIT License:
+
 Copyright (c) 2011 Schneems
 
 Permission is hereby granted, free of charge, to any person obtaining

data/spec/keytar/key_builder_spec.rb

@@ -75,7 +75,7 @@ describe KeyBuilder do
       end
 
       it "converts a hash to an array based on default order" do
-        Foo.key_hash_to_ordered_array(@options).should == [@options[:prefix], @options[:base], @options[:name], @options[:unique], @options[:suffix], @options[:version], @options[:v]]
+        Foo.key_hash_to_ordered_array(@options).should == [@options[:shard], @options[:prefix], @options[:base], @options[:name], @options[:unique], @options[:suffix], @options[:version], @options[:v]]
       end
 
       it "order output using direct option before class config" do

data/spec/keytar/keytar_spec.rb

@@ -10,6 +10,9 @@ ActiveRecord::Schema.define do
   create_table :bars do |t|
     t.string :name, :null => false
   end
+  create_table :bar_bazs do |t|
+    t.string :name, :null => false
+  end
 end
 
 class Foo
@@ -25,6 +28,10 @@ class BarNonActiveRecord
 end
 
 
+class BarBaz < ActiveRecord::Base
+
+end
+
 describe Keytar do
 
   describe 'cache_key' do
@@ -242,5 +249,19 @@ describe Keytar do
     end
   end
 
+  describe "keytar should not over-ride default method_missing for AR" do
+    before do
+      b = BarBaz.create(:name => "something")
+      @id = b.id
+      Object.instance_eval{ remove_const :BarBaz } ## AR caches methods on object on create, need to pull it from disk
+      class BarBaz < ActiveRecord::Base
+        include Keytar
+        define_key :foo_key
+      end
+    end
 
+    it 'does not interfere with how ActiveRecord generates methods based on column names' do
+      BarBaz.last.id.should == @id
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: keytar
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Schneems
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-20 00:00:00 -05:00
+date: 2011-06-21 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency