hash_store 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac95003b61d541bf721bc6bb6c118de0f56a0ea7
-  data.tar.gz: bc63c6e292764a7d95efed92e2d5d4e2d3c4d8ae
+  metadata.gz: d20653833590acd7440f21df77f05a4534c37989
+  data.tar.gz: bb346d67ded438d67c61977136aa8f2ab85dbcf4
 SHA512:
-  metadata.gz: 256273408ebee938bd6d4714b2ab9597af758c22b389b9ffcaa9d01aa1d08d239deca0b35f0bd38b57573fc24ad8e36521f26e1cd2ada5dbcc16e37cd4de6e32
-  data.tar.gz: 7e3fa18a5b7c7f9bc24902cdee9cfa8ab487c6696bd00e678888f6aad2d130de27c74d086c3c4c608932269b59e1c6c7429e030b66d9d738f6845501a41ae802
+  metadata.gz: 396256c0ff8ffb3aae139e0087a251abfea1bb796667894ccc2c056e1ea170de4d02e8551f0358912d328200be4bad3f5ed22b1e2c6284b46f34879a3023b5a0
+  data.tar.gz: a83cec0b8eb9fb016e76b251747a13b72717d0c4f13856366900f9d37fd26b46bb1d5ce75d0b3f8eb62079feb71b41e494ebd357b81501693be3ed552dfaaba6

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.ruby-version
 Gemfile.lock
 InstalledFiles
 _yardoc

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,9 +1,18 @@
 # HashStore
 
+[![Gem Version](https://badge.fury.io/rb/hash_store.png)](http://badge.fury.io/rb/hash_store)
+[![Build Status](https://travis-ci.org/curi1119/hash_store.png?branch=master)](https://travis-ci.org/curi1119/hash_store)
+[![Coverage Status](https://coveralls.io/repos/curi1119/hash_store/badge.png)](https://coveralls.io/r/curi1119/hash_store)
+[![Code Climate](https://codeclimate.com/github/curi1119/hash_store.png)](https://codeclimate.com/github/curi1119/hash_store)
+[![Dependency Status](https://gemnasium.com/curi1119/hash_store.png)](https://gemnasium.com/curi1119/hash_store)
+
 HashStore store RubyHash into Redis as JSON.
-Automatically add redis commands(GET,SET,DEL,EXITS) methods to your class.
+
+Automatically add redis command(GET,SET,DEL,EXITS) methods to your class.
 HashStore was designed to work with ActiveRecord, but also work with Non-ActiveRecord Class.
 
+-
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,22 +53,38 @@ class User < ActiveRecord::Base
              key: ->(model){ "hoge:#{model.id}" },
              hash: ->(model){ {id: model.id, name: model.name } }
 ```
+see more detail
+[schema](https://github.com/curi1119/hash_store/blob/master/spec/db/schema.rb)
+[model](https://github.com/curi1119/hash_store/blob/master/spec/support/models.rb)
+[sample data](https://github.com/curi1119/hash_store/blob/master/spec/factories/models.rb)
 
-User instance will gain theses methods:
-
-#### hash_store
-
+#### Default Behavior
+```ruby
+  hash_store
+```
+This is default behavior.
+Redis key will be "{table_name}:#{record id}" .
+Hash will contain all columns except created_at, updated_at.
 ```
 User#hash_store_key   # => "users:1"
 User#set_hash!        # => SET command for this instance.
 User#get_hash         # => GET command for this instance.
                            nil if key not found.
                            return hash(like {"address"=>"Nagoya, Japan", "first_name"=>"Hoge", "id"=>7, "last_name"=>"Foo"})
+User#get_hash(json: true)  # => If you pass {json: true}, get_hash don't convert json to hash.
+                                Its return json string("{\"address\":\"Nagoya, Japan\",\"first_name\":\"Hoge\",\"id\":8,\"last_name\":\"Foo\"}")
 User#del_hash!        # => DEL command for this instance.
 User#exists_hash?     # => true if key present on redis, false otherwise.
+
+User.hash_store_key       # => returns key proc object.
+User.get_hash("users:1")  # => returns same hash as User#get_hash
 ```
 
-#### hash_store :address
+#### Customize Hash
+```ruby
+   hash_store :address, hash: ->(model){ {address: model.address} }
+```
+You can customize hash.
 ```
 User#hash_store_key_address   # => "users:address:8"
 User#set_hash_address!
@@ -68,9 +93,18 @@ User#get_hash_address         # => GET command for this instance.
                                    return hash(like {"address"=>"Nagoya, Japan"}
 User#del_hash_address!
 User#exists_hash_address?
+
+User.hash_store_key_address
+User.get_hash_address("users:address:8")  # => returns same hash as User#get_hash_address
+
 ```
 
-#### hash_store :for_name
+#### Customize Key and Hash
+```ruby
+hash_store :for_name,  key: ->(model){ "hoge:#{model.id}" },  hash: ->(model){ {id: model.id, name: model.name } }`
+```
+
+And you can specify key for redis.
 ```
 User#hash_store_key_for_name   # => "hoge:10"
 User#set_hash_for_name!
@@ -79,6 +113,9 @@ User#get_hash_for_name         # => GET command for this instance.
                                     return hash(like {"id"=>16, "name"=>"Hoge Foo"})
 User#del_hash_for_name!
 User#exists_hash_for_name?
+
+User.hash_store_key_for_name
+User.get_hash_for_name("hoge:10")  # => returns same hash as User#get_hash_for_name
 ```
 
 
@@ -95,3 +132,5 @@ class Player
              hash: ->(ins){ {name: ins.name} }
 ```
 (same as above)
+
+But, you must pass name, options(:key and :hash) arguments to hash_store.

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task default: :spec
+task test: :spec

data/hash_store.gemspec

@@ -36,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'factory_girl'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'coveralls'
 end

data/lib/hash_store/base.rb

@@ -9,14 +9,14 @@ module HashStore::Base
           raise unless options[:key].present?
         rescue => e
           print  <<-EOS
-When using hash_store on Non-ActiveRecord class, you MUST pass name and options arguments.
+When using hash_store on Non-ActiveRecord class, you MUST pass name and options(:key and :hash) arguments.
 ex.) hash_store :name, key: ->(ins){ "name_of_key:\#{ins.id}"}, hash: ->(ins){ {address: ins.address} }
 EOS
           return
         end
       end
 
-      method_suffix = name.nil? ? '' : "_#{name}"
+      method_suffix = (name.nil? || name == '') ? '' : "_#{name}"
 
       if options[:hash].present?
         hs_hash_proc = options[:hash]
@@ -38,10 +38,8 @@ EOS
           hs_redis.set(hs_key_proc.call(self), json)
         end
 
-        define_method "get_hash#{method_suffix}" do
-          json = hs_redis.get(hs_key_proc.call(self))
-          return nil if json.nil?
-          MultiJson.decode(json)
+        define_method "get_hash#{method_suffix}" do |options=nil|
+          self.class.send("get_hash#{method_suffix}", hs_key_proc.call(self), options)
         end
 
         define_method "del_hash#{method_suffix}!" do
@@ -60,8 +58,19 @@ EOS
           HashStore::Config.redis
         end
         private :hs_redis
+
+        define_singleton_method "get_hash#{method_suffix}" do |key, options=nil|
+          json = HashStore::Config.redis.get(key)
+          return nil if json.nil?
+          return json if options.present? && options[:json]
+          MultiJson.decode(json)
+        end
+
+        define_singleton_method "hash_store_key#{method_suffix}" do
+          hs_key_proc
+        end
       end
-    end
 
+    end
   end
 end

data/lib/hash_store/version.rb

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
 
 module HashStore
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/hash_store/base_spec.rb

@@ -3,9 +3,23 @@ require 'spec_helper'
 
 describe HashStore::Base do
 
+
   context "hash_store on User Model without options" do
     let!(:user){ create(:user) }
 
+    context "class methods on User" do
+      it{ User.hash_store_key.should be_instance_of(Proc) }
+
+      describe ".get_hash" do
+        it { User.get_hash("users:#{user.id}").should be_nil }
+
+        context "After SET" do
+          before { user.set_hash! }
+          it{ User.get_hash("users:#{user.id}").should == user.as_json(root: false, except: [:created_at, :updated_at]) }
+        end
+      end
+    end
+
     it { user.hash_store_key.should == "users:#{user.id}" }
 
     describe "#set_hash!" do
@@ -21,6 +35,7 @@ describe HashStore::Base do
       context "After SET" do
         before { user.set_hash! }
         it{ user.get_hash.should == user.as_json(root: false, except: [:created_at, :updated_at]) }
+        it{ user.get_hash(json: true).should == user.to_json(root: false, except: [:created_at, :updated_at]) }
       end
     end
 
@@ -45,6 +60,19 @@ describe HashStore::Base do
   context "hash_store on User Model with options" do
     let!(:user){ create(:user) }
 
+    context "class methods on User" do
+      it{ User.hash_store_key_for_name.should be_instance_of(Proc) }
+
+      describe ".get_hash_for_name" do
+        it { User.get_hash_for_name("hoge:#{user.id}").should be_nil }
+
+        context "After SET" do
+          before { user.set_hash_for_name! }
+          it{ User.get_hash_for_name("hoge:#{user.id}").should == user.as_json(root: false, only:[:id, ], methods: ["name"]) }
+        end
+      end
+    end
+
     it { user.hash_store_key_for_name.should == "hoge:#{user.id}" }
 
     describe "#set_hash_for_name!" do
@@ -115,6 +143,7 @@ describe HashStore::Base do
       }
       it { player.hash_store_key_for_name.should == 'player:Curi:1' }
     end
-
   end
+
+
 end

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
 # -*- coding: utf-8 -*-
+require 'coveralls'
 require 'pry'
 require 'factory_girl'
 require 'active_record'
 require 'mock_redis'
 require 'hash_store'
+Coveralls.wear!
 
 ActiveRecord::Base.configurations = YAML::load(ERB.new(IO.read(File.dirname(__FILE__) + "/db/database.yml")).result)
 ActiveRecord::Base.establish_connection("sqlite3")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_store
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - M.Iwasaki(Curi)
@@ -164,6 +164,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |2
       HashStore store RubyHash into Redis as JSON.
       Automatically add redis commands(GET,SET,DEL,EXITS) methods to your class.
@@ -176,6 +190,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt