norton 0.0.22 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b5906f15562fcd49ad8fcd7a1328a12758984b5
-  data.tar.gz: bd7baed316f3532ece1c2567959ea1f7e408d7ee
+  metadata.gz: 47f5a6a213e297cec27645a41ff453ae1b7d4bfd
+  data.tar.gz: 37b3492ec453174d6bb8993ddf835ae2af2a43b4
 SHA512:
-  metadata.gz: 0ae278996ed1de62b9a54024ea6fb26c7a823c0a1eeb8afa61ba6807153b7812aeef1903193c77033df6e9a8c4edeb59816c7857d63e563225e4fbf262b69638
-  data.tar.gz: 3ae1acec911911dc8943814071bfd0c8f845e0139e2897b523a67f461c60ec90bb3367b651b621bdb2db0a2f1910650fdb9969c3cb3cfc7883ebafc3a660aee6
+  metadata.gz: cd5c343f935788a653d31e65b8f94107353df0121ced3610cc65613782fdc462450b05437a06c613f1dfd6c84dc6941dcf90119ccb66f0e1dbd81ce12ce6ca47
+  data.tar.gz: 12969d600acc46904a4680e49cf62f3acaff0243970449358d98619a9cf4e9e08f441f6c4cb86ddb057c81b56312f9cea06780e7b51bfa8ebde631cd5ce29a7f

data/lib/norton/counter.rb

@@ -1,6 +1,10 @@
 module Norton
   module Counter
-    extend ActiveSupport::Concern
+    extend ::ActiveSupport::Concern
+
+    included do
+      include Norton::Helper
+    end
 
     module ClassMethods
       #
@@ -13,37 +17,37 @@ module Norton
       def counter(name, options={}, &blk)
         define_method(name) do
           Norton.redis.with do |conn|
-            conn.get("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}").try(:to_i) || 0
+            conn.get(self.norton_redis_key(name)).try(:to_i) || 0
           end
         end
 
         define_method("incr_#{name}") do
           Norton.redis.with do |conn|
-            conn.incr("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}")
+            conn.incr(self.norton_redis_key(name))
           end
         end
 
         define_method("decr_#{name}") do
           Norton.redis.with do |conn|
-            conn.decr("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}")
+            conn.decr(self.norton_redis_key(name))
           end
         end
 
         define_method("incr_#{name}_by") do |increment|
           Norton.redis.with do |conn|
-            conn.incrby("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", increment)
+            conn.incrby(self.norton_redis_key(name), increment)
           end
         end
 
         define_method("decr_#{name}_by") do |decrement|
           Norton.redis.with do |conn|
-            conn.decrby("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", decrement)
+            conn.decrby(self.norton_redis_key(name), decrement)
           end
         end
 
         define_method("#{name}=") do |v|
           Norton.redis.with do |conn|
-            conn.set("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", v)
+            conn.set(self.norton_redis_key(name), v)
           end
         end
 
@@ -51,13 +55,13 @@ module Norton
           count = instance_eval(&blk)
 
           Norton.redis.with do |conn|
-            conn.set("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", count)
+            conn.set(self.norton_redis_key(name), count)
           end
         end
 
         define_method("remove_#{name}") do
           Norton.redis.with do |conn|
-            conn.del("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}")
+            conn.del(self.norton_redis_key(name))
           end
         end
         send(:after_destroy, "remove_#{name}".to_sym) if respond_to? :after_destroy

data/lib/norton/hash_map.rb

@@ -2,26 +2,21 @@ module Norton
   module HashMap
     extend ActiveSupport::Concern
 
+    included do
+      include Norton::Helper
+    end
+
     module ClassMethods
       def hash_map(name)
         define_method(name) do
           instance_variable_get("@#{name}") ||
             instance_variable_set("@#{name}",
-              Norton::Objects::Hash.new(norton_field_key(name))
+              Norton::Objects::Hash.new(self.norton_redis_key(name))
             )
         end
 
         after_destroy { send(name).clear } if respond_to?(:after_destroy)
       end
     end
-
-    def norton_field_key(name)
-      if id.nil?
-        raise NilObjectId,
-          "Attempt to address norton field :#{name} on class #{self.class.name} with nil id"
-      end
-
-      "#{self.class.name.tableize}:#{id}:#{name}"
-    end
   end
 end

data/lib/norton/helper.rb

