xmigra 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed23f4357ce987546bcfd0cd391281647c71af9f
-  data.tar.gz: 681a6faf3bae62f19913d3554eec2c1800d31667
+  metadata.gz: 87e678fcb7c1e98cff100798bd30948628becbcb
+  data.tar.gz: d89d555130e4e53e28f449f1cfdcd5ded31bf942
 SHA512:
-  metadata.gz: a296f86a8e0cd4c0f41ad2d0bec9f354186d90b9504b85d83f0f0221ee506a0b41eba47a8fa48b2eb1c6414eea092c66551416b3ec67f55995eaa3e3dfe9346f
-  data.tar.gz: 546d429aa2b0acfb39b75416e42701f2c8355145d7dd22daa2abf511f0c3778f546feb331fcba24e3a0a13d17d68924df93a3fe9e0a835f3b3710b40f2e2200f
+  metadata.gz: e35d004c20dc96dfd27418281ce19ded3b1c639d8aa7cb3591ba713c29b3c1246a4389ef63801a270b6409cfef22968f6d0eaa97f71ca2db574b35eedf99b933
+  data.tar.gz: ade9c348aacb41f7a81aa669c60511076fbf20b5ea0464f129473e2a859b0dfd87a558b979910eb88104550d0b32e9f8c3cc9ff683f11055bf282ed8006674f8

data/lib/xmigra/access_artifact.rb

@@ -1,3 +1,4 @@
+require 'xmigra/plugin'
 
 module XMigra
   class AccessArtifact
@@ -26,10 +27,20 @@ module XMigra
     end
     
     def creation_sql
-      if metavar = filename_metavariable
-        @definition.gsub(metavar) {|m| self.name}
+      raw = begin
+        if metavar = filename_metavariable
+          @definition.gsub(metavar) {|m| self.name}
+        else
+          @definition
+        end
+      end
+      
+      if Plugin.active
+        raw.dup.tap do |sql|
+          Plugin.active.amend_source_sql(sql)
+        end
       else
-        @definition
+        raw
       end
     end
     

data/lib/xmigra/access_artifact_collection.rb

@@ -1,5 +1,6 @@
 
 require "tsort"
+require 'xmigra/plugin'
 
 module XMigra
   class AccessArtifactCollection
@@ -10,9 +11,21 @@ module XMigra
       filename_metavariable = filename_metavariable.dup.freeze if filename_metavariable
       
       XMigra.each_access_artifact(path) do |artifact|
-        @items[artifact.name] = artifact
         artifact.extend(db_specifics) if db_specifics
         artifact.filename_metavariable = filename_metavariable
+        
+        if Plugin.active
+          next unless Plugin.active.include_access_artifact?(artifact)
+          Plugin.active.amend_access_artifact(artifact)
+        end
+        
+        @items[artifact.name] = artifact
+      end
+      
+      if Plugin.active
+        Plugin.active.each_additional_access_artifact(db_specifics) do |artifact|
+          @items[artifact.name] = artifact
+        end
       end
     end
     

data/lib/xmigra/branch_upgrade.rb

@@ -1,5 +1,6 @@
 
 require 'xmigra/migration'
+require 'xmigra/plugin'
 
 module XMigra
   class BranchUpgrade
@@ -27,7 +28,7 @@ module XMigra
       @sql = verinc_info['sql']
     end
     
-    attr_reader :file_path, :base_migration, :target_branch, :migration_completed, :sql
+    attr_reader :file_path, :base_migration, :target_branch, :migration_completed
     
     def found?
       @found
@@ -48,6 +49,16 @@ module XMigra
       @warnings.dup
     end
     
+    def sql
+      if Plugin.active
+        @sql.dup.tap do |result|
+          Plugin.active.amend_source_sql(result)
+        end
+      else
+        @sql
+      end
+    end
+    
     def migration_completed_id
       Migration.id_from_filename(XMigra.yaml_path(migration_completed))
     end

data/lib/xmigra/console.rb

@@ -0,0 +1,115 @@
+module XMigra
+  module Console
+    class Menu
+      def initialize(title, options, prompt, opts={})
+        @title = title
+        @prompt = prompt
+        @title_width = opts[:title_width] || 40
+        @title_rule = opts[:title_rule] || '='
+        @trailing_newlines = opts[:trailing_newlines] || 3
+        get_name = opts[:get_name] || lambda {|o| o.to_s}
+        @name_map = {}
+        @menu_map = {}
+        options.each_with_index do |opt, i|
+          opt_name = get_name[opt]
+          @name_map[opt_name] = opt
+          @menu_map[i + 1] = opt_name
+        end
+      end
+      
+      attr :title, :prompt, :title_width, :title_rule, :trailing_newlines
+      
+      def show_once
+        Console.output_section(
+          title, 
+          :trailing_newlines => @trailing_newlines
+        ) do
+          @menu_map.each_pair do |item_num, name|
+            puts "#{item_num.to_s.rjust(4)}. #{name}"
+          end
+          puts
+          print prompt + ': '
+          
+          user_choice = $stdin.gets.strip
+          @menu_map[user_choice.to_i].tap do |mapped|
+            return mapped unless mapped.nil?
+          end
+          return user_choice if @menu_map.values.include? user_choice
+          by_prefix = @menu_map.values.select {|e| e.start_with? user_choice}
+          return by_prefix[0] if by_prefix.length == 1
+        end
+        return nil
+      end
+      
+      def get_selection
+        loop do
+          selection = show_once
+          break unless selection.nil?
+          puts "That input did not uniquely identify one of the available options."
+          puts
+        end
+        @trailing_newlines.times {puts}
+        return @name_map[selection]
+      end
+    end
+    
+    class InvalidInput < Exception
+      def initialize(msg=nil)
+        super(msg)
+        @explicit_message = !msg.nil?
+      end
+      
+      def explicit_message?
+        @explicit_message
+      end
+    end
+    
+    class <<self
+      def output_section(title=nil, opts={})
+        trailing_newlines = opts[:trailing_newlines] || 3
+        
+        if title
+          puts " #{title} ".center(40, '=')
+          puts
+        end
+        
+        (yield).tap do
+          trailing_newlines.times {puts}
+        end
+      end
+      
+      def validated_input(prompt)
+        loop do
+          print prompt + ": "
+          input_value = $stdin.gets.strip
+          
+          result = begin
+            yield input_value
+          rescue InvalidInput => e
+            puts e.message if e.explicit_message?
+            next
+          end
+          
+          return result unless result.nil?
+        end
+      end
+      
+      def yes_no(prompt, default_value)
+        input_options = ""
+        input_options << (default_value == :yes ? "Y" : "y")
+        input_options << (default_value == :no ? "N" : "n")
+        
+        validated_input("#{prompt} [#{input_options}]") do |input_value|
+          case input_value
+          when /^y(es)?$/io
+            true
+          when /^n(o)?$/io
+            false
+          when ''
+            {:yes => true, :no => false}[default_value]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xmigra/db_support/mssql.rb

@@ -1,3 +1,4 @@
+require 'xmigra/console'
 
 module XMigra
   module MSSQLSpecifics
@@ -1166,6 +1167,15 @@ INSERT INTO [xmigra].[branch_upgrade] ([Current]) VALUES (#{branch_id_literal});
       def string_literal(s)
         "N'#{s.gsub("'","''")}'"
       end
+      
+      def init_schema(schema_config)
+        Console.output_section "Microsoft SQL Server Specifics" do
+          if Console.yes_no("Use more verbose syntax compatible with SQL Server 2005", :no)
+            schema_config.dbinfo["MSSQL 2005 compatible"] = true
+            puts "Configured for SQL Server 2005 compatibility mode."
+          end
+        end
+      end
     end
   end
 end

data/lib/xmigra/index.rb

@@ -1,3 +1,4 @@
+require 'xmigra/plugin'
 
 module XMigra
   class Index
@@ -15,7 +16,13 @@ module XMigra
     end
     
     def definition_sql
-      @definition
+      if Plugin.active
+        @definition.dup.tap do |sql|
+          Plugin.active.amend_source_sql(sql)
+        end
+      else
+        @definition
+      end
     end
   end
 end

data/lib/xmigra/index_collection.rb

@@ -1,5 +1,6 @@
 
 require 'xmigra/index'
+require 'xmigra/plugin'
 
 module XMigra
   class IndexCollection
@@ -12,8 +13,20 @@ module XMigra
         index = Index.new(info)
         index.extend(db_specifics) if db_specifics
         index.file_path = File.expand_path(fpath)
+        
+        if Plugin.active
+          next unless Plugin.active.include_index?(index)
+          Plugin.active.amend_index(index)
+        end
+        
         @items[index.name] = index
       end
+      
+      if Plugin.active
+        Plugin.active.each_additional_index(db_specifics) do |index|
+          @items[index.name] = index
+        end
+      end
     end
     
     def [](name)

data/lib/xmigra/migration.rb

@@ -1,4 +1,5 @@
 require 'pathname'
+require 'xmigra/plugin'
 require 'xmigra/revert_file'
 
 module XMigra
@@ -17,13 +18,23 @@ module XMigra
       @changes.each {|c| c.freeze}
     end
     
-    attr_reader :id, :follows, :sql, :description, :changes
+    attr_reader :id, :follows, :description, :changes
     attr_accessor :file_path
     
     def schema_dir
       Pathname(file_path).dirname.join('..')
     end
     
+    def sql
+      if Plugin.active
+        @sql.dup.tap do |result|
+          Plugin.active.amend_source_sql(result)
+        end
+      else
+        @sql
+      end
+    end
+    
     def reversion
       result = RevertFile.new(self)
       return result if result.exist?

data/lib/xmigra/permission_script_writer.rb

@@ -1,4 +1,5 @@
 
+require 'xmigra/plugin'
 require 'xmigra/schema_manipulator'
 
 module XMigra
@@ -35,7 +36,9 @@ module XMigra
           # Grant the permissions indicated in the source file
           grant_specified_permissions_sql,
           
-        ].flatten.compact.join(ddl_block_separator)
+        ].flatten.compact.join(ddl_block_separator).tap do |result|
+          Plugin.active.amend_composed_sql(result) if Plugin.active
+        end
       end
     end
     

data/lib/xmigra/plugin.rb

@@ -0,0 +1,148 @@
+module XMigra
+  
+  # Base class for XMigra plugins.
+  #
+  # Derive a class from this class, then call XMigra::Plugin.activate! with
+  # a block that instantiates your class.
+  #
+  #   require "xmigra/plugin"
+  #   
+  #   class YearTemplatePlugin < XMigra::Plugin
+  #     def amend_composed_sql(sql)
+  #       sql.gsub! '[{year}]', Date.today.year.to_s
+  #     end
+  #   end
+  #   
+  #   XMigra::Plugin.activate! {YearTemplatePlugin.new}
+  #
+  # The last call to XMigra::Plugin.activate! will determine which block will
+  # be executed to return the active plugin, so make sure to +require+ any
+  # plugins to be aggregated before activating your own.
+  
+  class Plugin
+    class LoadingError < ::LoadError; end
+    
+    class <<self
+      attr_reader :active
+      
+      def loading?
+        !!@load_depth
+      end
+      
+      def load!(name)
+        previous_depth, @load_depth = @load_depth, (@load_depth || 0) + 1
+        @activation = nil if previous_depth.nil?
+        begin
+          require name
+        rescue ::LoadError => error
+          if previous_depth.nil? && error.path == name
+            raise LoadingError, "The XMigra plugin #{name.inspect} is not installed (Kernel#require failed)."
+          else
+            raise
+          end
+        ensure
+          @load_depth = previous_depth
+        end
+        
+        if previous_depth.nil? && @activation
+          @active = @activation.call
+        end
+      end
+      
+      def activate!(&blk)
+        @activation = blk
+      end
+    end
+    
+    
+    # Amend SQL coming from source documents.  The String object passed to
+    # this method will be included in the commands to run, and any
+    # modifications made to this object will be reflected in the script.
+    # XMigra only calls this method to amend SQL read in from source files.
+    #
+    # The default implementation does nothing.
+    
+    def amend_source_sql(sql)
+    end
+    
+    
+    # Amend SQL for script after all parts are combined.  This method will
+    # have an opportunity to amend all of the SQL in the output script,
+    # including SQL generated by XMigra.
+    #
+    # XMigra only calls this method one time for the entire output script
+    # _prior_ to any transformation necessary for script transactionality
+    # (e.g. splitting the script into batches and encoding as string
+    # literals).  The one exception to this is for any branch upgrade SQL,
+    # which will already be encoded in one or more string literals.
+    #
+    # The default implementation does nothing.
+    
+    def amend_composed_sql(sql)
+    end
+    
+    
+    # Indicate if the access artifact (stored procedure, user defined function,
+    # or view) should be included in the logical schema.
+    #
+    # The default implementation always returns +true+.
+    
+    def include_access_artifact?(artifact)
+      true
+    end
+    
+    
+    # Amend each included access artifact.
+    #
+    # _artifact_ - an XMigra::StoredProcedure, XMigra::Function, or XMigra::View
+    #
+    # The default implementation does nothing.
+    
+    def amend_access_artifact(artifact)
+    end
+    
+    
+    # Yields additional access artifacts to include in the logical schema.
+    #
+    # _db_specifics_ - A module providing methods useful for building SQL
+    #                  specific to the target RDBMS.
+    # 
+    # The yielded artifact objects must respond to +name+, +depends_on+ and
+    # +definition_sql+.
+    #
+    # The default implementation does not yield any objects.
+    
+    def each_additional_access_artifact(db_specifics=nil) # :yields: artifact
+    end
+    
+    
+    # Indicate if the index should be included in the logical schema.
+    #
+    # The default implementation always return +true+.
+    
+    def include_index?(index)
+      true
+    end
+    
+    
+    # Amend each included index.
+    #
+    # The default implementation does nothing.
+    
+    def amend_index(index)
+    end
+    
+    
+    # Yields additional indexes to include in the logical schema.
+    #
+    # _db_specifics_ - A module providing methods useful for building SQL
+    #                  specific to the target RDBMS.
+    # 
+    # The yielded index objects must respond to +name+ and +definition_sql+.
+    #
+    # The default implementation does not yield any objects.
+    
+    def each_additional_index(db_specifics=nil) # :yields: index
+    end
+  end
+end

