Class: Parlour::RbiGenerator::Arbitrary

Inherits:

RbiObject

• Object
• RbiObject
• Parlour::RbiGenerator::Arbitrary

Defined in:

lib/parlour/rbi_generator/arbitrary.rb

Overview

Represents miscellaneous Ruby code.

Instance Attribute Summary

• #code ⇒ Object

  Returns arbitrary code string.

Attributes inherited from RbiObject

#comments, #generated_by, #generator, #name

Instance Method Summary

• #==(other) ⇒ Boolean

  Returns true if this instance is equal to another arbitrary code line.

• #describe ⇒ String

  Returns a human-readable brief string description of this code.

• #generate_rbi(indent_level, options) ⇒ Array<String>

  Generates the RBI lines for this arbitrary code.

• #initialize(generator, code: '', &block) ⇒ Arbitrary constructor

  Creates new arbitrary code.

• #merge_into_self(others) ⇒ void

  Given an array of Arbitrary instances, merges them into this one.

• #mergeable?(others) ⇒ Boolean

  Given an array of Arbitrary instances, returns true if they may be merged into this instance using #merge_into_self.

Methods inherited from RbiObject

#add_comment

Constructor Details

#initialize(generator, code: '', &block) ⇒ Arbitrary

Creates new arbitrary code.

Parameters:

• code (String) (defaults to: '') —

  The arbitrary code string. Indentation is added to the beginning of each line.

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 17

def initialize(generator, code: '', &block)
  super(generator, '')
  @code = code
  yield_self(&block) if block
end

Instance Attribute Details

#code ⇒ Object

Returns arbitrary code string.

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 25

def code
  @code
end

Instance Method Details

#==(other) ⇒ Boolean

Returns true if this instance is equal to another arbitrary code line.

Parameters:

• other (Object) —

  The other instance. If this is not a Parlour::RbiGenerator::Arbitrary (or a subclass of it), this will always return false.

Returns:

• (Boolean)

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 33

def ==(other)
  Arbitrary === other && code == other.code
end

#describe ⇒ String

Returns a human-readable brief string description of this code.

Returns:

• (String)

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 87

def describe
  "Arbitrary code (#{code})"
end

#generate_rbi(indent_level, options) ⇒ Array<String>

Generates the RBI lines for this arbitrary code.

Parameters:

• indent_level (Integer) —

  The indentation level to generate the lines at.

• options (Options) —

  The formatting options to use.

Returns:

• (Array<String>) —

  The RBI lines, formatted as specified.

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 48

def generate_rbi(indent_level, options)
  code.split("\n").map { |l| options.indented(indent_level, l) }
end

#merge_into_self(others) ⇒ void

This method returns an undefined value.

Given an array of Parlour::RbiGenerator::Arbitrary instances, merges them into this one. This particular implementation always throws an exception, because #mergeable? is always false.

Parameters:

• others (Array<RbiGenerator::RbiObject>) —

  An array of other Parlour::RbiGenerator::Arbitrary instances.

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 79

def merge_into_self(others)
  raise 'arbitrary code is never mergeable'
end

#mergeable?(others) ⇒ Boolean

Given an array of Parlour::RbiGenerator::Arbitrary instances, returns true if they may be merged into this instance using #merge_into_self. This is always false.

Parameters:

• others (Array<RbiGenerator::RbiObject>) —

  An array of other Parlour::RbiGenerator::Arbitrary instances.

Returns:

• (Boolean) —

  Whether this instance may be merged with them.

# File 'lib/parlour/rbi_generator/arbitrary.rb', line 63

def mergeable?(others)
  false
end