modulesync 2.4.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8aebcf942cd3e1d9ccef2339d17bd07e208ee279305ba0bb6e7ad0b615ff69af
-  data.tar.gz: d4a2d213c0ed6b96a3d7f616e3e5b4a26145e1d741246daea3e9b903df0ba380
+  metadata.gz: 16c0c39c9e9c25f2f153464a9b0eaaa32d84d2d0586620e479676d4900503ae9
+  data.tar.gz: 328deb34bae7f84f47969b289b121a0f241dbde49756d881963f21dac0842595
 SHA512:
-  metadata.gz: cd56a2ab522debc6a002dceb8b84f5296d970bbbc8e57f242e913f0f7e9ba6dbdc8ca16005937d2d45d79df4991baaec4122c288cbed0be39ae28502f90752a3
-  data.tar.gz: 4301a8ace72c549965bec4438cf152c15bf7c4b4c9cda6a8ad14d3da8d2ff774fed8354ce9a13cdf94630cc18955d43bfdb520da3173501dc8e7aecdcfd36b9c
+  metadata.gz: 42ca23a6203c31ceab58cb653070763e309606255107fec64239ce4808744073975dee48d8a397a3eb5cdc458882e29c126413aae6fc36eafd64024cb4441243
+  data.tar.gz: 33543edf6757f1988c5fca4a382a3b939a53647764bf0fc4291f6076c188749f72f5036438cc93b91999b7268c65400b34059b050ba0b6857eb89e9758de11ad

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+# raise PRs for gem updates
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10
+
+# Maintain dependencies for GitHub Actions
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "13:00"
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -1,8 +1,11 @@
 ---
-name: CI
+name: ⚒️ CI
+
 on:
-  - pull_request
-  - push
+  pull_request: {}
+  push:
+    branches:
+      - master
 
 env:
   BUNDLE_WITHOUT: release
@@ -11,7 +14,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -32,10 +35,11 @@ jobs:
           - ruby: "3.0"
           - ruby: "3.1"
             codecov: "yes"
+          - ruby: "3.2"
     env:
       CODECOV: ${{ matrix.codecov }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Install Ruby ${{ matrix.ruby }}
         uses: ruby/setup-ruby@v1
         with:
@@ -47,3 +51,11 @@ jobs:
         run: bundle exec cucumber
       - name: Build gem
         run: gem build *.gemspec
+  tests:
+    needs:
+      - rubocop
+      - test
+    runs-on: ubuntu-latest
+    name: Test suite
+    steps:
+      - run: echo Test suite completed

data/.github/workflows/release.yml

@@ -8,13 +8,15 @@ on:
 jobs:
   release:
     runs-on: ubuntu-latest
-    if: github.repository == 'voxpupuli/modulesync'
+    if: github.repository_owner == 'voxpupuli'
     steps:
-      - uses: actions/checkout@v2
-      - name: Install Ruby 3.1
+      - uses: actions/checkout@v3
+      - name: Install Ruby 3.2
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.2'
+        env:
+          BUNDLE_WITHOUT: release
       - name: Build gem
         run: gem build *.gemspec
       - name: Publish gem to rubygems.org

data/.rubocop.yml

@@ -32,9 +32,6 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
-Layout/LineContinuationLeadingSpace:
-  Enabled: false
-
 # sane line length
 Layout/LineLength:
   Max: 120
@@ -47,3 +44,7 @@ Style/FrozenStringLiteralComment:
 # We explicitly prefer $stderr.puts over #warn
 Style/StderrPuts:
   Enabled: false
+
+Gemspec/RequireMFA:
+  Exclude:
+    - 'modulesync.gemspec'

data/.rubocop_todo.yml

@@ -1,20 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-02-14 21:55:21 UTC using RuboCop version 1.24.1.
+# on 2023-04-14 18:50:10 UTC using RuboCop version 1.28.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'modulesync.gemspec'
-
-# Offense count: 9
+# Offense count: 10
 # Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 60

data/CHANGELOG.md

@@ -2,6 +2,37 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.6.0](https://github.com/voxpupuli/modulesync/tree/2.6.0) (2023-04-14)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/2.5.0...2.6.0)
+
+**Implemented enhancements:**
+
+- Add Ruby 3.2 support [\#266](https://github.com/voxpupuli/modulesync/pull/266) ([bastelfreak](https://github.com/bastelfreak))
+- Update to latest RuboCop 1.28.2 [\#265](https://github.com/voxpupuli/modulesync/pull/265) ([bastelfreak](https://github.com/bastelfreak))
+
+**Fixed bugs:**
+
+- Fix compatibility with latest `ruby-git` [\#260](https://github.com/voxpupuli/modulesync/pull/260) ([alexjfisher](https://github.com/alexjfisher))
+
+**Closed issues:**
+
+- msync update --noop is broken with git 1.17.x [\#259](https://github.com/voxpupuli/modulesync/issues/259)
+
+**Merged pull requests:**
+
+- Add CI best practices [\#264](https://github.com/voxpupuli/modulesync/pull/264) ([bastelfreak](https://github.com/bastelfreak))
+- Bump actions/checkout from 2 to 3 [\#262](https://github.com/voxpupuli/modulesync/pull/262) ([dependabot[bot]](https://github.com/apps/dependabot))
+- dependabot: check for github actions and gems [\#261](https://github.com/voxpupuli/modulesync/pull/261) ([bastelfreak](https://github.com/bastelfreak))
+
+## [2.5.0](https://github.com/voxpupuli/modulesync/tree/2.5.0) (2022-10-14)
+
+[Full Changelog](https://github.com/voxpupuli/modulesync/compare/2.4.0...2.5.0)
+
+**Implemented enhancements:**
+
+- Copy file permissions from template to target [\#257](https://github.com/voxpupuli/modulesync/pull/257) ([ekohl](https://github.com/ekohl))
+
 ## [2.4.0](https://github.com/voxpupuli/modulesync/tree/2.4.0) (2022-09-27)
 
 [Full Changelog](https://github.com/voxpupuli/modulesync/compare/2.3.1...2.4.0)

data/Rakefile

@@ -9,7 +9,18 @@ rescue LoadError
   puts 'rspec not installed - skipping unit test task setup'
 end
 
-RuboCop::RakeTask.new
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+  # RuboCop is an optional group
+else
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    # These make the rubocop experience maybe slightly less terrible
+    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
+    # Use Rubocop's Github Actions formatter if possible
+    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
+  end
+end
 
 CLEAN.include('pkg/', 'tmp/')
 

data/features/update/pull_request.feature

@@ -32,9 +32,8 @@ Feature: Create a pull-request/merge-request after update
       """
       ---
       puppet-test:
-        gitlab: {
+        gitlab:
           base_url: 'https://gitlab.example.com'
-      }
       """
     And I set the environment variables to:
       | variable     | value  |
@@ -60,9 +59,8 @@ Feature: Create a pull-request/merge-request after update
       """
       ---
       puppet-test:
-        gitlab: {
+        gitlab:
           base_url: 'https://gitlab.example.com'
-        }
       """
     And I set the environment variables to:
       | variable     | value  |
@@ -77,9 +75,8 @@ Feature: Create a pull-request/merge-request after update
       """
       ---
       puppet-test:
-        gitlab: {
+        gitlab:
           base_url: https://gitlab.example.com
-        }
       """
     And a file named "config_defaults.yml" with:
       """

data/lib/modulesync/git_service/github.rb

@@ -22,9 +22,8 @@ module ModuleSync
         head = "#{namespace}:#{source_branch}"
 
         if noop
-          $stdout.puts \
-            "Using no-op. Would submit PR '#{title}' to '#{repo_path}' " \
-            "- merges '#{source_branch}' into '#{target_branch}'"
+          $stdout.puts "Using no-op. Would submit PR '#{title}' to '#{repo_path}' " \
+                       "- merges '#{source_branch}' into '#{target_branch}'"
           return
         end
 

data/lib/modulesync/git_service/gitlab.rb

@@ -28,9 +28,8 @@ module ModuleSync
 
       def _open_pull_request(repo_path:, namespace:, title:, message:, source_branch:, target_branch:, labels:, noop:) # rubocop:disable Metrics/ParameterLists, Lint/UnusedMethodArgument
         if noop
-          $stdout.puts \
-            "Using no-op. Would submit MR '#{title}' to '#{repo_path}' " \
-            "- merges #{source_branch} into #{target_branch}"
+          $stdout.puts "Using no-op. Would submit MR '#{title}' to '#{repo_path}' " \
+                       "- merges #{source_branch} into #{target_branch}"
           return
         end
 

data/lib/modulesync/hook.rb

@@ -15,10 +15,10 @@ module ModuleSync
       <<~CONTENT
         #!/usr/bin/env bash
 
-        current_branch=\`git symbolic-ref HEAD | sed -e 's,.*/\(.*\),\1,'\`
-        git_dir=\`git rev-parse --show-toplevel\`
-        message=\`git log -1 --format=%B\`
-        msync -m "\$message" #{arguments}
+        current_branch=`git symbolic-ref HEAD | sed -e 's,.*/(.*),\1,'`
+        git_dir=`git rev-parse --show-toplevel`
+        message=`git log -1 --format=%B`
+        msync -m "$message" #{arguments}
       CONTENT
     end
 

data/lib/modulesync/renderer.rb

@@ -10,13 +10,7 @@ module ModuleSync
       end
     end
 
-    def self.build(target_name)
-      template_file = if !File.exist?("#{target_name}.erb") && File.exist?(target_name)
-                        $stderr.puts "Warning: using '#{target_name}' as template without '.erb' suffix"
-                        target_name
-                      else
-                        "#{target_name}.erb"
-                      end
+    def self.build(template_file)
       template = File.read(template_file)
       erb_obj = if RUBY_VERSION >= '2.7'
                   ERB.new(template, trim_mode: '-')
@@ -36,9 +30,10 @@ module ModuleSync
       ForgeModuleFile.new(configs, metadata).render
     end
 
-    def self.sync(template, target_name)
+    def self.sync(template, target_name, mode = nil)
       FileUtils.mkdir_p(File.dirname(target_name))
       File.write(target_name, template)
+      File.chmod(mode, target_name) unless mode.nil?
     end
   end
 end

data/lib/modulesync/repository.rb

@@ -31,6 +31,9 @@ module ModuleSync
     end
 
     def default_branch
+      # `Git.default_branch` requires ruby-git >= 1.17.0
+      return Git.default_branch(repo.dir) if Git.respond_to? :default_branch
+
       symbolic_ref = repo.branches.find { |b| b.full.include?('remotes/origin/HEAD') }
       return unless symbolic_ref
 

data/lib/modulesync.rb

@@ -31,7 +31,13 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
   end
 
   def self.local_file(config_path, file)
-    File.join(config_path, MODULE_FILES_DIR, 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"
+      path
+    else
+      "#{path}.erb"
+    end
   end
 
   # List all template files.
@@ -88,9 +94,9 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
     if configs['delete']
       Renderer.remove(target_file)
     else
-      templatename = local_file(options[:configs], filename)
+      template_file = local_file(options[:configs], filename)
       begin
-        erb = Renderer.build(templatename)
+        erb = Renderer.build(template_file)
         # Meta data passed to the template as @metadata[:name]
         metadata = {
           :module_name => settings.additional_settings[:puppet_module],
@@ -99,7 +105,8 @@ module ModuleSync # rubocop:disable Metrics/ModuleLength
           :target_file => target_file,
         }
         template = Renderer.render(erb, configs, metadata)
-        Renderer.sync(template, target_file)
+        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}'"
         raise

data/modulesync.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name                  = 'modulesync'
-  spec.version               = '2.4.0'
+  spec.version               = '2.6.0'
   spec.authors               = ['Vox Pupuli']
   spec.email                 = ['voxpupuli@groups.io']
   spec.summary               = 'Puppet Module Synchronizer'
@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'aruba', '>= 0.14', '< 2'
+  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.2'
+  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'

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: modulesync
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Vox Pupuli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2023-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.14'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -92,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.28.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 1.28.2
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -241,6 +235,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".config/cucumber.yml"
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/release.yml"
 - ".gitignore"
@@ -315,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Puppet Module Synchronizer