xcassetscop 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6392c29c38a1569c9dae8edab100e6da846ecd8cf4a90ade2f0a503a26afb795
-  data.tar.gz: 2bec50f9927a83a4c9f8db12854a2fe9d8d55e10db972737b88a0bd196a10df7
+  metadata.gz: 612d8b2b930674cf4e0ebcea7e3f4b12223d5fb2f1d40cf2fea101c1808f3597
+  data.tar.gz: be3b2060014f5fdf05f38b0485b2770bfdce2936c3bdf28ee2fdf75261269442
 SHA512:
-  metadata.gz: 591b55b55c1ea806189506308ab39620ba8b96080dc088deaa67810499fc4add36c91059ae509cb84f4b3ea9c2cefdd3d5646cfb731194c4be07ca5735e8a61c
-  data.tar.gz: 927b59ca999b135a55238ce15001bc99f3e65d54179690bcc7a877379ecbf2a72c6cb57e0bc789ae1f838340f5b45eb8949e6da757cc29efe3707b9a85a2c8f5
+  metadata.gz: 5d9cb48ea22bbee17fbbff9635973430fe6825ba6c4ecdfc54202e0c278d28797c2760b19b51ec40afde06998db6751ed35911b683d5feef71c7fe16662ad548
+  data.tar.gz: b2135b6434ea185507a468e808e93b538cbb40295267bd050afcdd19cb525fe52466328380bfb70cabfb7185888f5d595df6eba27d886991cf632ee00ef4dea6

data/bin/xcassetscop

@@ -4,4 +4,4 @@
 
 require 'xcassetscop'
 
-XCAssetsCop::CLI.run ARGV
+XCAssetsCop::CLI.start ARGV

data/lib/xcassetscop.rb

@@ -8,3 +8,4 @@ require_relative './xcassetscop/linter'
 require_relative './xcassetscop/linter_rule'
 require_relative './xcassetscop/module'
 require_relative './xcassetscop/template_rendering_intent'
+require_relative './xcassetscop/version'

data/lib/xcassetscop/cli.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
 
+require 'thor'
 require_relative 'configfile_parser'
+require_relative 'version'
 
 module XCAssetsCop
-  module CLI
-    def self.run(args)
-      configfile_path = File.expand_path args[0]
+  class CLI < Thor
+    desc 'lint [CONFIG FILE]', 'lint files using the configuration file provided, looks for a xcassetscop.yml if no path is provided'
+    def lint(config_path = nil)
+      configfile_path = File.expand_path(config_path || './xcassetscop.yml')
       unless File.file? configfile_path
         puts "Can't find file on path: #{configfile_path}"
         return
@@ -25,5 +28,10 @@ module XCAssetsCop
         puts 'No errors found'
       end
     end
+
+    desc 'version', 'print version'
+    def version
+      puts Version.version
+    end
   end
 end

data/lib/xcassetscop/config_options.rb

@@ -6,21 +6,24 @@ require_relative './image_scale'
 
 module XCAssetsCop
   class ConfigOptions
-    attr_reader :file_extension, :image_scale, :same_file_and_asset_name, :template_rendering_intent
+    attr_reader :file_extension, :image_scale, :same_file_and_asset_name, :template_rendering_intent,
+                :preserves_vector_representation
 
     ALLOWED_KEYS = %i[
       file_extension
       image_scale
       same_file_and_asset_name
       template_rendering_intent
+      preserves_vector_representation
     ].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
+      @same_file_and_asset_name = obj.sdig('same_file_and_asset_name')
       @template_rendering_intent = obj.sdig('template_rendering_intent')
+      @preserves_vector_representation = obj.sdig('preserves_vector_representation')
     end
 
     private

data/lib/xcassetscop/linter.rb

@@ -11,6 +11,18 @@ module XCAssetsCop
       contents_json&.dig('images')&.first&.dig('filename')
     end
 
+    def self.get_file_extension(contents_json)
+      get_file_name(contents_json).split('.').last
+    end
+
+    def self.validate_file_extension(contents_json, expected)
+      file_extension = get_file_extension(contents_json)
+      return [] if expected.to_sym == file_extension.to_sym
+
+      file_name = get_file_name(contents_json)
+      ["Expected #{file_name} type to be #{expected}, got #{file_extension} instead"]
+    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
@@ -44,12 +56,16 @@ module XCAssetsCop
       ["Expected #{file_name} to be rendered as '#{expected}', got '#{template_rendering_intent}' instead"]
     end
 
-    def self.validate_file_extension(contents_json, expected)
+    def self.validate_preserves_vector_representation(contents_json, expected)
+      preserves_vector_representation = contents_json&.dig('properties')&.dig('preserves-vector-representation') || false
+      file_extension = get_file_extension(contents_json)
+
       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"]
+      return ["#{file_name} should be a PDF file if you want to preserve vector data"] if (file_extension.to_sym != :pdf) && expected
+      return ["Expected #{file_name} to#{' NOT' unless expected} preserve vector representation"] unless preserves_vector_representation == expected
+
+      []
     end
 
     def self.lint_file(file_path, config)
@@ -58,15 +74,17 @@ module XCAssetsCop
 
       template_rendering_intent = config.template_rendering_intent
       image_scale = config.image_scale
-      same_file_and_asset_name = config.same_file_and_asset_name || false
+      same_file_and_asset_name = config.same_file_and_asset_name
       file_extension = config.file_extension
+      preserves_vector_representation = config.preserves_vector_representation
 
       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_preserves_vector_representation(contents_json, file_path) if preserves_vector_representation
       errors += validate_file_extension(contents_json, file_extension.to_sym) if file_extension
+      errors += file_name_matches_asset_name(contents_json, file_path) if same_file_and_asset_name
 
       errors
     end

data/lib/xcassetscop/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module XCAssetsCop
+  module Version
+    STRING = '0.0.2'
+
+    def self.version
+      STRING
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcassetscop
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aleph Retamal
@@ -29,6 +29,7 @@ files:
 - lib/xcassetscop/module.rb
 - lib/xcassetscop/template_rendering_intent.rb
 - lib/xcassetscop/utility.rb
+- lib/xcassetscop/version.rb
 homepage: https://lalacode.io
 licenses:
 - MIT