jsvd-blackboard 0.3.1 → 0.4.0

data/ChangeLog

@@ -1,3 +1,7 @@
+== 0.4.0 / 2009-03-08
+
+* Simpler interface for item and folder structure construction
+
 == 0.3.1 / 2009-03-01
 
 * Fixed moneta dependency (wycats-moneta)

data/README.rdoc

@@ -2,12 +2,12 @@
 == BlackBoard
 
 * BlackBoard provides a folder-layer to moneta.
-* BlackBoard aims for quickly writing and reading of data.
+* BlackBoard aims for quickly writing and reading data.
 * To be attached to EventMachine, for example.
 
 == Example
 
-# Objects written to the blackboard must answer to :timestamp, for they will expire.
+# Objects written to the blackboard must answer to :timestamp, since they'll expire.
 
   class TestObject
     attr_reader :timestamp
@@ -17,13 +17,14 @@
 # A BlackBoard is created with a static structure of folders and items.
 
   bb = BlackBoard.new :ttl => 2 do
-   folder :folder1, [:name1] do
-     folder :folder1, [:name1, :name2]
-     folder :folder2, [:name2]
-     folder :folder3, [:name2]
-   end
+    folder1 :name1 do
+      folder1 :name1, :name2
+      folder2 :name2
+      folder3 :name2, :ttl => 3
+    end
+  end
 
-# To write an item from a folder:
+# To write an item to a folder:
 
   obj = TestObject.new
   bb.folder1.folder1.name1 = obj
@@ -32,24 +33,21 @@
 
   obj = bb.folder1.folder1.name1
 
-# To retrive all items in a folder:
+# To retrieve all items in a folder:
 
   items = bb.folder1
   obj = items[:folder1][:name1]
 
 == Installation
 
-=== Archive Installation
-
-	rake install
-
 === Gem Installation
 
-	gem install blackboard
+	gem install jsvd-blackboard -s http://gems.github.com
 
 == Features/Problems
 
 * Broken #empty?
+* Unspecced Folder class since 0.4.0
 
 == Synopsis
 

data/blackboard.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
 	s.name              = "blackboard"
-	s.version           = "0.3.1"
+	s.version           = "0.4.0"
 	s.platform          = Gem::Platform::RUBY
 	s.has_rdoc          = true
 	s.summary           = ""

data/lib/blackboard.rb

@@ -14,6 +14,7 @@ class BlackBoard
     raise ArgumentError, "BlackBoard.new should not receive ttl bigger than #seconds in 30 days" if @ttl > 2592000
     @store = opts[:store] || Moneta::Memcache.new(:server => "127.0.0.1:11411")
     instance_eval(&block) unless block.nil?
+    instance_eval "def method_missing folder; raise BlackBoardError, \"Folder \#{folder} not found\"; end"
   end
 
   def has_folders?
@@ -24,60 +25,58 @@ class BlackBoard
     true
   end
 
-  def folder name, keys, args = {}, &block
-    raise BlackBoardError, "Folder #{name} already exists" if @folders.has_key?(name)
-    ttl = args[:ttl]
-    ttl ||= @ttl
-    instance_eval %Q{def #{name}; @folders[:#{name}]._update; @folders[:#{name}]; end}
-    @folders[name] = Folder.new name, keys, :cache => @store, :ttl => ttl, &block
-  end
-
   def clear
     @store.clear
   end
 
-  def method_missing folder
-    raise BlackBoardError, "Folder #{folder} not found"
+  def method_missing name, *args, &block
+
+    raise BlackBoardError, "Folder #{name} already exists" if @folders.has_key?(name)
+    instance_eval %Q{def #{name}; @folders[:#{name}]._update; @folders[:#{name}]; end}
+
+    options = args[-1].is_a?(Hash) ? args.delete_at(-1) : {}
+    options[:ttl] ||= @ttl
+    options[:store] ||= @store
+
+    @folders[name] = Folder.new name, args, options, &block
+
   end
 
   class Folder < Hash
 
-    def initialize name, children, args = {}, &block
+    def initialize name, items, options, &block
       @name = name
 
       @folders = []
-      @ttl = args[:ttl]
-      @store = args[:cache]
+      @ttl = options[:ttl]
+      @store = options[:store]
 
-      raise ArgumentError, "Folder.new should receive name, keys, cache and ttl" if @ttl.nil? || args[:cache].nil?
       raise ArgumentError, "Folder.new should not receive ttl bigger than #seconds in 30 days" if @ttl > 2592000
 
-      create_children children
+      create_children items 
 
       instance_eval(&block) unless block.nil?
-
+      instance_eval "def method_missing folder; raise BlackBoardError, \"Folder \#{folder} not found\"; end"
     end
 
-    def method_missing folder
-      raise BlackBoardError, "Folder #{folder} not found"
+    def method_missing name, *args, &block
+
+      raise BlackBoardError, "Folder #{name} already exists" if @folders.include?(name)
+      instance_eval %Q{def #{name}; self[:#{name}]._update; self[:#{name}]; end}
+
+      options = args[-1].is_a?(Hash) ? args.delete_at(-1) : {}
+      options[:ttl] ||= @ttl
+      options[:store] ||= @store
+
+      self[name] = Folder.new "#{@name}.#{name}", args, options, &block
+
     end
 
     def _update
       @items.keys.each do |k|
         self[k] = get k
       end
-      @folders.each {|f| self[f]._update }
-    end
-
-    private
-    def folder name, keys, args = {}, &block
-      raise BlackBoardError, "Folder #{name} already exists" if self.has_key?(name)
-      ttl = args[:ttl]
-      ttl ||= @ttl
-      @folders << name
-      self[name] = Folder.new "#{@name}.#{name}", keys, :cache => @store, :ttl => ttl, &block
-      instance_eval %Q{def #{name}; self[:#{name}]._update ;self[:#{name}]; end}
-
+      @folders.each {|f| ; self[f]._update }
     end
 
     def create_children children

data/spec/blackboard_spec.rb

@@ -81,7 +81,7 @@ describe BlackBoard do
   before :all do
     `memcached -d -p 11411 -P /tmp/memcached-test.pid`
     @blackboard = BlackBoard.new :ttl => 2 do
-      folder :folder1, [:name1, :name2]
+      folder1 :name1, :name2
     end
   end
 
@@ -104,7 +104,7 @@ describe BlackBoard do
 
     it "should have folders after adding one" do
       bb = BlackBoard.new do
-        folder :folder1, [:name1, :name2]
+        folder1 :name1, :name2
       end
       bb.should have_folders
       bb.folders.keys.should include(:folder1)
@@ -129,8 +129,8 @@ describe BlackBoard do
     
     before :all do
       @blackboard = BlackBoard.new :ttl => 2 do
-        folder :folder1, [:name1, :name2, :name3]
-        folder :folder2, [:name4, :name5, :name6]
+        folder1 :name1, :name2, :name3
+        folder2 :name4, :name5, :name6
       end
       @blackboard.folders.keys.should include(:folder1)
     end
@@ -231,8 +231,8 @@ describe BlackBoard do
 
       lambda { 
         @blackboard = BlackBoard.new :ttl => 2 do
-          folder :folder1, [:name1, :name2, :name3] do
-            folder :folder2, [:name4, :name5]
+          folder1 :name1, :name2, :name3 do
+            folder2 :name4, :name5
           end
         end
       }.should_not raise_error
@@ -244,8 +244,8 @@ describe BlackBoard do
     it "should be possible to write to a subfolder" do
 
       @blackboard = BlackBoard.new :ttl => 2 do
-        folder :folder1, [:name1, :name2, :name3] do
-          folder :folder2, [:name4, :name5]
+        folder1 :name1, :name2, :name3 do
+          folder2 :name4, :name5
         end
       end
 
@@ -267,8 +267,8 @@ describe BlackBoard do
 
     it "should allow different ttl for subfolders" do
       @blackboard = BlackBoard.new :ttl => 2 do
-        folder :folder1, [:name1], :ttl => 1
-        folder :folder2, [:name2], :ttl => 2
+        folder1 :name1, :ttl => 1
+        folder2 :name2, :ttl => 2
       end
       obj = TestObject.new 
       obj.color = :green
@@ -286,8 +286,8 @@ describe BlackBoard do
 
     it "should allow different ttl between folder and subfolder" do
       @blackboard = BlackBoard.new :ttl => 2 do
-        folder :folder1, [:name1], :ttl => 1 do
-          folder :folder2, [:name2], :ttl => 2
+        folder1 :name1, :ttl => 1 do
+          folder2 :name2, :ttl => 2
         end
       end
       obj = TestObject.new 
@@ -307,8 +307,8 @@ describe BlackBoard do
 
     it "should propagate tll to subfolders " do
       @blackboard = BlackBoard.new :ttl => 2 do
-        folder :folder1, [:name1], :ttl => 1 do
-          folder :folder2, [:name2]
+        folder1 :name1, :ttl => 1 do
+          folder2 :name2
         end
       end
       obj = TestObject.new 
@@ -328,8 +328,8 @@ describe BlackBoard do
 
     it "should support writing to two elements with same name on different folders" do
       @blackboard = BlackBoard.new :ttl => 10 do
-        folder :folder1, [:name1]
-        folder :folder2, [:name1]
+        folder1 :name1
+        folder2 :name1
       end
       obj = TestObject.new 
       obj.color = :green
@@ -344,12 +344,12 @@ describe BlackBoard do
 
     it "should not complain when creating sub sub folders" do
       lambda { @blackboard = BlackBoard.new :ttl => 10 do
-        folder :folder1, [:name1] do
-          folder :folder1, [:name1] do
-            folder :folder1, [:name1] do
-              folder :folder1, [:name1] do
-                folder :folder1, [:name1] do
-                  folder :folder1, [:name1]
+        folder1 :name1 do
+          folder1 :name1 do
+            folder1 :name1 do
+              folder1 :name1 do
+                folder1 :name1 do
+                  folder1 :name1
                 end
               end
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsvd-blackboard
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - "Jo\xC3\xA3o Duarte"