redisk 0.1.0 → 0.2.0

data/.gitignore

@@ -20,4 +20,5 @@ pkg
 
 ## PROJECT::SPECIFIC
 dump.rdb
-redis-test.pid
+redis-test.pid
+tmp

data/HISTORY

@@ -0,0 +1,14 @@
+=== 0.2.0 [2009-12-22]
+
+* Almost complete support for both line and byte operations on Redisk::IO
+* New special extensions to the base IO class:
+  * .from_file and .to_file for writing/reading to disk
+  * .unlink for deleting contents
+  * .all lists the IO's created by Redisk::IO
+* New examples folder
+
+=== 0.1.0
+
+* Initial Release.
+  * Basic support for line operations in Redisk::IO
+  * Redisk::Logger

data/README.rdoc

@@ -41,6 +41,24 @@ By default, Redisk uses the Redis on localhost:6379, but you can change that by
 
     Redisk.redis = 'myhost:myport'
     
+Check out the small but growing list of examples in examples/
+
+== INSTALL (NOW!)
+    
+Proudly tested and working on Ruby 1.8.6, 1.8.7, and 1.9.1 
+    
+Gems are on gemcutter:
+
+    gem install redisk
+    
+Dependencies:
+
+    redis running somewhere
+    
+    gems:
+      redis
+      redis-namespace
+    
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/examples/rails.rb

@@ -0,0 +1,4 @@
+# You could put this in a Rails environment
+
+# Set the logger to log to redis and truncate it at 10,000 lines
+config.logger = Redisk::Logger.new("#{Rails.env}.log", :truncate => 10 * 1000)

data/examples/yajl.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'yajl'
+require 'redisk'
+
+hash = {'something' => 'for nothing', 'and_the_rest' => 'for free', 'i' => {'want' => {'my' => 'mtv'}}}
+
+io_name = 'test.json'
+Redisk::IO.unlink(io_name)
+
+puts 'The hash:'
+puts hash.inspect
+
+puts 'write the hash as json to redis'
+io = Redisk::IO.new(io_name)
+Yajl::Encoder.encode(hash, io)
+
+puts 'read it back out'
+io.rewind
+puts io.read.inspect
+
+io.rewind
+
+puts 'parse it back to ruby'
+puts Yajl::Parser.parse(io).inspect

data/lib/redisk/io.rb

@@ -6,16 +6,24 @@ module Redisk
     
     class NotImplementedError < RuntimeError; end
     class EOFError < ::EOFError; end
+    class IOError < ::IOError; end
     
     attr_reader :name, :mode, :_
   
-    def initialize(name, mode = 'rw')
-      @name   = name
-      @mode   = mode # we're going to just ignore this for now
-      @buffer = nil
-      @sync   = false
-      @size   = 0
-      @lineno = 0
+    def initialize(name, mode = 'r')
+      @name         = name
+      @mode         = mode # we're going to just ignore this for now
+      @read_open    = true
+      @write_open   = true
+      @write_buffer = nil
+      @read_buffer  = nil
+      @sync         = false
+      @pos          = 0
+      @lineno       = 0
+      @size         = stat.size > 0 ? stat.size : true_size
+      # add io to the list of ios
+      redis.sadd dir, name
+      rewind
     end
     alias :for_fd :initialize
 
@@ -26,7 +34,19 @@ module Redisk
     def list_key
       self.class.list_key(name)
     end
+    
+    def self.all
+      redis.smembers dir
+    end
   
+    def self.dir
+      "__ios__"
+    end
+    
+    def dir
+      self.class.dir
+    end
+    
     # Executes the block for every line in the named I/O port, where lines are 
     # separated by sep_string.
     # 
@@ -38,8 +58,9 @@ module Redisk
     #    GOT This is line three
     #    GOT And so on...
     def self.foreach(name, &block)
-      readlines(name).each(&block)
-      nil
+      io = new(name)
+      io.each_line(&block)
+      io.close
     end
   
     # With no associated block, open is a synonym for IO::new. If the optional 
@@ -48,7 +69,9 @@ module Redisk
     # instance, IO::open returns the value of the block.
     def self.open(name, mode = 'r')
       io = new(name, mode)
-      block_given? ? yield(io) : io
+      returned = block_given? ? yield(io) : io
+      io.close
+      returned
     end
   
     # IO.pipe → array
@@ -92,12 +115,21 @@ module Redisk
     #    IO.read("testfile", 20)       #=> "This is line one\nThi"
     #    IO.read("testfile", 20, 10)   #=> "ne one\nThis is line "
     def self.read(name, length = nil, offset = nil)
+      io = new(name)
+      io.seek(offset) if offset
+      returned = io.read(length)
+      io.close
+      returned
+    end
+    
+    # Works similarly to IO.read, but operates on lines instead of bytes
+    def self.read_lines(name, length = nil, offset = nil)
       start_i = offset || 0
       end_i   = length ? start_i + (length - 1) : -1
       values  = redis.lrange(list_key(name), start_i, end_i)
-      values.join("\n")
+      values.join
     end
-  
+      
     # Reads the entire file specified by name as individual lines, and returns 
     # those lines in an array. Lines are separated by sep_string.
     # 
@@ -125,6 +157,31 @@ module Redisk
       raise NotImplementedError, ".sysopen is not implemented"
     end
   
+    # Removes all references to the io at name
+    def self.unlink(name)
+      redis.keys("#{name}:*").each do |key|
+        redis.del key.gsub('redisk:','')
+      end
+      redis.srem dir, name
+      nil
+    end
+
+    # Reads the contents of file into the IO. 
+    # If file is not a File its taken as a path and passed to File.open
+    def self.from_file(name, file)
+      io = new(name)
+      io.from_file(file)
+      io
+    end
+    
+    # Writes the contents of IO into file.
+    # If file is not a File its taken as a path and passed to File.open
+    def self.to_file(name, file)
+      io   = new(name)
+      io.to_file(file)
+      io
+    end
+
     # String Output—Writes obj to ios. obj will be converted to a string using 
     # to_s.
     # 
@@ -133,10 +190,10 @@ module Redisk
     # 
     #    Hello world!
     def <<(text)
-      @buffer ||= ''
-      @buffer << text
+      @write_buffer ||= ''
+      @write_buffer << text
       flush if sync
-      @buffer
+      @write_buffer
     end
     
     # ios.binmode => ios
@@ -154,7 +211,9 @@ module Redisk
     # 
     # If ios is opened by IO.popen, close sets $?.
     def close
-      
+      flush
+      close_read
+      close_write
     end 
     
     # ios.close_read => nil
@@ -170,7 +229,8 @@ module Redisk
     #    prog.rb:3:in `readlines': not opened for reading (IOError)
     #     from prog.rb:3
     def close_read
-      
+      @read_open = false
+      nil
     end
     
     # ios.close_write => nil
@@ -187,7 +247,8 @@ module Redisk
     #     from prog.rb:3:in `print'
     #     from prog.rb:3
     def close_write
-      
+      @write_open = false
+      nil
     end
 
     # ios.closed? => true or false
@@ -202,8 +263,8 @@ module Redisk
     #    f.closed?       #=> false
     #    f.close_read    #=> nil
     #    f.closed?       #=> true
-    def closed
-      
+    def closed?
+      !(@write_open || @read_open)
     end
     
     # ios.each(sep_string=$/) {|line| block } => ios
@@ -238,7 +299,11 @@ module Redisk
     #    f.each_byte {|x| checksum ^= x }   #=> #<File:testfile>
     #    checksum                           #=> 12
     def each_byte
-      
+      rewind
+      while !eof?
+        yield getc
+      end
+      self
     end
     
     # ios.eof => true or false
