io_shuten 0.0.1.dev5 → 0.0.3.dev1

data/doc/top-level-namespace.html

@@ -96,9 +96,9 @@
 </div>
     
     <div id="footer">
-  Generated on Mon Jan 23 01:15:28 2012 by 
+  Generated on Thu Jan 26 00:45:41 2012 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.4 (ruby-1.9.3).
+  0.7.4 (ruby-1.8.7).
 </div>
 
   </body>

data/io_shuten.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "io_shuten"
-  s.version = "0.0.1.dev5"
+  s.version = "0.0.3.dev1"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Grabo"]
-  s.date = "2012-01-23"
-  s.description = "IO::shuten \u{2013} Use databases as IO handler like you would do with files and streams."
+  s.date = "2012-01-25"
+  s.description = "IO::shuten \342\200\223 Use databases as IO handler like you would do with files and streams."
   s.email = ["chris@dinarrr.com"]
   s.extra_rdoc_files = [
     "LICENSE",
@@ -29,6 +29,8 @@ Gem::Specification.new do |s|
     "LICENSE.de",
     "README.md",
     "Rakefile",
+    "benchmark/compare_mem_w_buf.rb",
+    "doc/IO_3A_3ABuffer.html",
     "doc/IO_shuten.html",
     "doc/IO_shuten/Base.html",
     "doc/IO_shuten/Base/FileAccessError.html",
@@ -36,6 +38,7 @@ Gem::Specification.new do |s|
     "doc/IO_shuten/Base/NodeNameError.html",
     "doc/IO_shuten/Base/NodeNotFoundError.html",
     "doc/IO_shuten/Base/NotYetImplemented.html",
+    "doc/IO_shuten/Buffer.html",
     "doc/IO_shuten/Errors.html",
     "doc/IO_shuten/Errors/FileAccessError.html",
     "doc/IO_shuten/Errors/FileNotFoundError.html",
@@ -44,6 +47,7 @@ Gem::Specification.new do |s|
     "doc/IO_shuten/Errors/NodeNameExistsError.html",
     "doc/IO_shuten/Errors/NodeNotFoundError.html",
     "doc/IO_shuten/Errors/NotYetImplemented.html",
+    "doc/IO_shuten/Memory.html",
     "doc/IO_shuten/Mongo.html",
     "doc/IO_shuten/Redis.html",
     "doc/IO_shuten/Stores.html",
@@ -71,7 +75,9 @@ Gem::Specification.new do |s|
     "io_shuten.gemspec",
     "lib/io_shuten.rb",
     "lib/io_shuten/base.rb",
+    "lib/io_shuten/buffer.rb",
     "lib/io_shuten/errors.rb",
+    "lib/io_shuten/memory.rb",
     "lib/io_shuten/mongo.rb",
     "lib/io_shuten/redis.rb",
     "lib/io_shuten/stores.rb",
@@ -83,7 +89,8 @@ Gem::Specification.new do |s|
     "lib/io_shuten/stores/redis/pub_sub.rb",
     "lib/io_shuten/version.rb",
     "spec/examples/logger_spec.rb",
-    "spec/lib/base_spec.rb",
+    "spec/lib/buffer_spec.rb",
+    "spec/lib/memory_spec.rb",
     "spec/lib/mongo_spec.rb",
     "spec/lib/redis_spec.rb",
     "spec/lib/stores/mongo/collection_spec.rb",
@@ -98,13 +105,14 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/asaaki/io_shuten"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.15"
-  s.summary = "IO::shuten \u{2013} Use databases as IO handler. (NOT YET READY FOR PRODUCTION!)"
+  s.rubygems_version = "1.8.10"
+  s.summary = "IO::shuten \342\200\223 Use databases as IO handler. (NOT YET READY FOR PRODUCTION!)"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<iobuffer>, ["~> 1.0.0"])
       s.add_runtime_dependency(%q<hiredis>, ["~> 0.4.4"])
       s.add_runtime_dependency(%q<redis>, ["~> 2.2.2"])
       s.add_runtime_dependency(%q<bson_ext>, ["~> 1.5.2"])
