Module: Bullematic

Defined in:
lib/bullematic/logger.rb,
lib/bullematic.rb,
lib/bullematic/cli.rb,
lib/bullematic/fixer.rb,
lib/bullematic/version.rb,
lib/bullematic/notifier.rb,
lib/bullematic/detection.rb,
lib/bullematic/ast/finder.rb,
lib/bullematic/ast/parser.rb,
lib/bullematic/ast/rewriter.rb,
lib/bullematic/configuration.rb,
lib/bullematic/evidence_store.rb,
lib/bullematic/integrations/rails.rb,
lib/bullematic/integrations/rspec.rb,
lib/bullematic/integrations/minitest.rb,
sig/generated/bullematic.rbs,
sig/generated/bullematic/cli.rbs,
sig/generated/bullematic/fixer.rbs,
sig/generated/bullematic/logger.rbs,
sig/generated/bullematic/version.rbs,
sig/generated/bullematic/notifier.rbs,
sig/generated/bullematic/detection.rbs,
sig/generated/bullematic/ast/finder.rbs,
sig/generated/bullematic/ast/parser.rbs,
sig/generated/bullematic/ast/rewriter.rbs,
sig/generated/bullematic/configuration.rbs,
sig/generated/bullematic/evidence_store.rbs,
sig/generated/bullematic/integrations/rails.rbs,
sig/generated/bullematic/integrations/rspec.rbs,
sig/generated/bullematic/integrations/minitest.rbs

Overview

rbs_inline: enabled frozen_string_literal: true

Defined Under Namespace

Modules: AST, Integrations Classes: BullematicLogger, CLI, Configuration, Detection, Error, EvidenceStore, FixError, Fixer, Middleware, Notifier, ParseError

Constant Summary collapse

VERSION =

Signature:

  • String

Returns:

  • (String) 
"0.2.0"

Class Method Summary collapse

Class Method Details

.configuration ⇒ Configuration?

: () -> Configuration?

Returns:



26
27
28
 
# File 'lib/bullematic.rb', line 26

def configuration
  @configuration
end

.configuration=(configuration) ⇒ Configuration?

: (Configuration?) -> Configuration?

Parameters:

Returns:



31
32
33
 
# File 'lib/bullematic.rb', line 31

def configuration=(configuration)
  @configuration = configuration
end

.configure {|arg0| ... } ⇒ void

This method returns an undefined value.

: () { (Configuration) -> void } -> void

Yields:

Yield Parameters:

Yield Returns:

  • (void) 


36
37
38
39
40
 
# File 'lib/bullematic.rb', line 36

def configure
  self.configuration ||= Configuration.new
  config = configuration
  yield(config) if block_given? && config
end

.enabled? ⇒ Boolean

: () -> bool

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/bullematic.rb', line 50

def enabled?
  configuration&.enabled == true && ENV["BULLEMATIC"] == "1"
end

.reset! ⇒ void

This method returns an undefined value.

: () -> void



55
56
57
58
 
# File 'lib/bullematic.rb', line 55

def reset!
  @configuration = nil
  Fixer.clear
end

.setup_bullet_hook ⇒ void

This method returns an undefined value.

: () -> void



43
44
45
46
47
 
# File 'lib/bullematic.rb', line 43

def setup_bullet_hook
  return unless defined?(Bullet)

  Notifier.setup
end