maglevrecord 0.0.3 → 0.1.1

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# gemstone files
+gem_*_code.log
+# gvim files
+*.swp
+
+/test.rb
+
+*~
+/*.lock
+/activesupport/
+/maglevrecord
+/test2.rb
+/test_input.txt
+
+/caller_content.rb
+/module_content.rb

data/.travis.yml

@@ -0,0 +1,19 @@
+# Java, because those are the 64bit boxes. We'll change it once Ruby
+# boxes are 64bit, too
+language: java
+before_install:
+  - "sudo apt-get install -qq rake"
+before_script:
+  - "./install.sh"
+  - "export MAGLEV_HOME=/home/travis/build/knub/maglevrecord/maglev"
+  - "export PATH=$MAGLEV_HOME/bin:$PATH"
+  - "gem uninstall -x -i /home/travis/.rvm/gems/ruby-1.9.3-p327@global bundler"
+  - "maglev-gem install bundler"
+  - "bundle install"
+  - "gem install maglevrecord"
+script:
+  - "bundle exec rake testslow"
+  - "bundle exec rake testslow"
+  - "bundle exec rake testfast TESTOPTS='-v' TEST=test/_test_object_reference.rb"
+notifications:
+    email: false

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+
+gem 'activesupport'
+gem 'activemodel'
+gem 'actionpack'
+gem "railties"
+
+group :development, :test do
+  gem 'timecop'
+  gem 'tzinfo'
+end

data/README.md

@@ -0,0 +1,89 @@
+# MagLevRecord - a model interface for Rails 
+
+master [![Build Status master](https://travis-ci.org/knub/maglevrecord.png?branch=master)](https://travis-ci.org/knub/maglevrecord)
+develop [![Build Status develop](https://travis-ci.org/knub/maglevrecord.png?branch=develop)](https://travis-ci.org/knub/maglevrecord)
+
+This is intended to replace ActiveRecord::Base when using MagLev. It is not ready for production use, but feel free to play around with it.
+
+## Installation
+
+You can install this gem from rubygems.org:
+```gem install maglevrecord```
+
+
+## Basic Usage
+
+### Creating classes
+
+Classes which you wish to persist have to include ```MaglevRecord::Base``` or ```MaglevRecord::RootedBase```. You can still inherit from whatever base class you want.
+
+```ruby
+require 'maglev_record'
+
+class Book
+  include MaglevRecord::RootedBase
+  
+  attr_accessor :author, :title, :comments
+end
+```
+Use attr_reader, attr_writer or attr_accessor to define your fields and use the generated getters and setters to access them. Do not access the instance variables directly, because we might need to do some background work when accessing and setting in future versions.
+
+### Saving
+
+There is a significant difference between ActiveRecord and MaglevRecord: ActiveRecord features an object-wise saving mechanism, whereas **MaglevRecord can only save all objects marked as persistent at once**. That is the Smalltalk image idea: make some changes and then save the whole world.
+
+```ruby
+book = Book.new(:title => "A new book", :author => "The writer")
+another_book = Book.new(:title => "Another new book", :author => "The writer")
+MaglevRecord.save
+```
+
+*Important:* When using MaglevRecord in a Rails app, unsaved changes are lost at the end of the request (die to an automatic request-wrapper).
+
+### Accessing model objects
+
+Rooted model classes (```ActiveRecord::RootedBase```) implement ```Enumerable```, so you can just use the normal collection API.
+You can use these methods for queries. Dynamic finders and indexes will be implemented later.
+```ruby
+ book = Book.find { |b| b.author == "The writer" }
+ #book.select
+ #book.map
+ #etc.
+```
+
+Ordinary model classes (```ActiveRecord::Base```) do not provide a mechanism access such models directly. They are used only for referencing such models from other models, i.e. if the model is not reachable from a rooted model, the garbage collector will remove it after some time.
+
+### Deleting models
+
+Rooted models can be deleted with ```delete```. 
+
+*Warning:* This will only remove the model from the enumeration of all models. This model will not be removed until the last reachable reference to it is removed.
+
+### Validation
+
+MaglevRecord supports model validation via ActiveModel.
+
+```ruby
+require 'maglev_record'
+
+class Book
+  include MaglevRecord::Base
+  
+  validates :author, :presence => true
+  validates :title,  :presence => true,
+                     :length => { :minimum => 5 }
+
+  attr_accessor :author, :title, :comments
+end
+```
+
+Using ```book.valid?``` you can determine if a model is valid. Models are *not* automatically validated on global save.
+
+### Resetting objects
+
+Use ```MaglevRecord.reset``` the reset all changed made since the last save or reset.
+
+## Further questions, improvements?
+
+Feel free to fork, pull-request or ask via email at bp2012h1 [at] hpi.uni-potsdam.de.
+We are actively developing this and hope for feedback.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+require 'logger'
+$LOAD_PATH << './lib'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.name = 'testfast'
+  t.test_files = FileList['test/**/test*.rb'] - FileList['test/**/test*.slow.rb']
+  t.ruby_opts << "-W0 -rubygems --stone test"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.name = 'testslow'
+  t.test_files = FileList['test/**/test*.rb']
+  t.ruby_opts << "-W0 -rubygems --stone test"
+end
+
+desc "Run tests"
+
+task :default => :testfast

data/install.sh

@@ -0,0 +1,238 @@
+#! /bin/bash
+
+#=========================================================================
+# Copyright (C) GemStone Systems, Inc. 2010.
+#
+# Name - install.sh
+#
+# Purpose - Make sure MagLev and GemStone are setup correctly in a fresh clone
+#           of MagLev from git://github.com:MagLev/maglev.git. You only need 
+#           to run this once, you can use update.sh from then on.
+#
+#           Be both verbose and idempotent, so we can easily diagnose
+#           any problems.
+#
+# $Id:$
+#
+# Description:
+#    Does a basic setup of memory and services for MagLev 
+#    Setup for manual MagLev startup rather than automatic startup upon boot
+#    Safe to run multiple times. Only saves one prior backup repository though.
+#    Requires root access (using sudo) to change setings and create directories
+#
+# Actions:
+#    Verify machine is capable of running MagLev 64-bit
+#    Add shared memory setup to /etc/sysctl.conf
+#    Add GemStone netldi service port to /etc/services
+#    Invoke update.sh to finish the job
+#=========================================================================
+
+echo $PWD
+git clone https://github.com/MagLev/maglev.git
+cd maglev
+git checkout stefan/maglevrecord
+
+if [ -x bin/maglev-ruby ]; then
+    # echo "using $PWD as MAGLEV_HOME"
+    export MAGLEV_HOME=$PWD
+else
+    echo "[Error] $PWD is not a valid MagLev directory"
+    echo "To fix this, 'clone git://github.com:MagLev/maglev.git'"
+    echo "then run install.sh from the resulting directory."
+    exit 1
+fi
+
+# Check that the parent directory is writable
+if [ ! -w ".." ]; then
+    echo "[Error] This script requires write permission on the MagLev parent directory."
+    /bin/ls -ld ..
+    echo "To fix this, 'chmod u+w ..'"
+    exit 1
+fi
+
+# Detect operating system
+PLATFORM="`uname -sm | tr ' ' '-'`"
+# Macs with Core i7 use the same software as older Macs
+[ $PLATFORM = "Darwin-x86_64" ] && PLATFORM="Darwin-i386"
+
+# Check we're on a suitable 64-bit machine
+case "$PLATFORM" in
+    Darwin-i386)
+    OSVERSION="`sw_vers -productVersion`"
+    MAJOR="`echo $OSVERSION | cut -f1 -d.`"
+    MINOR="`echo $OSVERSION | cut -f2 -d.`"
+    CPU_TYPE="`uname -p`"
+    CPU_CAPABLE="`sysctl hw.cpu64bit_capable | cut -f2 -d' '`"
+    #
+    # Check the CPU and Mac OS X profile.
+    if [[ $CPU_TYPE != "i386" || $CPU_CAPABLE -ne 1 || $MAJOR -lt 10 || $MINOR -lt 5 ]] ; then
+        echo "[Error] This script requires Mac OS X 10.5 or later on a 64-bit Intel CPU."
+        exit 1
+    fi
+    ;;
+    Linux-x86_64)
+    # Linux looks OK
+    ;;
+    SunOS-i86pc)
+    # Solaris X86  looks OK
+    ;;
+    *)
+    echo "[Error] This script only works on a 64-bit Linux, Mac OS X, or Solaris-x86 machine"
+    echo "The result from \"uname -sm\" is \"`uname -sm`\""
+    exit 1
+    ;;
+esac
+
+# We should run this as a normal user, not root.
+if [ `id | cut -f2 -d= | cut -f1 -d\(` -eq 0 ]; then
+    echo "[Error] This script should be run as a normal user, not root."
+    exit 1
+fi
+
+# We're good to go. Let user know.
+machine_name="`uname -n`"
+echo "[Info] Configuring $machine_name to run MagLev"
+
+# Do a trivial sudo to test we can and get the password prompt out of the way
+sudo date
+
+# Figure out how much total memory is installed
+echo "[Info] Setting up shared memory"
+#
+# Ref: http://wiki.finkproject.org/index.php/Shared_Memory_Regions_on_Darwin
+# Ref: http://developer.postgresql.org/pgdocs/postgres/kernel-resources.html
+# Ref: http://www.idevelopment.info/data/Oracle/DBA_tips/Linux/LINUX_8.shtml
+#
+case "$PLATFORM" in
+    Linux-x86_64)
+    # use TotalMem: kB because Ubuntu doesn't have Mem: in Bytes
+    totalMemKB=`awk '/MemTotal:/{print($2);}' /proc/meminfo`
+    totalMem=$(($totalMemKB * 1024))
+    # Figure out the max shared memory segment size currently allowed
+    shmmax=`cat /proc/sys/kernel/shmmax`
+    # Figure out the max shared memory currently allowed
+    shmall=`cat /proc/sys/kernel/shmall`
+    ;;
+    Darwin-i386)
+    totalMem="`sysctl hw.memsize | cut -f2 -d' '`"
+    # Figure out the max shared memory segment size currently allowed
+    shmmax="`sysctl kern.sysv.shmmax | cut -f2 -d' '`"
+    # Figure out the max shared memory currently allowed
+    shmall="`sysctl kern.sysv.shmall | cut -f2 -d' '`"
+    ;;
+    SunOS-i86pc)
+    # TODO: figure memory needs for Solaris-x86
+    # Investigate project.max-shm-memory
+    totalMemMB="`/usr/sbin/prtconf | grep Memory | cut -f3 -d' '`"
+    totalMem=$(($totalMemMB * 1048576))
+    shmmax=$(($totalMem / 4))
+    shmall=$(($shmmax / 4096))
+    ;;
+    *)
+    echo "[Error] Can't determine operating system. Check script."
+    exit 1
+    ;;
+esac
+totalMemMB=$(($totalMem / 1048576))
+shmmaxMB=$(($shmmax / 1048576))
+shmallMB=$(($shmall / 256))
+
+# Print current values
+echo "  Total memory available is $totalMemMB MB"
+echo "  Max shared memory segment size is $shmmaxMB MB"
+echo "  Max shared memory allowed is $shmallMB MB"
+
+# Figure out the max shared memory segment size (shmmax) we want
+# Use 75% of available memory but not more than 2GB
+shmmaxNew=$(($totalMem * 3/4))
+[ $shmmaxNew -gt 2147483648 ] && shmmaxNew=2147483648
+shmmaxNewMB=$(($shmmaxNew / 1048576))
+
+# Figure out the max shared memory allowed (shmall) we want
+# The MacOSX default is 4MB, way too small
+# The Linux default is 2097152 or 8GB, so we should never need this
+# but things will certainly break if it's been reset too small
+# so ensure it's at least big enough to hold a fullsize shared memory segment
+shmallNew=$(($shmmaxNew / 4096))
+[ $shmallNew -lt $shmall ] && shmallNew=$shmall
+shmallNewMB=$(($shmallNew / 256))
+
+# Increase shmmax if appropriate
+if [ $shmmaxNew -gt $shmmax ]; then
+    echo "[Info] Increasing max shared memory segment size to $shmmaxNewMB MB"
+    [ $PLATFORM = "Darwin-i386" ] && sudo sysctl -w kern.sysv.shmmax=$shmmaxNew
+    [ $PLATFORM = "Linux-x86_64" ] && sudo bash -c "echo $shmmaxNew > /proc/sys/kernel/shmmax"
+    [ $PLATFORM = "SunOS-i86pc" ] && echo "[Warning] shmmax must be set manually on Solaris-x86"
+else
+    echo "[Info] No need to increase max shared memory segment size"
+fi
+
+# Increase shmall if appropriate
+if [ $shmallNew -gt $shmall ]; then
+    echo "[Info] Increasing max shared memory allowed to $shmallNewMB MB"
+    [ $PLATFORM = "Darwin-i386" ] && sudo sysctl -w kern.sysv.shmall=$shmallNew
+    [ $PLATFORM = "Linux-x86_64" ] && sudo bash -c "echo $shmallNew > /proc/sys/kernel/shmall"
+    [ $PLATFORM = "SunOS-i86pc" ] && echo "[Warning]shmall must be set manually on Solaris-x86"
+else
+    echo "[Info] No need to increase max shared memory allowed"
+fi
+
+# At this point, shared memory settings contain the values we want, 
+# put them in sysctl.conf so they are preserved.
+if [[ ! -f /etc/sysctl.conf || `grep -sc "kern.*.shm" /etc/sysctl.conf` -eq 0 ]]; then
+    case "$PLATFORM" in
+        Linux-x86_64)
+        echo "# kernel.shm* settings added by MagLev installation" > /tmp/sysctl.conf.$$
+        echo "kernel.shmmax=`cat /proc/sys/kernel/shmmax`" >> /tmp/sysctl.conf.$$
+        echo "kernel.shmall=`cat /proc/sys/kernel/shmall`" >> /tmp/sysctl.conf.$$
+        ;;
+        Darwin-i386)
+        # On Mac OS X Leopard, you must have all five settings in sysctl.conf
+        # before they will take effect.
+        echo "# kern.sysv.shm* settings added by MagLev installation" > /tmp/sysctl.conf.$$
+        sysctl kern.sysv.shmmax kern.sysv.shmall kern.sysv.shmmin kern.sysv.shmmni \
+        kern.sysv.shmseg  | tr ":" "=" | tr -d " " >> /tmp/sysctl.conf.$$
+        ;;
+        SunOS-i86pc)
+        # Do nothing in Solaris-x86 since /etc/sysctl.conf is ignored on Solaris 10.
+        # Must configure shared memory settings manually.
+        ;;
+        *)
+        echo "[Error] Can't determine operating system. Check script."
+        exit 1
+        ;;
+    esac
+    # Do nothing on Solaris-x86 since /etc/sysctl.conf is ignored on Solaris 10.
+    if [[ "$PLATFORM" != "SunOS-i86pc" ]]; then
+        echo "[Info] Adding the following section to /etc/sysctl.conf"
+        cat /tmp/sysctl.conf.$$
+        sudo bash -c "cat /tmp/sysctl.conf.$$ >> /etc/sysctl.conf"
+        /bin/rm -f /tmp/sysctl.conf.$$
+    fi
+else
+    echo "[Info] The following shared memory settings already exist in /etc/sysctl.conf"
+    echo "To change them, remove the following lines from /etc/sysctl.conf and rerun this script"
+    grep "kern.*.shm" /etc/sysctl.conf
+fi
+
+# Now setup for NetLDI in case we ever need it.
+echo "[Info] Setting up GemStone netldi service port"
+if [ `grep -sc "^gs64ldi" /etc/services` -eq 0 ]; then
+    echo '[Info] Adding "gs64ldi  50378/tcp" to /etc/services'
+    sudo bash -c 'echo "gs64ldi         50378/tcp        # Gemstone netldi"  >> /etc/services'
+else
+    echo "[Info] GemStone netldi service port is already set in /etc/services"
+    echo "To change it, remove the following line from /etc/services and rerun this script"
+    grep "^gs64ldi" /etc/services
+fi
+
+# Make sure we have a compatible version of GemStone
+bash ./update.sh
+
+rake stone:create[test]
+rake test:start
+
+
+cd ..
+# End of script
+exit 0

data/lib/maglev_record/base.rb

@@ -1,66 +1,14 @@
-require "maglev_record/persistence"
-require "maglev_record/enumerable"
-require "maglev_record/read_write"
-require "rubygems"
-require "active_support"
-require "active_model"
-
 module MaglevRecord
   module Base
-    extend ActiveSupport::Concern
-    extend ActiveModel::Naming
-
-    @attributes = {}
-    included do
-      include ActiveModel
-      include ActiveModel::AttributeMethods
-      include ActiveModel::Conversion
-      include ActiveModel::Dirty
-      include ActiveModel::MassAssignmentSecurity
-      include ActiveModel::Validations
-      include MaglevRecord::Persistence
-      include MaglevRecord::Enumerable
-      include MaglevRecord::ReadWrite
-
-      self.maglev_persistable
-      ActiveSupport.maglev_persistable
-      ActiveSupport::HashWithIndifferentAccess.maglev_persistable
-    end
-
-    def initialize(*args)
-      if args.size == 1
-        args[0].each do |k, v|
-          self.send("#{k.to_s}=".to_sym, v)
-        end
-      end
-    end
-
-    def clear_dirty
-      @dirty = nil
-    end
-    def reset!
-      changed.each do |attr|
-        self.send "reset_#{attr}!".to_sym
-      end
-      clear_dirty
-    end
-
-    def attributes
-      @attributes ||= {}
-    end
-
-    module ClassMethods
-      def create(*args)
-        x = self.new(*args)
-        x
-      end
-
-    end
-
-    def to_key
-      key = self.__id__
-      [key] if key
-    end
-
+    extend MaglevSupport::Concern
+    include MaglevRecord::Integration
+    include MaglevRecord::Persistence
+    include MaglevRecord::ReadWrite
+    include MaglevRecord::MigrationOperations
+    redo_include ActiveModel::Conversion
+    include MaglevRecord::Sensible
+    include ActiveModel::Conversion
+    include MaglevRecord::SecurePassword
+    include MaglevRecord::Snapshotable
   end
 end

data/lib/maglev_record/enumerable.rb

@@ -1,35 +1,24 @@
-require "active_support"
-
 module MaglevRecord
   module Enumerable
-    extend ActiveSupport::Concern
-
     module ClassMethods
-      include ::Enumerable
-
+      def all
+        raise "method not available for MaglevRecord::Base"
+      end
       def each
-        self.object_pool.each_value do |el|
-          yield(el)
-        end
+        raise "method not available for MaglevRecord::Base"
       end
-
       def size
-        self.object_pool.size
+        raise "method not available for MaglevRecord::Base"
       end
-
-      alias_method :length, :size
-
       def find_by_objectid(id)
-        self.object_pool[id]
-      end
-
-      def all
-        self.object_pool.values
+        raise "method not available for MaglevRecord::Base"
+        # if id.respond_to? :to_i
+        #   id = id.to_i 
+        # else
+        #   raise "#{id} do not respond to :to_i!"
+        # end
+        # ObjectSpace._id2ref(id)
       end
-
     end
-
   end
-
-end
-
+end

data/lib/maglev_record/errors.rb

@@ -0,0 +1,10 @@
+module MaglevRecord
+  class Error < RuntimeError
+  end
+
+  class InvalidOperationError < Error
+  end
+
+  class IrreversibleMigration < Error
+  end
+end

