Module: Xampl

Included in:
XamplGenerator
Defined in:
lib/xamplr.rb,
lib/xamplr/mixins.rb,
lib/xamplr/to-xml.rb,
lib/xamplr/to-ruby.rb,
lib/xamplr/version.rb,
lib/xamplr/visitor.rb,
lib/xamplr/from-xml.rb,
lib/xamplr/visitors.rb,
lib/xamplr/xml-text.rb,
lib/xamplr-generator.rb,
lib/xamplr/persister.rb,
lib/xamplr/exceptions.rb,
lib/xamplr/persistence.rb,
lib/xamplr/xampl-module.rb,
lib/xamplr/xampl-object.rb,
lib/xamplr/from-xml-orig.rb,
lib/xamplr/notifications.rb,
lib/xamplr/obsolete/fsdb.rb,
lib/xamplr/persist-to-xml.rb,
lib/xamplr/persisters/caches.rb,
lib/xamplr/persisters/simple.rb,
lib/xamplr/persisters/caching.rb,
lib/xamplr/persisters/in-memory.rb,
lib/xamplr/persisters/filesystem.rb,
lib/xamplr/xampl-object-internals.rb,
lib/xamplr/xampl-persisted-object.rb,
lib/xamplr/persisters/tokyo-cabinet.rb

Defined Under Namespace

Modules: InvalidXampl, XamplExtensionsToRubyObjects, XamplObject, XamplPersistedObject, XamplWithDataContent, XamplWithMixedContent, XamplWithSimpleContent, XamplWithoutContent Classes: AbstractCachingPersister, AlreadyKnownToPersister, BlockedChange, CopyXML, CountingVisitor, FSDBPersister, FilesystemPersister, FromXML, FromXML_original, InMemoryPersister, IncompatiblePersisterRequest, MarkChangedDeep, MixedPersisters, NoActivePersister, PersistXML, Persister, PrettyXML, ResetIsChanged, RubyPrinter, SimplePersister, TableQuery, TokyoCabinetPersister, UnmanagedChange, Version, Visitor, XMLPrinter, XMLText, XamplCache, XamplCacheLFU, XamplException, XamplIsInvalid, XamplLiteralRubyObject

Constant Summary collapse

DEFAULT_CAPACITY =

TODO – this is way too big! TODO – FIX THIS PROBLEM

increase the default cache size to 2000 (which is way too big, but there is
a bug... removing from the cache does not remove from memory, so if a
storybook exists that points (even indirectly) at something flushed, the
thing flushed is still held in memory. What is needed is for the thing to
be invalidated somehow withought DUPLICATES being created when the thing
is read again next time)

2000
@@logger = 
Logger.new(STDOUT)
@@persister = 
nil
@@known_persisters = 
{}
@@persister_kinds = 
{}
@@default_persister_kind = 
:simple
@@default_persister_format = 
:xml_format
@@xampl_lock = 
Sync.new
@@verbose_transactions = 
true
@@xampl_extends_symbols = 
false

Class Method Summary collapse

Class Method Details

.auto_cache(xampl) ⇒ Object 



313
314
315
316
317
318
319
320
 
# File 'lib/xamplr/persistence.rb', line 313

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

.auto_persistence(on = true) ⇒ Object 



20
21
22
23
24
 
# File 'lib/xamplr/persistence.rb', line 20

def Xampl.auto_persistence(on=true)
  if (@@persister) then
    @@persister.automatic = on
  end
end

.auto_uncache(xampl) ⇒ Object 



322
323
324
325
326
 
# File 'lib/xamplr/persistence.rb', line 322

def Xampl.auto_uncache(xampl)
  if xampl.persister and xampl.persister.automatic then
    xampl.persister.uncache(xampl)
  end
end

.block_future_changes(on = true) ⇒ Object 



14
15
16
17
18
 
# File 'lib/xamplr/persistence.rb', line 14

def Xampl.block_future_changes(on=true)
  if (@@persister) then
    @@persister.block_changes = on
  end
end

.cache(xampl) ⇒ Object 



389
390
391
 
# File 'lib/xamplr/persistence.rb', line 389

def Xampl.cache(xampl)
  @@persister.cache(xampl)
end

.clear_cache ⇒ Object

Raises:



328
329
330
331
 
# File 'lib/xamplr/persistence.rb', line 328

def Xampl.clear_cache
  raise NoActivePersister unless @@persister
  @@persister.clear_cache
end

.close_all_persisters ⇒ Object 



347
348
349
350
351
 
# File 'lib/xamplr/persistence.rb', line 347

def Xampl.close_all_persisters
  @@known_persisters.each do | name, persister |
    persister.close
  end
end

.count_changed ⇒ Object 



305
306
307
 
# File 'lib/xamplr/persistence.rb', line 305

def Xampl.count_changed
  @@persister.count_changed if @@persister
end

.default_persister_format ⇒ Object 



51
52
53
 
# File 'lib/xamplr/persistence.rb', line 51

def Xampl.default_persister_format
  @@default_persister_format
end

.default_persister_kind ⇒ Object 



43
44
45
 
# File 'lib/xamplr/persistence.rb', line 43

def Xampl.default_persister_kind
  @@default_persister_kind
end

.disable_all_persisters ⇒ Object 



30
31
32
33
34
 
# File 'lib/xamplr/persistence.rb', line 30

def Xampl.disable_all_persisters
  @@persister = nil
  @@known_persisters.each { | persister | persister.close}
  @@known_persisters = {}
end

.disable_persister ⇒ Object 



36
37
38
 
# File 'lib/xamplr/persistence.rb', line 36

def Xampl.disable_persister
  @@persister = nil
end

.drop_all_persisters(verbose = false) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/xamplr/persistence.rb', line 104

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

.drop_persister(name) ⇒ Object 



118
119
120
121
122
123
124
 
# File 'lib/xamplr/persistence.rb', line 118

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

.enable_persister(name, kind = nil, format = nil) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/xamplr/persistence.rb', line 59

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

.find_known(klass, pid) ⇒ Object

Raises:



379
380
381
382
383
 
# File 'lib/xamplr/persistence.rb', line 379

def Xampl.find_known(klass, pid)
  raise NoActivePersister unless @@persister
  xampl, ignore = @@persister.find_known(klass, pid)
  return xampl
end

.find_mentions_of(xampl) ⇒ Object

Raises:



516
517
518
519
 
# File 'lib/xamplr/persistence.rb', line 516

def Xampl.find_mentions_of(xampl)
  raise NoActivePersister unless @@persister
  @@persister.find_mentions_of(xampl)
end

.find_meta(hint = false) ⇒ Object

Raises:



506
507
508
509
 
# File 'lib/xamplr/persistence.rb', line 506

def Xampl.find_meta(hint=false)
  raise NoActivePersister unless @@persister
  @@persister.find_meta(hint) { | q | yield q }
end

.find_pids(hint = false) ⇒ Object

Raises:



511
512
513
514
 
# File 'lib/xamplr/persistence.rb', line 511

def Xampl.find_pids(hint=false)
  raise NoActivePersister unless @@persister
  @@persister.find_pids(hint) { | q | yield q }
end

.find_xampl(hint = false) ⇒ Object

Raises:



501
502
503
504
 
# File 'lib/xamplr/persistence.rb', line 501

def Xampl.find_xampl(hint=false)
  raise NoActivePersister unless @@persister
  @@persister.find_xampl(hint) { | q | yield q }
end

.flush_persister_caches ⇒ Object 



97
98
99
100
101
102
 
# File 'lib/xamplr/persistence.rb', line 97

def Xampl.flush_persister_caches
  Xampl.print_known_persisters
  @persister.close
  @@known_persisters.delete(@@persister.name)
  Xampl.print_known_persisters
end

.introduce_to_persister(xampl) ⇒ Object

Raises:



299
300
301
302
303
 
# File 'lib/xamplr/persistence.rb', line 299

def Xampl.introduce_to_persister(xampl)
  raise NoActivePersister unless @@persister

  @@persister.introduce(xampl)
end

.lazy_load(xampl) ⇒ Object

Raises:



362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/xamplr/persistence.rb', line 362

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

.log ⇒ Object 



13
14
15
 
# File 'lib/xamplr.rb', line 13

def Xampl.log
  return @@logger
end

.lookup(klass, pid) ⇒ Object

Raises:



374
375
376
377
 
# File 'lib/xamplr/persistence.rb', line 374

def Xampl.lookup(klass, pid)
  raise NoActivePersister unless @@persister
  @@persister.lookup(klass, pid)
end

.lookup_in_map(map, klass, pid) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/xamplr/persistence.rb', line 393

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

.make(klass, pid = nil) {|xampl| ... } ⇒ Object

Yields:

  • (xampl) 


5
6
7
8
9
10
 
# File 'lib/xamplr/mixins.rb', line 5

def Xampl.make(klass, pid=nil)
  xampl = klass.new
  xampl.set_the_index(pid) if nil != pid
  yield(xampl) if block_given?
  return xampl
end

.optimise(opts = {}) ⇒ Object

Raises:



485
486
487
488
489
 
# File 'lib/xamplr/persistence.rb', line 485

def Xampl.optimise(opts={})
  raise NoActivePersister unless @@persister

  @@persister.optimise(opts)
end

.persister ⇒ Object 



10
11
12
 
# File 'lib/xamplr/persistence.rb', line 10

def Xampl.persister
  @@persister
end

.print_known_persisters ⇒ Object 