@@ -116,12 +124,11 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov-rcov>, [">= 0"])
       s.add_development_dependency(%q<simplecov-csv>, [">= 0"])
       s.add_development_dependency(%q<redcarpet>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<yard-blame>, [">= 0"])
       s.add_development_dependency(%q<pry>, [">= 0"])
-      s.add_development_dependency(%q<pry-doc>, [">= 0"])
     else
+      s.add_dependency(%q<iobuffer>, ["~> 1.0.0"])
       s.add_dependency(%q<hiredis>, ["~> 0.4.4"])
       s.add_dependency(%q<redis>, ["~> 2.2.2"])
       s.add_dependency(%q<bson_ext>, ["~> 1.5.2"])
@@ -133,13 +140,12 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov-rcov>, [">= 0"])
       s.add_dependency(%q<simplecov-csv>, [">= 0"])
       s.add_dependency(%q<redcarpet>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<yard-blame>, [">= 0"])
       s.add_dependency(%q<pry>, [">= 0"])
-      s.add_dependency(%q<pry-doc>, [">= 0"])
     end
   else
+    s.add_dependency(%q<iobuffer>, ["~> 1.0.0"])
     s.add_dependency(%q<hiredis>, ["~> 0.4.4"])
     s.add_dependency(%q<redis>, ["~> 2.2.2"])
     s.add_dependency(%q<bson_ext>, ["~> 1.5.2"])
@@ -151,11 +157,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<simplecov-rcov>, [">= 0"])
     s.add_dependency(%q<simplecov-csv>, [">= 0"])
     s.add_dependency(%q<redcarpet>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<yard-blame>, [">= 0"])
     s.add_dependency(%q<pry>, [">= 0"])
-    s.add_dependency(%q<pry-doc>, [">= 0"])
   end
 end
 

data/lib/io_shuten/base.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module IO_shuten
-  # IO_shuten::Base is the in-memory implementation and parent class for other implementations.
+  # IO_shuten::Base is interface class for other implementations.
   class Base
 
     # Storage of current Base instances of the running process
@@ -16,28 +16,6 @@ module IO_shuten
     # @return [StringIO]
     attr :container
 
-    # Creates a new Base node and stores it in the pool
-    #
-    # @param [String] node_name Name of the node node (container)
-    # @param [Symbol] node_name also a symbol is allowed
-    # @param *args (not used)
-    # @return [Base]
-    # @raise [NodeNameError]
-    def initialize(node_name = nil, *args)
-      if [String, Symbol].include?(node_name.class)
-        unless Base.instance_exists? node_name
-        @node_name    = node_name
-        @container      = StringIO.new("","w+")
-
-        @@instances << self unless @@instances.include?(self)
-        else
-          raise Errors::NodeExistsError, "Node already in pool, replacement is not allowed."
-        end
-      else
-        raise Errors::NodeNameError, "Name must be kind of String or Symbol and can't be nil."
-      end
-    end
-
     ### class methods
 
     class << self
@@ -69,46 +47,6 @@ module IO_shuten
         end
       end
 
-      # Loads instances from disk
-      #
-      # @param [String] Directory name
-      # @param [Array] File names (HINT: you can provide a Dir.glob)
-      # @return [Boolean]
-      def load_instances source
-        case source.class.to_s
-          when "Array"
-            source.each do |file_name|
-              node = Base.new(file_name)
-              node.puts File.read(file_name)
-            end
-          when "String"
-            if File.exists?(source) && File.directory?(source)
-              Dir[source+"/**/*"].each do |file_name|
-                node = Base.new(file_name)
-                node.puts File.read(file_name)
-              end
-            end
-          else
-            raise ArgumentError, "Input must be a kind of Array or String (but was: #{source.class})."
-        end
-      end
-
-      # Saves all instances to disk
-      #
-      # @return [Boolean]
-      def save_instances
-        results = @@instances.inject({}) do |result, node|
-          File.open(node.node_name,"w") do |fh|
-            fh.puts node.string
-          end
-          result[node.node_name] = :failed unless File.exists?(node.node_name)
-        end
-        if results
-          false
-        else
-          true
-        end
-      end
 
       # Checks for existence of a node
       #
@@ -123,76 +61,10 @@ module IO_shuten
       alias_method :exists?,         :instance_exists?
       alias_method :exist?,          :instance_exists?
 
-      # @return [Base] itself on success
-      # @raise [NodeNotFoundError]
-      def open node_name, *args
-        if Base.instance_exists? node_name
-          if block_given?
-            base = Base.send :load, node_name
-            base.reopen(base.container.string) if base.container.closed_write?
-            yield(base)
-            base.container.close_write
-            base
-
-          else
-            base = Base.send :load, node_name
-            base.reopen(base.container.string) if base.container.closed_write?
-            base
-          end
-
-        else
-          raise Errors::NodeNotFoundError
-        end
-      end
-      alias_method :open_node, :open
-
-    private
-
-      # @private
-      def load node_name
-        instances.select do |inst|
-          inst.node_name == node_name
-        end.first
-      end
-      alias_method :load_node, :load
-
     end
 
     ### instance methods
 
-    # @return [Base] itself on success
-    # @raise [FileNotFoundError]
-    def load_from_file file_name = nil
-      file_name ||= self.node_name
-      if file_exists? file_name
-        self.container.string = File.read(file_name)
-        self
-      else
-        raise Errors::FileNotFoundError, self.node_name
-      end
-    end
-
-    # @return [Base] itself on success
-    # @raise [FileAccessError]
-    def save_to_file file_name = nil
-      file_name ||= self.node_name
-      begin
-        File.open(file_name, 'w') do |fh|
-          fh.write(self.container.string)
-        end
-        self
-      rescue Exception => e
-        raise Errors::FileAccessError, "Reason: #{e.message}"
-      end
-    end
-
-    # @return [Boolean]
-    def file_exists? file_name = nil
-      file_name ||= self.node_name
-      File.exists?(file_name)
-    end
-    alias_method :file_exist?, :file_exists?
-
     # @private
     def respond_to? sym
       !!self.methods.include?(sym) || respond_to_missing?(sym)

data/lib/io_shuten/buffer.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+
+require "iobuffer"
+
+# @private
+class ::IO::Buffer
+  def close; end #dummy
+end
+
+module IO_shuten
+  # Implementation of the Buffer storage
+  class Buffer < IO_shuten::Base
+
+    # Creates a new Buffer node and stores it in the pool
+    #
+    # @param [String] node_name Name of the node node (container)
+    # @param [Symbol] node_name also a symbol is allowed
+    # @return [Buffer]
+    # @raise [NodeNameError]
+    def initialize(node_name = nil)
+      if [String, Symbol].include?(node_name.class)
+        unless Buffer.instance_exists? node_name
+        @node_name  = node_name
+        @container  = ::IO::Buffer.new
+
+        @@instances << self unless @@instances.include?(self)
+        else
+          raise Errors::NodeExistsError, "Node already in pool, replacement is not allowed."
+        end
+      else
+        raise Errors::NodeNameError, "Name must be kind of String or Symbol and can't be nil."
+      end
+    end
+
+    ### class methods
+
+    class << self
+
+      # Loads instances from disk
+      #
+      # @param [String] Directory name
+      # @param [Array] File names (HINT: you can provide a Dir.glob)
+      # @return [Boolean]
+      def load_instances source
+        case source.class.to_s
+          when "Array"
+            source.each do |file_name|
+              node = Buffer.new(file_name)
+              File.open(file_name,'r') do |fh|
+                node.read_from fh
+              end
+            end
+          when "String"
+            if File.exists?(source) && File.directory?(source)
+              Dir[source+"/**/*"].each do |file_name|
+                node = Buffer.new(file_name)
+                File.open(file_name,'r') do |fh|
+                  node.read_from fh
+                end
+              end
+            end
+          else
+            raise ArgumentError, "Input must be a kind of Array or String (but was: #{source.class})."
+        end
+      end
+
+      # Saves all instances to disk
+      #
+      # @return [Boolean]
+      def save_instances
+        results = instances.inject({}) do |result, node|
+          File.open(node.node_name,"w") do |fh|
+            node.write_to(fh)
+          end
+
+          result[node.node_name] = :failed unless File.exists?(node.node_name)
+        end
+        if results
+          false
+        else
+          true
+        end
+      end
+
+      # @return [Buffer] itself on success
+      # @raise [NodeNotFoundError]
+      def open node_name, *args
+        if Buffer.instance_exists? node_name
+          if block_given?
+            base = Buffer.send :load, node_name
+            yield(base)
+            base
+
+          else
+            base = Buffer.send :load, node_name
+            base
+          end
+
+        else
+          raise Errors::NodeNotFoundError
+        end
+      end
+      alias_method :open_node, :open
+
+    private
+
+      # @private
+      def load node_name
+        instances.select do |inst|
+          inst.node_name == node_name
+        end.first
+      end
+      alias_method :load_node, :load
+
+    end
+
+    ### instance methods
+
+    # @return [Buffer] itself on success
+    # @raise [FileNotFoundError]
+    def load_from_file file_name = nil
+      file_name ||= self.node_name
+      if file_exists? file_name
+        File.open(file_name) do |fh|
+          self.container.read_from(fh)
+        end
+        self
+      else
+        raise Errors::FileNotFoundError, self.node_name
+      end
+    end
+
+    # @return [Buffer] itself on success
+    # @raise [FileAccessError]
+    def save_to_file file_name = nil
+      file_name ||= self.node_name
+      begin
+        File.open(file_name, 'w') do |fh|
+          self.container.write_to(fh)
+        end
+        self
+      rescue Exception => e
+        raise Errors::FileAccessError, "Reason: #{e.message}"
+      end
+    end
+
+    # @return [Boolean]
+    def file_exists? file_name = nil
+      file_name ||= self.node_name
+      File.exists?(file_name)
+    end
+    alias_method :file_exist?, :file_exists?
+
+  end
+end
+

data/lib/io_shuten/memory.rb

@@ -0,0 +1,145 @@
+# encoding: utf-8
+
+module IO_shuten
+  # Implementation of the Memory storage
+  class Memory < IO_shuten::Base
+
+    # Creates a new Memory node and stores it in the pool
+    #
+    # @param [String] node_name Name of the node node (container)
+    # @param [Symbol] node_name also a symbol is allowed
+    # @return [Memory]
+    # @raise [NodeNameError]
+    def initialize(node_name = nil)
+      if [String, Symbol].include?(node_name.class)
+        unless Memory.instance_exists? node_name
+        @node_name  = node_name
+        @container  = ::StringIO.new("","w+")
+
+        @@instances << self unless @@instances.include?(self)
+        else
+          raise Errors::NodeExistsError, "Node already in pool, replacement is not allowed."
+        end
+      else
+        raise Errors::NodeNameError, "Name must be kind of String or Symbol and can't be nil."
+      end
+    end
+
+    ### class methods
+
+    class << self
+
+      # Loads instances from disk
+      #
+      # @param [String] Directory name
+      # @param [Array] File names (HINT: you can provide a Dir.glob)
+      # @return [Boolean]
+      def load_instances source
+        case source.class.to_s
+          when "Array"
+            source.each do |file_name|
+              node = Memory.new(file_name)
+              node.puts File.read(file_name)
+            end
+          when "String"
+            if File.exists?(source) && File.directory?(source)
+              Dir[source+"/**/*"].each do |file_name|
+                node = Memory.new(file_name)
+                node.puts File.read(file_name)
+              end
+            end
+          else
+            raise ArgumentError, "Input must be a kind of Array or String (but was: #{source.class})."
+        end
+      end
+
+      # Saves all instances to disk
+      #
+      # @return [Boolean]
+      def save_instances
+        results = instances.inject({}) do |result, node|
+          File.open(node.node_name,"w") do |fh|
+            fh.puts node.string
+          end
+          result[node.node_name] = :failed unless File.exists?(node.node_name)
+        end
+        if results
+          false
+        else
+          true
+        end
+      end
+
+      # @return [Memory] itself on success
+      # @raise [NodeNotFoundError]
+      def open node_name, *args
+        if Memory.instance_exists? node_name
+          if block_given?
+            base = Memory.send :load, node_name
+            base.reopen(base.container.string) if base.container.closed_write?
+            yield(base)
+            base.container.close_write
+            base
+
+          else
+            base = Memory.send :load, node_name
+            base.reopen(base.container.string) if base.container.closed_write?
+            base
+          end
+
+        else
+          raise Errors::NodeNotFoundError
+        end
+      end
+      alias_method :open_node, :open
+
+    private
+
+      # @private
+      def load node_name
+        instances.select do |inst|
+          inst.node_name == node_name
+        end.first
+      end
+      alias_method :load_node, :load
+
+    end
+
+    ### instance methods
+
+    # @return [Memory] itself on success
+    # @raise [FileNotFoundError]
+    def load_from_file file_name = nil
+      file_name ||= self.node_name
+      if file_exists? file_name
+        self.container.string = File.read(file_name)
+        self
+      else
+        raise Errors::FileNotFoundError, self.node_name
+      end
+    end
+
+    # @return [Memory] itself on success
+    # @raise [FileAccessError]
+    def save_to_file file_name = nil
+      file_name ||= self.node_name
+      begin
+        File.open(file_name, 'w') do |fh|
+          fh.write(self.container.string)
+        end
+        self
+      rescue Exception => e
+        raise Errors::FileAccessError, "Reason: #{e.message}"
+      end
+    end
+
+    # @return [Boolean]
+    def file_exists? file_name = nil
+      file_name ||= self.node_name
+      File.exists?(file_name)
+    end
+    alias_method :file_exist?, :file_exists?
+
+  end
+end
+

data/lib/io_shuten/redis.rb

@@ -1,10 +1,75 @@
 # encoding: utf-8
 
+require "redis"
+
 module IO_shuten
   # Implementation of the Redis storage
   #
+  # Two backends are possible: simple key-value and pub-sub messaging
+  #
+  # KeyValue
+  # has different node types.
+  # Incremental single message store: each write will create a new key.
+  # Message collection store: all writes go to a single key.
+  # Good for events or logs.
+  #
+  # PubSub
+  # has different node types: publisher and subscriber.
+  # In future maybe a combined publisher-subscriber type possible, but in general less needed.
+  # Good for live event messaging.
+  #
   # @todo Needs two backends (default database interface and pub/sub interface)!
   class Redis < IO_shuten::Base
 
+    # Global redis client instance for the pool
+    # @return [Object] Redis instance
+    @@redis = ::Redis.new
+
+    # @param [String] node_name
+    # @param [Symbol] node_name
+    # @param [Symbol] backend :key_value, :pub_sub
+    # @param [Symbol] type for backend :key_value => [:single,:collection], for backend :pub_sub => [:publisher,:subscriber]
+    # @param [Object] Redis an instance for this specific node, otherwise the Redis.redis instance will be used
+    def initialize node_name, backend, type, redis_instance = nil
+      # based on the backend type it should instantiate the corresponding backend store module
+      node = :nil
+      case backend
+        when :key_value
+          Stores::Redis::KeyValue #.create(type)
+        when :pub_sub
+          Stores::Redis::PubSub #.create(type)
+        else
+          raise ArgumentError, "Backend type unknown. Use :key_value or :pub_sub"
+      end
+      @@instances << node
+    end
+
+    ### class methods ###
+
+    class << self
+
+      # @return [Object] current redis client
+      def redis
+        @@redis
+      end
+
+      # Sets a new global redis client for the pool
+      # @return [Object] new redis client
+      def redis= new_redis
+        @redis = new_redis
+      end
+    end
+
+    ### instance methods ###
+
+    def read
+    end
+
+    def write
+    end
+
+    def close
+    end
+
   end
 end

data/lib/io_shuten/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 module IO_shuten
   # @private
-  VERSION = [0,0,1,'dev5'].join('.')
+  VERSION = [0,0,3,'dev1'].join('.')
 end

data/lib/io_shuten.rb

@@ -5,6 +5,8 @@ module IO_shuten; end
 
 require "io_shuten/errors"
 require "io_shuten/base"
+require "io_shuten/memory"
+require "io_shuten/buffer"
 require "io_shuten/stores"
 require "io_shuten/mongo"
 require "io_shuten/redis"