keytar 1.3.1 → 1.4.0

data/README.md

@@ -2,13 +2,15 @@ Keytar
 ======
 
 **1.** A keyboard that is designed to be played standing up, like a guitar.  
-**2.** A crazy simple, flexible ruby library for generating NOSQL keys. Use it with redis, memcache, cassandra, or any other key-value store. 
+**2.** A crazy simple, flexible ruby library for generating NOSQL keys. Use it with redis, memcache, mongo, or any other key-value store. 
 
 It Builds Keys
 --------
-keytar auto-magically generates keys using method names ending in `*_key` or simply `key`
-
-    User.key #=> "user"
+    class User
+      include Keytar
+      define_keys :friends, :last_web_access_cache, :favorite_spots, :sweet
+    end
+    
     User.friends_key #=> "user:friends"
     
     u = User.new
@@ -40,7 +42,7 @@ then run
 
     bundle install
 
-drop `include Keytar` in any __Ruby__ model you want and you're good to go
+drop `include Keytar` in any model you want and you're good to go
 
 
 It's that simple
@@ -52,13 +54,13 @@ 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 :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.
+
+Where the first argument is the key (or keys) to be defined, and the second argument is a hash of configuration options.
 
 
 Global options can also be configured per class by passing in a hash to **key_config**:
@@ -88,7 +90,7 @@ Here is a run down of what each does
     
 **unique** sets the unique value of the instance that is used to build the key
 
-By default all instance keys have an identifying unique element included in the key, specifying `key_unique` allows you to change the field that is used to specify a unique key. (defaults to database backed id, but will not use id if object.id == object.object_id)
+By default all instance keys have an identifying unique element included in the key, specifying `key_unique` allows you to change the field that is used to specify a unique key. (defaults to database backed id, Object#id)
 
     User.create(:username => "Schneems", :id => 9)
     User.find(9).favorite_spots_key #=> "users:favorite_spots:9"

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.4.0

data/keytar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keytar}
-  s.version = "1.3.1"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]
-  s.date = %q{2011-07-13}
+  s.date = %q{2011-07-27}
   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

@@ -12,13 +12,6 @@ module KeyBuilder
     # setup method missing on class
     klass.class_eval do
       extend KeyBuilder::Ext
-      def self.method_missing(method_name, *args, &blk)
-        if method_name.to_s =~ /.*key$/
-          self.build_key(:base => self.to_s.downcase, :name => method_name, :args => args)
-        else
-          super
-        end
-      end
     end
   end
 
@@ -130,14 +123,4 @@ module KeyBuilder
     options[:unique] = unique unless unique == object_id
     self.class.build_key(options)
   end
-
-
-
-  def method_missing(method_name, *args, &blk)
-    if method_name.to_s =~ /.*key$/
-      build_key(:name => method_name, :args => args)
-    else
-      super
-    end
-  end
 end

data/spec/keytar/keytar_spec.rb

@@ -17,19 +17,19 @@ end
 
 class Foo
   include Keytar
+  define_key :awesome
 end
 
 class Bar < ActiveRecord::Base
   include Keytar
+  define_key :awesome
 end
 
 class BarNonActiveRecord
-
 end
 
 
 class BarBaz < ActiveRecord::Base
-
 end
 
 describe Keytar do
@@ -63,10 +63,6 @@ describe Keytar do
   end
 
   describe 'class methods' do
-    it 'should respond to "key" method by returning downcase of class name' do
-      Foo.key.should == "foo"
-    end
-
     it 'should respond to "awesome_key" method by returning :class, :delimiter, :name' do
       Foo.awesome_key.should == "foo:awesome"
     end
@@ -89,10 +85,6 @@ describe Keytar do
       @foo = Foo.new
     end
 
-    it 'should respond to "key" method by returning pluralized downcase of class name' do
-      @foo.key.should == "foos"
-    end
-
     it 'should respond to "awesome_key" method by returning :class, :delimiter, :name' do
       @foo.awesome_key.should == "foos:awesome"
     end
@@ -179,7 +171,7 @@ describe Keytar do
        Foo.key_unique key_unique
        Foo.key_unique.should == key_unique
        foo = Foo.new
-       foo.awesome_key.should == "foos:awesome:#{foo.timeish}"
+       foo.awesome_key.should include(foo.timeish)
      end
 
      # todo move tests and assertsions to seperate describe and it blocks
@@ -237,6 +229,7 @@ describe Keytar do
       it 'includes keybuilder when it is included' do
         BarNonActiveRecord.class_eval do
           include Keytar
+          define_key :awesome
         end
         describe BarNonActiveRecord.ancestors do
           it {should include( KeyBuilder)}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: keytar
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: 
   segments: 
   - 1
-  - 3
-  - 1
-  version: 1.3.1
+  - 4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Schneems
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 -05:00
+date: 2011-07-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency