fontist 1.5.0 → 1.7.2

data/lib/fontist/formula_template.rb

@@ -23,10 +23,23 @@ module Fontist
           formula.font_collections.each do |collection|
             provides_font_collection do
               filename collection.filename
+              source_filename collection.source_filename
 
               collection.fonts.each do |font|
-                styles = font.styles.map { |s| [s.type, s.full_name] }.to_h
-                provides_font font.name, extract_styles_from_collection: styles
+                provides_font(
+                  font.name,
+                  extract_styles_from_collection: font.styles.map do |style|
+                    {
+                      family_name: style.family_name,
+                      style: style.type,
+                      full_name: style.full_name,
+                      post_script_name: style.post_script_name,
+                      version: style.version,
+                      description: style.description,
+                      copyright: style.copyright,
+                    }
+                  end
+                )
               end
             end
           end
@@ -45,6 +58,7 @@ module Fontist
                   version: style.version,
                   description: style.description,
                   filename: style.font,
+                  source_filename: style.source_font,
                   copyright: style.copyright,
                 }
               end

data/lib/fontist/import/create_formula.rb

@@ -8,10 +8,6 @@ require_relative "formula_builder"
 module Fontist
   module Import
     class CreateFormula
-      FONT_PATTERN = /(\.ttf|\.otf)$/i.freeze
-      FONT_COLLECTION_PATTERN = /\.ttc$/i.freeze
-      LICENSE_PATTERN = /(OFL\.txt|UFL\.txt|LICENSE\.txt)$/i.freeze
-
       def initialize(url, options = {})
         @url = url
         @options = options
@@ -26,41 +22,30 @@ module Fontist
       def formula
         builder = FormulaBuilder.new
         builder.url = @url
-        builder.archive = download(@url)
-        builder.extractor = extractor(builder.archive)
+        builder.archive = archive
+        builder.extractor = extractor
         builder.options = @options
-        builder.font_files = font_files(builder.extractor)
-        builder.font_collection_files = font_collection_files(builder.extractor)
-        builder.license_text = license_texts(builder.extractor).first
+        builder.font_files = extractor.font_files
+        builder.font_collection_files = extractor.font_collection_files
+        builder.license_text = extractor.license_text
         builder.formula
       end
 
-      def download(url)
-        return url if File.exist?(url)
-
-        Fontist::Utils::Downloader.download(url, progress_bar: true).path
+      def extractor
+        @extractor ||=
+          RecursiveExtraction.new(archive,
+                                  subarchive: @options[:subarchive],
+                                  subdir: @options[:subdir])
       end
 
-      def extractor(archive)
-        RecursiveExtraction.new(archive)
+      def archive
+        @archive ||= download(@url)
       end
 
-      def font_files(extractor)
-        extractor.extract(FONT_PATTERN) do |path|
-          Otf::FontFile.new(path)
-        end
-      end
-
-      def font_collection_files(extractor)
-        extractor.extract(FONT_COLLECTION_PATTERN) do |path|
-          Files::CollectionFile.new(path)
-        end
-      end
+      def download(url)
+        return url if File.exist?(url)
 
-      def license_texts(extractor)
-        extractor.extract(LICENSE_PATTERN) do |path|
-          File.read(path)
-        end
+        Fontist::Utils::Downloader.download(url, progress_bar: true).path
       end
 
       def save(hash)

data/lib/fontist/import/files/collection_file.rb

@@ -11,10 +11,15 @@ module Fontist
         def initialize(path)
           @path = path
           @fonts = read
+          @extension = "ttc"
         end
 
         def filename
-          File.basename(@path)
+          File.basename(@path, ".*") + "." + @extension
+        end
+
+        def source_filename
+          File.basename(@path) unless filename == File.basename(@path)
         end
 
         private

data/lib/fontist/import/files/file_requirement.rb

@@ -0,0 +1,17 @@
+module Fontist
+  module Import
+    module Files
+      class FileRequirement
+        def initialize
+          `file -v`
+        rescue Errno::ENOENT
+          abort "`file` is not available. (Or is PATH not setup properly?)"
+        end
+
+        def call(path)
+          Helpers::SystemHelper.run("file --brief '#{path}'")
+        end
+      end
+    end
+  end
+end

data/lib/fontist/import/files/font_detector.rb

@@ -0,0 +1,48 @@
+require_relative "file_requirement"
+
+module Fontist
+  module Import
+    module Files
+      class FontDetector
+        REQUIREMENTS = { file: FileRequirement.new }.freeze
+
+        FONT_LABELS = ["OpenType font data",
+                       "TrueType Font data"].freeze
+
+        COLLECTION_LABEL = "TrueType font collection data".freeze
+
+        FONT_EXTENSIONS = {
+          "OpenType font data" => "otf",
+          "TrueType Font data" => "ttf",
+          "TrueType font collection data" => "ttc",
+        }.freeze
+
+        def self.detect(path)
+          brief = file_brief(path)
+
+          if brief.start_with?(*FONT_LABELS)
+            :font
+          elsif brief.start_with?(COLLECTION_LABEL)
+            :collection
+          else
+            :other
+          end
+        end
+
+        def self.standard_extension(path)
+          brief = file_brief(path)
+
+          FONT_EXTENSIONS.each do |label, extension|
+            return extension if brief.start_with?(label)
+          end
+
+          raise Errors::UnknownFontTypeError.new(path)
+        end
+
+        def self.file_brief(path)
+          REQUIREMENTS[:file].call(path)
+        end
+      end
+    end
+  end
+end

data/lib/fontist/import/formula_builder.rb

@@ -89,7 +89,7 @@ module Fontist
       def download(url)
         Fontist::Utils::Downloader.download(url, progress_bar: true).path
       rescue Errors::InvalidResourceError
-        Fontist.ui.say("WARN: a mirror is not found '#{url}'")
+        Fontist.ui.error("WARN: a mirror is not found '#{url}'")
         nil
       end
 
@@ -98,7 +98,7 @@ module Fontist
         return output.first if output.size == 1
 
         checksums = output.join(", ")
-        Fontist.ui.say("WARN: SHA256 differs (#{checksums})")
+        Fontist.ui.error("WARN: SHA256 differs (#{checksums})")
         output
       end
 
@@ -107,7 +107,10 @@ module Fontist
 
         collections = @font_collection_files.map do |file|
           fonts = fonts_from_files(file.fonts, :to_collection_style)
-          { filename: file.filename, fonts: fonts }
+
+          { filename: file.filename,
+            source_filename: file.source_filename,
+            fonts: fonts }.compact
         end
 
         collections.sort_by do |x|
@@ -147,7 +150,14 @@ module Fontist
       end
 
       def open_license
-        return unless @license_text
+        unless @license_text
+          Fontist.ui.error("WARN: please add license manually")
+          return
+        end
+
+        Fontist.ui.error("WARN: ensure it's an open license, otherwise " \
+                         "change the 'open_license' attribute to " \
+                         "'requires_license_agreement'")
 
         TextHelper.cleanup(@license_text)
       end

data/lib/fontist/import/google/skiplist.yml

@@ -4,3 +4,5 @@
 - Overpass Mono
 - Lato
 - Open Sans
+- Work Sans
+- Fira Code

data/lib/fontist/import/otf/font_file.rb

@@ -1,5 +1,6 @@
 require_relative "../otfinfo/otfinfo_requirement"
 require_relative "../text_helper"
+require_relative "../files/font_detector"
 
 module Fontist
   module Import
@@ -10,14 +11,19 @@ module Fontist
         }.freeze
 
         STYLE_ATTRIBUTES = %i[family_name type full_name post_script_name
-                              version description copyright font].freeze
-        COLLECTION_ATTRIBUTES = STYLE_ATTRIBUTES.reject { |a| a == :font }
+                              version description copyright font
+                              source_font].freeze
+
+        COLLECTION_ATTRIBUTES = STYLE_ATTRIBUTES.reject do |a|
+          %i[font source_font].include?(a)
+        end
 
         attr_reader :path
 
         def initialize(path)
           @path = path
           @info = read
+          @extension = detect_extension
         end
 
         def to_style
@@ -55,7 +61,11 @@ module Fontist
         end
 
         def font
-          File.basename(@path)
+          File.basename(@path, ".*") + "." + @extension
+        end
+
+        def source_font
+          File.basename(@path) unless font == File.basename(@path)
         end
 
         def copyright
@@ -77,12 +87,18 @@ module Fontist
         def read
           text = REQUIREMENTS[:otfinfo].call(@path)
 
-          text.split("\n")
+          text
+            .encode("UTF-8", invalid: :replace, replace: "")
+            .split("\n")
             .select { |x| x.include?(":") }
             .map { |x| x.split(":", 2) }
             .map { |x| x.map { |y| Fontist::Import::TextHelper.cleanup(y) } }
             .to_h
         end
+
+        def detect_extension
+          Files::FontDetector.standard_extension(@path)
+        end
       end
     end
   end

data/lib/fontist/import/recursive_extraction.rb

@@ -1,27 +1,40 @@
 require "find"
 require_relative "extractors"
+require_relative "files/font_detector"
 
 module Fontist
   module Import
     class RecursiveExtraction
-      BOTH_FONTS_PATTERN = "**/*.{ttf,otf,ttc}".freeze
+      FONTS_PATTERN = "**/*.{ttf,otf,ttc}".freeze
       ARCHIVE_EXTENSIONS = %w[zip msi exe cab].freeze
+      LICENSE_PATTERN = /(OFL\.txt|UFL\.txt|LICENSE\.txt|COPYING)$/i.freeze
 
-      def initialize(archive)
+      def initialize(archive, subarchive: nil, subdir: nil)
         @archive = archive
+        @subarchive = subarchive
+        @subdir = subdir
         @operations = []
+        @font_files = []
+        @collection_files = []
       end
 
       def extension
         File.extname(filename(@archive)).sub(/^\./, "")
       end
 
-      def extract(pattern)
-        Array.new.tap do |results|
-          Find.find(extracted_path) do |path| # rubocop:disable Style/CollectionMethods, Metrics/LineLength
-            results << yield(path) if path.match(pattern)
-          end
-        end
+      def font_files
+        ensure_extracted
+        @font_files
+      end
+
+      def font_collection_files
+        ensure_extracted
+        @collection_files
+      end
+
+      def license_text
+        ensure_extracted
+        @license_text
       end
 
       def operations
@@ -49,7 +62,11 @@ module Fontist
 
       def extract_recursively(archive)
         path = operate_on_archive(archive)
-        return path if fonts_exist?(path)
+        match_files(path)
+        if matched?
+          save_operation_subdir
+          return path
+        end
 
         next_archive = find_archive(path)
         extract_recursively(next_archive)
@@ -57,6 +74,8 @@ module Fontist
 
       def operate_on_archive(archive)
         extractor = choose_extractor(archive)
+        Fontist.ui.say("Extracting #{archive} with #{extractor.class.name}")
+
         save_operation(extractor)
         extractor.extract
       end
@@ -81,15 +100,80 @@ module Fontist
         @operations << { format: extractor.format }
       end
 
-      def fonts_exist?(path)
-        fonts = Dir.glob(File.join(path, BOTH_FONTS_PATTERN))
-        !fonts.empty?
+      def match_files(dir_path)
+        Find.find(dir_path) do |entry_path| # rubocop:disable Style/CollectionMethods
+          match_license(entry_path)
+          match_font(entry_path) if font_directory?(entry_path, dir_path)
+        end
+      end
+
+      def match_license(path)
+        @license_text ||= File.read(path) if license?(path)
+      end
+
+      def license?(file)
+        file.match?(LICENSE_PATTERN)
+      end
+
+      def font_directory?(path, base_path)
+        return true unless @subdir
+
+        relative_path = Pathname.new(path).relative_path_from(base_path).to_s
+        dirname = File.dirname(relative_path)
+        normalized_pattern = @subdir.chomp("/")
+        File.fnmatch?(normalized_pattern, dirname)
+      end
+
+      def match_font(path)
+        case Files::FontDetector.detect(path)
+        when :font
+          @font_files << Otf::FontFile.new(path)
+        when :collection
+          @collection_files << Files::CollectionFile.new(path)
+        end
+      end
+
+      def matched?
+        [@font_files, @collection_files].any? do |files|
+          files.size.positive?
+        end
+      end
+
+      def save_operation_subdir
+        return unless @subdir
+
+        @operations.last[:options] ||= {}
+        @operations.last[:options][:fonts_sub_dir] = @subdir
       end
 
       def find_archive(path)
-        Dir.children(path)
-          .map    { |file_name| File.join(path, file_name) }
-          .max_by { |file_path| [file_type(file_path), File.size(file_path)] }
+        paths = Dir.children(path).map { |file| File.join(path, file) }
+        by_subarchive(paths) || by_size(paths)
+      end
+
+      def by_subarchive(paths)
+        return unless @subarchive
+
+        path_found = paths.detect do |path|
+          @subarchive == File.basename(path)
+        end
+
+        return unless path_found
+
+        save_operation_subarchive(path_found)
+
+        path_found
+      end
+
+      def save_operation_subarchive(path)
+        @operations.last[:options] ||= {}
+        @operations.last[:options][:subarchive] = File.basename(path)
+      end
+
+      def by_size(paths)
+        paths.max_by do |path|
+          [file_type(path), File.size(path)]
+        end
       end
 
       def file_type(file_path)