redispot 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12690e01651c34511666f3c387adb439ab9a94b4
+  data.tar.gz: 95aefdff7ef71d1a1aa328551682713c39866f89
+SHA512:
+  metadata.gz: bc071d7b16ee721be78b43524041abeb1b3a39e8a5869d0d36abfc3553bcba00a99f8ec164b457a4fbda11fe3fe6e5caa45434590c3ade05847adf61605f931a
+  data.tar.gz: 6a3c599ef734e319b635b5d1dd772c5e1b2e3bc486bf7f825036d8d7f820169ec3cb8d49e8aa711888fb574738e03ba9c570e04d516d3440e806237c4e8b67a0

data/.gitignore

@@ -0,0 +1,7 @@
+/.bundle/
+/.yardoc/
+/Gemfile.lock
+/doc/
+/pkg/
+/vendor/
+*.sw[a-z]

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.6
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in test-redis_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 hatyuki
+
+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,104 @@
+# Redispot
+[![Gem Version](https://badge.fury.io/rb/redispot.svg)](http://badge.fury.io/rb/redispot)
+[![Build Status](https://travis-ci.org/hatyuki/redispot-rb.svg?branch=master)](https://travis-ci.org/hatyuki/redispot-rb)
+[![Code Climate](https://codeclimate.com/github/hatyuki/redispot-rb/badges/gpa.svg)](https://codeclimate.com/github/hatyuki/redispot-rb)
+
+Launching the redis-server instance which is available only within a block.
+It is useful when you want to test your code.
+It is a Ruby clone of [Test::RedisServer](https://github.com/typester/Test-RedisServer).
+
+
+## Synopsis
+```ruby
+require 'redis'
+require 'redispot'
+
+Redispot::Server.new do |connect_info|
+  redis = Redis.new(connect_info)
+  redis.ping  # => "PONG"
+end
+```
+
+
+## Methods
+### Redispot::Server.new(options)
+Create a new instance, and start redis-server if block given.
+
+```ruby
+redis_server = Redispot::Server.new(options)
+
+# or
+
+Redispot::Server.new(options) do |connect_info|
+  redis = Redis.new(connect_info)
+  # ...
+end
+```
+
+Available options are:
+
+- [Hash] config
+
+    This is a `redis.conf` key value pair. You can use any key-value pair(s) that redis-server supports.
+
+    If you want to use this redis.conf:
+
+    ```
+    port 9999
+    databases 16
+    save 900 1
+    ```
+
+    Your conf parameter will be:
+
+    ```ruby
+    Redispot::Server.new(config: {
+        port:      9999,
+        databases: 16,
+        save:      '900 1',
+    })
+    ```
+
+- [Fixnum] timeout (Default: 3)
+
+    Timeout seconds for detecting if redis-server is awake or not.
+
+- [String] tmpdir
+
+    Temporal directory, where redis config will be stored.
+
+
+### Redispot::Server#start
+Start redis-server instance manually.
+
+```ruby
+server = Redispot::Server.new
+server.start do |connect_info|
+  redis = Redis.new(connect_info)
+  redis.ping  # => "PONG"
+end
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redispot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redispot
+
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/hatyuki/redispot-rb.
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'redispot'
+
+# 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.
+
+require 'pry'
+Pry.start

data/bin/setup

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

data/lib/redispot/server.rb

@@ -0,0 +1,170 @@
+require 'fileutils'
+require 'timeout'
+require 'tmpdir'
+
+module Redispot
+  class Server
+
+    # Destractor
+    #
+    # @private
+    def self.destroy (pid, owner_pid, timeout)
+      Proc.new do
+        return if pid.nil? || owner_pid != Process.pid
+
+        signals = [:TERM, :INT, :KILL]
+
+        begin
+          Process.kill(signals.shift, pid)
+          Timeout.timeout(timeout) { Process.waitpid(pid) }
+        rescue Timeout::Error
+          retry
+        end
+      end
+    end
+
+    # Create a new instance, and start redis-server if block given.
+    #
+    # @example
+    #   Redispot::Server.new do |connect_info|
+    #     redis = Redis.new(connect_info)
+    #     assert_equal('PONG', redis.ping)
+    #   end
+    #
+    # @param config [Hash] This is a `redis.conf` key value pair. You can use any key-value pair(s) that redis-server supports.
+    # @param timeout [Fixnum] Timeout seconds for detecting if redis-server is awake or not.
+    # @param tmpdir [String] Temporal directory, where redis config will be stored.
+    # @yield [connect_info] Connection info for client library to connect this redis-server instance.
+    # @yieldparam connect_info [String] This parameter is designed to pass directly to Redis module.
+    def initialize (config: { }, timeout: 3, tmpdir: nil, &block)
+      @executable = 'redis-server'
+      @owner_pid  = Process.pid
+      @pid        = nil
+      @workdir    = nil
+      @config     = config
+      @timeout    = timeout
+      @tmpdir     = tmpdir.nil? ? nil : File.expand_path(tmpdir)
+
+      if @config[:loglevel].to_s == 'warning'
+        $stderr.puts 'Redispot::Server does not support "loglevel warning", using "notice" instead.'
+        @config[:loglevel] = 'notice'
+      end
+
+      start(&block) if block
+    end
+
+    # Start redis-server instance within a given block.
+    #
+    # @example
+    #   redis_server = Redispot::Server.new
+    #   redis_server.start do |connect_info|
+    #     redis = Redis.new(connect_info)
+    #     assert_equal('PONG', redis.ping)
+    #   end
+    #
+    # @yield [connect_info] Connection info for client library to connect this redis-server instance.
+    # @yieldparam connect_info [Hash] This parameter is designed to pass directly to Redis module.
+    def start
+      Dir.mktmpdir(nil, @tmpdir) do |workdir|
+        @workdir = workdir
+        yield start_redis_server
+        stop
+      end
+    end
+
+    private
+    def start_redis_server
+      @pid = fork_process
+
+      Timeout.timeout(@timeout) do
+        loop do
+          if !Process.waitpid(@pid, Process::WNOHANG).nil?
+            @pid = nil
+            raise RuntimeError, "failed to launch redis-server\n#{File.read(logfile)}"
+          else
+            if File.read(logfile) =~ /The server is now ready to accept connections/
+              ObjectSpace.define_finalizer(self, proc { stop })
+              return connect_info
+            end
+          end
+
+          sleep 0.1
+        end
+      end
+    rescue Timeout::Error
+      stop if @pid
+      raise RuntimeError, "failed to launch redis-server\n#{File.read(logfile)}"
+    end
+
+    def fork_process
+      File.open(logfile, 'w') do |fh|
+        Process.fork do
+          begin
+            exec @executable, config_file, out: fh, err: fh
+          rescue => error
+            $stderr.puts "exec failed: #{error}"
+            exit error.errno
+          end
+        end
+      end
+    end
+
+    def connect_info
+      return unless @pid
+
+      host = config[:bind].nil? ? '0.0.0.0' : config[:bind]
+      port = config[:port]
+
+      if port.is_a?(Fixnum) && port > 0
+        { url: "redis://#{host}:#{port}/" }
+      else
+        { path: config[:unixsocket] }
+      end
+    end
+
+    def stop
+      return if @pid.nil? || @owner_pid != Process.pid
+
+      signals = [:TERM, :INT, :KILL]
+
+      begin
+        Process.kill(signals.shift, @pid)
+        Timeout.timeout(@timeout) { Process.waitpid(@pid) }
+      rescue Timeout::Error
+        retry
+      end
+
+      @pid     = nil
+      @workdir = nil
+
+      ObjectSpace.undefine_finalizer(self)
+    end
+
+    def logfile
+      "#{@workdir}/redis.log"
+    end
+
+    def config_file
+      config_string = config.inject('') do |memo, (key, value)|
+        next if value.to_s.empty?
+        memo += "#{key} #{value}\n"
+      end
+
+      "#{@workdir}/redis.conf".tap do |config_path|
+        File.write(config_path, config_string)
+      end
+    end
+
+    def config
+      default_config.merge(@config)
+    end
+
+    def default_config
+      {
+        unixsocket: "#{@workdir}/redis.sock",
+        dir:        "#{@workdir}/"
+      }
+    end
+
+  end
+end

data/lib/redispot/version.rb

@@ -0,0 +1,3 @@
+module Redispot
+  VERSION = '0.1.1'
+end

data/lib/redispot.rb

@@ -0,0 +1,2 @@
+require 'redispot/server'
+require 'redispot/version.rb'

data/redispot.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redispot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redispot'
+  spec.version       = Redispot::VERSION
+  spec.authors       = ['hatyuki']
+  spec.email         = ['hatyuki29@gmail.com']
+  spec.summary       = 'Launching the redis-server instance which is available only within a block.'
+  spec.description   = 'Launching the redis-server instance which is available only within a block.'
+  spec.homepage      = 'https://github.com/hatyuki/redispot-rb'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'redis'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'yard'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: redispot
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- hatyuki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: pry
+  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: redis
+  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: test-unit
+  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: 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'
+description: Launching the redis-server instance which is available only within a
+  block.
+email:
+- hatyuki29@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redispot.rb
+- lib/redispot/server.rb
+- lib/redispot/version.rb
+- redispot.gemspec
+homepage: https://github.com/hatyuki/redispot-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Launching the redis-server instance which is available only within a block.
+test_files: []
+has_rdoc: