rk 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08b7982550fff000dda262a080a8aa2e06928062
-  data.tar.gz: 07ac2573cdad17788e75b5ff5bc659992465a0d2
+  metadata.gz: 072511d6420663d7e00bfcfd1ad0fad43b589333
+  data.tar.gz: 1e3407fb1d77308adb7f783ddddd8a3df046640e
 SHA512:
-  metadata.gz: 5594dd8895519189ad01c218882d3b62abf06374bcd15686e1de142d3e37140b6495abc7e2f5505f0c50bf34ac2dd8b63bc9e98d92edb7984094be0f4e023ae4
-  data.tar.gz: bbc4d2fcecc80530f92e0e2fa49dba41549e3e3203ff53301736c698fd27dd998ceb26ea3580ac9ef3ec59a52befdc35da49aad73e086f98073ae6e86898bf0a
+  metadata.gz: 3bef8fd553c1c3f1a0befe58c20af4c86b7b741296af168043218147ade21b7b2cecafffec8b4651efac3d4a7f4456b2d9c14b93c055225bbb05de9c6c3c0418
+  data.tar.gz: c88add90b37662301a02f22e471eabdb8bf327a4f1153c841d70e5674ab3bcd21e75420a74d3dd3b6d5873f3acfd3731fec2c38d73f792139a8d6d6696adbc1f

data/lib/rk.rb

@@ -1,39 +1,67 @@
-# Module for including "rk" to global namespace (class Object)
+# Module for including +rk+ to global namespace (class Object).
 module Rk
 
-  # Build Redis keys of several elements, for example rk("user", 10) => "user:10"
+  # Build Redis keys of several elements.
+  #   rk("user", 10) => "user:10"
   class Rk
-    attr_accessor :separator, :prefix, :suffix
+    attr_accessor :separator, :prefix, :suffix, :keys
 
-    # Set defaults, separator to ":", prefix/suffix is empty
+    # Set defaults
+    # * <tt>separator</tt> - :
+    # * <tt>prefix</tt> - empty
+    # * <tt>suffix</tt> - empty
+    # * <tt>keys</tt> - empty
     def initialize
       @separator = ":"
       @prefix = ""
       @suffix = ""
+      @keys = {}
     end
 
-    # Build a string including prefix/suffix, joining all elements with the separator
+    # Build a string including prefix/suffix, joining all elements with the separator.
     def rk(*elements)
       ([@prefix] + elements + [@suffix]).reject { |element| element.to_s.empty? }.join(@separator)
     end
 
-    # Add methods dynamically to define/access elements, for example
-    # rk.user = "user"; rk(rk.user, 10) => "user:10"
+    # Add methods dynamically to define/access elements.
+    #   rk.user = "user"
+    #   rk(rk.user, 10) => "user:10"
     def method_missing(method, *arg)
       # Raise an error if a method gets accessed which was not defined before
       raise RuntimeError, "'rk.#{method.to_s}' is undefined" unless method.to_s.include?("=")
 
       # Define a method to return a value as set, for example rk.settings = 'set' defines
       # a method called "settings" which returns the string "set"
+      key = method.to_s.sub(/=/, "")
+      val = (arg || []).first
+
       instance_eval(%Q[
-        def #{method.to_s.sub(/=/, "")}
-          "#{(arg || []).first}"
+        def #{key}
+          "#{val}"
         end
       ])
+
+      # Store user-defined key
+      @keys[key] = val
     end
-  end
 
-  # Create and call a global instance of Rk to either build a key or set/get attributes
+    # Define key elements by key/value pairs of a hash, symbols and strings allowed for
+    # keys/values.
+    #
+    #   rk.keys = { user: "user", "statistics" => "stats", "session" => :sess }
+    def keys=(h)
+      # Allow hash only
+      raise TypeError, "invalid type" unless h.is_a?(Hash)
+
+      # Call rk.<key> = <val> for each pair of hash
+      h.each_pair do |key, val|
+        self.send("#{key}=", val)
+      end
+    end
+
+  end # class Rk
+
+  # Create and call a global instance of Rk to either build a key or set/get attributes.
   def rk(*elements)
     $_rk = Rk.new unless $_rk
 
@@ -49,7 +77,7 @@ module Rk
 
 end # module Rk
 
-# We could use "extend Rk" to extend only "main", but we would have to "include Rk" in
+# We could use +extend Rk+ to extend only +main+, but we would have to +include Rk+ in
 # any class, hence we include Rk to the global object.
 class Object
   include Rk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Oliver Mensinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies: []
 description: Ruby helper to generate keys for Redis
 email: oliver.mensinger@gmail.com