modulesync 2.6.0 → 3.1.0

data/lib/modulesync/git_service/base.rb

@@ -2,7 +2,7 @@ module ModuleSync
   module GitService
     # Generic class for git services
     class Base
-      def open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:) # rubocop:disable Metrics/ParameterLists
+      def open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:)
         unless source_branch != target_branch
           raise ModuleSync::Error,
                 "Unable to open a pull request with the same source and target branch: '#{source_branch}'"
@@ -55,7 +55,7 @@ module ModuleSync
 
       protected
 
-      def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:) # rubocop:disable Metrics/ParameterLists
+      def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:)
         raise NotImplementedError
       end
     end

data/lib/modulesync/git_service/github.rb

@@ -13,12 +13,12 @@ module ModuleSync
         Octokit.configure do |c|
           c.api_endpoint = endpoint
         end
-        @api = Octokit::Client.new(:access_token => token)
+        @api = Octokit::Client.new(access_token: token)
       end
 
       private
 
-      def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:) # rubocop:disable Metrics/ParameterLists
+      def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:)
         head = "#{namespace}:#{source_branch}"
 
         if noop
@@ -28,9 +28,9 @@ module ModuleSync
         end
 
         pull_requests = @api.pull_requests(repo_path,
-                                           :state => 'open',
-                                           :base => target_branch,
-                                           :head => head)
+                                           state: 'open',
+                                           base: target_branch,
+                                           head: head)
         unless pull_requests.empty?
           # Skip creating the PR if it exists already.
           $stdout.puts "Skipped! #{pull_requests.length} PRs found for branch '#{source_branch}'"

data/lib/modulesync/git_service/gitlab.rb

@@ -11,8 +11,8 @@ module ModuleSync
         super()
 
         @api = Gitlab::Client.new(
-          :endpoint => endpoint,
-          :private_token => token,
+          endpoint: endpoint,
+          private_token: token,
         )
       end
 
@@ -26,7 +26,7 @@ module ModuleSync
 
       private
 
-      def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:) # rubocop:disable Metrics/ParameterLists, Lint/UnusedMethodArgument
+      def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:) # rubocop:disable Lint/UnusedMethodArgument
         if noop
           $stdout.puts "Using no-op. Would submit MR '#{title}' to '#{repo_path}' " \
                        "- merges #{source_branch} into #{target_branch}"
@@ -34,9 +34,9 @@ module ModuleSync
         end
 
         merge_requests = @api.merge_requests(repo_path,
-                                             :state => 'opened',
-                                             :source_branch => source_branch,
-                                             :target_branch => target_branch)
+                                             state: 'opened',
+                                             source_branch: source_branch,
+                                             target_branch: target_branch)
         unless merge_requests.empty?
           # Skip creating the MR if it exists already.
           $stdout.puts "Skipped! #{merge_requests.length} MRs found for branch '#{source_branch}'"
@@ -45,9 +45,9 @@ module ModuleSync
 
         mr = @api.create_merge_request(repo_path,
                                        title,
-                                       :source_branch => source_branch,
-                                       :target_branch => target_branch,
-                                       :labels => labels)
+                                       source_branch: source_branch,
+                                       target_branch: target_branch,
+                                       labels: labels)
         $stdout.puts \
           "Submitted MR '#{title}' to '#{repo_path}' " \
           "- merges '#{source_branch}' into '#{target_branch}'"

data/lib/modulesync/renderer.rb

@@ -15,7 +15,7 @@ module ModuleSync
       erb_obj = if RUBY_VERSION >= '2.7'
                   ERB.new(template, trim_mode: '-')
                 else
-                  ERB.new(template, nil, '-')
+                  ERB.new(template, trim_mode: '-')
                 end
       erb_obj.filename = template_file
       erb_obj.def_method(ForgeModuleFile, 'render()', template_file)

data/lib/modulesync/repository.rb

@@ -140,8 +140,8 @@ module ModuleSync
       begin
         opts_commit = {}
         opts_push = {}
-        opts_commit = { :amend => true } if options[:amend]
-        opts_push = { :force => true } if options[:force]
+        opts_commit = { amend: true } if options[:amend]
+        opts_push = { force: true } if options[:force]
         if options[:pre_commit_script]
           script = "#{File.dirname(File.dirname(__FILE__))}/../contrib/#{options[:pre_commit_script]}"
           `#{script} #{@directory}`

data/lib/modulesync.rb

@@ -12,17 +12,17 @@ require 'modulesync/util'
 
 require 'monkey_patches'
 
-module ModuleSync # rubocop:disable Metrics/ModuleLength
+module ModuleSync
   class Error < StandardError; end
 
   include Constants
 
   def self.config_defaults
     {
-      :project_root => 'modules/',
-      :managed_modules_conf => 'managed_modules.yml',
-      :configs => '.',
-      :tag_pattern => '%s',
+      project_root: 'modules/',
+      managed_modules_conf: 'managed_modules.yml',
+      configs: '.',
+      tag_pattern: '%s',
     }
   end
 
@@ -33,7 +33,7 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
   def self.local_file(config_path, file)
     path = File.join(config_path, MODULE_FILES_DIR, file)
     if !File.exist?("#{path}.erb") && File.exist?(path)
-      $stderr.puts "Warning: using '#{path}' as template without '.erb' suffix"
+      warn "Warning: using '#{path}' as template without '.erb' suffix"
       path
     else
       "#{path}.erb"
@@ -50,9 +50,9 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
           .collect { |p| p.chomp('.erb') }
           .to_a
     else
-      $stderr.puts "#{local_template_dir} does not exist." \
-                   ' Check that you are working in your module configs directory or' \
-                   ' that you have passed in the correct directory with -c.'
+      warn "#{local_template_dir} does not exist. " \
+           'Check that you are working in your module configs directory or ' \
+           'that you have passed in the correct directory with -c.'
       exit 1
     end
   end
@@ -68,8 +68,8 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
 
     managed_modules = Util.parse_config(config_file)
     if managed_modules.empty?
-      $stderr.puts "No modules found in #{config_file}." \
-                   ' Check that you specified the right :configs directory and :managed_modules_conf file.'
+      warn "No modules found in #{config_file}. " \
+           'Check that you specified the right :configs directory and :managed_modules_conf file.'
       exit 1
     end
     managed_modules.select! { |m| m =~ Regexp.new(filter) } unless filter.nil?
@@ -99,16 +99,16 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
         erb = Renderer.build(template_file)
         # Meta data passed to the template as @metadata[:name]
         metadata = {
-          :module_name => settings.additional_settings[:puppet_module],
-          :namespace => settings.additional_settings[:namespace],
-          :workdir => puppet_module.working_directory,
-          :target_file => target_file,
+          module_name: settings.additional_settings[:puppet_module],
+          namespace: settings.additional_settings[:namespace],
+          workdir: puppet_module.working_directory,
+          target_file: target_file,
         }
         template = Renderer.render(erb, configs, metadata)
         mode = File.stat(template_file).mode
         Renderer.sync(template, target_file, mode)
       rescue StandardError
-        $stderr.puts "#{puppet_module.given_name}: Error while rendering file: '#{filename}'"
+        warn "#{puppet_module.given_name}: Error while rendering file: '#{filename}'"
         raise
       end
     end
@@ -128,9 +128,9 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
                             defaults,
                             module_configs[GLOBAL_DEFAULTS_KEY] || {},
                             module_configs,
-                            :puppet_module => puppet_module.repository_name,
-                            :git_base => options[:git_base],
-                            :namespace => puppet_module.repository_namespace)
+                            puppet_module: puppet_module.repository_name,
+                            git_base: options[:git_base],
+                            namespace: puppet_module.repository_namespace)
 
     settings.unmanaged_files(module_files).each do |filename|
       $stdout.puts "Not managing '#{filename}' in '#{puppet_module.given_name}'"
@@ -178,7 +178,7 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
       manage_module(puppet_module, module_files, defaults)
     rescue ModuleSync::Error, Git::GitExecuteError => e
       message = e.message || 'Error during `update`'
-      $stderr.puts "#{puppet_module.given_name}: #{message}"
+      warn "#{puppet_module.given_name}: #{message}"
       exit 1 unless options[:skip_broken]
       errors = true
       $stdout.puts "Skipping '#{puppet_module.given_name}' as update process failed"
@@ -222,7 +222,7 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
         raise Thor::Error, message if @options[:fail_fast]
 
         errors[puppet_module.given_name] = message
-        $stderr.puts message
+        warn message
       end
 
       $stdout.puts ''

data/modulesync.gemspec

@@ -3,33 +3,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '2.6.0'
+  spec.version               = '3.1.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
   spec.description           = 'Utility to synchronize common files across puppet modules in Github.'
   spec.homepage              = 'https://github.com/voxpupuli/modulesync'
   spec.license               = 'Apache-2.0'
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'aruba', '~>2.0'
-  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'cucumber'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop', '~> 1.28.2'
-  spec.add_development_dependency 'rubocop-performance'
-  spec.add_development_dependency 'rubocop-rake'
-  spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'voxpupuli-rubocop', '~> 2.0'
 
   spec.add_runtime_dependency 'git', '~>1.7'
   spec.add_runtime_dependency 'gitlab', '~>4.0'
-  spec.add_runtime_dependency 'octokit', '~>4.0'
-  spec.add_runtime_dependency 'puppet-blacksmith', '>= 3.0', '< 7'
+  spec.add_runtime_dependency 'octokit', '>=4', '<8'
+  spec.add_runtime_dependency 'puppet-blacksmith', '>= 3.0', '< 8'
   spec.add_runtime_dependency 'thor'
 end

data/spec/helpers/faker/puppet_module_remote_repo.rb

@@ -102,21 +102,21 @@ module ModuleSync
 
       def tags
         FileUtils.chdir(bare_repo_dir) do
-          return run %w{git tag --list}
+          return run %w[git tag --list]
         end
       end
 
       def delete_branch(branch)
         FileUtils.chdir(bare_repo_dir) do
-          run %W{git branch -D #{branch}}
+          run %W[git branch -D #{branch}]
         end
       end
 
       def create_branch(branch, from = nil)
         from ||= default_branch
         FileUtils.chdir(tmp_repo_dir) do
-          run %W{git branch -c #{from} #{branch}}
-          run %W{git push --set-upstream origin #{branch}}
+          run %W[git branch -c #{from} #{branch}]
+          run %W[git push --set-upstream origin #{branch}]
         end
       end
 

data/spec/helpers/faker.rb

@@ -7,6 +7,7 @@ module ModuleSync
 
     def self.working_directory
       raise 'Working directory must be set' if @working_directory.nil?
+
       FileUtils.mkdir_p @working_directory
       @working_directory
     end

data/spec/unit/modulesync/git_service/factory_spec.rb

@@ -4,13 +4,19 @@ require 'modulesync/git_service/factory'
 describe ModuleSync::GitService::Factory do
   context 'when instantiate a GitHub service without credentials' do
     it 'raises an error' do
-      expect { ModuleSync::GitService::Factory.instantiate(type: :github, endpoint: nil, token: nil) }.to raise_error(ModuleSync::GitService::MissingCredentialsError)
+      expect do
+        ModuleSync::GitService::Factory.instantiate(type: :github, endpoint: nil,
+                                                    token: nil)
+      end.to raise_error(ModuleSync::GitService::MissingCredentialsError)
     end
   end
 
   context 'when instantiate a GitLab service without credentials' do
     it 'raises an error' do
-      expect { ModuleSync::GitService::Factory.instantiate(type: :gitlab, endpoint: nil, token: nil) }.to raise_error(ModuleSync::GitService::MissingCredentialsError)
+      expect do
+        ModuleSync::GitService::Factory.instantiate(type: :gitlab, endpoint: nil,
+                                                    token: nil)
+      end.to raise_error(ModuleSync::GitService::MissingCredentialsError)
     end
   end
 end

data/spec/unit/modulesync/git_service/github_spec.rb

@@ -4,8 +4,8 @@ require 'modulesync/git_service/github'
 
 describe ModuleSync::GitService::GitHub do
   context '::open_pull_request' do
-    before(:each) do
-      @client = double()
+    before do
+      @client = double
       allow(Octokit::Client).to receive(:new).and_return(@client)
       @it = ModuleSync::GitService::GitHub.new('test', 'https://api.github.com')
     end
@@ -28,53 +28,51 @@ describe ModuleSync::GitService::GitHub do
     it 'submits PR when --pr is set' do
       allow(@client).to receive(:pull_requests)
         .with(args[:repo_path],
-              :state => 'open',
-              :base => 'master',
-              :head => "#{args[:namespace]}:#{args[:source_branch]}"
-             ).and_return([])
+              state: 'open',
+              base: 'master',
+              head: "#{args[:namespace]}:#{args[:source_branch]}").and_return([])
       expect(@client).to receive(:create_pull_request)
         .with(args[:repo_path],
               'master',
               args[:source_branch],
               args[:title],
-              args[:message]
-             ).and_return({"html_url" => "http://example.com/pulls/22"})
+              args[:message]).and_return({ 'html_url' => 'http://example.com/pulls/22' })
       expect { @it.open_pull_request(**args) }.to output(/Submitted PR/).to_stdout
     end
 
     it 'skips submitting PR if one has already been issued' do
       pr = {
-        "title" => "Test title",
-        "html_url" => "https://example.com/pulls/44",
-        "number" => "44"
+        'title' => 'Test title',
+        'html_url' => 'https://example.com/pulls/44',
+        'number' => '44',
       }
 
       expect(@client).to receive(:pull_requests)
         .with(args[:repo_path],
-              :state => 'open',
-              :base => 'master',
-              :head => "#{args[:namespace]}:#{args[:source_branch]}"
-             ).and_return([pr])
+              state: 'open',
+              base: 'master',
+              head: "#{args[:namespace]}:#{args[:source_branch]}").and_return([pr])
       expect { @it.open_pull_request(**args) }.to output("Skipped! 1 PRs found for branch 'test'\n").to_stdout
     end
 
     context 'when labels are set' do
-      let(:labels) { %w{HELLO WORLD} }
+      let(:labels) { %w[HELLO WORLD] }
 
       it 'adds labels to PR' do
-        allow(@client).to receive(:create_pull_request).and_return({"html_url" => "http://example.com/pulls/22", "number" => "44"})
+        allow(@client).to receive(:create_pull_request).and_return({ 'html_url' => 'http://example.com/pulls/22',
+                                                                     'number' => '44', })
         allow(@client).to receive(:pull_requests)
           .with(args[:repo_path],
-                :state => 'open',
-                :base => 'master',
-                :head => "#{args[:namespace]}:#{args[:source_branch]}"
-               ).and_return([])
+                state: 'open',
+                base: 'master',
+                head: "#{args[:namespace]}:#{args[:source_branch]}").and_return([])
         expect(@client).to receive(:add_labels_to_an_issue)
           .with(args[:repo_path],
-                "44",
-                ["HELLO", "WORLD"]
-               )
-        expect { @it.open_pull_request(**args) }.to output(/Attaching the following labels to PR 44: HELLO, WORLD/).to_stdout
+                '44',
+                %w[HELLO WORLD])
+        expect do
+          @it.open_pull_request(**args)
+        end.to output(/Attaching the following labels to PR 44: HELLO, WORLD/).to_stdout
       end
     end
   end

data/spec/unit/modulesync/git_service/gitlab_spec.rb

@@ -4,8 +4,8 @@ require 'modulesync/git_service/gitlab'
 
 describe ModuleSync::GitService::GitLab do
   context '::open_pull_request' do
-    before(:each) do
-      @client = double()
+    before do
+      @client = double
       allow(Gitlab::Client).to receive(:new).and_return(@client)
       @it = ModuleSync::GitService::GitLab.new('test', 'https://gitlab.com/api/v4')
     end
@@ -28,62 +28,59 @@ describe ModuleSync::GitService::GitLab do
     it 'submits MR when --pr is set' do
       allow(@client).to receive(:merge_requests)
         .with(args[:repo_path],
-              :state => 'opened',
-              :source_branch => args[:source_branch],
-              :target_branch => 'master',
-             ).and_return([])
+              state: 'opened',
+              source_branch: args[:source_branch],
+              target_branch: 'master').and_return([])
 
       expect(@client).to receive(:create_merge_request)
         .with(args[:repo_path],
               args[:title],
-              :labels => [],
-              :source_branch => args[:source_branch],
-              :target_branch => 'master',
-             ).and_return({"html_url" => "http://example.com/pulls/22"})
+              labels: [],
+              source_branch: args[:source_branch],
+              target_branch: 'master').and_return({ 'html_url' => 'http://example.com/pulls/22' })
 
       expect { @it.open_pull_request(**args) }.to output(/Submitted MR/).to_stdout
     end
 
     it 'skips submitting MR if one has already been issued' do
       mr = {
-        "title" => "Test title",
-        "html_url" => "https://example.com/pulls/44",
-        "iid" => "44"
+        'title' => 'Test title',
+        'html_url' => 'https://example.com/pulls/44',
+        'iid' => '44',
       }
 
       expect(@client).to receive(:merge_requests)
         .with(args[:repo_path],
-              :state => 'opened',
-              :source_branch => args[:source_branch],
-              :target_branch => 'master',
-             ).and_return([mr])
+              state: 'opened',
+              source_branch: args[:source_branch],
+              target_branch: 'master').and_return([mr])
 
       expect { @it.open_pull_request(**args) }.to output("Skipped! 1 MRs found for branch 'test'\n").to_stdout
     end
 
     context 'when labels are set' do
