keytar 0.9.0 → 1.0.0

data/.rvmrc

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-ruby_string="ree-1.8.7-2011.03"
+ruby_string="ruby-1.9.2-p180"
 gemset_name="keytar"
 
 if rvm list strings | grep -q "${ruby_string}" ; then

data/README.md

@@ -4,10 +4,10 @@ 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)
 
-KeyBuilder
+It Builds Keys
 ----------
 
-Keytar is an amazingly easy way to auto-magically 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 automatically generates keys based on class name instead of cluttering model definitions with tons of redundant key method declarations. 
+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. 
 
 ___quit___ littering your code with junk like this:
 
@@ -22,7 +22,7 @@ Seriously, ___quit it___!
 
 Installation
 ------------
-In your Ruby on Rails Gemfile add
+In your Gemfile add
 
     gem 'keytar'
 
@@ -30,19 +30,19 @@ then run
 
     bundle install
 
-now, you're good to go. Not using RoR? No worries, just drop `include Keytar` in any Ruby model you want.
+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".
+keytar auto-magically generates keys using method names ending in `"_key"` or simply "key"
 
     User.key #=> "user"
     User.memcache_key #=> "user:memcache"
     
     u = User.new
     u.redis_key #=> "users:redis"
-    u.redis_key("some_arguement") #=> "users:redis:some_arguement"
+    u.redis_key("some_argument") #=> "users:redis:some_argument"
     
     u = User.create(:id => 2)
     u.sweet_key #=> "users:sweet:2"
@@ -51,18 +51,33 @@ keytar auto-magically generates keys using method names ending in `"_key"` or si
 
 It's that simple
 
-Config
-------
+Configuration
+-------------
+Keys can be pre-defined and configured on a per key basis by calling **define\_keys**:
+
+    class User
+      include Keytar
+      define_keys [:zoolander, :something_about_mary, :tropic_thunder], :delimiter => "|", :version => 2
+      define_keys :cassandra, :delimiter => "/", :version => 3, :key_prefix => "lol"
+    end
+
+    User.respond_to? :zoolander_key #=> true
+    User.zoolander_key #=> "user|zoolander|2"
+
+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. 
 
-These options can be configured by passing in a hash to keyfig:
 
-    class User < ActiveRecord::Base
-      keyfig :key_delimiter => ":", :key_order => [:unique, :suffix], :key_prefix => "before"
+options can also be configured per class by passing in a hash to **key_config**:
+
+    class User
+      include Keytar
+      key_config :key_delimiter => ":", :key_order => [:unique, :suffix], :key_prefix => "before"
     end
 
 Or by calling class methods
 
-    class User < ActiveRecord::Base
+    class User
+      include Keytar
       key_delimiter ":"
       key_order [:prefix, :base, :name, :unique, :args, :suffix]
       key_prefix nil
@@ -72,9 +87,9 @@ Config Options Breakdown
 ------------------------
 Here is a run down of what each does  
 
-**key_delimeter** sets the separating argument in keys
+**key_delimiter** sets the separating argument in keys
 
-    User.key_delimeter "|"
+    User.key_delimiter "|"
     user.redis_key #=> "users|redis"
 
 
@@ -92,17 +107,18 @@ By default all instance keys have an identifying unique element included in the
     user.redis_key #=> "users:redis:9"
 
     User.key_unique("username")
+    user.username #=> "schneems"
     user.redis_key #=> "users:redis:schneems"
 
-**key_prefix** sets the a prefix to your key for that class
+**key_prefix** adds some text to the beginning of your key for that class
 
     User.key_prefix "woot"
-    user.redis_key #=> "woot:users:redis"
+    User.redis_key #=> "woot:users:redis"
     
-**key_suffix** sets the a suffix to your key for that class
+**key_suffix** adds some text to the end of your key for that class
 
     User.key_suffix "slave"
-    user.redis_key #=> "users:redis:slave"
+    User.redis_key #=> "users:redis:slave"
 
 **`key_pluralize_instances`** allows you to toggle pluralizing instance keys (note the 's' in 'users' is not there)
 
@@ -118,12 +134,7 @@ By default all instance keys have an identifying unique element included in the
 **key_case** allows you to specify the case of your key
 
     User.key_case :upcase
-    user.redis_key #=> "USERS:REDIS"
-
-**`key_cache_methods`** will let you toggle whether or not keytar defines your key methods after being called. If you're calling
-these methods over and over, this can give you a speed boost, however there is overhead associated with defining methods. The default
-is on, however try it both ways on your app run some benchmarks and see what works the best.
-
+    User.redis_key #=> "USER:REDIS"
 
 
 Since this library is sooooo simple, here is a ASCII keytar for you. Thanks for checking it out.
@@ -188,4 +199,4 @@ Fork away. If you want to chat about a feature idea, or a question you can find
 
 
 Copyright (c) 2011 Schneems. See LICENSE.txt for
