Module: ActiveRecordMigrationUi

Defined in:
lib/active_record_migration_ui.rb,
lib/active_record_migration_ui/engine.rb,
lib/active_record_migration_ui/logger.rb,
lib/active_record_migration_ui/version.rb,
lib/active_record_migration_ui/middleware.rb,
app/controllers/active_record_migration_ui/migrations_controller.rb,
app/channels/active_record_migration_ui/application_cable/channel.rb,
app/controllers/active_record_migration_ui/application_controller.rb,
app/interactors/active_record_migration_ui/migrate_migration_script.rb,
app/channels/active_record_migration_ui/application_cable/connection.rb,
app/interactors/active_record_migration_ui/organise_migrating_script.rb,
app/channels/active_record_migration_ui/active_record_migration_ui_channel.rb,
app/interactors/active_record_migration_ui/find_all_pending_migration_scripts.rb,
app/interactors/active_record_migration_ui/notify_migration_script_as_running.rb,
app/interactors/active_record_migration_ui/notify_migration_script_as_done_or_fail.rb,
app/interactors/active_record_migration_ui/ensure_migration_version_is_included_in_pending_scripts.rb

Defined Under Namespace

Modules: ApplicationCable Classes: ActiveRecordMigrationUiChannel, ApplicationController, Configuration, Engine, EnsureMigrationVersionIsIncludedInPendingScripts, FindAllPendingMigrationScripts, Logger, Middleware, MigrateMigrationScript, MigrationsController, MutedLogger, NotifyMigrationScriptAsDoneOrFail, NotifyMigrationScriptAsRunning, OrganiseMigratingScript

Constant Summary collapse

ROOT_PATH = 
Pathname.new(File.join(__dir__, '..'))
VERSION = 
'0.1.2'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



16
17
18
 
# File 'lib/active_record_migration_ui.rb', line 16

def configuration
  @configuration
end

.running_migration ⇒ Object

Returns the value of attribute running_migration.



17
18
19
 
# File 'lib/active_record_migration_ui.rb', line 17

def running_migration
  @running_migration
end

Class Method Details

.ac_channel_class_name ⇒ Object 



19
20
21
 
# File 'lib/active_record_migration_ui.rb', line 19

def ac_channel_class_name
  'ActiveRecordMigrationUi::ActiveRecordMigrationUiChannel'
end

.ac_channel_name ⇒ Object 



23
24
25
 
# File 'lib/active_record_migration_ui.rb', line 23

def ac_channel_name
  'active_record_migration_ui'
end

.configure {|configuration| ... } ⇒ Object

Yields:



53
54
55
56
 
# File 'lib/active_record_migration_ui.rb', line 53

def self.configure
  self.init_config
  yield(configuration)
end

.init_config ⇒ Object 



49
50
51
 
# File 'lib/active_record_migration_ui.rb', line 49

def self.init_config
  self.configuration ||= Configuration.new
end

.needs_migration? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/active_record_migration_ui.rb', line 27

def needs_migration?
  ActiveRecord::Base.connection.migration_context.needs_migration?
end

.running_migration? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/active_record_migration_ui.rb', line 31

def running_migration?
  running_migration == true
end

.webpacker ⇒ Object 



35
36
37
38
39
40
 
# File 'lib/active_record_migration_ui.rb', line 35

def webpacker
  @webpacker ||= ::Webpacker::Instance.new(
    root_path: ROOT_PATH,
    config_path: ROOT_PATH.join('config', 'webpacker.yml')
  )
end

.webpacker_dev_server ⇒ Object 



42
43
44
45
46
 
# File 'lib/active_record_migration_ui.rb', line 42

def webpacker_dev_server
  ActiveRecordMigrationUi.webpacker.config.dev_server
rescue
  nil
end