data/lib/maglev_record/integration.rb

@@ -0,0 +1,7 @@
+module MaglevRecord
+  module Integration
+    def to_param
+      id && id.to_s
+    end
+  end
+end

data/lib/maglev_record/maglev_record.rb

@@ -0,0 +1,13 @@
+module MaglevRecord
+  VERSION = '0.1.1'
+  PERSISTENT_ROOT_KEY = :MaglevRecord
+
+  def self.save
+    Maglev.commit_transaction
+  end
+
+  def self.reset
+    Maglev.abort_transaction
+  end
+end
+

data/lib/maglev_record/maglev_support/active_support_patch.rb

@@ -0,0 +1,31 @@
+module ActiveSupport
+  class << Deprecation
+    # Declare that a method has been deprecated.
+    def deprecate_methods(target_module, *method_names)
+      options = method_names.extract_options!
+      method_names += options.keys
+      method_names.each do |method_name|
+        next unless method_name.respond_to?(:to_sym)  # next if Fixnum
+        next if method_name == :none                  # check from rubygems/deprecate.rb
+        next if method_name.to_s.include?(".")             # . in method names is not allowed
+        # workaround for :==
+        if method_name.to_sym == :==
+          method_name = "equal?"
+        end
+        target_module.alias_method_chain(method_name, :deprecation) do |target, punctuation|
+          target_module.module_eval(<<-end_eval, __FILE__, __LINE__ + 1)
+            def #{target}_with_deprecation#{punctuation}(*args, &block)
+              ::ActiveSupport::Deprecation.warn(
+                ::ActiveSupport::Deprecation.deprecated_method_warning(
+                  :#{method_name},
+                  #{options[method_name].inspect}),
+                caller
+              )
+              send(:#{target}_without_deprecation#{punctuation}, *args, &block)
+            end
+          end_eval
+        end
+      end
+    end
+  end
+end

data/lib/maglev_record/maglev_support/concern.rb

@@ -0,0 +1,19 @@
+module MaglevSupport
+  module Concern
+    def included(base)
+      self.included_modules.reverse.each do |mod|
+        base.extend(mod::ClassMethods) if mod.constants.include? 'ClassMethods'
+      end
+      self.reinclude_store.each do |mod|
+        base.__save_for_reinclude(mod)
+      end unless self.reinclude_store.nil?
+      base.extend(self::ClassMethods) if self.constants.include? 'ClassMethods'
+      if base.is_a? Class
+        # base.send :redo_include, ActiveModel::Validations
+        base.send :redo_extend, Enumerable
+        base.send :redo_extend, MaglevSupport.constantize("ActiveModel::Naming")
+      end
+      Maglev.commit_transaction
+    end
+  end
+end

data/lib/maglev_record/maglev_support/maglev_support.rb

@@ -0,0 +1,15 @@
+module MaglevSupport
+  # Copied from activesupport/lib/active_support/inflector/methods.rb
+  def self.constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+end
+
+require "maglev_record/maglev_support/active_support_patch"