bborn-desert 0.5.3

data/VERSION.yml

@@ -0,0 +1,2 @@
+--- 
+:version: 0.5.3

data/generators/desert_plugin/USAGE

@@ -0,0 +1,14 @@
+NAME
+     desert_plugin - creates a directory structure and starter files for a new desert plugin
+
+SYNOPSIS
+     desert_plugin [plugin name]
+
+DESCRIPTION
+     |-- vendor
+        `-- plugins
+           `-- [plugin name]
+
+EXAMPLE
+      ./script/generate desert_plugin spiffy
+

data/generators/desert_plugin/desert_plugin_generator.rb

@@ -0,0 +1,73 @@
+require 'rails_generator'
+require 'rails_generator/commands'
+
+class DesertPluginGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.directory "vendor/plugins/#{file_name}"
+
+      m.directory "vendor/plugins/#{file_name}/app"
+      m.directory "vendor/plugins/#{file_name}/app/controllers"
+      m.directory "vendor/plugins/#{file_name}/app/helpers"
+      m.directory "vendor/plugins/#{file_name}/app/models"
+      m.directory "vendor/plugins/#{file_name}/app/views"
+
+      m.directory "vendor/plugins/#{file_name}/config"
+      m.template "routes.rb", "vendor/plugins/#{file_name}/config/routes.rb"
+      m.map_route_from_plugin
+
+      m.directory "vendor/plugins/#{file_name}/db"
+      m.directory "vendor/plugins/#{file_name}/db/migrate"
+      # m.template "plugin_migration.rb", "vendor/plugins/#{file_name}/db/migrate/001_init_#{file_name}_plugin.rb" 
+
+      m.directory "vendor/plugins/#{file_name}/lib"
+
+      m.directory "vendor/plugins/#{file_name}/spec"
+      m.directory "vendor/plugins/#{file_name}/spec/controllers"
+      m.directory "vendor/plugins/#{file_name}/spec/fixtures"
+      m.directory "vendor/plugins/#{file_name}/spec/models"
+      m.directory "vendor/plugins/#{file_name}/spec/views"
+      m.file "spec_helper.rb", "vendor/plugins/#{file_name}/spec/spec_helper.rb" 
+
+      m.directory "vendor/plugins/#{file_name}/tasks"
+
+      m.file "empty_file", "vendor/plugins/#{file_name}/init.rb"
+    end
+  end
+
+end
+
+module Desert #:nodoc:
+  module Generator #:nodoc:
+    module Commands #:nodoc:
+
+      module Create
+        def map_route_from_plugin
+          logger.route "adding map.routes_from_plugin(:#{file_name}) to top of routes.rb"
+          sentinel = 'ActionController::Routing::Routes.draw do |map|'
+          gsub_file('config/routes.rb', /(#{Regexp.escape(sentinel)})/mi) do |match|
+            "#{match}\n  map.routes_from_plugin(:#{file_name})\n"
+          end
+        end
+      end
+
+      module Destroy
+        def map_route_from_plugin
+          look_for = "\n  map.routes_from_plugin(:#{file_name})\n"
+          logger.route "removing map.routes_from_plugin(:#{file_name}) from routes.rb"
+          gsub_file 'config/routes.rb', /(#{Regexp.escape(look_for)})/mi, ''
+        end
+      end
+
+      module List
+        def map_route_from_plugin
+          logger.route "adding map.routes_from_plugin(:#{file_name}) to top of routes.rb"
+        end
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Create.send   :include,  Desert::Generator::Commands::Create
+Rails::Generator::Commands::Destroy.send  :include,  Desert::Generator::Commands::Destroy
+Rails::Generator::Commands::List.send     :include,  Desert::Generator::Commands::List

data/generators/desert_plugin/templates/desert_routes.rb

@@ -0,0 +1,4 @@
+# Add your custom routes here.  If in config/routes.rb you would 
+# add <tt>map.resources</tt>, here you would add just <tt>resources</tt>
+
+# resources :<%= plural_name %>

data/generators/desert_plugin/templates/plugin_migration.rb

@@ -0,0 +1,11 @@
+class Init<%= class_name %>Plugin < ActiveRecord::Migration
+  def self.up
+    create_table "<%= plural_name %>", :force => true do |t|
+      t.column "some_<%= file_name %>_column", :string
+    end
+  end
+
+  def self.down
+    drop_table :<%= plural_name %>
+  end
+end

data/generators/desert_plugin/templates/spec_helper.rb

@@ -0,0 +1,8 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../../../../config/environment")
+require 'spec'
+require 'spec/rails'
+
+Spec::Runner.configure do |config|
+  config.fixture_path = "#{File.dirname(__FILE__)}/../spec/fixtures"
+end

data/lib/desert.rb

@@ -0,0 +1,14 @@
+require "active_support"
+require "active_record"
+require "action_controller"
+require "action_mailer"
+
+dir = File.dirname(__FILE__)
+require "#{dir}/desert/supported_rails_versions"
+require "#{dir}/desert/plugin"
+require "#{dir}/desert/manager"
+require "#{dir}/desert/version_checker"
+require "#{dir}/desert/rails"
+require "#{dir}/desert/ruby"
+require "#{dir}/desert/plugin_migrations"
+require "#{dir}/desert/plugin_templates"

data/lib/desert/manager.rb

@@ -0,0 +1,131 @@
+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, 'app','sweepers')
+        paths << File.join(component_root, 'lib')
+      end
+      dependencies.load_paths.reverse_each do |path|
+        paths << File.expand_path(path)
+      end
+      paths.uniq!
+      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.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_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,39 @@
+ActiveRecord::ConnectionAdapters::SchemaStatements.module_eval do
+  def initialize_schema_migrations_table_with_plugins
+    initialize_schema_migrations_table_without_plugins
+
+    begin
+      smt = Desert::PluginMigrations::Migrator.schema_migrations_table_name
+      unless ActiveRecord::Base.connection.tables.include?(smt)
+        execute "CREATE TABLE #{smt} (plugin_name #{type_to_sql(:string)}, version #{type_to_sql(:string)})"
+      end
+      old_smt = Desert::PluginMigrations::Migrator.schema_info_table_name
+      if ActiveRecord::Base.connection.tables.include?(old_smt)
+        plugins_and_versions = select_all("SELECT plugin_name, version from #{old_smt}")
+        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
+      end
+    rescue ActiveRecord::StatementInvalid
+      # Schema has been initialized
+    end
+  end
+  alias_method_chain :initialize_schema_migrations_table, :plugins
+end