@@ -2,6 +2,42 @@ module Norton
   module Helper
     extend ActiveSupport::Concern
 
+    #
+    # Prefix of Redis Key of Norton value, consists with Class name string in plural form
+    # and Instance id.
+    #
+    # Example:
+    #
+    # a User instance with id = 1 -> `users:1`
+    # a HolyLight::Spammer instance with id = 5 -> `holy_light/spammers:5`
+    #
+    #
+    # @return [String]
+    #
+    def norton_prefix
+      id = self.id
+      raise Norton::NilObjectId if id.nil?
+      klass = self.class.to_s.pluralize.underscore
+      "#{klass}:#{self.id}"
+    end
+
+    #
+    # Returns the final Redis Key of a certain Norton value, teh value will be saved in redis with
+    # this value.
+    #
+    # Example:
+    #
+    # a User instance with id = 1 defines a counter named `likes_count` -> users:1:likes_count
+    #
+    #
+    # @param [String] name
+    #
+    # @return [String]
+    #
+    def norton_redis_key(name)
+      "#{self.norton_prefix}:#{name}"
+    end
+
     #
     # 批量取出当前对象的多个 Norton value
     #
@@ -9,21 +45,20 @@ module Norton
     #
     # @return [Hash]
     #
-    def norton_values(*keys)
+    def norton_vals(*names)
       ret = {}
 
-      redis_keys = keys.map { |k| "#{self.class.to_s.pluralize.underscore}:#{self.id}:#{k}" }
+      redis_keys = names.map { |n| self.norton_redis_key(n) }
 
       redis_values = Norton.redis.with do |conn|
         conn.mget(redis_keys)
       end
 
-      keys.each_with_index do |key, index|
-        ret[key] = redis_values[index].try(:to_i)
+      names.each_with_index do |n, index|
+        ret[n] = redis_values[index].try(:to_i)
       end
 
       ret
     end
-
   end
 end

data/lib/norton/timed_value.rb

@@ -16,11 +16,11 @@ module Norton
         # Define getter
         define_method(name) do
           Norton.redis.with do |conn|
-            v = conn.get("#{self.class.to_s.tableize}:#{self.id}:#{name}")
+            v = conn.get(self.norton_redis_key(name))
 
             if v.nil?
               v = instance_eval(&blk)
-              conn.setex("#{self.class.to_s.tableize}:#{self.id}:#{name}", options[:ttl], v)
+              conn.setex(self.norton_redis_key(name), options[:ttl], v)
             end
 
             v
@@ -30,11 +30,11 @@ module Norton
         define_method("reset_#{name}") do
           Norton.redis.with do |conn|
             v = instance_eval(&blk)
-            conn.setex("#{self.class.to_s.tableize}:#{self.id}:#{name}", options[:ttl], v)
+            conn.setex(self.norton_redis_key(name), options[:ttl], v)
             v
           end
         end
       end
     end
   end
-end
+end

data/lib/norton/timestamp.rb

@@ -2,6 +2,10 @@ module Norton
   module Timestamp
     extend ActiveSupport::Concern
 
+    included do
+      include Norton::Helper
+    end
+
     module ClassMethods
       #
       # [timestamp Define a timestamp]
@@ -14,11 +18,11 @@ module Norton
           ts = nil
 
           Norton.redis.with do |conn|
-            ts = conn.get("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}").try(:to_i)
+            ts = conn.get(self.norton_redis_key(name)).try(:to_i)
 
             if !options[:allow_nil] && ts.nil?
               ts = Time.now.to_i
-              conn.set("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", ts)
+              conn.set(self.norton_redis_key(name), ts)
             end
 
             ts
@@ -28,13 +32,20 @@ module Norton
         define_method("touch_#{name}") do
           Norton.redis.with do |conn|
             if options[:digits].present? && options[:digits] == 13
-              conn.set("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", (Time.now.to_f * 1000).to_i)
+              conn.set(self.norton_redis_key(name), (Time.now.to_f * 1000).to_i)
             else
-              conn.set("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}", Time.now.to_i)
+              conn.set(self.norton_redis_key(name), Time.now.to_i)
             end
           end
         end
 
+        define_method("remove_#{name}") do
+          Norton.redis.with do |conn|
+            conn.del("#{self.class.to_s.pluralize.underscore}:#{self.id}:#{name}")
+          end
+        end
+        send(:after_destroy, "remove_#{name}".to_sym) if respond_to? :after_destroy
+
         # Add callback
         if options[:touch_on].present?
           options[:touch_on].each do |callback, condition|

