tog-desert 0.3.4

data/lib/desert/plugin.rb

@@ -0,0 +1,74 @@
+module Desert
+  class Plugin # nodoc
+    attr_reader :name, :path
+    def initialize(path)
+      @path = File.expand_path(path)
+      @name = File.basename(@path)
+    end
+
+    def migration_path
+      "#{@path}/db/migrate"
+    end
+
+    # The path to the views for this plugin
+    def templates_path
+      "#{@path}/app/views"
+    end
+
+    def controllers_path
+      "#{@path}/app/controllers"
+    end
+
+    # TODO: Test me
+    def models_path
+      "#{@path}/app/models"
+    end
+
+    # TODO: Test me
+    def helpers_path
+      "#{@path}/app/helpers"
+    end
+
+    # The path to the layout for this plugin
+    def layouts_path
+      "#{templates_path}/layouts"
+    end
+
+    # Finds a template with the specified path
+    def find_template(template)
+      template_path = "#{templates_path}/#{template}"
+      File.exists?(template_path) ? template_path : nil
+    end
+
+    def framework_paths
+      # TODO: Don't include dirs for frameworks that are not used
+      %w(
+        railties
+        railties/lib
+        actionpack/lib
+        activesupport/lib
+        activerecord/lib
+        actionmailer/lib
+        actionwebservice/lib
+      ).map { |dir| "#{framework_root_path}/#{dir}" }.select { |dir| File.directory?(dir) }
+    end
+
+    def ==(other)
+      self.path == other.path
+    end
+
+    def migration
+      @migration ||= PluginMigrations::Migrator.new(:up, migration_path)
+    end
+
+    def with_current_plugin
+      old_plugin = PluginMigrations::Migrator.current_plugin
+      begin
+        PluginMigrations::Migrator.current_plugin = self
+        yield
+      ensure
+        PluginMigrations::Migrator.current_plugin = old_plugin
+      end
+    end
+  end
+end

data/lib/desert/plugin_migrations/extensions/1.0/schema_statements.rb

@@ -0,0 +1,34 @@
+ActiveRecord::ConnectionAdapters::SchemaStatements.module_eval do
+  def initialize_schema_information_with_plugins
+    initialize_schema_information_without_plugins
+
+    begin
+      execute "CREATE TABLE #{Desert::PluginMigrations::Migrator.schema_info_table_name} (plugin_name #{type_to_sql(:string)}, version #{type_to_sql(:integer)})"
+    rescue ActiveRecord::StatementInvalid
+      # Schema has been initialized
+    end
+  end
+  alias_method_chain :initialize_schema_information, :plugins
+
+  def dump_schema_information_with_plugins
+    schema_information = []
+
+    dump = dump_schema_information_without_plugins
+    schema_information << dump if dump
+
+    begin
+      plugins = ActiveRecord::Base.connection.select_all("SELECT * FROM #{Desert::PluginMigrations::Migrator.schema_info_table_name}")
+      plugins.each do |plugin|
+        if (version = plugin['version'].to_i) > 0
+          plugin_name = ActiveRecord::Base.quote_value(plugin['plugin_name'])
+          schema_information << "INSERT INTO #{Desert::PluginMigrations::Migrator.schema_info_table_name} (plugin_name, version) VALUES (#{plugin_name}, #{version})"
+        end
+      end
+    rescue ActiveRecord::StatementInvalid
+      # No Schema Info
+    end
+
+    schema_information.join(";\n")
+  end
+  alias_method_chain :dump_schema_information, :plugins
+end

data/lib/desert/plugin_migrations/extensions/2.1/schema_statements.rb

@@ -0,0 +1,12 @@
+ActiveRecord::ConnectionAdapters::SchemaStatements.module_eval do
+  def initialize_schema_migrations_table_with_plugins
+    initialize_schema_migrations_table_without_plugins
+
+    begin
+      execute "CREATE TABLE #{Desert::PluginMigrations::Migrator.schema_info_table_name} (plugin_name #{type_to_sql(:string)}, version #{type_to_sql(:integer)})"
+    rescue ActiveRecord::StatementInvalid
+      # Schema has been initialized
+    end
+  end
+  alias_method_chain :initialize_schema_migrations_table, :plugins
+end

