admiral-tools-figma 0.0.1

data/admiraltools/helper/figma/figma_client/models/domain/primitives/font.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+class Font
+  attr_accessor \
+    :font_family,
+    :font_postscript_name,
+    :font_size,
+    :font_weight,
+    :letter_spacing
+
+  def initialize(
+    font_family:,
+    font_postscript_name:,
+    font_size:,
+    font_weight:,
+    letter_spacing:
+  )
+    @font_family = font_family
+    @font_postscript_name = font_postscript_name
+    @font_size = font_size
+    @font_weight = font_weight
+    @letter_spacing = letter_spacing
+  end
+
+  def self.from_hash(hash)
+    return nil if hash.nil?
+
+    font_family = hash['font_family']
+    font_postscript_name = hash['font_postscript_name']
+    font_size = hash['font_size']
+    font_weight = hash['font_weight']
+    letter_spacing = hash['letter_spacing']
+
+    if !font_family.nil? && !font_postscript_name.nil? && !font_size.nil? && !font_weight.nil? && !letter_spacing.nil?
+      return Font.new(
+        font_family: font_family,
+        font_postscript_name: font_postscript_name,
+        font_size: font_size,
+        font_weight: font_weight,
+        letter_spacing: letter_spacing
+      )
+    end
+
+    nil
+  end
+
+  def to_hash
+    hash = {}
+    hash['font_family'] = font_family
+    hash['font_postscript_name'] = font_postscript_name
+    hash['font_size'] = font_size
+    hash['font_weight'] = font_weight
+    hash['letter_spacing'] = letter_spacing
+    hash
+  end
+end

data/admiraltools/helper/figma/figma_client/models/domain/primitives/frame_info.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+class FrameInfo
+  attr_accessor \
+    :node_id,
+    :name,
+    :background_color,
+    :page_id,
+    :page_name
+
+  def initialize(
+    node_id:,
+    name:,
+    background_color:,
+    page_id:,
+    page_name:
+  )
+    @node_id = node_id
+    @name = name
+    @background_color = background_color
+    @page_id = page_id
+    @page_name = page_name
+  end
+
+  def self.from_hash(hash)
+    return nil if hash.nil?
+
+    node_id = hash['node_id']
+    name = hash['name']
+    background_color = hash['background_color']
+    page_id = hash['page_id']
+    page_name = hash['page_name']
+    FigmaFrameInfo.new(node_id: node_id, name: name, background_color: background_color, page_id: page_id,
+                       page_name: page_name)
+  end
+
+  def to_hash
+    hash = {}
+    hash['node_id'] = node_id
+    hash['name'] = name
+    hash['background_color'] = background_color
+    hash['page_id'] = page_id
+    hash['page_name'] = page_name
+    hash
+  end
+end

data/admiraltools/helper/figma/figma_client/models/domain/primitives/image_link.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class ImageLink
+  attr_accessor :link, :scale, :image_format
+
+  def initialize(link:, scale:, image_format:)
+    @link = link
+    @scale = scale
+    @image_format = image_format
+  end
+
+  def self.from_hash(hash)
+    return nil if hash.nil?
+
+    scale = hash['scale']
+    link = hash['link']
+    image_format = hash['image_format']
+
+    if !scale.nil? && !link.nil? && !image_format.nil?
+      return ImageLink.new(scale: scale, link: link, image_format: image_format)
+    end
+
+    nil
+  end
+
+  def to_hash
+    hash = {}
+    hash['scale'] = scale
+    hash['link'] = link
+    hash['image_format'] = image_format
+    hash
+  end
+end

data/admiraltools/helper/figma/figma_client/models/domain/primitives/style.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+class StyleNameInfo
+  attr_accessor :full_name, :group_name, :style_name
+
+  def initialize(
+    full_name:,
+    group_name:,
+    style_name:
+  )
+    @full_name = full_name
+    @group_name = group_name
+    @style_name = style_name
+  end
+
+  def self.create_from(name:)
+    name ||= ''
+    full_name = name
+    name_array = name.split('/')
+
+    if name_array.count > 1
+      group_name = name_array[0]
+      name_array.shift
+      style_name = name_array.join('/')
+    else
+      group_name = 'Default'
+      style_name = name_array[0] || 'unknown'
+    end
+
+    StyleNameInfo.new(
+      full_name: full_name,
+      group_name: group_name,
+      style_name: style_name
+    )
+  end
+
+  def to_hash
+    hash = {}
+    hash['full_name'] = full_name
+    hash['group_name'] = group_name
+    hash['style_name'] = style_name
+    hash
+  end
+end
+
+class Style
+  attr_accessor :name, :node_id, :style_type, :description, :color, :font
+
+  def description_params
+    JSON.parse(description)
+  rescue StandardError
+    nil
+  end
+
+  def initialize(
+    name:,
+    node_id:,
+    style_type:,
+    description:,
+    color: nil,
+    font: nil
+  )
+    @name = name
+    @node_id = node_id
+    @style_type = style_type
+    @description = description
+    @color = color
+    @font = font
+  end
+
+  def name_info
+    StyleNameInfo.create_from(name: name)
+  end
+
+  def is_dark
+    name.downcase.include?('dark') || false
+  end
+
+  def self.from_hash(hash)
+    return nil if hash.nil?
+
+    name = hash['name']
+    node_id = hash['node_id']
+    style_type = hash['style_type']
+    description = hash['description']
+    color_hash = hash['color']
+    font_hash = hash['font']
+
+    color = !color_hash.nil? ? Color.from_hash(color_hash) : nil
+    font = !font_hash.nil? ? Font.from_hash(font_hash) : nil
+
+    if !name.nil? && !node_id.nil? && style_type
+      return Style.new(name: name, node_id: node_id, style_type: style_type, description: description,
+                       color: color, font: font)
+    end
+
+    nil
+  end
+
+  def to_hash
+    hash = {}
+    hash['name'] = name
+    hash['node_id'] = node_id
+    hash['style_type'] = style_type
+    hash['description'] = description
+    hash['color'] = color&.to_hash unless color.nil?
+    hash['font'] = font&.to_hash unless font.nil?
+    hash['name_info'] = name_info.to_hash unless name_info.nil?
+    hash['description_params'] = description_params unless description_params.nil?
+    hash['is_dark'] = is_dark
+    hash
+  end
+end

data/admiraltools/helper/figma/figma_client/models/domain/primitives/styles_group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class StylesGroup
+  attr_accessor :name, :styles
+
+  def initialize(name:, styles:)
+    @name = name
+    @styles = styles
+  end
+
+  def is_dark
+    name.downcase.include?('dark') || false
+  end
+
+  def to_hash
+    hash = {}
+    hash['name'] = name
+    hash['styles'] = styles&.map { |s| s.to_hash }
+    hash['is_dark'] = is_dark
+    hash
+  end
+end

data/admiraltools/helper/figma/figma_client/models/domain/primitives/styles_list.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'style'
+
+class StylesList
+  attr_accessor :styles
+
+  def initialize(styles:)
+    @styles = styles
+  end
+
+  def self.from_hash(hash)
+    hash.map { |s| Style.from_hash(s) }
+  end
+
+  def to_hash
+    styles.map(&:to_hash)
+  end
+
+  def self.from_json(json)
+    styles = (JSON.parse(json) || []).map { |s| Style.from_hash(s) }
+    StylesList.new(styles: styles)
+  end
+
+  def to_json(*_args)
+    styles.map(&:to_hash).to_json
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'api/primitives/figma_color'
+require_relative 'api/primitives/figma_component'
+require_relative 'api/primitives/figma_components_styles_meta'
+require_relative 'api/primitives/figma_node'
+require_relative 'api/primitives/figma_paint'
+require_relative 'api/primitives/figma_style'
+require_relative 'api/primitives/figma_type_style'
+require_relative 'api/primitives/figma_color'
+
+require_relative 'api/results/figma_components_styles_result'
+require_relative 'api/results/figma_images_result'
+require_relative 'api/results/figma_nodes_result'
+
+require_relative 'domain/primitives/color'
+require_relative 'domain/primitives/component'
+require_relative 'domain/primitives/components_list'
+require_relative 'domain/primitives/font'
+require_relative 'domain/primitives/image_link'
+require_relative 'domain/primitives/style'
+require_relative 'domain/primitives/styles_group'
+require_relative 'domain/primitives/styles_list'
+
+require_relative 'domain/converters/figma_to_domain_converter'

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative 'models/models'
+require_relative 'generators/generators'
+require_relative 'helpers/progress_tasks_logger'
+
+class FigmaImageDownloader
+  OUTPUT_FORMAT_RAW = 'raw'
+  OUTPUT_FORMAT_RES = 'res'
+  OUTPUT_FORMAT_XCASSETS = 'xcassets'
+  OUTPUT_FORMAT_XCASSETS_SYMOBLS = 'xcassets-symbols'
+
+  XCASSETS_TEMPLATE_RENDERING_INTENT_ORIGINAL = 'original'
+  XCASSETS_TEMPLATE_RENDERING_INTENT_TEMPLATE = 'template'
+
+  def download_images(params:)
+    generator = generator(params: params)
+
+    image_set_refs = params.image_components.map { |c| generator.create_image_sets(image_component: c) }
+    total_count = image_set_refs.map(&:image_refs).flatten.length
+
+    logger = ProgressTasksLogger.new(total_count: total_count)
+    puts("Start downloading #{total_count}")
+    generator.start_download(image_sets: image_set_refs)
+    image_set_refs.each do |image_set|
+      puts("Image set: #{image_set.name}")
+      generator.image_set_start_download(image_set: image_set)
+      image_set.image_refs.each do |image|
+        generator.image_start_download(image: image)
+        download_task(task: image, output_folder: params.output_folder)
+        logger.increment
+        puts("#{logger.progress_string} #{image.path} #{image.image_link.link}")
+        generator.image_end_download(image: image)
+      end
+      generator.image_set_end_download(image_set: image_set)
+    end
+    puts("\nDownloading complete! #{logger.progress_string}")
+    generator.end_download(image_sets: image_set_refs)
+  end
+
+  private
+
+  def generator(params:)
+    case params.output_format
+    when OUTPUT_FORMAT_RAW
+      FolderGeneratorRaw.new(params: params)
+    when OUTPUT_FORMAT_RES
+      FolderGeneratorRes.new(params: params)
+    when OUTPUT_FORMAT_XCASSETS
+      FolderGeneratorXcassets.new(params: params, symbols: false)
+    when OUTPUT_FORMAT_XCASSETS_SYMOBLS
+      FolderGeneratorXcassets.new(params: params, symbols: true)
+    else
+      raise 'Unknown output format'
+    end
+  end
+
+  def download_task(task:, output_folder:)
+    data = open(task.image_link.link)
+    path = File.join(output_folder, task.path)
+    file = File.open_file(file_name: path, mode: 'w', create_directories: true)
+    file.write(data.read)
+    file.close
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class FolderGenerator
+  attr_accessor :params
+
+  def initialize(params:)
+    @params = params
+  end
+
+  def start_download(image_sets:); end
+
+  def end_download(image_sets:); end
+
+  def create_image_sets(image_component:); end
+
+  def image_set_start_download(image_set:); end
+
+  def image_set_end_download(image_set:); end
+
+  def image_start_download(image:); end
+
+  def image_end_download(image:); end
+
+  def format_name(image_component:)
+    formatter = ImageNameFormatter.new
+    page_name = params.include_page_name ? image_component.containing_frame.page_name : nil
+    frame_name = params.include_frame_name ? image_component.containing_frame.name : nil
+
+    formatter.separate(
+      name: image_component.name,
+      page_name: page_name,
+      frame_name: frame_name,
+      naming_style: params.naming_style,
+      folder_depth: params.folder_depth
+    )
+  end
+
+  def image_path(group_name:, image_link:, single_scale:)
+    formatter = ImageNameFormatter.new
+    formatter.image_path(
+      group_name: group_name,
+      image_link: image_link,
+      single_scale: single_scale,
+      convert_to_dpi: params.convert_scales_to_dpi
+    )
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'folder_generator'
+require_relative '../helpers/scale_formatter'
+require_relative '../helpers/image_name_formatter'
+require_relative '../models/image_set_ref'
+
+class FolderGeneratorRaw < FolderGenerator
+  def create_image_sets(image_component:)
+    name_components = format_name(image_component: image_component)
+    name = name_components.name
+    folder = name_components.folder
+
+    image_links = image_component.image_links
+    single_scale = image_component.single_scale?
+
+    image_refs = image_links.map do |i|
+      file_name = image_path(group_name: name, image_link: i, single_scale: single_scale)
+      item_path = File.join(folder, file_name)
+      ImageRef.new(path: item_path, image_link: i)
+    end
+
+    ImageSetRef.new(name: name, folder: folder, image_refs: image_refs, single_scale: single_scale)
+  end
+
+  def image_end_download(image:)
+    return unless params.convert_svg_to_vector
+
+    input_file = File.join(params.output_folder, image.path)
+    SvtToVectorConverter.new.convert(input_file: input_file)
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'folder_generator'
+require_relative '../helpers/scale_formatter'
+require_relative '../helpers/image_name_formatter'
+require_relative '../models/image_set_ref'
+
+class FolderGeneratorRes < FolderGenerator
+  def create_image_sets(image_component:)
+    name_components = format_name(image_component: image_component)
+    name = name_components.name
+    folder = name_components.folder
+
+    image_links = image_component.image_links
+    single_scale = image_component.single_scale?
+
+    image_refs = image_links.map do |i|
+      file_name = "#{name}.#{i.image_format}"
+      scale_folder = folder_for_scale(scale: i.scale, single_scale: single_scale)
+      item_path = File.join(folder, scale_folder, file_name)
+      ImageRef.new(path: item_path, image_link: i)
+    end
+
+    ImageSetRef.new(name: name, folder: folder, image_refs: image_refs, single_scale: single_scale)
+  end
+
+  def folder_for_scale(scale:, single_scale:)
+    dpi = ScaleFormatter.new.dpi_from_scale(scale)
+    !single_scale && !dpi.nil? ? "drawable-#{dpi}" : 'drawable'
+  end
+
+  def image_end_download(image:)
+    return unless params.convert_svg_to_vector
+
+    input_file = File.join(params.output_folder, image.path)
+    SvtToVectorConverter.new.convert(input_file: input_file)
+  end
+end

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

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'folder_generator'
+require_relative '../../helpers/hash_access'
+require_relative '../helpers/scale_formatter'
+require_relative '../helpers/image_name_formatter'
+require_relative '../models/image_set_ref'
+
+class FolderGeneratorXcassets < FolderGenerator
+
+  attr_accessor :symbols
+
+  def initialize(symbols:, params:)
+    @symbols = symbols
+    super(params: params)
+  end
+
+  def start_download(image_sets:)
+    create_root_content_json(folder: params.output_folder)
+  end
+
+  def image_set_start_download(image_set:)
+    create_recursive_asset_contnet_json(folder: image_set.folder)
+
+    if symbols
+      create_symbolset_content_json(image_set: image_set)
+    else
+      create_imageset_content_json(image_set: image_set)
+    end
+  end
+
+  def image_end_download(image:)
+    return unless params.convert_svg_to_vector
+
+    input_file = File.join(params.output_folder, image.path)
+    SvtToVectorConverter.new.convert(input_file: input_file)
+  end
+
+  def create_image_sets(image_component:)
+    name_components = format_name(image_component: image_component)
+    name = name_components.name
+    extension = symbols ? 'symbolset' : 'imageset'
+    folder = File.join(name_components.folder, "#{name}.#{extension}")
+
+    image_links = image_component.image_links
+    single_scale = image_component.single_scale?
+
+    image_refs = image_links.map do |i|
+      file_name = image_path(group_name: name, image_link: i, single_scale: single_scale)
+      item_path = File.join(folder, file_name)
+      ImageRef.new(path: item_path, image_link: i)
+    end
+
+    ImageSetRef.new(name: name, folder: folder, image_refs: image_refs, single_scale: single_scale)
+  end
+
+  private
+
+  def create_root_content_json(folder:)
+    file_path = File.join(folder, 'Contents.json')
+    return if File.exist?(file_path)
+
+    content = content_template
+    File.write_file_json(path: file_path, hash: content)
+  end
+
+  def create_recursive_asset_contnet_json(folder:)
+    folder_root = params.output_folder
+
+    folders = folder.split('/')[0...-1].map do |f|
+      folder_root = File.join(folder_root, f)
+      folder_root
+    end
+
+    folders.each { |f| create_asset_contnet_json(folder: f) }
+  end
+
+  def add_content_property(content:, key:, value:)
+    if content.dig('properties', key).nil? && !value.nil?
+    properties = content['properties'] || {}
+    properties[key] = value
+    content['properties'] = properties
+    end
+  end
+
+  def create_asset_contnet_json(folder:)
+    file_path = File.join(folder, 'Contents.json')
+    content = File.read_file_json(path: file_path) || content_template
+    xcassets_params = params.xcassets_params || {}
+    provides_namespace = xcassets_params[:provides_namespace]
+
+    add_content_property(content: content, key: 'provides-namespace', value: provides_namespace)
+
+    File.write_file_json(path: file_path, hash: content)
+  end
+
+  def content_template
+    content = {}
+    content['info'] = {}
+    content['info']['version'] = 1
+    content['info']['author'] = 'xcode'
+    content
+  end
+
+  def create_symbolset_content_json(image_set:)
+    image_refs = image_set&.image_refs || []
+
+    if image_refs.empty?
+      return
+    end
+
+    folder = File.join(params.output_folder, image_set.folder)
+    file_path = File.join(folder, 'Contents.json')
+    content = File.read_file_json(path: file_path) || content_template
+    symbols = content['symbols'] || []
+
+    ref = image_refs[0]
+    filename = File.basename(ref.path)
+
+    symbol = symbols.first || {}
+    symbol['filename'] = filename
+    symbol['idiom'] = 'universal' if symbol['idiom'].nil?
+
+    symbols = [symbol]
+    content['symbols'] = symbols
+
+    xcassets_params = params.xcassets_params || {}
+    language_direction = xcassets_params[:language_direction]
+    add_content_property(content: content, key: 'language-direction', value: language_direction)
+
+    File.write_file_json(path: file_path, hash: content)
+  end
+
+  def create_imageset_content_json(image_set:)
+    folder = File.join(params.output_folder, image_set.folder)
+    file_path = File.join(folder, 'Contents.json')
+    content = File.read_file_json(path: file_path) || content_template
+    images = content['images'] || []
+
+    image_set&.image_refs&.each do |task|
+      filename = File.basename(task.path)
+      image_names = images.map { |i| i['filename'] }.compact
+      image_index = image_names.find_index(filename)
+
+      if image_index.nil?
+        images.push({})
+        image_index = images.length - 1
+      end
+
+      image = images[image_index]
+
+      image['filename'] = filename
+      image['idiom'] = 'universal' if image['idiom'].nil?
+
+      scale = task.image_link.scale
+      scale_enabled = !scale.nil? && !image_set.single_scale
+
+      if scale_enabled
+        image['scale'] = ScaleFormatter.new.formatted_scale(scale: scale)
+      else
+        image.delete('scale')
+      end
+    end
+
+    content['images'] = images
+    xcassets_params = params.xcassets_params || {}
+    template_rendering_intent = xcassets_params[:template_rendering_intent]
+    preserves_vector_representation = xcassets_params[:preserves_vector_representation]
+
+    add_content_property(content: content, key: 'template-rendering-intent', value: template_rendering_intent)
+    add_content_property(content: content, key: 'preserves-vector-representation', value: preserves_vector_representation)
+
+    File.write_file_json(path: file_path, hash: content)
+  end
+
+end
+
+
+