-further details.
+further details.

data/VERSION

@@ -1 +1 @@
-0.9.0
+1.0.0

data/keytar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keytar}
-  s.version = "0.9.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]
-  s.date = %q{2011-05-08}
+  s.date = %q{2011-05-16}
   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
@@ -20,40 +20,19 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
-    ".DS_Store",
     ".rvmrc",
     "Gemfile",
-    "Gemfile.lock",
     "README.md",
     "Rakefile",
     "VERSION",
-    "db/migrate/001_create_bars.rb",
     "keytar.gemspec",
     "lib/.DS_Store",
     "lib/keytar.rb",
     "lib/keytar/key_builder.rb",
     "license.txt",
-    "pkg/keytar-0.1.0.gem",
-    "pkg/keytar-0.1.1.gem",
     "spec/keytar/key_builder_spec.rb",
     "spec/keytar/keytar_spec.rb",
-    "spec/keytar/spec_helper.rb",
-    "vendor/cache/activemodel-3.0.6.gem",
-    "vendor/cache/activerecord-3.0.6.gem",
-    "vendor/cache/activesupport-3.0.6.gem",
-    "vendor/cache/arel-2.0.9.gem",
-    "vendor/cache/builder-2.1.2.gem",
-    "vendor/cache/diff-lcs-1.1.2.gem",
-    "vendor/cache/git-1.2.5.gem",
-    "vendor/cache/i18n-0.5.0.gem",
-    "vendor/cache/jeweler-1.5.2.gem",
-    "vendor/cache/rake-0.8.7.gem",
-    "vendor/cache/rspec-2.5.0.gem",
-    "vendor/cache/rspec-core-2.5.1.gem",
-    "vendor/cache/rspec-expectations-2.5.0.gem",
-    "vendor/cache/rspec-mocks-2.5.0.gem",
-    "vendor/cache/sqlite3-1.3.3.gem",
-    "vendor/cache/tzinfo-0.3.26.gem"
+    "spec/keytar/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/Schnems/keytar}
   s.licenses = ["MIT"]

data/lib/keytar.rb

@@ -1,9 +1,6 @@
-require 'rubygems'
-begin; require 'active_record'; rescue; end
 
 module Keytar
   autoload :KeyBuilder, 'keytar/key_builder'
-  ActiveRecord::Base.class_eval { include KeyBuilder } if defined?(ActiveRecord::Base)
   def self.included(klass)
     klass.class_eval {include KeyBuilder}
   end

data/lib/keytar/key_builder.rb

@@ -1,4 +1,3 @@
-require 'rubygems'
 require 'active_support/inflector' # used for pluralize
 require 'active_support/core_ext/object/blank' # used for blank? and present?
 
@@ -6,44 +5,23 @@ module KeyBuilder
   alias :original_method_missing :method_missing
 
   DEFAULTS = {:key_delimiter => ":",
-                :key_order => [:prefix, :base, :name, :unique, :args, :suffix],
+                :key_order => [:prefix, :base, :name, :unique, :args, :suffix, :version, :v],
                 :key_prefix => nil,
                 :key_suffix => nil,
                 :key_pluralize_instances => true,
                 :key_case => :downcase,
                 :key_plural => nil,
-                :key_unique => "id",
-                :key_cache_methods => true
-                }
+                :key_unique => "id"}
 
   def self.included(klass)
     # setup method missing on class
     klass.class_eval do
       extend KeyBuilder::Ext
-      # if method_missing doesn't already exist, aliasing and calling it will create an infinite loop
-      @@key_builder_jump_to_superclass = true
-      if klass.respond_to?("method_missing")
-        @@key_builder_jump_to_superclass = false
-        alias :key_builder_alias_method_missing :method_missing
-      end
-
       def self.method_missing(method_name, *args, &blk)
         if method_name.to_s =~ /.*key$/
-          ## Performance: define method so we can skip method_missing next time
-          if key_cache_methods
-            (class << self;self ;end).instance_eval do
-              define_method(method_name) do |*args|
-                build_key(:base => self.to_s.downcase, :name => method_name, :args => args)
-              end
-            end
-          end
           self.build_key(:base => self.to_s.downcase, :name => method_name, :args => args)
         else
-          if @@key_builder_jump_to_superclass
-            super
-          else
-            key_builder_alias_method_missing(method_name, *args, &blk)
-          end
+          super
         end
       end
     end
@@ -62,69 +40,101 @@ module KeyBuilder
       }
     end
 
-    def keyfig(options = {})
+    # sets up configuration options for individual keys
+    # alows us to define the keys without calling method missing
+    def cache_key( *args)
+      # coherce args into meaningful things
+      names = []; options = {}; args.each {|arg| arg.is_a?(Hash) ? options = arg : names << arg}
+      options.merge!(:name => name, :base => self.to_s.downcase)
+
+      # allow for loose naming of keys configuration symbols can use :key_prefix or just :prefix
+      options.keys.each do |key|
+        options["key_#{key}".to_sym] = options[key] if key.to_s !~ /^key_/
+      end
+
+      names.each do |name|
+        # define (cache) class method
+        (class << self;self ;end).instance_eval do
+          define_method("#{name}_key") do |*args|
+            options.merge!(:name => name, :base => self.to_s.downcase, :args => args)
+            build_key(options)
+          end
+        end
+
+        # define (cache) instance method
+        class_eval do
+          define_method("#{name}_key") do |*args|
+            options.merge!(:name => name, :args => args)
+            build_key(options)
+          end
+        end
+      end
+    end
+    alias :cache_keys  :cache_key
+    alias :define_key  :cache_key
+    alias :define_keys :cache_key
+
+    # a way to define configurations for keytar using a hash
+    def key_config(options = {})
       options.keys.each do |key|
         eval("@@#{key} = options[key]") if key.to_s =~ /^key_.*/
       end
     end
+    alias :keyfig :key_config
 
     # Call KeyBuilder.build_key or Foo.build_key with options
     # :base => self.to_s.downcase, :name => method_name, :args => args
     def build_key(options = {})
       key_hash = build_key_hash(options)
       key_array = key_hash_to_ordered_array(key_hash)
-      return key_from_array(key_array)
+      return key_from_array(key_array, options)
     end
 
     # takes input options and turns to a hash, which can be sorted based on key
     def build_key_hash(options)
-      options[:name] = options[:name].to_s.gsub(/(key|_key)/, '')
-      options.merge :prefix => self.key_prefix, :suffix => self.key_suffix
+      options[:name] = options[:name].to_s.gsub(/(^key$|_key$)/, '')
+      {:prefix => options[:key_prefix]||self.key_prefix,
+       :suffix => options[:key_suffix]||self.key_suffix}.merge(options)
     end
 
     # orders the elements based on defaults or config
     def key_hash_to_ordered_array(key_hash)
       key_array ||= []
-      self.key_order.each do |key|
+      (key_hash[:key_order]||self.key_order).each do |key|
         if key != :args
           key_array << key_hash[key]
         else
-          key_array << key_hash[key].map(&:to_s)
+          key_array << key_hash[key].map(&:to_s) unless key_hash[key].blank?
         end
       end
       return key_array
     end
 
     # applys a delimter and appropriate case to final key
-    def key_from_array(key_array)
-      key = key_array.flatten.reject {|item| item.blank? }.join(self.key_delimiter)
-      key = key.downcase if self.key_case == :downcase
-      key = key.upcase if self.key_case == :upcase
+    def key_from_array(key_array, options = {})
+      key = key_array.flatten.reject {|item| item.blank? }.join(options[:key_delimiter]||self.key_delimiter)
+      key_case = options[:key_case] || self.key_case
+      key = key.downcase if key_case == :downcase
+      key = key.upcase if key_case == :upcase
       key
     end
   end
 
   # build_key method for instances by default class is pluralized to create different key
-  def build_key(method_name, *args)
-    base = self.class.to_s.downcase
-    base =  self.class.key_plural||base.pluralize if self.class.key_pluralize_instances.present?
-    unique = eval("self.#{self.class.key_unique}") unless eval("self.#{self.class.key_unique}") == object_id
-    self.class.build_key(:base => base, :name => method_name, :args => args, :unique => unique)
+  def build_key(options = {})
+    options[:base] = options[:base]||self.class.to_s.downcase
+    if (options[:key_pluralize_instances] == true ) || (options[:key_pluralize_instances] != false && self.class.key_pluralize_instances.present?)
+      options[:base] =  options[:key_plural]||self.class.key_plural||options[:base].pluralize
+    end
+    options[:unique] = eval("self.#{options[:key_unique]||self.class.key_unique}") unless eval("self.#{options[:key_unique]||self.class.key_unique}") == object_id
+    self.class.build_key(options)
   end
 
 
 
   def method_missing(method_name, *args, &blk)
     if method_name.to_s =~ /.*key$/
-      ## Performance: define method so we can skip method_missing next time
-      if self.class.key_cache_methods
-        self.class.instance_eval do
-          define_method(method_name) do |*args|
-            build_key(method_name, *args)
-          end
-        end
-      end
-      build_key(method_name, *args)
+      build_key(:name => method_name, :args => args)
     else
       original_method_missing(method_name, *args, &blk)
     end

data/spec/keytar/key_builder_spec.rb

@@ -1,203 +1,166 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-
 class Foo
-  include KeyBuilder
-end
+  include Keytar
 
+  def ymd
+    Time.now.strftime("%y%m%d")
+  end
+end
 
 describe KeyBuilder do
-
-  describe 'class methods' do
-    it 'should respond to "key" method by returning downcase of class name' do
-      Foo.key.should == "foo"
+  describe 'build_key class method' do
+    before do
+      @options = {:name => "foo", :args => nil}
     end
 
-    it 'should respond to "awesome_key" method by returning :class, :delimiter, :name' do
-      Foo.awesome_key.should == "foo:awesome"
+    describe 'build_key' do
+      it 'calls other class methods' do
+        Foo.should_receive(:build_key_hash)
+        Foo.should_receive(:key_hash_to_ordered_array)
+        Foo.should_receive(:key_from_array)
+        Foo.build_key(@options)
+      end
     end
 
-    it 'should respond to "awesome_key(number)" method by returning :class, :delimiter, :name, :delimiter, :arg' do
-      number = rand(100)
-      Foo.awesome_key(number).should == "foo:awesome:#{number}"
-    end
+    describe 'build_key_hash' do
+      it 'removes key and _key from the :name option' do
+        Foo.build_key_hash(@options.merge(:name => "foo_key"))[:name].should == "foo"
+        Foo.build_key_hash(@options.merge(:name => "key"))[:name].should == ""
+        Foo.build_key_hash(@options.merge(:name => "fookey"))[:name].should == "fookey"
+      end
 
-    it 'should dynamically define a class method capeable of producing different keys' do
-      key1 = Foo.define_method_time_test_key(1)
-      key2 = Foo.define_method_time_test_key(2)
-      Foo.respond_to?(:define_method_time_test_key).should be_true
-      key2.should_not == key1
-    end
+      describe 'prefix' do
+        it 'takes in prefix converts key_prefix to prefix' do
+          prefix = "prefix"
+          Foo.build_key_hash(@options.merge(:key_prefix => prefix))[:prefix].should == prefix
+        end
+
+        it 'favors direct options over class settings' do
+          prefix = "prefix"
+          Foo.should_not_receive(:key_prefix)
+          Foo.build_key_hash(@options.merge(:key_prefix => prefix))[:prefix].should == prefix
+        end
+
+        it "defaults to class settings when no direct option is given" do
+          prefix = "classPrefix"
+          Foo.should_receive(:key_prefix).and_return(prefix)
+          Foo.build_key_hash(@options)[:prefix].should == prefix
+        end
+      end
 
+      describe "suffix" do
+        it 'takes in suffix and converts key_suffix to suffix' do
+          suffix = "sufix"
+          Foo.build_key_hash(@options.merge(:key_suffix => suffix))[:suffix].should == suffix
+        end
+
+        it 'favors direct options over class settings' do
+          suffix = "suffix"
+          Foo.should_not_receive(:key_suffix)
+          Foo.build_key_hash(@options.merge(:key_suffix => suffix))[:suffix].should == suffix
+        end
+
+        it "defaults to class settings when no direct option is given" do
+          suffix = "classSuffix"
+          Foo.should_receive(:key_suffix).and_return(suffix)
+          Foo.build_key_hash(@options)[:suffix].should == suffix
+        end
+      end
+    end
 
+    describe 'key_hash_to_rdered_array' do
+      before do
+        @options.merge!(:prefix => "prefix", :base => "base", :name => "name", :suffix => "suffix", :version => 1)
+      end
 
-    it 'should call method_missing on a non-existant method' do
-      begin
-        Foo.thismethoddoesnotexist
-      rescue => ex
+      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]]
       end
-        ex.class.should == NoMethodError
-    end
-  end
 
+      it "order output using direct option before class config" do
+        Foo.should_not_receive(:key_order)
+        key_order = [:prefix, :base, :name, :unique, :args, :suffix, :version, :v].reverse
+        Foo.key_hash_to_ordered_array(@options.merge(:key_order => key_order)).should == [@options[:prefix], @options[:base], @options[:name], @options[:unique], @options[:suffix], @options[:version], @options[:v]].reverse
+      end
 
-  describe 'instance methods' do
-    before(:each) do
-      @foo = Foo.new
+      it "convert each arg in args to a string" do
+        args = ["hey", 1 , "what", 2, "up", []]
+        Foo.key_hash_to_ordered_array(@options.merge(:args => args)).include?(args.map(&:to_s)).should be_true
+      end
     end
 
-    it 'should respond to "key" method by returning pluralized downcase of class name' do
-      @foo.key.should == "foos"
-    end
+    describe 'key_from_array' do
+      before do
+        @key_array = ["foo", "Bar", "oH", "YEAH"]
+      end
 
-    it 'should respond to "awesome_key" method by returning :class, :delimiter, :name' do
-      @foo.awesome_key.should == "foos:awesome"
-    end
+      it "strip out nil from the array and have no spaces" do
+        Foo.key_from_array([nil, nil]).match(/nil/).should be_false
+        Foo.key_from_array([nil, nil]).match(/\s/).should be_false
+      end
 
