keytar 1.0.1 → 1.1.0

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/growl'

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/Gemfile

@@ -1,10 +1,11 @@
 source 'http://rubygems.org'
 
-group :development do
+group :development, :test do
   gem 'activerecord', '~>3.0.4' ## not needed if you're just using KeyBuilder
-  gem 'activesupport', '~>3.0.4' ## KeyBuilder relies on several helper methods, can be re-factored to not need this
   gem 'rake', '~>0.8.7'
   gem 'jeweler', '~>1.5.2'
+  gem "autotest-standalone"
+  gem "autotest-growl"
 end
 
 group :test do

data/README.md

@@ -12,8 +12,8 @@ Keytar is an amazingly easy way generate keys for all of your NOSQL key needs. A
 ___quit___ littering your code with junk like this:
 
     class User
-      def some_distributed_no_sql_datastore_key
-        "foos:some_distributed_no_sql_datastore:#{self.id}"
+      def some_key_for_a_distributed_no_sql_datastore_key
+        "foos:some_key_for_a_distributed_no_sql_datastore_key:#{self.id}"
       end
     end
 
@@ -38,11 +38,11 @@ Example:
 keytar auto-magically generates keys using method names ending in `"_key"` or simply "key"
 
     User.key #=> "user"
-    User.memcache_key #=> "user:memcache"
+    User.friends_key #=> "user:friends"
     
     u = User.new
-    u.redis_key #=> "users:redis"
-    u.redis_key("some_argument") #=> "users:redis:some_argument"
+    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"
@@ -58,7 +58,7 @@ Keys can be pre-defined and configured on a per key basis by calling **define\_k
     class User
       include Keytar
       define_keys [:friend_ids, :email_subscriptions, :news_feed], :delimiter => "|", :version => "v2"
-      define_keys :cassandra, :delimiter => "/", :version => 3, :key_prefix => "lol"
+      define_keys :favorite_spots, :delimiter => "/", :version => 3, :key_prefix => "lol"
     end
 
     User.respond_to? :friend_ids_key #=> true
@@ -67,65 +67,66 @@ Keys can be pre-defined and configured on a per key basis by calling **define\_k
 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. 
 
 
-global options can also be configured per class by passing in a hash to **key_config**:
+Global options can also be configured per class by passing in a hash to **key_config**:
 
     class User
       include Keytar
-      key_config :delimiter => ":", :order => [:unique, :suffix], :prefix => "before"
+      key_config :delimiter => "/", :suffix => "after"
+      define_keys :ignored_ids
     end
 
+    User.ignored_ids_key #=> "user/ignored_ids/after"
+
 Configuration Options Breakdown
 ------------------------
 Here is a run down of what each does  
 
 **delimiter** sets the separating argument in keys
 
-    :delimiter => "|"
-    user.redis_key #=> "users|redis"
+    define_keys :favorite_spots, :delimiter => "|"
+    User.favorite_spots_key #=> "user|favorite_spots"
 
 
-**order** sets the location of key parts, if a symbol is omitted, it will not show up in the final key
+**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)
 
-    :key_order =>[:name, :base]
-    user.redis_key #=> "redis:users"
+    define_keys :favorite_spots, :order => [:name, :base]
+    User.favorite_spots_key #=> "favorite_spots:user:1"
     
 **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)
 
-    user = User.create(:username => "Schneems", :id => 9)
-    user.id #=> 9
-    user.redis_key #=> "users:redis:9"
+    User.create(:username => "Schneems", :id => 9)
+    User.find(9).favorite_spots_key #=> "users:favorite_spots:9"
 
-    :unique => "username"
-    user.username #=> "schneems"
-    user.redis_key #=> "users:redis:schneems"
+    define_keys :favorite_spots, :unique => "username"
+    User.find(9).favorite_spots_key #=> "users:favorite_spots:schneems"
 
 **prefix** adds some text to the beginning of your key for that class
 
-    :prefix =>  "woot"
-    User.redis_key #=> "woot:users:redis"
+    define_keys :favorite_spots, :prefix =>  "woot"
+    User.favorite_spots_key #=> "woot:user:favorite_spots"
     
 **suffix** adds some text to the end of your key for that class
 
