has_alter_ego 0.0.2 → 0.0.3

data/Changelog.md

@@ -0,0 +1,9 @@
+# 0.0.3 (2010-06-10)
+* Add a rake task for dumping the current database objects into an alter_egos YAML file
+* Do not bring back destroyed objects
+
+# 0.0.2 (2010-06-09)
+* Added Rails3 support
+
+# 0.0.1 (2010-06-09)
+* Initial release with basic functionality

data/README.md

@@ -20,7 +20,7 @@ Then
     script/generate has_alter_ego
     rake db:migrate
 
-Rails 3
+## Rails 3
 ### As a plugin
     rails plugin install git://github.com/aduffeck/has_alter_ego.git
     rails generate has_alter_ego
@@ -35,10 +35,10 @@ Then
     rake db:migrate
 
 # Usage
-
+## General
 The seed data is defined in YAML files called after the model's table. The files are expected in **db/fixtures/alter_egos**.
 
-Say you have a Model Car. has_alter_ego is enabled with the *has_alter_ego* method:
+Say you have a Model *Car*. has_alter_ego is enabled with the *has_alter_ego* method:
 
     create_table :cars do |t|
       t.string :brand
@@ -50,7 +50,7 @@ Say you have a Model Car. has_alter_ego is enabled with the *has_alter_ego* meth
       has_alter_ego
     end
 
-You would then create a file **db/fixtures/alter_egos/cars.yml** with the seed data:
+You could then create a file **db/fixtures/alter_egos/cars.yml** with the seed data:
 
     1:
       brand: Lotus
@@ -74,6 +74,18 @@ and you'd automagically have those objects available in your database.
     => #<Car id: 1, brand: "Lotus", model: "Elise">
 
 Whenever the seed definition changes the objects in the database inherit the changes unless they have been overridden.
+When a seed object was destroyed in the database it will not be added again.
+
+**Note:** If the table has a numeric primary key has_alter_ego reserves the first n IDs for seed objects (default=1000),
+so the next non-seed object will get the ID 1001.
+The number of reserved objects can be set with the optional *:reserved_space* parameter, e.g.
+
+    has_alter_ego :reserved_space => 5000
+
+You always have to make sure that no seed IDs clash with IDs in the database.
+
+
+## Advanced stuff
 You can check if an object was created from seed definition with *has_alter_ego?*:
 
     @car = Car.find(1)
@@ -110,5 +122,12 @@ If you don't want to inherit changes for an object without actually modifying it
     @car.alter_ego_state
     => "default"
 
+# Generating seed data from the database
+
+has_alter_ego has a rake task for dumping the current database content into a seed file. It is called like this:
+
+    rake has_alter_ego::dump MODEL=Car
+
+That will fill **db/fixtures/alter_egos/cars.yml** with the database objects. 
 
 Copyright (c) 2010 André Duffeck, released under the MIT license

data/lib/has_alter_ego/dumper.rb

@@ -1,6 +1,32 @@
 module HasAlterEgo
   class Dumper
-    def dump
+    def self.dump
+      raise "You need to pass a MODEL=<model name> argument to rake" if ENV["MODEL"].blank?
+      klaas = ENV["MODEL"].constantize
+
+      yml_file = File.join(RAILS_ROOT, "db", "fixtures", "alter_egos", klaas.table_name + ".yml")
+      yml = {}
+      if File.exists?(yml_file)
+        File.open(yml_file) do |yf|
+          yml = YAML::load( yf )
+        end
+      end
+
+      puts yml.inspect
+      klaas.all.each do |o|
+        key = o[klaas.primary_key]
+        yml[key] ||= {}
+        o.attributes.keys.each do |a|
+          next if a == klaas.primary_key
+          yml[key][a] = o[a]
+        end
+        o.build_alter_ego unless o.alter_ego
+        o.alter_ego.state = 'default'
+        o.save_without_alter_ego
+      end
+      File.open(yml_file, File::WRONLY|File::TRUNC|File::CREAT) do |yf|
+        yf.write yml.to_yaml
+      end
     end
   end
 end

data/lib/has_alter_ego.rb

@@ -13,6 +13,7 @@ module HasAlterEgo
         class_eval do
           has_one :alter_ego, :as => :alter_ego_object
           alias_method :save_without_alter_ego, :save
+          alias_method :destroy_without_alter_ego, :destroy
           send :include, InstanceMethods
           reserve_space(opts[:reserved_space])
           parse_yml
@@ -51,6 +52,10 @@ module HasAlterEgo
             db_object.save_without_alter_ego
           end
         else
+          # Check for destroyed alter_egos
+          alter_ego = AlterEgo.find_by_alter_ego_object_id_and_alter_ego_object_type(primary_key, self.name)
+          return if alter_ego.try(:state) == "destroyed"
+
           db_object = self.new
           db_object[self.primary_key] = primary_key
           yml[primary_key].keys.each do |attr|
@@ -88,14 +93,29 @@ module HasAlterEgo
           self.alter_ego.state = 'modified'
           self.alter_ego.save
         end
+        if ActiveRecord::VERSION::MAJOR == 3 and !perform_validation.is_a?(Hash)
+          perform_validation = {:validate => perform_validation}
+        end
         save_without_alter_ego perform_validation
       end
 
+      def destroy
+        if self.alter_ego
+          self.alter_ego.state = 'destroyed'
+          self.alter_ego.save
+        end
+        destroy_without_alter_ego
+      end
+
       def pin!
         self.alter_ego.state = 'pinned'
         self.alter_ego.save
       end
 
+      def ban!
+
+      end
+
       def reset
         self.alter_ego.state = 'default'
         self.alter_ego.save

data/lib/tasks/has_alter_ego.rake

@@ -1 +1,6 @@
-
+namespace :has_alter_ego do
+  desc "Dump the objects of MODEL from the database in a YAML file as alter egos"
+  task :dump => :environment do
+    HasAlterEgo::Dumper.dump
+  end
+end

data/test/db/fixtures/alter_egos/cars.yml

@@ -12,4 +12,12 @@
 
 4:
   brand: Corvette
-  model: C5
+  model: C5
+
+5:
+  brand: Fiat
+  model: Punto
+
+6:
+  brand: Ford
+  model: Focus

data/test/has_alter_ego_test.rb

@@ -35,7 +35,7 @@ class HasAlterEgoTest < Test::Unit::TestCase
   end
 
   def test_create_objects_from_yml
-    assert_equal 4, Car.count
+    assert_equal 6, Car.count
     c1 = Car.find(1)
     assert_equal "Lotus", c1.brand
     assert_equal "Elise", c1.model
@@ -153,4 +153,23 @@ class HasAlterEgoTest < Test::Unit::TestCase
     orangejuice.save
     assert !orangejuice.has_alter_ego?
   end
+
+  def test_destroyed_object_leaves_destroyed_alter_ego
+    c = Car.find(6)
+    alter_ego = c.alter_ego
+    assert_equal "default", alter_ego.state
+
+    c.destroy
+    alter_ego.reload
+    assert_equal "destroyed", alter_ego.state
+  end
+
+  def test_destroyed_objects_do_not_return
+    assert Car.find_by_id(5)
+    Car.find_by_id(5).destroy
+    assert !Car.find_by_id(5)
+
+    Car.parse_yml
+    assert !Car.find_by_id(5)
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: has_alter_ego
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - "Andr\xC3\xA9 Duffeck"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-09 00:00:00 +02:00
+date: 2010-06-10 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -34,6 +34,7 @@ files:
 - lib/generators/has_alter_ego_generator.rb
 - lib/has_alter_ego.rb
 - lib/tasks/has_alter_ego.rake
+- Changelog.md
 - README.md
 - Rakefile
 - rails/init.rb