io_shuten 0.0.1.dev4 → 0.0.1.dev5

data/lib/io_shuten/errors.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module IO_shuten
+
+  # Collection of Errors/Exceptions
+  module Errors
+
+    # Exception if a node object was not found
+    class NodeNotFoundError < ::StandardError
+    end
+
+    # Exception if the node object name was of wrong type
+    class NodeNameError < ::StandardError
+    end
+
+    # Exception if the node object name was found in pool
+    class NodeExistsError < ::StandardError
+    end
+
+    # Exception if file was not found
+    class FileNotFoundError < ::StandardError
+    end
+
+    # Exception if something went wrong on file handling
+    class FileAccessError < ::StandardError
+    end
+
+    # Exception for not yet implemented methods (stubs)
+    class NotYetImplemented < ::StandardError
+      # @private
+      def initialize callee = nil, pos = nil
+        msg = if callee
+          "Method :#{callee} is not (yet) supported. #{pos ? ''+pos+'' : ''}"
+        else
+          "The method is not (yet) supported."
+        end
+        super msg
+      end
+    end
+
+  end
+end

data/lib/io_shuten/redis.rb

@@ -2,6 +2,8 @@
 
 module IO_shuten
   # Implementation of the Redis storage
+  #
+  # @todo Needs two backends (default database interface and pub/sub interface)!
   class Redis < IO_shuten::Base
 
   end

data/lib/io_shuten/stores.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module IO_shuten
+  # Namespace for the storage implementations
+  module Stores
+  end
+end
+
+require "io_shuten/stores/mongo"
+require "io_shuten/stores/redis"
+

data/lib/io_shuten/stores/mongo.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module IO_shuten::Stores
+  # Namespace for mongodb backends
+  module Mongo
+  end
+end
+
+require "io_shuten/stores/mongo/collection"
+require "io_shuten/stores/mongo/gridfs"
+

data/lib/io_shuten/stores/mongo/collection.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module IO_shuten::Stores::Mongo
+  # MongoDB Backend for Collection based storage
+  module Collection
+  end
+end

data/lib/io_shuten/stores/mongo/gridfs.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module IO_shuten::Stores::Mongo
+  # MongoDB Backend for GridFS based storage
+  module GridFS
+  end
+end

data/lib/io_shuten/stores/redis.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module IO_shuten::Stores
+  # Namespace for redis backends
+  module Redis
+  end
+end
+
+require "io_shuten/stores/redis/key_value"
+require "io_shuten/stores/redis/pub_sub"
+

data/lib/io_shuten/stores/redis/key_value.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module IO_shuten::Stores::Redis
+  # Redis Backend for key-value based storage
+  module KeyValue
+  end
+end

data/lib/io_shuten/stores/redis/pub_sub.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module IO_shuten::Stores::Redis
+  # Redis Backend for pub-sub (event/message) based storage
+  module PubSub
+  end
+end

data/lib/io_shuten/version.rb

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

data/spec/lib/base_spec.rb

@@ -8,27 +8,36 @@ describe Base do
 
     describe :new do
 
-      context "without object_name" do
-        it "creates a new object with nil name" do
-          ios = Base.new
-          ios.should be_an(IO_shuten::Base)
-          ios.object_name.should be_nil
+      context "without node_name" do
+        it "raises " do
+          expect { Base.new }.to raise_error(Errors::NodeNameError)
         end
       end
 
-      context "with object_name" do
-        it "creates a new object with name as String" do
-          object_name = "foo bar"
-          ios = Base.new(object_name)
+      context "with node_name" do
+        it "creates a new node with name as String" do
+          node_name = "foo bar"
+          ios = Base.new(node_name)
           ios.should be_an(IO_shuten::Base)
-          ios.object_name.should == object_name
+          ios.node_name.should == node_name
         end
 
-        it "creates a new object with name as Symbol" do
-          object_name = :foobar
-          ios = Base.new(object_name)
+        it "creates a new node with name as Symbol" do
+          node_name = :foobar
+          ios = Base.new(node_name)
           ios.should be_an(IO_shuten::Base)
-          ios.object_name.should == object_name
+          ios.node_name.should == node_name
+        end
+
+        it "raises NodeNameError if wrong type" do
+          node_name = 1.23
+          expect { Base.new(node_name) }.to raise_error(Errors::NodeNameError)
+        end
+
+        it "raises NodeExistsError if node name is already taken" do
+          node_name = :already_taken
+          expect { Base.new(node_name) }.to_not raise_error
+          expect { Base.new(node_name) }.to raise_error(Errors::NodeExistsError)
         end
       end
 
@@ -45,9 +54,9 @@ describe Base do
       describe :instances do
         it "retrieves all @@instances" do
           Base.purge_instances!
-          objects = %w[first second last]
-          objects.each do |object_name|
-            Base.new(object_name)
+          nodes = %w[first second last]
+          nodes.each do |node_name|
+            Base.new(node_name)
           end
 
           Base.instances.should have(3).items
@@ -57,32 +66,32 @@ describe Base do
       describe :delete_instance do
         before do
           Base.purge_instances!
-          @object_names = %w[first second last]
-          @objects = @object_names.inject([]) do |store, object_name|
-            store << Base.new(object_name)
+          @node_names = %w[first second last]
+          @nodes = @node_names.inject([]) do |store, node_name|
+            store << Base.new(node_name)
             store
           end
         end
 
-        it "removes an instance by name from store" do
-          Base.delete_instance(@object_names.first)
-          Base.instances.should_not include(@objects.first)
+        it "removes an node by name from store" do
+          Base.delete_instance(@node_names.first)
+          Base.instances.should_not include(@nodes.first)
         end
 
-        it "removes an instance by object from store" do
-          Base.delete_instance(@objects.first)
-          Base.instances.should_not include(@objects.first)
+        it "removes an node by instance from store" do
+          Base.delete_instance(@nodes.first)
+          Base.instances.should_not include(@nodes.first)
         end
 
-        it "removes an instance by symbolized name from store" do
+        it "removes an node by symbolized name from store" do
           Base.purge_instances!
-          @object_names = %w[first second last].map(&:to_sym)
-          @objects = @object_names.inject([]) do |store, object_name|
-            store << Base.new(object_name)
+          @node_names = %w[first second last].map(&:to_sym)
+          @nodes = @node_names.inject([]) do |store, node_name|
+            store << Base.new(node_name)
             store
           end
-          Base.delete_instance(@object_names.first)
-          Base.instances.should_not include(@objects.first)
+          Base.delete_instance(@node_names.first)
+          Base.instances.should_not include(@nodes.first)
         end
 
       end
@@ -96,13 +105,14 @@ describe Base do
 
           Dir.mkdir(@tmp_path) unless File.exists?(@tmp_path)
 
-          example_content = "This is a dummy file!"
+          @example_content = "This is a dummy file!"
 
           @file_names = %w[file1 file2 file3]
 
           @file_names.each do |file_name|
             File.open("#{@tmp_path}/#{file_name}",'w') do |fh|
-              fh.puts example_content
+              fh.puts file_name
+              fh.puts @example_content
             end
           end
         end
@@ -115,14 +125,43 @@ describe Base do
         end
 
         describe :save_instances do
+          before do
+            @file_names2 = %w[file4 file5 file6]
+          end
+
+          after do
+            @file_names2.each do |file_name|
+              File.unlink("#{@tmp_path}/#{file_name}") if File.exists?("#{@tmp_path}/#{file_name}")
+            end
+          end
+
           it "writes all instances to disk" do
-            pending
+            @file_names2.each do |file_name|
+              node = Base.new("#{@tmp_path}/#{file_name}")
+              node.puts "content of file: #{file_name}"
+            end
+
+            Base.save_instances.should be_true
           end
         end
 
         describe :load_instances do
-          it "loads instances from disk" do
-            pending
+          it "loads an array of files" do
+            absolute_files = @file_names.inject([]) do |store, file_name|
+              store << "#{@tmp_path}/#{file_name}"
+            end
+            Base.load_instances absolute_files
+            Base.pool.should have(3).items
+          end
+
+          it "loads an array of files provided by Dir.glob" do
+            Base.load_instances Dir.glob(@tmp_path+"/**/*")
+            Base.pool.should have(3).items
+          end
+
+          it "loads files from a directory name (String)" do
+            Base.load_instances @tmp_path
+            Base.pool.should have(3).items
           end
         end
 
@@ -139,39 +178,69 @@ describe Base do
 
       context "without any args" do
         it "raises ArgumentError" do
-          expect { Base.open }.to raise_error(ArgumentError)
+          expect { Base.open }.to raise_error(::ArgumentError)
         end
       end
 
       context "with name only" do
 
-        context "and object does not exist" do
+        context "and node does not exist" do
           it "raises NodeNotFound error" do
-            Base.stub(:exists?).and_return(false)
-            expect { Base.open("foo bar") }.to raise_error(Base::NodeNotFoundError)
+            expect { Base.open("foo bar") }.to raise_error(Errors::NodeNotFoundError)
           end
         end
 
-        context "and object exists" do
-          it "returns the requested object" do
-            object_name = "foo bar"
-            object_cont = "demo content of object"
-            object_mock = double(Base, :object_name => object_name, :container => object_cont)
+        context "and node exists" do
+          it "returns the requested node" do
+            node_name = "foo bar"
+            stored_obj  = Base.new(node_name)
 
-            Base.should_receive(:exists?).with(object_name).and_return(true)
-            Base.should_receive(:load).and_return(object_mock)
+            ios = Base.open(node_name)
+            ios.should === stored_obj
+          end
 
-            ios = Base.open(object_name)
+          it "always reopens node for writing (and reading)" do
+            node_name = :always_reopenable
+            node = Base.new(node_name)
+            node.close
 
-            ios.object_name.should == object_name
-            ios.container.should == object_cont
+            node.should be_closed
+            Base.open(node_name).should_not be_closed
           end
         end
       end
 
       context "with name and block" do
