cauta-desert 0.5.1

data/lib/desert/manager.rb

@@ -0,0 +1,129 @@
+module Desert
+  class Manager # nodoc
+    class << self
+      def instance
+        @instance ||= new
+      end
+      attr_writer :instance
+
+      protected
+      def method_missing(method_name, *args, &block)
+        instance.__send__(method_name, *args, &block)
+      end
+    end
+
+    attr_reader :loading_plugin, :plugins_in_registration
+
+    def initialize
+      @plugins = []
+      @plugins_in_registration = []
+    end
+
+    def plugins
+      @plugins.dup
+    end
+
+    def load_paths
+      paths = []
+      plugin_paths.each do |component_root|
+        paths << File.join(component_root, 'app')
+        paths << File.join(component_root, 'app','models')
+        paths << File.join(component_root, 'app','controllers')
+        paths << File.join(component_root, 'app','helpers')
+        paths << File.join(component_root, 'lib')
+      end
+      dependencies.load_paths.reverse.each do |path|
+        paths << File.expand_path(path) unless paths.include?(File.expand_path(path))
+      end
+      paths
+    end
+
+    def register_plugin(plugin_path)
+      plugin = Plugin.new(plugin_path)
+      @plugins_in_registration << plugin
+
+      yield if block_given?
+
+      dependencies.load_paths << plugin.models_path
+      dependencies.load_paths << plugin.controllers_path
+      dependencies.load_paths << plugin.helpers_path
+
+      @plugins_in_registration.pop
+
+      if existing_plugin = find_plugin(plugin.name)
+        return existing_plugin
+      end
+
+      @plugins << plugin
+      plugin
+    end
+
+    def find_plugin(name_or_directory)
+      name = File.basename(File.expand_path(name_or_directory))
+      plugins.find do |plugin|
+        plugin.name == name
+      end
+    end
+
+    def plugin_exists?(name_or_directory)
+      !find_plugin(name_or_directory).nil?
+    end
+
+    def plugin_path(name)
+      plugin = find_plugin(name)
+      return nil unless plugin
+      plugin.path
+    end
+
+    def files_on_load_path(file)
+      desert_file_exists = false
+      files = []
+      load_paths.each do |path|
+        full_path = File.join(path, file)
+        full_path << '.rb' unless File.extname(full_path) == '.rb'
+        files << full_path if File.exists?(full_path)
+      end
+      files
+    end
+
+    def directory_on_load_path?(dir_suffix)
+      Desert::Manager.load_paths.each do |path|
+        return true if File.directory?(File.join(path, dir_suffix))
+      end
+      return false
+    end
+
+    def layout_paths
+      layout_paths = plugins.reverse.collect do |plugin|
+        plugin.layouts_path
+      end
+      layout_paths
+    end
+    
+    def require_all_files
+      all_files.each do |file|
+        require file
+      end
+    end
+
+    def all_files
+      Desert::Manager.load_paths.inject([]) do |all, load_path|
+        all |= Dir["#{load_path}/**/*.rb"]
+        all
+      end
+    end
+
+    protected
+    def dependencies
+      @dependencies ||= ActiveSupport.const_defined?(:Dependencies) ? ActiveSupport::Dependencies : Dependencies
+    end
+
+    def plugin_paths
+      plugins_and_app.collect { |plugin| plugin.path }
+    end
+
+    def plugins_and_app
+      plugins + @plugins_in_registration + [Plugin.new(RAILS_ROOT)]
+    end
+  end
+end

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/1.2/extensions/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/1.2/migrator.rb

@@ -0,0 +1,33 @@
+module Desert #:nodoc:
+  module PluginMigrations
+    class Migrator < ActiveRecord::Migrator
+      class << self
+        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
+
+      def migrated
+        current_plugin_version = self.class.current_version
+        (1..current_plugin_version).to_a
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+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_migrations_table_name} (plugin_name #{type_to_sql(:string)}, version #{type_to_sql(:string)})"
+      plugins_and_versions = select_all("SELECT plugin_name, version from #{Desert::PluginMigrations::Migrator.schema_migrations_table_name}")
+      plugins_and_versions.each do |plugin_data|
+        plugin_name, version = plugin_data["plugin_name"], plugin_data["version"]
+        plugin = Desert::Manager.find_plugin(plugin_name)
+        migration_versions = Dir["#{plugin.migration_path}/*.rb"].map do |path|
+          File.basename(path, ".rb")
+        end.select do |migration|
+          # Make sure versions don't start with zero, or Integer will interpret them as octal
+          version_from_table_stripped = version.sub(/^0*/, '')
+          migration_version_stripped = migration.split("_").first.sub(/^0*/, '')
+          Integer(migration_version_stripped) <= Integer(version_from_table_stripped)
+        end
+        migration_versions.each do |migration_version|
+          insert_sql = ActiveRecord::Base.send(:sanitize_sql, [
+            "INSERT INTO #{Desert::PluginMigrations::Migrator.schema_migrations_table_name}(plugin_name, version) VALUES(?, ?)",
+            plugin_name,
+            Integer(migration_version.split("_").first.sub(/^0*/, ''))
+          ])
+          execute insert_sql
+        end
+      end
+    rescue ActiveRecord::StatementInvalid
+      # Schema has been initialized
+    end
+  end
+  alias_method_chain :initialize_schema_migrations_table, :plugins
+end

data/lib/desert/plugin_migrations/2.1/migrator.rb

@@ -0,0 +1,35 @@
+module Desert #:nodoc:
+  module PluginMigrations
+    class Migrator < ActiveRecord::Migrator
+      class << self
+        def current_version #:nodoc:
+          result = ActiveRecord::Base.connection.select_one("SELECT version FROM #{schema_migrations_table_name} WHERE plugin_name = '#{current_plugin.name}' order by version desc")
+          if result
+            result['version'].to_i
+          else
+            # There probably isn't an entry for this plugin in the migration info table.
+            0
+          end
+        end
+
+        def get_all_versions
+          ActiveRecord::Base.connection.select_values("SELECT version FROM #{schema_migrations_table_name} where plugin_name='#{current_plugin.name}'").map(&:to_i).sort
+        end
+      end
+
+      def record_version_state_after_migrating(version)
+        sm_table = self.class.schema_migrations_table_name
+
+        if down?
+          ActiveRecord::Base.connection.update("DELETE FROM #{sm_table} WHERE version = '#{version}' WHERE plugin_name = '#{current_plugin.name}'")
+        else
+          ActiveRecord::Base.connection.insert("INSERT INTO #{sm_table} (plugin_name, version) VALUES ('#{current_plugin.name}', '#{version}')")
+        end
+      end
+
+      def migrated
+        self.class.get_all_versions
+      end
+    end
+  end
+end

data/lib/desert/plugin_migrations/migrator.rb

@@ -0,0 +1,29 @@
+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
+        
+        def schema_migrations_table_name
+          ActiveRecord::Base.table_name_prefix + 'plugin_schema_migrations' + ActiveRecord::Base.table_name_suffix
+        end
+      end
+    end
+  end
+end

data/lib/desert/plugin_migrations.rb

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

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,12 @@
+module ActionView #:nodoc:
+  class TemplateFinder #: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
+  end
+end

data/lib/desert/plugin_templates/action_controller.rb

@@ -0,0 +1,12 @@
+module ActionController #:nodoc:
+  module Layout #:nodoc:
+    module ClassMethods #:nodoc:
+      private
+        def layout_list_with_plugin_routing
+          plugin_layouts = Desert::Manager.layout_paths.join(",")
+          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,17 @@
+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}/2.2.0/action_view"
+  else
+    require "#{dir}/1.2.0/action_view"
+  end
+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