-    it 'should respond to "awesome_key(number)" method by returning :class, :delimiter, :name, :delimiter, :arg' do
-      number = rand(100)
-      @foo.awesome_key(number).should == "foos:awesome:#{number}"
-    end
+      it "return a string" do
+        Foo.key_from_array(@key_array).class.should == String
+      end
 
-    it 'should dynamically define an instance method capeable of producing different keys' do
-      key1 = @foo.define_method_time_test_key(1)
-      key2 = @foo.define_method_time_test_key(2)
-      @foo.respond_to?(:define_method_time_test_key).should be_true
-      key2.should_not == key1
-    end
+      it "keep the key case consistent (downcase by default)" do
+        Foo.key_from_array(@key_array).should == @key_array.map(&:downcase).join(":")
+      end
 
-    it 'should dynamically define an instance method capeable of producing different keys' do
-      key1 = @foo.define_method_time_test_key(1)
-      key2 = @foo.define_method_time_test_key(2)
-      @foo.respond_to?(:define_method_time_test_key).should be_true
-      key2.should_not == key1
-    end
+      it "allow different cases to be passed in via options" do
+        Foo.should_not_receive(:key_case)
+        Foo.key_from_array(@key_array, :key_case => :upcase).should == @key_array.map(&:upcase).join(":")
+      end
 
-    it 'should call method_missing on a non-existant method' do
-      begin
-        @foo.thismethoddoesnotexist
-      rescue => ex
+      it "flattens all inputs" do
+        array = @key_array << [[["1"], ["2"]],["3"]]
+        Foo.key_from_array(array, :key_case => :upcase).should == array.flatten.map(&:upcase).join(":")
       end
-        ex.class.should == NoMethodError
     end
   end
 
-  # test last
-  describe 'class configurations' do
-    after(:each) do
-      # todo find a better way of resetting all these values
-      Foo.key_delimiter KeyBuilder::DEFAULTS[:key_delimiter]
-      Foo.key_order KeyBuilder::DEFAULTS[:key_order]
-      Foo.key_prefix KeyBuilder::DEFAULTS[:key_prefix]
-      Foo.key_suffix KeyBuilder::DEFAULTS[:key_suffix]
-      Foo.key_pluralize_instances KeyBuilder::DEFAULTS[:key_pluralize_instances]
-      Foo.key_case KeyBuilder::DEFAULTS[:key_case]
-      Foo.key_plural KeyBuilder::DEFAULTS[:key_plural]
-      Foo.key_unique KeyBuilder::DEFAULTS[:key_unique]
-      Foo.key_cache_methods KeyBuilder::DEFAULTS[:key_cache_methods]
-    end
-
-    it 'should change key_delimiter' do
-      key_delimiter = "|"
-      Foo.key_delimiter key_delimiter
-      Foo.key_delimiter.should == key_delimiter
-      Foo.awesome_key.should == "foo#{key_delimiter}awesome"
+  describe 'build_key instance method' do
+    before do
+      @options = {:name => "foo", :args => nil}
+      @foo = Foo.new
     end
 
+    describe 'build_key' do
+      it 'sets_base to class name and pluralizes it' do
+        @foo.class.should_receive(:build_key).with(hash_including(:base => @foo.class.to_s.downcase + "s"))
+        @foo.build_key(@options)
+      end
 
-    it 'should change key_order' do
-      order_array = [:prefix, :name, :unique, :base, :args, :suffix]
-      Foo.key_order order_array
-      Foo.key_order.should == order_array
-      Foo.awesome_key.should == "awesome:foo"
-    end
+      it 'allows a manual over-ride of base' do
+        base = "base"
+        @foo.class.should_receive(:build_key).with(hash_including(:base => base + "s"))
+        @foo.build_key(@options.merge(:base => base))
+      end
 
-    it 'should change key_prefix' do
-      key_prefix = "memcache"
-      Foo.key_prefix key_prefix
-      Foo.key_prefix.should == key_prefix
-      Foo.awesome_key.should == "#{key_prefix}:foo:awesome"
-    end
+      it "don't pluralize base if key_pluralize_instances is set to false" do
+        @foo.class.should_not_receive(:key_pluralize_instances)
+        @foo.class.should_receive(:build_key).with(hash_including(:base => @foo.class.to_s.downcase))
+        @foo.build_key(@options.merge(:key_pluralize_instances => false))
+      end
 
-    it 'should change key_suffix' do
-      key_suffix = "slave"
-      Foo.key_suffix key_suffix
-      Foo.key_suffix.should == key_suffix
-      Foo.awesome_key.should == "foo:awesome:#{key_suffix}"
-    end
+      it "don't pluralize base if key_pluralize_instances is set to false" do
+        @foo.class.should_not_receive(:key_pluralize_instances)
+        @foo.class.should_receive(:build_key).with(hash_including(:base => @foo.class.to_s.downcase))
+        @foo.build_key(@options.merge(:key_pluralize_instances => false))
+      end
 