-        it "opens object, yields the block and closes object" do
-          pending
+        it "opens node, yields the block and closes node for writing" do
+          str      = "string set in block"
+          origin   = Base.new(:blocktest)
+
+          open_obj = Base.open :blocktest do |handle|
+            handle.write str
+          end
+
+          open_obj.should      === origin
+          origin.string.should === str
+          origin.should        be_closed_write
+          origin.should_not    be_closed_read
+          expect { origin.write 'foo' }.to raise_error(IOError)
+        end
+
+        it "can reopen an node for manipulation" do
+          str       = "string set in block"
+          other_str = "new string"
+          origin    = Base.new(:blocktest)
+
+          Base.open :blocktest do |handle|
+            handle.write str
+          end
+
+          expect do
+            Base.open :blocktest do |handle|
+              handle.puts other_str
+            end
+          end.to_not raise_error
+          Base.open(:blocktest).string.should match(other_str)
         end
       end
 
@@ -181,41 +250,62 @@ describe Base do
 
   describe "Instance Methods" do
 
-    describe "StringIO method wrapper" do
-      method_list = %w[
+    before do
+      Base.purge_instances!
+    end
+
+    describe "StringIO method wrapper (for: #{RUBY_VERSION})" do
+      m18 = %w[
         binmode bytes
-        chars close close_read close_write closed? closed_read? closed_write? codepoints
-        each each_byte each_char each_codepoint each_line
+        chars close close_read close_write closed? closed_read? closed_write?
+        each each_byte each_char each_line
         eof eof?
-        external_encoding
         fcntl fileno flush fsync
         getbyte getc gets
-        internal_encoding isatty
+        isatty
         length lineno lineno= lines
         pid pos pos= print printf putc puts
-        read read_nonblock readbyte readchar readline readlines readpartial
+        read readbyte readchar readline readlines
         reopen rewind
-        seek set_encoding size string string= sync sync= sysread syswrite
+        seek size string string= sync sync= sysread syswrite
         tell truncate tty?
-        ungetbyte ungetc
-        write write_nonblock
+        ungetc
+        write
       ]
+      m19_additionals = %w[
+        codepoints
+        each_codepoint
+        external_encoding
+        internal_encoding
+        read_nonblock
+        readpartial
+        set_encoding
+        ungetbyte
+        write_nonblock
+      ]
+      method_list = RUBY_VERSION =~ /^1\.8\./ ? m18 : (m18 + m19_additionals)
+
       method_list.each do |method_name|
         it "- responds to ##{method_name}" do
-          Base.new.should respond_to(method_name)
+          Base.new(:string_io_test).should respond_to(method_name)
         end
       end
     end
 
     describe "method stub with #not_yet_implemented! call" do
       it "raises NotYetImplemented" do
-        ios = Base.new
+        ios = Base.new(:not_implemented)
         ios.instance_eval do
-          def not_implemented_method
+          def not_implemented_method_a
+            not_yet_implemented!
+          end
+          def not_implemented_method_b
             not_yet_implemented! __method__, "#{__FILE__}:#{__LINE__}"
           end
         end
-        expect { ios.not_implemented_method }.to raise_error(Base::NotYetImplemented)
+        expect { ios.not_implemented_method_a }.to raise_error(Errors::NotYetImplemented)
+        expect { ios.not_implemented_method_b }.to raise_error(Errors::NotYetImplemented)
+        expect { ios.not_implemented_method_c }.to raise_error(Errors::NotYetImplemented)
       end
     end
 
@@ -230,7 +320,7 @@ describe Base do
 
         Dir.mkdir(@tmp_path) unless File.exists?(@tmp_path)
         f = File.new(@tmp_true_file,'w')
-        f.puts("true content")
+        f.puts "true content"
         f.close
       end
 
@@ -280,7 +370,7 @@ describe Base do
         context "file does not exist" do
           it "raises FileNotFoundError" do
             ios = Base.new(@tmp_false_file)
-            expect { ios.load_from_file }.to raise_error(Base::FileNotFoundError)
+            expect { ios.load_from_file }.to raise_error(Errors::FileNotFoundError)
           end
         end
 
@@ -292,7 +382,7 @@ describe Base do
           context "with container name as default" do
             it "writes container into the file" do
               ios = Base.new(@tmp_save_file)
-              ios.puts = "Test string"
+              ios.puts "Test string"
               ios.save_to_file.should be_true
             end
           end
@@ -300,7 +390,7 @@ describe Base do
           context "with custom name" do
             it "writes container into the file" do
               ios = Base.new(:different_name)
-              ios.puts = "Test string"
+              ios.puts "Test string"
               ios.save_to_file(@tmp_save_file).should be_true
             end
           end
@@ -310,8 +400,8 @@ describe Base do
         context "path not accessible" do
           it "raises FileAccessError with corresponding reason" do
             ios = Base.new(@denied_path)
-            ios.puts = "Test string"
-            expect { ios.save_to_file }.to raise_error(Base::FileAccessError, /Reason/)
+            ios.puts "Test string"
+            expect { ios.save_to_file }.to raise_error(Errors::FileAccessError, /Reason/)
           end
         end