Class: Hanami::Hanamirc Private

Inherits:

Object

• Object
• Hanami::Hanamirc

Defined in:

lib/hanami/hanamirc.rb

Overview

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

Read the .hanamirc file in the root of the application

Since:

• 0.3.0

Constant Summary

FILE_NAME =

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.

Hanamirc name file

See Also:

• #path_file

Since:

• 0.3.0

'.hanamirc'.freeze

DEFAULT_ARCHITECTURE =

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.

Architecture default value

See Also:

• #options

Since:

• 0.3.0

'container'.freeze

APP_ARCHITECTURE =

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.

Application architecture value

Since:

• 0.6.0

'app'.freeze

ARCHITECTURE_KEY =

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.

Architecture key for writing the hanamirc file

See Also:

• #default_options

Since:

• 0.3.0

'architecture'.freeze

PROJECT_NAME =

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.

Project name for writing the hanamirc file

See Also:

• #default_options

Since:

• 0.8.0

'project'.freeze

DEFAULT_TEST_SUITE =

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.

Test suite default value

See Also:

• #default_options

Since:

• 0.3.0

'minitest'.freeze

TEST_KEY =

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.

Test suite key for writing the hanamirc file

See Also:

• #default_options

Since:

• 0.3.0

'test'.freeze

DEFAULT_TEMPLATE =

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.

Template default value

See Also:

• #default_options

Since:

• 0.3.0

'erb'.freeze

TEMPLATE_KEY =

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.

Template key for writing the hanamirc file

See Also:

• #default_options

Since:

• 0.3.0

'template'.freeze

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.

Key/value separator in hanamirc file

Since:

• 0.8.0

'='.freeze

Instance Method Summary

• #default_options ⇒ Object private

  Default values for writing the hanamirc file.

• #exists? ⇒ Boolean private

  Check if hanamirc file exists.

• #initialize(root) ⇒ Hanamirc constructor private

  Initialize Hanamirc class with application’s root and environment options.

• #options ⇒ Hanami::Utils::Hash private

  Read hanamirc file (if exists) and parse it’s values or return default.

Constructor Details

#initialize(root) ⇒ Hanamirc

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.

Initialize Hanamirc class with application’s root and environment options.

Parameters:

• root (Pathname) —

  Application’s root

See Also:

• Environment#initialize

Since:

• 0.3.0

# File 'lib/hanami/hanamirc.rb', line 91

def initialize(root)
  @root = root
end

Instance Method Details

#default_options ⇒ 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.

Default values for writing the hanamirc file

See Also:

• #options

Since:

• 0.5.1

# File 'lib/hanami/hanamirc.rb', line 117

def default_options
  @default_options ||= Utils::Hash.new({
                                       ARCHITECTURE_KEY => DEFAULT_ARCHITECTURE,
                                       PROJECT_NAME     => project_name,
                                       TEST_KEY         => DEFAULT_TEST_SUITE,
                                       TEMPLATE_KEY     => DEFAULT_TEMPLATE
                                     }).symbolize!.freeze
end

#exists? ⇒ Boolean

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.

Check if hanamirc file exists

Returns:

• (Boolean) —

  hanamirc file’s path existing

Since:

• 0.3.0

# File 'lib/hanami/hanamirc.rb', line 132

def exists?
  path_file.exist?
end

#options ⇒ Hanami::Utils::Hash

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.

Read hanamirc file (if exists) and parse it’s values or return default.

Examples:

Default values if file doesn’t exist

Hanami::Hanamirc.new(Pathname.new(Dir.pwd)).options
 # => { architecture: 'container', test: 'minitest', template: 'erb' }

Custom values if file doesn’t exist

options = { architect: 'application', test: 'rspec', template: 'slim' }
Hanami::Hanamirc.new(Pathname.new(Dir.pwd), options).options
 # => { architecture: 'application', test: 'rspec', template: 'slim' }

Returns:

• (Hanami::Utils::Hash) —

  parsed values

Since:

• 0.3.0

# File 'lib/hanami/hanamirc.rb', line 107

def options
  @options ||= symbolize(default_options.merge(file_options))
end