@@ -266,7 +331,7 @@ module Redisk
     # Note that IO#eof? reads data to a input buffer. So IO#sysread doesn‘t 
     # work with IO#eof?.
     def eof
-      lineno >= length
+      lineno >= length || pos >= size
     end
     alias :eof? :eof
     
@@ -302,13 +367,13 @@ module Redisk
     # 
     #    no newline
     def flush
-      if @buffer
-        redis.rpush list_key, @buffer 
-        @size += @buffer.length
+      if @write_buffer && @write_buffer != ''
+        redis.rpush list_key, @write_buffer
+        @size += @write_buffer.length
         stat.write_attribute(:size, @size)
         stat.write_attribute(:mtime, Time.now)
       end
-      @buffer = nil
+      @write_buffer = nil
     end
     
     # ios.fsync => 0 or nil
@@ -318,6 +383,31 @@ module Redisk
     # from Ruby‘s buffers, but doesn‘t not guarantee that the underlying 
     # operating system actually writes it to disk.
     def fsync
+      false
+    end
+    
+    # Reads the contents of file into the IO. 
+    # If file is not a File its taken as a path and passed to File.open
+    # Returns the IO
+    def from_file(file)
+      file = File.open(file, 'r') if !file.is_a?(File)
+      file.each_line do |l|
+        write l
+      end
+      file.close
+      self
+    end
+    
+    # Writes the contents of IO into file.
+    # If file is not a File its taken as a path and passed to File.open
+    # Returns the IO
+    def to_file(file)
+      file = File.open(file, 'w') if !file.is_a?(File)
+      each_line do |l|
+        file.write l
+      end
+      file.close
+      self
     end
     
     # ios.getc => fixnum or nil
@@ -328,6 +418,7 @@ module Redisk
     #    f.getc   #=> 84
     #    f.getc   #=> 104
     def getc
+      read(1).to_s.ord
     end
     
     # ios.gets(sep_string=$/) => string or nil
@@ -342,11 +433,14 @@ module Redisk
     #    File.new("testfile").gets   #=> "This is line one\n"
     #    $_                          #=> "This is line one\n"
     def gets
+      check_stream_open!(:read)
       flush
+      return nil if eof?
       val = redis.lrange(list_key, lineno, lineno + 1)
       if val = val.first
         self.lineno += 1
         $_ = @_ = val
+        @pos += val.length
         val
       end
     end
@@ -387,6 +481,10 @@ module Redisk
       @size
     end
     
+    def true_size
+      readlines.join.length
+    end
+    
     # ios.lineno => integer
     # Returns the current line number in ios. The stream must be opened for 
     # reading. lineno counts the number of times gets is called, rather than 
@@ -416,7 +514,15 @@ module Redisk
     #    f.gets                     #=> "This is line two\n"
     #    $. # lineno of last read   #=> 1001
     def lineno=(num)
-      @lineno = num
+      @lineno = num.to_i
+    end
+    
+    def open?(stream = nil)
+      if stream
+        instance_variable_get("@#{stream}_open")
+      else
+        @write_open && @read_open
+      end
     end
     
     # ios.pid => fixnum
@@ -434,7 +540,7 @@ module Redisk
     #    In child, pid is 26209
     #    In parent, child pid is 26209
     def pid
-      
+      Process.pid
     end
     
     # ios.pos => integer
@@ -446,7 +552,7 @@ module Redisk
     #    f.gets   #=> "This is line one\n"
     #    f.pos    #=> 17
     def pos
-      
+      @pos
     end
     alias :tell :pos
     
@@ -457,7 +563,13 @@ module Redisk
     #    f.pos = 17
     #    f.gets   #=> "This is line two\n"
     def pos=(num)
-      
+      current_pos = @pos
+      if num < current_pos
+        @pos = 0
+      else
+        num -= current_pos
+      end
+      read(num)
     end
       
     # ios.print() => nil
@@ -497,7 +609,7 @@ module Redisk
     # 
     #    AA
     def putc(obj)
