norton 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6535a6a6aa0b6aafc903750f29736fdb867e436e
-  data.tar.gz: f6a843aaa3aac77be86602b45dc8f4181cb03a10
+  metadata.gz: 8de7d288d5c2e1b54399508842ffc761063d2bbf
+  data.tar.gz: b2cb45b37ca12fa36e8adf03455220fba96153ea
 SHA512:
-  metadata.gz: ec3d694c9179a844a3f4b48915f7a62e32ce0d130d14b5e4685f08f8d87d8e9a05c4f68693af28d02dd07037af0b8b8e3b60f8de4d7c248fe7eea1b5e05acd1b
-  data.tar.gz: e86b51e2e964fbd2a646ef88cbbd59504506fe7bd553be74c688ffb8463a8ed1478038a7bee66d77ad671942ea73b0efab9f27546f9a601d841e1d58e98c6875
+  metadata.gz: afeb424fb75456de2a6dafa5eb1285dc6bdf6e6fbdca78e1b1c5e8bb819a60da37957a108d638747030c134c94f71aef55349533bd1cde6bd3fa73494dfcff43
+  data.tar.gz: 38a31ffb7c30e55f60061abd6e49be42955ffa4a9cc8b59b3a7bcff8aa68c49ad03aefd145808ee6ef310f2ffc83144005b145d5484bde8e74632c2ab5adb46f

data/Rakefile

@@ -1,7 +1,9 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
 
-Rake::TestTask.new do |t|
-  t.libs << 'spec'
-  t.pattern = "spec/**/*_spec.rb"
-end
+desc "run all the specs"
+task :test do
+  sh "rspec spec"
+end
+task :default => :test
+task :spec => :test

data/lib/norton/hash.rb

@@ -0,0 +1,27 @@
+module Norton
+  module Hash
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def hash_map(name)
+        define_method(name) do
+          instance_variable_get("@#{name}") ||
+            instance_variable_set("@#{name}",
+              Norton::Objects::HashMap.new(norton_field_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/objects/hash_map.rb

@@ -0,0 +1,68 @@
+module Norton
+  module Objects
+    class HashMap
+      attr_reader :key
+
+      def initialize(key)
+        @key = key
+      end
+
+      # Redis: HSET
+      def hset(field, value)
+        Norton.redis.with { |conn| conn.hset(key, field, value) }
+      end
+      alias_method :[]=, :hset
+
+      # Redis: HGET
+      def hget(field)
+        Norton.redis.with { |conn| conn.hget(key, field) }
+      end
+      alias_method :get, :hget
+      alias_method :[],  :hget
+
+      # Redis: HMGET
+      def hmget(*field)
+        Norton.redis.with { |conn| conn.hmget(key, field) }
+      end
+      alias_method :mget, :hmget
+
+      # Redis: HDEL
+      def hdel(*field)
+        Norton.redis.with { |conn| conn.hdel(key, field) }
+      end
+      alias_method :delete, :hdel
+
+      # Redis: HINCRBY
+      def hincrby(field, by = 1)
+        Norton.redis.with { |conn| conn.hincrby(key, field, by) }
+      end
+      alias_method :incr, :hincrby
+
+      # Redis: HINCRBY
+      def hdecrby(field, by = 1)
+        hincrby(field, -by)
+      end
+      alias_method :decr, :hdecrby
+
+      # Redis: HEXISTS
+      def hexists(field)
+        Norton.redis.with { |conn| conn.hexists(key, field) }
+      end
+      alias_method :include?, :hexists
+      alias_method :has_key?, :hexists
+      alias_method :key?,     :hexists
+      alias_method :member?,  :hexists
+
+      # Redis: HEXISTS
+      def hkeys
+        Norton.redis.with { |conn| conn.hkeys(key) }
+      end
+      alias_method :keys, :hkeys
+
+      # Redis: DEL
+      def clear
+        Norton.redis.with { |conn| conn.del(key) }
+      end
+    end
+  end
+end

data/lib/norton/version.rb

@@ -1,3 +1,3 @@
 module Norton
-  VERSION = "0.0.19"
+  VERSION = "0.0.20"
 end

data/lib/norton.rb

@@ -7,8 +7,12 @@ require "norton/timestamp"
 require "norton/counter"
 require "norton/timed_value"
 require "norton/helper"
+require "norton/objects/hash_map"
+require "norton/hash"
 
 module Norton
+  class NilObjectId < StandardError; end
+
   class << self
     attr_accessor :redis
 

data/spec/norton/hash_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+class HashObject
+  include Norton::Hash
+
+  hash_map :profile
+
+  def id
+    @id ||= 99
+  end
+end
+
+describe Norton::Hash do
+  describe "#norton_field_key" do
+    it "generates the correct field key" do
+      object = HashObject.new
+      expect(object.norton_field_key(:profile)).to eq("hash_objects:99:profile")
+    end
+
+    it "raises NilObjectId if the object id is nil" do
+      object = HashObject.new
+      allow(object).to receive(:id) { nil }
+
+      expect { object.norton_field_key(:profile) }.to raise_error(Norton::NilObjectId)
+    end
+  end
+
+  describe "#hash_map" do
+    it "sets a instance variable" do
+      object = HashObject.new
+      expect(object.profile).to be_a(Norton::Objects::HashMap)
+    end
+  end
+end

data/spec/norton/objects/hash_map_spec.rb

@@ -0,0 +1,115 @@
+require 'spec_helper'
+
+describe Norton::Objects::HashMap do
+  describe "#hset" do
+    it "saves the value of the field in redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+      expect(Norton.redis.with { |conn| conn.hget(hash_map.key, :name) }).to eq("Bob")
+    end
+  end
+
+  describe "#hget" do
+    it "returns the value of the field from redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+
+      expect(hash_map.hget(:name)).to eq("Bob")
+    end
+  end
+
+  describe "#hdel" do
+    it "deletes the field from redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+
+      hash_map.hdel(:name)
+
+      expect(hash_map.hget(:name)).to be(nil)
+    end
+
+    it "deletes multiple fields from redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+      hash_map.hset(:age, 21)
+
+      hash_map.hdel(:name, :age)
+
+      expect(hash_map.hget(:name)).to be(nil)
+      expect(hash_map.hget(:age)).to be(nil)
+    end
+  end
+
+  describe "#hmget" do
+    it "returns the values associated with the specified fields in the hash" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+      hash_map.hset(:age,  21)
+
+      expect(hash_map.hmget(:name, :age)).to eq(["Bob", "21"])
+    end
+  end
+
+  describe "#hincrby" do
+    it "increments value by integer at field" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:age, 21)
+
+      hash_map.hincrby(:age, 2)
+      expect(hash_map.hget(:age)).to eq("23")
+    end
+
+    it "increments value by 1" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:age, 21)
+
+      hash_map.hincrby(:age)
+      expect(hash_map.hget(:age)).to eq("22")
+    end
+  end
+
+  describe "#hdecrby" do
+    it "decrements value by integer at field" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:age, 21)
+
+      hash_map.hdecrby(:age, 2)
+      expect(hash_map.hget(:age)).to eq("19")
+    end
+  end
+
+  describe "#hexists" do
+    it "returns true if the field exists in redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+
+      expect(hash_map.hexists(:name)).to be(true)
+    end
+
+    it "returns false if the field doesn't exist in redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+
+      expect(hash_map.hexists(:name)).to be(false)
+    end
+  end
+
+  describe "#hkeys" do
+    it "returns all keys in a hash" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+      hash_map.hset(:age, 21)
+
+      expect(hash_map.hkeys).to match_array(["name", "age"])
+    end
+  end
+
+  describe "#clear" do
+    it "deletes the hash from redis" do
+      hash_map = Norton::Objects::HashMap.new("users:99:profile")
+      hash_map.hset(:name, "Bob")
+
+      hash_map.clear
+      expect(Norton.redis.with { |conn| conn.exists(hash_map.key) }).to eq(false)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: norton
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Larry Zhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -180,13 +180,17 @@ files:
 - Rakefile
 - lib/norton.rb
 - lib/norton/counter.rb
+- lib/norton/hash.rb
 - lib/norton/helper.rb
+- lib/norton/objects/hash_map.rb
 - lib/norton/timed_value.rb
 - lib/norton/timestamp.rb
 - lib/norton/version.rb
 - norton.gemspec
 - spec/norton/counter_spec.rb
+- spec/norton/hash_spec.rb
 - spec/norton/helper_spec.rb
+- spec/norton/objects/hash_map_spec.rb
 - spec/norton/timestamp_spec.rb
 - spec/norton_spec.rb
 - spec/spec_helper.rb
@@ -217,7 +221,9 @@ summary: Provide simple helpers on persist values in redis for performance. Work
   with ActiveRecord.
 test_files:
 - spec/norton/counter_spec.rb
+- spec/norton/hash_spec.rb
 - spec/norton/helper_spec.rb
+- spec/norton/objects/hash_map_spec.rb
 - spec/norton/timestamp_spec.rb
 - spec/norton_spec.rb
 - spec/spec_helper.rb