data/lib/norton/version.rb

@@ -1,3 +1,3 @@
 module Norton
-  VERSION = "0.0.22"
+  VERSION = "0.0.24"
 end

data/lib/norton.rb

@@ -3,10 +3,10 @@ require "connection_pool"
 require "active_support/concern"
 require "active_support/inflector"
 require "norton/version"
+require "norton/helper"
 require "norton/timestamp"
 require "norton/counter"
 require "norton/timed_value"
-require "norton/helper"
 require "norton/objects/hash"
 require "norton/hash_map"
 

data/spec/norton/hash_map_spec.rb

@@ -11,17 +11,10 @@ class HashMapObject
 end
 
 describe Norton::HashMap do
-  describe "#norton_field_key" do
+  describe "#norton_redis_key" do
     it "generates the correct field key" do
       object = HashMapObject.new
-      expect(object.norton_field_key(:profile)).to eq("hash_map_objects:99:profile")
-    end
-
-    it "raises NilObjectId if the object id is nil" do
-      object = HashMapObject.new
-      allow(object).to receive(:id) { nil }
-
-      expect { object.norton_field_key(:profile) }.to raise_error(Norton::NilObjectId)
+      expect(object.norton_redis_key(:profile)).to eq("hash_map_objects:99:profile")
     end
   end
 

data/spec/norton/helper_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 class Dummy
   include Norton::Counter
   include Norton::Timestamp
-  include Norton::Helper
 
   counter :counter1
   counter :counter2
@@ -16,12 +15,50 @@ class Dummy
   end
 end
 
+module HolyLight
+  class Spammer
+    include Norton::Counter
+
+    def id
+      @id ||= Random.rand(10000)
+    end
+  end
+end
+
 describe Norton::Helper do
-  describe ".norton_values" do
-    it "should respond to `:norton_values`" do
+  describe "#norton_redis_key" do
+    it do
+      n = SecureRandom.hex(3)
+
+      dummy = Dummy.new
+      expect(dummy.norton_redis_key(n)).to eq("dummies:#{dummy.id}:#{n}")
+    end
+
+    it "should raise `Norton::NilObjectId` if id returns nil" do
+      dummy = Dummy.new
+      allow(dummy).to receive(:id) { nil }
+
+      expect { dummy.norton_prefix }.to raise_error(Norton::NilObjectId)
+    end
+  end
+
+  describe "#norton_prefix" do
+    it "should return correctly for `Dummy`" do
+      dummy = Dummy.new
+      expect(dummy.norton_prefix).to eq("dummies:#{dummy.id}")
+    end
+
+    it "should return correctly for `HolyLight::Spammer`" do
+      spammer = HolyLight::Spammer.new
+      expect(spammer.norton_prefix).to eq("holy_light/spammers:#{spammer.id}")
+    end
+  end
+
+  describe "#norton_vals" do
+    it "should respond to `:norton_vals`" do
       dummy = Dummy.new
 
-      expect(dummy).to respond_to(:norton_values)
+      expect(dummy).to respond_to(:norton_vals)
     end
 
     it "should return the specific values" do
@@ -33,7 +70,7 @@ describe Norton::Helper do
 
       dummy.touch_time1
 
-      values = dummy.norton_values(:counter1, :time1)
+      values = dummy.norton_vals(:counter1, :time1)
 
       expect(values).to include(:counter1, :time1)
       expect(values.size).to eq(2)
@@ -50,7 +87,7 @@ describe Norton::Helper do
 
       dummy.touch_time1
 
-      values = dummy.norton_values(:counter1, :counter2, :time2)
+      values = dummy.norton_vals(:counter1, :counter2, :time2)
 
       expect(values).to include(:counter1, :counter2, :time2)
       expect(values.size).to eq(3)

data/spec/norton/timestamp_spec.rb

@@ -24,6 +24,11 @@ describe Norton::Timestamp do
       expect(dummy).to respond_to(:born_at)
       expect(dummy).to respond_to(:touch_born_at)
     end
+
+    it "should create remove method" do
+      dummy = Dummy.new
+      expect(dummy).to respond_to(:remove_born_at)
+    end
   end
 
   describe "#touch_born_at" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norton
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.24
 platform: ruby
 authors:
 - Larry Zhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis