# frozen_string_literal: true require "pathname" module Licensed class AppConfiguration < Hash DEFAULT_CACHE_PATH = ".licenses".freeze # Returns the root for a configuration in following order of precendence: # 1. explicitly configured "root" property # 2. a found git repository root # 3. the current directory def self.root_for(configuration) configuration["root"] || Licensed::Git.repository_root || Dir.pwd end def initialize(options = {}, inherited_options = {}) super() # update order: # 1. anything inherited from root config # 2. explicitly configured app settings update(inherited_options) update(options) verify_arg "source_path" self["sources"] ||= {} self["reviewed"] ||= {} self["ignored"] ||= {} self["allowed"] ||= [] self["root"] = AppConfiguration.root_for(self) # defaults to the directory name of the source path if not set self["name"] ||= File.basename(self["source_path"]) # setting the cache path might need a valid app name self["cache_path"] = detect_cache_path(options, inherited_options) end # Returns the path to the workspace root as a Pathname. def root @root ||= Pathname.new(self["root"]) end # Returns the path to the app cache directory as a Pathname def cache_path root.join(self["cache_path"]) end # Returns the path to the app source directory as a Pathname def source_path root.join(self["source_path"]) end def pwd Pathname.pwd end # Returns an array of enabled app sources def sources @sources ||= Licensed::Sources::Source.sources .select { |source_class| enabled?(source_class.type) } .map { |source_class| source_class.new(self) } end # Returns whether a source type is enabled def enabled?(source_type) # the default is false if any sources are set to true, true otherwise default = !self["sources"].any? { |_, enabled| enabled } self["sources"].fetch(source_type, default) end # Is the given dependency reviewed? def reviewed?(dependency) Array(self["reviewed"][dependency["type"]]).include?(dependency["name"]) end # Is the given dependency ignored? def ignored?(dependency) Array(self["ignored"][dependency["type"]]).any? do |pattern| File.fnmatch?(pattern, dependency["name"], File::FNM_PATHNAME | File::FNM_CASEFOLD) end end # Is the license of the dependency allowed? def allowed?(license) Array(self["allowed"]).include?(license) end # Ignore a dependency def ignore(dependency) (self["ignored"][dependency["type"]] ||= []) << dependency["name"] end # Set a dependency as reviewed def review(dependency) (self["reviewed"][dependency["type"]] ||= []) << dependency["name"] end # Set a license as explicitly allowed def allow(license) self["allowed"] << license end private # Returns the cache path for the application based on: # 1. An explicitly set cache path for the application, if set # 2. An inherited root cache path joined with the app name # 3. The default cache path joined with the app name def detect_cache_path(options, inherited_options) return options["cache_path"] unless options["cache_path"].to_s.empty? # if cache_path and shared_cache are both set in inherited_options, # don't append the app name to the cache path cache_path = inherited_options["cache_path"] return cache_path if cache_path && inherited_options["shared_cache"] == true cache_path ||= DEFAULT_CACHE_PATH File.join(cache_path, self["name"]) end def verify_arg(property) return if self[property] raise Licensed::Configuration::LoadError, "App #{self["name"]} is missing required property #{property}" end end class Configuration DEFAULT_CONFIG_FILES = [ ".licensed.yml".freeze, ".licensed.yaml".freeze, ".licensed.json".freeze ].freeze class LoadError < StandardError; end # An array of the applications in this licensed configuration. attr_reader :apps # Loads and returns a Licensed::Configuration object from the given path. # The path can be relative or absolute, and can point at a file or directory. # If the path given is a directory, the directory will be searched for a # `config.yml` file. def self.load_from(path) config_path = Pathname.pwd.join(path) config_path = find_config(config_path) if config_path.directory? Configuration.new(parse_config(config_path)) end def initialize(options = {}) apps = options.delete("apps") || [] apps << default_options.merge(options) if apps.empty? apps = apps.flat_map { |app| self.class.expand_app_source_path(app) } @apps = apps.map { |app| AppConfiguration.new(app, options) } end private def self.expand_app_source_path(app_config) return app_config if app_config["source_path"].to_s.empty? source_path = File.expand_path(app_config["source_path"], AppConfiguration.root_for(app_config)) expanded_source_paths = Dir.glob(source_path).select { |p| File.directory?(p) } # return the original configuration if glob didn't result in multiple paths return app_config if expanded_source_paths.size <= 1 # map the expanded paths to new application configurations expanded_source_paths.map do |path| config = app_config.merge("source_path" => path) # update configured values for name and cache_path for uniqueness. # this is only needed when values are explicitly set, AppConfiguration # will handle configurations that don't have these explicitly set dir_name = File.basename(path) config["name"] = "#{config["name"]}-#{dir_name}" if config["name"] # if a cache_path is set and is not marked as shared, append the app name # to the end of the cache path to make a unique cache path for the app if config["cache_path"] && config["shared_cache"] != true config["cache_path"] = File.join(config["cache_path"], dir_name) end config end end # Find a default configuration file in the given directory. # File preference is given by the order of elements in DEFAULT_CONFIG_FILES # # Raises Licensed::Configuration::LoadError if a file isn't found def self.find_config(directory) config_file = DEFAULT_CONFIG_FILES.map { |file| directory.join(file) } .find { |file| file.exist? } config_file || raise(LoadError, "Licensed configuration not found in #{directory}") end # Parses the configuration given at `config_path` and returns the values # as a Hash # # Raises Licensed::Configuration::LoadError if the file type isn't known def self.parse_config(config_path) return {} unless config_path.file? extension = config_path.extname.downcase.delete "." config = case extension when "json" JSON.parse(File.read(config_path)) when "yml", "yaml" YAML.load_file(config_path) else raise LoadError, "Unknown file type #{extension} for #{config_path}" end expand_config_roots(config, config_path) config end # Expand any roots specified in a configuration file based on the configuration # files directory. def self.expand_config_roots(config, config_path) if config["root"] == true config["root"] = File.dirname(config_path) elsif config["root"] config["root"] = File.expand_path(config["root"], File.dirname(config_path)) end if config["apps"]&.any? config["apps"].each { |app_config| expand_config_roots(app_config, config_path) } end end def default_options # manually set a cache path without additional name { "source_path" => Dir.pwd, "cache_path" => AppConfiguration::DEFAULT_CACHE_PATH } end end end