class Frameit::ConfigParser

Attributes

data[R]

Public Class Methods

supported_color?(value) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 122
def self.supported_color?(value)
  return false if value.nil?
  Color.all_colors.any?(value)
end
supported_device?(value) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 132
def self.supported_device?(value)
  return !Device.find_device_by_id_or_name(value).nil?
end
supported_platform?(value) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 127
def self.supported_platform?(value)
  return false if value.nil?
  Platform.all_platforms.any?(value)
end

Public Instance Methods

change_paths_to_absolutes!(values) click to toggle source

Use absolute paths instead of relative

# File frameit/lib/frameit/config_parser.rb, line 45
def change_paths_to_absolutes!(values)
  values.each do |key, value|
    if value.kind_of?(Hash)
      change_paths_to_absolutes!(value) # recursive call
    elsif value.kind_of?(Array)
      value.each do |current|
        change_paths_to_absolutes!(current) if current.kind_of?(Hash) # recursive call
      end
    else
      if ['font', 'background'].include?(key)
        # Change the paths to relative ones
        # `replace`: to change the content of the string, so it's actually stored
        if @path # where is the config file. We don't have a config file in tests
          containing_folder = File.expand_path('..', @path)
          value.replace(File.join(containing_folder, value))
        end
      end
    end
  end
end
check_fonts(value) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 108
def check_fonts(value)
  UI.user_error!("`fonts` must be an array") unless value.kind_of?(Array)

  value.each do |current|
    UI.user_error!("You must specify a font path") if current.fetch('font', '').length == 0
    UI.user_error!("Could not find font at path '#{File.expand_path(current.fetch('font'))}'") unless File.exist?(current.fetch('font'))
    UI.user_error!("`supported` must be an array") unless current.fetch('supported', []).kind_of?(Array)
  end
end
fetch_value(path) click to toggle source

Fetches the finished configuration for a given path. This will try to look for a specific value and fallback to a default value if nothing was found

# File frameit/lib/frameit/config_parser.rb, line 28
def fetch_value(path)
  specifics = @data['data'].select { |a| path.include?(a['filter']) }

  default = @data['default']

  values = default.clone
  specifics.each do |specific|
    values = values.fastlane_deep_merge(specific)
  end

  change_paths_to_absolutes!(values)
  validate_values(values)

  values
end
integer_or_percentage(value) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 118
def integer_or_percentage(value)
  value.kind_of?(Integer) || (value.end_with?('%') && value.to_f > 0)
end
load(path) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 7
def load(path)
  return nil unless File.exist?(path) # we are okay with no config at all
  UI.verbose("Parsing config file '#{path}'")
  @path = path
  self.parse(File.read(path))
end
parse(data) click to toggle source

@param data (String) the JSON data to be parsed

# File frameit/lib/frameit/config_parser.rb, line 15
def parse(data)
  begin
    @data = JSON.parse(data)
  rescue => ex
    UI.error(ex.message)
    UI.user_error!("Invalid JSON file at path '#{@path}'. Make sure it's a valid JSON file")
  end

  self
end
validate_key(key, value) click to toggle source
# File frameit/lib/frameit/config_parser.rb, line 77
def validate_key(key, value)
  case key
  when 'font'
    UI.user_error!("Could not find font at path '#{File.expand_path(value)}'") unless File.exist?(value)
  when 'fonts'
    check_fonts(value)
  when 'background'
    UI.user_error!("Could not find background image at path '#{File.expand_path(value)}'") unless File.exist?(value)
  when 'color'
    UI.user_error!("Invalid color '#{value}'. Must be valid Hex #123123") unless value.include?("#")
  when 'padding'
    unless integer_or_percentage(value) || value.split('x').length == 2
      UI.user_error!("padding must be an integer, or pair of integers of format 'AxB', or a percentage of screen size")
    end
  when 'title_min_height'
    unless integer_or_percentage(value)
      UI.user_error!("padding must be an integer, or a percentage of screen size")
    end
  when 'show_complete_frame', 'title_below_image'
    UI.user_error!("'#{key}' must be a Boolean") unless [true, false].include?(value)
  when 'font_scale_factor'
    UI.user_error!("font_scale_factor must be numeric") unless value.kind_of?(Numeric)
  when 'frame'
    UI.user_error!("Invalid frame color '#{value}'. Frame color must be one of " + Color.all_colors.join(', ')) unless ConfigParser.supported_color?(value)
  when 'use_platform'
    UI.user_error!("Invalid platform type '#{value}'. Available values are " + Platform.all_platforms.join(', ') + ".") unless ConfigParser.supported_platform?(value)
  when 'force_device_type'
    UI.user_error!("Invalid device type '#{value}'. Available values: " + Devices.all_device_names_without_apple.join(', ')) unless ConfigParser.supported_device?(value)
  end
end
validate_values(values) click to toggle source

Make sure the paths/colors are valid

# File frameit/lib/frameit/config_parser.rb, line 67
def validate_values(values)
  values.each do |key, value|
    if value.kind_of?(Hash)
      validate_values(value) # recursive call
    else
      validate_key(key, value)
    end
  end
end