maglevrecord 0.1.1 → 0.1.2

data/.gitignore

@@ -33,3 +33,10 @@ gem_*_code.log
 
 /caller_content.rb
 /module_content.rb
+
+# ignore files for presentation no 8
+/a.rb
+/b.rb
+/snapshot_test.rb
+/test3.rb
+

data/.travis.yml

@@ -10,7 +10,6 @@ before_script:
   - "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"

data/README.md

@@ -1,13 +1,15 @@
-# MagLevRecord - a model interface for Rails 
+# MagLevRecord - a model interface for Rails
+[![Build Status master](https://travis-ci.org/knub/maglevrecord.png?branch=master)](https://travis-ci.org/knub/maglevrecord)
+[![Code Climate](https://codeclimate.com/github/knub/maglevrecord.png)](https://codeclimate.com/github/knub/maglevrecord)
 
-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)
+```ActiveRecord``` is the ORM commonly used when working with Rails and relational databases.
+When using MagLev, using an ORM is no longer necessary, **you can just work with your objects as they are**.
+Still, ```ActiveRecord::Base``` offers some nice features for working with your models (*e.g.* like Validations).
 
-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.
+This gem offers all those features and bundles them in a comfortable way.
 
-## Installation
+### Installation
 
-You can install this gem from rubygems.org:
 ```gem install maglevrecord```
 
 
@@ -15,7 +17,15 @@ You can install this gem from rubygems.org:
 
 ### 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.
+Models, which you wish to persist, have to include ```MaglevRecord::Base``` or ```MaglevRecord::RootedBase```.
+You can still inherit from whatever base class you want.
+
+The difference between ```RootedBase``` and ```Base``` is, that ```RootedBase``` automatically stores the
+instances in ```Maglev::PERSISTENT_ROOT``` ([persistence by reachability](http://maglevity.wordpress.com/2010/01/17/persistence-by-reachability/)).
+The instances are stored in a hash, which contains all instances of the class.
+
+When using ```Base``` you are responsible for making the object reachable from ```PERSISTENT_ROOT```.
+
 
 ```ruby
 require 'maglev_record'
@@ -83,6 +93,11 @@ Using ```book.valid?``` you can determine if a model is valid. Models are *not*
 
 Use ```MaglevRecord.reset``` the reset all changed made since the last save or reset.
 
+
+### Migrating objects
+
+Have a look at the [demo application for migrations](https://github.com/niccokunzmann/maglevrecord-demo/blob/master/README.md).
+
 ## Further questions, improvements?
 
 Feel free to fork, pull-request or ask via email at bp2012h1 [at] hpi.uni-potsdam.de.

data/Rakefile

@@ -6,14 +6,14 @@ $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.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.test_files = FileList['test/{,**/}test*.rb']
   t.ruby_opts << "-W0 -rubygems --stone test"
 end
 

data/install.sh

@@ -121,7 +121,6 @@ case "$PLATFORM" in
     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))

data/lib/maglev_record/base.rb

@@ -1,14 +1,23 @@
 module MaglevRecord
   module Base
     extend MaglevSupport::Concern
+    include MaglevRecord::Snapshotable
     include MaglevRecord::Integration
     include MaglevRecord::Persistence
     include MaglevRecord::ReadWrite
     include MaglevRecord::MigrationOperations
     redo_include ActiveModel::Conversion
+    redo_include MaglevRecord::Validations
+    #module ClassMethods
+    #  def self.extended(base)
+        #base.class_methods_not_to_reset << "_validators"
+        #base.class_methods_not_to_reset << "_validators="
+        #base.class_methods_not_to_reset << "_validators?"
+        #base.class_methods_not_to_reset << "method_missing"
+    #  end
+    #end
     include MaglevRecord::Sensible
     include ActiveModel::Conversion
     include MaglevRecord::SecurePassword
-    include MaglevRecord::Snapshotable
   end
 end

data/lib/maglev_record/enumerable.rb

@@ -1,6 +1,11 @@
 module MaglevRecord
   module Enumerable
     module ClassMethods
+      def first
+        each{ |model|
+          return model
+        }
+      end
       def all
         raise "method not available for MaglevRecord::Base"
       end
@@ -21,4 +26,4 @@ module MaglevRecord
       end
     end
   end
-end
+end

data/lib/maglev_record/errors.rb

@@ -7,4 +7,7 @@ module MaglevRecord
 
   class IrreversibleMigration < Error
   end
+
+  class NoMigrationReadError < Error
+  end
 end

data/lib/maglev_record/maglev_record.rb

@@ -1,5 +1,5 @@
 module MaglevRecord
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
   PERSISTENT_ROOT_KEY = :MaglevRecord
 
   def self.save

data/lib/maglev_record/maglev_support/concern.rb

@@ -4,16 +4,15 @@ module MaglevSupport
       self.included_modules.reverse.each do |mod|
         base.extend(mod::ClassMethods) if mod.constants.include? 'ClassMethods'
       end
+      base.extend(self::ClassMethods) if self.constants.include? 'ClassMethods'
       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
+      #Maglev.commit_transaction
     end
   end
 end

data/lib/maglev_record/maglev_support/secure_password.rb

@@ -4,9 +4,8 @@ module MaglevRecord
       def has_secure_password
         attr_reader :password
 
-        # TODO: No validations so far
-        # validates_confirmation_of :password
-        # validates_presence_of     :password_digest
+        validates_confirmation_of :password
+        validates_presence_of     :password_digest
 
         mark_sensible :password, :password_confirmation
     

data/lib/maglev_record/migration/loader.rb

@@ -19,7 +19,7 @@ module MaglevRecord
 
     def load_string(source, file = __FILE__)
       migration = instance_eval source, file
-      # TODO: Check class of migration is really migration!
+      raise MaglevRecord::NoMigrationReadError unless migration.class == MaglevRecord::Migration
       migration.source = source
       @migration_list << migration
     end

data/lib/maglev_record/migration/migration.rb

@@ -138,5 +138,19 @@ MaglevRecord::Migration.new(Time.parse('#{
 end
       eos
     end
+
+    def self.write_to_file(folder, description,
+                           upcode = nil, downcode = nil)
+      now = Time.now
+      filename = now.strftime("migration_%Y-%m-%b-%d_%H.%M.%S.rb")
+      # TODO the arguments point at this to need to be refactored to an own 
+      #      class
+      content = file_content(now, description, upcode, downcode)
+      filepath = File.join(folder, filename)
+      File.open(filepath, 'w') { |file|
+        file.write(content)
+      }
+      filepath
+    end
   end
 end

data/lib/maglev_record/migration/migrator.rb

@@ -17,16 +17,28 @@ module MaglevRecord
     ##
     # Returns all migrations currently in the stone in the correct order.
     def migration_store
-      Maglev::PERSISTENT_ROOT[MIGRATION_KEY] ||= SortedSet.new
+      Maglev::PERSISTENT_ROOT[MIGRATION_KEY] ||= []
+    end
+
+    def migrations_todo
+      @migration_list.reject do |mig|
+        migration_store.include?(mig.id)
+      end
+    end
+
+    def up?(logger = @non_displaying_logger)
+      # todo: test
+      migrations_todo.sort.each do |mig|
+        logger.info("to do: '" + mig.name + "' from " + mig.timestamp.to_s)
+      end
+      logger.info("Already applied all migrations.") if migrations_todo.empty?
     end
 
     ##
     # Applies the desired state of migrations.
     def up(logger = @non_displaying_logger)
       Maglev.abort_transaction
-      to_do = @migration_list.reject do |mig|
-       migration_store.include?(mig.id)
-      end
+      to_do = migrations_todo
       logger.info("Already applied all migrations.") if to_do.empty?
       to_do.sort.each do |mig|
         mig.logger = logger
@@ -36,5 +48,11 @@ module MaglevRecord
       end
       Maglev.commit_transaction
     end
+
+    def self.for_directory(directory)
+      loader = MigrationLoader.new
+      loader.load_directory(directory)
+      new(loader.migration_list)
+    end
   end
 end

data/lib/maglev_record/migration/operations.rb

@@ -12,6 +12,7 @@ module MaglevRecord
       end
 
       def rename_attribute(old_name, new_name)
+        # TODO: test wether attribute is removed from attributes of class
         attr_accessor new_name
         each { |model|
           value = model.attributes[old_name]
@@ -30,10 +31,12 @@ module MaglevRecord
       end
 
       def delete_attribute(name)
+        # TODO: test attribute names for string and for symbol
         each { |model|
           value = model.attributes.delete(name)
           yield value if block_given?
         }
+        attributes.delete name.to_s if respond_to? :attributes
       end
 
       def migration_rename_to(new_name)
@@ -70,7 +73,46 @@ module MaglevRecord
         }
         list
       end
+
+      def remove_instance_method(name)
+        begin
+          remove_method name
+        rescue NameError
+        end
+      end
+
+      def remove_class_method(name)
+        begin
+          singleton_class.remove_method name
+        rescue NameError
+        end
+      end
+
+      def change_superclass_to(new_superclass)
+        # remove the superclass to enable to change the superclass
+        return unless new_superclass.is_able_to_become_superclass_of(self)
+        _name = name
+        Maglev.persistent do
+          maglev_redefine {
+            new_class = Object.module_eval "
+              class #{_name} < #{new_superclass.name}
+                self
+              end"
+            if respond_to? :object_pool_key
+              # where should I put it else?
+              raise "self should be object_pool_key" unless self == object_pool_key
+              pool_pool = Maglev::PERSISTENT_ROOT[MaglevRecord::PERSISTENT_ROOT_KEY]
+              unless pool_pool.nil?
+                #TODO: test no instances while superclass change
+                old_pool = pool_pool.delete(self) # TODO: test removed
+                pool_pool[new_class] = old_pool unless old_pool.nil?
+              end
+            end
+          }
+        end
+      end
     end
+
     class NullClass
       include ClassMethods
       def initialize(name)
@@ -86,7 +128,23 @@ module MaglevRecord
       end
       def migration_delete
       end
+      def remove_instance_method(name)
+      end
+      def remove_class_method(name)
+      end
+      def is_able_to_become_superclass_of(base_class)
+        false
+      end
+      def change_superclass_to(new_superclass)
+      end
     end
   end
 end
 
+Maglev.persistent do
+  class Class
+    def is_able_to_become_superclass_of(base_class)
+      true
+    end
+  end
+end

data/lib/maglev_record/persistence.rb

@@ -5,18 +5,25 @@ module MaglevRecord
     def initialize(*args)
       if args.size == 1
         args[0].each do |k, v|
-          meth_name = "#{k.to_s}=".to_sym 
+          meth_name = "#{k.to_s}=".to_sym
           self.send(meth_name, v) if self.respond_to? meth_name
         end
       end
-      @created_at_timestamp = Time.now
+      created
     end
 
     def created_at
       @created_at_timestamp
     end
-    def created_at=(timestamp)
-      @created_at_timestamp = timestamp
+    def created
+      @created_at_timestamp = Time.now
+    end
+
+    def updated_at
+      @updated_at_timestamp
+    end
+    def updated
+      @updated_at_timestamp = Time.now
     end
 
     alias :persisted? :committed?
@@ -38,4 +45,4 @@ module MaglevRecord
       end
     end
   end
-end
+end

data/lib/maglev_record/read_write.rb

@@ -4,7 +4,7 @@ module MaglevRecord
     extend MaglevSupport::Concern
 
     def attributes
-      @maglev_attributes ||= Hash.new 
+      @maglev_attributes ||= Hash.new
     end
 
     def update_attributes(attribute_hash)
@@ -16,9 +16,8 @@ module MaglevRecord
 
     module ClassMethods
       def attr_reader(*attr_names)
-        @attr_readers ||= []
         attr_names.each do |attr_name|
-          attr_readers << attr_name
+          attributes << attr_name.to_s
           self.module_eval <<-ATTRREADER, __FILE__, __LINE__ + 1
             def #{attr_name}
               attributes[:#{attr_name}]
@@ -27,24 +26,56 @@ module MaglevRecord
         end
       end
 
-      def attr_readers
-        @attr_readers
-      end
-
       def attr_writer(*attr_names)
         attr_names.each do |attr_name|
+          attributes << attr_name.to_s
           self.module_eval <<-ATTRWRITER, __FILE__, __LINE__ + 1
             def #{attr_name}=(new_value)
+              updated
               attributes[:#{attr_name}] = new_value
             end
           ATTRWRITER
         end
       end
 
+
       def attr_accessor(*attr_names)
         attr_reader *attr_names
         attr_writer *attr_names
       end
+
+      #
+      # resets the class to no methods
+      # returns a memento proc that can be called to restore the old state
+      #
+      def attributes
+        @attributes ||= []
+        raise TypeError, "attributes contain bad elements #{@attributes}" unless @attributes.all?{ |attribute| attribute.is_a? String }
+        @attributes.sort!
+        @attributes.uniq!
+        @attributes
+      end
+
+      def reset
+        _attributes = attributes_to_reset.map{ |attribute|
+          attributes.delete attribute
+        }
+        reset_proc = super if defined?(super)
+        return Proc.new {
+          reset_proc.call unless reset_proc.nil?
+          _attributes.each{ |attribute| attributes << attribute}
+          attributes
+          self
+        }
+      end
+
+      def snapshot_attributes
+        attributes.reject{|attribute| attribute.include? 'valid' }
+      end
+
+      def attributes_to_reset
+        snapshot_attributes
+      end
     end
   end
 end

data/lib/maglev_record/rooted_enumerable.rb

@@ -1,6 +1,11 @@
 module MaglevRecord
   module RootedEnumerable
     module ClassMethods
+      def first
+        each{ |model|
+          return model
+        }
+      end
       def all
         object_pool.values
       end
@@ -22,4 +27,4 @@ module MaglevRecord
       end
     end
   end
-end
+end

data/lib/maglev_record/rooted_persistence.rb

@@ -2,6 +2,9 @@ module MaglevRecord
   module RootedPersistence
     extend MaglevSupport::Concern
 
+    def destroy
+      self.class.object_pool.delete(self.id)
+    end
     module ClassMethods
       def object_pool_key
         self
@@ -17,6 +20,7 @@ module MaglevRecord
       end
 
       def new(*args)
+        create_validations
         instance = super(*args)
         self.object_pool[instance.id] = instance
         instance

data/lib/maglev_record/sensible.rb

@@ -5,7 +5,7 @@ module MaglevRecord
     end
 
     def clear_sensibles
-      sensibles.each do |attribute|  
+      sensibles.each do |attribute|
         send("#{attribute}=", nil)
       end
     end
@@ -17,7 +17,7 @@ module MaglevRecord
 
       def mark_sensible(*attr_names)
         @maglev_sensible_attributes ||= Array.new unless attr_names.empty?
-        attr_names.each do |attribute| 
+        attr_names.each do |attribute|
           @maglev_sensible_attributes << attribute unless @maglev_sensible_attributes.include?(attribute)
         end
       end

data/lib/maglev_record/snapshot/change.rb

@@ -1,19 +1,9 @@
 
 module MaglevRecord
 
-  class ClassChange
-    def initialize(old, new)
-      @old = old
-      @new = new
-    end
-    def new_attr_accessors
-      @new.attr_readers - @old.attr_readers
-    end
-    def removed_attr_accessors
-      @old.attr_readers - @new.attr_readers
-    end
-  end
- 
+  #
+  # The Change between two snapshots of the image
+  #
   class Change
 
     def initialize(old, new)
@@ -34,14 +24,22 @@ module MaglevRecord
       changes
     end
 
+    def changed_class_names
+      changed_classes.map(&:class_name).sort
+    end
+
     def removed_classes
-      @new.class_snapshots.select{ |new|
-        not new.exists? and @old.class_snapshots.all?{ |old|
+      @old.class_snapshots.select{ |old|
+        old.exists? and @new.class_snapshots.all?{ |new|
           old != new
         }
       }
     end
 
+    def removed_class_names
+      removed_classes.map(&:class_name).sort
+    end
+
     def new_classes
       @new.class_snapshots.select{ |new|
         new.exists? and @old.class_snapshots.all?{ |old|
@@ -49,5 +47,46 @@ module MaglevRecord
         }
       }
     end
+
+    def new_class_names
+      new_classes.map(&:class_name).sort
+    end
+
+    def migration_string_list
+      if removed_classes.size == 1 and new_classes.size == 1
+        ["rename_class #{removed_class_names.first
+                  }, :#{new_class_names.first}"]
+      else
+        removed_class_names.map{ |class_name|
+          "delete_class #{class_name}"
+        } + new_class_names.map{ |class_name|
+          "#new class: #{class_name}"
+        }
+      end + changed_classes.map(&:migration_string_list).flatten
+    end
+
+    def migration_string(identation = 0)
+      " " * identation + migration_string_list.select{ |s| s.strip != ""}.join("\n" + " " * identation)
+    end
+
+    def nothing_changed?
+      removed_classes == [] and changed_classes == [] and new_classes == []
+    end
+
+    def [](class_or_class_name)
+      changed_classes.each{ |change|
+        return change if change.changed_class == class_or_class_name or
+                         change.class_name == class_or_class_name
+      }
+    end
+
+    def superclass_mismatch_classes
+      []
+    end
+
+    def reversed
+      self.class.new(@new, @old)
+    end
+
   end
 end