Class: Decidim::GemManager

Inherits:
Object
  • Object
show all
Defined in:
lib/decidim/gem_manager.rb

Overview

Handles a decidim components.

Allows to perform custom operations on all modules in a given folder, or on specific module folders.

Potential operations are:

  • Running custom commands, via the ‘run` method, such as releasing it, or installing it locally.

  • Updating version files from the main ‘.decidim-version` file in the root of the repository.

Constant Summary collapse

PARTICIPATORY_SPACES = 
%w(
  participatory_processes
  assemblies
  conferences
).freeze
COMPONENTS = 
%w(
  accountability
  budgets
  debates
  meetings
  pages
  proposals
  surveys
  blogs
).freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dir) ⇒ GemManager

Returns a new instance of GemManager.



39
40
41
 
# File 'lib/decidim/gem_manager.rb', line 39

def initialize(dir)
  @dir = File.expand_path(dir)
end

Class Method Details

.all_dirs(include_root: true) ⇒ Object 



187
188
189
190
191
192
 
# File 'lib/decidim/gem_manager.rb', line 187

def all_dirs(include_root: true)
  dirs = plugins
  dirs << "./" if include_root

  dirs.each { |dir| yield(dir) }
end

.capture(cmd, env: {}, with_stderr: true) ⇒ Object 



93
94
95
96
97
 
# File 'lib/decidim/gem_manager.rb', line 93

def capture(cmd, env: {}, with_stderr: true)
  return Open3.capture2e(env, cmd) if with_stderr

  Open3.capture2(env, cmd)
end

.fail_fast? ⇒ Boolean

Returns:

  • (Boolean) 


210
211
212
 
# File 'lib/decidim/gem_manager.rb', line 210

def fail_fast?
  ENV.fetch("FAIL_FAST", nil) != "false"
end

.install_all(out: $stdout) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/decidim/gem_manager.rb', line 125

def install_all(out: $stdout)
  run_all(
    "gem build %name && mv %name-%version.gem ..",
    include_root: false,
    out:
  )

  new(root).run(
    "gem build %name && gem install *.gem",
    out:
  )
end

.package_dirs ⇒ Object 



194
195
196
197
198
 
# File 'lib/decidim/gem_manager.rb', line 194

def package_dirs
  dirs = Dir.glob("#{root}/packages/*")

  dirs.each { |dir| yield(dir) }
end

.patch_component_gemfile_generator ⇒ Object 



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/decidim/gem_manager.rb', line 218

def patch_component_gemfile_generator
  content = %(# frozen_string_literal: true
<%# This file is automatically generated. Do not edit this file, it will be overwritten
If you want to modify it you can do it in the Decidim::GemManager.patch_component_gemfile_generator method %>
source "https://rubygems.org"

ruby RUBY_VERSION

gem "decidim", "~> #{version}"
gem "decidim-<%= component_name %>", path: "."

gem "puma", "#{fetch_gemfile_version("puma")}"
gem "bootsnap", "#{fetch_gemfile_version("bootsnap")}"

group :development, :test do
  gem "byebug", "#{fetch_gemfile_version("byebug")}", platform: :mri

  gem "decidim-dev", "~> #{version}"
end

group :development do
  gem "faker", "#{Gem.loaded_specs["decidim-dev"].dependencies.select { |a| a.name == "faker" }.first.requirement}"
  gem "letter_opener_web", "#{fetch_gemfile_version("letter_opener_web")}"
  gem "listen", "#{fetch_gemfile_version("listen")}"
  gem "web-console", "#{fetch_gemfile_version("web-console")}"
end
)

  file_path = File.join(root, "decidim-generators/lib/decidim/generators/component_templates/Gemfile.erb")
  File.write(file_path, content)
end

.plugins ⇒ Object 



200
201
202
203
204
 
# File 'lib/decidim/gem_manager.rb', line 200

def plugins
  Dir.glob("#{root}/decidim-*/").select do |dir|
    File.exist?(File.join(dir, "lib", "decidim"))
  end
end

.replace_file(name, regexp, replacement) ⇒ Object 



181
182
183
184
185
 
# File 'lib/decidim/gem_manager.rb', line 181

def replace_file(name, regexp, replacement)
  new_content = File.read(name).gsub(regexp, replacement)

  File.write(name, new_content)
end

.replace_versions ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/decidim/gem_manager.rb', line 111

def replace_versions
  all_dirs do |dir|
    manager = new(dir)
    manager.replace_gem_version
    manager.replace_gemspec_version
  end

  package_dirs do |dir|
    new(dir).replace_package_version
  end

  replace_antora_version
end

.retry_times ⇒ Object 



214
215
216
 
# File 'lib/decidim/gem_manager.rb', line 214

def retry_times
  ENV.fetch("RETRY_TIMES", 10).to_i
end

.run(cmd, out: $stdout) ⇒ Object 



99
100
101
 
# File 'lib/decidim/gem_manager.rb', line 99

def run(cmd, out: $stdout)
  system(cmd, out:)
end

.run_all(command, out: $stdout, include_root: true) ⇒ Object 



150
151
152
153
154
155
156
 
# File 'lib/decidim/gem_manager.rb', line 150

def run_all(command, out: $stdout, include_root: true)
  all_dirs(include_root:) do |dir|
    status = run_at(dir, command, out:)

    break if !status && fail_fast?
  end
end

.run_at(dir, command, out: $stdout) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
 
# File 'lib/decidim/gem_manager.rb', line 166

def run_at(dir, command, out: $stdout)
  attempts = 0
  until (status = new(dir).run(command, out:))
    attempts += 1

    break if attempts > Decidim::GemManager.retry_times
  end

  status
end

.run_packages(command, out: $stdout) ⇒ Object 



158
159
160
161
162
163
164
 
# File 'lib/decidim/gem_manager.rb', line 158

def run_packages(command, out: $stdout)
  package_dirs do |dir|
    status = run_at(dir, command, out:)

    break if !status && fail_fast?
  end
end

.semver_friendly_version(a_version) ⇒ Object 



206
207
208
 
# File 'lib/decidim/gem_manager.rb', line 206

def semver_friendly_version(a_version)
  a_version.gsub(/\.pre/, "-pre").gsub(/\.dev/, "-dev").gsub(/.rc(\d*)/, "-rc\\1")
end

.test_component ⇒ Object 



107
108
109
 
# File 'lib/decidim/gem_manager.rb', line 107

def test_component
  new("decidim-#{COMPONENTS.sample}").run("rake")
end

.test_participatory_space ⇒ Object 



103
104
105
 
# File 'lib/decidim/gem_manager.rb', line 103

def test_participatory_space
  new("decidim-#{PARTICIPATORY_SPACES.sample}").run("rake")
end

.uninstall_all(out: $stdout) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/decidim/gem_manager.rb', line 138

def uninstall_all(out: $stdout)
  run_all(
    "gem uninstall %name -v %version --executables --force",
    out:
  )

  new(root).run(
    "rm decidim-*.gem",
    out:
  )
end

.version ⇒ Object 



177
178
179
 
# File 'lib/decidim/gem_manager.rb', line 177

def version
  @version ||= File.read(version_file).strip
end

Instance Method Details

#capture(command, env: {}, with_stderr: true) ⇒ Object 



49
50
51
52
53
 
# File 'lib/decidim/gem_manager.rb', line 49

def capture(command, env: {}, with_stderr: true)
  interpolated_in_folder(command) do |cmd|
    self.class.capture(cmd, env:, with_stderr:)
  end
end

#replace_gem_version ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/decidim/gem_manager.rb', line 55

def replace_gem_version
  Dir.chdir(@dir) do
    replace_file(
      "lib/#{name.tr("-", "/")}/version.rb",
      /def self\.version(\s*)"[^"]*"/,
      "def self.version\\1\"#{version}\""
    )
  end
end

#replace_gemspec_version ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/decidim/gem_manager.rb', line 65

def replace_gemspec_version
  Dir.chdir(@dir) do
    gemspec_file = Dir.glob("*.gemspec").first
    return unless gemspec_file

    replace_file(
      gemspec_file,
      /(?<!required_ruby_)version = "[^"]*"/,
      "version = \"#{version}\""
    )
  end
end

#replace_package_version ⇒ Object 



78
79
80
81
82
83
84
85
86
 
# File 'lib/decidim/gem_manager.rb', line 78

def replace_package_version
  Dir.chdir(@dir) do
    replace_file(
      "package.json",
      /^  "version": "[^"]*"/,
      "  \"version\": \"#{semver_friendly_version(version)}\""
    )
  end
end

#run(command, out: $stdout) ⇒ Object 



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

def run(command, out: $stdout)
  interpolated_in_folder(command) do |cmd|
    self.class.run(cmd, out:)
  end
end

#short_name ⇒ Object 



88
89
90
 
# File 'lib/decidim/gem_manager.rb', line 88

def short_name
  name.gsub(/decidim-/, "")
end