madeleine 0.8.0 → 0.9.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0254e4a5cd6fe35768ce76fb92b0804724a83663
+  data.tar.gz: cc5860e5c27def4543d104edc0ce30f0f6acf65a
+SHA512:
+  metadata.gz: e009aac28e96a06499feeff40c43156bc8dfa7139ae20588fc2c5eef88277868b77cbff63be153971b59230e956b35b91483783dd8983ce6e33a8837c301a343
+  data.tar.gz: c5c67ada967d93f9d280ade1304c07328b439acf4aa787e5c1441d68213394252c4bd8a1227a3f8485db46cfe98856969360b08e07fd896dcdc08ea87b4c65d2

data/CHANGES.txt

@@ -1,3 +1,5 @@
+    * Ruby 2.0 fix for self-tests.
+
 Madeleine 0.8.0 (December 17, 2012):
 
     * Ruby 1.9 compatible (requires at least 1.8.7)

data/README.md

@@ -0,0 +1,84 @@
+# Madeleine
+
+Madeleine is a Ruby implementation of transparent persistence of business
+objects, using command logging and complete system snapshots.
+
+https://github.com/ghostganz/madeleine
+
+### Usage
+
+```ruby
+require 'madeleine'
+
+# Create an application as a prevalent system
+
+madeleine = SnapshotMadeleine.new("my_example_storage") {
+  # Creating the initial empty system. This is how the application
+  # is bootstrapped on each startup (until the first snapshot is taken).
+  # All the persistent data needs to be reachable from this object.
+  # For this example, the application's whole dataset is a hash
+  # with a counter:
+  {:counter => 0}
+}
+
+# To operate on the system, we need commands. For this example,
+# we can do additions to our counter:
+class AdditionCommand
+  def initialize(number)
+    @number = number
+  end
+
+  def execute(system)
+    # This is the only place from where we're allowed to modify
+    # the system.
+    system[:counter] += @number
+  end
+end
+
+# Do modifications of the system by sending commands through
+# the Madeleine instance:
+
+command = AdditionCommand.new(12)
+madeleine.execute_command(command)
+
+# The commands are written to the command log before executed.
+# The next time the application starts, all the commands in the
+# log are re-applied to the system, returning it to the state it
+# had when it was shut down.
+
+# To avoid long start-up times when the command log gets large,
+# you can do occasional snapshots of the entire system. You must
+# also do a snapshot before deploying any changes in your application
+# logic.
+
+madeleine.take_snapshot
+```
+
+### Requirements
+
+* Ruby 1.8.7 or later
+
+### Contact
+
+Homepage: https://github.com/ghostganz/madeleine
+
+### License
+
+BSD (see the file ```COPYING```)
+
+### Credits
+
+Anders Bengtsson   -   Prevalence core impl.
+Stephen Sykes      -   Automatic commands impl.
+
+Madeleine's design is based on Prevayler, the original Java
+prevalence layer.
+
+With the help of patches, testing and feedback from:
+
+Steve Conover, David Heinemeier Hansson, Johan Lind, Håkan Råberg,
+IIMA Susumu, Martin Tampe and Jon Tirsén
+
+Thanks to Klaus Wuestefeld and the Prevayler developers for the
+model of this software; to Minero Aoki for the installer; to Matz and
+the core developers for the Ruby language!

data/lib/madeleine.rb

@@ -42,21 +42,32 @@ module Madeleine
     # See: DefaultSnapshotMadeleine
     #
     # * <tt>directory_name</tt> - Storage directory to use. Will be created if needed.
-    # * <tt>snapshot_marshaller</tt> - Marshaller to use for system snapshots. (Optional)
+    # * <tt>options</tt> - Options hash:
+    #      * <tt>:snapshot_marshaller</tt> - Marshaller to use for system snapshots (defaults to Marshal)
+    #      * <tt>:execution_context</tt> - Optional context to be passed to commands' execute() method as a second parameter
     # * <tt>new_system_block</tt> - Block to create a new system (if no stored system was found).
-    def self.new(directory_name, snapshot_marshaller=Marshal, &new_system_block)
+    def self.new(directory_name, options = {}, &new_system_block)
+      if options.kind_of? Hash
+        options = {
+          :snapshot_marshaller => Marshal,
+          :execution_context => nil
+        }.merge(options)
+      else
+        # Backwards compat.
+        options = {:snapshot_marshaller => options}
+      end
+
       log_factory = DefaultLogFactory.new
       logger = Logger.new(directory_name,
                           log_factory)
       snapshotter = Snapshotter.new(directory_name,
-                                    snapshot_marshaller)
-      lock = DefaultLock.new
+                                    options[:snapshot_marshaller])
       recoverer = Recoverer.new(directory_name,
-                                snapshot_marshaller)
+                                options[:snapshot_marshaller])
       system = recoverer.recover_snapshot(new_system_block)
-      executer = Executer.new(system)
+      executer = Executer.new(system, options[:execution_context])
       recoverer.recover_logs(executer)
-      DefaultSnapshotMadeleine.new(system, logger, snapshotter, lock, executer)
+      DefaultSnapshotMadeleine.new(system, logger, snapshotter, executer)
     end
   end
 
@@ -65,13 +76,13 @@ module Madeleine
     # The prevalent system
     attr_reader :system
 
-    def initialize(system, logger, snapshotter, lock, executer)
+    def initialize(system, logger, snapshotter, executer)
       SanityCheck.instance.run_once
 
       @system = system
       @logger = logger
       @snapshotter = snapshotter
-      @lock = lock
+      @lock = Sync.new
       @executer = executer
 
       @closed = false
@@ -103,7 +114,7 @@ module Madeleine
     #
     # * <tt>query</tt> - The query command to execute
     def execute_query(query)
-      @lock.synchronize_shared do
+      @lock.synchronize(:SH) do
         @executer.execute(query)
       end
     end
@@ -168,31 +179,20 @@ module Madeleine
 
   FILE_COUNTER_SIZE = 21 #:nodoc:
 
-  class DefaultLock #:nodoc:
-
-    def initialize
-      @lock = Sync.new
-    end
-
-    def synchronize(&block)
-      @lock.synchronize(&block)
-    end
-
-    def synchronize_shared(&block)
-      @lock.synchronize(:SH, &block)
-    end
-  end
-
   class Executer #:nodoc:
-
-    def initialize(system)
+    def initialize(system, context = nil)
       @system = system
+      @context = context
       @in_recovery = false
     end
 
     def execute(command)
       begin
-        command.execute(@system)
+        if @context
+          command.execute(@system, @context)
+        else
+          command.execute(@system)
+        end
       rescue
         raise unless @in_recovery
       end
@@ -231,7 +231,7 @@ module Madeleine
     def recover_logs(executer)
       executer.recovery do
         CommandLog.log_file_names(@directory_name, FileService.new).each do |file_name|
-          open(@directory_name + File::SEPARATOR + file_name, "rb") do |log|
+          open("#{@directory_name}#{File::SEPARATOR}#{file_name}", "rb") do |log|
             recover_log(executer, log)
           end
         end
@@ -255,11 +255,13 @@ module Madeleine
     end
 
     def name
-      result = @path
-      result += File::SEPARATOR
-      result += sprintf("%0#{FILE_COUNTER_SIZE}d", @id)
-      result += '.'
-      result += @name
+      [
+        @path,
+        File::SEPARATOR,
+        sprintf("%0#{FILE_COUNTER_SIZE}d", @id),
+        '.',
+        @name
+      ].join
     end
   end
 
@@ -363,7 +365,7 @@ module Madeleine
     private
 
     def delete_log_files
-      names = Dir.glob(@directory_name + File::SEPARATOR + "*.command_log")
+      names = Dir.glob("#{@directory_name}#{File::SEPARATOR}*.command_log")
       names.each do |name|
         name.untaint
         File.delete(name)

data/lib/madeleine/sanity.rb

@@ -1,3 +1,4 @@
+#encoding:utf-8
 #
 # Author::    Anders Bengtsson <ndrsbngtssn@yahoo.se>
 # Copyright:: Copyright (c) 2004-2006
@@ -11,7 +12,11 @@ module Madeleine
     include Singleton
 
     def initialize
-      @testdata = "\x85\x00\x0a\0x0d\x0a".freeze
+      @testdata = "\x85\x00\x0a\0x0d\x0a"
+      if @testdata.respond_to?(:force_encoding)
+        @testdata.force_encoding('ASCII-8BIT')
+      end
+      @testdata.freeze
       @was_run = false
     end
 

data/lib/madeleine/version.rb

@@ -1,3 +1,3 @@
 module Madeleine
-  VERSION = "0.8.0"
+  VERSION = "0.9.0.pre"
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: madeleine
 version: !ruby/object:Gem::Version
-  version: 0.8.0
-  prerelease: 
+  version: 0.9.0.pre
 platform: ruby
 authors:
-- Anders Bengtsson
+- Anders Kindberg (Bengtsson)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2013-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,33 +27,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Transparent persistence of system state using logging and snapshots
@@ -81,11 +74,12 @@ files:
 - contrib/test_batched.rb
 - contrib/test_scalability.rb
 - contrib/threaded_benchmark.rb
-- README
+- README.md
 - CHANGES.txt
 - COPYING
 homepage: http://github.com/ghostganz/madeleine
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --exclude
@@ -97,21 +91,19 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Madeleine is a Ruby implementation of Object Prevalence
 test_files: []

data/README

@@ -1,55 +0,0 @@
-
-Madeleine is a Ruby implementation of Object Prevalence: Transparent
-persistence of business objects using command logging and complete
-system snapshots.
-
-https://github.com/ghostganz/madeleine
-
-Madeleine's design is based on Prevayler, the original Java
-prevalence layer.
-
-
-Usage:
-
-    require 'madeleine'
-
-    # Create an application as a prevalent system
-
-    madeleine = SnapshotMadeleine.new("my_example_storage") {
-      SomeExampleApplication.new()
-    }
-
-    # Do modifications of the system by sending commands through
-    # the Madeleine instance. A command is an object with a suitable
-    # "execute(system)" method.
-
-    madeleine.execute_command(command)
-
-
-Requirements:
-
-    * Ruby 1.8.7 or later
-
-Contact:
-
-    Homepage:
-    https://github.com/ghostganz/madeleine
-
-License:
-
-    BSD (see the file COPYING)
-
-Credits:
-
-    Anders Bengtsson   -   Prevalence core impl.
-    Stephen Sykes      -   Automatic commands impl.
-
-    With the help of patches, testing and feedback from:
-
-    Steve Conover, David Heinemeier Hansson, Johan Lind, Håkan Råberg,
-    IIMA Susumu, Martin Tampe and Jon Tirsén
-
-    Thanks to Klaus Wuestefeld and the Prevayler developers for the
-    model of this software; to Minero Aoki for the installer; to Matz and
-    the core developers for the Ruby language!
-