Module: RuboCop::Cop::Cask::CaskHelp

Includes:
CommentsHelp
Included in:
NoOverrides, OnDescStanza, OnHomepageStanza, OnSystemConditionals, OnUrlStanza, StanzaGrouping, StanzaOrder, Variables
Defined in:
rubocops/cask/mixin/cask_help.rb

Overview

Common functionality for cops checking casks.

Instance Method Summary collapse

Instance Method Details

#find_end_line(node) ⇒ Object

FIXME: Workaround until https://github.com/rubocop/rubocop/pull/11858 is released.



18
19
20
21
22
 
# File 'rubocops/cask/mixin/cask_help.rb', line 18

def find_end_line(node)
  return node.loc.end.line if node.block_type? || node.numblock_type?

  super
end

#inner_stanzas(block_node, comments) ⇒ Object 



44
45
46
47
48
 
# File 'rubocops/cask/mixin/cask_help.rb', line 44

def inner_stanzas(block_node, comments)
  block_contents = block_node.child_nodes.select(&:begin_type?)
  inner_nodes = block_contents.map(&:child_nodes).flatten.select(&:send_type?)
  inner_nodes.map { |n| RuboCop::Cask::AST::Stanza.new(n, comments) }
end

#on_block(block_node) ⇒ void

This method returns an undefined value.

Parameters:

  • block_node (RuboCop::AST::BlockNode) 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'rubocops/cask/mixin/cask_help.rb', line 25

def on_block(block_node)
  super if defined? super

  return if !block_node.cask_block? && !block_node.cask_on_system_block?

  comments = comments_in_range(block_node).to_a
  stanza_block = RuboCop::Cask::AST::StanzaBlock.new(block_node, comments)
  on_cask_stanza_block(stanza_block)

  return unless block_node.cask_block?

  cask_block = RuboCop::Cask::AST::CaskBlock.new(block_node, comments)
  on_cask(cask_block)
end

#on_cask(cask_block) ⇒ void

This method returns an undefined value.

Parameters:



12
 
# File 'rubocops/cask/mixin/cask_help.rb', line 12

def on_cask(cask_block); end

#on_cask_stanza_block(cask_stanza_block) ⇒ void

This method returns an undefined value.

Parameters:



15
 
# File 'rubocops/cask/mixin/cask_help.rb', line 15

def on_cask_stanza_block(cask_stanza_block); end

#on_system_methods(cask_stanzas) ⇒ Object 



40
41
42
 
# File 'rubocops/cask/mixin/cask_help.rb', line 40

def on_system_methods(cask_stanzas)
  cask_stanzas.select(&:on_system_block?)
end