redispot 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12690e01651c34511666f3c387adb439ab9a94b4
-  data.tar.gz: 95aefdff7ef71d1a1aa328551682713c39866f89
+  metadata.gz: 2ab5ec4bc687538bb74c69596ff14e72f99c6332
+  data.tar.gz: 67b3382aa1d1f44b5c124a3809ea81dcbea49e96
 SHA512:
-  metadata.gz: bc071d7b16ee721be78b43524041abeb1b3a39e8a5869d0d36abfc3553bcba00a99f8ec164b457a4fbda11fe3fe6e5caa45434590c3ade05847adf61605f931a
-  data.tar.gz: 6a3c599ef734e319b635b5d1dd772c5e1b2e3bc486bf7f825036d8d7f820169ec3cb8d49e8aa711888fb574738e03ba9c570e04d516d3440e806237c4e8b67a0
+  metadata.gz: 605045c45c3c2478589896f31c169e03c6c96261e12cacc34fa4d160a043622b4f7881ebf0de2b544c86bf87e5d77860fd7f943a72f1cb67e503193be22035e7
+  data.tar.gz: 2c4be779c3fbe2916c0098963ce6cb49ac63323a4a056d030c706f922cab0b180bfbbef56f2c2c79b1d5b47b04861cd36498f2db128e9926eb24b62ce0e4e654

data/.envrc

@@ -0,0 +1,4 @@
+layout ruby
+export CODECLIMATE_REPO_TOKEN="2193dedb73f3070a2fd119a2c577d97ad00de8becc5147c188f6f4428fe2e94b"
+
+# vim: ft=sh

data/.gitignore

@@ -1,6 +1,8 @@
 /.bundle/
+/.direnv/
 /.yardoc/
 /Gemfile.lock
+/coverage/
 /doc/
 /pkg/
 /vendor/

data/.travis.yml

@@ -3,3 +3,6 @@ rvm:
   - 2.1.6
   - 2.2.2
 before_install: gem install bundler -v 1.10.5
+addons:
+  code_climate:
+    repo_token: 2193dedb73f3070a2fd119a2c577d97ad00de8becc5147c188f6f4428fe2e94b

data/README.md

@@ -2,9 +2,11 @@
 [![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)
+[![Test Coverage](https://codeclimate.com/github/hatyuki/redispot-rb/badges/coverage.svg)](https://codeclimate.com/github/hatyuki/redispot-rb/coverage)
 
-Launching the redis-server instance which is available only within a block.
+Launching the redis-server instance which is available only within a scope.
 It is useful when you want to test your code.
+
 It is a Ruby clone of [Test::RedisServer](https://github.com/typester/Test-RedisServer).
 
 
@@ -13,10 +15,22 @@ It is a Ruby clone of [Test::RedisServer](https://github.com/typester/Test-Redis
 require 'redis'
 require 'redispot'
 
+# Using redis-server instance within a block
+redis = nil
 Redispot::Server.new do |connect_info|
   redis = Redis.new(connect_info)
   redis.ping  # => "PONG"
 end
+
+redis.ping  # => Error!
+
+# or start it manually
+
+redispot = Redispot::Server.new
+redis    = Redis.new(redispot.start)
+redis.ping  # => "PONG"
+redispot.stop
+redis.ping  # => Error!
 ```
 
 
@@ -25,7 +39,7 @@ end
 Create a new instance, and start redis-server if block given.
 
 ```ruby
-redis_server = Redispot::Server.new(options)
+redispot = Redispot::Server.new(options)
 
 # or
 
@@ -72,11 +86,35 @@ Available options are:
 Start redis-server instance manually.
 
 ```ruby
-server = Redispot::Server.new
-server.start do |connect_info|
+redispot = Redispot::Server.new
+
+redispot.start do |connect_info|
   redis = Redis.new(connect_info)
   redis.ping  # => "PONG"
 end
+
+# or
+
+redis = Redis.new(redispot.start)
+# ... do anything
+redispot.stop
+```
+
+
+### Redispot::Server#stop
+Stop redis-server instance.
+
+This method is automatically called from object destructor.
+
+
+### Redispot::Server#connect_info
+Return connection info for client library to connect this redis-server instance.
+
+This parameter is designed to pass directly to Redis module.
+
+```ruby
+redispot = Redispot::Server.new
+redis    = Redis.new(redispot.connect_info)
 ```
 
 

data/lib/redispot/refinements.rb

@@ -0,0 +1,25 @@
+module Redispot
+  module Refinements
+    refine Object do
+      def blank?
+        respond_to?(:empty?) ? !!empty? : !self
+      end
+
+      def present?
+        !blank?
+      end
+
+      def presence
+        self if present?
+      end
+    end
+
+    refine Hash do
+      def symbolize_keys
+        each_key.each_with_object(Hash.new) do |key, memo|
+          memo[key.to_sym] = fetch(key)
+        end
+      end
+    end
+  end
+end

data/lib/redispot/server.rb

@@ -1,27 +1,8 @@
-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
+    using Refinements
 
     # Create a new instance, and start redis-server if block given.
     #
@@ -40,10 +21,18 @@ module Redispot
       @executable = 'redis-server'
       @owner_pid  = Process.pid
       @pid        = nil
-      @workdir    = nil
-      @config     = config
+      @config     = config.symbolize_keys
       @timeout    = timeout
-      @tmpdir     = tmpdir.nil? ? nil : File.expand_path(tmpdir)
+      @workdir    = WorkingDirectory.new(tmpdir)
+
+      if @config[:port].nil? && @config[:unixsocket].nil?
+        @config[:unixsocket] = "#{@workdir}/redis.sock"
+        @config[:port]       = 0
+      end
+
+      if @config[:dir].nil?
+        @config[:dir] = @workdir
+      end
 
       if @config[:loglevel].to_s == 'warning'
         $stderr.puts 'Redispot::Server does not support "loglevel warning", using "notice" instead.'
@@ -53,117 +42,152 @@ module Redispot
       start(&block) if block
     end
 
-    # Start redis-server instance within a given block.
+    # Start redis-server instance manually.
+    # If block given, the redis instance is available only within a block.
+    # Users must call Redispot::Server#stop they have called Redispot::Server#start without block.
     #
     # @example
-    #   redis_server = Redispot::Server.new
-    #   redis_server.start do |connect_info|
+    #   redispot.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.
+    #   # or
+    #
+    #   connect_info = redispot.start
+    #
+    # @overload start { ... }
+    #   @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.
+    # @overload start
+    #   @return 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
+      return if @pid
+      start_process
+
+      if block_given?
+        yield connect_info
         stop
+      else
+        connect_info
       end
     end
 
-    private
-    def start_redis_server
-      @pid = fork_process
+    # Stop redis-server.
+    # This method is automatically called from object destructor.
+    #
+    def stop
+      return unless @pid
 
-      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
+      signals = [:TERM, :INT, :KILL]
 
-          sleep 0.1
-        end
+      begin
+        Process.kill(signals.shift, @pid)
+        Timeout.timeout(@timeout) { Process.waitpid(@pid) }
+      rescue Timeout::Error => error
+        retry unless signals.empty?
+        raise error
       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
+      @pid = nil
+
+      ObjectSpace.undefine_finalizer(self)
     end
 
+    # Return connection info for client library to connect this redis-server instance.
+    #
+    # @example
+    #   redispot = Redispot::Server.new
+    #   redis    = Redis.new(redispot.connect_info)
+    #
+    # @return [String] This parameter is designed to pass directly to Redis module.
     def connect_info
-      return unless @pid
-
-      host = config[:bind].nil? ? '0.0.0.0' : config[:bind]
-      port = config[:port]
+      host = @config[:bind].presence || '0.0.0.0'
+      port = @config[:port]
 
       if port.is_a?(Fixnum) && port > 0
         { url: "redis://#{host}:#{port}/" }
       else
-        { path: config[:unixsocket] }
+        { path: @config[:unixsocket] }
       end
     end
 
-    def stop
-      return if @pid.nil? || @owner_pid != Process.pid
-
-      signals = [:TERM, :INT, :KILL]
+    private
+    #
+    def start_process
+      logfile = "#{@workdir}/redis-server.log"
 
-      begin
-        Process.kill(signals.shift, @pid)
-        Timeout.timeout(@timeout) { Process.waitpid(@pid) }
-      rescue Timeout::Error
-        retry
-      end
+      execute_redis_server(logfile)
+      wait_redis_server(logfile)
+      ObjectSpace.define_finalizer(self, Killer.new(@pid, @timeout))
+    end
 
-      @pid     = nil
-      @workdir = nil
+    #
+    # @param logfile [Pathname]
+    def execute_redis_server (logfile)
+      File.open(logfile, 'a') do |fh|
+        @pid = Process.fork do
+          configfile = "#{@workdir}/redis.conf"
+          File.write(configfile, config_string)
 
-      ObjectSpace.undefine_finalizer(self)
+          begin
+            Kernel.exec(@executable, configfile, out: fh, err: fh)
+          rescue SystemCallError => error
+            $stderr.puts "exec failed: #{error}"
+            exit error.errno
+          end
+        end
+      end
+    rescue SystemCallError => error
+      $stderr.puts "failed to create log file: #{error}"
     end
 
-    def logfile
-      "#{@workdir}/redis.log"
+    #
+    # @param logfile [Pathname]
+    def wait_redis_server (logfile)
+      Timeout.timeout(@timeout) do
+        while Process.waitpid(@pid, Process::WNOHANG).nil?
+          return if File.read(logfile) =~ /the server is now ready to accept connections/i
+          sleep 0.1
+        end
+
+        @pid = nil
+        raise Timeout::Error
+      end
+    rescue Timeout::Error
+      raise RuntimeError, "failed to launch redis-server\n#{File.read(logfile)}"
     end
 
-    def config_file
-      config_string = config.inject('') do |memo, (key, value)|
+    #
+    # @return [String]
+    def config_string
+      @config.each_with_object(String.new) do |(key, value), memo|
         next if value.to_s.empty?
-        memo += "#{key} #{value}\n"
+        memo << "#{key} #{value}\n"
       end
+    end
 
-      "#{@workdir}/redis.conf".tap do |config_path|
-        File.write(config_path, config_string)
+
+    class Killer  # :nodoc
+      def initialize (redis_pid, timeout = 3)
+        @owner_pid = Process.pid
+        @redis_pid = redis_pid
+        @timeout   = timeout
       end
-    end
 
-    def config
-      default_config.merge(@config)
-    end
+      def call (*args)
+        return if @owner_pid != Process.pid
+
+        signals = [:TERM, :INT, :KILL]
 
-    def default_config
-      {
-        unixsocket: "#{@workdir}/redis.sock",
-        dir:        "#{@workdir}/"
-      }
+        begin
+          Process.kill(signals.shift, pid)
+          Timeout.timeout(timeout) { Process.waitpid(pid) }
+        rescue Timeout::Error => error
+          retry unless signals.empty?
+          raise error
+        end
+      end
     end
 
   end

data/lib/redispot/version.rb

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

data/lib/redispot/working_directory.rb

@@ -0,0 +1,43 @@
+require 'fileutils'
+require 'tmpdir'
+
+module Redispot
+  class WorkingDirectory
+
+    # Create a temporary directory
+    #
+    # @param basedir [String]
+    def initialize (basedir = nil)
+      @directory = File.expand_path(Dir.mktmpdir(nil, basedir))
+      ObjectSpace.define_finalizer(self, Remover.new(@directory))
+    end
+
+    # Delete the temporary directory
+    #
+    def delete
+      FileUtils.remove_entry_secure(@directory)
+      ObjectSpace.undefine_finalizer(self)
+    rescue Errno::ENOENT
+    end
+
+    # Returns path to the temporary directory
+    #
+    # @return [String]
+    def to_s
+      @directory
+    end
+
+    class Remover  # :nodoc
+      def initialize (directory)
+        @pid       = Process.pid
+        @directory = directory
+      end
+
+      def call (*args)
+        return if @pid != Process.pid
+        FileUtils.remove_entry_secure(@directory)
+      rescue Errno::ENOENT
+      end
+    end
+  end
+end

data/lib/redispot.rb

@@ -1,2 +1,4 @@
+require 'redispot/refinements'
 require 'redispot/server'
-require 'redispot/version.rb'
+require 'redispot/working_directory'
+require 'redispot/version'

data/redispot.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.1.0'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'redis'
   spec.add_development_dependency 'test-unit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redispot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - hatyuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-09 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +116,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -111,8 +126,10 @@ files:
 - bin/console
 - bin/setup
 - lib/redispot.rb
+- lib/redispot/refinements.rb
 - lib/redispot/server.rb
 - lib/redispot/version.rb
+- lib/redispot/working_directory.rb
 - redispot.gemspec
 homepage: https://github.com/hatyuki/redispot-rb
 licenses:
@@ -126,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="