Class: Hanami::CLI::Commands::App::Command

Inherits:
Hanami::CLI::Command show all
Defined in:
lib/hanami/cli/commands/app/command.rb

Overview

Base class for hanami CLI commands intended to be executed within an existing Hanami app.

Since:

  • 2.0.0

Defined Under Namespace

Modules: Environment

Constant Summary collapse

ACTION_SEPARATOR =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0

"."

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hanami::CLI::Command

#initialize, new

Constructor Details

This class inherits a constructor from Hanami::CLI::Command

Class Method Details

.inherited(klass) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0



46
47
48
49
 
# File 'lib/hanami/cli/commands/app/command.rb', line 46

def self.inherited(klass)
  super
  klass.prepend(Environment)
end

Instance Method Details

#app ⇒ Hanami::App

Returns the Hanami app class.

Returns:

  • (Hanami::App) —

    the Hanami app

Raises:

  • (Hanami::AppLoadError) —

    if the app has not been loaded

Since:

  • 2.0.0



59
60
61
62
63
64
65
 
# File 'lib/hanami/cli/commands/app/command.rb', line 59

def app
  @app ||=
    begin
      require "hanami/prepare"
      Hanami.app
    end
end

#database ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This is NOT AVAILABLE as of the 2.0.0 release.

Since:

  • 2.0.0



118
119
120
 
# File 'lib/hanami/cli/commands/app/command.rb', line 118

def database
  @database ||= Commands::App::DB::Utils::Database[app]
end

#database_config ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This is NOT AVAILABLE as of the 2.0.0 release.

Since:

  • 2.0.0



125
126
127
 
# File 'lib/hanami/cli/commands/app/command.rb', line 125

def database_config
  database.config
end

#measure(desc) ⇒ Object

Executes a given block and prints string to the out stream with details of the time taken to execute.

If the block returns a falsey value, then a failure message is printed.

Examples:

measure("Reverse the polarity of the neutron flow") do
  # reverses the polarity, returns a truthy value
end
# printed to `out`:
# => Reverse the polarity of the neutron flow in 2s
measure("Disable the time dilation device") do
  # attempts to disable the device, returns a falsey favlue
end
# printed to `out`:
# !!! => Disable the time dilation device FAILED

Since:

  • 2.0.0



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/hanami/cli/commands/app/command.rb', line 103

def measure(desc)
  start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  result = yield
  stop = Process.clock_gettime(Process::CLOCK_MONOTONIC)

  if result
    out.puts "=> #{desc} in #{(stop - start).round(4)}s"
  else
    out.puts "!!! => #{desc.inspect} FAILED"
  end
end

#run_command(klass, *args) ⇒ Object

Runs another CLI command via its command class.

Parameters:

  • klass (Hanami::CLI::Command)
  • args (Array) —

    any additional arguments to pass to the command's #call method.

Since:

  • 2.0.0



74
75
76
77
78
79
80
 
# File 'lib/hanami/cli/commands/app/command.rb', line 74

def run_command(klass, *args)
  klass.new(
    out: out,
    inflector: app.inflector,
    fs: Hanami::CLI::Files,
  ).call(*args)
end