Module: HairTrigger

Defined in:
lib/hair_trigger.rb,
lib/hair_trigger/base.rb,
lib/hair_trigger/adapter.rb,
lib/hair_trigger/builder.rb,
lib/hair_trigger/railtie.rb,
lib/hair_trigger/version.rb,
lib/hair_trigger/migrator.rb,
lib/hair_trigger/schema_dumper.rb,
lib/hair_trigger/migration_reader.rb

Defined Under Namespace

Modules: Adapter, Base, MigrationReader, Migrator, SchemaDumper Classes: Builder, Railtie

Constant Summary collapse

VERSION = 
"0.2.6"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.migration_path ⇒ Object 



193
194
195
 
# File 'lib/hair_trigger.rb', line 193

def migration_path
  @migration_path ||= 'db/migrate'
end

.model_path ⇒ Object 



185
186
187
 
# File 'lib/hair_trigger.rb', line 185

def model_path
  @model_path ||= 'app/models'
end

.schema_rb_path ⇒ Object 



189
190
191
 
# File 'lib/hair_trigger.rb', line 189

def schema_rb_path
  @schema_rb_path ||= 'db/schema.rb'
end

Class Method Details

.adapter_name_for(adapter) ⇒ Object 



197
198
199
 
# File 'lib/hair_trigger.rb', line 197

def adapter_name_for(adapter)
  adapter.adapter_name.downcase.sub(/\d$/, '').to_sym
end

.current_migrations(options = {}) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/hair_trigger.rb', line 46

def current_migrations(options = {})
  if options[:in_rake_task]
    options[:include_manual_triggers] = true
    options[:schema_rb_first] = true
    options[:skip_pending_migrations] = true
  end
  
  # if we're in a db:schema:dump task (explict or kicked off by db:migrate),
  # we evaluate the previous schema.rb (if it exists), and then all applied
  # migrations in order (even ones older than schema.rb). this ensures we
  # handle db:migrate:down scenarios correctly
  #
  # if we're not in such a rake task (i.e. we just want to know what
  # triggers are defined, whether or not they are applied in the db), we
  # evaluate all migrations along with schema.rb, ordered by version
  migrator = self.migrator
  migrated = migrator.migrated rescue []
  migrations = []
  migrator.migrations.each do |migration|
    next if options[:skip_pending_migrations] && !migrated.include?(migration.version)
    triggers = MigrationReader.get_triggers(migration, options)
    migrations << [migration, triggers] unless triggers.empty?
  end
  
  if previous_schema = (options.has_key?(:previous_schema) ? options[:previous_schema] : File.exist?(schema_rb_path) && File.read(schema_rb_path))
    base_triggers = MigrationReader.get_triggers(previous_schema, options)
    unless base_triggers.empty?
      version = (previous_schema =~ /ActiveRecord::Schema\.define\(:version => (\d+)\)/) && $1.to_i
      migrations.unshift [OpenStruct.new({:version => version}), base_triggers]
    end
  end
  
  migrations = migrations.sort_by{|(migration, triggers)| migration.version} unless options[:schema_rb_first]
  
  all_builders = []
  migrations.each do |(migration, triggers)|
    triggers.each do |new_trigger|
      # if there is already a trigger with this name, delete it since we are
      # either dropping it or replacing it
      new_trigger.prepare!
      all_builders.delete_if{ |(n, t)| t.prepared_name == new_trigger.prepared_name }
      all_builders << [migration.name, new_trigger] unless new_trigger.options[:drop]
    end
  end
  
  all_builders
end

.current_triggers ⇒ Object 



14
15
16
17
18
 
# File 'lib/hair_trigger.rb', line 14

def current_triggers
  # see what the models say there should be
  canonical_triggers = models.map(&:triggers).flatten.compact
  canonical_triggers.each(&:prepare!) # interpolates any vars so we match the migrations
end

.generate_migration(silent = false) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/hair_trigger.rb', line 98

def generate_migration(silent = false)
  begin
    canonical_triggers = current_triggers
  rescue 
    $stderr.puts $!
    exit 1
  end
  
  migrations = current_migrations
  migration_names = migrations.map(&:first)
  existing_triggers = migrations.map(&:last)
  
  up_drop_triggers = []
  up_create_triggers = []
  down_drop_triggers = []
  down_create_triggers = []
  
  # see which triggers need to be dropped
  existing_triggers.each do |existing|
    next if canonical_triggers.any?{ |t| t.prepared_name == existing.prepared_name }
    up_drop_triggers.concat existing.drop_triggers
    down_create_triggers << existing
  end
  
  # see which triggers need to be added/replaced
  (canonical_triggers - existing_triggers).each do |new_trigger|
    up_create_triggers << new_trigger
    down_drop_triggers.concat new_trigger.drop_triggers
    if existing = existing_triggers.detect{ |t| t.prepared_name == new_trigger.prepared_name }
      # it's not sufficient to rely on the new trigger to replace the old
      # one, since we could be dealing with trigger groups and the name
      # alone isn't sufficient to know which component triggers to remove
      up_drop_triggers.concat existing.drop_triggers
      down_create_triggers << existing
    end
  end
  
  return if up_drop_triggers.empty? && up_create_triggers.empty?

  migration_name = infer_migration_name(migration_names, up_create_triggers, up_drop_triggers)
  migration_version = infer_migration_version(migration_name)
  file_name = migration_path + '/' + migration_version + "_" + migration_name.underscore + ".rb"
  prefix = ActiveRecord::VERSION::STRING < "3.1." ? "self." : ""
  File.open(file_name, "w"){ |f| f.write <<-MIGRATION }
# This migration was auto-generated via `rake db:generate_trigger_migration'.
# While you can edit this file, any changes you make to the definitions here
# will be undone by the next auto-generated trigger migration.

class #{migration_name} < ActiveRecord::Migration
  def #{prefix}up
#{(up_drop_triggers + up_create_triggers).map{ |t| t.to_ruby('    ') }.join("\n\n").lstrip}
  end

  def #{prefix}down
#{(down_drop_triggers + down_create_triggers).map{ |t| t.to_ruby('    ') }.join("\n\n").lstrip}
  end
end
  MIGRATION
  file_name
end

.infer_migration_name(migration_names, create_triggers, drop_triggers) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/hair_trigger.rb', line 159

def infer_migration_name(migration_names, create_triggers, drop_triggers)
  migration_base_name = if create_triggers.size > 0
    ("create trigger#{create_triggers.size > 1 ? 's' : ''} " +
     create_triggers.map{ |t| [t.options[:table], t.options[:events].join(" ")].join(" ") }.join(" and ")
    ).downcase.gsub(/[^a-z0-9_]/, '_').gsub(/_+/, '_').camelize
  else
    ("drop trigger#{drop_triggers.size > 1 ? 's' : ''} " +
     drop_triggers.map{ |t| t.options[:table] }.join(" and ")
    ).downcase.gsub(/[^a-z0-9_]/, '_').gsub(/_+/, '_').camelize
  end

  name_version = nil
  while migration_names.include?("#{migration_base_name}#{name_version}")
    name_version = name_version.to_i + 1
  end
  migration_name = "#{migration_base_name}#{name_version}"
end

.infer_migration_version(migration_name) ⇒ Object 



177
178
179
180
181
182
183
 
# File 'lib/hair_trigger.rb', line 177

def infer_migration_version(migration_name)
  ActiveRecord::Base.timestamped_migrations ?
    Time.now.getutc.strftime("%Y%m%d%H%M%S") :
    Dir.glob(migration_path + '/*rb').
      map{ |f| f.gsub(/.*\/(\d+)_.*/, '\1').to_i}.
      inject(0){ |curr, i| i > curr ? i : curr } + 1
end

.migrations_current? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/hair_trigger.rb', line 94

def migrations_current?
  current_migrations.map(&:last).sort.eql? current_triggers.sort
end

.migrator ⇒ Object 



39
40
41
42
43
44
 
# File 'lib/hair_trigger.rb', line 39

def migrator
  migrations = ActiveRecord::VERSION::STRING >= "4.0." ?
    ActiveRecord::Migrator.migrations(migration_path) :
    migration_path
  ActiveRecord::Migrator.new(:up, migrations)
end

.models ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/hair_trigger.rb', line 20

def models
  if defined?(Rails) && Rails::VERSION::MAJOR > 2
    Rails.application.eager_load!
  else
    Dir[model_path + '/*rb'].each do |model|
      class_name = model.sub(/\A.*\/(.*?)\.rb\z/, '\1').camelize
      next unless File.read(model) =~ /^\s*trigger[\.\(]/
      begin
        require "./#{model}" unless Object.const_defined?(class_name)
      rescue StandardError, LoadError
        raise "unable to load #{class_name} and its trigger(s)"
      end
    end
  end
  ActiveRecord::VERSION::STRING < "3.0." ?
    ActiveRecord::Base.send(:subclasses) :
    ActiveRecord::Base.descendants
end