xamplr 1.2.0

data/lib/xamplr/notifications.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+
+module Xampl
+  module XamplObject
+
+    # add text (while loading from XML)
+    #   xml_text -- the text
+    #   realising -- true when loading from a persister
+    def note_adding_text_content(xml_text, realising)
+      return xml_text
+    end
+
+    # these are the arrays of attribute information about to be used to
+    # initialise the attributes
+
+    def note_initialise_attributes_with(names, namespaces, values, realising)
+    end
+
+    # attributes are setup up (while loading from XML)
+
+    def note_attributes_initialised(realising)
+    end
+
+    # just created
+
+    def note_created(realising)
+    end
+
+    # about to be added to a parent
+
+    def note_add_to_parent(parent, realising)
+      return self
+    end
+
+    # about to be added to a parent
+
+    def note_add_child(child, realising)
+      return child
+    end
+
+    # this element has been completed
+
+    def note_closed(realising)
+      return self
+    end
+
+    # replacing the original
+
+    def note_replacing(original)
+    end
+
+    # about to be invalidated
+
+    def note_invalidate
+    end
+  end
+end

data/lib/xamplr/obsolete/fsdb.rb

@@ -0,0 +1,62 @@
+module Xampl
+
+  require "fileutils"
+  require "fsdb"
+  require "xamplr/persister/caching"
+
+  class FSDBPersister < AbstractCachingPersister
+
+    def initialize(name=nil, format=nil, root=File.join(".", "repo-fsdb"))
+      super(root, name, format)
+
+      @db = FSDB::Database[@root_dir]
+      @db_lock = "lock"
+      @db[@db_lock] = @db_lock
+    end
+
+    def FSDBPersister.kind
+      :fsdb
+    end
+
+    def kind
+      FSDBPersister.kind
+    end
+
+    def rollback_cleanup
+      super
+      @db.clear_cache
+    end
+
+    def do_sync_write
+      @db.edit(@db_lock){ | lock |
+        @changed.each { | xampl, ignore | write(xampl) }
+      }
+    end
+
+    def place_name(klass, id, type=".txt")
+      place = File.join(klass.name.split("::"), "#{id}#{type}")
+      return place
+    end
+
+    def write(xampl)
+      raise XamplException.new(:no_index_so_no_persist) unless xampl.get_the_index
+      #return false unless xampl.get_the_index
+
+      place = place_name(xampl.class, xampl.get_the_index)
+      @db[place] = represent(xampl)
+
+      @write_count = @write_count + 1
+      xampl.changes_accepted
+      return true
+    end
+
+    def read_representation(klass, pid)
+      place = place_name(klass, pid)
+      representation = @db.edit(@db_lock){ | lock | @db[place] }
+      return representation
+    end
+  end
+
+  Xampl.register_persister_kind(FSDBPersister)
+end
+

data/lib/xamplr/persist-to-xml.rb

@@ -0,0 +1,249 @@
+require 'libxml'
+
+module Xampl
+
+  class PersistXML < Visitor
+    attr_accessor :ns_to_prefix, :start_body, :body, :out, :mentions
+
+    def initialize(out="", mentions=nil)
+      super()
+
+      @out = out
+      @was_attr = false
+
+      @mentions = mentions
+
+      @ns_to_prefix = {}
+      @start_body = nil
+      @body = ""
+      @attr_list = nil
+    end
+
+    def cycle(xampl)
+      raise XamplException.new(:cycle_detected_in_xampl_cluster) unless xampl.kind_of?(XamplPersistedObject)
+      return true
+    end
+
+    def revisit(xampl)
+      return true
+    end
+
+    def register_ns(ns)
+      if (0 == ns.length) then
+        return ""
+      end
+
+      prefix = ns_to_prefix[ns]
+      if (nil == prefix) then
+        preferred = XamplObject.lookup_preferred_ns_prefix(ns)
+        prefix = "" << preferred << ":" if preferred
+        prefix = "ns" << ns_to_prefix.size.to_s << ":" unless prefix
+        ns_to_prefix[ns] = prefix
+      end
+      return prefix
+    end
+
+    def attr_esc(s)
+      unless defined?(@@doc) then
+        @@doc = LibXML::XML::Document.new()
+        @@doc.root = LibXML::XML::Node.new('r')
+        @@attr = LibXML::XML::Attr.new(@@doc.root, 'v', 'v')
+      end
+
+      @@attr.value = s.to_s
+      (@@doc.root.to_s)[6..-4]
+    end
+
+
+=begin
+
+    def attr_esc_old(s)
+      if (s.kind_of? XamplObject)
+        return attr_esc(s.to_xml)
+      end
+
+#      stupid_test()
+
+      result = s.to_s.dup
+
+      result.gsub!("&", "&amp;")
+      result.gsub!("<", "&lt;")
+      result.gsub!(">", "&gt;")
+      result.gsub!("'", "&apos;")
+      result.gsub!("\"", "&quot;")
+
+      return result
+    end
+
+=end
+
+
+#    def content_esc(s)
+#      #NO! the attribute has the right to compact white space
+#      unless defined?(@@doc) then
+#        @@doc = LibXML::XML::Document.new()
+#        @@doc.root = LibXML::XML::Node.new('r')
+#        @@attr = LibXML::XML::Attr.new(@@doc.root, 'v', 'v')
+#      end
+#
+#      @@attr.value = s
+#      (@@doc.root.to_s)[6..-4]
+#    end
+
+    #TODO -- use libxml for this too
+    def content_esc(s)
+      result = s.to_s.dup
+
+      return result if (s.kind_of? XamplObject)
+
+      result.gsub!("&", "&amp;")
+      result.gsub!("<", "&lt;")
+
+      return result
+    end
+
+    def attribute(xampl)
+      @attr_list = []
+      if (nil != xampl.attributes) then
+        xampl.attributes.each do |attr_spec|
+          prefix = (2 < attr_spec.length) ? register_ns(attr_spec[2]) : ""
+          value = xampl.instance_variable_get(attr_spec[0])
+#          @attr_list << (" " << prefix << attr_spec[1] << "='" << attr_esc(value) << "'") unless nil == value
+          @attr_list << (" " << prefix << attr_spec[1] << '="' << attr_esc(value) << '"') unless nil == value
+        end
+      end
+    end
+
+    def persist_attribute(xampl)
+      @attr_list = []
+      pattr = xampl.indexed_by.to_s
+      if (nil != xampl.attributes) then
+        xampl.attributes.each do |attr_spec|
+          if pattr == attr_spec[1] then
+            prefix = (2 < attr_spec.length) ? register_ns(attr_spec[2]) : ""
+            value = xampl.instance_variable_get(attr_spec[0])
+#            @attr_list << (" " << prefix << attr_spec[1] << "='" << attr_esc(value) << "'") unless nil == value
+            @attr_list << (" " << prefix << attr_spec[1] << '="' << attr_esc(value) << '"') unless nil == value
+            break
+          end
+        end
+      end
+    end
+
+    def show_attributes
+      result = @attr_list.join(" ")
+      if (0 == result.length) then
+        return ""
+      else
+        return result
+      end
+    end
+
+    def start_element(xampl)
+      tag = xampl.tag
+      ns = xampl.ns
+      tag_info = "" << "<" << register_ns(ns) << tag
+      unless @start_body then
+        attribute(xampl)
+        attr_defn = show_attributes
+        @start_body = "" << tag_info << attr_defn
+        @was_attr = true if 0 < attr_defn.size
+      else
+        if xampl.persist_required then
+          @mentions << xampl if @mentions
+          @no_children = true
+          persist_attribute(xampl)
+        else
+          attribute(xampl)
+        end
+        @body << tag_info << show_attributes
+      end
+    end
+
+    def end_element(xampl)
+      tag = xampl.tag
+      ns = xampl.ns
+      @body << "</" << register_ns(ns) << tag << ">"
+    end
+
+    def define_ns
+      result = ""
+      ns_to_prefix.each do |ns, prefix|
+#        result = sprintf("%s xmlns:%s='%s'", result, prefix[0..-2], ns)
+        result = sprintf("%s xmlns:%s=\"%s\"", result, prefix[0..-2], ns)
+      end
+      return result
+    end
+
+    def done
+      out << @start_body << define_ns << @body
+    end
+
+    def before_visit_without_content(xampl)
+      start_element(xampl)
+      @body << "/>"
+    end
+
+    def before_visit_simple_content(xampl)
+      start_element(xampl)
+      if @no_children then
+        @body << "/>"
+      else
+        @body << ">"
+        @body << content_esc(xampl._content) if xampl._content
+        end_element(xampl)
+      end
+    end
+
+    def before_visit_data_content(xampl)
+      start_element(xampl)
+      if @no_children then
+        @body << "/>"
+      else
+        @body << ">"
+        @body << content_esc(xampl._content) if xampl._content
+      end
+    end
+
+    def after_visit_data_content(xampl)
+      end_element(xampl) unless @no_children
+    end
+
+    def before_visit_mixed_content(xampl)
+      if @no_children then
+        @body << "/>"
+      else
+        start_element(xampl)
+        @body << ">"
+      end
+    end
+
+    def after_visit_mixed_content(xampl)
+      end_element(xampl) unless @no_children
+    end
+
+    def before_visit(xampl)
+      if xampl.respond_to? "before_visit_by_element_kind" then
+        xampl.before_visit_by_element_kind(self)
+      else
+        @body << xampl.to_s
+      end
+    end
+
+    def after_visit(xampl)
+      xampl.after_visit_by_element_kind(self) if xampl.respond_to? "after_visit_by_element_kind"
+    end
+
+    def visit_string(string)
+      @body << string
+    end
+  end
+
+  module XamplObject
+    def to_xml(out="", skip=[])
+      PersistXML.new(out).start(self).done
+    end
+  end
+
+end
+

