reactive-activerecord 0.2.0

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2008-2009 Pascal Hurni
+Copyright (c) 2004-2007 David Heinemeier Hansson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,26 @@
+LICENSE
+Manifest
+README
+Rakefile
+lib/activerecord_meta_model.rb
+lib/reactive-activerecord.rb
+lib/tasks/databases.rake
+reactive_app_generators/activerecord/USAGE
+reactive_app_generators/activerecord/activerecord_generator.rb
+reactive_app_generators/activerecord/templates/frontbase.yml
+reactive_app_generators/activerecord/templates/ibm_db.yml
+reactive_app_generators/activerecord/templates/mysql.yml
+reactive_app_generators/activerecord/templates/oracle.yml
+reactive_app_generators/activerecord/templates/postgresql.yml
+reactive_app_generators/activerecord/templates/sqlite2.yml
+reactive_app_generators/activerecord/templates/sqlite3.yml
+reactive_generators/model/USAGE
+reactive_generators/model/model_generator.rb
+reactive_generators/model/templates/fixtures.yml
+reactive_generators/model/templates/migration.rb
+reactive_generators/model/templates/model.rb
+reactive_generators/model/templates/unit_test.rb
+reactive_generators/resource/USAGE
+reactive_generators/resource/resource_generator.rb
+reactive_generators/resource/templates/controller.rb
+reactive_generators/resource/templates/helper.rb

data/README

@@ -0,0 +1,26 @@
+== reactive-activerecord
+
+Reactive plugin that provides ActiveRecord support for Models.
+
+Version::  0.2.0
+Author::   Pascal Hurni
+Email::    phi@ruby-reactive.org
+Homepage:: http://www.ruby-reactive.org
+
+== Description
+
+Provides ActiveRecord for the ORM used by the reactive-mvc plugin.
+
+== Configuration
+
+gem_requirement::  A string specifying the activerecord gem version requirement.
+                   Defaults to none.
+logger::           The logger instance used by activerecord.
+                   Defaults to Reactive configuration#logger.
+config_file::      YAML configuration file for the database connections.
+                   Defaults to 'config/database.yml'
+
+== Requirements
+
+* reactive-core >= 0.2.0
+* activerecord >= 2.0.0

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rubygems'
+
+unless Gem.source_index.find_name('reactive-dev').empty?
+  require 'reactive-dev/tasks/plugin'
+end

data/lib/activerecord_meta_model.rb

@@ -0,0 +1,111 @@
+module Reactive
+  module MetaModel
+    module ActiveRecord
+      def self.included(base)
+        def base.meta
+          @meta ||= ActiveRecordModel.new(self)
+        end
+      end
+    
+      def supra
+        @supra ||= ActiveRecordInstance.new(self)
+      end
+    end
+  
+    class ActiveRecordInstance
+      delegate :new_record?, :changed?, :mark_for_destruction, :marked_for_destruction?,
+        :valid?, :errors,
+        :to => :@instance
+      
+      def initialize(instance)
+        @instance = instance
+      end
+    
+      # reload without hitting the database
+      # does not trigger observers
+      def revert
+        @instance.instance_variable_set(:@marked_for_destruction, false)
+        @instance.changes.each {|attr, (old,new)| @instance.send("#{attr}=", old) }
+        @instance.send(:changed_attributes).clear
+        @instance.class.meta.has_manys.each {|assoc_meta| @instance.send(assoc_meta.name).each {|record| record.supra.revert} }
+        @instance.class.meta.has_ones.each {|assoc_meta| revert_assoc(@instance.send(assoc_meta.name)) }
+      end
+    
+      protected
+      
+      def revert_assoc(assoc)
+        assoc && assoc.supra.revert
+      end
+    
+    end
+
+    class ActiveRecordModel < Model
+      
+      class Column < Column
+        def initialize(column)
+          @name, @type, @primary = column.name.to_sym, column.type, column.primary
+        end
+      end
+    
+      class Association < Association
+        def initialize(association)
+          @name, @kind, @klass = association.name.to_sym, association.macro, association.klass
+          @polymorphic = association.options[:polymorphic]
+          # TODO: has_* don't have attributes in their table, so avoid these attributes (they may clash with real attributes!)
+          @columns = [
+            association.primary_key_name,
+            association.options[:foreign_type],
+            association.counter_cache_column
+          ].compact.map(&:to_sym)
+        end
+        
+      end
+    
+      attr_reader :name
+      
+      delegate :add_observer, :delete_observer, :to => :@model
+      
+      def initialize(model)
+        @model = model
+        @name = model.to_s.demodulize.underscore
+      end
+    
+      def has_manys
+        @has_manys ||= @model.reflect_on_all_associations(:has_many).map {|association| Association.new(association)}
+      end
+    
+      def has_ones
+        @has_ones ||= @model.reflect_on_all_associations(:has_one).map {|association| Association.new(association)}
+      end
+    
+      def belong_tos
+        @belong_tos ||= @model.reflect_on_all_associations(:belongs_to).map {|association| Association.new(association)}
+      end
+    
+      def associations
+        belong_tos + has_ones + has_manys
+      end
+    
+      def columns
+        @columns ||= @model.columns.map {|column| Column.new(column)}
+      end
+    
+      def attributes
+        columns + associations
+      end
+
+      def attribute(name)
+        attributes.find {|attribute| attribute.name == name.to_sym}
+      end
+    
+    end
+  end
+end
+
+=begin
+  self.nested_resources = []
+  self.has_manys = []
+  self.has_ones = []
+  self.belong_tos = []
+  self.columns = []
+=end