-     it 'should change key_pluralize_instances' do
-       key_pluralize_instances = false
-       Foo.key_pluralize_instances key_pluralize_instances
-       Foo.key_pluralize_instances.should == key_pluralize_instances
-       foo = Foo.new
-       foo.awesome_key.should == "foo:awesome"
-     end
-
-     it 'should change key_case' do
-       key_case = :upcase
-       Foo.key_case key_case
-       Foo.key_case.should == key_case
-       Foo.awesome_key.should == "FOO:AWESOME"
-     end
-
-     it 'should change key_plural' do
-       key_plural = "fooz"
-       Foo.key_plural key_plural
-       Foo.key_plural.should == key_plural
-       foo = Foo.new
-       foo.awesome_key.should == "fooz:awesome"
-     end
-
-     it 'should change key_unique' do
-       Foo.class_eval { def timeish; (Time.now.to_i * 0.01).floor; end}
-       key_unique = :timeish
-       Foo.key_unique key_unique
-       Foo.key_unique.should == key_unique
-       foo = Foo.new
-       foo.awesome_key.should == "foos:awesome:#{foo.timeish}"
-     end
-
-     # todo move tests and assertsions to seperate describe and it blocks
-     it 'should allow all configurations to be set using a hash' do
-       # variables
-       key_delimiter = "/"
-       key_order = [:prefix, :base, :suffix]
-       key_prefix = "before"
-       key_suffix = "after"
-       key_pluralize_instances = false
-       key_case = :upcase
-       key_plural = "zoosk"
-       key_unique = "doesn-t_apply_to_instance_methods"
-       key_cache_methods = false
-       # config
-       Foo.keyfig :key_delimiter => key_delimiter,
-                  :key_order => key_order,
-                  :key_prefix => key_prefix,
-                  :key_suffix => key_suffix,
-                  :key_pluralize_instances => key_pluralize_instances,
-                  :key_case => key_case,
-                  :key_plural => key_plural,
-                  :key_unique => key_unique,
-                  :key_cache_methods => key_cache_methods
-      # assertions
-      Foo.key_delimiter.should == key_delimiter
-      Foo.key_order.should == key_order
-      Foo.key_prefix.should == key_prefix
-      Foo.key_suffix.should == key_suffix
-      Foo.key_pluralize_instances.should == key_pluralize_instances
-      Foo.key_case.should == key_case
-      Foo.key_plural.should == key_plural
-      Foo.key_unique.should == key_unique
-      Foo.key_cache_methods == key_cache_methods
-     end
-
-     it 'should change key_cache_methods' do
-       Foo.key_cache_methods false
-       key1 = Foo.config_define_method_time_test_key(1)
-       Foo.respond_to?(:config_define_method_time_test_key).should be_false
-     end
+      it "allow unique method to be passed in via options" do
+        @foo.class.should_not_receive(:key_unique)
+        @foo.class.should_receive(:build_key).with(hash_including(:unique => @foo.ymd))
+        @foo.build_key(@options.merge(:key_unique => :ymd))
+      end
 
+      it "set unique based on configuration" do
+        @foo.class.should_receive(:key_unique).at_least(:once).and_return("ymd")
+        @foo.class.should_receive(:build_key).with(hash_including(:unique => @foo.ymd))
+        @foo.build_key
+      end
+    end
   end
-
 end

data/spec/keytar/keytar_spec.rb

@@ -1,17 +1,23 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
 ## Gives us ActiveRecord backed model Bar that we can test instances of
 ActiveRecord::Base.establish_connection(
 :adapter => "sqlite3",
 :database => ":memory:",
 :host     => 'localhost')
 
-## Gives us ActiveRecord backed model Bar that we can test instances of
-ActiveRecord::Migrator.migrate(
-  File.expand_path(File.dirname(__FILE__) + "../../../db/migrate") ,
-  ENV["VERSION"] ? ENV["VERSION"].to_i : nil )
+ActiveRecord::Schema.define do
+  create_table :bars do |t|
+    t.string :name, :null => false
+  end
+end
 
-class Bar < ActiveRecord::Base
+class Foo
+  include Keytar
+end
 
+class Bar < ActiveRecord::Base
+  include Keytar
 end
 
 class BarNonActiveRecord
@@ -20,13 +26,191 @@ end
 
 
 describe Keytar do
