Class: Kettle::Family::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/kettle/family/config.rb

Constant Summary collapse

DEFAULT_PATHS = 
[".kettle-family.yml", ".structuredmerge/kettle-family.yml"].freeze
DEFAULT_MEMBER_EXCLUDES = 
[
  "vendor/**",
  "**/vendor/**",
  "tmp/**",
  "**/tmp/**",
  "spec/**",
  "**/spec/**",
  "test/**",
  "**/test/**"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root:, path:, data:) ⇒ Config

Returns a new instance of Config.



33
34
35
36
37
 
# File 'lib/kettle/family/config.rb', line 33

def initialize(root:, path:, data:)
  @root = root
  @path = path
  @data = stringify_keys(data)
end

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



20
21
22
 
# File 'lib/kettle/family/config.rb', line 20

def data
  @data
end

#path ⇒ Object (readonly)

Returns the value of attribute path.



20
21
22
 
# File 'lib/kettle/family/config.rb', line 20

def path
  @path
end

#root ⇒ Object (readonly)

Returns the value of attribute root.



20
21
22
 
# File 'lib/kettle/family/config.rb', line 20

def root
  @root
end

Class Method Details

.load(root:, path: nil) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/kettle/family/config.rb', line 22

def self.load(root:, path: nil)
  expanded_root = File.expand_path(root)
  config_path = path && File.expand_path(path, expanded_root)
  config_path ||= DEFAULT_PATHS
    .map { |candidate| File.join(expanded_root, candidate) }
    .find { |candidate| File.file?(candidate) }

  data = config_path ? YAML.load_file(config_path) : {}
  new(root: expanded_root, path: config_path, data: data || {})
end

Instance Method Details

#branch_lanes ⇒ Object 



270
271
272
 
# File 'lib/kettle/family/config.rb', line 270

def branch_lanes
  fetch_path("branch_lanes") || fetch_path("branches", "lanes") || {}
end

#changelog_env ⇒ Object 



169
170
171
172
173
 
# File 'lib/kettle/family/config.rb', line 169

def changelog_env
  return {} unless changelog_version_file

  {"K_CHANGELOG_VERSION_FILE" => changelog_version_file.to_s}
end

#changelog_full_path(member) ⇒ Object 



165
166
167
 
# File 'lib/kettle/family/config.rb', line 165

def changelog_full_path(member)
  File.expand_path(changelog_path, shared_changelog? ? root : member.root)
end

#changelog_mode ⇒ Object 



145
146
147
 
# File 'lib/kettle/family/config.rb', line 145

def changelog_mode
  fetch_path("changelog", "mode") || "member"
end

#changelog_path ⇒ Object 



153
154
155
 
# File 'lib/kettle/family/config.rb', line 153

def changelog_path
  fetch_path("changelog", "path") || "CHANGELOG.md"
end

#changelog_version_file ⇒ Object 



157
158
159
 
# File 'lib/kettle/family/config.rb', line 157

def changelog_version_file
  fetch_path("changelog", "version_file")
end

#changelog_workdir(_member = nil) ⇒ Object 



161
162
163
 
# File 'lib/kettle/family/config.rb', line 161

def changelog_workdir(_member = nil)
  shared_changelog? ? root : nil
end

#check_forbidden_tracked_member_dirs ⇒ Object 



129
130
131
 
# File 'lib/kettle/family/config.rb', line 129

def check_forbidden_tracked_member_dirs
  fetch_path("check", "forbidden_tracked_member_dirs") || []
end

#check_forbidden_tracked_member_dirs_except ⇒ Object 



133
134
135
 
# File 'lib/kettle/family/config.rb', line 133

def check_forbidden_tracked_member_dirs_except
  fetch_path("check", "forbidden_tracked_member_dirs_except") || []
end

#check_member_required_dirs ⇒ Object 



125
126
127
 
# File 'lib/kettle/family/config.rb', line 125

def check_member_required_dirs
  fetch_path("check", "member_required_dirs") || []
end

#check_readme_links ⇒ Object 



137
138
139
 
# File 'lib/kettle/family/config.rb', line 137

def check_readme_links
  fetch_path("check", "readme_links") || {}
end

#check_required_bins ⇒ Object 



117
118
119
 
# File 'lib/kettle/family/config.rb', line 117

def check_required_bins
  fetch_path("check", "required_bins") || ReadinessCheck::REQUIRED_BINS
end

#check_required_files ⇒ Object 



113
114
115
 
# File 'lib/kettle/family/config.rb', line 113

def check_required_files
  fetch_path("check", "required_files") || ReadinessCheck::REQUIRED_FILES
end

#check_root_required_files ⇒ Object 



121
122
123
 
# File 'lib/kettle/family/config.rb', line 121

def check_root_required_files
  fetch_path("check", "root_required_files") || []
end

#command_for(name) ⇒ Object 



109
110
111
 
# File 'lib/kettle/family/config.rb', line 109

def command_for(name)
  fetch_path("commands", name)
end

#discover_members? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'lib/kettle/family/config.rb', line 90

def discover_members?
  members = data.fetch("members", {})
  members.fetch("discover", true)
end

#explicit_members ⇒ Object 



80
81
82
83
84
85
86
87
88
 
# File 'lib/kettle/family/config.rb', line 80

def explicit_members
  members = data.fetch("members", {})
  explicit = members.fetch("explicit", [])
  explicit.map do |entry|
    entry = stringify_keys(entry)
    member_root = File.expand_path(entry.fetch("root"), root)
    entry.merge("root" => member_root)
  end
end

#family_local_path_env ⇒ Object 



56
57
58
59
60
61
 
# File 'lib/kettle/family/config.rb', line 56

def family_local_path_env
  name = family_local_path_env_name
  return {} unless name

  {name => family_local_path_root}
end

#family_local_path_env_name ⇒ Object 



43
44
45
46
47
48
49
 
# File 'lib/kettle/family/config.rb', line 43

def family_local_path_env_name
  configured = fetch_path("family", "local_path_env")
  return nil if configured == false
  return configured.to_s unless configured.to_s.empty?

  "#{family_name.gsub(/[^A-Za-z0-9]+/, "_").upcase}_DEV"
end

#family_local_path_root ⇒ Object 



51
52
53
54
 
# File 'lib/kettle/family/config.rb', line 51

def family_local_path_root
  configured = fetch_path("family", "local_path_root")
  configured ? expand_config_relative_path(configured) : root
end

#family_mode ⇒ Object 



63
64
65
 
# File 'lib/kettle/family/config.rb', line 63

def family_mode
  fetch_path("family", "mode") || "monorepo"
end

#family_name ⇒ Object 



39
40
41
 
# File 'lib/kettle/family/config.rb', line 39

def family_name
  fetch_path("family", "name") || File.basename(root)
end

#install_local_dependencies ⇒ Object 



215
216
217
218
219
220
221
 
# File 'lib/kettle/family/config.rb', line 215

def install_local_dependencies
  paths = fetch_path("install", "local_dependencies") || fetch_path("local_dependencies") || []
  Array(paths).map do |entry|
    value = entry.is_a?(Hash) ? stringify_keys(entry).fetch("path") : entry
    expand_config_relative_path(value)
  end
end

#member_exclude_patterns ⇒ Object 



95
96
97
98
99
 
# File 'lib/kettle/family/config.rb', line 95

def member_exclude_patterns
  members = data.fetch("members", {})
  patterns = members.fetch("exclude", nil) || members.fetch("ignore", nil) || []
  DEFAULT_MEMBER_EXCLUDES + Array(patterns)
end

#member_release_target_branches ⇒ Object 



263
264
265
266
267
268
 
# File 'lib/kettle/family/config.rb', line 263

def member_release_target_branches
  targets = fetch_path("release", "member_target_branches") || {}
  targets.to_h do |member_name, branches|
    [member_name.to_s, Array(branches).map(&:to_s)]
  end
end

#member_roots ⇒ Object 



72
73
74
75
76
77
78
 
# File 'lib/kettle/family/config.rb', line 72

def member_roots
  configured = fetch_path("members", "roots")
  return configured.map { |path| File.expand_path(path, root) } if configured
  return sibling_member_roots if family_mode == "sibling_repos"

  [members_root]
end

#members_root ⇒ Object 



67
68
69
70
 
# File 'lib/kettle/family/config.rb', line 67

def members_root
  configured = fetch_path("family", "members_root") || fetch_path("members", "root")
  configured ? File.expand_path(configured, root) : root
end

#normalize_lockfiles? ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/kettle/family/config.rb', line 191

def normalize_lockfiles?
  fetch_path("template", "normalize_lockfiles") == true
end

#normalize_lockfiles_command ⇒ Object 



195
196
197
 
# File 'lib/kettle/family/config.rb', line 195

def normalize_lockfiles_command
  fetch_path("template", "normalize_lockfiles_command") || "bundle lock"
end

#order_hints ⇒ Object 



105
106
107
 
# File 'lib/kettle/family/config.rb', line 105

def order_hints
  fetch_path("members", "order", "hints") || []
end

#order_mode ⇒ Object 



101
102
103
 
# File 'lib/kettle/family/config.rb', line 101

def order_mode
  fetch_path("members", "order", "mode") || "dependency"
end

#pre_release_image_url_skip_patterns ⇒ Object 



141
142
143
 
# File 'lib/kettle/family/config.rb', line 141

def pre_release_image_url_skip_patterns
  Array(fetch_path("pre_release", "image_url_skip_patterns")).map(&:to_s)
end

#release_auto_dependency_floors? ⇒ Boolean

Returns:

  • (Boolean) 


239
240
241
 
# File 'lib/kettle/family/config.rb', line 239

def release_auto_dependency_floors?
  fetch_path("release", "auto_dependency_floors") != false
end

#release_build_command ⇒ Object 



223
224
225
 
# File 'lib/kettle/family/config.rb', line 223

def release_build_command
  fetch_path("release", "build_command") || command_for("release_build") || "bundle exec rake build"
end

#release_disable_local_path_env ⇒ Object 



210
211
212
213
 
# File 'lib/kettle/family/config.rb', line 210

def release_disable_local_path_env
  configured = fetch_path("release", "disable_local_path_env")
  Array(configured || default_release_disable_local_path_env)
end

#release_env ⇒ Object 



231
232
233
 
# File 'lib/kettle/family/config.rb', line 231

def release_env
  stringify_env(fetch_path("release", "env") || {})
end

#release_family_changelog? ⇒ Boolean

Returns:

  • (Boolean) 


243
244
245
 
# File 'lib/kettle/family/config.rb', line 243

def release_family_changelog?
  fetch_path("release", "family_changelog", "enabled") == true
end

#release_family_changelog_command ⇒ Object 



247
248
249
 
# File 'lib/kettle/family/config.rb', line 247

def release_family_changelog_command
  fetch_path("release", "family_changelog", "command") || "bundle exec kettle-changelog"
end

#release_jobs ⇒ Object 



235
236
237
 
# File 'lib/kettle/family/config.rb', line 235

def release_jobs
  fetch_path("release", "jobs")
end

#release_normalize_lockfiles? ⇒ Boolean

Returns:

  • (Boolean) 


199
200
201
202
203
204
 
# File 'lib/kettle/family/config.rb', line 199

def release_normalize_lockfiles?
  configured = fetch_path("release", "normalize_lockfiles")
  return configured unless configured.nil?

  normalize_lockfiles?
end

#release_normalize_lockfiles_command ⇒ Object 



206
207
208
 
# File 'lib/kettle/family/config.rb', line 206

def release_normalize_lockfiles_command
  fetch_path("release", "normalize_lockfiles_command") || normalize_lockfiles_command
end

#release_publish_command ⇒ Object 



227
228
229
 
# File 'lib/kettle/family/config.rb', line 227

def release_publish_command
  fetch_path("release", "publish_command") || command_for("release_publish") || "bundle exec kettle-release"
end

#release_push_command ⇒ Object 



255
256
257
 
# File 'lib/kettle/family/config.rb', line 255

def release_push_command
  fetch_path("release", "push_command") || command_for("release_push") || "git push --follow-tags"
end

#release_tag_command ⇒ Object 



251
252
253
 
# File 'lib/kettle/family/config.rb', line 251

def release_tag_command
  fetch_path("release", "tag_command") || command_for("release_tag") || "git tag"
end

#release_target_branches ⇒ Object 



259
260
261
 
# File 'lib/kettle/family/config.rb', line 259

def release_target_branches
  fetch_path("release", "target_branches") || fetch_path("branches", "release_targets") || []
end

#shared_changelog? ⇒ Boolean

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/kettle/family/config.rb', line 149

def shared_changelog?
  changelog_mode == "root"
end

#template_command ⇒ Object 



175
176
177
 
# File 'lib/kettle/family/config.rb', line 175

def template_command
  fetch_path("template", "command") || command_for("template")
end

#template_jobs ⇒ Object 



187
188
189
 
# File 'lib/kettle/family/config.rb', line 187

def template_jobs
  fetch_path("template", "jobs")
end

#template_profile ⇒ Object 



179
180
181
 
# File 'lib/kettle/family/config.rb', line 179

def template_profile
  fetch_path("template", "profile")
end

#template_repository_topology ⇒ Object 



183
184
185
 
# File 'lib/kettle/family/config.rb', line 183

def template_repository_topology
  fetch_path("template", "repository_topology")
end