scss_lint-auto_correct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecfcbc916da720f957affb069abd0cb138469b9e
-  data.tar.gz: 681f8344e431b2ed948a72efa3446ee1b954a4ea
+  metadata.gz: fba2efff4f1df225710a78b728482a14cc8131a4
+  data.tar.gz: 12f5ab2d724a3b3127d39246d9e5441bfb130b5c
 SHA512:
-  metadata.gz: b26b98b6112520ff69a4e95547e9bb6211c5f1446481f982e8aab95d3e316281ab3be3a3315af687572cc4d488334e06d0adbdf09dc40edfcc341b283777b188
-  data.tar.gz: 4d28006157b8d380470eef8d1205f573c9840524b90dbcf44399e58aafedb4b5d39a211d613d9bc4ca242eeea6ee0e7636d9efca0903fbb16a501ca8a65b5127
+  metadata.gz: c9442a72c3feefe5d8c588510f560f031a175ae7d9c5ad2ef0795bb82f9400a0e63c52b26ca872be2607ad311129dce7cb1591793ab1e29b2682afaf5ddb2f4e
+  data.tar.gz: 8fe3ac34f4de8717ca5db69bf396f0cecaa6dbfb91ebcb08601dddaf23e3c36cf92028ad263beb5e4d4761e1a4547db681be5c81b4c82528e9ca99d09fa67cc9

data/lib/scss_lint/auto_correct/cli.rb

@@ -61,6 +61,7 @@ module SCSSLint::AutoCorrect
       puts "  --verbose, -v"
       puts "  --dry"
       puts "  --list"
+      puts "  --force  Ignore config disabling of corrector"
       puts "Only apply specific correctors, using any combination of:"
       @correctors.each do |c|
         puts "  --#{c.short_name}"
@@ -123,8 +124,9 @@ module SCSSLint::AutoCorrect
 
     def invoke_correctors(contents)
       @correctors.each do |corrector|
-        config = corrector.config_name ? @config.options['linters'].fetch(corrector.config_name) : {}
-        contents = corrector.new(config).call(contents)
+        config = corrector.linter_name ? @config.options['linters'].fetch(corrector.linter_name) : {}
+        instance = corrector.new(config)
+        contents = instance.call(contents) if instance.enabled? || option?(:force)
       end
       contents
     end

data/lib/scss_lint/auto_correct/correctors/base.rb

@@ -1,6 +1,6 @@
 module SCSSLint::AutoCorrect::Correctors
   class Base
-    def self.config_name
+    def self.linter_name
     end
 
     def self.short_name

data/lib/scss_lint/auto_correct/correctors/property_sort_order.rb

@@ -0,0 +1,53 @@
+module SCSSLint::AutoCorrect::Correctors
+  class PropertySortOrder < Base
+    def initialize(config = {})
+      super
+      @result = []
+      @buffer = []
+      @enabled = true
+      @sorter = SCSSLint::AutoCorrect::PropertySorter.new rules: @config["order"]
+    end
+
+    def call(source)
+      source.lines.each { |line| visit_line(line) }
+      flush_buffer!
+      @result.join
+    end
+
+    def visit_line(line)
+      if line =~ /scss-lint:disable.*PropertySortOrder/
+        @result << line
+        @enabled = false
+        return
+      end
+      if line =~ /scss-lint:enable.*PropertySortOrder/
+        @result << line
+        @enabled = true
+        return
+      end
+      if @enabled && @sorter.property?(line)
+        @buffer << line
+      else
+        flush_buffer!
+        @result << line
+      end
+    end
+
+    def flush_buffer!
+      @result += reduce_buffer(@buffer)
+      @buffer = []
+    end
+
+    def reduce_buffer(lines)
+      @sorter.sort_lines(lines)
+    end
+
+    def self.linter_name
+      "PropertySortOrder"
+    end
+
+    def self.description
+      "Sorts properties correctly"
+    end
+  end
+end

data/lib/scss_lint/auto_correct/correctors/shorter_versions_of_colors.rb

@@ -4,6 +4,10 @@ module SCSSLint::AutoCorrect::Correctors
       contents.gsub(/#(([A-Za-z0-9])\2){3}/) { |m| "##{m[1]}#{m[3]}#{m[5]}" }
     end
 
+    def self.linter_name
+      "HexLength"
+    end
+
     def self.description
       "Shortens hex color codes to 3 letters, when possible"
     end

data/lib/scss_lint/auto_correct/correctors/use_hex_instead_of_color_keywords.rb

@@ -22,5 +22,9 @@ module SCSSLint::AutoCorrect::Correctors
     def self.priority
       5
     end
+
+    def self.linter_name
+      "ColorKeyword"
+    end
   end
 end

data/lib/scss_lint/auto_correct/property_sorter.rb

@@ -0,0 +1,92 @@
+require "scss_lint/constants"
+
+module SCSSLint::AutoCorrect
+  class PropertySorter
+    def initialize(rules: "")
+      @rules = rules
+    end
+
+    def preferred_order
+      return @preferred_order unless @preferred_order.nil?
+      path = File.join \
+        SCSSLint::SCSS_LINT_DATA,
+        "property-sort-orders",
+        "#{@rules}.txt"
+
+      @preferred_order = []
+
+      if File.file?(path)
+        @preferred_order = File.open(path) \
+          .read
+          .split("\n")
+          .reject { |line| line =~ /^\s*#/ || line.strip == "" }
+      end
+
+      @preferred_order
+    end
+
+    def property?(line)
+      parsed = parse_line(line)
+      return false if parsed.nil?
+      !!parsed[:property]
+      # !preferred_order.index(parsed[:property]).nil?
+    end
+
+    def parse_line(line)
+      mm = line.match(/^\s*([^:]+):/)
+      full = mm[1]
+      if full[0] == "-"
+        mm2 = full.match(/^-([^-]+)-(.*)$/)
+        {
+          vendor: mm2[1],
+          property: mm2[2],
+          line: line
+        }
+      else
+        {
+          property: full,
+          line: line
+        }
+      end
+    rescue
+      nil
+    end
+
+    def compare_lines(a, b)
+      compare_properties \
+        parse_line(a),
+        parse_line(b)
+    end
+
+    def compare_properties(a, b)
+      if a[:property] == b[:property]
+        compare_by_vendor(a, b)
+      elsif preferred_order.any?
+        compare_by_order(a, b)
+      else
+        a[:property] <=> b[:property]
+      end
+    end
+
+    def compare_by_order(a, b)
+      (preferred_order.index(a[:property]) || Float::INFINITY) <=>
+        (preferred_order.index(b[:property]) || Float::INFINITY)
+    end
+
+    def compare_by_vendor(a, b)
+      if a[:vendor] && b[:vendor]
+        a[:vendor] <=> b[:vendor]
+      elsif a[:vendor]
+        -1
+      elsif b[:vendor]
+        1
+      else
+        0
+      end
+    end
+
+    def sort_lines(lines)
+      lines.sort { |a,b| compare_lines(a, b) }
+    end
+  end
+end

data/lib/scss_lint/auto_correct/version.rb

@@ -1,4 +1,4 @@
 # Defines the gem version.
 module SCSSLint::AutoCorrect
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/test/fixtures/unsorted_properties.scss

@@ -0,0 +1,4 @@
+.lorem {
+  height: 55px;
+  color: #fff;
+}

data/test/fixtures/unsorted_properties_corrected.scss

@@ -0,0 +1,4 @@
+.lorem {
+  color: #fff;
+  height: 55px;
+}

data/test/fixtures/unsorted_properties_disable_rule.scss

@@ -0,0 +1,6 @@
+.lorem {
+  # scss-lint:disable PropertySortOrder
+  color: #fff;
+  height: 55px;
+  # scss-lint:enable PropertySortOrder
+}

data/test/unit/property_sort_order_test.rb

@@ -0,0 +1,24 @@
+require_relative "../test_helper"
+
+class PropertySortOrderTest < Minitest::Test
+  describe "SCSSLint::AutoCorrect::Correctors::PropertySortOrder" do
+    let(:corrector) { SCSSLint::AutoCorrect::Correctors::PropertySortOrder }
+
+    it "basically works" do
+      corrector.new
+    end
+
+    it "process input" do
+      input = load_file "unsorted_properties.scss"
+      expected = load_file "unsorted_properties_corrected.scss"
+      output = corrector.new.call input
+      assert_equal expected, output
+    end
+
+    it "ignores blocks, when pre-processor instructions are present" do
+      input = load_file "unsorted_properties_disable_rule.scss"
+      output = corrector.new.call input
+      assert_equal input, output
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scss_lint-auto_correct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Dorian Marié
@@ -46,16 +46,22 @@ files:
 - lib/scss_lint/auto_correct/correctors/lines_end_with_semicolons.rb
 - lib/scss_lint/auto_correct/correctors/newlines_for_each_selector.rb
 - lib/scss_lint/auto_correct/correctors/no_spaces_before_semicolons.rb
+- lib/scss_lint/auto_correct/correctors/property_sort_order.rb
 - lib/scss_lint/auto_correct/correctors/short_versions_of_numbers.rb
 - lib/scss_lint/auto_correct/correctors/shorter_versions_of_colors.rb
 - lib/scss_lint/auto_correct/correctors/spacing_before_selectors.rb
 - lib/scss_lint/auto_correct/correctors/use_hex_instead_of_color_keywords.rb
 - lib/scss_lint/auto_correct/correctors/variable_names.rb
+- lib/scss_lint/auto_correct/property_sorter.rb
 - lib/scss_lint/auto_correct/version.rb
 - test/fixtures/has_uppercase_colors.scss
+- test/fixtures/unsorted_properties.scss
+- test/fixtures/unsorted_properties_corrected.scss
+- test/fixtures/unsorted_properties_disable_rule.scss
 - test/test_helper.rb
 - test/unit/cli_test.rb
 - test/unit/downcase_colors_test.rb
+- test/unit/property_sort_order_test.rb
 homepage: https://github.com/Dorian/scss-lint-auto-correct
 licenses:
 - MIT
@@ -82,6 +88,10 @@ specification_version: 4
 summary: Auto corrections for SCSS lint tool
 test_files:
 - test/fixtures/has_uppercase_colors.scss
+- test/fixtures/unsorted_properties.scss
+- test/fixtures/unsorted_properties_corrected.scss
+- test/fixtures/unsorted_properties_disable_rule.scss
 - test/test_helper.rb
 - test/unit/cli_test.rb
 - test/unit/downcase_colors_test.rb
+- test/unit/property_sort_order_test.rb