io_shuten 0.0.1.dev5 → 0.0.3.dev1

data/.travis.yml

@@ -2,12 +2,19 @@ rvm:
   - 1.9.3
   - 1.9.2
   - 1.8.7
+  - ree
+  - ruby-head
+  - rbx-18mode
+  - rbx-19mode
 
 branches:
   only:
     - develop
     - master
 
+#after_script:
+#  - "ruby ./benchmark/compare_mem_w_buf.rb"
+
 notifications:
   email:
     - chris@dinarrr.com

data/Gemfile

@@ -1,5 +1,7 @@
 source "https://rubygems.org"
 
+gem "iobuffer", "~> 1.0.0"
+
 gem "hiredis", "~> 0.4.4"
 gem "redis", "~> 2.2.2", :require => ["redis/connection/hiredis", "redis"]
 
@@ -16,13 +18,10 @@ group :development, :test do
   gem "simplecov-csv", :require => false
 
   gem "redcarpet"
-  gem "rdoc"
   gem "yard"
-  #gem "yard-rspec" # not working :(
   gem "yard-blame"
 
   gem "pry"
-  gem "pry-doc"
+  #gem "pry-doc"
 end
 
-

data/Gemfile.lock

@@ -8,11 +8,11 @@ GEM
     diff-lcs (1.1.3)
     git (1.2.5)
     hiredis (0.4.4)
+    iobuffer (1.0.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.5)
     method_source (0.6.7)
       ruby_parser (>= 2.3.1)
     mongo (1.5.2)
@@ -23,12 +23,7 @@ GEM
       method_source (~> 0.6.7)
       ruby_parser (>= 2.3.1)
       slop (~> 2.1.0)
-    pry-doc (0.3.0)
-      pry (>= 0.9.0)
-      yard (>= 0.6.4)
     rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
     redcarpet (2.0.1)
     redis (2.2.2)
     rspec (2.8.0)
@@ -61,12 +56,11 @@ PLATFORMS
 DEPENDENCIES
   bson_ext (~> 1.5.2)
   hiredis (~> 0.4.4)
+  iobuffer (~> 1.0.0)
   jeweler
   mongo (~> 1.5.2)
   pry
-  pry-doc
   rake
-  rdoc
   redcarpet
   redis (~> 2.2.2)
   rspec (~> 2.8.0)

data/README.md

@@ -15,10 +15,10 @@ Example:
 require "io_shuten"
 require "logger"
 
-logdev = IO_shuten::Redis.new( REDIS_INSTANCE )
+logdev = IO_shuten::Memory.new('log_node')
 logger = Logger.new(logdev)
 
-logger.info "This message will be stored in redis."
+logger.info "This message will be stored in memory."
 ```
 
 
@@ -30,21 +30,35 @@ In japanese `io` means *500* or *big amount*, `shū･ten` means *endpoint* (tra
 ## Types
 
 
-### IO_shuten::Base
+### IO_shuten::Memory
 
 An in-memory storage system (handles simple StringIO objects).
 
 Offers write-to-disk for single instance and all instances.
 
+Provides all methods of StringIO.
+
+### IO_shuten::Buffer
+
+Like IO_shuten::Memory but with IO::Buffer as container instead of StringIO.
+(Install it with `gem install iobuffer`.)
+
+Performance depends on machine and ruby version. Almost same throughput, on 1.9.3 is the native StringIO better than the IO::Buffer cext.
+
 ### IO_shuten::Redis
 
 Stores content in a redis database.
 
+Provides basic methods like `#read`, `#write` and `#close`.
+A logger only needs write and close methods of an IO object.
 
 ### IO_shuten::Mongo
 
 Stores content in a mongodb database.
 
+Provides basic methods like `#read`, `#write` and `#close`.
+A logger only needs write and close methods of an IO object.
+
 
 ## Not for production!
 

data/Rakefile

@@ -15,6 +15,10 @@ require "io_shuten/version"
 
 
 
+RUBY_ENGINE = '(no engine)' unless defined? RUBY_ENGINE
+
+
+
 Jeweler::Tasks.new do |gem|
   gem.name        = "io_shuten"
   gem.version     = IO_shuten::VERSION
@@ -70,4 +74,24 @@ task :pry do
   sh "pry -I lib -r io_shuten --no-pager"
 end
 
-task :default => :spec
+
+
+desc "Prints current environment"
+task :envinfo do
+  puts ['RUBY:',RUBY_PLATFORM,RUBY_ENGINE,RUBY_VERSION].join(" ")
+end
+
+
+
+desc "RBX ONLY: Clean up rbc and .rbx"
+task :rbx_clean do
+  Dir["./**/*.rbc","./**/.*.rbc"].each do |f|
+    File.unlink f
+  end
+  sh "rm -rf .rbx" if File.exists?(".rbx") && File.directory?(".rbx")
+end
+
+
+
+task :default => [:envinfo,:spec]
+

data/benchmark/compare_mem_w_buf.rb

@@ -0,0 +1,134 @@
+# encoding: utf-8
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "rubygems"
+require "benchmark"
+require "bundler/setup"
+require "io_shuten"
+require "logger"
+
+IOM = IO_shuten::Memory
+IOB = IO_shuten::Buffer
+
+loops_write  =  5000
+loops_logger =  5000
+loops_files  =  2000
+loops_files_outer = 5
+
+lorem_ipsum = <<LOREM
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod
+tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
+At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren,
+no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet,
+consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et
+dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo
+dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem
+ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed
+diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
+voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd
+gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.
+LOREM
+
+tmp_path = File.expand_path("../../tmp", __FILE__)
+Dir.mkdir(tmp_path) unless File.exists?(tmp_path)
+
+puts
+puts "BENCHMARK: IO_shuten::Buffer vs IO_shuten::Memory #{ENV['TRAVIS'] ? '(TRAVIS CI)' : ''}"
+
+puts
+puts "WRITES"
+puts
+Benchmark.bmbm do |x|
+  x.report "W  IO_shuten::Buffer" do
+    IO_shuten::Buffer.purge_instances!
+    loops_write.times do |i|
+      iob = IO_shuten::Buffer.new("wbuff-#{i}")
+      iob.write lorem_ipsum
+    end
+  end
+  x.report "W  IO_shuten::Memory" do
+    IO_shuten::Memory.purge_instances!
+    loops_write.times do |i|
+      iom = IO_shuten::Memory.new("wmem-#{i}")
+      iom.write lorem_ipsum
+    end
+  end
+end
+
+puts
+puts "LOGGING"
+puts
+Benchmark.bmbm do |x|
+  x.report "L  IO_shuten::Buffer" do
+    IO_shuten::Buffer.purge_instances!
+    loops_logger.times do |i|
+      logdev = IO_shuten::Buffer.new("logdev-#{i}")
+      logger = Logger.new(logdev)
+      logger.info lorem_ipsum
+      logger.debug "counter: #{i}"
+    end
+  end
+  x.report "L  IO_shuten::Memory" do
+    IO_shuten::Memory.purge_instances!
+    loops_logger.times do |i|
+      logdev = IO_shuten::Memory.new("logdev-#{i}")
+      logger = Logger.new(logdev)
+      logger.info lorem_ipsum
+      logger.debug "counter: #{i}"
+    end
+  end
+end
+
+puts
+puts "FILE WRITES"
+puts
+Benchmark.bmbm do |x|
+  x.report "FW IO_shuten::Buffer" do
+    IO_shuten::Buffer.purge_instances!
+    loops_files.times do |i|
+      iob = IO_shuten::Buffer.new("#{tmp_path}/wbuff-#{i}")
+      iob.write lorem_ipsum
+      iob.save_to_file
+    end
+  end
+  x.report "FW IO_shuten::Memory" do
+    IO_shuten::Memory.purge_instances!
+    loops_files.times do |i|
+      iom = IO_shuten::Memory.new("#{tmp_path}/wmem-#{i}")
+      iom.write lorem_ipsum
+      iom.save_to_file
+    end
+  end
+end
+
+puts
+puts "FILE READS"
+puts
+Benchmark.bmbm do |x|
+  x.report "FR IO_shuten::Buffer" do
+    loops_files_outer.times do
+      IO_shuten::Buffer.purge_instances!
+      loops_files.times do |i|
+        iob = IO_shuten::Buffer.new("#{tmp_path}/wbuff-#{i}")
+        iob.load_from_file
+        iob.read
+      end
+    end
+  end
+  x.report "FR IO_shuten::Memory" do
+    loops_files_outer.times do
+      IO_shuten::Memory.purge_instances!
+      loops_files.times do |i|
+        iom = IO_shuten::Memory.new("#{tmp_path}/wmem-#{i}")
+        iom.load_from_file
+        iom.read
+      end
+    end
+  end
+end
+
+Dir["#{tmp_path}/**/*"].each do |f|
+  File.unlink f
+end
+
+puts
+puts "/BENCHMARK"

data/doc/IO_3A_3ABuffer.html

@@ -0,0 +1,198 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Class: IO::Buffer
+  
+    &mdash; IO::shuten 【五百::終点】
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/blame.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (I)</a> &raquo; 
+    
+    
+    <span class="title">IO::Buffer</span>
+  
+  
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a id="class_list_link" href="#">Class List</a>
+  
+    <a id="method_list_link" href="#">Method List</a>
+  
+    <a id="file_list_link" href="#">File List</a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+    
+    <iframe id="search_frame"></iframe>
+    
+    <div id="content"><h1>Class: IO::Buffer
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">IO::Buffer</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/io_shuten/buffer.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#close-instance_method" title="#close (instance method)">- (Object) <strong>close</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'><p>
+dummy.
+</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
+    
+      <div class="method_details first">
+  <p class="signature first" id="close-instance_method">
+  
+    - (<tt>Object</tt>) <strong>close</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p>
+dummy
+</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code blame">
+  <caption><span class="info file"># File 'lib/io_shuten/buffer.rb', line 6</span></caption>
+  <tr>
+    <td>
+      <table>
+      
+      
+        
+        <tr>
+        
+          <td class="author"><a href="mailto:<chris@dinarrr.com>">Christoph Grabo</a></td>
+        
+          <td class="date">2012-01-26 00:33:32</td>
+          <td class="commit"><a title="Fix some issues with incompatibilities of rubies">b0f63a42</a><td>
+          <td class="lines">6</td>
+          <td><pre class="code"><span class='rubyid_def def kw'>def</span> <span class='rubyid_close identifier id'>close</span><span class='semicolon token'>;</span> <span class='rubyid_end end kw'>end</span></pre></td>
+        </tr>
+      
+      </table>
+    </td>
+    <td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+    
+    <div id="footer">
+  Generated on Thu Jan 26 00:41:21 2012 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.4 (ruby-1.8.7).
+</div>
+
+  </body>
+</html>