keytar 1.0.0 → 1.0.1

data/README.md

@@ -57,48 +57,39 @@ Keys can be pre-defined and configured on a per key basis by calling **define\_k
 
     class User
       include Keytar
-      define_keys [:zoolander, :something_about_mary, :tropic_thunder], :delimiter => "|", :version => 2
+      define_keys [:friend_ids, :email_subscriptions, :news_feed], :delimiter => "|", :version => "v2"
       define_keys :cassandra, :delimiter => "/", :version => 3, :key_prefix => "lol"
     end
 
-    User.respond_to? :zoolander_key #=> true
-    User.zoolander_key #=> "user|zoolander|2"
+    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. 
 
 
-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 :key_delimiter => ":", :key_order => [:unique, :suffix], :key_prefix => "before"
+      key_config :delimiter => ":", :order => [:unique, :suffix], :prefix => "before"
     end
 
-Or by calling class methods
-
-    class User
-      include Keytar
-      key_delimiter ":"
-      key_order [:prefix, :base, :name, :unique, :args, :suffix]
-      key_prefix nil
-    end
-
-Config Options Breakdown
+Configuration Options Breakdown
 ------------------------
 Here is a run down of what each does  
 
-**key_delimiter** sets the separating argument in keys
+**delimiter** sets the separating argument in keys
 
-    User.key_delimiter "|"
+    :delimiter => "|"
     user.redis_key #=> "users|redis"
 
 
-**key_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
 
-    User.key_order [:name, :base]
+    :key_order =>[:name, :base]
     user.redis_key #=> "redis:users"
     
-**key_unique** sets the unique value of the instance that is used to build the key
+**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)
 
@@ -106,34 +97,34 @@ By default all instance keys have an identifying unique element included in the
     user.id #=> 9
     user.redis_key #=> "users:redis:9"
 
-    User.key_unique("username")
+    :unique => "username"
     user.username #=> "schneems"
     user.redis_key #=> "users:redis:schneems"
 
-**key_prefix** adds some text to the beginning of your key for that class
+**prefix** adds some text to the beginning of your key for that class
 
-    User.key_prefix "woot"
+    :prefix =>  "woot"
     User.redis_key #=> "woot:users:redis"
     
-**key_suffix** adds some text to the end of your key for that class
+**suffix** adds some text to the end of your key for that class
 
-    User.key_suffix "slave"
+    :suffix => "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)
+**`pluralize_instances`** allows you to toggle pluralizing instance keys (note the 's' in 'users' is not there)
 
-    User.key_pluralize_instances false
+    :pluralize_instances => false
     user.redis_key #=> "user:redis"
     
 
-**key_plural** allows you to over-ride the default pluralize method with custom spelling
+**plural** allows you to over-ride the default pluralize method with custom spelling
 
-    User.key_plural "uzerz"
+    :plural => "uzerz"
     user.redis_key #=> "uzerz:redis"
 
-**key_case** allows you to specify the case of your key
+**case** allows you to specify the case of your key
 
-    User.key_case :upcase
+    :case => :upcase
     User.redis_key #=> "USER:REDIS"
 
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/keytar.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{keytar}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Schneems"]

data/lib/keytar/key_builder.rb

@@ -76,6 +76,9 @@ module KeyBuilder
 
     # a way to define configurations for keytar using a hash
     def key_config(options = {})
+      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_.*/
       end

data/spec/keytar/keytar_spec.rb

@@ -187,14 +187,14 @@ describe Keytar do
        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
+       Foo.keyfig :delimiter => key_delimiter,
+                  :order => key_order,
+                  :prefix => key_prefix,
+                  :suffix => key_suffix,
+                  :pluralize_instances => key_pluralize_instances,
+                  :case => key_case,
+                  :plural => key_plural,
+                  :unique => key_unique
       # assertions
       Foo.key_delimiter.should == key_delimiter
       Foo.key_order.should == key_order

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: keytar
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Schneems