has_alter_ego 0.0.1

data/README.md

@@ -0,0 +1,100 @@
+# has_alter_ego
+
+has_alter_ego makes it possible to keep seed and live data transparently in parallel. In contrast to other seed
+data approaches has_alter_ego synchronizes the seed definitions with your database objects automagically unless you've
+overridden it in the database.
+
+# Installation
+
+## Rails 2.3.x
+### As a plugin
+    script/plugin install git://github.com/aduffeck/has_alter_ego.git
+    script/generate has_alter_ego
+    rake db:migrate
+
+### As a gem
+Add the following line to your config/environment.rb file:
+    config.gem "has_alter_ego"
+Then
+    gem install has_alter_ego
+    script/generate has_alter_ego
+    rake db:migrate
+
+# Usage
+
+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:
+
+    create_table :cars do |t|
+      t.string :brand
+      t.string :model
+    end
+
+
+    class Car < ActiveRecord::Base
+      has_alter_ego
+    end
+
+You would then create a file db/fixtures/has_alter_ego/cars.yml with the seed data:
+
+    1:
+      brand: Lotus
+      model: Elise
+
+    2:
+      brand: Porsche
+      model: 911
+
+    3:
+      brand: Ferrari
+      model: F50
+
+    4:
+      brand: Corvette
+      model: C5
+
+and you'd automagically have those objects available in your database.
+
+    Car.find(1)
+    => #<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.
+You can check if an object was created from seed definition with *has_alter_ego?*:
+
+    @car = Car.find(1)
+    @car.has_alter_ego?
+    => true
+
+    Car.new.has_alter_ego?
+    => false
+
+The method *alter_ego_state* tells whether an object has been overridden. "modified" objects will no longer inherit
+changes to the seed data.
+
+    @car.alter_ego_state
+    => "default"
+
+    @car.update_attribute(:model, "foo")
+    => true
+    @car
+    => #<Car id: 1, brand: "Lotus", model: "foo">
+    @car.alter_ego_state
+    => "modified"
+
+If you don't want to inherit changes for an object without actually modifying it you can use *pin!*:
+
+    @car.pin!
+    => true
+    @car.alter_ego_state
+    => "pinned"
+
+
+*reset* reverts the changes in the database and activates the synchronization again:
+    @car.reset
+    => #<Car id: 1, brand: "Lotus", model: "Elise">
+    @car.alter_ego_state
+    => "default"
+
+
+Copyright (c) 2010 André Duffeck, released under the MIT license

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require "rake/gempackagetask"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_alter_ego plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_alter_ego plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Schizophrenia'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::GemPackageTask.new(eval(File.read("has_alter_ego.gemspec"))) { |pkg| }

data/generators/has_alter_ego/has_alter_ego_generator.rb

@@ -0,0 +1,8 @@
+class HasAlterEgoGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory('db/fixtures/alter_egos')
+      m.migration_template('create_alter_egos.rb', "db/migrate", :migration_file_name => 'create_alter_egos')
+    end
+  end
+end

data/generators/has_alter_ego/templates/create_alter_egos.rb

@@ -0,0 +1,14 @@
+class CreateAlterEgos < ActiveRecord::Migration
+  def self.up
+    create_table :alter_egos do |t|
+      t.string :alter_ego_object_id
+      t.string :alter_ego_object_type, :limit => 40
+      t.string :state
+    end
+    add_index :alter_egos, [:alter_ego_object_id, :alter_ego_object_type]
+  end
+
+  def self.down
+    drop_table :alter_egos
+  end
+end

data/lib/has_alter_ego.rb

@@ -0,0 +1,112 @@
+require File.join(File.dirname(__FILE__), "has_alter_ego", "alter_ego")
+
+module HasAlterEgo
+  module ActiveRecordAdapater
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    module ClassMethods
+      def has_alter_ego opts = {}
+        opts.reverse_merge!({:reserved_space => 1000})
+
+        class_eval do
+          has_one :alter_ego, :as => :alter_ego_object
+          alias_method :save_without_alter_ego, :save
+          send :include, InstanceMethods
+          reserve_space(opts[:reserved_space])
+          parse_yml
+        end
+      end
+
+      # Reserve the first n IDs for stubbed objects
+      def reserve_space space
+        return unless self.columns_hash[self.primary_key].klass == Fixnum
+        return if self.last and self.last[self.primary_key] >= space
+
+        o = self.new
+        o[self.primary_key] = space
+        o.save_without_alter_ego
+        o.destroy
+        return
+      end
+
+      def parse_yml
+        yml = get_yml
+        yml.keys.each do |o|
+          parse_yml_for o
+        end
+        yml
+      end
+
+      def parse_yml_for primary_key
+        yml = get_yml
+        db_object = self.find(primary_key) rescue nil
+        if db_object
+          raise "There is already a #{db_object.class} with id #{db_object.id} in the database." unless db_object.has_alter_ego?
+          if db_object.alter_ego.state == 'default'
+            yml[primary_key].keys.each do |attr|
+              db_object[attr] = yml[primary_key][attr]
+            end
+            db_object.save_without_alter_ego
+          end
+        else
+          db_object = self.new
+          db_object[self.primary_key] = primary_key
+          yml[primary_key].keys.each do |attr|
+            db_object[attr] = yml[primary_key][attr]
+          end
+          db_object.build_alter_ego
+          db_object.alter_ego.state = 'default'
+          db_object.save_without_alter_ego
+        end
+      end
+
+      private
+
+      def get_yml
+        filename = File.join(RAILS_ROOT, "db", "fixtures", "alter_egos", self.table_name + ".yml")
+        return {} unless File.exists?(filename)
+        yml = File.open(filename) do |yf|
+          YAML::load( yf )
+        end
+        yml
+      end
+    end
+
+    module InstanceMethods
+      def has_alter_ego?
+        return self.alter_ego.present?
+      end
+
+      def alter_ego_state
+        self.alter_ego.state if self.alter_ego
+      end
+
+      def save perform_validation = true
+        if self.alter_ego
+          self.alter_ego.state = 'modified'
+          self.alter_ego.save
+        end
+        save_without_alter_ego perform_validation
+      end
+
+      def pin!
+        self.alter_ego.state = 'pinned'
+        self.alter_ego.save
+      end
+
+      def reset
+        self.alter_ego.state = 'default'
+        self.alter_ego.save
+
+        self.class.parse_yml_for self[self.class.primary_key]
+        self.reload
+      end
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include HasAlterEgo::ActiveRecordAdapater
+end

data/lib/has_alter_ego/alter_ego.rb

@@ -0,0 +1,3 @@
+class AlterEgo < ActiveRecord::Base
+  belongs_to :alter_ego_object, :polymorphic => true
+end

data/lib/tasks/has_alter_ego.rake

@@ -0,0 +1 @@
+

data/rails/init.rb

@@ -0,0 +1 @@
+require 'has_alter_ego'

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

@@ -0,0 +1,2 @@
+1:
+  brand: Hercules

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

@@ -0,0 +1,15 @@
+1:
+  brand: Lotus
+  model: Elise
+
+2:
+  brand: Porsche
+  model: 911
+
+3:
+  brand: Ferrari
+  model: F50
+
+4:
+  brand: Corvette
+  model: C5

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

@@ -0,0 +1,5 @@
+water:
+  color: none
+
+coffee:
+  color: black

data/test/has_alter_ego_test.rb

@@ -0,0 +1,156 @@
+require 'test_helper'
+
+class Car < ActiveRecord::Base
+  has_many :tires
+  has_alter_ego
+end
+
+class Bike < ActiveRecord::Base
+end
+
+class Scooter < ActiveRecord::Base
+end
+
+class Tire < ActiveRecord::Base
+end
+
+class Drink < ActiveRecord::Base
+  set_primary_key :name
+  has_alter_ego
+end
+
+class HasAlterEgoTest < Test::Unit::TestCase
+  def test_space_gets_reserved
+    c = Car.create
+    assert_equal 1001, c.id
+
+    assert_equal 1, Scooter.create.id
+    Scooter.has_alter_ego :reserved_space => 500
+    assert_equal 501, Scooter.create.id
+  end
+
+  def test_has_alter_ego?
+    assert Car.find(1).alter_ego
+    assert !Car.new.has_alter_ego?
+  end
+
+  def test_create_objects_from_yml
+    assert_equal 4, Car.count
+    c1 = Car.find(1)
+    assert_equal "Lotus", c1.brand
+    assert_equal "Elise", c1.model
+    assert c1.has_alter_ego?
+  end
+
+  def test_exception_is_raised_if_id_is_already_in_use
+    bike = Bike.create
+    assert_raise RuntimeError do
+      Bike.has_alter_ego
+    end
+  end
+
+  def test_object_attributes_are_updated_if_not_modified
+    c = Car.find(1)
+    assert_equal "Lotus", c.brand
+    assert_equal "default", c.alter_ego_state
+
+    c.brand = "Toyota"
+    c.save_without_alter_ego
+    c.reload
+    assert_equal "Toyota", c.brand
+    assert_equal "default", c.alter_ego_state
+
+    Car.parse_yml
+    c.reload
+    assert_equal "Lotus", c.brand
+  end
+
+  def test_object_attributes_are_not_updated_if_pinned
+    c = Car.find(2)
+    c.reset
+    assert_equal "Porsche", c.brand
+
+    c.brand = "VW"
+    c.save_without_alter_ego
+    c.pin!
+    c.reload
+    assert_equal "VW", c.brand
+    assert_equal "pinned", c.alter_ego_state
+
+    Car.parse_yml
+    c.reload
+    assert_equal "VW", c.brand
+  end
+
+  def test_object_attributes_are_not_updated_if_modified
+    c = Car.find(2)
+    assert_equal "Porsche", c.brand
+
+    c.brand = "VW"
+    c.save
+    c.reload
+    assert_equal "VW", c.brand
+    assert_equal "modified", c.alter_ego_state
+
+    Car.parse_yml
+    c.reload
+    assert_equal "VW", c.brand
+  end
+
+  def test_reset
+    c = Car.find(3)
+    assert_equal "Ferrari", c.brand
+    assert_equal "default", c.alter_ego_state
+
+    c.brand = "Fiat"
+    c.save
+    c.reload
+
+    assert_equal "Fiat", c.brand
+    assert_equal "modified", c.alter_ego_state
+    c.reset
+    c.reload
+
+    assert_equal "Ferrari", c.brand
+    assert_equal "default", c.alter_ego_state
+  end
+
+  def test_associations_do_not_change_state
+    c = Car.find(4)
+    assert_equal "default", c.alter_ego_state
+    assert_equal 0, c.tires.size
+
+    4.times do
+      c.tires << Tire.new
+    end
+    c.reload
+    assert_equal "default", c.alter_ego_state
+    assert_equal 4, c.tires.size
+  end
+
+  def test_different_primary_key
+    assert_equal 2, Drink.all.size
+    assert_equal "none", Drink.find("water").color
+
+    water = Drink.find("water")
+    assert water.has_alter_ego?
+    assert_equal "default", water.alter_ego_state
+
+    water.color = "blue"
+    water.save
+    water.reload
+    assert_equal "blue", water.color
+    assert_equal "modified", water.alter_ego_state
+
+    water.reset
+    water.reload
+    assert_equal "none", water.color
+    assert_equal "default", water.alter_ego_state
+
+    orangejuice = Drink.new
+    orangejuice.name = "orangejuice"
+    orangejuice.color = "yellow"
+    orangejuice.save
+    assert !orangejuice.has_alter_ego?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'test/unit'
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+require File.dirname(__FILE__) + '/../lib/has_alter_ego'
+RAILS_ROOT = File.dirname(__FILE__)
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define do
+    create_table :alter_egos do |t|
+      t.string :alter_ego_object_id
+      t.string :alter_ego_object_type, :limit => 40
+      t.string :state
+    end
+
+    create_table :cars do |t|
+      t.string :brand
+      t.string :model
+    end
+
+    create_table :bikes
+    create_table :scooters
+
+    create_table :tires do |t|
+      t.integer :car_id
+    end
+
+    create_table :drinks, :id => false do |t|
+      t.string :name
+      t.string :color
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: has_alter_ego
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Andr\xC3\xA9 Duffeck"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-09 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: "    has_alter_ego makes it possible to keep seed and live data transparently in parallel. In contrast to other seed\n    data approaches has_alter_ego synchronizes the seed definitions with your database objects automagically unless you've\n    overridden it in the database.\n"
+email: 
+- aduffeck@suse.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/has_alter_ego/alter_ego.rb
+- lib/has_alter_ego.rb
+- lib/tasks/has_alter_ego.rake
+- README.md
+- Rakefile
+- rails/init.rb
+- generators/has_alter_ego/templates/create_alter_egos.rb
+- generators/has_alter_ego/has_alter_ego_generator.rb
+- test/db/fixtures/alter_egos/bikes.yml
+- test/db/fixtures/alter_egos/cars.yml
+- test/db/fixtures/alter_egos/drinks.yml
+- test/test_helper.rb
+- test/has_alter_ego_test.rb
+has_rdoc: false
+homepage: http://github.com/aduffeck/has_alter_ego
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Rails plugin which makes it possible to keep seed and live data in parallel
+test_files: 
+- test/has_alter_ego_test.rb