-    :suffix => "slave"
-    User.redis_key #=> "users:redis:slave"
+    define_keys :favorite_spots, :suffix => "pow"
+    User.favorite_spots_key #=> "user:favorite_spots:pow"
 
 **`pluralize_instances`** allows you to toggle pluralizing instance keys (note the 's' in 'users' is not there)
 
-    :pluralize_instances => false
-    user.redis_key #=> "user:redis"
+    define_keys :favorite_spots, :pluralize_instances => false
+    User.find(1).favorite_spots_key #=> "user:favorite_spots:1"
     
 
 **plural** allows you to over-ride the default pluralize method with custom spelling
 
-    :plural => "uzerz"
-    user.redis_key #=> "uzerz:redis"
+    define_keys :favorite_spots, :plural => "uzerz"
+    User.find(1).favorite_spots_key #=> "uzerz:favorite_spots:1"
 
 **case** allows you to specify the case of your key
 
-    :case => :upcase
-    User.redis_key #=> "USER:REDIS"
+    define_keys :favorite_spots, :case => :upcase
+    User.favorite_spots_key #=> "USER:REDIS"
 
 
 Since this library is sooooo simple, here is a ASCII keytar for you. Thanks for checking it out.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/autotest/discover.rb

@@ -0,0 +1 @@
+Autotest.add_discovery { "rspec2" }

data/keytar.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keytar}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]
-  s.date = %q{2011-05-16}
+  s.date = %q{2011-06-20}
   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,19 +20,23 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".autotest",
+    ".rspec",
     ".rvmrc",
     "Gemfile",
     "README.md",
     "Rakefile",
     "VERSION",
+    "autotest/discover.rb",
     "keytar.gemspec",
     "lib/.DS_Store",
     "lib/keytar.rb",
     "lib/keytar/key_builder.rb",
+    "lib/keytar/key_utility.rb",
     "license.txt",
     "spec/keytar/key_builder_spec.rb",
     "spec/keytar/keytar_spec.rb",
-    "spec/keytar/spec_helper.rb"
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/Schnems/keytar}
   s.licenses = ["MIT"]
@@ -42,7 +46,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/keytar/key_builder_spec.rb",
     "spec/keytar/keytar_spec.rb",
