strokedb 0.0.2.1 → 0.0.2.2

data/examples/todo.rb

@@ -0,0 +1,92 @@
+#! /usr/bin/env ruby
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require "strokedb"
+
+StrokeDB::Config.build :default => true, :base_path => '.todo.strokedb'
+
+
+TodoItem = StrokeDB::Meta.new do
+  def done!
+    self.done = true
+    save!
+  end
+  def to_s
+    status = done ? "X" : " "
+    "[#{status}] #{description}"
+  end
+end
+
+TodoList = StrokeDB::Meta.new do
+  has_many :items, :through => :todo_items
+
+  def to_s
+    s = "#{name}:\n"
+    items.each do |item|
+      s << "  #{item}\n"
+    end
+    s
+  end
+end
+
+
+def add_issue(prefix,description)
+  todo_list = TodoList.find_or_create(:name => prefix)
+  todo_item = TodoItem.find_or_create(:description => description, :done => false, :todo_list => todo_list)
+  list_issues
+end
+
+def complete_issue(prefix,description)
+  todo_list = TodoList.find_or_create(:name => prefix)
+  return unless todo_list
+  if item = todo_list.items.first(:description => description)
+    item.done!
+    list_issues
+  else 
+    puts "No such item found"
+  end
+end
+
+def list_issues
+  todo_lists = TodoList.find
+  return [] if todo_lists.empty?
+  todo_lists.each { |list| puts list }
+end
+
+def extract_prefix_item(str)
+  _, prefix, _, item = str.match(/(^\[(.*)\])?(.+)/).to_a
+  prefix ||= "[Main]"
+  prefix.gsub!(/(^\[|\]$)/,'')
+  item.lstrip!
+  [prefix,item]
+end
+
+if ARGV.empty?
+  if list_issues.empty?
+    puts "Type --help for program help"
+  end
+  exit
+end
+
+if ARGV.first.downcase == "--help"
+  puts %{
+    Usage: todo Do this                          Add item to 'Main' list
+           todo [project] Do that                Add item to 'project' list
+           todo -d Do this                       Complete item in 'Main' list
+           todo -d [project] Do that             Complete item in 'project' lis
+           todo                                  List all items
+           todo --help                           This help message
+  }
+  exit
+end
+
+unless ARGV.first.downcase == "-d"
+  prefix,item = extract_prefix_item(ARGV.join(' '))
+  add_issue(prefix,item)
+else
+  args = ARGV
+  args.shift
+  prefix,item = extract_prefix_item(args.join(' '))
+  complete_issue(prefix,item)
+end
+
+

data/lib/strokedb.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+$LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift( File.expand_path(File.join(File.dirname(__FILE__), 'strokedb')) ).uniq!
+require 'strokedb/core_ext'
+require File.join(File.dirname(__FILE__), '/../vendor/rbmodexcl/rbmodexcl')
+require_one_of 'json', 'json_pure'
+
+require 'set'
+require 'fileutils'
+
+module StrokeDB
+  # Version:
+        MAIN = 0
+       MAJOR = 0
+       MINOR = 2
+  PATCHLEVEL = 2
+  
+  VERSION = [MAIN.to_s, MAJOR.to_s, MINOR.to_s, PATCHLEVEL.to_s].join('.')
+  VERSION_STRING = VERSION + (RUBY_PLATFORM =~ /java/ ? '-java' : '')
+  
+  # Coverage threshold - bump this float anytime your changes increase the spec coverage
+  # DO NOT LOWER THIS NUMBER. EVER.
+  COVERAGE = 92
+
+  # UUID regexp (like 1e3d02cc-0769-4bd8-9113-e033b246b013)
+  UUID_RE = /([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})/
+
+  # document version regexp
+  VERSION_RE = UUID_RE
+  
+  # XML Schema time format
+  # Time.now.xmlschema(6)
+  #    #=> "2008-04-27T23:39:09.920288+04:00"
+  # Time.xmlschema("2008-04-27T23:39:09.920288+04:00")
+  #    #=> Sun Apr 27 19:39:09 UTC 2008
+  XMLSCHEMA_TIME_RE = /\A\s*(-?\d+)-(\d\d)-(\d\d)T(\d\d):(\d\d):(\d\d)(\.\d*)?(Z|[+-]\d\d:\d\d)?\s*\z/i
+  
+  # STROKEDB NSURL
+  STROKEDB_NSURL = "http://strokedb.com/"
+  
+  # so called Nil UUID
+  NIL_UUID                      = "00000000-0000-0000-0000-000000000000"
+  RAW_NIL_UUID                  = "\x00" * 16
+  
+  RAW_FULL_UUID                 = "\xff" * 16
+
+
+  class <<self
+    def default_store
+      StrokeDB.default_config.stores[:default] rescue nil
+    end
+    def default_store=(store)
+      cfg = Config.new
+      cfg.stores[:default] = store
+      StrokeDB.default_config = cfg
+    end
+  end
+
+  if ENV['DEBUG'] || $DEBUG
+    def DEBUG
+      yield
+    end
+  else
+    def DEBUG
+    end
+  end
+
+  OPTIMIZATIONS = []
+  OPTIMIZATIONS << :C    unless RUBY_PLATFORM =~ /java/
+  OPTIMIZATIONS << :Java if     RUBY_PLATFORM =~ /java/
+
+  class NoDefaultStoreError < Exception ; end
+end
+
+require 'strokedb/nsurl'
+require 'strokedb/util'
+require 'strokedb/document'
+require 'strokedb/config'
+require 'strokedb/data_structures'
+require 'strokedb/volumes'
+require 'strokedb/sync'
+require 'strokedb/index'
+require 'strokedb/view'
+require 'strokedb/transaction'
+require 'strokedb/stores'