-      
+      self << obj.is_a?(Fixnum) ? obj : obj.to_s[0]
     end
     
     # ios.puts(obj, ...) => nil
@@ -516,8 +628,11 @@ module Redisk
     #    test
     def puts(*args)
       args.empty? ? 
-        write('') :
-        args.each {|a| write(a) }
+        write("\n") :
+        args.each {|a| 
+          a += "\n" if a !~ /\n$/
+          write(a) 
+        }
       nil
     end
     
@@ -532,8 +647,30 @@ module Redisk
     # 
     #    f = File.new("testfile")
     #    f.read(16)   #=> "This is line one"
-    def read
-      
+    def read(length = nil, buffer = nil)
+      check_stream_open!(:read)
+      if eof
+        length ? nil : ""
+      else
+        if length 
+          @read_buffer ||= ""
+          fetched = false
+          while @read_buffer.length < length && !eof?
+            @read_buffer << gets.to_s
+            fetched = true
+          end
+          result = @read_buffer[0...length]
+          @read_buffer = @read_buffer[length..-1] || ""
+          if fetched
+            @pos -= @read_buffer.length 
+          else
+            @pos += result.length
+          end
+        else
+          result = readlines.join
+        end
+        buffer ? buffer.replace(buffer + result) : result
+      end
     end
     
     # ios.read_nonblock(maxlen) => string
@@ -566,7 +703,14 @@ module Redisk
     # read data is obtainable via its data method.
     # 
     def readbytes(n)
-      
+      result = read(n)
+      if result && result.length < n
+        raise TruncatedDataError, result
+      elsif result.nil?
+        raise EOFError, "You have reached the end of the IO stream"
+      else
+        result
+      end
     end
     
     # ios.readchar => fixnum
@@ -595,6 +739,7 @@ module Redisk
     #    f = File.new("testfile")
     #    f.readlines[0]   #=> "This is line one\n"
     def readlines
+      check_stream_open!(:read)
       self.class.readlines(name)
     end
     
@@ -678,6 +823,7 @@ module Redisk
     #    f.readline   #=> "This is line one\n"
     def rewind
       self.lineno = 0
+      self.pos    = 0
     end
     
     # scanf(str,&b)
@@ -727,6 +873,19 @@ module Redisk
     #    f.seek(-13, IO::SEEK_END)   #=> 0
     #    f.readline                  #=> "And so on...\n"
     def seek(offset, whence = SEEK_SET)
+      case whence
+      when SEEK_SET
+        self.pos = offset
+      when SEEK_END
+        self.pos = size + offset
+      when SEEK_CUR
+        self.pos += offset
+      end
+      0
+    end
+    
+    # works just like seek, but seeks by lineno instead of pos
+    def seek_lines(offset, whence = SEEK_SET)
       case whence
       when SEEK_SET
         self.lineno = offset
@@ -815,6 +974,7 @@ module Redisk
       else
         redis.ltrim list_key, -size, -1
       end
+      stat.write_attribute(:size, @size = true_size)
       length
     end
     
@@ -829,10 +989,20 @@ module Redisk
     #    c = f.getc                 #=> 84
     #    f.ungetc(c)                #=> nil
     #    f.getc                     #=> 84
-    def ungetc(int)
-      
+    def ungetc(integer)
+      check_stream_open!(:write)
+      char = ("" << integer)
+      self << char
+      nil
     end
     
+    # Removes all references to the IO and closes it for reading and writing
+    def unlink
+      close
+      self.class.unlink(name)
+    end
+    alias :delete :unlink
+    
     # ios.write(string) => integer
     # Writes the given string to ios. The stream must be opened for writing. 
     # If the argument is not a string, it will be converted to a string using 
@@ -845,8 +1015,9 @@ module Redisk
     #    This is a test
     #    That was 15 bytes of data
     def write(string)
+      check_stream_open!(:write)
       string = string.to_s
-      @buffer = string
+      self << string
       flush
       string.length
     end
