admiral-tools-figma 0.0.1

data/admiraltools/helper/figma/figma_image_downloader/generators/generators.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'folder_generator'
+require_relative 'folder_generator_raw'
+require_relative 'folder_generator_res'
+require_relative 'folder_generator_xcassets'

data/admiraltools/helper/figma/figma_image_downloader/helpers/image_name_formatter.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative '../models/image_name_components'
+require_relative '../../helpers/string_format'
+
+class ImageNameFormatter
+  def separate(name:, naming_style:, folder_depth:, page_name: nil, frame_name: nil)
+    name = File.join([page_name, frame_name, name].compact)
+    full_name = format_path(name)
+    path_components = slice_name(name: full_name, folder_depth: folder_depth)
+    name = format_name(name: path_components.name, naming_style: naming_style)
+    folder = format_folder(folder: path_components.folder, naming_style: naming_style)
+    ImageNameComponents.new(name: name, folder: folder)
+  end
+
+  def image_path(group_name:, image_link:, single_scale:, convert_to_dpi: false)
+    if single_scale
+      "#{group_name}.#{image_link.image_format}"
+    else
+      scale = ScaleFormatter.new.formatted_scale(scale: image_link.scale, convert_to_dpi: convert_to_dpi)
+      "#{group_name}@#{scale}.#{image_link.image_format}"
+    end
+  end
+
+  private
+
+  def format_name(name:, naming_style:)
+    format_string(string: name, naming_style: naming_style).lowercase_first_letter
+  end
+
+  def format_folder(folder:, naming_style:)
+    folder.split('/').map { |f| format_string(string: f, naming_style: naming_style) }.join('/')
+  end
+
+  def format_string(string:, naming_style:)
+    string ||= ''
+    case naming_style
+    when String::FORMAT_STYLE_CAMELCASE
+      string.camelcase('-', '_', ' ', '/')
+    when String::FORMAT_STYLE_SNAKECASE
+      string.snakecase
+    when String::FORMAT_STYLE_KEBABCASE
+      string.kebabcase
+    else
+      string
+    end
+  end
+
+  def slice_name(name:, folder_depth:)
+    path_components = (name || '').split('/') || []
+    max_index = max(path_components.length - 1, 0)
+    folder_depth = folder_depth.negative? ? max_index : folder_depth
+    max_depth = max(folder_depth, 0)
+
+    folder = path_components[0, max_depth].join('/') || ''
+    name = path_components[max_depth..max_index].join('/') || ''
+
+    ImageNameComponents.new(name: name, folder: folder)
+  end
+
+  def format_path(path)
+    path.split('/').map(&:strip).join('/')
+  end
+
+  def min(a, b)
+    [a, b].min
+  end
+
+  def max(a, b)
+    [a, b].max
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/helpers/progress_tasks_logger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class ProgressTasksLogger
+  attr_accessor :total_count, :current_count
+
+  def initialize(total_count:)
+    @total_count = total_count
+    @current_count = 0
+  end
+
+  def reset
+    self.current_count = 0
+  end
+
+  def increment(value: 1)
+    self.current_count += value
+  end
+
+  def progress_string
+    "(#{current_count}/#{total_count})"
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/helpers/scale_formatter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+class ScaleFormatter
+  def scales_from_dpis(dpis)
+    return [] if dpis.nil?
+
+    dpis.map { |d| scale_from_dpi(d) }.compact
+  end
+
+  def dpis_from_scales(scales)
+    return [] if scales.nil?
+
+    scales.map { |s| dpi_from_scale(s) }.compact
+  end
+
+  def any_scales_to_scales(scales)
+    return [] if scales.nil?
+
+    result_scales = []
+    scales.each do |scale|
+      case scale
+      when String
+        converted_scale = scale_from_dpi(scale)
+        if !converted_scale.nil?
+          result_scales.push(converted_scale)
+        else
+          float_scale = scale.to_f
+          result_scales.push(float_scale) unless float_scale.nil?
+        end
+      when Numeric
+        result_scales.push(scale)
+      else
+        next
+      end
+    end
+    result_scales.uniq
+  end
+
+  def scale_from_dpi(dpi)
+    dpi = dpi.downcase
+    case dpi
+    when 'ldpi'
+      0.75
+    when 'mdpi'
+      1.0
+    when 'hdpi'
+      1.5
+    when 'xhdpi'
+      2.0
+    when 'xxhdpi'
+      3.0
+    when 'xxxhdpi'
+      4.0
+    else
+      nil
+    end
+  end
+
+  def dpi_from_scale(scale)
+    scale = scale.round(2)
+    case scale
+    when 0.75
+      'ldpi'
+    when 1.0
+      'mdpi'
+    when 1.5
+      'hdpi'
+    when 2.0
+      'xhdpi'
+    when 3.0
+      'xxhdpi'
+    when 4.0
+      'xxxhdpi'
+    else
+      nil
+    end
+  end
+
+  def formatted_scale(scale:, convert_to_dpi: false)
+    return nil if scale.nil?
+
+    dpi_scale = dpi_from_scale(scale)
+
+    if convert_to_dpi && !dpi_scale.nil?
+      dpi_scale
+    else
+      "#{scale.to_s_formatted.gsub(/[.,]/, '_')}x"
+    end
+  end
+end
+
+class Numeric
+  def to_s_formatted
+    to_s.chomp('.0')
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/helpers/svg_to_vector_converter.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class SvtToVectorConverter
+  def convert(input_file:, output_file: nil)
+    return unless ['.svg'].include?(File.extname(input_file))
+
+    name = File.join(File.dirname(input_file), File.basename(input_file, File.extname(input_file)))
+    output_file = output_file.nil? ? "#{name}.xml" : output_file
+    jar_file = File.join(File.dirname(__FILE__), '../bin/svg2vectordrawable.jar')
+    system("java -jar #{jar_file} #{input_file} #{output_file} true")
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/models/download_image_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class DownloadImageParams
+  attr_accessor :image_components, :output_folder, :folder_depth, :output_format, :naming_style,
+                :xcassets_params, :convert_svg_to_vector, :convert_scales_to_dpi, 
+                :include_page_name, :include_frame_name
+
+  def initialize(
+    image_components:,
+    output_folder:,
+    folder_depth:,
+    output_format:,
+    naming_style:,
+    xcassets_params:,
+    convert_svg_to_vector:,
+    convert_scales_to_dpi:,
+    include_page_name:,
+    include_frame_name:
+  )
+    @image_components = image_components
+    @output_folder = output_folder
+    @folder_depth = folder_depth
+    @output_format = output_format
+    @naming_style = naming_style
+    @xcassets_params = xcassets_params
+    @convert_svg_to_vector = convert_svg_to_vector
+    @convert_scales_to_dpi = convert_scales_to_dpi
+    @include_page_name = include_page_name
+    @include_frame_name = include_frame_name
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/models/image_name_components.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class ImageNameComponents
+  attr_accessor :name, :folder
+
+  def initialize(name:, folder:)
+    @name = name
+    @folder = folder
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/models/image_ref.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/scale_formatter'
+
+class ImageRef
+  attr_accessor :path, :image_link
+
+  def initialize(path:, image_link:)
+    @path = path
+    @image_link = image_link
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/models/image_set_ref.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'image_ref'
+
+class ImageSetRef
+  attr_accessor :name, :folder, :image_refs, :single_scale
+
+  def initialize(name:, folder:, image_refs:, single_scale:)
+    @name = name || ''
+    @folder = folder || ''
+    @image_refs = image_refs || []
+    @single_scale = single_scale
+  end
+end

data/admiraltools/helper/figma/figma_image_downloader/models/models.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'image_ref'
+require_relative 'image_set_ref'
+require_relative 'download_image_params'

data/admiraltools/helper/figma/figma_template_generator/figma_template_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'models/styles_template'
+
+class FigmaTemplateGenerator
+  def generate(styles:, style_types:, template_path:, output_path:)
+    require 'liquid'
+    Liquid::Template.register_filter(StringFilters)
+
+    styles = styles.select { |s| (style_types.nil? || style_types.include?(s.style_type)) }
+    template_data = StylesTemplate.new(styles: styles).to_hash
+
+    dir_name = File.dirname(output_path)
+    FileUtils.mkdir_p(dir_name) unless File.directory?(dir_name)
+
+    template = File.read(template_path)
+    output = Liquid::Template.parse(template).render(template_data)
+    output_file = File.open(output_path, 'w')
+    output_file.write(output)
+    output_file.close unless output.nil?
+  end
+end

data/admiraltools/helper/figma/figma_template_generator/models/styles_template.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative '../../figma_client/figma_client'
+
+class StylesTemplate
+  attr_accessor :groups, :styles, :common_style_names
+
+  def initialize(styles:)
+    styles = styles.sort_by(&:name)
+    @styles = styles
+
+    groups_hash = {}
+
+    styles.each do |s|
+      group = groups_hash[s.name_info.group_name] || StylesGroup.new(name: s.name_info.group_name, styles: [])
+      group.styles.push(s)
+      groups_hash[s.name_info.group_name] = group
+    end
+
+    @groups = groups_hash.map { |_key, value| value }
+
+    @common_style_names = styles
+                          .uniq { |s| s.name_info.style_name }
+                          .map { |s| s.name_info.style_name }
+  end
+
+  def to_hash
+    hash = {}
+    hash['styles'] = styles.map(&:to_hash)
+    hash['groups'] = groups.map(&:to_hash)
+    hash['common_style_names'] = common_style_names
+    hash
+  end
+end

data/admiraltools/helper/figma/helpers/file_folder.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+class File
+  def self.open_file(file_name:, mode:, create_directories:)
+    create_directories = !create_directories.nil? || false
+    if create_directories
+      dirname = File.dirname(file_name)
+      FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+    end
+    File.open(file_name, mode)
+  end
+
+  def self.read_file_json(path:)
+    if File.exist?(path)
+      text = File.read(path)
+      JSON.parse(text)
+    else
+      nil
+    end
+  end
+
+  def self.write_file_json(hash:, path:, create_directories: true)
+    file = File.open_file(file_name: path, mode: 'w', create_directories: create_directories)
+    json = JSON.pretty_generate(hash)
+    file.write(json)
+    file.close
+  end
+end

data/admiraltools/helper/figma/helpers/hash_access.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Hash
+  def dig_set(keys, value, force = false, delete_if_nil = true)
+    final_key = keys.pop
+    position = self
+    keys.each do |key|
+      position[key] = {} if !position[key].is_a?(Hash) && force
+      position = position[key]
+      break if position.nil?
+    end
+    if delete_if_nil && value.nil?
+      position&.delete(final_key)
+    else
+      position[final_key] = value
+    end
+  end
+end

data/admiraltools/helper/figma/helpers/string_filters.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative 'string_format'
+
+module StringFilters
+  # Letter case
+
+  def uppercase_first_letter(input)
+    input.uppercase_first_letter
+  end
+
+  def lowercase_first_letter(input)
+    input.lowercase_first_letter
+  end
+
+  # Snake case
+
+  def snakecase(input)
+    input.snakecase
+  end
+
+  def upper_snakecase(input)
+    input.snakecase.uppercase_first_letter
+  end
+
+  def lower_snakecase(input)
+    input.snakecase.lowercase_first_letter
+  end
+
+  # Kebab case
+
+  def kebabcase(input)
+    input.kebabcase
+  end
+
+  def upper_kebabcase(input)
+    input.kebabcase.uppercase_first_letter
+  end
+
+  def lower_kebabcase(input)
+    input.kebabcase.lowercase_first_letter
+  end
+
+  # Camel case
+
+  def camelcase_s(input, *separators)
+    input.camelcase(separators)
+  end
+
+  def upper_camelcase(input, *separators)
+    input.camelcase(separators)
+  end
+
+  def lower_camelcase(input, *separators)
+    input.camelcase(separators)
+  end
+
+  # Formatting
+
+  def default_format(input)
+    input.default_format
+  end
+end

data/admiraltools/helper/figma/helpers/string_format.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class String
+  FORMAT_STYLE_CAMELCASE = 'camelcase'
+  FORMAT_STYLE_SNAKECASE = 'snakecase'
+  FORMAT_STYLE_KEBABCASE = 'kebabcase'
+
+  def uppercase_first_letter
+    capitalize
+  end
+
+  def lowercase_first_letter
+    return self unless length.positive?
+
+    self[0, 1].downcase + self[1..-1]
+  end
+
+  def snakecase
+    gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .gsub(/\s/, '_')
+      .gsub(/__+/, '_')
+      .downcase
+  end
+
+  def kebabcase
+    snakecase.gsub(/_/, '-')
+  end
+
+  def camelcase(*separators)
+    case separators.first
+    when Symbol, TrueClass, FalseClass, NilClass
+      first_letter = separators.shift
+    end
+
+    separators = ['_', '\s'] if separators.empty?
+
+    str = dup
+
+    separators.each do |s|
+      str = str.gsub(/(?:#{s}+)([a-zA-Z0-9])/) { Regexp.last_match(1).upcase }
+    end
+
+    case first_letter
+    when :upper, true
+      str = str.gsub(/(\A|\s)([a-z])/) { Regexp.last_match(1) + Regexp.last_match(2).upcase }
+    when :lower, false
+      str = str.gsub(/(\A|\s)([A-Z])/) { Regexp.last_match(1) + Regexp.last_match(2).downcase }
+    end
+
+    str
+  end
+
+  def default_format
+    available_symbols_regex = /[^a-zA-Z0-9_]/
+    separator_symbols = [' ', '_', '-', '/']
+    camelcase(separator_symbols).gsub(available_symbols_regex, '').lowercase_first_letter
+  end
+end

data/admiraltools/helper/system/system.rb

@@ -0,0 +1,17 @@
+def syscall(*cmd)
+  require 'open3'
+  stdout, = Open3.capture3(*cmd)
+  stdout
+end
+
+def syscall_safe(*cmd)
+  syscall(*cmd)
+rescue StandardError
+  ''
+end
+
+class String
+  def extract_by_regex(regex)
+    (regex.match(self) || [])[0]
+  end
+end

data/admiraltools/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Fastlane
+  module Admiraltools
+    VERSION = '0.0.36'
+  end
+end

data/admiraltools.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+#require 'fastlane/plugin/admiraltools/version'
+#
+module Fastlane
+  module Admiraltools
+    # Return all .rb files inside the "actions" and "helpers" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helpers}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Admiraltools.all_classes.each do |current|
+  require current
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: admiral-tools-figma
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Admiral team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-04 00:00:00.000000000 Z
+dependencies: []
+description: The tool to download figma icons
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- admiral-tools-figma.gemspec
+- admiraltools.rb
+- admiraltools/actions/figma_download_images.rb
+- admiraltools/actions/figma_generate_styles.rb
+- admiraltools/actions/figma_get_image_links.rb
+- admiraltools/actions/figma_get_styles.rb
+- admiraltools/helper/admiraltools_helper.rb
+- admiraltools/helper/figma/figma_client/figma_client.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_color.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_component.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_components_styles_meta.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_frame_info.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_node.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_paint.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_style.rb
+- admiraltools/helper/figma/figma_client/models/api/primitives/figma_type_style.rb
+- admiraltools/helper/figma/figma_client/models/api/results/figma_components_styles_result.rb
+- admiraltools/helper/figma/figma_client/models/api/results/figma_images_result.rb
+- admiraltools/helper/figma/figma_client/models/api/results/figma_nodes_result.rb
+- admiraltools/helper/figma/figma_client/models/domain/converters/figma_to_domain_converter.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/color.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/component.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/components_list.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/font.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/frame_info.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/image_link.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/style.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/styles_group.rb
+- admiraltools/helper/figma/figma_client/models/domain/primitives/styles_list.rb
+- admiraltools/helper/figma/figma_client/models/models.rb
+- admiraltools/helper/figma/figma_image_downloader/bin/svg2vectordrawable.jar
+- admiraltools/helper/figma/figma_image_downloader/figma_image_downloader.rb
+- admiraltools/helper/figma/figma_image_downloader/generators/folder_generator.rb
+- admiraltools/helper/figma/figma_image_downloader/generators/folder_generator_raw.rb
+- admiraltools/helper/figma/figma_image_downloader/generators/folder_generator_res.rb
+- admiraltools/helper/figma/figma_image_downloader/generators/folder_generator_xcassets.rb
+- admiraltools/helper/figma/figma_image_downloader/generators/generators.rb
+- admiraltools/helper/figma/figma_image_downloader/helpers/image_name_formatter.rb
+- admiraltools/helper/figma/figma_image_downloader/helpers/progress_tasks_logger.rb
+- admiraltools/helper/figma/figma_image_downloader/helpers/scale_formatter.rb
+- admiraltools/helper/figma/figma_image_downloader/helpers/svg_to_vector_converter.rb
+- admiraltools/helper/figma/figma_image_downloader/models/download_image_params.rb
+- admiraltools/helper/figma/figma_image_downloader/models/image_name_components.rb
+- admiraltools/helper/figma/figma_image_downloader/models/image_ref.rb
+- admiraltools/helper/figma/figma_image_downloader/models/image_set_ref.rb
+- admiraltools/helper/figma/figma_image_downloader/models/models.rb
+- admiraltools/helper/figma/figma_template_generator/figma_template_generator.rb
+- admiraltools/helper/figma/figma_template_generator/models/styles_template.rb
+- admiraltools/helper/figma/helpers/file_folder.rb
+- admiraltools/helper/figma/helpers/hash_access.rb
+- admiraltools/helper/figma/helpers/string_filters.rb
+- admiraltools/helper/figma/helpers/string_format.rb
+- admiraltools/helper/system/system.rb
+- admiraltools/version.rb
+homepage: https://github.com/admiral-team
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: The tool to download figma icons
+test_files: []