statesman-trigger 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9ae2e9640d93d968e583f6ed5dcf8c80a4f85ff
-  data.tar.gz: 5796a36556bad99d890174522ed94ca295161a99
+  metadata.gz: 4aa120ba58e0a9739d02b5ccc9838fa4c88cd6e8
+  data.tar.gz: bb1f4c91f67b04f963f316566fa27188a9fd022b
 SHA512:
-  metadata.gz: 0fb83a8b14e76e37c475d7141efb317487472f2e02f296cd32ab81bb6c7cb25ab2d5e051ceb8d4ea4635ac4c836cc74320da8bf6dc2d9f9d63bfdf52d6752f97
-  data.tar.gz: 550682de13db79df2da3b08fce45e810f9dd27f764c29bdb77ff03a71ada73ac45caaa95c9e7c8d6b5c0946b97d20282f2eb9f6f2541de7462d277148ac978e7
+  metadata.gz: ce618ee125c93a5150dcd151cbb10d1969240f472707d8c739829bf5fd7fe879a5b8c2afce5ef2234f857aac89befe955aea455e30f4ce6603d4b53fb99be531
+  data.tar.gz: d72cb76d9ead48c4cd7f0ee87dc1bbb5c443487a3e2cfd21d85779f8574269fd041b6bf2d8baa3cd71a33c1982a231300f598e112fbc139a56dc7999fcd728b7

data/.yardopts

@@ -0,0 +1,8 @@
+--private
+--protected
+-m markdown
+lib/**/*.rb
+-
+README.md
+CODE_OF_CONDUCT.md
+LICENSE.txt

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,15 @@
+# @markup markdown
+# @title Contributor Code of Conduct
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/LICENSE.txt

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

data/Rakefile

@@ -1,12 +1,18 @@
 require "bundler/gem_tasks"
 
-begin
-  require 'rspec/core/rake_task'
+require 'yard'
+require 'rspec/core/rake_task'
+require 'yard/rake/yardoc_task'
 
-  RSpec::Core::RakeTask.new(:spec) do |t|
-    t.verbose = false
-  end
-rescue LoadError
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', '-', 'README.md', 'LICENSE.txt', 'CODE_OF_CONDUCT.md']
+  t.options = ['--private', '--protected']
+  t.stats_options = ['--list-undoc']
 end
 
 task :default => :spec

data/lib/statesman/trigger.rb

@@ -5,19 +5,22 @@ require "pg"
 require "virtus"
 require "dedent"
 
+# Namespace for [Statesman gem](https://github.com/gocardless/statesman).
 module Statesman
+  # Namespace for this gem.
   module Trigger
+    # Raised when a value can't be introspected
+    class IntrospectionError < NoMethodError; end
+
     require_relative './trigger/null_object'
     require_relative './trigger/parameters'
     require_relative './trigger/abstract_query'
     require_relative './trigger/trigger_query'
     require_relative './trigger/update_function_query'
     require_relative './trigger/integration'
-    require_relative './trigger/migrations'
   end
 end
 
 ActiveSupport.on_load :active_record do
-  ActiveRecord::ConnectionAdapters::AbstractAdapter.include Statesman::Trigger::Integration
-  ActiveRecord::Migration::CommandRecorder.include Statesman::Trigger::Migrations
+  Statesman::Trigger::Integration.install!
 end

data/lib/statesman/trigger/abstract_query.rb

@@ -8,32 +8,47 @@ module Statesman
       # @return [Statesman::Trigger::Parameters]
       attr_reader :parameters
 
+      # @param [Statesman::Trigger::Parameters] parameters
       def initialize(parameters)
         @parameters = parameters
       end
 
+      # @return [String] the formatted {#up_query} based on {#parameters}.
       def up
         up_query % parameters.for_query
       end
 
+      # @return [String] the formatted {#down_query} based on {#parameters}.
       def down
         down_query % parameters.for_query
       end
 
       protected
+      # @!attribute [r] up_query
+      # @return [String]
       def up_query
         config.up_query.presence or raise 'Define up!'
       end
 
+      # @!attribute [r] down_query
+      # @return [String]
       def down_query
         config.down_query.presence or raise 'Define down!'
       end
 
       class << self
+        # Set the {#up_query} SQL for this class.
+        #
+        # @param [String] raw_sql
+        # @return [void]
         def up!(raw_sql)
           config.up_query = raw_sql.dedent
         end
 
+        # Set the {#down_query} SQL for this class.
+        #
+        # @param [String] raw_sql
+        # @return [void]
         def down!(raw_sql)
           config.down_query = raw_sql.dedent
         end

data/lib/statesman/trigger/integration.rb

@@ -1,35 +1,24 @@
 module Statesman
   module Trigger
+    # Integration with ActiveRecord.
     module Integration
       extend ActiveSupport::Concern
 
-      def create_statesman_trigger(options = {})
-        statesman_trigger_requires_pg!
-
-        params = Statesman::Trigger::Parameters.new options
-
-        validation_query = params.build_validation_query
-
-        raise "target column `#{params.sync_column}` not found on `#{params.model_table}`." unless select_value(validation_query)
-
-        params.build_statements(direction: :up).map do |stmt|
-          execute stmt
+      require_relative './integration/shared_methods'
+      require_relative './integration/adapter_methods'
+      require_relative './integration/command_recorder_methods'
+      require_relative './integration/migration_methods'
+
+      class << self
+        # Used in an `ActiveSupport.on_load :active_record` callback to install the ActiveRecord integrations.
+        #
+        # @return [void]
+        def install!
+          ActiveRecord::ConnectionAdapters::AbstractAdapter.include Statesman::Trigger::Integration::AdapterMethods
+          ActiveRecord::Migration::CommandRecorder.include Statesman::Trigger::Integration::CommandRecorderMethods
+          ActiveRecord::Migration.include Statesman::Trigger::Integration::MigrationMethods
         end
       end
-
-      def drop_statesman_trigger(options = {})
-        statesman_trigger_requires_pg!
-
-        params = Statesman::Trigger::Parameters.new options
-
-        params.build_statements(direction: :down).map do |stmt|
-          execute stmt
-        end
-      end
-
-      def statesman_trigger_requires_pg!
-        raise 'Requires postgres' unless adapter_name =~ /postg/i
-      end
     end
   end
 end

data/lib/statesman/trigger/integration/adapter_methods.rb

@@ -0,0 +1,46 @@
+module Statesman
+  module Trigger
+    module Integration
+      # Integration with `ActiveRecord::ConnectionAdapters::AbstractAdapter`
+      #
+      # @note only Postgres is currently supported.
+      module AdapterMethods
+        extend ActiveSupport::Concern
+        include Statesman::Trigger::Integration::SharedMethods
+
+        # @!macro migration_command
+        def create_statesman_trigger(*args)
+          statesman_trigger_requires_pg!
+
+          params = build_statesman_trigger_params args
+
+          validation_query = params.build_validation_query
+
+          raise "target column `#{params.sync_column}` not found on `#{params.model_table}`." unless select_value(validation_query)
+
+          params.build_statements(direction: :up).map do |stmt|
+            execute stmt
+          end
+        end
+
+        # @!macro migration_command
+        def drop_statesman_trigger(*args)
+          statesman_trigger_requires_pg!
+
+          params = build_statesman_trigger_params args
+
+          params.build_statements(direction: :down).map do |stmt|
+            execute stmt
+          end
+        end
+
+        # @api private
+        # @raise [RuntimeError] if adapter is not postgres
+        # @return [void]
+        def statesman_trigger_requires_pg!
+          raise 'Requires postgres' unless adapter_name =~ /postg/i
+        end
+      end
+    end
+  end
+end

data/lib/statesman/trigger/integration/command_recorder_methods.rb

@@ -0,0 +1,31 @@
+module Statesman
+  module Trigger
+    module Integration
+      # Add support for statesman triggers to `ActiveRecord::Migration::CommandRecorder` in order to support reversible migrations.
+      module CommandRecorderMethods
+        extend ActiveSupport::Concern
+        include Statesman::Trigger::Integration::SharedMethods
+
+        # @!macro migration_command
+        def create_statesman_trigger(*args, &block)
+          record :create_statesman_trigger, build_statesman_trigger_options(args)
+        end
+
+        # @!macro migration_command
+        def drop_statesman_trigger(*args, &block)
+          record :drop_statesman_trigger, build_statesman_trigger_options(args)
+        end
+
+        # @return [(Symbol, Hash)]
+        def invert_create_statesman_trigger(args, &block)
+          [:drop_statesman_trigger, build_statesman_trigger_options(args)]
+        end
+
+        # @return [(Symbol, Hash)]
+        def invert_drop_statesman_trigger(args, &block)
+          [:create_statesman_trigger, build_statesman_trigger_options(args)]
+        end
+      end
+    end
+  end
+end

data/lib/statesman/trigger/integration/migration_methods.rb

@@ -0,0 +1,48 @@
+module Statesman
+  module Trigger
+    module Integration
+      # Adds support for statesman triggers to `ActiveRecord::Migration`.
+      module MigrationMethods
+        extend ActiveSupport::Concern
+        include Statesman::Trigger::Integration::SharedMethods
+
+        # @!macro migration_command
+        def create_statesman_trigger(*args)
+          params = build_statesman_trigger_params(args)
+
+          say_with_time "Creating Statesman trigger" do
+            dump_statesman_params params
+
+            say "create_statesman_trigger_function :#{params.function_name}", true
+            say "create_statesman_trigger :#{params.trigger_name}", true
+
+            connection.create_statesman_trigger params
+          end
+        end
+
+        # @!macro migration_command
+        def drop_statesman_trigger(*args)
+          params = build_statesman_trigger_params(args)
+
+          say_with_time "Dropping Statesman trigger" do
+            dump_statesman_params params
+
+            say "drop_statesman_trigger :#{params.trigger_name}", true
+            say "drop_statesman_trigger_function :#{params.function_name}", true
+
+            connection.drop_statesman_trigger params
+          end
+        end
+
+        private
+        # @param [Statesman::Trigger::Parameters] params
+        # @return [void]
+        def dump_statesman_params(params)
+          params.for_inspect.each do |key, value|
+            say "#{key}: #{value.inspect}", true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/statesman/trigger/integration/shared_methods.rb

@@ -0,0 +1,96 @@
+module Statesman
+  module Trigger
+    module Integration
+      # Used to match a single string for a {Parameters#state_name}
+      MATCH_STATE_NAME = proc do |args|
+        args.length == 1 && args.first.kind_of?(String)
+      end
+
+      # Used to match a tuple of classes for {Parameters#model_klass} and {Parameters#transition_klass}
+      MATCH_MODEL_AND_TRANSITION_CLASSES = proc do |args|
+        args.length == 2 && args.all? { |a| a.kind_of? Class }
+      end
+
+      # Used to match a tuple of strings for {Parameters#model_table} and {Parameters#transition_table}
+      MATCH_MODEL_AND_TRANSITION_TABLES = proc do |args|
+        args.length == 2 && args.all? { |a| a.kind_of?(String) || a.kind_of?(Symbol) }
+      end
+
+      # Combines {MATCH_STATE_NAME} with {MATCH_MODEL_AND_TRANSITION_CLASSES}
+      MATCH_STATE_NAME_AND_CLASSES = proc do |args|
+        MATCH_STATE_NAME[args.take(1)] && MATCH_MODEL_AND_TRANSITION_CLASSES[args.drop(1)]
+      end
+
+      # Combines {MATCH_STATE_NAME} with {MATCH_MODEL_AND_TRANSITION_TABLES}
+      MATCH_STATE_NAME_AND_TABLE_NAMES = proc do |args|
+        MATCH_STATE_NAME[args.take(1)] && MATCH_MODEL_AND_TRANSITION_TABLES[args.drop(1)]
+      end
+
+      # Methods used by migration and connection adapter integrations.
+      #
+      # @api private
+      module SharedMethods
+        extend ActiveSupport::Concern
+
+        # @!macro [new] migration_options
+        #   @param [Hash] options
+        #   @option options [String] :sync_column (see Parameters#sync_column)
+
+        # @!macro [new] migration_command
+        #   @overload $0(state_name, options = {})
+        #     @param [#to_s] state_name
+        #     @!macro migration_options
+        #   @overload $0(model_klass, transition_klass, options = {})
+        #     @param [Class] model_klass
+        #     @param [Class] transition_klass
+        #     @!macro migration_options
+        #   @overload $0(state_name, model_klass, transition_klass, options = {})
+        #     @param [#to_s] state_name
+        #     @param [Class] model_klass
+        #     @param [Class] transition_klass
+        #     @!macro migration_options
+        #   @overload $0(model_table, transition_table, options = {})
+        #     @param [#to_s] model_table
+        #     @param [#to_s] transition_table
+        #     @!macro migration_options
+        #   @overload $0(state_name, model_table, transition_table, options = {})
+        #     @param [#to_s] state_name
+        #     @param [#to_s] model_table
+        #     @param [#to_s] transition_table
+        #     @!macro migration_options
+        #
+        #   @return [void]
+
+        # @param [(Class, Class), (#to_s, #to_s, #to_s), (#to_s), (#to_s, Class, Class), (#to_s, #to_s)] args
+        # @return [(Hash)]
+        def build_statesman_trigger_options(args)
+          return [args.first] if args.first.kind_of?(Statesman::Trigger::Parameters)
+
+          args    &&= args.dup
+          options = args.extract_options!
+
+          case args
+          when MATCH_STATE_NAME_AND_CLASSES
+            options[:state_name], options[:model_klass], options[:transition_klass] = args
+          when MATCH_STATE_NAME_AND_TABLE_NAMES
+            options[:state_name], options[:model_table], options[:transition_table] = args
+          when MATCH_STATE_NAME
+            options[:state_name] = args.first
+          when MATCH_MODEL_AND_TRANSITION_TABLES
+            options[:model_table], options[:transition_table] = args
+          when MATCH_MODEL_AND_TRANSITION_CLASSES
+            options[:model_klass], options[:transition_klass] = args
+          end
+
+          return [options]
+        end
+
+        # @param (see #build_statesman_trigger_options)
+        # @return [Statesman::Trigger::Parameters]
+        def build_statesman_trigger_params(args)
+          Statesman::Trigger::Parameters.new build_statesman_trigger_options(args).first
+        end
+      end
+    end
+  end
+end

data/lib/statesman/trigger/null_object.rb

@@ -1,18 +1,29 @@
 module Statesman
   module Trigger
+    # Created by {Parameters#default_model_klass} or {Parameters#default_transition_klass}
+    # to raise errors if there is an attempt to introspect
+    # @api private
     class NullObject
+      # @!attribute [r] name
+      # Name of the parameter used by {Parameters}
+      # @return [String]
       attr_reader :name
 
+      # @param [String, Symbol] name
       def initialize(name)
         @name = name
       end
 
+      # @return [String]
       def inspect
         %[#{self.class}(:name => :#{name})]
       end
 
+      # @param [Symbol] method
+      # @raise [Statesman::Trigger::IntrospectionError] with the name of the method that should exist on {#name}.
+      # @return [void]
       def method_missing(method, *args, &block)
-        raise NoMethodError, "You must provide :#{name} that responds to :#{method}"
+        raise Statesman::Trigger::IntrospectionError, "You must provide :#{name} that responds to :#{method}"
       end
     end
   end

data/lib/statesman/trigger/parameters.rb

@@ -1,31 +1,70 @@
 module Statesman
   module Trigger
+    # This generates `CREATE` / `DROP` `FUNCTION` / `TRIGGER` statements and can
+    # introspect proper values based on provided {#model_klass} and {#transition_klass}.
     class Parameters
-      include Virtus.model
+      __send__ :include, Virtus.model
 
+      # @see #prefix
       PREFIX_FORMAT = "sync_%<state_name>s_state_for_%<model_table>s"
 
+      # @!attribute [r] state_name
+      # Unique identifier in the case of multiple states on the same table.
+      # @return [String]
       attribute :state_name,          String, default: "statesman"
+
+      # @!attribute [r] sync_column
+      # The name of the column on the "parent" table to synchronize the last state's value.
+      # @return [String]
       attribute :sync_column,         String, default: "current_state"
 
+      # @!attribute [r] model_klass
+      # The "parent" class that has the state machine on it.
+      # @return [Class]
       attribute :model_klass,         Object, required: false, default: :default_model_klass
+
+      # @!attribute [r] transition_klass
+      # The transition class that stores the state machine history.
+      # @return [Class]
       attribute :transition_klass,    Object, required: false, default: :default_transition_klass
 
+      # @!attribute [r] model_table
+      # The table for {#model_klass} (will be introspected from that if not provided, else error)
+      # @return [String]
       attribute :model_table,         String, default: :default_model_table
+
+      # @!attribute [r] transition_table
+      # The table for {#transition_klass} (will be introspected from that if not provided, else error)
+      # @return [String]
       attribute :transition_table,    String, default: :default_transition_table
+
+      # @!attribute [r] foreign_key_column
+      # The foreign key column on on {#transition_table} that syncs up with {#model_table}'s `id` column.
+      #
+      # Given `orders` and `order_transitions`, this would be `order_id` on the latter table.
+      # @return [String]
       attribute :foreign_key_column,  String, default: :default_foreign_key_column
 
+      # @!attribute [r] prefix
+      # Used to namespace {#function_name} and {#trigger_name} in the database.
+      # @see PREFIX_FORMAT
+      # @return [String]
       attribute :prefix,              String, default: :default_prefix
 
+      # @!attribute [r] function_name
+      # @return [String]
       attribute :function_name,       String, default: :default_function_name
+
+      # @!attribute [r] trigger_name
+      # @return [String]
       attribute :trigger_name,        String, default: :default_trigger_name
 
+      # Builds a query used to validate that {#sync_column} actually exists on {#model_table}.
       # @return [String]
       def build_validation_query
         %[SELECT TRUE from pg_attribute WHERE attrelid = '%<model_table>s'::regclass AND attname = '%<sync_column>s' AND NOT attisdropped] % { model_table: escape_string(model_table), sync_column: escape_string(sync_column) }
       end
 
-      # @api private
       # @param [:up, :down] direction
       # @return [<String>]
       def build_statements(direction:)
@@ -43,10 +82,33 @@ module Statesman
         return stmts
       end
 
+      # @return [String]
+      def inspect
+        %[Statesman::Trigger(#{for_inspect.inspect})]
+      end
+
+      # @!attribute [r] quoted_function_name
+      # Returns the PG-safe {#function_name}
+      # @return [String]
+      def quoted_function_name
+        quote_ident function_name
+      end
+
+      # @!attribute [r] quoted_function_name
+      # Returns the PG-safe {#trigger_name}
+      # @return [String]
+      def quoted_trigger_name
+        quote_ident trigger_name
+      end
+
+      # @!attribute [r] update_function
+      # @return [Statesman::Trigger::UpdateFunctionQuery]
       def update_function
         @update_function ||= UpdateFunctionQuery.new self
       end
 
+      # @!attribute [r] trigger_statement
+      # @return [Statesman::Trigger::TriggerQuery]
       def trigger_statement
         @trigger_statement ||= TriggerQuery.new self
       end
@@ -56,51 +118,78 @@ module Statesman
         attributes.slice(:state_name, :sync_column,
                          :model_table, :transition_table,
                          :function_name, :trigger_name,
-                         :foreign_key_column)
+                         :foreign_key_column).merge(
+                           quoted_function_name:  quoted_function_name,
+                           quoted_trigger_name:   quoted_trigger_name
+                         )
+      end
+
+      # @return [Hash]
+      def for_inspect
+        attributes.slice(:state_name, :sync_column, :model_table, :transition_table)
       end
 
       private
+      # @return [NullObject]
       def default_model_klass
         NullObject.new :model_klass
       end
 
+      # @return [NullObject]
       def default_transition_klass
         NullObject.new :transition_klass
       end
 
+      # @return [String]
       def default_prefix
         sprintf(PREFIX_FORMAT, state_name: state_name, model_table: model_table)
       end
 
+      # @return [String]
       def default_model_table
         model_klass.table_name
       end
 
+      # @return [String]
       def default_transition_table
         transition_klass.table_name
       end
 
+      # @return [String]
       def default_foreign_key_column
         return "#{model_klass.model_name.singular}_id" unless model_klass.kind_of?(NullObject)
 
         return "#{model_table.to_s.singularize}_id"
       end
 
+      # @return [String]
       def default_function_name
-        quote_ident "#{prefix}_fn"
+        "#{prefix}_fn"
       end
 
+      # @return [String]
       def default_trigger_name
-        quote_ident "#{prefix}_trigger"
+        "#{prefix}_trigger"
       end
 
+      # @!group Quoting methods
+
+      # Shorthand for `PG::Connection.escape_string`
+      #
+      # @param [String] value
+      # @return [String]
       def escape_string(value)
         PG::Connection.escape_string value
       end
 
+      # Shorthand for `PG::Connection.quote_ident`
+      #
+      # @param [String] value
+      # @return [String]
       def quote_ident(value)
         PG::Connection.quote_ident value
       end
+      # @!endgroup
     end
   end
 end

data/lib/statesman/trigger/trigger_query.rb

@@ -1,14 +1,16 @@
 module Statesman
   module Trigger
+    # Generates `[ CREATE | DROP ] TRIGGER` statements.
+    #
     # @api private
     class TriggerQuery < AbstractQuery
       up! <<-SQL
-        CREATE TRIGGER %<trigger_name>s AFTER INSERT ON %<transition_table>s
-          FOR EACH ROW EXECUTE PROCEDURE %<function_name>s();
+        CREATE TRIGGER %<quoted_trigger_name>s AFTER INSERT ON %<transition_table>s
+          FOR EACH ROW EXECUTE PROCEDURE %<quoted_function_name>s();
       SQL
 
       down! <<-SQL
-        DROP TRIGGER IF EXISTS %<trigger_name>s ON %<transition_table>s;
+        DROP TRIGGER IF EXISTS %<quoted_trigger_name>s ON %<transition_table>s;
       SQL
     end
   end

data/lib/statesman/trigger/update_function_query.rb

@@ -1,9 +1,11 @@
 module Statesman
   module Trigger
+    # Generates `[ CREATE | DROP ] FUNCTION` statements.
+    #
     # @api private
     class UpdateFunctionQuery < AbstractQuery
       up! <<-SQL
-      CREATE OR REPLACE FUNCTION %<function_name>s() RETURNS TRIGGER AS $$
+      CREATE OR REPLACE FUNCTION %<quoted_function_name>s() RETURNS TRIGGER AS $$
         BEGIN
           UPDATE %<model_table>s SET %<sync_column>s = NEW.to_state WHERE id = NEW.%<foreign_key_column>s;
           RETURN NULL;
@@ -12,7 +14,7 @@ module Statesman
       SQL
 
       down! <<-SQL
-      DROP FUNCTION IF EXISTS %<function_name>s()
+      DROP FUNCTION IF EXISTS %<quoted_function_name>s()
       SQL
     end
   end

data/lib/statesman/trigger/version.rb

@@ -1,5 +1,6 @@
 module Statesman
   module Trigger
-    VERSION = "0.1.0"
+    # Gem version.
+    VERSION = "0.1.1"
   end
 end

data/statesman-trigger.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "yard"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman-trigger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexa Grey
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create a database trigger that keeps the most recent Statesman state
   in sync.
 email:
@@ -189,7 +203,10 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -199,7 +216,10 @@ files:
 - lib/statesman/trigger.rb
 - lib/statesman/trigger/abstract_query.rb
 - lib/statesman/trigger/integration.rb
-- lib/statesman/trigger/migrations.rb
+- lib/statesman/trigger/integration/adapter_methods.rb
+- lib/statesman/trigger/integration/command_recorder_methods.rb
+- lib/statesman/trigger/integration/migration_methods.rb
+- lib/statesman/trigger/integration/shared_methods.rb
 - lib/statesman/trigger/null_object.rb
 - lib/statesman/trigger/parameters.rb
 - lib/statesman/trigger/trigger_query.rb
@@ -230,3 +250,4 @@ signing_key:
 specification_version: 4
 summary: Create a database trigger that keeps the most recent Statesman state in sync.
 test_files: []
+has_rdoc: 

data/lib/statesman/trigger/migrations.rb

@@ -1,71 +0,0 @@
-module Statesman
-  module Trigger
-    MATCH_STATE_NAME = proc do |args|
-      args.length == 1 && args.first.kind_of?(String)
-    end
-
-    MATCH_MODEL_AND_TRANSITION_CLASSES = proc do |args|
-      args.length == 2 && args.all? { |a| a.kind_of? Class }
-    end
-
-    MATCH_MODEL_AND_TRANSITION_TABLES = proc do |args|
-      args.length == 2 && args.all? { |a| a.kind_of?(String) || a.kind_of?(Symbol) }
-    end
-
-    MATCH_STATE_NAME_AND_CLASSES = proc do |args|
-      MATCH_STATE_NAME[args.take(1)] && MATCH_MODEL_AND_TRANSITION_CLASSES[args.drop(1)]
-    end
-
-    MATCH_STATE_NAME_AND_TABLE_NAMES = proc do |args|
-      MATCH_STATE_NAME[args.take(1)] && MATCH_MODEL_AND_TRANSITION_TABLES[args.drop(1)]
-    end
-
-    # Integrates with CommandRecorder
-    #
-    # @api private
-    module Migrations
-      extend ActiveSupport::Concern
-
-      def create_statesman_trigger(*args, &block)
-        record :create_statesman_trigger, build_statesman_trigger_options(args)
-      end
-
-      def drop_statesman_trigger(*args, &block)
-        record :drop_statesman_trigger, build_statesman_trigger_options(args)
-      end
-
-      def invert_create_statesman_trigger(args, &block)
-        [:drop_statesman_trigger, build_statesman_trigger_options(args)]
-      end
-
-      def invert_drop_statesman_trigger(args, &block)
-        [:create_statesman_trigger, build_statesman_trigger_options(args)]
-      end
-
-      def build_statesman_trigger_options(args)
-        options = args.extract_options!
-
-        case args
-        when MATCH_STATE_NAME_AND_CLASSES
-          options[:state_name]        = args.shift
-          options[:model_klass]       = args.shift
-          options[:transition_klass]  = args.shift
-        when MATCH_STATE_NAME_AND_TABLE_NAMES
-          options[:state_name]        = args.shift
-          options[:model_table]       = args.shift
-          options[:transition_table]  = args.shift
-        when MATCH_STATE_NAME
-          options[:state_name]        = args.shift
-        when MATCH_MODEL_AND_TRANSITION_TABLES
-          options[:model_table]       = args.shift
-          options[:transition_table]  = args.shift
-        when MATCH_MODEL_AND_TRANSITION_CLASSES
-          options[:model_klass]       = args.shift
-          options[:transition_klass]  = args.shift
-        end
-
-        return [options]
-      end
-    end
-  end
-end