data/lib/reactive-activerecord.rb

@@ -0,0 +1,29 @@
+Reactive::Initializer.configure :activerecord do
+  Reactive.configuration.reactive_activerecord.config_file ||= Reactive.path_for(:config, 'database.yml')
+  Reactive.configuration.paths[:db] = Reactive.configuration.reactive_activerecord.db_path || Reactive.path_for("db")
+end
+
+# Also called from the ModelGenerator
+def reactive_activerecord_init # :nodoc:
+  gem 'activerecord', Reactive.configuration.reactive_activerecord.gem_requirement || '>=0'
+  require 'activerecord'
+  
+  (Reactive.configuration.reactive_activerecord.base || {}).each do |name, value|
+    ActiveRecord::Base.send("#{name}=", value)
+  end
+
+  ActiveRecord::Base.logger ||= Reactive.logger
+  ActiveRecord::Base.configurations = YAML::load(IO.read(Reactive.configuration.reactive_activerecord.config_file))
+  ActiveRecord::Base.establish_connection(Reactive.configuration.environment)
+end
+
+Reactive::Initializer.init :activerecord do
+  reactive_activerecord_init
+  
+  require(File.join(File.dirname(__FILE__), 'activerecord_meta_model'))
+  ActiveRecord::Base.send(:include, Reactive::MetaModel::ActiveRecord)
+end
+
+Reactive::Initializer.after_init :activerecord do
+  ActiveRecord::Base.instantiate_observers
+end

data/lib/tasks/databases.rake

@@ -0,0 +1,349 @@
+namespace :db do
+  namespace :create do
+    desc 'Create all the local databases defined in config/database.yml'
+    task :all => :environment do
+      ActiveRecord::Base.configurations.each_value do |config|
+        # Skip entries that don't have a database key, such as the first entry here:
+        #
+        #  defaults: &defaults 
+        #    adapter: mysql 
+        #    username: root
+        #    password: 
+        #    host: localhost
+        #  
+        #  development: 
+        #    database: blog_development
+        #    <<: *defaults
+        next unless config['database']
+        # Only connect to local databases
+        if %w( 127.0.0.1 localhost ).include?(config['host']) || config['host'].blank?
+          create_database(config)
+        else
+          p "This task only creates local databases. #{config['database']} is on a remote host."
+        end
+      end
+    end
+  end
+
+  desc 'Create the database defined in config/database.yml for the current environment'
+  task :create => :environment do
+    create_database(ActiveRecord::Base.configurations[Reactive.configuration.environment])
+  end
+
+  def create_database(config)
+    begin
+      ActiveRecord::Base.establish_connection(config)
+      ActiveRecord::Base.connection
+    rescue
+      case config['adapter']
+      when 'mysql'
+        @charset   = ENV['CHARSET']   || 'utf8'
+        @collation = ENV['COLLATION'] || 'utf8_general_ci'
+        begin
+          ActiveRecord::Base.establish_connection(config.merge({'database' => nil}))
+          ActiveRecord::Base.connection.create_database(config['database'], {:charset => @charset, :collation => @collation})
+          ActiveRecord::Base.establish_connection(config)
+        rescue
+          $stderr.puts "Couldn't create database for #{config.inspect}"
+        end
+      when 'postgresql'
+        `createdb "#{config['database']}" -E utf8`
+      when 'sqlite'
+        `sqlite "#{config['database']}"`
+      when 'sqlite3'
+        `sqlite3 "#{config['database']}"`
+      end
+    else
+      p "#{config['database']} already exists"
+    end
+  end
+
+  namespace :drop do
+    desc 'Drops all the local databases defined in config/database.yml'
+    task :all => :environment do
+      ActiveRecord::Base.configurations.each_value do |config|
+        # Skip entries that don't have a database key
+        next unless config['database']
+        # Only connect to local databases
+        if config['host'] == 'localhost' || config['host'].blank?
+          drop_database(config)
+        else
+          p "This task only drops local databases. #{config['database']} is on a remote host."
+        end
+      end
+    end
+  end
+
+  desc 'Drops the database for the current environment'
+  task :drop => :environment do
+    drop_database(ActiveRecord::Base.configurations[Reactive.configuration.environment || 'development'])
+  end
+
+  desc "Migrate the database through scripts in db/migrate. Target specific version with VERSION=x. Turn off output with VERBOSE=false."
+  task :migrate => :environment do
+    ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+    ActiveRecord::Migrator.migrate(Reactive.relative_path_for(:db, "migrate/"), ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+  end
+
+  namespace :migrate do
+    desc  'Rollbacks the database one migration and re migrate up. If you want to rollback more than one step, define STEP=x'
+    task :redo => [ 'db:rollback', 'db:migrate' ]
+
+    desc 'Resets your database using your migrations for the current environment'
+    task :reset => ["db:drop", "db:create", "db:migrate"]
+  end
+
+  desc 'Rolls the schema back to the previous version. Specify the number of steps with STEP=n'
+  task :rollback => :environment do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    version = ActiveRecord::Migrator.current_version - step
+    ActiveRecord::Migrator.migrate('db/migrate/', version)
+  end
+
+  desc 'Drops and recreates the database from db/schema.rb for the current environment.'
+  task :reset => ['db:drop', 'db:create', 'db:schema:load']
+
+  desc "Retrieves the charset for the current environment's database"
+  task :charset => :environment do
+    config = ActiveRecord::Base.configurations[Reactive.configuration.environment || 'development']
+    case config['adapter']
+    when 'mysql'
+      ActiveRecord::Base.establish_connection(config)
+      puts ActiveRecord::Base.connection.charset
+    else
+      puts 'sorry, your database adapter is not supported yet, feel free to submit a patch'
+    end
+  end
+
+  desc "Retrieves the collation for the current environment's database"
+  task :collation => :environment do
+    config = ActiveRecord::Base.configurations[Reactive.configuration.environment || 'development']
+    case config['adapter']
+    when 'mysql'
+      ActiveRecord::Base.establish_connection(config)
+      puts ActiveRecord::Base.connection.collation
+    else
+      puts 'sorry, your database adapter is not supported yet, feel free to submit a patch'
+    end
+  end
+
+  desc "Retrieves the current schema version number"
+  task :version => :environment do
+    puts "Current version: #{ActiveRecord::Migrator.current_version}"
+  end
+
+  desc "Raises an error if there are pending migrations"
+  task :abort_if_pending_migrations => :environment do
+    if defined? ActiveRecord
+      pending_migrations = ActiveRecord::Migrator.new(:up, 'db/migrate').pending_migrations
+
+      if pending_migrations.any?
+        puts "You have #{pending_migrations.size} pending migrations:"
+        pending_migrations.each do |pending_migration|
+          puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+        end
+        abort "Run `rake db:migrate` to update your database then try again."
+      end
+    end
+  end
+
+  namespace :fixtures do
+    desc "Load fixtures into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+    task :load => :environment do
+      require 'active_record/fixtures'
+      ActiveRecord::Base.establish_connection(Reactive.configuration.environment.to_sym)
+      (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(Reactive.path_for(:test, 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+        Fixtures.create_fixtures('test/fixtures', File.basename(fixture_file, '.*'))
+      end
+    end
+    
+    desc "Search for a fixture given a LABEL or ID."
+    task :identify => :environment do
+      require "active_record/fixtures"
+
+      label, id = ENV["LABEL"], ENV["ID"]
+      raise "LABEL or ID required" if label.blank? && id.blank?
+      
+      puts %Q(The fixture ID for "#{label}" is #{Fixtures.identify(label)}.) if label
+      
+      Dir[Reactive.path_for(:test, 'fixtures/**/*.yml')].each do |file|
+        if data = YAML::load(ERB.new(IO.read(file)).result)
+          data.keys.each do |key|
+            key_id = Fixtures.identify(key)
+            
+            if key == label || key_id == id.to_i
+              puts "#{file}: #{key} (#{key_id})"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  namespace :schema do
+    desc "Create a db/schema.rb file that can be portably used against any DB supported by AR"
+    task :dump => :environment do
+      require 'active_record/schema_dumper'
+      File.open(ENV['SCHEMA'] || Reactive.path_for(:db, "schema.rb"), "w") do |file|
+        ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, file)
+      end
+    end
+
+    desc "Load a schema.rb file into the database"
+    task :load => :environment do
+      file = ENV['SCHEMA'] || Reactive.path_for(:db, "schema.rb")
+      load(file)
+    end
+  end
+
+  namespace :structure do
+    desc "Dump the database structure to a SQL file"
+    task :dump => :environment do
+      env = Reactive.configuration.environment
+      abcs = ActiveRecord::Base.configurations
+      case abcs[env]["adapter"]
+      when "mysql", "oci", "oracle"
+        ActiveRecord::Base.establish_connection(abcs[env])
+        File.open(Reactive.path_for(:db, "#{env}_structure.sql"), "w+") { |f| f << ActiveRecord::Base.connection.structure_dump }
+      when "postgresql"
+        ENV['PGHOST']     = abcs[env]["host"] if abcs[env]["host"]
+        ENV['PGPORT']     = abcs[env]["port"].to_s if abcs[env]["port"]
+        ENV['PGPASSWORD'] = abcs[env]["password"].to_s if abcs[env]["password"]
+        search_path = abcs[env]["schema_search_path"]
+        search_path = "--schema=#{search_path}" if search_path
+        `pg_dump -i -U "#{abcs[env]["username"]}" -s -x -O -f db/#{env}_structure.sql #{search_path} #{abcs[env]["database"]}`
+        raise "Error dumping database" if $?.exitstatus == 1
+      when "sqlite", "sqlite3"
+        dbfile = abcs[env]["database"] || abcs[env]["dbfile"]
+        `#{abcs[env]["adapter"]} #{dbfile} .schema > db/#{env}_structure.sql`
+      when "sqlserver"
+        `scptxfr /s #{abcs[env]["host"]} /d #{abcs[env]["database"]} /I /f db\\#{env}_structure.sql /q /A /r`
+        `scptxfr /s #{abcs[env]["host"]} /d #{abcs[env]["database"]} /I /F db\ /q /A /r`
+      when "firebird"
+        set_firebird_env(abcs[env])
+        db_string = firebird_db_string(abcs[env])
+        sh "isql -a #{db_string} > db/#{env}_structure.sql"
+      else
+        raise "Task not supported by '#{abcs["test"]["adapter"]}'"
+      end
+
+      if ActiveRecord::Base.connection.supports_migrations?
+        File.open(Reactive.path_for(:db, "#{env}_structure.sql"), "a") { |f| f << ActiveRecord::Base.connection.dump_schema_information }
+      end
+    end
+  end
+
+  namespace :test do
+    desc "Recreate the test database from the current environment's database schema"
+    task :clone => %w(db:schema:dump db:test:purge) do
+      ActiveRecord::Base.establish_connection(ActiveRecord::Base.configurations['test'])
+      ActiveRecord::Schema.verbose = false
+      Rake::Task["db:schema:load"].invoke
+    end
+
+
+    desc "Recreate the test databases from the development structure"
+    task :clone_structure => [ "db:structure:dump", "db:test:purge" ] do
+      env = Reactive.configuration.environment
+      abcs = ActiveRecord::Base.configurations
+      case abcs["test"]["adapter"]
+      when "mysql"
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.execute('SET foreign_key_checks = 0')
+        IO.readlines(Reactive.path_for(:db, "#{env}_structure.sql")).join.split("\n\n").each do |table|
+          ActiveRecord::Base.connection.execute(table)
+        end
+      when "postgresql"
+        ENV['PGHOST']     = abcs["test"]["host"] if abcs["test"]["host"]
+        ENV['PGPORT']     = abcs["test"]["port"].to_s if abcs["test"]["port"]
+        ENV['PGPASSWORD'] = abcs["test"]["password"].to_s if abcs["test"]["password"]
+        `psql -U "#{abcs["test"]["username"]}" -f db/#{env}_structure.sql #{abcs["test"]["database"]}`
+      when "sqlite", "sqlite3"
+        dbfile = abcs["test"]["database"] || abcs["test"]["dbfile"]
+        `#{abcs["test"]["adapter"]} #{dbfile} < db/#{env}_structure.sql`
+      when "sqlserver"
+        `osql -E -S #{abcs["test"]["host"]} -d #{abcs["test"]["database"]} -i db\\#{env}_structure.sql`
+      when "oci", "oracle"
+        ActiveRecord::Base.establish_connection(:test)
+        IO.readlines(Reactive.path_for(:db, "#{env}_structure.sql")).join.split(";\n\n").each do |ddl|
+          ActiveRecord::Base.connection.execute(ddl)
+        end
+      when "firebird"
+        set_firebird_env(abcs["test"])
+        db_string = firebird_db_string(abcs["test"])
+        sh "isql -i db/#{env}_structure.sql #{db_string}"
+      else
+        raise "Task not supported by '#{abcs["test"]["adapter"]}'"
+      end
+    end
+
+    desc "Empty the test database"
+    task :purge => :environment do
+      abcs = ActiveRecord::Base.configurations
+      case abcs["test"]["adapter"]
+      when "mysql"
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.recreate_database(abcs["test"]["database"])
+      when "postgresql"
+        ENV['PGHOST']     = abcs["test"]["host"] if abcs["test"]["host"]
+        ENV['PGPORT']     = abcs["test"]["port"].to_s if abcs["test"]["port"]
+        ENV['PGPASSWORD'] = abcs["test"]["password"].to_s if abcs["test"]["password"]
+        enc_option = "-E #{abcs["test"]["encoding"]}" if abcs["test"]["encoding"]
+
+        ActiveRecord::Base.clear_active_connections!
+        `dropdb -U "#{abcs["test"]["username"]}" #{abcs["test"]["database"]}`
+        `createdb #{enc_option} -U "#{abcs["test"]["username"]}" #{abcs["test"]["database"]}`
+      when "sqlite","sqlite3"
+        dbfile = abcs["test"]["database"] || abcs["test"]["dbfile"]
+        File.delete(dbfile) if File.exist?(dbfile)
+      when "sqlserver"
+        dropfkscript = "#{abcs["test"]["host"]}.#{abcs["test"]["database"]}.DP1".gsub(/\\/,'-')
+        `osql -E -S #{abcs["test"]["host"]} -d #{abcs["test"]["database"]} -i db\\#{dropfkscript}`
+        `osql -E -S #{abcs["test"]["host"]} -d #{abcs["test"]["database"]} -i db\\#{Reactive.configuration.environment}_structure.sql`
+      when "oci", "oracle"
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.structure_drop.split(";\n\n").each do |ddl|
+          ActiveRecord::Base.connection.execute(ddl)
+        end
+      when "firebird"
+        ActiveRecord::Base.establish_connection(:test)
+        ActiveRecord::Base.connection.recreate_database!
+      else
+        raise "Task not supported by '#{abcs["test"]["adapter"]}'"
+      end
+    end
+
+    desc 'Prepare the test database and load the schema'
+    task :prepare => %w(environment db:abort_if_pending_migrations) do
+      if defined?(ActiveRecord) && !ActiveRecord::Base.configurations.blank?
+        Rake::Task[{ :sql  => "db:test:clone_structure", :ruby => "db:test:clone" }[ActiveRecord::Base.schema_format]].invoke
+      end
+    end
+  end
+
+end
+
+def drop_database(config)
+  case config['adapter']
+  when 'mysql'
+    ActiveRecord::Base.connection.drop_database config['database']
+  when /^sqlite/
+    FileUtils.rm_f(Reactive.path_for(config['database']))
+  when 'postgresql'
+    `dropdb "#{config['database']}"`
+  end
+end
+
+def session_table_name
+  ActiveRecord::Base.pluralize_table_names ? :sessions : :session
+end
+
+def set_firebird_env(config)
+  ENV["ISC_USER"]     = config["username"].to_s if config["username"]
+  ENV["ISC_PASSWORD"] = config["password"].to_s if config["password"]
+end
+
+def firebird_db_string(config)
+  FireRuby::Database.db_string_for(config.symbolize_keys)
+end