data/lib/{config → strokedb}/config.rb

@@ -33,7 +33,7 @@ module StrokeDB
       opts = opts.stringify_keys
       
       config = new(opts['default'])
-      storages = opts['storages'] || [:memory_chunk, :file_chunk]
+      storages = opts['storages'] || [:memory, :file]
 
       base_path = opts['base_path'] || './'
 
@@ -58,8 +58,8 @@ module StrokeDB
 
       config.add_index(:default, opts['index'] || :inverted_list, index_storages.first)
 
-      config.add_store(:default, opts['store'] || :skiplist, 
-                       { :storage => storages.first }.merge(opts['store_options'] || {}))
+      config.add_store(:default, opts['store'], # FIXME: nil here is a Bad Thing (tm) 
+                       { :storage => storages.first, :path => base_path }.merge(opts['store_options'] || {}))
 
       ### save config ###
 
@@ -106,13 +106,14 @@ module StrokeDB
     end
     
     def add_store(key, type, options = {})
+      
       options[:storage] = @storages[options[:storage] || :default]
       raise "Missing storage for store #{key}" unless options[:storage]
-
+      
       options[:index] ||= @indexes[options[:index] || :default]
-
+      
       store_instance = constantize(:store, type).new(options)
-
+      
       if options[:index]
         options[:index].document_store = store_instance
       end
@@ -120,6 +121,10 @@ module StrokeDB
       @stores[key] = store_instance
     end
     
+    def inspect
+      "#<StrokeDB::Config:0x#{object_id.to_s(16)}>"
+    end
+    
     private
     
     def constantize(name,type)
@@ -134,9 +139,9 @@ module StrokeDB
     end
   end
   
-  class <<self
+  class << self
     def use_perthread_default_config!
-      class <<self
+      class << self
         def default_config
           Thread.current['StrokeDB.default_config']
         end
@@ -146,7 +151,7 @@ module StrokeDB
       end
     end
     def use_global_default_config!
-      class <<self
+      class << self
         def default_config
           $strokedb_default_config
         end

data/lib/strokedb/console.rb

