Class: Graphiti::Schema::Check

Inherits:
Object
  • Object
show all
Defined in:
lib/graphiti/schema/check.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schema, path) ⇒ Check

Returns a new instance of Check.



6
7
8
9
10
11
12
 
# File 'lib/graphiti/schema/check.rb', line 6

def initialize(schema, path)
  @path = path
  @schema = schema
  @generated = normalize(schema)
  @committed = normalize(JSON.parse(File.read(path))) if File.exist?(path)
  @errors = @committed ? SchemaDiff.new(@committed, @generated).compare : []
end

Instance Attribute Details

#errors ⇒ Object (readonly)

Returns the value of attribute errors.



4
5
6
 
# File 'lib/graphiti/schema/check.rb', line 4

def errors
  @errors
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



4
5
6
 
# File 'lib/graphiti/schema/check.rb', line 4

def path
  @path
end

Instance Method Details

#compatible? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/graphiti/schema/check.rb', line 22

def compatible?
  errors.empty?
end

#message ⇒ Object 



36
37
38
39
40
41
42
 
# File 'lib/graphiti/schema/check.rb', line 36

def message
  return "Schema is up to date: #{path}" if ok?
  return "#{missing_message}\n\n#{regenerate}" if missing?
  return "#{incompatible_message}\n\n#{errors.join("\n")}" unless compatible?

  "Schema file is outdated: #{path}\n\n#{regenerate}"
end

#missing? ⇒ Boolean

Returns:

  • (Boolean) 


14
15
16
 
# File 'lib/graphiti/schema/check.rb', line 14

def missing?
  @committed.nil?
end

#ok? ⇒ Boolean

Returns:

  • (Boolean) 


26
27
28
 
# File 'lib/graphiti/schema/check.rb', line 26

def ok?
  !missing? && !stale? && compatible?
end

#stale? ⇒ Boolean

Returns:

  • (Boolean) 


18
19
20
 
# File 'lib/graphiti/schema/check.rb', line 18

def stale?
  !missing? && @committed != @generated
end

#write! ⇒ Object 



30
31
32
33
34
 
# File 'lib/graphiti/schema/check.rb', line 30

def write!
  FileUtils.mkdir_p(File.dirname(path))
  File.write(path, JSON.pretty_generate(@schema))
  path
end