Class: Middleman::PreviewServer::BasicInformation

Inherits:
Object
  • Object
show all
Defined in:
middleman-core/lib/middleman-core/preview_server/information.rb

Overview

Basic information class to wrap common behaviour

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options_hash = ::Middleman::EMPTY_HASH) ⇒ BasicInformation

Create instance

Parameters:

  • bind_address (String) —

    The bind address of the server

  • server_name (String) —

    The name of the server

  • port (Integer) —

    The port to listen on


31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 31

def initialize(options_hash = ::Middleman::EMPTY_HASH)
  @bind_address = ServerIpAddress.new(options_hash[:bind_address])
  @server_name  = ServerHostname.new(options_hash[:server_name])
  @port         = options_hash[:port]
  @valid        = true

  @site_addresses = []
  @listeners = []
  @checks = []

  # This needs to be check for each use case. Otherwise `Webrick` will
  # complain about that.
  @checks << Checks::InterfaceIsAvailableOnSystem.new
end

Instance Attribute Details

#bind_address ⇒ Object

Returns the value of attribute bind_address.


18
19
20
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 18

def bind_address
  @bind_address
end

#listeners ⇒ Object (readonly)

Returns the value of attribute listeners.


19
20
21
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 19

def listeners
  @listeners
end

#port ⇒ Object

Returns the value of attribute port.


18
19
20
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 18

def port
  @port
end

#reason ⇒ Object

Returns the value of attribute reason.


18
19
20
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 18

def reason
  @reason
end

#server_name ⇒ Object

Returns the value of attribute server_name.


18
19
20
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 18

def server_name
  @server_name
end

#site_addresses ⇒ Object (readonly)

Returns the value of attribute site_addresses.


19
20
21
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 19

def site_addresses
  @site_addresses
end

#valid ⇒ Object

Returns the value of attribute valid.


18
19
20
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 18

def valid
  @valid
end

Instance Method Details

#local_network_interfaces ⇒ Object

Default is to get all network interfaces


72
73
74
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 72

def local_network_interfaces
  network_interfaces_inventory.nil? ? [] : network_interfaces_inventory.network_interfaces(:all)
end

#resolve_me ⇒ Object

Raises:

  • (NoMethodError) 

59
60
61
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 59

def resolve_me(*)
  raise NoMethodError
end

#show_me_network_interfaces(inventory) ⇒ Object

Get network information

Parameters:

  • inventory (#network_interfaces) —

    Get list of available network interfaces


67
68
69
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 67

def show_me_network_interfaces(inventory)
  @network_interfaces_inventory = inventory
end

#valid? ⇒ Boolean

Is the given information valid?

Returns:

  • (Boolean) 

47
48
49
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 47

def valid?
  valid == true
end

#validate_me(validator) ⇒ Object

Pass "self" to validator

Parameters:

  • validator (#validate) —

    The validator


55
56
57
 
# File 'middleman-core/lib/middleman-core/preview_server/information.rb', line 55

def validate_me(validator)
  validator.validate self, checks
end