-  describe 'requiring Keytar' do
-    it 'should load keybuilder into ActiveRecord::Base if defined' do
-      describe Bar.ancestors do
-        it {should include( KeyBuilder)}
+
+  describe 'cache_key' do
+    it 'allows us to pre-define class methods' do
+      Foo.cache_key(:cached_method, :delimiter => "/", :key_prefix => "woo")
+      Foo.respond_to?(:cached_method_key).should be_true
+      puts Foo.cached_method_key(22).should == "woo/foo/cached_method/22"
+    end
+
+    it 'allows us to pre-define instance methods' do
+      Foo.cache_key(:cached_instance_method, :delimiter => "|", :version => "3")
+      @foo = Foo.new
+      @foo.respond_to?(:cached_instance_method_key).should be_true
+      @foo.cached_instance_method_key.should == "foos|cached_instance_method|3"
+    end
+
+    describe 'taking an array' do
+      it 'allows us to pre-define multiple class key methods' do
+        Foo.cache_key(:m1, :m2, :m3, :delimiter => ":", :key_prefix => "foo")
+        Foo.respond_to?(:m1_key).should be_true
+        Foo.respond_to?(:m2_key).should be_true
+        Foo.respond_to?(:m3_key).should be_true
+        @foo = Foo.new
+        @foo.respond_to?(:m1_key).should be_true
+        @foo.respond_to?(:m2_key).should be_true
+        @foo.respond_to?(:m3_key).should be_true
       end
     end
+  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
+
+    it 'should respond to "awesome_key(number)" method by returning :class, :delimiter, :name, :delimiter, :arg' do
+      number = rand(100)
+      Foo.awesome_key(number).should == "foo:awesome:#{number}"
+    end
+
+
+
+    it 'should call method_missing on a non-existant method' do
+        lambda{ Foo.thismethoddoesnotexist }.should raise_error(NoMethodError)
+    end
+  end
+
+
+  describe 'instance methods' do
+    before(:each) 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
+
+    it 'should respond to "awesome_key(number)" method by returning :class, :delimiter, :name, :delimiter, :arg' do
+      number = rand(100)
+      @foo.awesome_key(number).should == "foos:awesome:#{number}"
+    end
+
+    it 'should call method_missing on a non-existant method' do
+        lambda{ @foo.thismethoddoesnotexist }.should raise_error(NoMethodError)
+    end
+  end
+
+  # test last
+  describe 'class configurations' do
+    after(:each) do
+      # todo find a better way of resetting all these values
+      Foo.key_delimiter KeyBuilder::DEFAULTS[:key_delimiter]
+      Foo.key_order KeyBuilder::DEFAULTS[:key_order]
+      Foo.key_prefix KeyBuilder::DEFAULTS[:key_prefix]
+      Foo.key_suffix KeyBuilder::DEFAULTS[:key_suffix]
+      Foo.key_pluralize_instances KeyBuilder::DEFAULTS[:key_pluralize_instances]
+      Foo.key_case KeyBuilder::DEFAULTS[:key_case]
+      Foo.key_plural KeyBuilder::DEFAULTS[:key_plural]
+      Foo.key_unique KeyBuilder::DEFAULTS[:key_unique]
+    end
+
+    it 'should change key_delimiter' do
+      key_delimiter = "|"
+      Foo.key_delimiter key_delimiter
+      Foo.key_delimiter.should == key_delimiter
+      Foo.awesome_key.should == "foo#{key_delimiter}awesome"
+    end
+
+
+    it 'should change key_order' do
+      order_array = [:prefix, :name, :unique, :base, :args, :suffix]
+      Foo.key_order order_array
+      Foo.key_order.should == order_array
+      Foo.awesome_key.should == "awesome:foo"
+    end
+
+    it 'should change key_prefix' do
+      key_prefix = "memcache"
+      Foo.key_prefix key_prefix
+      Foo.key_prefix.should == key_prefix
+      Foo.awesome_key.should == "#{key_prefix}:foo:awesome"
+    end
+
+    it 'should change key_suffix' do
+      key_suffix = "slave"
+      Foo.key_suffix key_suffix
+      Foo.key_suffix.should == key_suffix
+      Foo.awesome_key.should == "foo:awesome:#{key_suffix}"
+    end
+
+     it 'should change key_pluralize_instances' do
+       key_pluralize_instances = false
+       Foo.key_pluralize_instances key_pluralize_instances
+       Foo.key_pluralize_instances.should == key_pluralize_instances
+       foo = Foo.new
+       foo.awesome_key.should == "foo:awesome"
+     end
+
+     it 'should change key_case' do
+       key_case = :upcase
+       Foo.key_case key_case
+       Foo.key_case.should == key_case
+       Foo.awesome_key.should == "FOO:AWESOME"
+     end
+
+     it 'should change key_plural' do
+       key_plural = "fooz"
+       Foo.key_plural key_plural
+       Foo.key_plural.should == key_plural
+       foo = Foo.new
+       foo.awesome_key.should == "fooz:awesome"
+     end
+
+     it 'should change key_unique' do
+       Foo.class_eval { def timeish; (Time.now.to_i * 0.01).floor; end}
+       key_unique = :timeish
+       Foo.key_unique key_unique
+       Foo.key_unique.should == key_unique
+       foo = Foo.new
+       foo.awesome_key.should == "foos:awesome:#{foo.timeish}"
+     end
+
+     # todo move tests and assertsions to seperate describe and it blocks
+     it 'should allow all configurations to be set using a hash' do
+       # variables
+       key_delimiter = "/"
+       key_order = [:prefix, :base, :suffix]
+       key_prefix = "before"
+       key_suffix = "after"
+       key_pluralize_instances = false
+       key_case = :upcase
+       key_plural = "zoosk"
+       key_unique = "doesn-t_apply_to_instance_methods"
+       # config
+       Foo.keyfig :key_delimiter => key_delimiter,
+                  :key_order => key_order,
+                  :key_prefix => key_prefix,
+                  :key_suffix => key_suffix,
+                  :key_pluralize_instances => key_pluralize_instances,
+                  :key_case => key_case,
+                  :key_plural => key_plural,
+                  :key_unique => key_unique
+      # assertions
+      Foo.key_delimiter.should == key_delimiter
+      Foo.key_order.should == key_order
+      Foo.key_prefix.should == key_prefix
+      Foo.key_suffix.should == key_suffix
+      Foo.key_pluralize_instances.should == key_pluralize_instances
+      Foo.key_case.should == key_case
+      Foo.key_plural.should == key_plural
+      Foo.key_unique.should == key_unique
+     end
+
+  end
+
+
+
+  describe 'requiring Keytar' do
     it 'should allow ActiveRecord based objects to use their unique identifiers' do
       name = "notblank"
       b = Bar.create(:name => name)
@@ -36,10 +220,6 @@ describe Keytar do
   end
 
   describe 'requiring Keytar with ActiveRecord undefined' do
-    before do
-      begin; Object.send(:remove_const, "ActiveRecord"); rescue NameError; end
-    end
-
     it 'does not automatically add KeyBuilder to the class' do
       describe BarNonActiveRecord.ancestors do
         it {should_not include( KeyBuilder)}

data/spec/keytar/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'active_record'
 
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: keytar
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 23
   prerelease: 
   segments: 
+  - 1
   - 0
-  - 9
   - 0
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Schneems
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-08 00:00:00 -05:00
+date: 2011-05-16 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,40 +105,19 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
-- .DS_Store
 - .rvmrc
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - VERSION
-- db/migrate/001_create_bars.rb
 - keytar.gemspec
 - lib/.DS_Store
 - lib/keytar.rb
 - lib/keytar/key_builder.rb
 - license.txt
-- pkg/keytar-0.1.0.gem
-- pkg/keytar-0.1.1.gem
 - spec/keytar/key_builder_spec.rb
 - spec/keytar/keytar_spec.rb
 - spec/keytar/spec_helper.rb
-- vendor/cache/activemodel-3.0.6.gem
-- vendor/cache/activerecord-3.0.6.gem
-- vendor/cache/activesupport-3.0.6.gem
-- vendor/cache/arel-2.0.9.gem
-- vendor/cache/builder-2.1.2.gem
-- vendor/cache/diff-lcs-1.1.2.gem
-- vendor/cache/git-1.2.5.gem
-- vendor/cache/i18n-0.5.0.gem
-- vendor/cache/jeweler-1.5.2.gem
-- vendor/cache/rake-0.8.7.gem
-- vendor/cache/rspec-2.5.0.gem
-- vendor/cache/rspec-core-2.5.1.gem
-- vendor/cache/rspec-expectations-2.5.0.gem
-- vendor/cache/rspec-mocks-2.5.0.gem
-- vendor/cache/sqlite3-1.3.3.gem
-- vendor/cache/tzinfo-0.3.26.gem
 has_rdoc: true
 homepage: http://github.com/Schnems/keytar
 licenses: 

data/Gemfile.lock

@@ -1,44 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.6)
-      activesupport (= 3.0.6)
-      builder (~> 2.1.2)
-      i18n (~> 0.5.0)
-    activerecord (3.0.6)
-      activemodel (= 3.0.6)
-      activesupport (= 3.0.6)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.6)
-    arel (2.0.9)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    git (1.2.5)
-    i18n (0.5.0)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    rake (0.8.7)
-    rspec (2.5.0)
-      rspec-core (~> 2.5.0)
-      rspec-expectations (~> 2.5.0)
-      rspec-mocks (~> 2.5.0)
-    rspec-core (2.5.1)
-    rspec-expectations (2.5.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.5.0)
-    sqlite3 (1.3.3)
-    tzinfo (0.3.26)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.0.4)
-  activesupport (~> 3.0.4)
-  jeweler (~> 1.5.2)
-  rake (~> 0.8.7)
-  rspec (~> 2.5)
-  sqlite3 (~> 1.3.3)

data/db/migrate/001_create_bars.rb

@@ -1,11 +0,0 @@
-class CreateBars < ActiveRecord::Migration
-  def self.up
-    create_table :bars do |t|
-      t.column :name, :string, :null => false
-    end
-  end
-
-  def self.down
-    drop_table :bars
-  end
-end