data/lib/desert/plugin_migrations/extensions/schema_statements.rb

@@ -0,0 +1,6 @@
+dir = File.dirname(__FILE__)
+if ActiveRecord::ConnectionAdapters::SchemaStatements.instance_methods.include?('initialize_schema_information')
+  require "#{dir}/1.0/schema_statements"
+else
+  require "#{dir}/2.1/schema_statements"
+end

data/lib/desert/plugin_migrations/migrator.rb

@@ -0,0 +1,54 @@
+module Desert #:nodoc:
+  module PluginMigrations
+    # Responsible for migrating plugins.  PluginMigrations.Migrator.current_plugin
+    # indicates which plugin is currently being migrated
+    class Migrator < ActiveRecord::Migrator
+      # We need to be able to set the current plugin being migrated.
+      cattr_accessor :current_plugin
+
+      class << self
+        # Runs the migrations from a plugin, up (or down) to the version given
+        def migrate_plugin(plugin, version = nil)
+          self.current_plugin = plugin
+          if ActiveRecord::Base.connection.respond_to?(:initialize_schema_migrations_table)
+            ActiveRecord::Base.connection.initialize_schema_migrations_table
+          end
+          migrate(plugin.migration_path, version)
+        end
+
+        def schema_info_table_name #:nodoc:
+          ActiveRecord::Base.table_name_prefix + 'plugin_schema_info' + ActiveRecord::Base.table_name_suffix
+        end
+        alias_method :schema_migrations_table_name, :schema_info_table_name
+
+        def current_version #:nodoc:
+          result = ActiveRecord::Base.connection.select_one("SELECT version FROM #{schema_info_table_name} WHERE plugin_name = '#{current_plugin.name}'")
+          if result
+            result['version'].to_i
+          else
+            # There probably isn't an entry for this plugin in the migration info table.
+            0
+          end
+        end
+      end
+
+      def set_schema_version(version)
+        version = down? ? version.to_i - 1 : version.to_i
+
+        if ActiveRecord::Base.connection.select_one("SELECT version FROM #{self.class.schema_info_table_name} WHERE plugin_name = '#{current_plugin.name}'").nil?
+          # We need to create the entry since it doesn't exist
+          ActiveRecord::Base.connection.execute("INSERT INTO #{self.class.schema_info_table_name} (version, plugin_name) VALUES (#{version},'#{current_plugin.name}')")
+        else
+          ActiveRecord::Base.connection.update("UPDATE #{self.class.schema_info_table_name} SET version = #{version} WHERE plugin_name = '#{current_plugin.name}'")
+        end
+      end
+      alias_method :record_version_state_after_migrating, :set_schema_version
+
+
+      def migrated
+        current_plugin_version = self.class.current_version
+        (1..current_plugin_version).to_a
+      end
+    end
+  end
+end

data/lib/desert/plugin_migrations.rb

@@ -0,0 +1,3 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/plugin_migrations/migrator"
+require "#{dir}/plugin_migrations/extensions/schema_statements"

data/lib/desert/plugin_templates/1.2.0/action_mailer.rb

@@ -0,0 +1,21 @@
+module ActionMailer #:nodoc
+  class Base #:nodoc:
+    private
+      def template_path_with_plugin_routing
+        template_paths = [template_path_without_plugin_routing]
+        Desert::Manager.plugins.reverse.each do |plugin|
+          template_paths << "#{plugin.templates_path}/#{mailer_name}"
+        end
+        "{#{template_paths * ','}}"
+      end
+      alias_method_chain :template_path, :plugin_routing
+
+      def initialize_template_class(assigns)
+        view_path = File.dirname(Dir["#{template_path}/#{@template}.*"].first)
+        returning(template = ActionView::Base.new(view_path, assigns, self)) do
+          template.extend ApplicationHelper
+          template.extend self.class.master_helper_module
+        end
+      end
+  end
+end

data/lib/desert/plugin_templates/1.2.0/action_view.rb

@@ -0,0 +1,53 @@
+module ActionView
+  class Base
+    attr_reader :view_paths
+    def initialize_with_desert(base_path = nil, assigns_for_first_render = {}, controller = nil)
+      initialize_without_desert(base_path, assigns_for_first_render, controller)
+
+      @view_paths = [base_path]
+      Desert::Manager.plugins_and_app.reverse.each do |plugin|
+        @view_paths << plugin.templates_path
+      end
+    end
+    alias_method_chain :initialize, :desert
+
+    private
+    def full_path_template_exists?(path, extension)
+      file_path = "#{path}.#{extension}"
+      @@method_names.has_key?(file_path) || FileTest.exists?(file_path)
+    end
+
+    def find_template_extension_for(template_path)
+      view_paths.each do |view_path|
+        full_path = "#{view_path}/#{template_path}"
+        if match = @@template_handlers.find { |k,| full_path_template_exists?(template_path, k) }
+          return match.first.to_sym
+        elsif full_path_template_exists?(full_path, :rhtml)
+          return :rhtml
+        elsif full_path_template_exists?(full_path, :rxml)
+          return :rxml
+        elsif full_path_template_exists?(full_path, :rjs)
+          return :rjs
+        end
+      end
+      raise ActionViewError, "No rhtml, rxml, rjs or delegate template found for #{template_path} in #{@base_path}"
+    end
+
+    def full_template_path_with_plugin_routing(template_path, extension)
+      full_template_path = full_template_path_without_plugin_routing(template_path, extension)
+
+      unless File.exist?(full_template_path)
+        # Look through the plugins for the template
+        Desert::Manager.plugins.reverse.each do |plugin|
+          if plugin_template_path = plugin.find_template("#{template_path}.#{extension}")
+            full_template_path = plugin_template_path
+            break
+          end
+        end
+      end
+
+      full_template_path
+    end
+    alias_method_chain :full_template_path, :plugin_routing
+  end
+end

data/lib/desert/plugin_templates/1.99.0/action_mailer.rb

@@ -0,0 +1,25 @@
+module ActionMailer #:nodoc
+  class Base #:nodoc:
+    private
+      def template_path_with_plugin_routing
+        result = nil
+        Desert::Manager.plugins_and_app.reverse.each do |plugin|
+          relative_path = "#{plugin.templates_path}/#{mailer_name}"
+          unless Dir["#{relative_path}/#{@template}.*"].empty?
+            result = relative_path
+            break
+          end
+        end
+        result || template_path_without_plugin_routing
+      end
+      alias_method_chain :template_path, :plugin_routing
+
+      def initialize_template_class(assigns)
+        view_path = File.dirname(Dir["#{template_path}/#{@template}.*"].first)
+        returning(template = ActionView::Base.new([view_path], assigns, self)) do
+          template.extend ApplicationHelper
+          template.extend self.class.master_helper_module
+        end
+      end
+  end
+end

data/lib/desert/plugin_templates/1.99.0/action_view.rb

@@ -0,0 +1,38 @@
+module ActionView #:nodoc:
+  class Base #:nodoc:
+    def initialize_with_desert_plugins(*args)
+      initialize_without_desert_plugins *args
+
+      Desert::Manager.plugins.reverse.each do |plugin|
+        view_paths << plugin.templates_path
+      end
+    end
+    alias_method_chain :initialize, :desert_plugins
+    
+    def find_template_extension_from_handler(template_path, formatted = nil)
+      checked_template_path = formatted ? "#{template_path}.#{template_format}" : template_path
+
+      view_paths.each do |view_path|
+        template_handler_preferences.each do |template_type|
+          extensions =
+            case template_type
+            when :javascript
+              [:rjs]
+            when :delegate
+              @@template_handlers.keys
+            else
+              [template_type]
+            end
+
+          extensions.each do |extension|
+            file_path = File.join(view_path, "#{checked_template_path}.#{extension}")
+            if File.exist?(file_path)
+              return formatted ? "#{template_format}.#{extension}" : extension.to_s
+            end
+          end
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/desert/plugin_templates/2.0.0/action_mailer.rb

@@ -0,0 +1,23 @@
+module ActionMailer #:nodoc
+  class Base #:nodoc:
+    private
+      def template_path_with_plugin_routing
+        template_paths = [template_path_without_plugin_routing]
+        Desert::Manager.plugins.reverse.each do |plugin|
+          template_paths << "#{plugin.templates_path}/#{mailer_name}"
+        end
+        "{#{template_paths * ','}}"
+      end
+      alias_method_chain :template_path, :plugin_routing
+
+      def initialize_template_class(assigns)
+        view_paths = Dir[template_path].collect do |path|
+          File.dirname(path)
+        end
+        returning(template = ActionView::Base.new(view_paths, assigns, self)) do
+          template.extend ApplicationHelper
+          template.extend self.class.master_helper_module
+        end
+      end
+  end
+end

data/lib/desert/plugin_templates/2.0.2/action_view.rb

@@ -0,0 +1,26 @@
+module ActionView #:nodoc:
+  class Base #:nodoc:
+    def initialize_with_desert_plugins(*args)
+      initialize_without_desert_plugins *args
+
+      Desert::Manager.plugins.reverse.each do |plugin|
+        append_view_path plugin.templates_path
+      end
+    end
+    alias_method_chain :initialize, :desert_plugins
+    
+    def find_template_extension_from_handler(template_path, formatted = nil)
+      checked_template_path = formatted ? "#{template_path}.#{template_format}" : template_path
+
+      view_paths.each do |view_path|
+        self.class.template_handler_extensions.each do |extension|
+          file_path = File.join(view_path, "#{checked_template_path}.#{extension}")
+          if File.exist?(file_path)
+            return formatted ? "#{template_format}.#{extension}" : extension.to_s
+          end
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/desert/plugin_templates/2.1.0/action_view.rb

@@ -0,0 +1,13 @@
+module ActionView #:nodoc:
+  class TemplateFinder #:nodoc:
+    def initialize_with_desert_plugins(base, *paths)
+      self.class.process_view_paths(*paths)
+      initialize_without_desert_plugins base, *paths
+
+      Desert::Manager.plugins.reverse.each do |plugin|
+        append_view_path plugin.templates_path
+      end
+    end
+    alias_method_chain :initialize, :desert_plugins
+  end
+end

data/lib/desert/plugin_templates/action_controller.rb

@@ -0,0 +1,14 @@
+module ActionController #:nodoc:
+  module Layout #:nodoc:
+    module ClassMethods #:nodoc:
+      private
+        def layout_list_with_plugin_routing
+          plugin_layouts = Desert::Manager.layout_paths.join(",")
+          plugin_layouts.empty? ?
+            layout_list_without_plugin_routing :
+            layout_list_without_plugin_routing + Dir["{#{plugin_layouts}}/**/*"]
+        end
+        alias_method_chain :layout_list, :plugin_routing
+    end
+  end
+end

data/lib/desert/plugin_templates/action_view.rb

@@ -0,0 +1,16 @@
+dir = File.dirname(__FILE__)
+if ActionView.const_defined?(:TemplateFinder)
+  require "#{dir}/2.1.0/action_view"
+else
+  if ActionView::Base.private_instance_methods.include?('find_template_extension_from_handler')
+    if ActionView::Base.instance_methods.include?('template_handler_preferences')
+      require "#{dir}/1.99.0/action_view"
+    else
+      require "#{dir}/2.0.2/action_view"
+    end
+  elsif ActionView.const_defined?(:PathSet)
+    require "#{dir}/edge/action_view"
+  else
+    require "#{dir}/1.2.0/action_view"
+  end
+end

data/lib/desert/plugin_templates/edge/action_view.rb

@@ -0,0 +1,10 @@
+ActionView::Base.class_eval do
+  def initialize_with_desert_plugins(*args)
+    initialize_without_desert_plugins *args
+
+    Desert::Manager.plugins.reverse.each do |plugin|
+      view_paths << plugin.templates_path
+    end
+  end
+  alias_method_chain :initialize, :desert_plugins
+end

data/lib/desert/plugin_templates.rb

