statesman-trigger 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+before_install: gem install bundler -v '~> 1.9'
+cache: bundler
+rvm:
+  - 2.2.1
+before_script:
+  - psql -c 'create database statesman_trigger_test;' -U postgres
+addons:
+  postgresql: "9.3"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in statesman-trigger.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# Statesman::Trigger
+
+This is an extension to the fantastic [Statesman gem](https://github.com/gocardless/statesman)
+to create a database trigger to keep the most recent transition in sync on a specific column
+on the parent model.
+
+Presently, it is only designed to work with PostgreSQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'statesman-trigger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statesman-trigger
+
+## Usage
+
+Usage in a rails migration is straightforward, assuming you use the defaults:
+
+```ruby
+def change
+  add_column :orders, :current_state, :string, null: false, default: 'pending', index: true
+
+  create_statesman_trigger Order, OrderTransition
+end
+```
+
+The migration script will introspect from the provided classes.
+
+If you want your column to be named something else:
+
+```ruby
+def change
+  add_column :orders, :anything_you_want, :string, null: false, default: 'pending', index: true
+
+  create_statesman_trigger Order, OrderTransition, sync_column: :anything_you_want
+end
+```
+
+It is highly recommended you switch your Rails application's schema dumping format to SQL (`db/structure.sql` rather than `db/schema.rb`). That's accomplished by the following line in `config/application.rb`:
+
+```ruby
+module YourAppHere
+  class Application < Rails::Application
+    # Use SQL for dumping.
+    config.active_record.schema_format = :sql
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/scryptmouse/statesman-trigger/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.verbose = false
+  end
+rescue LoadError
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statesman/trigger"
+require "pry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require_relative '../spec/db/boot.rb'
+
+DEFAULT_PARAMS = Statesman::Trigger::Parameters.new model_klass: Article, transition_klass: ArticleTransition
+
+Pry.start

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/statesman-trigger.rb

@@ -0,0 +1 @@
+require 'statesman/trigger'

data/lib/statesman/trigger.rb

@@ -0,0 +1,23 @@
+require "statesman/trigger/version"
+require "active_support/all"
+require "active_record"
+require "pg"
+require "virtus"
+require "dedent"
+
+module Statesman
+  module Trigger
+    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
+end

data/lib/statesman/trigger/abstract_query.rb

@@ -0,0 +1,43 @@
+module Statesman
+  module Trigger
+    # @abstract
+    class AbstractQuery
+      include ActiveSupport::Configurable
+
+      # @!attribute [r] parameters
+      # @return [Statesman::Trigger::Parameters]
+      attr_reader :parameters
+
+      def initialize(parameters)
+        @parameters = parameters
+      end
+
+      def up
+        up_query % parameters.for_query
+      end
+
+      def down
+        down_query % parameters.for_query
+      end
+
+      protected
+      def up_query
+        config.up_query.presence or raise 'Define up!'
+      end
+
+      def down_query
+        config.down_query.presence or raise 'Define down!'
+      end
+
+      class << self
+        def up!(raw_sql)
+          config.up_query = raw_sql.dedent
+        end
+
+        def down!(raw_sql)
+          config.down_query = raw_sql.dedent
+        end
+      end
+    end
+  end
+end

data/lib/statesman/trigger/integration.rb

@@ -0,0 +1,35 @@
+module Statesman
+  module Trigger
+    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
+        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/migrations.rb

@@ -0,0 +1,71 @@
+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

data/lib/statesman/trigger/null_object.rb

@@ -0,0 +1,19 @@
+module Statesman
+  module Trigger
+    class NullObject
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def inspect
+        %[#{self.class}(:name => :#{name})]
+      end
+
+      def method_missing(method, *args, &block)
+        raise NoMethodError, "You must provide :#{name} that responds to :#{method}"
+      end
+    end
+  end
+end

data/lib/statesman/trigger/parameters.rb

@@ -0,0 +1,106 @@
+module Statesman
+  module Trigger
+    class Parameters
+      include Virtus.model
+
+      PREFIX_FORMAT = "sync_%<state_name>s_state_for_%<model_table>s"
+
+      attribute :state_name,          String, default: "statesman"
+      attribute :sync_column,         String, default: "current_state"
+
+      attribute :model_klass,         Object, required: false, default: :default_model_klass
+      attribute :transition_klass,    Object, required: false, default: :default_transition_klass
+
+      attribute :model_table,         String, default: :default_model_table
+      attribute :transition_table,    String, default: :default_transition_table
+      attribute :foreign_key_column,  String, default: :default_foreign_key_column
+
+      attribute :prefix,              String, default: :default_prefix
+
+      attribute :function_name,       String, default: :default_function_name
+      attribute :trigger_name,        String, default: :default_trigger_name
+
+      # @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:)
+        stmts = []
+
+        case direction
+        when :up
+          stmts << update_function.up
+          stmts << trigger_statement.up
+        when :down
+          stmts << trigger_statement.down
+          stmts << update_function.down
+        end
+
+        return stmts
+      end
+
+      def update_function
+        @update_function ||= UpdateFunctionQuery.new self
+      end
+
+      def trigger_statement
+        @trigger_statement ||= TriggerQuery.new self
+      end
+
+      # @return [Hash]
+      def for_query
+        attributes.slice(:state_name, :sync_column,
+                         :model_table, :transition_table,
+                         :function_name, :trigger_name,
+                         :foreign_key_column)
+      end
+
+      private
+      def default_model_klass
+        NullObject.new :model_klass
+      end
+
+      def default_transition_klass
+        NullObject.new :transition_klass
+      end
+
+      def default_prefix
+        sprintf(PREFIX_FORMAT, state_name: state_name, model_table: model_table)
+      end
+
+      def default_model_table
+        model_klass.table_name
+      end
+
+      def default_transition_table
+        transition_klass.table_name
+      end
+
+      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
+
+      def default_function_name
+        quote_ident "#{prefix}_fn"
+      end
+
+      def default_trigger_name
+        quote_ident "#{prefix}_trigger"
+      end
+
+      def escape_string(value)
+        PG::Connection.escape_string value
+      end
+
+      def quote_ident(value)
+        PG::Connection.quote_ident value
+      end
+    end
+  end
+end

data/lib/statesman/trigger/trigger_query.rb

@@ -0,0 +1,15 @@
+module Statesman
+  module Trigger
+    # @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();
+      SQL
+
+      down! <<-SQL
+        DROP TRIGGER IF EXISTS %<trigger_name>s ON %<transition_table>s;
+      SQL
+    end
+  end
+end

data/lib/statesman/trigger/update_function_query.rb

@@ -0,0 +1,19 @@
+module Statesman
+  module Trigger
+    # @api private
+    class UpdateFunctionQuery < AbstractQuery
+      up! <<-SQL
+      CREATE OR REPLACE FUNCTION %<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;
+        END;
+      $$ LANGUAGE plpgsql;
+      SQL
+
+      down! <<-SQL
+      DROP FUNCTION IF EXISTS %<function_name>s()
+      SQL
+    end
+  end
+end

data/lib/statesman/trigger/version.rb

@@ -0,0 +1,5 @@
+module Statesman
+  module Trigger
+    VERSION = "0.1.0"
+  end
+end

data/statesman-trigger.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statesman/trigger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "statesman-trigger"
+  spec.version       = Statesman::Trigger::VERSION
+  spec.authors       = ["Alexa Grey"]
+  spec.email         = ["devel@mouse.vc"]
+
+  spec.summary       = %q{Create a database trigger that keeps the most recent Statesman state in sync.}
+  spec.description   = %q{Create a database trigger that keeps the most recent Statesman state in sync.}
+  spec.homepage      = "https://github.com/scryptmouse/statesman-trigger"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.2"
+  spec.add_dependency "activerecord", ">= 3.2"
+  spec.add_dependency "pg"
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "dedent"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "database_cleaner"
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: statesman-trigger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexa Grey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: dedent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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:
+- devel@mouse.vc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/statesman-trigger.rb
+- lib/statesman/trigger.rb
+- lib/statesman/trigger/abstract_query.rb
+- lib/statesman/trigger/integration.rb
+- lib/statesman/trigger/migrations.rb
+- lib/statesman/trigger/null_object.rb
+- lib/statesman/trigger/parameters.rb
+- lib/statesman/trigger/trigger_query.rb
+- lib/statesman/trigger/update_function_query.rb
+- lib/statesman/trigger/version.rb
+- statesman-trigger.gemspec
+homepage: https://github.com/scryptmouse/statesman-trigger
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Create a database trigger that keeps the most recent Statesman state in sync.
+test_files: []