@@ -863,5 +1034,10 @@ module Redisk
     def write_nonblock(string)
     end
     
+    private
+    def check_stream_open!(stream = :read)
+      raise(IOError, "#{self} is not open for #{stream}ing") unless open?(stream)
+    end
+    
   end
 end

data/lib/redisk.rb

@@ -6,7 +6,7 @@ require 'redisk/io'
 require 'redisk/logger'
 
 module Redisk
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
   
   extend self
   
@@ -33,5 +33,22 @@ module Redisk
     self.redis
   end
   
+  def io(*args)
+    Redisk::IO.new(*args)
+  end
+  
+  def logger(*args)
+    Redisk::Logger.new(*args)
+  end
+  
 end
 
+class String
+  
+  if !method_defined?(:ord)
+    def ord
+      self[0]
+    end
+  end
+  
+end

data/redisk.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{redisk}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Quint"]
-  s.date = %q{2009-12-17}
+  s.date = %q{2009-12-22}
   s.description = %q{Redisk includes Redisk::IO which is ~ Ruby's stdlib IO. It can be used with stdlib's Logger to log directly to redis}
   s.email = %q{aaron@quirkey.com}
   s.extra_rdoc_files = [
@@ -19,9 +19,12 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "HISTORY",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
+     "examples/rails.rb",
+     "examples/yajl.rb",
      "lib/redisk.rb",
      "lib/redisk/helper.rb",
      "lib/redisk/io.rb",
@@ -45,7 +48,9 @@ Gem::Specification.new do |s|
     "spec/redisk_io_spec.rb",
      "spec/redisk_logger_spec.rb",
      "spec/redisk_stat_spec.rb",
-     "spec/spec_helper.rb"
+     "spec/spec_helper.rb",
+     "examples/rails.rb",
+     "examples/yajl.rb"
   ]
 
   if s.respond_to? :specification_version then

data/spec/redisk_io_spec.rb

@@ -2,6 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Redisk::IO do
   before do
+    FileUtils.mkdir_p('tmp')
     # load a file into an IO object
     @io_name = 'rails.log'
     @key = Redisk::IO.list_key(@io_name)
@@ -14,7 +15,9 @@ describe Redisk::IO do
   end
 
   after do
-    Redisk.redis.del @key
+    Redisk.redis.keys(@key.gsub(':_list', '*')).each do |key|
+      Redisk.redis.del key.gsub('redisk:', '')
+    end
   end
 
   describe 'new' do    
@@ -29,6 +32,15 @@ describe Redisk::IO do
     it 'stores the name of the key' do
       @io.name.should == @io_name
     end
+    
+    it 'should be open' do
+      @io.closed?.should == false
+    end
+    
+    it 'should add to the list of ios' do
+      Redisk::IO.all.should include(@io_name)
+    end
+    
   end
 
   describe 'foreach' do
@@ -45,6 +57,45 @@ describe Redisk::IO do
 
   end
 
+  describe 'from_file' do
+    before(:each) do
+      Redisk::IO.unlink('dump_test.log')
+      File.open('tmp/dump_test.log', 'w+') {|f| f << "This is a file" } 
+    end
+    
+    it 'should write into io at name from file' do
+      @io = Redisk::IO.from_file('dump_test.log', 'tmp/dump_test.log')
+      @io.rewind
+      @io.gets.should == "This is a file"
+    end
+    
+    it 'should write into io at name from File' do
+      @io = Redisk::IO.from_file('dump_test.log', File.new('tmp/dump_test.log'))
+      @io.rewind
+      @io.gets.should == "This is a file"
+    end
+    
+  end
+  
+  describe 'to_file' do
+    before(:each) do
+      Redisk::IO.unlink('dump_test.log')
+      File.unlink('tmp/dump_test.log')
+      Redisk::IO.open('dump_test.log') {|io| io << 'This is an IO' }
+    end
+    
+    it 'should write into file from io' do
+      Redisk::IO.to_file('dump_test.log', 'tmp/dump_test.log')
+      File.read('tmp/dump_test.log').should == 'This is an IO'
+    end
+    
+    it 'should write into File from io' do
+      Redisk::IO.to_file('dump_test.log', File.open('tmp/dump_test.log', 'w'))
+      File.read('tmp/dump_test.log').should == 'This is an IO'
+    end
+    
+  end
+
   describe 'open' do
 
     it 'should return an IO object if no block is given' do
@@ -68,15 +119,32 @@ describe Redisk::IO do
   describe 'read' do
 
     it 'should return the entire contents without arguments' do
-      Redisk::IO.read(@io_name).should == @file_as_array.join("\n")
+      Redisk::IO.read(@io_name).should == @file_as_array.join("")
+    end
+
+    it 'should return the first [length] bytes' do
+      Redisk::IO.read(@io_name, 2).should == @file_as_array[0][0..1]
+    end
+
+    it 'should return [length] contents starting at [offset]' do
+      Redisk::IO.read(@io_name, 2, 2).should == @file_as_array[0][2..3]
+    end
+
+  end
+  
+
+  describe 'read_lines' do
+
+    it 'should return the entire contents without arguments' do
+      Redisk::IO.read_lines(@io_name).should == @file_as_array.join("")
     end
 
     it 'should return the first [length] contents' do
-      Redisk::IO.read(@io_name, 2).should == @file_as_array[0..1].join("\n")
+      Redisk::IO.read_lines(@io_name, 2).should == @file_as_array[0..1].join("")
     end
 
     it 'should return [length] contents starting at [offset]' do
-      Redisk::IO.read(@io_name, 2, 2).should == @file_as_array[2..3].join("\n")
+      Redisk::IO.read_lines(@io_name, 2, 2).should == @file_as_array[2..3].join("")
     end
 
   end
@@ -99,7 +167,7 @@ describe Redisk::IO do
       it 'should append a line to the io' do
         @io << 'whu'
         @io.lineno = 100
-        @io.gets.should == 'whu'
+        @io.gets.should == "whu"
       end
 
       it 'should return the text' do
@@ -109,10 +177,56 @@ describe Redisk::IO do
       it 'should be able to chain' do
         @io << 'whu ' << 'zuh'
         @io.lineno = 100
-        @io.gets.should == 'whu zuh'
+        @io.gets.should == "whu zuh"
       end
 
     end
+    
+    describe '#close_read' do
+      
+      it 'should close the io for reading' do
+        @io.close_read
+        lambda {
+          @io.gets
+        }.should raise_error(IOError)
+      end
+      
+    end
+    
+    describe '#close_write' do
+      it 'should close the io for writing' do
+        @io.close_write
+        lambda {
+          @io.puts
+        }.should raise_error(IOError)
+      end
+      
+    end
+    
+    describe '#close' do
+      
+      it 'should close for reading and writing' do
+        @io.close
+        lambda {
+          @io.puts
+        }.should raise_error(IOError)
+        lambda {
+          @io.gets
+        }.should raise_error(IOError)
+      end
+      
+    end
+    
+    describe '#closed?' do
+      
+      it 'should only return true if both streams are closed' do
+        @io.close_read
+        @io.closed?.should == false
+        @io.close_write
+        @io.closed?.should == true
+      end
+      
+    end
 
     describe '#each' do
 
@@ -136,7 +250,29 @@ describe Redisk::IO do
       end
 
     end
-
+    
+    describe '#each_byte' do
+      
+      it 'should yield each byte as a fixnum to a block' do
+        i = 0
+        all_bytes = @file_as_array.join('')
+        @io.each_byte {|b| 
+          b.should be_kind_of(Fixnum)
+          b.should == all_bytes[i].ord
+          i+=1
+        }
+      end
+      
+      it 'should advance the pos of the io' do
+        i = 0
+        @io.each_byte {|b|
+          i+=1
+          @io.pos.should == i
+        }
+      end
+      
+    end
+    
     describe '#eof' do
 
       it 'should return false if lineno is not the end of the file' do
@@ -150,6 +286,28 @@ describe Redisk::IO do
 
     end
 
+    describe '#getc' do
+      
+      it 'should get the next byte from the file as a fixnum' do
+        val = @io.getc
+        val.should be_kind_of(Fixnum)
+        val.should == @file_as_array[0].ord
+      end
+      
+      it 'should increment the pos of the io' do
+        @io.getc
+        @io.pos.should == 1
+        @io.getc
+        @io.pos.should == 2
+      end
+      
+      it 'should get the next line if necessary' do
+        @io.pos = @file_as_array[0].length + 1
+        @io.getc.should == @file_as_array[1][0].ord
+      end
+
+    end
+      
     describe '#gets' do
 
       it 'should return the next line from the io' do
@@ -185,12 +343,35 @@ describe Redisk::IO do
         @io.gets.should == @file_as_array[50]
       end
     end
+    
+    describe '#pos' do
+      
+      it 'should return the current pos' do
+        @io.pos.should == 0
+      end
+      
+    end
+    
+    describe '#pos=' do
+      
+      it 'should set the pos' do
+        @io.pos = 5
+        @io.pos.should == 5
+        @io.getc.should == @file_as_array[0][5].ord
+      end
+      
+      it 'should set the lineno based on the pos' do
+        @io.pos = @file_as_array[0].length + 2
+        @io.lineno.should == 2
+      end
+      
+    end
 
     describe '#print' do
 
       it 'should append arguments into a string and write to io' do
         @io.print('My ', 'name ', 'is ', 'redisk')
-        line = Redisk::IO.read(@io_name, 1, 100)
+        line = Redisk::IO.read_lines(@io_name, 1, 100)
         line.should == 'My name is redisk'
       end
 
@@ -201,7 +382,7 @@ describe Redisk::IO do
       it 'should write the contents of $_ if no arguments are provided' do
         @io.gets
         @io.print
-        line = Redisk::IO.read(@io_name, 1, 100)
+        line = Redisk::IO.read_lines(@io_name, 1, 100)
         line.should == @file_as_array[0]
       end
     end
@@ -210,7 +391,7 @@ describe Redisk::IO do
 
       it 'should run the arguments through sprintf and print to the io' do
         @io.printf('My name is %s', 'redisk')
-        line = Redisk::IO.read(@io_name, 1, 100)
+        line = Redisk::IO.read_lines(@io_name, 1, 100)
         line.should == 'My name is redisk'
       end
 
@@ -221,19 +402,68 @@ describe Redisk::IO do
       it 'should write each argument to the io' do
         @io.puts('1', '2', '3')
         @io.lineno = 100
-        @io.gets.should == '1'
-        @io.gets.should == '2'
-        @io.gets.should == '3'
+        @io.gets.should == "1\n"
+        @io.gets.should == "2\n"
+        @io.gets.should == "3\n"
       end
 
       it 'should write a blank string if no argument is passed' do
         @io.puts
         @io.lineno = 100
-        @io.gets.should == ''
+        @io.gets.should == "\n"
       end
 
     end
 
+    describe '#read' do
+      
+      it 'should read to the end of the file if [length] is ommited' do
+        @io.read.should == @file_as_array.join("")
+      end
+      
+      it 'should read into the [buffer] if a buffer is passed' do
+        string = "new string\n"
+        @io.read(nil, string)
+        string.should == "new string\n" + @file_as_array.join("")
+      end
+      
+      it 'should read [length] bytes from the IO' do
+        val = @io.read(20)
+        val.length.should == 20
+      end
+      
+      it 'should return nil if [length] is passed at the eof' do
+        @io.pos = 1000000
+        @io.eof?.should == true
+        @io.read(5).should == nil
+      end
+      
+      it 'should return "" if no [length] is passed at the eof' do
+        @io.pos = 1000000
+        @io.eof?.should == true
+        @io.read(nil).should == ""
+      end
+      
+    end
+
+    describe '#readbytes' do
+      
+      it 'should read [n] bytes from the io' do
+        val = @io.readbytes(10)
+        val.length.should == 10
+        val.should == @file_as_array.join("")[0...10]
+      end
+      
+      it 'should raise EOFError if the data is nil' do
+        @io.each_byte {|b| b }
+        @io.eof?.should == true
+        lambda {
+          @io.readbytes(10)
+        }.should raise_error(EOFError)
+      end
+      
+    end
+
     describe '#readline' do
 
       it 'should read the next line with gets' do
@@ -270,26 +500,26 @@ describe Redisk::IO do
 
     describe '#seek' do
 
-      it 'should set the lineno to the absolute location' do
+      it 'should set the pos to the absolute location' do
         @io.seek(10)
-        @io.lineno.should == 10
+        @io.pos.should == 10
       end
 
-      it 'should set the lineno to the absolute location with SEEK_SET' do
+      it 'should set the pos to the absolute location with SEEK_SET' do
         @io.seek(15, IO::SEEK_SET)
-        @io.lineno.should == 15
+        @io.pos.should == 15
       end
 
-      it 'should set the lineno to the location relative to the end with SEEK_END' do
+      it 'should set the pos to the location relative to the end with SEEK_END' do
         @io.seek(-5, IO::SEEK_END)
-        @io.lineno.should == 95
+        @io.pos.should == @file_as_array.join.length - 5
       end
 
-      it 'should set the lineno to an offset position from the current line with SEEK_CUR' do
-        @io.lineno = 5
-        @io.lineno.should == 5
+      it 'should set the pos to an offset position from the current line with SEEK_CUR' do
+        @io.pos = 5
+        @io.pos.should == 5
         @io.seek(5, IO::SEEK_CUR)
-        @io.lineno.should == 10
+        @io.pos.should == 10
       end
 
     end
@@ -300,7 +530,7 @@ describe Redisk::IO do
         @stat = @io.stat
         @stat.should be_instance_of(Redisk::Stat)
         @stat.atime.should be_instance_of(Time)
-        @stat.size.should == 0
+        @stat.size.should be_instance_of(Fixnum)
       end
 
     end
@@ -329,6 +559,42 @@ describe Redisk::IO do
       
     end
 
+    describe '#ungetc' do
+      
+      it 'should put the string represented by a fixnum at the end of the io buffer' do
+        @io.ungetc 65
+        @io.flush
+        last_char = nil
+        @io.each_byte {|b| last_char = b }
+        last_char.should == 65
+      end
+      
+      it 'should return nil' do
+        @io.ungetc(65).should == nil
+      end
+      
+    end
+    
+    describe '#unlink' do
+      before do
+        @io.unlink
+      end
+      
+      it 'should delete all keys associated with the io' do
+        Redisk.redis.get(@key).should == nil
+        Redisk::Stat.new(@key).size.should == 0
+      end
+      
+      it 'should close the stream' do
+        @io.closed?.should == true
+      end
+      
+      it 'should remove the key from the list of ios' do
+        Redisk::IO.all.should_not include(@io_name)
+      end
+      
+    end
+
   end
   
   describe 'As an interface for logger' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: redisk
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Aaron Quint
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-17 00:00:00 -05:00
+date: 2009-12-22 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,9 +54,12 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- HISTORY
 - LICENSE
 - README.rdoc
 - Rakefile
+- examples/rails.rb
+- examples/yajl.rb
 - lib/redisk.rb
 - lib/redisk/helper.rb
 - lib/redisk/io.rb
@@ -103,3 +106,5 @@ test_files:
 - spec/redisk_logger_spec.rb
 - spec/redisk_stat_spec.rb
 - spec/spec_helper.rb
+- examples/rails.rb
+- examples/yajl.rb