@@ -0,0 +1,87 @@
+require 'irb'
+require 'core_ext/string'
+
+
+module StrokeDB
+  
+  module Console
+    RAM_BASE_PATH = '.console-ram.strokedb'
+    
+    def self.included(klass)
+      klass.module_eval do
+        
+        def setup
+          if ARGV.last.is_a? String
+            if (@@loc = ARGV.pop) == 'RAM'
+              puts 'Using in-memory storage.'
+              FileUtils.rm_rf RAM_BASE_PATH
+              ::StrokeDB::Config.build :default => true, :storages => [:memory], :base_path => RAM_BASE_PATH
+            else
+              puts "Using #{@@loc} storage."
+              ::StrokeDB::Config.build :default => true, :base_path => @@loc
+            end
+          else
+            @@loc = '.console.strokedb'
+            ::StrokeDB::Config.build :default => true, :base_path => @@loc
+          end
+          @@store = ::StrokeDB::default_store
+          @@saved = false
+        end
+        
+        def save!
+          @@store.storage.sync_chained_storages!
+          @@saved = true
+          @@store
+        end
+        def saved?
+          @@saved
+        end
+
+        def clear!
+          if @@loc == 'RAM'
+            FileUtils.rm_rf RAM_BASE_PATH
+          else
+            FileUtils.rm_rf @@loc
+          end
+          setup
+          "Database has been wiped out."
+        end
+
+        def find(*args)
+          @@store.find(*args)
+        end
+
+        def store
+          @@store
+        end
+        
+        def sandbox?
+          @@sandbox
+        end
+        
+        def reload!
+          silence_warnings do
+            load "strokedb.rb"
+          end
+          StrokeDB
+        end
+        
+        def help!
+          puts ("
+            - save!           Save the console's store (by default, a file in your current directory named console.strokedb)
+            - clear!          Drop the console's store (destructive, and launches you out of the session)
+            - find <uuid>     Find document by UUID in the console's store (example: find 'a4430ff1-6cb4-4428-a292-7ab8b77de467')
+            - Doc             Alias for Document
+            - store           Alias for the console's store's object
+            ".unindent!)
+        end
+        
+      end
+      klass.send(:include, StrokeDB)
+      klass.send(:setup)
+      
+      puts "StrokeDB #{::StrokeDB::VERSION} (help! for more info)"
+    end # self.included
+  end # Console
+  Doc = Document
+end # StrokeDB

data/lib/strokedb/core_ext.rb

@@ -0,0 +1,10 @@
+require 'core_ext/kernel'
+require 'core_ext/object'
+require 'core_ext/string'
+require 'core_ext/symbol'
+require 'core_ext/enumerable'
+require 'core_ext/hash'
+require 'core_ext/fixnum'
+require 'core_ext/float'
+require 'core_ext/infinity'
+require 'core_ext/blank'

data/lib/{util/ext → strokedb/core_ext}/blank.rb

@@ -7,7 +7,7 @@ class Object
   # to
   #   if !address.blank?
   def blank?
-    respond_to?(:empty?) ? empty? : !self
+    respond_to?(:empty?) ? empty? : !truthy?
   end
 end
 

data/lib/strokedb/core_ext/float.rb

@@ -0,0 +1,4 @@
+class Float
+  ::Infinity = 1.0 / 0.0 unless defined? ::Infinity
+  ::NaN      = 0.0 / 0.0 unless defined? ::NaN
+end

data/lib/strokedb/core_ext/infinity.rb

@@ -0,0 +1,33 @@
+# These are for use in Range arguments for View#find.
+# We don't provide correct spaceship operator <=>
+# to preserve performance.
+#
+class Object
+  def infinite?
+    false
+  end
+end
+
+class Numeric
+  def infinite?
+    self.abs == Infinity
+  end
+end
+
+InfiniteString = Class.new(String) do
+  def infinite?
+    true
+  end
+end.new.freeze
+
+InfiniteTime = Class.new(Time) do
+  def infinite?
+    true
+  end
+end.new.freeze
+
+# Syntactic sugar: sweet aliases for daily use. 
+# For use like (SmallestString.."a") in View#find()
+#
+LargestString = SmallestString = StringInfinity = InfiniteString
+LargestTime   = SmallestTime   = TimeInfinity = InfiniteTime

data/lib/strokedb/core_ext/kernel.rb

@@ -0,0 +1,41 @@
+module Kernel
+  def require_one_of(*args)
+    if args.first.class == Array
+      args = args.first
+      original_args = args[1]
+    end
+    original_args ||= args
+    
+    begin
+      require args.shift
+    rescue LoadError
+      raise LoadError, "You need one of these gems: #{original_args.join(', ')}" if
+        args.empty?
+      require_one_of(args, original_args)
+    end
+    
+  end
+  
+  # Helps to extract arguments for an overloaded methods:
+  #   def some_method(*args)
+  #     store, name, options = extract(Store, String, Hash, args)
+  #   end
+  #
+  # This method tries to extract arguments according to their type.
+  # If the correct type is missing, var is set to nil.
+  # If some of the input arguments are not matched, ArgumentError is raised.
+  #
+  def extract(*template_and_args)
+    args = template_and_args.pop
+    result = []
+        
+    args.each do |a|
+      unless while t = template_and_args.shift
+        t === a and result.push a and break 1 or result.push nil
+        end
+        raise ArgumentError, "Unexpected argument #{a.inspect} is passed!"
+      end
+    end
+    result + template_and_args.map{ nil }
+  end
+end

data/lib/strokedb/core_ext/object.rb

@@ -0,0 +1,16 @@
+require 'inline'
+
+# partially extracted from ActiveRecord (http://rubyforge.org/projects/activesupport/)
+
+class Object
+  unless respond_to?(:send!)
+    # Anticipating Ruby 1.9 neutering send
+    alias send! send
+  end
+
+  # Tricky, tricky! (-:
+  def truthy?
+    !!self
+  end
+
+end