-      let(:labels) { %w{HELLO WORLD} }
+      let(:labels) { %w[HELLO WORLD] }
 
       it 'adds labels to MR' do
-        mr = double()
-        allow(mr).to receive(:iid).and_return("42")
+        mr = double
+        allow(mr).to receive(:iid).and_return('42')
 
         expect(@client).to receive(:create_merge_request)
           .with(args[:repo_path],
                 args[:title],
-                :labels => ["HELLO", "WORLD"],
-                :source_branch => args[:source_branch],
-                :target_branch => 'master',
-               ).and_return(mr)
+                labels: %w[HELLO WORLD],
+                source_branch: args[:source_branch],
+                target_branch: 'master').and_return(mr)
 
         allow(@client).to receive(:merge_requests)
           .with(args[:repo_path],
-                :state => 'opened',
-                :source_branch => args[:source_branch],
-                :target_branch => 'master',
-               ).and_return([])
+                state: 'opened',
+                source_branch: args[:source_branch],
+                target_branch: 'master').and_return([])
 
-        expect { @it.open_pull_request(**args) }.to output(/Attached the following labels to MR 42: HELLO, WORLD/).to_stdout
+        expect do
+          @it.open_pull_request(**args)
+        end.to output(/Attached the following labels to MR 42: HELLO, WORLD/).to_stdout
       end
     end
   end