91
92
93
94
95
 
# File 'lib/xamplr/persistence.rb', line 91

def Xampl.print_known_persisters
  puts "Known Persisters:: --------------------------"
  @@known_persisters.each { | n, k | puts "    #{n} #{k}" }
  puts "---------------------------------------------"
end

.print_stats ⇒ Object 



309
310
311
 
# File 'lib/xamplr/persistence.rb', line 309

def Xampl.print_stats
  @@persister.print_stats if @@persister
end

.query(hint = false) ⇒ Object

Raises:



496
497
498
499
 
# File 'lib/xamplr/persistence.rb', line 496

def Xampl.query(hint=false)
  raise NoActivePersister unless @@persister
  @@persister.query(hint) { | q | yield q }
end

.query_implemented ⇒ Object

Raises:



491
492
493
494
 
# File 'lib/xamplr/persistence.rb', line 491

def Xampl.query_implemented
  raise NoActivePersister unless @@persister
  @@persister.query_implemented
end

.read_only(target_persister) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/xamplr/persistence.rb', line 242

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

.read_only_transaction(thing, kind = nil, automatic = true, format = nil, &block) ⇒ Object 



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/xamplr/persistence.rb', line 183

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

.register_persister_kind(klass) ⇒ Object 



26
27
28
 
# File 'lib/xamplr/persistence.rb', line 26

def Xampl.register_persister_kind(klass)
  @@persister_kinds[klass.kind] = klass
end

.remove_from_map(map, xampl) ⇒ Object 



472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/xamplr/persistence.rb', line 472

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

.rollback(persister = @@persister) ⇒ Object

Raises:



353
354
355
356
 
# File 'lib/xamplr/persistence.rb', line 353

def Xampl.rollback(persister=@@persister)
  raise NoActivePersister unless @@persister
  persister.rollback_cleanup
end

.rollback_all ⇒ Object 



358
359
360
 
# File 'lib/xamplr/persistence.rb', line 358

def Xampl.rollback_all
  @@known_persisters.values.each { | persister | persister.rollback }
end

.set_default_persister_format(format) ⇒ Object 



54
55
56
57
 
# File 'lib/xamplr/persistence.rb', line 54

def Xampl.set_default_persister_format(format)
  @@default_persister_format = format
  #puts "SET FORMAT format: #{@@default_persister_format}, kind: #{@@default_persister_kind}"
end

.set_default_persister_kind(kind) ⇒ Object 



46
47
48
49
 
# File 'lib/xamplr/persistence.rb', line 46

def Xampl.set_default_persister_kind(kind)
  @@default_persister_kind = kind
  #puts "SET KIND format: #{@@default_persister_format}, kind: #{@@default_persister_kind}"
end

.store_in_cache(map, xampl, container) ⇒ Object 



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/xamplr/persistence.rb', line 440

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

.store_in_map(map, xampl) ⇒ Object 



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/xamplr/persistence.rb', line 408

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

.sync ⇒ Object

Raises:



333
334
335
336
337
 
# File 'lib/xamplr/persistence.rb', line 333

def Xampl.sync
  #raise XamplException.new(:live_across_rollback) if @@persister.rolled_back
  raise NoActivePersister unless @@persister
  @@persister.sync
end

.sync_all ⇒ Object 



343
344
345
 
# File 'lib/xamplr/persistence.rb', line 343

def Xampl.sync_all
  @@known_persisters.each{ | name, persister | persister.sync }
end

.transaction(thing, kind = nil, automatic = true, format = nil, &block) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/xamplr/persistence.rb', line 133

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

.verboseTransactions(v) ⇒ Object 



129
130
131
 
# File 'lib/xamplr/persistence.rb', line 129

def Xampl.verboseTransactions(v)
  @@verbose_transactions = v
end

.version(stream) ⇒ Object 



339
340
341
 
# File 'lib/xamplr/persistence.rb', line 339

def Xampl.version(stream)
  @@persister.version(stream) if nil != @@persister
end

.write_to_cache(xampl) ⇒ Object 



385
386
387
 
# File 'lib/xamplr/persistence.rb', line 385

def Xampl.write_to_cache(xampl)
  @@persister.write_to_cache(xampl)
end

.xampl_extends_symbols ⇒ Object 



9
10
11
 
# File 'lib/xamplr/xampl-module.rb', line 9

def Xampl.xampl_extends_symbols
  @@xampl_extends_symbols
end

.xampl_extends_symbols=(v) ⇒ Object 



13
14
15
16
17
18
19
 
# File 'lib/xamplr/xampl-module.rb', line 13

def Xampl.xampl_extends_symbols=(v)
  @@xampl_extends_symbols = v

  if @@xampl_extends_symbols then
    Symbol.module_eval("include XamplExtensionsToRubyObjects")
  end
end