data/lib/xmigra/program.rb

@@ -42,6 +42,9 @@ module XMigra
             end
           rescue TerminatingOption => stop
             return stop
+          rescue Plugin::LoadingError => error
+            $stderr.puts error.message
+            exit 1
           end
         ensure
           @active_subcommand = prev_subcommand
@@ -446,7 +449,7 @@ END_SECTION
       begin; section['The "SCHEMA/database.yaml" File', <<END_SECTION]
 
 The SCHEMA/database.yaml file consists of several sections that provide general
-information about the database schema.  The following subsection detail some
+information about the database schema.  The following subsections detail some
 contents that may be included in this file.
 
 system
@@ -491,6 +494,25 @@ metavariable that is used for access object definitions.  The default value
 is "[{filename}]" (excluding the quotation marks).  If that string is required
 in one or more access object definitions, this section allows the schema to
 dictate another value.
+
+XMigra plugin
+-------------
+
+If given, this section/entry provides a name to require into the XMigra
+program (see documentation on Ruby's Kernel#require), with the intention that
+the required file will define and activate an instance of a subclass of
+XMigra::Plugin (see the documentation for XMigra::Plugin or
+lib/xmigra/plugin.rb).  Only one plugin may be specified, though that one
+plugin may aggregate the functionality of other plugins.
+
+Plugins are an advanced feature that can defeat many of the measures %program_name
+takes to guarantee that a database generated from scratch will go through the
+same sequence of changes as the production database(s) has/have.  This can
+happen even unintentionally, for instance by upgrading the gem that provides
+the plugin.  While the resulting script will still (if possible) be transacted,
+the incompatibility may not be discovered until the script is run against a
+production database, requiring cancellation of deployment.  Use this feature
+with extreme caution.
 END_SECTION
       end
       begin; section['Script Generation Modes', <<END_SECTION]
@@ -626,6 +648,22 @@ END_SECTION
       puts
     end
     
+    subcommand 'init', "Interactively set up a source filesystem subtree" do |argv|
+      args, options = command_line(argv, {:edit=>true},
+                                   :help=> <<END_OF_HELP)
+This command interactively asks for and records the information needed to set
+up a filesystem subtree as a source for generating scripts.
+END_OF_HELP
+      
+      tool = SourceTreeInitializer.new(options.source_dir).extend(WarnToStderr)
+      
+      file_paths = tool.create_files!
+      
+      if options.edit
+        file_paths.each {|fpath| edit(fpath)}
+      end
+    end
+    
     subcommand 'new', "Create a new migration file" do |argv|
       args, options = command_line(argv, {:edit=>true},
                                    :argument_desc=>"MIGRATION_SUMMARY",
@@ -665,6 +703,7 @@ END_OF_HELP
                             "'%prog %cmd' does not take any arguments.")
       
       sql_gen = SchemaUpdater.new(options.source_dir).extend(WarnToStderr)
+      sql_gen.load_plugin!
       sql_gen.production = options.production
       
       output_to(options.outfile) do |out_stream|
@@ -696,6 +735,7 @@ END_OF_HELP
                             "'%prog %cmd' does not take any arguments.")
       
       sql_gen = SchemaUpdater.new(options.source_dir).extend(WarnToStderr)
+      sql_gen.load_plugin!
       
       output_to(options.outfile) do |out_stream|
         out_stream.print(sql_gen.reversion_script)
@@ -717,6 +757,7 @@ END_OF_HELP
                             "'%prog %cmd' must target an existing access object definition.")
       
       sql_gen = SchemaUpdater.new(options.source_dir).extend(WarnToStderr)
+      sql_gen.load_plugin!
       
       artifact = sql_gen.access_artifacts[args[0]] || sql_gen.access_artifacts.at_path(args[0])
       output_to(options.outfile) do |out_stream|
@@ -895,6 +936,7 @@ END_OF_HELP
       end
       
       tool = SchemaUpdater.new(options.source_dir).extend(WarnToStderr)
+      tool.load_plugin!
       
       output_to(options.outfile) do |out_stream|
         tool.migrations.each do |migration|
@@ -949,6 +991,7 @@ END_OF_HELP
                             "'%prog %cmd' does not take any arguments.")
       
       sql_gen = PermissionScriptWriter.new(options.source_dir).extend(WarnToStderr)
+      sql_gen.load_plugin!
       
       output_to(options.outfile) do |out_stream|
         out_stream.print(sql_gen.permissions_sql)

data/lib/xmigra/reversion_script_building.rb

@@ -1,4 +1,6 @@
 
+require 'xmigra/plugin'
+
 module XMigra
   module ReversionScriptBuilding
     # This module is intended to be included into XMigra::SchemaUpdater
@@ -33,8 +35,12 @@ module XMigra
         "database.\n",
       ].collect {|l| '-- ' + l + "\n"}.join('')
       
-      return usage_note + "========================================\n" + \
-          reversions.join("-- ================================== --\n")
+      "".tap do |result|
+        result << usage_note + "========================================\n"
+        result << reversions.join("-- ================================== --\n")
+        
+        Plugin.active.amend_composed_sql(result) if Plugin.active
+      end
     end
   end
 end

data/lib/xmigra/schema_manipulator.rb

@@ -8,6 +8,8 @@ module XMigra
     STRUCTURE_SUBDIR = 'structure'
     VERINC_FILE = 'branch-upgrade.yaml'
     
+    PLUGIN_KEY = 'XMigra plugin'
+    
     def initialize(path)
       @path = Pathname.new(path)
       @db_info = YAML.load_file(@path + DBINFO_FILE)
@@ -28,12 +30,20 @@ module XMigra
           m.manages(path)
         } || NoSpecifics
       )
+      
+      if @db_info.has_key? PLUGIN_KEY
+        @plugin = @db_info[PLUGIN_KEY]
+      end
     end
     
-    attr_reader :path
+    attr_reader :path, :plugin
     
     def branch_upgrade_file
       @path.join(STRUCTURE_SUBDIR, VERINC_FILE)
     end
+    
+    def load_plugin!
+      Plugin.load! plugin if plugin
+    end
   end
 end

data/lib/xmigra/schema_updater.rb

@@ -1,4 +1,5 @@
 
+require 'xmigra/plugin'
 require 'xmigra/schema_manipulator'
 require 'xmigra/reversion_script_building'
 
@@ -77,6 +78,10 @@ RUNNING THIS SCRIPT ON A PRODUCTION DATABASE WILL FAIL.
       check_working_copy!
       
       intro_comment = @db_info.fetch('script comment', '')
+      if Plugin.active
+        intro_comment = intro_comment.dup
+        Plugin.active.amend_source_sql(intro_comment)
+      end
       intro_comment << if production
         sql_comment_block(vcs_information || "")
       else
@@ -140,7 +145,9 @@ RUNNING THIS SCRIPT ON A PRODUCTION DATABASE WILL FAIL.
         
         amend_script_parts(script_parts)
         
-        script_parts.map {|mn| self.send(mn)}.flatten.compact.join(ddl_block_separator)
+        script_parts.map {|mn| self.send(mn)}.flatten.compact.join(ddl_block_separator).tap do |result|
+          Plugin.active.amend_composed_sql(result) if Plugin.active
+        end
       end
     end
     

data/lib/xmigra/source_tree_initializer.rb

@@ -0,0 +1,106 @@
+require 'pathname'
+require 'xmigra/console'
+require 'xmigra/schema_manipulator'
+
+module XMigra
+  class SourceTreeInitializer
+    class ConfigInfo
+      def initialize(root_path)
+        @root_path = Pathname(root_path)
+        @dbinfo = {}
+        @steps_after_dbinfo_creation = []
+        @created_files = []
+      end
+      
+      attr_reader :root_path, :dbinfo
+      
+      def created_files
+        @created_files.dup
+      end
+      
+      def created_file!(fpath)
+        @created_files << Pathname(fpath)
+      end
+      
+      def after_dbinfo_creation(&blk)
+        @steps_after_dbinfo_creation << blk
+      end
+      
+      def run_steps_after_dbinfo_creation!
+        @steps_after_dbinfo_creation.each do |step|
+          step.call
+        end
+      end
+    end
+    
+    def initialize(root_path)
+      @root_path = Pathname.new(root_path)
+    end
+    
+    def dbinfo_path
+      @root_path + SchemaManipulator::DBINFO_FILE
+    end
+    
+    def get_user_input_block(input_type)
+      puts "Input ends on a line containing nothing but a single '.'."
+      "".tap do |result|
+        while (line = $stdin.gets).strip != '.'
+          result << line
+        end
+      end
+    end
+    
+    def vcs_system
+      @vcs_system ||= VersionControlSupportModules.find do |m|
+        m.manages(@root_path)
+      end
+    end
+    
+    def create_files!
+      schema_config = ConfigInfo.new(@root_path)
+      
+      if vcs_system.nil?
+        puts "The indicated folder is not under version control.  Some features"
+        puts "of this system require version control for full functionality.  If"
+        puts "you later decide to use version control, you will need to configure"
+        puts "it without assistance from this script."
+        puts
+        unless Console.yes_no("Continue configuring schema management", :no)
+          return
+        end
+      end
+      
+      db_system = Console::Menu.new(
+        "Supported Database Systems",
+        DatabaseSupportModules,
+        "Target system",
+        :get_name => lambda {|m| m::SYSTEM_NAME}
+      ).get_selection
+      
+      schema_config.dbinfo['system'] = db_system::SYSTEM_NAME
+      if db_system.respond_to? :init_schema
+        db_system.init_schema(schema_config)
+      end
+      
+      if vcs_system.respond_to? :init_schema
+        vcs_system.init_schema(schema_config)
+      end
+      
+      puts "Enter a script comment.  This comment will be prepended to each"
+      puts "generated script exactly as given here."
+      script_comment = get_user_input_block('script comment').extend(LiteralYamlStyle)
+      schema_config.dbinfo['script comment'] = script_comment if script_comment != ''
+      
+      schema_config.root_path.mkpath
+      
+      dbinfo_path.open('w') do |dbinfo_io|
+        $xmigra_yamler.dump(schema_config.dbinfo, dbinfo_io)
+      end
+      schema_config.created_file! dbinfo_path
+      
+      schema_config.run_steps_after_dbinfo_creation!
+      
+      return schema_config.created_files
+    end
+  end
+end

data/lib/xmigra/vcs_support/git.rb

@@ -1,3 +1,4 @@
+require 'xmigra/console'
 
 module XMigra
   module GitSpecifics
@@ -6,6 +7,57 @@ module XMigra
     MASTER_HEAD_ATTRIBUTE = 'xmigra-master'
     MASTER_BRANCH_SUBDIR = 'xmigra-master'
     
+    class AttributesFile
+      def initialize(effect_root, access=:shared)
+        @effect_root = Pathname(effect_root)
+        @access = access
+      end
+      
+      attr_reader :effect_root, :access
+      
+      def file_relative_path
+        case @access
+        when :local
+          Pathname('.git/info/attributes')
+        else
+          Pathname('.gitattributes')
+        end
+      end
+      
+      def file_path
+        @effect_root + file_relative_path
+      end
+      
+      def path_from(path)
+        file_path.relative_path_from(Pathname(path))
+      end
+      
+      def description
+        "".tap do |result|
+          result << "#{path_from(Pathname.pwd)}"
+          
+          chars = []
+          
+          if file_path.exist?
+            chars << "exists"
+          end
+          
+          case access
+          when :local
+            chars << "local"
+          end
+          
+          unless chars.empty?
+            result << " (#{chars.join(', ')})"
+          end
+        end
+      end
+      
+      def open(*args, &blk)
+        file_path.open(*args, &blk)
+      end
+    end
+    
     class << self
       def manages(path)
         run_git(:status, :check_exit=>true, :quiet=>true)
@@ -50,6 +102,61 @@ module XMigra
         end
         return value_list[0]
       end
+      
+      def attributes_file_paths(path)
+        wdroot = Dir.chdir path do
+          Pathname(run_git('rev-parse', '--show-toplevel').strip).realpath
+        end
+        pwd = Pathname.pwd
+        
+        [].tap do |result|
+          path.realpath.ascend do |dirpath|
+            result << AttributesFile.new(dirpath)
+            break if (wdroot <=> dirpath) >= 0
+          end
+          
+          result << AttributesFile.new(wdroot, :local)
+        end
+      end
+      
+      def get_master_url
+        print "Master repository URL (empty for none): "
+        master_repo = $stdin.gets.strip
+        return nil if master_repo.empty?
+        
+        Console.validated_input "Master branch name" do |master_branch|
+          if master_branch.empty?
+            raise Console::InvalidInput.new(
+              "Master branch name required to set 'xmigra-master' attribute --"
+            )
+          end
+          "#{master_repo}##{master_branch}"
+        end
+      end
+      
+      def init_schema(schema_config)
+        Console.output_section "Git Integration" do
+          if master_url = get_master_url
+            # Select locations for .gitattributes or .git/info/attributes
+            attribs_file = Console::Menu.new(
+              "Git Attributes Files",
+              attributes_file_paths(schema_config.root_path),
+              "File for storing 'xmigra-master' attribute",
+              :get_name => lambda {|af| af.description}
+            ).get_selection
+            
+            dbinfo_path = schema_config.root_path + SchemaManipulator::DBINFO_FILE
+            attribute_pattern = "/#{dbinfo_path.relative_path_from(attribs_file.effect_root)}"
+            
+            schema_config.after_dbinfo_creation do
+              attribs_file.open('a') do |attribs_io|
+                attribs_io.puts "#{attribute_pattern} xmigra-master=#{master_url}"
+              end
+              schema_config.created_file! attribs_file.file_path
+            end
+          end
+        end
+      end
     end
     
     def git(*args)

data/lib/xmigra/vcs_support/svn.rb

@@ -1,3 +1,4 @@
+require 'xmigra/console'
 
 module XMigra
   module SubversionSpecifics
@@ -26,7 +27,7 @@ module XMigra
         cmd_parts = ["svn", subcmd.to_s]
         cmd_parts << "--xml" unless no_result || raw_result
         cmd_parts.concat(
-          args.collect {|a| '""'.insert(1, a)}
+          args.collect {|a| '""'.insert(1, a.to_s)}
         )
         cmd_str = cmd_parts.join(' ')
         
@@ -35,6 +36,31 @@ module XMigra
         return output if raw_result && !no_result
         return REXML::Document.new(output) unless no_result
       end
+      
+      def init_schema(schema_config)
+        Console.output_section "Subversion Integration" do
+          puts "Establishing a \"production pattern,\" a regular expression for"
+          puts "recognizing branch identifiers of branches used for production"
+          puts "script generation, simplifies the process of resolving conflicts"
+          puts "in the migration chain, should any arise."
+          puts
+          puts "No escaping (either shell or Ruby) of the regular expression is"
+          puts "necessary when entered here."
+          puts
+          puts "Common choices are:"
+          puts "    ^trunk/"
+          puts "    ^version/"
+          puts
+          print "Production pattern (empty to skip): "
+          
+          production_pattern = $stdin.gets.chomp
+          return if production_pattern.empty?
+          schema_config.after_dbinfo_creation do
+            tool = SchemaManipulator.new(schema_config.root_path).extend(WarnToStderr)
+            tool.production_pattern = production_pattern
+          end
+        end
+      end
     end
     
     def subversion(*args)

data/lib/xmigra/version.rb

@@ -1,3 +1,3 @@
 module XMigra
-  VERSION = "1.3.1"
+  VERSION = "1.4.0"
 end

data/lib/xmigra.rb

@@ -319,6 +319,8 @@ require 'xmigra/stored_procedure'
 require 'xmigra/view'
 require 'xmigra/function'
 
+require 'xmigra/plugin'
+
 require 'xmigra/access_artifact_collection'
 require 'xmigra/index'
 require 'xmigra/index_collection'
@@ -330,6 +332,7 @@ require 'xmigra/schema_manipulator'
 require 'xmigra/schema_updater'
 require 'xmigra/new_migration_adder'
 require 'xmigra/permission_script_writer'
+require 'xmigra/source_tree_initializer'
 
 require 'xmigra/program'
 

data/test/reversions.rb

@@ -1,33 +1,4 @@
 
-def in_xmigra_schema
-  1.temp_dirs do |schema|
-    Dir.chdir(schema) do
-      initialize_xmigra_schema
-      yield
-    end
-  end
-end
-
-def add_migration(migration_name, reversion_sql=nil)
-  tool = XMigra::NewMigrationAdder.new('.')
-  mig_path = tool.add_migration migration_name
-  mig_chain = XMigra::MigrationChain.new('structure')
-  migration = mig_chain[-1]
-  unless reversion_sql.nil?
-    class <<migration
-      def reversion_tracking_sql
-        '-- TRACK REVERSION OF MIGRATION --'
-      end
-    end
-    rev_file = XMigra::RevertFile.new(migration)
-    rev_file.path.dirname.mkpath
-    rev_file.path.open('w') do |rev_stream|
-      rev_stream.puts reversion_sql
-    end
-  end
-  return migration
-end
-
 def add_migration_reversion_pair(migration_name, reversion_sql)
   return [add_migration(migration_name, reversion_sql), reversion_sql]
 end
@@ -78,7 +49,7 @@ run_test "Generated revisions script for one migration removes application recor
     assert("Reversions script does not remove migration application record") {
       XMigra::Program.run(['reversions'])
       script = test_output
-      script =~ /DELETE\s+FROM\s+.?xmigra.?\..?applied.?\s+WHERE\s+.?MigrationID.?\s*=\s*'#{migration.id}'\s*;/
+      script =~ /DELETE\s+FROM\s+.?xmigra.?\..?applied.?\s+WHERE\s+.?MigrationID.?\s*=\s*'#{Regexp.escape migration.id}'\s*;/
     }
   end
 end

data/test/runner.rb

@@ -13,6 +13,7 @@ TESTS = %w[
 $:.unshift Pathname(__FILE__).expand_path.dirname.dirname + 'lib'
 $:.unshift Pathname(__FILE__).expand_path.dirname.dirname
 require 'xmigra'
+require 'test/utils'
 
 $test_count = 0
 $test_successes = 0
@@ -68,40 +69,6 @@ def run_test(name, &block)
   end
 end
 
-class Integer
-  def temp_dirs(prefix='')
-    tmpdirs = []
-    begin
-      (1..self).each do |i|
-        tmpdirs << Pathname(Dir.mktmpdir([prefix, ".#{i}"]))
-      end
-      
-      yield(*tmpdirs)
-    ensure
-      tmpdirs.each do |dp|
-        begin
-          FileUtils.remove_entry dp
-        rescue
-          # Skip failure
-        end
-      end
-    end
-  end
-end
-
-def do_or_die(command, message=nil, exc_type=Exception)
-  output = `#{command}`
-  $?.success? || raise(exc_type, message || ("Unable to " + command + "\n" + output))
-end
-
-def initialize_xmigra_schema(path='.', options={})
-  (Pathname(path) + XMigra::SchemaManipulator::DBINFO_FILE).open('w') do |f|
-    YAML.dump({
-      'system' => $xmigra_test_system,
-    }.merge(options[:db_info] || {}), f)
-  end
-end
-
 def test_output
   return nil unless $stdout.kind_of? StringIO
   return $stdout.string

data/test/utils.rb

@@ -0,0 +1,78 @@
+require 'fileutils'
+require 'ostruct'
+require 'pathname'
+require 'stringio'
+require 'tmpdir'
+
+class Integer
+  def temp_dirs(prefix='')
+    tmpdirs = []
+    begin
+      (1..self).each do |i|
+        tmpdirs << Pathname(Dir.mktmpdir([prefix, ".#{i}"]))
+      end
+      
+      yield(*tmpdirs)
+    ensure
+      tmpdirs.each do |dp|
+        begin
+          FileUtils.remove_entry dp
+        rescue
+          # Skip failure
+        end
+      end
+    end
+  end
+end
+
+def do_or_die(command, message=nil, exc_type=Exception)
+  output = `#{command}`
+  $?.success? || raise(exc_type, message || ("Unable to " + command + "\n" + output))
+end
+
+def initialize_xmigra_schema(path='.', options={})
+  (Pathname(path) + XMigra::SchemaManipulator::DBINFO_FILE).open('w') do |f|
+    YAML.dump({
+      'system' => $xmigra_test_system,
+    }.merge(options[:db_info] || {}), f)
+  end
+end
+
+def in_xmigra_schema
+  1.temp_dirs do |schema|
+    Dir.chdir(schema) do
+      initialize_xmigra_schema
+      yield
+    end
+  end
+end
+
+def add_migration(migration_name, reversion_sql=nil)
+  tool = XMigra::NewMigrationAdder.new('.')
+  mig_path = tool.add_migration migration_name
+  mig_chain = XMigra::MigrationChain.new('structure')
+  migration = mig_chain[-1]
+  unless reversion_sql.nil?
+    class <<migration
+      def reversion_tracking_sql
+        '-- TRACK REVERSION OF MIGRATION --'
+      end
+    end
+    rev_file = XMigra::RevertFile.new(migration)
+    rev_file.path.dirname.mkpath
+    rev_file.path.open('w') do |rev_stream|
+      rev_stream.puts reversion_sql
+    end
+  end
+  return migration
+end
+
+def capture_stdout
+  old_stdout, $stdout = $stdout, StringIO.new
+  begin
+    yield
+    return $stdout.string
+  ensure
+    $stdout = old_stdout
+  end
+end

data/xmigra.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
     XMigra is a suite of tools for managing database schema evolution with
     version controlled files.  All database manipulations are written in
     SQL (specific to the target database).  Works with Git or Subversion.
-    Currently supports Microsoft SQL Server.
+    Currently supports Microsoft SQL Server and PostgreSQL.
   END
   spec.homepage      = "https://github.com/rtweeks/xmigra"
   spec.license       = "CC-BY-SA 4.0 Itnl."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xmigra
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Next IT Corporation
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,7 +43,7 @@ description: |2
       XMigra is a suite of tools for managing database schema evolution with
       version controlled files.  All database manipulations are written in
       SQL (specific to the target database).  Works with Git or Subversion.
-      Currently supports Microsoft SQL Server.
+      Currently supports Microsoft SQL Server and PostgreSQL.
 email:
 - rtweeks21@gmail.com
 executables:
@@ -61,6 +61,7 @@ files:
 - lib/xmigra/access_artifact.rb
 - lib/xmigra/access_artifact_collection.rb
 - lib/xmigra/branch_upgrade.rb
+- lib/xmigra/console.rb
 - lib/xmigra/db_support/mssql.rb
 - lib/xmigra/db_support/psql.rb
 - lib/xmigra/function.rb
@@ -72,11 +73,13 @@ files:
 - lib/xmigra/new_file.rb
 - lib/xmigra/new_migration_adder.rb
 - lib/xmigra/permission_script_writer.rb
+- lib/xmigra/plugin.rb
 - lib/xmigra/program.rb
 - lib/xmigra/reversion_script_building.rb
 - lib/xmigra/revert_file.rb
 - lib/xmigra/schema_manipulator.rb
 - lib/xmigra/schema_updater.rb
+- lib/xmigra/source_tree_initializer.rb
 - lib/xmigra/stored_procedure.rb
 - lib/xmigra/utils.rb
 - lib/xmigra/vcs_support/git.rb
@@ -86,6 +89,7 @@ files:
 - test/git_vcs.rb
 - test/reversions.rb
 - test/runner.rb
+- test/utils.rb
 - xmigra.gemspec
 homepage: https://github.com/rtweeks/xmigra
 licenses: