Introduce a LicenseTemplate model and LicenseTemplateFinder helper

2 files changed, 89 insertions, 0 deletions

diff --git a/app/finders/license_template_finder.rb b/app/finders/license_template_finder.rb
new file mode 100644
index 00000000000..fad33f0eca2
--- /dev/null
+++ b/app/finders/license_template_finder.rb
@@ -0,0 +1,36 @@
+# LicenseTemplateFinder
+#
+# Used to find license templates, which may come from a variety of external
+# sources
+#
+# Arguments:
+#   popular: boolean. When set to true, only "popular" licenses are shown. When
+#            false, all licenses except popular ones are shown. When nil (the
+#            default), *all* licenses will be shown.
+class LicenseTemplateFinder
+  attr_reader :params
+
+  def initialize(params = {})
+    @params = params
+  end
+
+  def execute
+    Licensee::License.all(featured: popular_only?).map do |license|
+      LicenseTemplate.new(
+        id: license.key,
+        name: license.name,
+        nickname: license.nickname,
+        category: (license.featured? ? :Popular : :Other),
+        content: license.content,
+        url: license.url,
+        meta: license.meta
+      )
+    end
+  end
+
+  private
+
+  def popular_only?
+    params.fetch(:popular, nil)
+  end
+end
diff --git a/app/models/license_template.rb b/app/models/license_template.rb
new file mode 100644
index 00000000000..0ad75b27827
--- /dev/null
+++ b/app/models/license_template.rb
@@ -0,0 +1,53 @@
+class LicenseTemplate
+  PROJECT_TEMPLATE_REGEX =
+    %r{[\<\{\[]
+      (project|description|
+      one\sline\s.+\swhat\sit\sdoes\.) # matching the start and end is enough here
+    [\>\}\]]}xi.freeze
+  YEAR_TEMPLATE_REGEX = /[<{\[](year|yyyy)[>}\]]/i.freeze
+  FULLNAME_TEMPLATE_REGEX =
+    %r{[\<\{\[]
+      (fullname|name\sof\s(author|copyright\sowner))
+    [\>\}\]]}xi.freeze
+
+  attr_reader :id, :name, :category, :nickname, :url, :meta
+
+  alias_method :key, :id
+
+  def initialize(id:, name:, category:, content:, nickname: nil, url: nil, meta: {})
+    @id = id
+    @name = name
+    @category = category
+    @content = content
+    @nickname = nickname
+    @url = url
+    @meta = meta
+  end
+
+  def popular?
+    category == :Popular
+  end
+  alias_method :featured?, :popular?
+
+  # Returns the text of the license
+  def content
+    if @content.respond_to?(:call)
+      @content = @content.call
+    else
+      @content
+    end
+  end
+
+  # Populate placeholders in the LicenseTemplate content
+  def resolve!(project_name: nil, fullname: nil, year: Time.now.year.to_s)
+    # Ensure the string isn't shared with any other instance of LicenseTemplate
+    new_content = content.dup
+    new_content.gsub!(YEAR_TEMPLATE_REGEX, year) if year.present?
+    new_content.gsub!(PROJECT_TEMPLATE_REGEX, project_name) if project_name.present?
+    new_content.gsub!(FULLNAME_TEMPLATE_REGEX, fullname) if fullname.present?
+
+    @content = new_content
+
+    self
+  end
+end