pivotal/LicenseFinder

View on GitHub
lib/license_finder/license.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

require 'license_finder/license/text'
require 'license_finder/license/template'

require 'license_finder/license/matcher'
require 'license_finder/license/header_matcher'
require 'license_finder/license/any_matcher'
require 'license_finder/license/none_matcher'

require 'license_finder/license/definitions'

module LicenseFinder
  class License
    class << self
      def all
        @all ||= Definitions.all
      end

      def find_by_name(name)
        name ||= 'unknown'
        license = all.detect { |l| l.matches_name? l.stripped_name(name) }

        if license
          license
        elsif name.include?(OrLicense.operator)
          OrLicense.new(name)
        elsif name.include?(AndLicense.operator)
          AndLicense.new(name)
        else
          Definitions.build_unrecognized(name)
        end
      end

      def find_by_text(text)
        all.detect { |l| l.matches_text? text }
      end
    end

    def initialize(settings)
      @short_name  = settings.fetch(:short_name)
      @pretty_name = settings.fetch(:pretty_name, short_name)
      @spdx_id     = settings.fetch(:spdx_id, '')
      @other_names = settings.fetch(:other_names, [])
      @url         = settings.fetch(:url)
      @matcher     = settings.fetch(:matcher) { Matcher.from_template(Template.named(short_name)) }
    end

    attr_reader :url

    def name
      pretty_name
    end

    def standard_id
      spdx_id
    end

    def stripped_name(name)
      name.sub(/^The /i, '')
    end

    def matches_name?(name)
      names.map(&:downcase).include? name.to_s.downcase
    end

    def matches_text?(text)
      matcher.matches_text?(text)
    end

    def eql?(other)
      name == other.name
    end

    def hash
      name.hash
    end

    def unrecognized_matcher?
      matcher.is_a?(NoneMatcher)
    end

    private

    attr_reader :short_name, :pretty_name, :other_names, :spdx_id, :matcher

    def names
      ([short_name, pretty_name, spdx_id] + other_names).uniq
    end
  end

  class AndLicense < License
    def self.operator
      ' AND '
    end

    def initialize(name, operator = AndLicense.operator)
      @short_name = name
      @pretty_name = name
      @url = nil
      @spdx_id = nil
      @matcher = NoneMatcher.new
      # removes heading and trailing parentesis and splits
      name = name[1..-2] if name.start_with?('(')
      names = name.split(operator)
      @sub_licenses = names.map do |sub_name|
        License.find_by_name(sub_name)
      end
    end

    attr_reader :sub_licenses
  end

  class OrLicense < AndLicense
    def self.operator
      ' OR '
    end

    def initialize(name)
      super(name, OrLicense.operator)
    end
  end
end