librarian-puppet 5.1.0 → 6.0.0

data/lib/librarian/puppet/source/forge/repo_v1.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'open-uri'
 require 'librarian/puppet/source/forge/repo'
@@ -7,9 +9,8 @@ module Librarian
     module Source
       class Forge
         class RepoV1 < Librarian::Puppet::Source::Forge::Repo
-
           def initialize(source, name)
-            super(source, name)
+            super
             # API returned data for this module including all versions and dependencies, indexed by module name
             # from https://forge.puppetlabs.com/api/v1/releases.json?module=#{name}
             @api_data = nil
@@ -31,14 +32,15 @@ module Librarian
             "#{source}#{info[name].first['file']}"
           end
 
-        private
+          private
 
           # convert organization/modulename to organization-modulename
           def normalize_dependencies(data)
             return nil if data.nil?
+
             # convert organization/modulename to organization-modulename
             data.keys.each do |m|
-              if m =~ %r{.*/.*}
+              if %r{.*/.*}.match?(m)
                 data[normalize_name(m)] = data[m]
                 data.delete(m)
               end
@@ -49,39 +51,43 @@ module Librarian
           # get and cache the API data for a specific module with all its versions and dependencies
           def api_data(module_name)
             return @api_data[module_name] if @api_data
+
             # call API and cache data
             @api_data = normalize_dependencies(api_call(module_name))
-            if @api_data.nil?
-              raise Error, "Unable to find module '#{name}' on #{source}"
-            end
+            raise Error, "Unable to find module '#{name}' on #{source}" if @api_data.nil?
+
             @api_data[module_name]
           end
 
           # get and cache the API data for a specific module and version
           def api_version_data(module_name, version)
             # if we already got all the versions, find in cached data
-            return @api_data[module_name].detect{|x| x['version'] == version.to_s} if @api_data
+            return @api_data[module_name].detect { |x| x['version'] == version.to_s } if @api_data
+
             # otherwise call the api for this version if not cached already
-            @api_version_data[version] = normalize_dependencies(api_call(name, version)) if @api_version_data[version].nil?
+            if @api_version_data[version].nil?
+              @api_version_data[version] =
+                normalize_dependencies(api_call(name, version))
+            end
             @api_version_data[version]
           end
 
-          def api_call(module_name, version=nil)
+          def api_call(module_name, version = nil)
             url = source.uri.clone
             url.path += "#{'/' if url.path.empty? or url.path[-1] != '/'}api/v1/releases.json"
-            url.query = "module=#{module_name.sub('-','/')}" # v1 API expects "organization/module"
+            url.query = "module=#{module_name.sub('-', '/')}" # v1 API expects "organization/module"
             url.query += "&version=#{version}" unless version.nil?
             debug { "Querying Forge API for module #{name}#{" and version #{version}" unless version.nil?}: #{url}" }
 
             begin
-              data = URI.open(url) {|f| f.read}
+              data = URI.open(url) { |f| f.read }
               JSON.parse(data)
             rescue OpenURI::HTTPError => e
               case e.io.status[0].to_i
-              when 404,410
+              when 404, 410
                 nil
               else
-                raise e, "Error requesting #{url}: #{e.to_s}"
+                raise e, "Error requesting #{url}: #{e}"
               end
             end
           end

data/lib/librarian/puppet/source/forge/repo_v3.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/puppet/source/forge/repo'
 require 'puppet_forge'
 require 'librarian/puppet/version'
@@ -7,25 +9,24 @@ module Librarian
     module Source
       class Forge
         class RepoV3 < Librarian::Puppet::Source::Forge::Repo
-
           PuppetForge.user_agent = "librarian-puppet/#{Librarian::Puppet::VERSION}"
 
           def initialize(source, name)
             PuppetForge.host = source.uri.clone
-            super(source, name)
+            super
           end
 
           def get_versions
-            get_module.releases.select{|r| r.deleted_at.nil?}.map{|r| r.version}
+            get_module.releases.select { |r| r.deleted_at.nil? }.map { |r| r.version }
           end
 
           def dependencies(version)
-            array = get_release(version).metadata[:dependencies].map{|d| [d[:name], d[:version_requirement]]}
+            array = get_release(version).metadata[:dependencies].map { |d| [d[:name], d[:version_requirement]] }
             Hash[*array.flatten(1)]
           end
 
           def url(name, version)
-            if name == "#{get_module().owner.username}/#{get_module().name}"
+            if name == "#{get_module.owner.username}/#{get_module.name}"
               release = get_release(version)
             else
               # should never get here as we use one repo object for each module (to be changed in the future)
@@ -35,28 +36,27 @@ module Librarian
             "#{source}#{release.file_uri}"
           end
 
-        private
+          private
 
           def get_module
             begin
               @module ||= PuppetForge::V3::Module.find(name)
               # https://github.com/puppetlabs/forge-ruby/pull/104/files starting with version 5, PuppetForge::ModuleNotFound is raised
               # previous versions raise Faraday::ResourceNotFound
-            rescue Faraday::ResourceNotFound, PuppetForge::ModuleNotFound => e
+            rescue Faraday::ResourceNotFound, PuppetForge::ModuleNotFound
               raise(Error, "Unable to find module '#{name}' on #{source}")
             end
             @module
           end
 
           def get_release(version)
-            release = get_module.releases.find{|r| r.version == version.to_s}
+            release = get_module.releases.find { |r| r.version == version.to_s }
             if release.nil?
-              versions = get_module.releases.map{|r| r.version}
+              versions = get_module.releases.map { |r| r.version }
               raise Error, "Unable to find version '#{version}' for module '#{name}' on #{source} amongst #{versions}"
             end
             release
           end
-
         end
       end
     end

data/lib/librarian/puppet/source/forge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'librarian/puppet/util'
 require 'librarian/puppet/source/forge/repo_v1'
@@ -25,15 +27,13 @@ module Librarian
           end
 
           def from_lock_options(environment, options)
-            new(environment, options[:remote], options.reject { |k, v| k == :remote })
+            new(environment, options[:remote], options.reject { |k, _v| k == :remote })
           end
 
           def from_spec_args(environment, uri, options)
             recognised_options = []
             unrecognised_options = options.keys - recognised_options
-            unless unrecognised_options.empty?
-              raise Error, "unrecognised options: #{unrecognised_options.join(", ")}"
-            end
+            raise Error, "unrecognised options: #{unrecognised_options.join(', ')}" unless unrecognised_options.empty?
 
             new(environment, uri, options)
           end
@@ -43,10 +43,10 @@ module Librarian
         private :environment=
         attr_reader :uri
 
-        def initialize(environment, uri, options = {})
+        def initialize(environment, uri, _options = {})
           self.environment = environment
 
-          @uri = URI::parse(uri)
+          @uri = URI.parse(uri)
           @cache_path = nil
         end
 
@@ -56,14 +56,14 @@ module Librarian
 
         def ==(other)
           other &&
-          self.class == other.class &&
-          self.uri == other.uri
+            self.class == other.class &&
+            uri == other.uri
         end
 
-        alias :eql? :==
+        alias eql? ==
 
         def hash
-          self.to_s.hash
+          to_s.hash
         end
 
         def to_spec_args
@@ -71,15 +71,14 @@ module Librarian
         end
 
         def to_lock_options
-          {:remote => uri.to_s}
+          { remote: uri.to_s }
         end
 
         def pinned?
           false
         end
 
-        def unpin!
-        end
+        def unpin!; end
 
         def install!(manifest)
           manifest.source == self or raise ArgumentError
@@ -121,7 +120,7 @@ module Librarian
           end
         end
 
-        def fetch_dependencies(name, version, version_uri)
+        def fetch_dependencies(name, version, _version_uri)
           repo(name).dependencies(version).map do |k, v|
             v = Librarian::Dependency::Requirement.new(v).to_gem_requirement
             Dependency.new(k, v, nil, name)
@@ -132,19 +131,19 @@ module Librarian
           repo(name).manifests
         end
 
-      private
+        private
 
         def repo(name)
           @repo ||= {}
 
           unless @repo[name]
-            # If we are using the official Forge then use API v3, otherwise use the preferred api 
+            # If we are using the official Forge then use API v3, otherwise use the preferred api
             # as defined by the CLI option use_v1_api
-            if !environment.use_v1_api
-              @repo[name] = RepoV3.new(self, name)
-            else
-              @repo[name] = RepoV1.new(self, name)
-            end
+            @repo[name] = if environment.use_v1_api
+                            RepoV1.new(self, name)
+                          else
+                            RepoV3.new(self, name)
+                          end
           end
           @repo[name]
         end

data/lib/librarian/puppet/source/git.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/source/git'
 require 'librarian/puppet/source/local'
 
@@ -7,12 +9,10 @@ module Librarian
       class Repository
         def hash_from(remote, reference)
           branch_names = remote_branch_names[remote]
-          if branch_names.include?(reference)
-            reference = "#{remote}/#{reference}"
-          end
+          reference = "#{remote}/#{reference}" if branch_names.include?(reference)
 
-          command = %W(rev-parse #{reference}^{commit} --quiet)
-          run!(command, :chdir => true).strip
+          command = %W[rev-parse #{reference}^{commit} --quiet]
+          run!(command, chdir: true).strip
         end
       end
     end
@@ -37,6 +37,10 @@ module Librarian
             raise Error, "Could not checkout #{uri}#{" at #{sha}" unless sha.nil?}: #{e}"
           end
 
+          if strip_dot_git? and repository.git?
+            repository.path.join('.git').rmtree
+          end
+
           cache_in_vendor(repository.path) if environment.vendor?
         end
 
@@ -54,20 +58,23 @@ module Librarian
           vendor_tgz.exist?
         end
 
+        def strip_dot_git?
+          environment.config_db.local["install.strip-dot-git"] == '1'
+        end
+
         def vendor_checkout!
           repository.path.rmtree if repository.path.exist?
           repository.path.mkpath
 
-          Librarian::Posix.run!(%W{tar xzf #{vendor_tgz}}, :chdir => repository.path.to_s)
+          Librarian::Posix.run!(%W[tar xzf #{vendor_tgz}], chdir: repository.path.to_s)
 
           repository_cached!
         end
 
         def cache_in_vendor(tmp_path)
-          Librarian::Posix.run!(%W{git archive -o #{vendor_tar} #{sha}}, :chdir => tmp_path.to_s)
-          Librarian::Posix.run!(%W{gzip #{vendor_tar}}, :chdir => tmp_path.to_s)
+          Librarian::Posix.run!(%W[git archive -o #{vendor_tar} #{sha}], chdir: tmp_path.to_s)
+          Librarian::Posix.run!(%W[gzip #{vendor_tar}], chdir: tmp_path.to_s)
         end
-
       end
     end
   end

data/lib/librarian/puppet/source/githubtarball/repo.rb

@@ -17,10 +17,9 @@ module Librarian
 
           def versions
             return @versions if @versions
+
             data = api_call("/repos/#{source.uri}/tags")
-            if data.nil?
-              raise Error, "Unable to find module '#{source.uri}' on https://github.com"
-            end
+            raise Error, "Unable to find module '#{source.uri}' on https://github.com" if data.nil?
 
             all_versions = data.map { |r| r['name'].gsub(/^v/, '') }.sort.reverse
 
@@ -29,7 +28,7 @@ module Librarian
             end
 
             @versions = all_versions.compact
-            debug { "  Module #{name} found versions: #{@versions.join(", ")}" }
+            debug { "  Module #{name} found versions: #{@versions.join(', ')}" }
             @versions
           end
 
@@ -48,9 +47,7 @@ module Librarian
 
             cache_version_unpacked! version
 
-            if install_path.exist? && rsync? != true
-              install_path.rmtree
-            end
+            install_path.rmtree if install_path.exist? && rsync? != true
 
             unpacked_path = version_unpacked_cache_path(version).children.first
             cp_r(unpacked_path, install_path)
@@ -64,7 +61,7 @@ module Librarian
 
             target = vendored?(vendored_name, version) ? vendored_path(vendored_name, version) : name
 
-            Librarian::Posix.run!(%W{tar xzf #{target} -C #{path}})
+            Librarian::Posix.run!(%W[tar xzf #{target} -C #{path}])
           end
 
           def vendor_cache(name, version)
@@ -75,17 +72,15 @@ module Librarian
 
             environment.vendor!
             File.open(vendored_path(vendored_name(name), version).to_s, 'wb') do |f|
-              begin
-                debug { "Downloading <#{url}> to <#{f.path}>" }
-                URI.open(url,
-                  "User-Agent" => "librarian-puppet v#{Librarian::Puppet::VERSION}") do |res|
-                  while buffer = res.read(8192)
-                    f.write(buffer)
-                  end
+              debug { "Downloading <#{url}> to <#{f.path}>" }
+              URI.open(url,
+                       'User-Agent' => "librarian-puppet v#{Librarian::Puppet::VERSION}") do |res|
+                while buffer = res.read(8192)
+                  f.write(buffer)
                 end
-              rescue OpenURI::HTTPError => e
-                raise e, "Error requesting <#{url}>: #{e.to_s}"
               end
+            rescue OpenURI::HTTPError => e
+              raise e, "Error requesting <#{url}>: #{e}"
             end
           end
 
@@ -96,37 +91,38 @@ module Librarian
           end
 
           def token_key_value
-            ENV[TOKEN_KEY]
+            ENV.fetch(TOKEN_KEY, nil)
           end
 
           def token_key_nil?
             token_key_value.nil? || token_key_value.empty?
           end
 
-          def add_api_token_to_url url
+          def add_api_token_to_url(url)
             if token_key_nil?
               debug { "#{TOKEN_KEY} environment value is empty or missing" }
-            elsif url.include? "?"
-              url << "&access_token=#{ENV[TOKEN_KEY]}"
+            elsif url.include? '?'
+              url << "&access_token=#{ENV.fetch(TOKEN_KEY, nil)}"
             else
-              url << "?access_token=#{ENV[TOKEN_KEY]}"
+              url << "?access_token=#{ENV.fetch(TOKEN_KEY, nil)}"
             end
             url
           end
 
-        private
+          private
 
           def api_call(path)
             tags = []
             url = "https://api.github.com#{path}?page=1&per_page=100"
-            while true do
+            while true
               debug { "  Module #{name} getting tags at: #{url}" }
               add_api_token_to_url(url)
-              response = http_get(url, :headers => {
-                "User-Agent" => "librarian-puppet v#{Librarian::Puppet::VERSION}"
-              })
+              response = http_get(url, headers: {
+                                    'User-Agent' => "librarian-puppet v#{Librarian::Puppet::VERSION}",
+                                  })
 
-              code, data = response.code.to_i, response.body
+              code = response.code.to_i
+              data = response.body
 
               if code == 200
                 tags.concat JSON.parse(data)
@@ -145,12 +141,14 @@ module Librarian
               end
 
               # next page
-              break if response["link"].nil?
-              next_link = response["link"].split(",").select{|l| l.match /rel=.*next.*/}
+              break if response['link'].nil?
+
+              next_link = response['link'].split(',').select { |l| l.match(/rel=.*next.*/) }
               break if next_link.empty?
+
               url = next_link.first.match(/<(.*)>/)[1]
             end
-            return tags
+            tags
           end
 
           def http_get(url, options)
@@ -163,7 +161,7 @@ module Librarian
           end
 
           def vendored_name(name = source.uri.to_s)
-            name.sub('/','-')
+            name.sub('/', '-')
           end
         end
       end

data/lib/librarian/puppet/source/githubtarball.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'librarian/puppet/util'
 require 'librarian/puppet/source/githubtarball/repo'
@@ -16,15 +18,13 @@ module Librarian
           end
 
           def from_lock_options(environment, options)
-            new(environment, options[:remote], options.reject { |k, v| k == :remote })
+            new(environment, options[:remote], options.reject { |k, _v| k == :remote })
           end
 
           def from_spec_args(environment, uri, options)
             recognised_options = []
             unrecognised_options = options.keys - recognised_options
-            unless unrecognised_options.empty?
-              raise Error, "unrecognised options: #{unrecognised_options.join(", ")}"
-            end
+            raise Error, "unrecognised options: #{unrecognised_options.join(', ')}" unless unrecognised_options.empty?
 
             new(environment, uri, options)
           end
@@ -34,9 +34,9 @@ module Librarian
         private :environment=
         attr_reader :uri
 
-        def initialize(environment, uri, options = {})
+        def initialize(environment, uri, _options = {})
           self.environment = environment
-          @uri = URI::parse(uri)
+          @uri = URI.parse(uri)
           @cache_path = nil
         end
 
@@ -46,14 +46,14 @@ module Librarian
 
         def ==(other)
           other &&
-          self.class == other.class &&
-          self.uri == other.uri
+            self.class == other.class &&
+            uri == other.uri
         end
 
-        alias :eql? :==
+        alias eql? ==
 
         def hash
-          self.to_s.hash
+          to_s.hash
         end
 
         def to_spec_args
@@ -61,15 +61,14 @@ module Librarian
         end
 
         def to_lock_options
-          {:remote => clean_uri(uri).to_s}
+          { remote: clean_uri(uri).to_s }
         end
 
         def pinned?
           false
         end
 
-        def unpin!
-        end
+        def unpin!; end
 
         def install!(manifest)
           manifest.source == self or raise ArgumentError
@@ -92,9 +91,7 @@ module Librarian
         end
 
         def cache_path
-          @cache_path ||= begin
-            environment.cache_path.join("source/puppet/githubtarball/#{uri.host}#{uri.path}")
-          end
+          @cache_path ||= environment.cache_path.join("source/puppet/githubtarball/#{uri.host}#{uri.path}")
         end
 
         def install_path(name)
@@ -110,7 +107,7 @@ module Librarian
           end
         end
 
-        def fetch_dependencies(name, version, version_uri)
+        def fetch_dependencies(_name, _version, _version_uri)
           {}
         end
 
@@ -118,7 +115,7 @@ module Librarian
           repo(name).manifests
         end
 
-      private
+        private
 
         def repo(name)
           @repo ||= {}

data/lib/librarian/puppet/source/local.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/puppet/util'
 
 module Librarian
@@ -11,12 +13,15 @@ module Librarian
 
           debug { "Installing #{manifest}" }
 
-          name, version = manifest.name, manifest.version
+          name = manifest.name
+          _ = manifest.version
           found_path = found_path(name)
           raise Error, "Path for #{name} doesn't contain a puppet module" if found_path.nil?
 
           unless name.include? '/' or name.include? '-'
-            warn { "Invalid module name '#{name}', you should qualify it with 'ORGANIZATION-#{name}' for resolution to work correctly" }
+            warn do
+              "Invalid module name '#{name}', you should qualify it with 'ORGANIZATION-#{name}' for resolution to work correctly"
+            end
           end
 
           install_path = environment.install_path.join(module_name(name))
@@ -28,13 +33,13 @@ module Librarian
           install_perform_step_copy!(found_path, install_path)
         end
 
-        def fetch_version(name, extra)
+        def fetch_version(name, _extra)
           cache!
-          found_path = found_path(name)
+          found_path(name)
           module_version
         end
 
-        def fetch_dependencies(name, version, extra)
+        def fetch_dependencies(name, _version, _extra)
           dependencies = Set.new
 
           if specfile?
@@ -62,7 +67,7 @@ module Librarian
           if parsed_metadata['version']
             parsed_metadata['version']
           else
-            warn { "Module #{to_s} does not have version, defaulting to 0.0.1" }
+            warn { "Module #{self} does not have version, defaulting to 0.0.1" }
             '0.0.1'
           end
         end
@@ -70,14 +75,14 @@ module Librarian
         def parsed_metadata
           if @metadata.nil?
             @metadata = if metadata?
-              begin
-                JSON.parse(File.read(metadata))
-              rescue JSON::ParserError => e
-                raise Error, "Unable to parse json file #{metadata}: #{e}"
-              end
-            else
-              {}
-            end
+                          begin
+                            JSON.parse(File.read(metadata))
+                          rescue JSON::ParserError => e
+                            raise Error, "Unable to parse json file #{metadata}: #{e}"
+                          end
+                        else
+                          {}
+                        end
             @metadata['dependencies'] ||= []
           end
           @metadata
@@ -104,10 +109,11 @@ module Librarian
           cp_r(found_path, install_path)
         end
 
-        def manifest?(name, path)
+        def manifest?(_name, path)
           return true if path.join('manifests').exist?
           return true if path.join('lib').join('puppet').exist?
           return true if path.join('lib').join('facter').exist?
+
           debug { "Could not find manifests, lib/puppet or lib/facter under #{path}, maybe it is not a puppet module" }
           true
         end

data/lib/librarian/puppet/source/path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'librarian/source/path'
 require 'librarian/puppet/source/local'
 

data/lib/librarian/puppet/source/repo.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 # parent class for githubtarball and forge source Repos
 module Librarian
   module Puppet
     module Source
       class Repo
-
         attr_accessor :source, :name
         private :source=, :name=
 
@@ -31,7 +32,6 @@ module Librarian
         def vendored_path(name, version)
           environment.vendor_cache.join("#{name}-#{version}.tar.gz")
         end
-
       end
     end
   end