-    "spec/keytar/spec_helper.rb"
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -50,22 +54,25 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<activerecord>, ["~> 3.0.4"])
-      s.add_development_dependency(%q<activesupport>, ["~> 3.0.4"])
       s.add_development_dependency(%q<rake>, ["~> 0.8.7"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<autotest-standalone>, [">= 0"])
+      s.add_development_dependency(%q<autotest-growl>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
       s.add_dependency(%q<activerecord>, ["~> 3.0.4"])
-      s.add_dependency(%q<activesupport>, ["~> 3.0.4"])
       s.add_dependency(%q<rake>, ["~> 0.8.7"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<autotest-standalone>, [">= 0"])
+      s.add_dependency(%q<autotest-growl>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
     s.add_dependency(%q<activerecord>, ["~> 3.0.4"])
-    s.add_dependency(%q<activesupport>, ["~> 3.0.4"])
     s.add_dependency(%q<rake>, ["~> 0.8.7"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<autotest-standalone>, [">= 0"])
+    s.add_dependency(%q<autotest-growl>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
   end
 end

data/lib/keytar.rb

@@ -1,5 +1,6 @@
 
 module Keytar
+  autoload :KeyUtility, "keytar/key_utility"
   autoload :KeyBuilder, 'keytar/key_builder'
   def self.included(klass)
     klass.class_eval {include KeyBuilder}

data/lib/keytar/key_builder.rb

@@ -1,5 +1,4 @@
-require 'active_support/inflector' # used for pluralize
-require 'active_support/core_ext/object/blank' # used for blank? and present?
+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
@@ -31,6 +30,7 @@ module KeyBuilder
   module Ext
     # creates class level getter and setter methods for the defaults for config
     DEFAULTS.keys.each do |key|
+      # TODO: re-write without eval
       eval %{
         def #{key}(#{key}_input = :key_default)
           @@#{key} = DEFAULTS[:#{key}] unless defined? @@#{key}
@@ -76,11 +76,12 @@ module KeyBuilder
 
     # a way to define configurations for keytar using a hash
     def key_config(options = {})
+      # 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
-      options.keys.each do |key|
-        eval("@@#{key} = options[key]") if key.to_s =~ /^key_.*/
+      options.each do |key, value|
+        self.send( key , value) if self.respond_to? key
       end
     end
     alias :keyfig :key_config
@@ -129,7 +130,8 @@ module KeyBuilder
     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
+    unique = self.send "#{options[:key_unique]||self.class.key_unique}".to_sym
+    options[:unique] = unique unless unique == object_id
     self.class.build_key(options)
   end
 

data/lib/keytar/key_utility.rb

@@ -0,0 +1,26 @@
+# Monkey patches for Object#blank?, Object.present? and String#pluralize
+# If active support is required, this won't be used, but
+# we shouldn't require a ruby project to use ActiveSupport
+# just for these three simple things
+
+module KeyUtility
+  unless Object.respond_to?(:blank?)
+    Object.class_eval do
+      def blank?
+        respond_to?(:empty?) ? empty? : !self
+      end
+
+      def present?
+        !blank?
+      end
+    end
+  end
+
+  unless String.respond_to? :pluralize
+    String.class_eval do
+      def pluralize
+        self[(self.length - 1), 1] =~ /s/i ? self : "#{self}s"
+      end
+    end
+  end
+end

data/spec/keytar/key_builder_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 class Foo
   include Keytar

data/spec/keytar/keytar_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
 ## Gives us ActiveRecord backed model Bar that we can test instances of
 ActiveRecord::Base.establish_connection(

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: keytar
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Schneems
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 -04:00
+date: 2011-06-20 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,22 +37,6 @@ dependencies:
 - !ruby/object:Gem::Dependency 
   type: :development
   requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 3
-        - 0
-        - 4
-        version: 3.0.4
-  name: activesupport
-  version_requirements: *id002
-  prerelease: false
-- !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -64,11 +48,11 @@ dependencies:
         - 7
         version: 0.8.7
   name: rake
-  version_requirements: *id003
+  version_requirements: *id002
   prerelease: false
 - !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -80,6 +64,20 @@ dependencies:
         - 2
         version: 1.5.2
   name: jeweler
+  version_requirements: *id003
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: autotest-standalone
   version_requirements: *id004
   prerelease: false
 - !ruby/object:Gem::Dependency 
@@ -93,9 +91,23 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rspec
+  name: autotest-growl
   version_requirements: *id005
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  version_requirements: *id006
+  prerelease: false
 description: "\n    Keytar is a Ruby on Rails wrapper for KeyBuilder.\n    Use KeyBuilder to automatically generate keys based on class name instead of cluttering model\n    definitions with tons of redundant key method declarations.\n  "
 email: richard.schneeman@gmail.com
 executables: []
@@ -105,19 +117,23 @@ extensions: []
 extra_rdoc_files: 
 - README.md
 files: 
+- .autotest
+- .rspec
 - .rvmrc
 - Gemfile
 - README.md
 - Rakefile
 - VERSION
+- autotest/discover.rb
 - keytar.gemspec
 - lib/.DS_Store
 - lib/keytar.rb
 - lib/keytar/key_builder.rb
+- lib/keytar/key_utility.rb
 - license.txt
 - spec/keytar/key_builder_spec.rb
 - spec/keytar/keytar_spec.rb
-- spec/keytar/spec_helper.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/Schnems/keytar
 licenses: 
@@ -155,4 +171,4 @@ summary: A crazy simple library for building keys  (in _key_ value store, not ho
 test_files: 
 - spec/keytar/key_builder_spec.rb
 - spec/keytar/keytar_spec.rb
-- spec/keytar/spec_helper.rb
+- spec/spec_helper.rb