Class: Mumukit::Sync::Store::Github::GuideReader

Inherits:
Object
  • Object
show all
Includes:
WithFileReading, WithSchema
Defined in:
lib/mumukit/sync/store/github/guide_reader.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from WithSchema

#build_fields_h, #exercise_schema, #guide_schema

Methods included from WithFileReading

#read_code_file, #read_file, #read_yaml_file

Constructor Details

#initialize(dir, repo) ⇒ GuideReader

Returns a new instance of GuideReader.



8
9
10
11
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 8

def initialize(dir, repo)
  @dir = File.expand_path(dir)
  @slug = repo.to_s
end

Instance Attribute Details

#dir ⇒ Object (readonly)

Returns the value of attribute dir.



6
7
8
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 6

def dir
  @dir
end

Instance Method Details

#read!(key, builder, meta) ⇒ Object 



51
52
53
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 51

def read!(key, builder, meta)
  builder[key] = meta[key]
end

#read_exercises ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 61

def read_exercises
  each_exercise_file do |root, position, id, name|
    builder = ExerciseBuilder.new

    meta = read_meta! "exercise #{name}", root
    meta['language'] &&= { name: meta['language'] }

    builder.meta = meta
    builder.id = id
    builder.name = meta['name'] || name

    exercise_schema.file_fields.each do |it|
      value = it.read_field_file "exercise #{name}", root
      builder[it.reverse_name] = value
    end
    yield builder
  end
end

#read_exercises!(builder) ⇒ Object 



55
56
57
58
59
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 55

def read_exercises!(builder)
  read_exercises do |exercise_builder|
    builder.add_exercise exercise_builder.build
  end
end

#read_guide! ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 13

def read_guide!
  builder = GuideBuilder.new(@slug)

  read_guide_meta! builder
  guide_schema.file_fields.each do |it|
    value = it.read_field_file 'guide', dir
    builder[it.reverse_name] = value
  end
  read_exercises! builder

  builder.build
end

#read_guide_meta!(builder) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 35

def read_guide_meta!(builder)
  meta = read_meta! 'guide', dir
  meta['language'] &&= { name: meta['language'] }
  read_legacy! meta

  builder.meta = meta


  builder.order = Mumukit::Sync::Store::Github::Ordering.from meta['order']
end

#read_legacy!(meta) ⇒ Object 



46
47
48
49
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 46

def read_legacy!(meta)
  meta['id_format'] ||= meta['original_id_format']
  meta['type'] ||= meta['learning'] ? 'learning' : 'practice'
end

#read_meta!(description, dir) ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/mumukit/sync/store/github/guide_reader.rb', line 26

def read_meta!(description, dir)
  meta = read_yaml_file(File.join(dir, 'meta.yml'))
  raise Mumukit::Sync::SyncError, "Missing #{description} meta.yml" unless meta

  meta
rescue Psych::SyntaxError
  raise Mumukit::Sync::SyncError, "Bad #{description} metadata syntax"
end