xcassetscop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6392c29c38a1569c9dae8edab100e6da846ecd8cf4a90ade2f0a503a26afb795
+  data.tar.gz: 2bec50f9927a83a4c9f8db12854a2fe9d8d55e10db972737b88a0bd196a10df7
+SHA512:
+  metadata.gz: 591b55b55c1ea806189506308ab39620ba8b96080dc088deaa67810499fc4add36c91059ae509cb84f4b3ea9c2cefdd3d5646cfb731194c4be07ca5735e8a61c
+  data.tar.gz: 927b59ca999b135a55238ce15001bc99f3e65d54179690bcc7a877379ecbf2a72c6cb57e0bc789ae1f838340f5b45eb8949e6da757cc29efe3707b9a85a2c8f5

data/bin/xcassetscop

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'xcassetscop'
+
+XCAssetsCop::CLI.run ARGV

data/lib/xcassetscop/cli.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'configfile_parser'
+
+module XCAssetsCop
+  module CLI
+    def self.run(args)
+      configfile_path = File.expand_path args[0]
+      unless File.file? configfile_path
+        puts "Can't find file on path: #{configfile_path}"
+        return
+      end
+      puts "Using config file at #{configfile_path}"
+
+      rules = ConfigfileParser.parse configfile_path
+      amount_of_files = rules.reduce(0) { |acc, rule| rule.paths.size + acc }
+      errors = Linter.lint_files rules
+
+      puts "#{rules.size} rules found"
+      puts "#{amount_of_files} files checked"
+      if errors.size.positive?
+        puts "Found #{errors.size} offenses:"
+        puts errors
+      else
+        puts 'No errors found'
+      end
+    end
+  end
+end

data/lib/xcassetscop/config_options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative './hash_extension'
+require_relative './template_rendering_intent'
+require_relative './image_scale'
+
+module XCAssetsCop
+  class ConfigOptions
+    attr_reader :file_extension, :image_scale, :same_file_and_asset_name, :template_rendering_intent
+
+    ALLOWED_KEYS = %i[
+      file_extension
+      image_scale
+      same_file_and_asset_name
+      template_rendering_intent
+    ].freeze
+
+    def initialize(obj)
+      ensure_all_keys_are_allowed obj
+      @file_extension = obj.sdig('file_extension')
+      @image_scale = obj.sdig('image_scale')
+      @same_file_and_asset_name = obj.sdig('same_file_and_asset_name') || false
+      @template_rendering_intent = obj.sdig('template_rendering_intent')
+    end
+
+    private
+
+    def ensure_all_keys_are_allowed(obj)
+      diff = obj.keys.map(&:to_sym) - ALLOWED_KEYS
+      raise StandardError, "Unexpected key#{'s' if diff.size > 1}: #{diff.map { |s| "'#{s}'" }.join(', ')}" if diff.size.positive?
+    end
+
+    def validate
+      TemplateRenderingIntent.validate @template_rendering_intent if @template_rendering_intent
+      ImageScale.validate @image_scale if @template_rendering_intent
+    end
+  end
+end

data/lib/xcassetscop/configfile_parser.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'linter_rule'
+
+module XCAssetsCop
+  module ConfigfileParser
+    def self.parse(file_path)
+      rules = YAML.load_file file_path
+      rules.map { |r| LinterRule.new(r) }
+    end
+  end
+end

data/lib/xcassetscop/hash_extension.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Hash
+  def sdig(key)
+    dig(key.to_s) || dig(key.to_sym)
+  end
+end

data/lib/xcassetscop/image_scale.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'utility'
+
+module XCAssetsCop
+  module ImageScale
+    AVAILABLE_VALUES = %i[
+      single
+      individual
+      individual_and_single
+    ].freeze
+
+    def self.validate(value)
+      Utility.validate_params(value, AVAILABLE_VALUES)
+    end
+  end
+end

data/lib/xcassetscop/linter.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative './template_rendering_intent'
+require_relative './image_scale'
+require_relative './linter_rule'
+
+module XCAssetsCop
+  module Linter
+    def self.get_file_name(contents_json)
+      contents_json&.dig('images')&.first&.dig('filename')
+    end
+
+    def self.file_name_matches_asset_name(contents_json, file_path)
+      asset_name = file_path.split('/').select { |str| str.include? '.imageset' }.first.split('.').first
+      file_name = get_file_name(contents_json)&.split('.')&.first
+      return [] if file_name == asset_name
+
+      ["Expected asset name and file name to be the same, got:\nAsset name: #{asset_name}\nFile name: #{file_name}"]
+    end
+
+    def self.validate_image_scale(contents_json, expected)
+      case contents_json&.dig('images')&.size
+      when 1
+        image_scale = :single
+      when 3
+        image_scale = :individual
+      when 4
+        image_scale = :individual_and_single
+      else
+        raise StandardError, "Couldn't figure out the image scale"
+      end
+      return [] if image_scale == expected
+
+      file_name = get_file_name contents_json
+      ["Expected #{file_name} scale to be '#{expected}', got '#{image_scale}' instead"]
+    end
+
+    def self.validate_template_rendering_intent(contents_json, expected)
+      template_rendering_intent = contents_json&.dig('properties')&.sdig('template-rendering-intent')&.to_sym || :default
+      return [] if template_rendering_intent == expected
+
+      file_name = get_file_name contents_json
+      ["Expected #{file_name} to be rendered as '#{expected}', got '#{template_rendering_intent}' instead"]
+    end
+
+    def self.validate_file_extension(contents_json, expected)
+      file_name = get_file_name(contents_json)
+      file_extension = file_name.split('.').last
+      return [] if expected.to_sym == file_extension.to_sym
+
+      ["Expected #{file_name} type to be #{expected}, got #{file_extension} instead"]
+    end
+
+    def self.lint_file(file_path, config)
+      file = File.read file_path
+      contents_json = JSON.parse file
+
+      template_rendering_intent = config.template_rendering_intent
+      image_scale = config.image_scale
+      same_file_and_asset_name = config.same_file_and_asset_name || false
+      file_extension = config.file_extension
+
+      errors = []
+
+      errors += validate_template_rendering_intent(contents_json, template_rendering_intent.to_sym) if template_rendering_intent
+      errors += validate_image_scale(contents_json, image_scale.to_sym) if image_scale
+      errors += file_name_matches_asset_name(contents_json, file_path) if same_file_and_asset_name
+      errors += validate_file_extension(contents_json, file_extension.to_sym) if file_extension
+
+      errors
+    end
+
+    def self.lint_files(rules)
+      errors = []
+      rules.each do |rule|
+        errors += rule.paths.map { |path| lint_file(path, rule.config) }.flatten
+      end
+      errors
+    end
+  end
+end

data/lib/xcassetscop/linter_rule.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative './config_options'
+
+module XCAssetsCop
+  class LinterRule
+    attr_reader :paths, :config
+
+    def initialize(obj)
+      LinterRule.ensure_no_missing_keys obj
+      LinterRule.ensure_all_keys_are_allowed obj
+      expanded_paths = obj.sdig(:paths).map { |path| File.expand_path(path) }
+      @paths = Dir.glob(expanded_paths)
+      @config = ConfigOptions.new obj.sdig(:config)
+    end
+
+    def self.ensure_no_missing_keys(obj)
+      obj_sym = obj.keys.map(&:to_sym)
+      missing_keys = []
+      missing_keys << :paths unless obj_sym.include? :paths
+      missing_keys << :config unless obj_sym.include? :config
+      raise StandardError, "Missing key#{'s' if missing_keys.size > 1}: #{missing_keys.map { |s| "'#{s}'" }.join(', ')}" if missing_keys.size.positive?
+    end
+
+    def self.ensure_all_keys_are_allowed(obj)
+      diff = obj.keys.map(&:to_sym) - %i[paths config]
+      raise StandardError, "Unexpected key#{'s' if diff.size > 1}: #{diff.map { |s| "'#{s}'" }.join(', ')}" if diff.size.positive?
+    end
+  end
+end

data/lib/xcassetscop/module.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module XCAssetsCop
+end

data/lib/xcassetscop/template_rendering_intent.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'utility'
+
+module XCAssetsCop
+  module TemplateRenderingIntent
+    AVAILABLE_VALUES = %i[
+      original
+      template
+      default
+    ].freeze
+
+    def self.validate(value)
+      Utility.validate_params(value, AVAILABLE_VALUES)
+    end
+  end
+end

data/lib/xcassetscop/utility.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module XCAssetsCop
+  module Utility
+    def self.validate_params(param, valid_params)
+      return true if valid_params.include? param
+
+      raise StandardError, "'#{param}' is not a valid parameter.\nValid parameters: #{valid_params.join(', ')}"
+    end
+  end
+end

data/lib/xcassetscop.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative './xcassetscop/cli'
+require_relative './xcassetscop/config_options'
+require_relative './xcassetscop/configfile_parser'
+require_relative './xcassetscop/image_scale'
+require_relative './xcassetscop/linter'
+require_relative './xcassetscop/linter_rule'
+require_relative './xcassetscop/module'
+require_relative './xcassetscop/template_rendering_intent'

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: xcassetscop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aleph Retamal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-11 00:00:00.000000000 Z
+dependencies: []
+description: Set rules for Xcode assets
+email: retamal.ph@gmail.com
+executables:
+- xcassetscop
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/xcassetscop
+- lib/xcassetscop.rb
+- lib/xcassetscop/cli.rb
+- lib/xcassetscop/config_options.rb
+- lib/xcassetscop/configfile_parser.rb
+- lib/xcassetscop/hash_extension.rb
+- lib/xcassetscop/image_scale.rb
+- lib/xcassetscop/linter.rb
+- lib/xcassetscop/linter_rule.rb
+- lib/xcassetscop/module.rb
+- lib/xcassetscop/template_rendering_intent.rb
+- lib/xcassetscop/utility.rb
+homepage: https://lalacode.io
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: XCAssetsCop
+test_files: []