@@ -0,0 +1,10 @@
+dir = File.dirname(__FILE__)
+require "#{dir}/plugin_templates/action_controller"
+if Desert::VersionChecker.rails_version_is_below_1990?
+  require "#{dir}/plugin_templates/1.2.0/action_mailer"
+elsif Desert::VersionChecker.rails_version_is_below_rc2?
+  require "#{dir}/plugin_templates/1.99.0/action_mailer"
+else
+  require "#{dir}/plugin_templates/2.0.0/action_mailer"
+end
+require "#{dir}/plugin_templates/action_view"

data/lib/desert/rails/1.2.0/initializer.rb

@@ -0,0 +1,20 @@
+module Rails
+  class Initializer
+    def load_plugin_with_desert(directory)
+      return if Desert::Manager.plugin_exists?(directory)
+      plugin = Desert::Manager.register_plugin(directory) do
+        load_plugin_without_desert(directory)
+      end
+      # TODO: Can we use Initializer::Configuration#default_load_paths to do this?
+      configuration.controller_paths << plugin.controllers_path
+    end
+    alias_method_chain :load_plugin, :desert
+
+    def require_plugin(plugin_name)
+      find_plugins(configuration.plugin_paths).sort.each do |path|
+        return load_plugin(path) if File.basename(path) == plugin_name
+      end
+      raise "Plugin '#{plugin_name}' does not exist"
+    end
+  end
+end

data/lib/desert/rails/2.0.0/plugin.rb

@@ -0,0 +1,22 @@
+class Rails::Plugin
+  attr_accessor :initializer
+  def require_plugin(plugin_name)
+    initializer.configuration.plugin_locators.each do |locator|
+      locator.new(initializer).each do |plugin_loader|
+        return plugin_loader.load(initializer) if plugin_loader.name.to_s == plugin_name.to_s
+      end
+    end
+    raise "Plugin '#{plugin_name}' does not exist"
+  end
+
+  def load_with_desert(initializer)
+    @initializer = initializer
+    return if Desert::Manager.plugin_exists?(directory)
+    plugin = Desert::Manager.register_plugin(directory) do
+      load_without_desert(initializer)
+    end
+    # TODO: Can we use Initializer::Configuration#default_load_paths to do this?
+    initializer.configuration.controller_paths << plugin.controllers_path
+  end
+  alias_method_chain :load, :desert
+end

data/lib/desert/rails/dependencies.rb

@@ -0,0 +1,87 @@
+dependencies = ActiveSupport.const_defined?(:Dependencies) ? ActiveSupport::Dependencies : Dependencies
+dependencies.module_eval do
+  def load_missing_constant_with_desert(from_mod, const_name)
+    from_mod = guard_against_anonymous_module(from_mod)
+    qualified_name = qualified_name_for from_mod, const_name
+    path_suffix = qualified_name.underscore
+
+    if define_constant_with_desert_loading(from_mod, const_name, qualified_name, path_suffix)
+      return from_mod.const_get(const_name)
+    end
+
+    if has_parent_module?(from_mod)
+      look_for_constant_in_parent_module(from_mod, const_name, qualified_name, path_suffix)
+    else
+      raise NameError, "Constant #{qualified_name} from #{path_suffix}.rb not found"
+    end
+  end
+  alias_method_chain :load_missing_constant, :desert
+
+  def load_once_path?(path)
+    load_once_paths.any? { |base| File.expand_path(path).starts_with? File.expand_path(base) }
+  end
+
+  def depend_on_with_desert(file_name, swallow_load_errors = false)
+    successfully_loaded_in_plugin = false
+    Desert::Manager.files_on_load_path(file_name).each do |file|
+      require_or_load(file)
+      successfully_loaded_in_plugin = true
+    end
+    begin
+      unless successfully_loaded_in_plugin
+        require_or_load file_name
+        loaded << File.expand_path(file_name)
+      end
+    rescue LoadError
+      if !swallow_load_errors && !successfully_loaded_in_plugin
+        raise
+      end
+    end
+  end
+  alias_method_chain :depend_on, :desert
+
+  protected
+  def define_constant_with_desert_loading(from_mod, const_name, qualified_name, path_suffix)
+    define_constant_from_file(from_mod, const_name, qualified_name, path_suffix) ||
+      define_constant_from_directory(from_mod, const_name, qualified_name, path_suffix)
+  end
+
+  def has_parent_module?(mod)
+    mod != Object
+  end
+
+  def look_for_constant_in_parent_module(from_mod, const_name, qualified_name, path_suffix)
+    return from_mod.parent.const_missing(const_name)
+  rescue NameError => e
+    raise NameError, "Constant #{qualified_name} from #{path_suffix}.rb not found\n#{e.message}"
+  end
+
+  def guard_against_anonymous_module(from_mod)
+    return Object if from_mod.name.blank?
+    return from_mod
+  end
+
+  def define_constant_from_file(from_mod, const_name, qualified_name, path_suffix)
+    files = Desert::Manager.files_on_load_path(path_suffix)
+    files.each do |file|
+      require_or_load file
+      loaded << file.gsub(/\.rb$/, '')
+      next if autoloaded_constants.include?(qualified_name)
+      next if load_once_path?(file)
+      autoloaded_constants << qualified_name
+    end
+    loaded << File.expand_path(path_suffix)
+    from_mod.const_defined?(const_name)
+  end
+
+  def define_constant_from_directory(from_mod, const_name, qualified_name, path_suffix)
+    return false unless Desert::Manager.directory_on_load_path?(path_suffix)
+
+    if autoloaded_constants.include?(qualified_name)
+      raise "Constant #{qualified_name} is already autoloaded but is not defined as a constant"
+    end
+    from_mod.const_set(const_name, Module.new)
+    autoloaded_constants << qualified_name
+    return true
+  end
+end

data/lib/desert/rails/migration.rb

@@ -0,0 +1,36 @@
+class ActiveRecord::Migration
+  module DesertMigration
+    def migrate_plugin(plugin_name, version)
+      plugin = find_plugin(plugin_name)
+      Desert::PluginMigrations::Migrator.migrate_plugin(
+        plugin,
+        version
+      )
+    end
+
+    protected
+    def find_plugin(plugin_name)
+      plugin = Desert::Manager.find_plugin(plugin_name.to_s)
+      return plugin if plugin
+      raise ArgumentError, "No plugin found named #{plugin_name}"
+    end
+
+    def table_exists?(table_name)
+      vals = select_all("DESC #{table_name}")
+      return true
+    rescue ActiveRecord::StatementInvalid
+      return false
+    end
+
+    def column_exists?(table_name, column_name)
+      val = select_one("select #{column_name} from #{table_name}")
+      return true
+    rescue ActiveRecord::StatementInvalid
+      return false
+    end
+    def table_exists?(table_name)
+      ActiveRecord::Base.connection.tables.include? table_name
+    end
+  end
+  extend DesertMigration
+end

data/lib/desert/rails/observer.rb

@@ -0,0 +1,22 @@
+module Desert
+  module Rails
+    module Observer
+      def self.observers=(*observers)
+        @observers = observers.flatten
+      end
+      def self.observers
+        @observers ||= []
+      end
+    end
+  end
+end
+
+class Rails::Initializer
+  def load_observers_with_desert
+    # todo verify if this should be logged
+    puts  "Adding #{Desert::Rails::Observer.observers.inspect} to #{ActiveRecord::Base.observers.inspect}"
+    ActiveRecord::Base.observers += Desert::Rails::Observer.observers.uniq
+    load_observers_without_desert
+  end
+  alias_method_chain :load_observers, :desert
+end

data/lib/desert/rails/route_set.rb

@@ -0,0 +1,23 @@
+module Desert
+  module Rails
+    module RouteSet
+      # Loads the set of routes from within a plugin and evaluates them at this
+      # point within an application's main <tt>routes.rb</tt> file.
+      #
+      # Plugin routes are loaded from <tt><plugin_root>/routes.rb</tt>.
+      def routes_from_plugin(name)
+        name = name.to_s
+        routes_path = File.join(
+          Desert::Manager.plugin_path(name),
+          "config/routes.rb"
+        )
+        RAILS_DEFAULT_LOGGER.debug "Loading routes from #{routes_path}."
+        eval(IO.read(routes_path), binding, routes_path) if File.file?(routes_path)
+      end
+    end
+  end
+end
+
+class ActionController::Routing::RouteSet::Mapper
+  include Desert::Rails::RouteSet
+end