ssdb-attr 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 42862ff9c47b1a76de97dad8d083f9f600f59899
-  data.tar.gz: 29d3a85d0b87e99d2b392d571a705c8c0bf31b9b
+  metadata.gz: 3d0a8577ee7cc342983ced7c743a36fb4bf06a99
+  data.tar.gz: c202f59301160470540f18f6fd8bfb7a6c346d97
 SHA512:
-  metadata.gz: 015184c70c5f94521c89f9e25f7a6d3c1d4c695b96ffbc70d239b8a706ccd87b968cf7f0240af359066eed9c86983fae5d5c3db20c7f6a0b8d86e605cf3bea65
-  data.tar.gz: bcf2ca89d68a6fe73ff897b8300e825ac2de3973c08a85a270e64a89ea8d22239304167004ce0398a3471d6a014df15bc3f96056641cf4abccc97a113fcd73e2
+  metadata.gz: 0ab615231b7df6dc1bc6e9a9db48c1120150636c474961ba9d0653c7634e4bbe9580cf360fa4951d9f8257ab7f48b7ff98fee9f19b3c4478275ecb9cfe294110
+  data.tar.gz: 18e23b76f1d825bc3dd5bfb26be2756c976d06f58e31aaade8bb89393d6dbcd29c2380c2dca7dd3d13abac32352179813e3f3846fb36acda64daf1eab2ab14f9

data/README.md

@@ -6,6 +6,10 @@ This gem provides an intuitive interface to define attributes on your ActiveMode
 
 # Changelog
 
+### 0.1.4
+
+- Add `SSDBAttr.load_attrs(objects, *fields)` to load multiple attrs for multiple same objects at one time.
+
 ### 0.1.3
 
 - Add `load_ssdb_attrs` to get multiple values from SSDB once to avoid multiple SSDB calls.

data/lib/ssdb-attr.rb

@@ -93,5 +93,44 @@ module SSDBAttr
       end
     end
 
+    #
+    # 获取多个 AR 对象的多个 SSDB 字段
+    #
+    # 例如:
+    #
+    # notes = Note.where("<some where>").limit(15)
+    # SSDBAttr.load_attrs(notes, :public_title, :public_content)
+    #
+    # @param [Array] objects
+    # @param [Array] fields
+    #
+    # @return [ActiveRecord::Relation|Array]
+    #
+    def load_attrs(objects, *fields)
+      fields.map!(&:to_s)
+
+      keys = objects.flat_map do |object|
+        fields.map { |name| object.ssdb_attr_key(name) }
+      end
+      values = SSDBAttr.pool.with { |conn| conn.mget(keys) }
+      key_values = keys.zip(values).to_h
+
+      objects.each do |object|
+        fields.each do |name|
+          next unless object.class.ssdb_attr_names.include?(name.to_s)
+
+          value =
+            if (raw_value = key_values[object.ssdb_attr_key(name)]).present?
+              object.typecaster(raw_value, object.class.ssdb_attr_definition[name])
+            else
+              object.public_send("#{name}_default_value")
+            end
+
+          object.instance_variable_set("@#{name}", value)
+        end
+      end
+
+      objects
+    end
   end
 end

data/lib/ssdb-attr/version.rb

@@ -1,3 +1,3 @@
 module SSDBAttr
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/ssdb/attr.rb

@@ -69,6 +69,10 @@ module SSDB
           instance_variable_set("@#{name}", val)
         end
 
+        define_method("#{name}_default_value") do
+          typecaster(options[:default], type)
+        end
+
         define_method("#{name}_was")          { attribute_was(name) }
 
         define_method("#{name}_change")       { attribute_change(name) }
@@ -113,16 +117,15 @@ module SSDB
       end
     end
 
-    private
-
     #
-    # Return the ConnectionPool used by current Class.
+    # Return the SSDB key for a attribute
     #
+    # @param [String] name Attribute name.
     #
-    # @return [ConnectionPool]
+    # @return [String]
     #
-    def ssdb_attr_pool
-      SSDBAttr.pool(self.class.ssdb_attr_pool_name)
+    def ssdb_attr_key(name)
+      "#{self.class.name.tableize}:#{ssdb_attr_id}:#{name}"
     end
 
     #
@@ -142,20 +145,20 @@ module SSDB
       end
     end
 
-    def ssdb_attr_id
-      send(self.class.ssdb_attr_id_field || :id)
-    end
-
+    private
 
     #
-    # Return the SSDB key for a attribute
+    # Return the ConnectionPool used by current Class.
     #
-    # @param [String] name Attribute name.
     #
-    # @return [String]
+    # @return [ConnectionPool]
     #
-    def ssdb_attr_key(name)
-      "#{self.class.name.tableize}:#{ssdb_attr_id}:#{name}"
+    def ssdb_attr_pool
+      SSDBAttr.pool(self.class.ssdb_attr_pool_name)
+    end
+
+    def ssdb_attr_id
+      send(self.class.ssdb_attr_id_field || :id)
     end
 
     #

data/spec/spec_helper.rb

@@ -6,6 +6,24 @@ require "ssdb-attr"
 ActiveRecord::Base.raise_in_transactional_callbacks = true if ActiveRecord::VERSION::STRING >= "4.2"
 ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
 
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.before(:all) do
+    # Connect to test SSDB server
+    SSDBAttr.setup(:url => "redis://localhost:8888")
+
+    # Clean up SSDB
+    system('printf "7\nflushdb\n\n4\nping\n\n" | nc 127.0.0.1 8888 -i 1 > /dev/null')
+
+    ActiveRecord::Base.connection.tables.each do |table|
+      ActiveRecord::Base.connection.execute "DELETE FROM #{table}"
+    end
+  end
+end
+
 # Setup tables for test
 tbls = [
   { "posts" => "updated_at DATETIME, saved_at DATETIME, changed_at DATETIME" },
@@ -18,3 +36,40 @@ tbls.each do |tbl|
     ActiveRecord::Base.connection.execute "CREATE TABLE #{tbl_name} (id INTEGER NOT NULL PRIMARY KEY, #{sql})"
   end
 end
+
+# ActiveRecord definition
+class Post < ActiveRecord::Base
+  include SSDB::Attr
+
+  ssdb_attr :name, :string
+  ssdb_attr :int_version, :integer
+  ssdb_attr :default_title, :string, default: "Untitled"
+  ssdb_attr :title, :string
+  ssdb_attr :content, :string
+  ssdb_attr :version, :integer, default: 1
+  ssdb_attr :default_version, :integer, :default => 100
+  ssdb_attr :field_with_validation, :string
+
+  validate :validate_field
+
+  def validate_field
+    if field_with_validation == "foobar"
+      errors.add(:field_with_validation, "foobar error")
+    end
+  end
+end
+
+class CustomIdField < ActiveRecord::Base
+  include SSDB::Attr
+
+  ssdb_attr_id :uuid
+  ssdb_attr :content, :string
+end
+
+class CustomPoolName < ActiveRecord::Base
+  include SSDB::Attr
+
+  ssdb_attr_pool :foo_pool
+
+  ssdb_attr :foo_id, :integer
+end

data/spec/ssdb-attr_spec.rb

@@ -1,5 +1,4 @@
-# require 'spec_helper'
-require "ssdb-attr"
+require "spec_helper"
 
 describe SSDBAttr do
 
@@ -128,4 +127,64 @@ describe SSDBAttr do
       end
     end
   end
+
+  describe ".load_attrs" do
+    it "returns the values correctly" do
+      post1 = Post.create(:name => "lol", :version => 2)
+      post2 = Post.create(:name => "dota", :version => 3)
+
+      posts = Post.where(:id => [post1.id, post2.id])
+
+      posts.each do |post|
+        expect(post.instance_variable_get(:@name)).to be(nil)
+        expect(post.instance_variable_get(:@version)).to be(nil)
+      end
+
+      SSDBAttr.load_attrs(posts, :name, :version)
+
+      expect(posts[0].instance_variable_get(:@name)).to eq("lol")
+      expect(posts[0].instance_variable_get(:@version)).to eq(2)
+
+      expect(posts[1].instance_variable_get(:@name)).to eq("dota")
+      expect(posts[1].instance_variable_get(:@version)).to eq(3)
+    end
+
+    it "returns default value correctly if no value in ssdb" do
+      post1 = Post.create(:name => "lol")
+      post2 = Post.create(:name => "dota")
+
+      posts = Post.where(:id => [post1.id, post2.id])
+
+      posts.each do |post|
+        expect(post.instance_variable_get(:@name)).to be(nil)
+        expect(post.instance_variable_get(:@version)).to be(nil)
+      end
+
+      SSDBAttr.load_attrs(posts, :name, :version)
+
+      expect(posts[0].instance_variable_get(:@name)).to eq("lol")
+      expect(posts[0].instance_variable_get(:@version)).to eq(1)
+
+      expect(posts[1].instance_variable_get(:@name)).to eq("dota")
+      expect(posts[1].instance_variable_get(:@version)).to eq(1)
+    end
+
+    it "doesn't define instance variables for undefined ssdb atts" do
+      post1 = Post.create(:name => "lol")
+      post2 = Post.create(:name => "dota")
+
+      posts = Post.where(:id => [post1.id, post2.id])
+
+      posts.each do |post|
+        expect(post.instance_variable_get(:@name)).to be(nil)
+        expect(post.instance_variable_get(:@version)).to be(nil)
+      end
+
+      SSDBAttr.load_attrs(posts, :undefined_field)
+
+      posts.each do |post|
+        expect(post.instance_variable_defined?(:@undefined_field)).to be(false)
+      end
+    end
+  end
 end

data/spec/ssdb/attr_spec.rb

@@ -1,55 +1,6 @@
 require "spec_helper"
 
-class Post < ActiveRecord::Base
-  include SSDB::Attr
-
-  ssdb_attr :name, :string
-  ssdb_attr :int_version, :integer
-  ssdb_attr :default_title, :string, default: "Untitled"
-  ssdb_attr :title, :string
-  ssdb_attr :content, :string
-  ssdb_attr :version, :integer, default: 1
-  ssdb_attr :default_version, :integer, :default => 100
-  ssdb_attr :field_with_validation, :string
-
-  validate :validate_field
-
-  def validate_field
-    if field_with_validation == "foobar"
-      errors.add(:field_with_validation, "foobar error")
-    end
-  end
-end
-
-class CustomIdField < ActiveRecord::Base
-  include SSDB::Attr
-
-  ssdb_attr_id :uuid
-  ssdb_attr :content, :string
-end
-
-class CustomPoolName < ActiveRecord::Base
-  include SSDB::Attr
-
-  ssdb_attr_pool :foo_pool
-
-  ssdb_attr :foo_id, :integer
-end
-
 describe SSDB::Attr do
-
-  before(:all) do
-    # Connect to test SSDB server
-    SSDBAttr.setup(:url => "redis://localhost:8888")
-
-    # Clean up SSDB
-    system('printf "7\nflushdb\n\n4\nping\n\n" | nc 127.0.0.1 8888 -i 1 > /dev/null')
-
-    ActiveRecord::Base.connection.tables.each do |table|
-      ActiveRecord::Base.connection.execute "DELETE FROM #{table}"
-    end
-  end
-
   context "Post" do
     let(:post) { Post.create(updated_at: 1.day.ago, saved_at: 1.day.ago, changed_at: 1.day.ago) }
     let(:redis) { Redis.new(:url => 'redis://localhost:8888') }
@@ -72,6 +23,7 @@ describe SSDB::Attr do
     it "should respond to methods" do
       expect(post.respond_to?(:name)).to be true
       expect(post.respond_to?(:name=)).to be true
+      expect(post.respond_to?(:name_default_value)).to be true
       expect(post.respond_to?(:name_was)).to be true
       expect(post.respond_to?(:name_change)).to be true
       expect(post.respond_to?(:name_changed?)).to be true
@@ -101,6 +53,16 @@ describe SSDB::Attr do
       end
     end
 
+    describe "#attirbute_default_value" do
+      it "returns correct default value" do
+        post.default_title = "changed"
+        post.default_version = 99
+
+        expect(post.default_title_default_value).to eq("Untitled")
+        expect(post.default_version_default_value).to eq(100)
+      end
+    end
+
     describe "#reload_ssdb_attrs" do
       it "should reload attribute values from SSDB" do
         post = Post.create(title: "foobar", version: 4)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssdb-attr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Larry Zhao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-29 00:00:00.000000000 Z
+date: 2017-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis