redis-spawn 0.0.3 → 0.0.4

data/README.md

@@ -161,13 +161,49 @@ At present, there is no built in mechanism for cleaning up the data directory
 This allows you to prevent the server from automatically being started, e.g.
 
 ```ruby
-    # Don't want to start striaght away
-    my_server = Redis::SpawnServer(:start => false)
+    # Don't want to start straight away
+    my_server = Redis::SpawnServer.new(:start => false)
     # ...
     # Now we're ready to start
     my_server.start
 ```
 
+### Extensions to redis-rb
+
+Three new methods are defined in the Redis class: Redis.spawn,
+Redis.spawn_and_connect, and Redis#spawned_server_instance. Redis.spawn is
+simply a convenience wrapper for Redis::SpawnServer.new:
+
+```ruby
+    my_server = Redis.spawn(opts)
+```
+
+is the same as the slightly more verbose:
+
+```ruby
+    my_server = Redis::SpawnServer.new(opts)
+```
+
+Redis.spawn_and_connect spawns a new server and returns a connection to it:
+
+```ruby
+    spawned_connection = Redis.spawn_and_connect
+    => #<Redis:0x00000002d5e470>
+```
+
+The method takes the same option parameters as Redis::SpawnServer.new.  One
+question you might ask is since you're returned a Redis instance, what
+happens to the Redis:SpawnServer instance?  The answer is that it is stored
+in the Redis instance, and you can get it through the
+Redis#spawned_server_instance accessor:
+
+```ruby
+    spawned_connection.spawned_server_instance
+    => #<Redis::SpawnServer:0x00000002683290>
+    spawned_connection.spawned_server_instance.pid
+    => 10633
+````
+
 Contact and Contributing
 ------------------------
 

data/lib/redis/spawn/version.rb

@@ -1,5 +1,5 @@
 class Redis
   class SpawnServer
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/redis/spawn.rb

@@ -125,10 +125,12 @@ class Redis
       self.pid
     end
     
+    # Check whether the server is stated by checking if a value is assigned to @pid
     def started?
       self.pid ? true : false
     end
     
+    # Shutdown the spawned redis-server if it is running
     def shutdown
       if self.started?
         self.shutdown!
@@ -137,6 +139,7 @@ class Redis
       end
     end
     
+    # Forcibly shutdown the spawned redis-server. Used internally by #shutdown.
     def shutdown!
       Process.kill("TERM", self.pid)
     rescue Errno::ESRCH
@@ -205,9 +208,42 @@ class Redis
       end
     end
 
+    # Shortcut for getting name of the configured unix socket file
     def socket
       self.server_opts[:unixsocket]
     end
 
   end
+  
+  # Convenience wrapper for Redis::SpawnServer.new
+  #
+  # @param supplied_opts: options for this server including any configuration overrides
+  #
+  # @return [Redis::SpawnServer] instance corresponding to the spawned server
+  def self.spawn(supplied_opts = {})
+    SpawnServer.new(supplied_opts)
+  end
+  
+  # Spawn a new redis-server with supplied options and connect to it. Has the
+  # side-effect of setting instance variable @_redis_spawnserver_instance with
+  # the spawned server instance
+  #
+  # @param supplied_opts: options for this server including any configuration overrides
+  #
+  # @return [Redis] a redis-rb connection to the newly spawned redis-server
+  def self.spawn_and_connect(supplied_opts = {})
+    redis_spawnserver_instance = SpawnServer.new(supplied_opts)
+    redis_instance = self.connect(:path => redis_spawnserver_instance.socket)
+    redis_instance.instance_variable_set(:@_redis_spawnserver_instance, redis_spawnserver_instance)
+    redis_instance
+  end
+  
+  # Accessor for the spawned server instance created by Redis.spawn_and_connect
+  def spawned_server_instance
+    if self.instance_variables.include?(:@_redis_spawnserver_instance)
+      @_redis_spawnserver_instance
+    else
+      nil
+    end
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Phil Stewart
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-29 00:00:00 +01:00
+date: 2011-11-08 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency