redis-helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f8a91bd9c3a1637aeb3459abfa889f481fc8a57
+  data.tar.gz: 5bcb97d1fa9b302f3eb34eb6163ea8db5c63a22d
+SHA512:
+  metadata.gz: 420927ee72553a458e32c89da390f9814cd3c46b47da61c84eb8061ec242dde87dad555b0cf1caa0e7b0aa74351372582b28badc7f5095ec7125fdf323b0aa06
+  data.tar.gz: da61908ece984ba363d22f54309d43f87a5feab499e6b73a9c65704e41f45fc81f6845d79e29186d49aacb50574c6631ea1e15bf7337e46f2243a50981f4dc92

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  onkcop:
+    - "config/rubocop.yml"
+    # uncomment if use rails cops
+    # - "config/rails.yml"
+    # uncomment if use rspec cops
+    # - "config/rspec.yml"
+
+AllCops:
+  TargetRubyVersion: 2.4

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis-helper.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Narazaka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Redis::Helper
+
+Redisを扱うクラスで利用するモジュール
+
+Redis::Objectsがmulti使えないとかアレっていう [@i2bskn](https://github.com/i2bskn) さん等の想いのカケラ。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "redis-helper"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis-helper
+
+## Usage
+
+```ruby
+class Foo < ActiveRecord::Base
+  include Redis::Helper
+
+  def bar_count
+    # attr_key(:bar_count) => "Foo:<id>:bar_count"
+    redis.get(attr_key(:bar_count)).to_i
+  end
+
+  def update_bar_count(count)
+    # ttl_to(self.end_at) => self.end_at - Time.current
+    redis.setex(attr_key(:bar_count), ttl_to(self.end_at), count)
+  end
+end
+
+foo = Foo.find(id)
+foo.update_bar_count(10)
+foo.bar_count => 10
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Narazaka/redis-helper/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+require "yard/rake/yardoc_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new
+YARD::Rake::YardocTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "redis/helper"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/redis/helper.rb

@@ -0,0 +1,92 @@
+require "redis"
+require "active_support"
+require "active_support/core_ext/object/blank"
+require "active_support/core_ext/numeric/time"
+require "redis/helper/version"
+
+# Redisを扱うクラスで利用するモジュール
+#
+# @example
+#   class Foo < ActiveRecord::Base
+#     include Redis::Helper
+#
+#     def bar_count
+#       # attr_key(:bar_count) => "Foo:<id>:bar_count"
+#       redis.get(attr_key(:bar_count)).to_i
+#     end
+#
+#     def update_bar_count(count)
+#       # ttl_to(self.end_at) => self.end_at - Time.current
+#       redis.setex(attr_key(:bar_count), ttl_to(self.end_at), count)
+#     end
+#   end
+#
+#   foo = Foo.find(id)
+#   foo.update_bar_count(10)
+#   foo.bar_count => 10
+#
+class Redis
+  module Helper
+    # 正しくない固有キー(固有キー値が空?)
+    class UnknownUniqueValue < StandardError; end
+
+    # デフォルトの固有キー名
+    DEFAULT_UNIQUE_ATTR_NAME = :id
+    # redisキーの区切り文字
+    REDIS_KEY_DELIMITER = ":".freeze
+
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    # クラスメソッド
+    module ClassMethods
+      # Redis.currentへのショートカット
+      def redis
+        @redis ||= ::Redis.current
+      end
+    end
+
+    # instance固有のkeyとattr_nameからkeyを生成する
+    # (instanceに複数のkeyを設定したい場合やkeyにattr_nameを含めたい場合に使用する)
+    # @param [String|Symbol] name キー名
+    # @param [String|Symbol] unique_attr インスタンスの固有キーとして使用するメソッド名
+    # @return [String]
+    def attr_key(name, unique_attr = nil)
+      [instance_key(unique_attr), name].join(REDIS_KEY_DELIMITER)
+    end
+
+    # instance固有のkeyを生成する ("<Class Name>:<unique key>")
+    # @param [String|Symbol] unique_attr インスタンスの固有キーとして使用するメソッド名
+    # @return [String]
+    def instance_key(unique_attr = nil)
+      attr_name = unique_attr || DEFAULT_UNIQUE_ATTR_NAME
+      if (unique_key = self.public_send(attr_name)).blank?
+        raise UnknownUniqueValue, "unique keyとして指定された値(#{attr_name})が取得できません"
+      end
+      [self.class.name, unique_key].join(REDIS_KEY_DELIMITER)
+    end
+
+    # 引数で指定した時間にexpireするためのttl値を生成
+    # @example
+    #   # 2016/10/26 正午にexpireする
+    #   redis.setex(key, ttl_to(Time.zone.parse("2016-10-26 12:00:00")), value)
+    #   # 24時間後にexpireする
+    #   redis.setex(key, ttl_to(1.day.since), value)
+    # @param [Time] to_time expireする時間
+    # @param [Time] from_time 現在時間
+    # @param [Boolean] unsigned_non_zero 計算結果のttlが0の場合1を返す
+    # @return [Integer]
+    def ttl_to(to_time, from_time = Time.current, unsigned_non_zero: true)
+      ttl = (to_time - from_time).to_i
+      return ttl if ttl > 0
+      unsigned_non_zero ? 1 : ttl
+    end
+
+    # Redis.currentへのショートカット
+    # @return [Redis]
+    def redis
+      self.class.redis
+    end
+  end
+end

data/lib/redis/helper/version.rb

@@ -0,0 +1,6 @@
+class Redis
+  module Helper
+    # バージョン
+    VERSION = "1.0.0".freeze
+  end
+end

data/redis-helper.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis/helper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis-helper"
+  spec.version       = Redis::Helper::VERSION
+  spec.authors       = ["Narazaka"]
+  spec.email         = ["info@narazaka.net"]
+
+  spec.summary       = "helper module for models using Redis"
+  spec.homepage      = "https://github.com/Narazaka/redis-helper"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["yard.run"] = "yri"
+  end
+
+  spec.add_dependency "redis"
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "onkcop"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: redis-helper
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: onkcop
+  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: 
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis/helper.rb
+- lib/redis/helper/version.rb
+- redis-helper.gemspec
+homepage: https://github.com/Narazaka/redis-helper
+licenses:
+- MIT
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: helper module for models using Redis
+test_files: []