Class: Pinspec::Emit::SpecWriter

Inherits:
Object
  • Object
show all
Defined in:
lib/pinspec/emit/spec_writer.rb

Defined Under Namespace

Classes: RawRuby, Result

Constant Summary collapse

SPEC_DIR = 
"spec/characterization"
SUPPORT_DIR = 
"spec/characterization/support"
SERIALIZER_TEMPLATE = 
File.expand_path("../../../templates/serializer.rb", __dir__)
SUPPORT_TEMPLATE = 
File.expand_path("../../../templates/spec_support.rb", __dir__)
FACTORY_TEMPLATE = 
File.expand_path("../../../templates/factory_build.rb", __dir__)
PROVENANCE = 
"pinspec:generated"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app_root:, target:, plan:, corpus:, stability:, fk_map:, force: false, only_aspect: nil, spec_dir: nil) ⇒ SpecWriter

Returns a new instance of SpecWriter.



20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/pinspec/emit/spec_writer.rb', line 20

def initialize(app_root:, target:, plan:, corpus:, stability:, fk_map:, force: false,
               only_aspect: nil, spec_dir: nil)
  @app_root = app_root
  @target = target
  @plan = plan
  @corpus = corpus
  @stability = stability
  @fk_map = fk_map
  @force = force
  @only_aspect = only_aspect
  @spec_dir = spec_dir || SPEC_DIR
end

Class Method Details

.class_stem(class_name) ⇒ Object

The class half of a pin's filename, so a caller can find the pin for a class without knowing which method it froze.



35
36
37
38
39
40
41
42
43
 
# File 'lib/pinspec/emit/spec_writer.rb', line 35

def self.class_stem(class_name)
  class_name.to_s
            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
            .downcase
            .tr("/", "_")
            .tr(":", "_")
            .squeeze("_")
end

Instance Method Details

#guard_existing! ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/pinspec/emit/spec_writer.rb', line 66

def guard_existing!
  return unless File.file?(spec_path)

  existing = Analyzer::Source.read(spec_path)
  return if @force

  unless existing.include?(PROVENANCE)
    raise VerifyFailed,
          "#{spec_path} already exists and was not written by pinspec. " \
          "Nothing pinspec did not write is ever overwritten; move it aside " \
          "or pass --force."
  end
end

#spec_path ⇒ Object 



45
46
47
48
49
 
# File 'lib/pinspec/emit/spec_writer.rb', line 45

def spec_path
  suffix = @only_aspect ? "_#{@only_aspect}" : ""

  File.join(@app_root, @spec_dir, "#{file_stem}#{suffix}_spec.rb")
end

#write! ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/pinspec/emit/spec_writer.rb', line 51

def write!
  guard_existing!

  FileUtils.mkdir_p(File.dirname(spec_path))
  FileUtils.mkdir_p(File.join(@app_root, SUPPORT_DIR))

  support = write_support!
  File.write(spec_path, render)

  Result.new(
    spec_path: spec_path, support_paths: support,
    pinned_cases: pinned.map { |verdict| verdict.case_id }, aspects: aspect_counts
  )
end