mobb-redis 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f2f43a7fcf210c2fa427c84058f219cbc99c096d2d6a2a64e3ff91186f80edf
+  data.tar.gz: 58c8d4645b09b32ac82055d55ef6fe995b2717dd75d6a8b5875f961efd976e9b
+SHA512:
+  metadata.gz: 97444f8f70b6bde96675251e394d070de0375f5f26e6fbd951572a84ac04e5dab2b518dfe13c4571ebd884cb1c54fdc209db10a347b09242fdb0a5fb0c20d997
+  data.tar.gz: efbb8a0c40125080ebfd07d17dc9b21e2a567d8574d7ffdee43c689fa7223b74ad80cdbe481be241b08bce6d506bbf2c4d1aa9f98f00e0c2e9cb92945010cf40

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.gem
+tmp/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+script: 'bundle exec rake'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+redis-sinatra 1.4.1 (2017-12-15)
+--------------------------------------------------------------------------------
+
+*   Remove Travis builds for Ruby 1.9 on jruby and rbx
+    Felipe Batista
+
+*   Remove dependency to Sinatra
+
+    let users require Sinatra the way it fits to their project
+    Felipe Batista
+
+*   Loosen gem dependencies
+    Tom Scott
+
+*   Initial implementation
+    Luca Guidi

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 - 2011 Luca Guidi
+
+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,47 @@
+# Redis stores for Mobb
+
+__`mobb-redis`__ provides a Redis backed cache store for __Mobb__. See the main [redis-store readme](https://github.com/redis-store/redis-store) for general guidelines.
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'mobb-redis'
+```
+
+## Usage
+
+```ruby
+require 'mobb'
+require 'mobb-redis'
+
+class MyApp < Mobb::Base
+  register Mobb::Cache
+
+  on 'hi' do
+    settings.cache.fetch('greet') { 'Hello, World!' }
+  end
+end
+```
+
+Keep in mind that the above fetch will return `"OK"` on success, not the return of the block.
+
+## Running tests
+
+```ruby
+gem install bundler
+git clone https://github.com/kinoppyd/mobb-redis
+cd mobb-redis
+bundle install
+bundle exec rake
+```
+
+If you are on **Snow Leopard** you have to run `env ARCHFLAGS="-arch x86_64" bundle exec rake`
+
+## Copyright
+
+Original
+2009 - 2013 Luca Guidi - [http://lucaguidi.com](http://lucaguidi.com), released under the MIT license]
+
+Modify
+kinoppyd

data/Rakefile

@@ -0,0 +1,45 @@
+require 'bundler/setup'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'redis-store/testing/tasks'
+require 'mobb-redis/version'
+require 'date'
+
+desc 'Generate the changelog based on git history'
+task :changelog, :from, :to do |_t, args|
+
+  #from = args[:from] || `git describe --tags --abbrev=0`.strip
+  #to = args[:to] || 'HEAD'
+  log = `git log 586af720daf323efeee358267752c9098c1fb407..HEAD --pretty=format:'%an|%B___'`
+
+  puts "mobb-redis #{Mobb::Redis::VERSION} (#{Date.today})"
+  puts '-' * 80
+  puts
+
+  log.split(/___/).each do |commit|
+    pieces = commit.split('|').reverse
+    author = pieces.pop.strip
+    message = pieces.join.strip
+
+    next if message =~ /^\s*Merge pull request/
+    next if message =~ /No changelog/
+    next if message =~ /^\s*Merge branch/
+
+    first_line = false
+
+    message.each_line do |line|
+      if !first_line
+        first_line = true
+        puts "*   #{line}"
+      elsif line.strip.empty?
+        puts
+      else
+        puts "    #{line}"
+      end
+    end
+
+    puts "    #{author}"
+    puts
+  end
+end
+

data/lib/mobb-redis.rb

@@ -0,0 +1,9 @@
+require 'redis-store'
+require 'mobb-redis/version'
+require 'mobb/cache/redis_store'
+
+module Mobb
+  module Redis
+    # Your code goes here...
+  end
+end

data/lib/mobb-redis/version.rb

@@ -0,0 +1,5 @@
+module Mobb
+  module Redis
+    VERSION = '1.0.0'
+  end
+end

data/lib/mobb/cache/redis_store.rb

@@ -0,0 +1,131 @@
+module Mobb
+  module Cache
+    class << self
+      def register(app)
+        app.set :cache, RedisStore.new
+      end
+      alias_method :registered, :register
+    end
+
+    class RedisStore
+      # Instantiate the store.
+      #
+      # Example:
+      #   RedisStore.new
+      #     # => host: localhost,   port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com"
+      #     # => host: example.com, port: 6379,  db: 0
+      #
+      #   RedisStore.new "example.com:23682"
+      #     # => host: example.com, port: 23682, db: 0
+      #
+      #   RedisStore.new "example.com:23682/1"
+      #     # => host: example.com, port: 23682, db: 1
+      #
+      #   RedisStore.new "example.com:23682/1/theplaylist"
+      #     # => host: example.com, port: 23682, db: 1, namespace: theplaylist
+      #
+      #   RedisStore.new "localhost:6379/0", "localhost:6380/0"
+      #     # => instantiate a cluster
+      def initialize(*addresses)
+        @data = ::Redis::Store::Factory.create addresses
+      end
+
+      def write(key, value, options = nil)
+        if options && options[:unless_exist]
+          @data.setnx key, value, options
+        else
+          @data.set key, value, options
+        end
+      end
+
+      def read(key, options = nil)
+        @data.get(key, options)
+      end
+
+      def delete(key, options = nil)
+        @data.del key
+      end
+
+      def exist?(key, options = nil)
+        @data.exists key
+      end
+
+      # Increment a key in the store.
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.increment "counter"
+      #   cache.read "counter", :raw => true      # => "24"
+      #
+      #   cache.increment "counter", 6
+      #   cache.read "counter", :raw => true      # => "30"
+      #
+      #   cache.increment "a counter"
+      #   cache.read "a counter", :raw => true    # => "1"
+      #
+      #   cache.increment "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "1"
+      def increment(key, amount = 1)
+        @data.incrby key, amount
+      end
+
+      # Decrement a key in the store
+      #
+      # If the key doesn't exist it will be initialized on 0.
+      # If the key exist but it isn't a Fixnum it will be initialized on 0.
+      #
+      # Example:
+      #   We have two objects in cache:
+      #     counter # => 23
+      #     rabbit  # => #<Rabbit:0x5eee6c>
+      #
+      #   cache.decrement "counter"
+      #   cache.read "counter", :raw => true      # => "22"
+      #
+      #   cache.decrement "counter", 2
+      #   cache.read "counter", :raw => true      # => "20"
+      #
+      #   cache.decrement "a counter"
+      #   cache.read "a counter", :raw => true    # => "-1"
+      #
+      #   cache.decrement "rabbit"
+      #   cache.read "rabbit", :raw => true       # => "-1"
+      def decrement(key, amount = 1)
+        @data.decrby key, amount
+      end
+
+      # Delete objects for matched keys.
+      #
+      # Example:
+      #   cache.del_matched "rab*"
+      def delete_matched(matcher, options = nil)
+        @data.keys(matcher).each { |key| @data.del key }
+      end
+
+      def fetch(key, options = {})
+        (!options[:force] && data = read(key, options)) || block_given? && begin
+          data = yield
+          write(key, data, options)
+        end
+        data || nil
+      end
+
+      # Clear all the data from the store.
+      def clear
+        @data.flushdb
+      end
+
+      def stats
+        @data.info
+      end
+    end
+  end
+end

data/mobb-redis.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'mobb-redis/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'mobb-redis'
+  s.version     = Mobb::Redis::VERSION
+  s.authors     = ['kinoppyd', 'Luca Guidi']
+  s.email       = ['whoisdissolvedgirl+github@gmail.com']
+  s.homepage    = 'https://github.com/kinoppyd/mobb-redis'
+  s.summary     = %q{Redis store for Mobb}
+  s.description = %q{Redis store for Mobb}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'redis-store', '>= 1.1', '< 2'
+  s.add_dependency 'mobb', '>= 0'
+
+  s.add_development_dependency 'rake',     '~> 10'
+  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'mocha',    '~> 0.14.0'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'redis-store-testing'
+end

data/test/sinatra/cache/redis_store_test.rb

@@ -0,0 +1,166 @@
+require 'test_helper'
+
+class App
+  def initialize
+    @values = {}
+  end
+
+  def set(key, value)
+    @values[key] = value
+  end
+
+  def get(key)
+    @values[key]
+  end
+end
+
+describe Mobb::Cache::RedisStore do
+  before do
+    @store  = Mobb::Cache::RedisStore.new
+    @dstore = Mobb::Cache::RedisStore.new "redis://127.0.0.1:6380/1", "redis://127.0.0.1:6381/1"
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    with_store_management do |store|
+      store.write  "rabbit", @rabbit
+      store.delete "counter"
+      store.delete "rub-a-dub"
+    end
+  end
+
+  it "should register as extension" do
+    app = App.new
+    Mobb::Cache.register(app)
+    store = app.get(:cache)
+    store.must_be_kind_of(Mobb::Cache::RedisStore)
+  end
+
+  it "should read the data" do
+    with_store_management do |store|
+      store.read("rabbit").must_equal(@rabbit)
+    end
+  end
+
+  it "should write the data" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit
+      store.read("rabbit").must_equal(@white_rabbit)
+    end
+  end
+
+  it "should write the data with expiration time" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit, :expires_in => 1 # second
+      # store.read("rabbit").must_equal(@white_rabbit)
+      sleep 2
+      store.read("rabbit").must_be_nil
+    end
+  end
+
+  it "should not write data if :unless_exist option is true" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit, :unless_exist => true
+      store.read("rabbit").must_equal(@rabbit)
+    end
+  end
+
+  it "should read raw data" do
+    with_store_management do |store|
+      store.read("rabbit", :raw => true).must_equal(Marshal.dump(@rabbit))
+    end
+  end
+
+  it "should write raw data" do
+    with_store_management do |store|
+      store.write "rabbit", @white_rabbit, :raw => true
+      store.read("rabbit", :raw => true).must_equal(%(#<OpenStruct color="white">))
+    end
+  end
+
+  it "should delete data" do
+    with_store_management do |store|
+      store.delete "rabbit"
+      store.read("rabbit").must_be_nil
+    end
+  end
+
+  it "should delete matched data" do
+    with_store_management do |store|
+      store.delete_matched "rabb*"
+      store.read("rabbit").must_be_nil
+    end
+  end
+
+  it "should verify existence of an object in the store" do
+    with_store_management do |store|
+      assert store.exist?("rabbit")
+      assert ! store.exist?("rab-a-dub")
+    end
+  end
+
+  it "should increment a key" do
+    with_store_management do |store|
+      3.times { store.increment "counter" }
+      store.read("counter", :raw => true).to_i.must_equal(3)
+    end
+  end
+
+  it "should decrement a key" do
+    with_store_management do |store|
+      3.times { store.increment "counter" }
+      2.times { store.decrement "counter" }
+      store.read("counter", :raw => true).to_i.must_equal(1)
+    end
+  end
+
+  it "should increment a key by given value" do
+    with_store_management do |store|
+      store.increment "counter", 3
+      store.read("counter", :raw => true).to_i.must_equal(3)
+    end
+  end
+
+  it "should decrement a key by given value" do
+    with_store_management do |store|
+      3.times { store.increment "counter" }
+      store.decrement "counter", 2
+      store.read("counter", :raw => true).to_i.must_equal(1)
+    end
+  end
+
+  it "should clear the store" do
+    with_store_management do |store|
+      store.clear
+      store.instance_variable_get(:@data).keys("*").flatten.must_be :empty?
+    end
+  end
+
+  it "should return store stats" do
+    with_store_management do |store|
+      store.stats.wont_be :empty?
+    end
+  end
+
+  it "should fetch data" do
+    with_store_management do |store|
+      store.fetch("rabbit").must_equal(@rabbit)
+      store.fetch("rub-a-dub").must_be_nil
+      store.fetch("rub-a-dub") { "Flora de Cana" }.must_equal("Flora de Cana")
+      store.fetch("rub-a-dub").must_equal("Flora de Cana")
+      store.fetch("rabbit", :force => true).must_be_nil # force cache miss
+      store.fetch("rabbit", :force => true, :expires_in => 1) { @white_rabbit }
+      # store.fetch("rabbit").must_equal(@white_rabbit)
+      sleep 2
+      store.fetch("rabbit").must_be_nil
+    end
+  end
+
+  private
+    def instantiate_store(addresses = nil)
+      Mobb::Cache::RedisStore.new(addresses).instance_variable_get(:@data)
+    end
+
+    def with_store_management
+      yield @store
+      yield @dstore
+    end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'mobb-redis'

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: mobb-redis
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- kinoppyd
+- Luca Guidi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: mobb
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: redis-store-testing
+  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: Redis store for Mobb
+email:
+- whoisdissolvedgirl+github@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mobb-redis.rb
+- lib/mobb-redis/version.rb
+- lib/mobb/cache/redis_store.rb
+- mobb-redis.gemspec
+- test/sinatra/cache/redis_store_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kinoppyd/mobb-redis
+licenses:
+- MIT
+metadata: {}
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Redis store for Mobb
+test_files:
+- test/sinatra/cache/redis_store_test.rb
+- test/test_helper.rb