data/lib/xamplr/persistence.rb

@@ -0,0 +1,522 @@
+
+require 'sync'
+
+module Xampl
+
+  @@persister = nil
+  @@known_persisters = {}
+  @@persister_kinds = {}
+
+  def Xampl.persister
+    @@persister
+  end
+
+  def Xampl.block_future_changes(on=true)
+    if (@@persister) then
+      @@persister.block_changes = on
+    end
+  end
+
+  def Xampl.auto_persistence(on=true)
+    if (@@persister) then
+      @@persister.automatic = on
+    end
+  end
+
+  def Xampl.register_persister_kind(klass)
+    @@persister_kinds[klass.kind] = klass
+  end
+
+  def Xampl.disable_all_persisters
+    @@persister = nil
+    @@known_persisters.each { | persister | persister.close}
+    @@known_persisters = {}
+  end
+
+  def Xampl.disable_persister
+    @@persister = nil
+  end
+
+  @@default_persister_kind = :simple
+  @@default_persister_format = :xml_format
+
+  def Xampl.default_persister_kind
+    @@default_persister_kind
+  end
+  def Xampl.set_default_persister_kind(kind)
+    @@default_persister_kind = kind
+    #puts "SET KIND format: #{@@default_persister_format}, kind: #{@@default_persister_kind}"
+  end
+
+  def Xampl.default_persister_format
+    @@default_persister_format
+  end
+  def Xampl.set_default_persister_format(format)
+    @@default_persister_format = format
+    #puts "SET FORMAT format: #{@@default_persister_format}, kind: #{@@default_persister_kind}"
+  end
+
+  def Xampl.enable_persister(name, kind=nil, format=nil)
+    kind = kind || @@default_persister_kind
+    format = format || @@default_persister_format
+    @@persister = @@known_persisters[name]
+
+    if @@persister then
+      #      @@persister.open # this won't work
+      # TODO -- if we know the persister, why are we being so anal about kind and format???
+
+      kind = @@persister.kind || kind
+      format = @@persister.format || format
+
+      #raise XamplException.new(:live_across_rollback) if @@persister.rolled_back
+      if kind and kind != @@persister.kind then
+        raise IncompatiblePersisterRequest.new(@@persister, "kind", kind, @@persister.kind)
+      end
+      if format and format != @@persister.format then
+        raise IncompatiblePersisterRequest.new(@@persister, "format", format, @@persister.format)
+      end
+    end
+
+    unless @@persister then
+      # puts "CREATE PERSISTER #{name}, format: #{format}, kind: #{kind}"
+      @@persister = @@persister_kinds[kind].new(name, format)
+      if (nil != name) then
+        @@known_persisters[name] = @@persister
+      end
+    end
+
+    @@persister
+  end
+
+  def Xampl.print_known_persisters
+    puts "Known Persisters:: --------------------------"
+    @@known_persisters.each { | n, k | puts "    #{n} #{k}" }
+    puts "---------------------------------------------"
+  end
+
+  def Xampl.flush_persister_caches
+    Xampl.print_known_persisters
+    @persister.close
+    @@known_persisters.delete(@@persister.name)
+    Xampl.print_known_persisters
+  end
+
+  def Xampl.drop_all_persisters(verbose=false)
+    puts "Drop All Persisters:: --------------------------" if verbose
+    @@known_persisters.each do |name, persister|
+      puts "    #{ name } #{ persister.class.name }" if verbose
+      next if persister == @@persister
+      persister.close
+      persister.clear_cache
+    end
+    puts "---------------------------------------------" if verbose
+    GC.start
+    GC.start
+    GC.start
+  end
+
+  def Xampl.drop_persister(name)
+    Xampl.print_known_persisters
+    p = @@known_persisters[name]
+    p.close if p
+    @@known_persisters.delete(name)
+    Xampl.print_known_persisters
+  end
+
+  @@xampl_lock = Sync.new
+
+  @@verbose_transactions = true
+  def Xampl.verboseTransactions(v)
+    @@verbose_transactions = v
+  end
+
+  def Xampl.transaction(thing, kind=nil, automatic=true, format=nil, &block)
+    if String === thing then
+      name = thing
+    elsif XamplObject === thing then
+      name = thing.persister.name
+    else
+      raise XamplException.new("can't base a transaction on a #{thing.class.name} (#{thing})")
+    end
+
+    if block_given? then
+      @@xampl_lock.synchronize(:EX) do
+        initial_persister = @@persister
+        Xampl.enable_persister(name, kind, format)
+
+        rollback = true
+        exception = nil
+        original_automatic = @@persister.automatic
+
+        begin
+          #TODO -- impose some rules on nested transactions/enable_persisters??
+
+          Xampl.auto_persistence(automatic)
+          result = yield
+          Xampl.block_future_changes(true)
+          Xampl.sync
+          rollback = false
+          return result
+        rescue => e
+          exception = e
+        ensure
+          Xampl.block_future_changes(false)
+          Xampl.auto_persistence(original_automatic)
+          if rollback then
+            if exception then
+              puts "ROLLBACK(#{__LINE__}):: #{exception}" if rollback and @@verbose_transactions
+              #print exception.backtrace.join("\n") if rollback
+              raise exception
+            else
+              if @@verbose_transactions and rollback then
+                puts "ROLLBACK(#{__LINE__}):: UNKNOWN CAUSE" if rollback
+              end
+            end
+          end
+          Xampl.rollback if rollback
+          @@persister = initial_persister
+        end
+      end
+    end
+  end
+
+  def Xampl.read_only_transaction(thing, kind=nil, automatic=true, format=nil, &block)
+    if String === thing then
+      name = thing
+    elsif XamplObject === thing then
+      name = thing.persister.name
+    else
+      raise XamplException.new("can't base a transaction on a #{thing.class.name} (#{thing})")
+    end
+
+    target_persister = nil
+    if block_given? then
+      @@xampl_lock.synchronize(:EX) do
+        initial_persister = @@persister
+        Xampl.enable_persister(name, kind, format)
+        target_persister = @@persister
+
+        rollback = true
+        original_automatic = @@persister.automatic
+        @changed ||= nil
+        original_changed = @changed
+        @changed = {}
+        begin
+          Xampl.auto_persistence(false)
+          #Xampl.block_future_changes(true)
+
+          yield
+          rollback = false
+        rescue => e
+          exception = e
+        ensure
+          Xampl.auto_persistence(original_automatic)
+          #Xampl.block_future_changes(false)
+
+          if 0 == @changed.size then
+            @changed = original_changed
+
+            if rollback then
+              puts "ROLLBACK(#{__LINE__}):: #{exception}"
+              print exception.backtrace.join("\n")
+              Xampl.rollback
+            end
+            @@persister = initial_persister
+          else
+            puts "CHANGED COUNT: #{@changed.size}"
+            @changed = original_changed
+
+            puts "ROLLBACK(#{__LINE__}) #{exception}" if rollback
+            print exception.backtrace.join("\n")
+            Xampl.rollback
+
+            @@persister = initial_persister
+
+            raise BlockedChange.new(target_persister)
+          end
+        end
+      end
+    end
+  end
+
+  def Xampl.read_only(target_persister)
+    #TODO -- EXCLUSIVE ACCESS TO THE PERSISTER!!!
+    name = target_persister.name
+
+    if block_given? then
+      initial_persister = @@persister
+      Xampl.enable_persister(name, target_persister.kind, target_persister.format)
+
+      rollback = true
+      original_automatic = @@persister.automatic
+      original_changed = @changed
+      @changed = {}
+      begin
+        Xampl.auto_persistence(false)
+        #Xampl.block_future_changes(true)
+
+        yield
+        rollback = false
+      ensure
+        ####        Xampl.auto_persistence(original_automatic)
+        ####        #Xampl.block_future_changes(false)
+        ####
+        ####        if 0 < @changed.size then
+        ####          puts "CHANGED COUNT: #{@changed.size}"
+        ####          raise BlockedChange.new(target_persister)
+        ####        end
+        ####
+        ####        @changed = original_changed
+        ####
+        ####        puts "ROLLBACK(#{__LINE__})" if rollback
+        ####			  Xampl.rollback if rollback
+        ####	      @@persister = initial_persister
+
+        Xampl.auto_persistence(original_automatic)
+        #Xampl.block_future_changes(false)
+
+        if 0 == @changed.size then
+          @changed = original_changed
+
+          puts "ROLLBACK(#{__LINE__})" if rollback
+          Xampl.rollback if rollback
+          @@persister = initial_persister
+        else
+          puts "CHANGED COUNT: #{@changed.size}"
+          @changed = original_changed
+
+          puts "ROLLBACK(#{__LINE__})" if rollback
+          Xampl.rollback
+
+          @@persister = initial_persister
+
+          raise BlockedChange.new(target_persister)
+        end
+      end
+    end
+  end
+
+  def Xampl.introduce_to_persister(xampl)
+    raise NoActivePersister unless @@persister
+
+    @@persister.introduce(xampl)
+  end
+
+  def Xampl.count_changed
+    @@persister.count_changed if @@persister
+  end
+
+  def Xampl.print_stats
+    @@persister.print_stats if @@persister
+  end
+
+  def Xampl.auto_cache(xampl)
+    if (nil == xampl.persister) and @@persister and @@persister.automatic then
+      xampl.persister = @@persister
+    end
+    if xampl.persister and xampl.persister.automatic then
+      xampl.persister.cache(xampl)
+    end
+  end
+
+  def Xampl.auto_uncache(xampl)
+    if xampl.persister and xampl.persister.automatic then
+      xampl.persister.uncache(xampl)
+    end
+  end
+
+  def Xampl.clear_cache
+    raise NoActivePersister unless @@persister
+    @@persister.clear_cache
+  end
+
+  def Xampl.sync
+    #raise XamplException.new(:live_across_rollback) if @@persister.rolled_back
+    raise NoActivePersister unless @@persister
+    @@persister.sync
+  end
+
+  def Xampl.version(stream)
+    @@persister.version(stream) if nil != @@persister
+  end
+
+  def Xampl.sync_all
+    @@known_persisters.each{ | name, persister | persister.sync }
+  end
+
+  def Xampl.close_all_persisters
+    @@known_persisters.each do | name, persister |
+      persister.close
+    end
+  end
+
+  def Xampl.rollback(persister=@@persister)
+    raise NoActivePersister unless @@persister
+    persister.rollback_cleanup
+  end
+
+  def Xampl.rollback_all
+    @@known_persisters.values.each { | persister | persister.rollback }
+  end
+
+  def Xampl.lazy_load(xampl)
+    raise NoActivePersister.new unless @@persister
+
+    pid = xampl.get_the_index
+    if xampl and pid then
+      @@persister.lazy_load(xampl, xampl.class, pid)
+      xampl.load_needed = false
+    else
+      raise "XAMPL.LAZY_LOAD -- REFUSED"
+    end
+  end
+
+  def Xampl.lookup(klass, pid)
+    raise NoActivePersister unless @@persister
+    @@persister.lookup(klass, pid)
+  end
+
+  def Xampl.find_known(klass, pid)
+    raise NoActivePersister unless @@persister
+    xampl, ignore = @@persister.find_known(klass, pid)
+    return xampl
+  end
+
+  def Xampl.write_to_cache(xampl)
+    @@persister.write_to_cache(xampl)
+  end
+
+  def Xampl.cache(xampl)
+    @@persister.cache(xampl)
+  end
+
+  def Xampl.lookup_in_map(map, klass, pid)
+    return nil if nil == pid
+
+    module_name = klass.module_name
+    tag = klass.tag
+
+    tag_map = map[module_name]
+    return nil if nil == tag_map
+
+    pid_map = tag_map[tag]
+    return nil if nil == pid_map
+
+    return pid_map[pid]
+  end
+
+  def Xampl.store_in_map(map, xampl)
+    module_name = xampl.module_name
+    tag = xampl.tag
+    pid = xampl.get_the_index
+
+    if nil == pid then
+      return false
+    end
+
+    if block_given? then
+      data = yield
+    else
+      data = xampl
+    end
+
+    tag_map = map[module_name]
+    if nil == tag_map then
+      tag_map = {}
+      map[module_name] = tag_map
+    end
+
+    pid_map = tag_map[tag]
+    if nil == pid_map then
+      pid_map = {}
+      tag_map[tag] = pid_map
+    end
+
+    pid_map[pid] = data
+
+    return true
+  end
+
+  def Xampl.store_in_cache(map, xampl, container)
+    module_name = xampl.module_name
+    tag = xampl.tag
+    pid = xampl.get_the_index
+
+    if nil == pid then
+      return false
+    end
+
+    if block_given? then
+      data = yield
+    else
+      data = xampl
+    end
+
+    tag_map = map[module_name]
+    if nil == tag_map then
+      tag_map = {}
+      map[module_name] = tag_map
+    end
+
+    pid_map = tag_map[tag]
+    if nil == pid_map then
+      pid_map = container.fresh_cache
+      tag_map[tag] = pid_map
+    end
+
+    pid_map[pid] = data
+
+    return true
+  end
+
+  def Xampl.remove_from_map(map, xampl)
+    pid = xampl.get_the_index
+    return nil unless pid
+
+    tag_map = map[xampl.module_name]
+    return nil unless tag_map
+
+    pid_map = tag_map[xampl.tag]
+    return nil unless pid_map
+
+    return pid_map.delete(pid)
+  end
+
+  def Xampl.optimise(opts={})
+    raise NoActivePersister unless @@persister
+
+    @@persister.optimise(opts)
+  end
+
+  def Xampl.query_implemented
+    raise NoActivePersister unless @@persister
+    @@persister.query_implemented
+  end
+
+  def Xampl.query(hint=false)
+    raise NoActivePersister unless @@persister
+    @@persister.query(hint) { | q | yield q }
+  end
+
+  def Xampl.find_xampl(hint=false)
+    raise NoActivePersister unless @@persister
+    @@persister.find_xampl(hint) { | q | yield q }
+  end
+
+  def Xampl.find_meta(hint=false)
+    raise NoActivePersister unless @@persister
+    @@persister.find_meta(hint) { | q | yield q }
+  end
+
+  def Xampl.find_pids(hint=false)
+    raise NoActivePersister unless @@persister
+    @@persister.find_pids(hint) { | q | yield q }
+  end
+
+  def Xampl.find_mentions_of(xampl)
+    raise NoActivePersister unless @@persister
+    @@persister.find_mentions_of(xampl)
+  end
+
+end
+