debian-mirror-gitlab/lib/gitlab/file_detector.rb

89 lines
2.7 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
require 'set'
module Gitlab
# Module that can be used to detect if a path points to a special file such as
# a README or a CONTRIBUTING file.
module FileDetector
PATTERNS = {
2017-09-10 17:25:29 +05:30
# Project files
2020-03-13 15:44:24 +05:30
readme: /\A(#{Regexp.union(*Gitlab::MarkupHelper::PLAIN_FILENAMES).source})(\.(txt|#{Regexp.union(*Gitlab::MarkupHelper::EXTENSIONS).source}))?\z/i,
2018-03-17 18:26:18 +05:30
changelog: %r{\A(changelog|history|changes|news)[^/]*\z}i,
2018-11-20 20:47:30 +05:30
license: %r{\A((un)?licen[sc]e|copying)(\.[^/]+)?\z}i,
2018-03-17 18:26:18 +05:30
contributing: %r{\Acontributing[^/]*\z}i,
2017-08-17 22:00:37 +05:30
version: 'version',
2017-09-10 17:25:29 +05:30
avatar: /\Alogo\.(png|jpg|gif)\z/,
2018-03-17 18:26:18 +05:30
issue_template: %r{\A\.gitlab/issue_templates/[^/]+\.md\z},
merge_request_template: %r{\A\.gitlab/merge_request_templates/[^/]+\.md\z},
2019-07-31 22:56:46 +05:30
metrics_dashboard: %r{\A\.gitlab/dashboards/[^/]+\.yml\z},
2018-11-08 19:23:39 +05:30
xcode_config: %r{\A[^/]*\.(xcodeproj|xcworkspace)(/.+)?\z},
2017-09-10 17:25:29 +05:30
# Configuration files
2017-08-17 22:00:37 +05:30
gitignore: '.gitignore',
gitlab_ci: '.gitlab-ci.yml',
2018-03-17 18:26:18 +05:30
route_map: '.gitlab/route-map.yml',
2017-09-10 17:25:29 +05:30
# Dependency files
2020-03-13 15:44:24 +05:30
cargo_toml: 'Cargo.toml',
2018-03-17 18:26:18 +05:30
cartfile: %r{\ACartfile[^/]*\z},
2017-09-10 17:25:29 +05:30
composer_json: 'composer.json',
gemfile: /\A(Gemfile|gems\.rb)\z/,
gemfile_lock: 'Gemfile.lock',
2018-03-17 18:26:18 +05:30
gemspec: %r{\A[^/]*\.gemspec\z},
2017-09-10 17:25:29 +05:30
godeps_json: 'Godeps.json',
package_json: 'package.json',
podfile: 'Podfile',
2018-03-17 18:26:18 +05:30
podspec_json: %r{\A[^/]*\.podspec\.json\z},
podspec: %r{\A[^/]*\.podspec\z},
requirements_txt: %r{\A[^/]*requirements\.txt\z},
2020-01-01 13:55:28 +05:30
yarn_lock: 'yarn.lock',
# OpenAPI Specification files
2020-04-22 19:07:51 +05:30
openapi: %r{[^/]*(openapi|swagger)[^/]*\.(yaml|yml|json)\z}i
2017-08-17 22:00:37 +05:30
}.freeze
# Returns an Array of file types based on the given paths.
#
# This method can be used to check if a list of file paths (e.g. of changed
# files) involve any special files such as a README or a LICENSE file.
#
# Example:
#
# types_in_paths(%w{README.md foo/bar.txt}) # => [:readme]
def self.types_in_paths(paths)
types = Set.new
paths.each do |path|
type = type_of(path)
types << type if type
end
types.to_a
end
# Returns the type of a file path, or nil if none could be detected.
#
# Returned types are Symbols such as `:readme`, `:version`, etc.
#
# Example:
#
# type_of('README.md') # => :readme
# type_of('VERSION') # => :version
def self.type_of(path)
PATTERNS.each do |type, search|
did_match = if search.is_a?(Regexp)
2018-03-17 18:26:18 +05:30
path =~ search
2017-08-17 22:00:37 +05:30
else
2018-03-17 18:26:18 +05:30
path.casecmp(search) == 0
2017-08-17 22:00:37 +05:30
end
return type if did_match
end
nil
end
end
end