scss_lint-auto_correct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecfcbc916da720f957affb069abd0cb138469b9e
+  data.tar.gz: 681f8344e431b2ed948a72efa3446ee1b954a4ea
+SHA512:
+  metadata.gz: b26b98b6112520ff69a4e95547e9bb6211c5f1446481f982e8aab95d3e316281ab3be3a3315af687572cc4d488334e06d0adbdf09dc40edfcc341b283777b188
+  data.tar.gz: 4d28006157b8d380470eef8d1205f573c9840524b90dbcf44399e58aafedb4b5d39a211d613d9bc4ca242eeea6ee0e7636d9efca0903fbb16a501ca8a65b5127

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015, 2017 Dorian Marié, Troels Knak-Nielsen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/bin/scss-lint-auto-correct

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+require "scss_lint/auto_correct"
+require "scss_lint/auto_correct/cli"
+
+# logger = SCSSLint::Logger.new(STDOUT)
+exit SCSSLint::AutoCorrect::CLI.new.run(ARGV)

data/lib/scss_lint/auto_correct/cli.rb

@@ -0,0 +1,148 @@
+module SCSSLint::AutoCorrect
+  class CLI
+    attr_accessor :correctors, :paths, :options, :writer, :config
+
+    def initialize
+      @paths = []
+      @options = {}
+      @writer = FilesystemWriter.new
+      @correctors = Correctors.all
+    end
+
+    def parse_args!(argv)
+      @paths = []
+      @options = {}
+      argv.each do |arg|
+        if arg[0..1] == "--"
+          @options[arg[2..-1].to_sym] = true
+        elsif arg[0] == "-"
+          @options[arg[1..-1].to_sym] = true
+        elsif File.directory?(arg)
+          Dir["#{arg.chomp('/')}/**/*.scss"].each do |f|
+            @paths << f
+          end
+        else
+          @paths << arg
+        end
+      end
+    end
+
+    def option?(*names)
+      names.each do |name|
+        return true if @options[name.to_sym]
+      end
+      false
+    end
+
+    def run(argv)
+      parse_args! argv
+      load_config!
+      if option? :help, :h
+        print_help
+        return 0
+      end
+      if option? :list
+        print_list
+        return 0
+      end
+      if @paths.empty?
+        puts "Nothing to process"
+        return 1
+      end
+      process_all @paths
+      0
+    end
+
+    def print_help
+      puts "Fix your messy code"
+      puts "USAGE: scss-lint-auto-correct [OPTIONS] PATH [PATH ...]"
+      puts "OPTIONS are:"
+      puts "  --help, -h"
+      puts "  --verbose, -v"
+      puts "  --dry"
+      puts "  --list"
+      puts "Only apply specific correctors, using any combination of:"
+      @correctors.each do |c|
+        puts "  --#{c.short_name}"
+      end
+      puts "Disable specific correctors, using any combination of:"
+      @correctors.each do |c|
+        puts "  --no-#{c.short_name}"
+      end
+    end
+
+    def print_list
+      puts "Configured correctors:"
+      @correctors.each do |c|
+        puts "  #{c.short_name}: #{c.description}"
+      end
+    end
+
+    def load_config!
+      config_file = relevant_configuration_file
+      @config = config_file ? SCSSLint::Config.load(config_file) : SCSSLint::Config.default
+    end
+
+    def relevant_configuration_file
+      if File.exist?(SCSSLint::Config::FILE_NAME)
+        SCSSLint::Config::FILE_NAME
+      elsif File.exist?(SCSSLint::Config.user_file)
+        SCSSLint::Config.user_file
+      end
+    end
+
+    def process_all(paths)
+      paths.each do |path|
+        process_file path
+      end
+    end
+
+    def process_file(path)
+      puts "Processing file #{path}" if option? :verbose, :v
+      before = File.read(path)
+      after = invoke_correctors(before)
+
+      write_file(path, after) if before != after
+    end
+
+    def write_file(path, contents)
+      puts "Writing file #{path}" if option? :verbose, :v
+      writer.write_file(path, contents)
+    end
+
+    def selected_correctors
+      selected = []
+      unselected = []
+      @correctors.each do |c|
+        selected << c if option? c.short_name
+        unselected << c if option? "no-#{c.short_name}"
+      end
+      all = selected.any? ? selected : @correctors
+      all - unselected
+    end
+
+    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)
+      end
+      contents
+    end
+
+    class FilesystemWriter
+      def write_file(path, contents)
+        File.open(path, "w+") { |f| f.write contents }
+      end
+    end
+
+    class DummyWriter
+      def files
+        @files ||= []
+      end
+
+      def write_file(path, contents)
+        files << { path: path, contents: contents }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module SCSSLint::AutoCorrect::Correctors
+  class Base
+    def self.config_name
+    end
+
+    def self.short_name
+      self.name.split("::").last.
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr('_', '-').
+        downcase
+    end
+
+    def self.priority
+      10
+    end
+
+    attr_reader :config
+
+    def initialize(config = {})
+      @config = config
+    end
+
+    def enabled?
+      @config["enabled"] != false
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SCSSLint::AutoCorrect::Correctors
+  class DoubleQuoting < Base
+    def call(contents)
+      contents.gsub("'", '"')
+    end
+
+    def self.description
+      "Use double quotes, rather than single quotes"
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SCSSLint::AutoCorrect::Correctors
+  class DowncaseColors < Base
+    def call(contents)
+      contents.gsub(/#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})/) { |m| m.downcase }
+    end
+
+    def self.description
+      "Downcase hex color values"
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module SCSSLint::AutoCorrect::Correctors
+  class FormatNewlines < Base
+    def call(contents)
+      contents.gsub(/}\n( *[\.a-zA-Z0-9=\-:&\[\]]+) {/m) do
+        "}\n\n#{Regexp.last_match[1]} {"
+      end
+    end
+
+    def self.description
+      ""
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module SCSSLint::AutoCorrect::Correctors
+  class LinesEndWithSemicolons < Base
+    def call(contents)
+      # if a line ends with a letter, it means it should end with a semicolon
+      # (and it contains a : but no comments (// and *) and some buggy expressions (&))
+      contents.gsub(/^[^\/*&]+:[^\/*&]+[A-Za-z0-9-]$/, '\0;')
+    end
+
+    def self.description
+      "Ensure lines end with a semicolon, when they should"
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module SCSSLint::AutoCorrect::Correctors
+  class NewlinesForEachSelector < Base
+    def call(contents)
+      contents.gsub(/([a-zA-Z0-9\[\]=~* ]+,){2,}.+{/) do |m|
+        selectors = m.split(",")
+        first = selectors.first.rstrip
+        rest = selectors[1..-1].map { |s| " " * first.count(" ") + s.strip }
+        ([first] + rest).join(",\n")
+      end
+    end
+
+    def self.description
+      "Ensure each selector goes on its own line"
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SCSSLint::AutoCorrect::Correctors
+  class NoSpacesBeforeSemicolons < Base
+    def call(contents)
+      contents.gsub(/ +;/, ';')
+    end
+
+    def self.description
+      "Remove spaces before semicolons"
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module SCSSLint::AutoCorrect::Correctors
+  class ShortVersionsOfNumbers < Base
+    def call(contents)
+      # do not match 1.04 or v1.0.0 or LICENSE-2.0
+      # (this is pure dark magic)
+      contents.gsub(/([^-v[0-9]?\.?)])([0-9])\.0+([^0-9])/, '\1\2\3')
+    end
+
+    def self.description
+      ""
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SCSSLint::AutoCorrect::Correctors
+  class ShorterVersionsOfColors < Base
+    def call(contents)
+      contents.gsub(/#(([A-Za-z0-9])\2){3}/) { |m| "##{m[1]}#{m[3]}#{m[5]}" }
+    end
+
+    def self.description
+      "Shortens hex color codes to 3 letters, when possible"
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SCSSLint::AutoCorrect::Correctors
+  class SpacingBeforeSelectors < Base
+    def call(contents)
+      contents.gsub(/[a-zA-Z0-9%\[\]=*~]+ +{/) { |m| m.gsub(/ +/, ' ') }
+    end
+
+    def self.description
+      "Removes any extra whitespace before selector opening brace"
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+module SCSSLint::AutoCorrect::Correctors
+  class UseHexInsteadOfColorKeywords < Base
+    def call(contents)
+      colors = self.class.data
+      regexp = Regexp.new("^([^\/]+ )(#{colors.keys.join('|')})([\) ;].*)$")
+
+      contents.gsub(regexp) do
+        Regexp.last_match[1] + colors[Regexp.last_match[2]] + Regexp.last_match[3]
+      end
+    end
+
+    def self.data
+      return @data if @data
+      colors_file = File.expand_path(File.join(File.dirname(__FILE__), "color-keywords.csv"))
+      @data = Hash[File.read(colors_file).lines.map { |l| l.gsub("\n", '').split(',') }]
+    end
+
+    def self.description
+      "Replace named colors with their hex values"
+    end
+
+    def self.priority
+      5
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module SCSSLint::AutoCorrect::Correctors
+  class VariableNames < Base
+    def call(contents)
+      contents.gsub(/\$[a-z_-]+/) { |m| m.gsub('_', '-') }
+    end
+
+    def self.description
+      "Use dashes instead of underscores in variable names"
+    end
+  end
+end

data/lib/scss_lint/auto_correct/correctors.rb

@@ -0,0 +1,10 @@
+module SCSSLint::AutoCorrect
+  module Correctors
+    def self.all
+      ObjectSpace.
+        each_object(Class).
+        select { |klass| klass < Base }.
+        sort_by(&:priority)
+    end
+  end
+end

data/lib/scss_lint/auto_correct/version.rb

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

data/lib/scss_lint/auto_correct.rb

@@ -0,0 +1,10 @@
+require "scss_lint"
+
+module SCSSLint
+  module AutoCorrect
+  end
+end
+
+Dir[File.expand_path('..', __FILE__) + "/**/*.rb"].sort_by(&:length).each do |path|
+  require path
+end

data/test/fixtures/has_uppercase_colors.scss

@@ -0,0 +1,3 @@
+.lorem {
+  color: #FF0000;
+}

data/test/test_helper.rb

@@ -0,0 +1,25 @@
+require "minitest/mock"
+require "minitest/autorun"
+require "minitest/pride"
+
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+
+Dir[File.expand_path('../../lib', __FILE__) + "/**/*.rb"].sort_by(&:length).each do |path|
+  require path
+end
+
+module Minitest
+  class Test
+    # Set is `let`'s wacky cousin
+    def set(key, value)
+      @_memoized ||= {}
+      @_memoized[key.to_s] = value
+      value
+    end
+
+    def load_file(filename, type: "t")
+      path = File.join(File.dirname(__FILE__), "fixtures", filename)
+      File.open(path, "r#{type}").read
+    end
+  end
+end

data/test/unit/cli_test.rb

@@ -0,0 +1,43 @@
+require_relative "../test_helper"
+
+class CliTest < Minitest::Test
+  describe "SCSSLint::AutoCorrect::CLI" do
+    let(:cli) { SCSSLint::AutoCorrect::CLI }
+
+    it "basically works" do
+      cli.new
+    end
+
+    it "can parse regular args" do
+      instance = cli.new
+      instance.parse_args! ["foo"]
+      assert_equal ["foo"], instance.paths
+    end
+
+    it "can parse regular options" do
+      instance = cli.new
+      instance.parse_args! ["--verbose"]
+      assert_equal [], instance.paths
+      assert_equal({ verbose: true }, instance.options)
+    end
+
+    it "allows running a specific correctors only" do
+      instance = cli.new
+      instance.parse_args! ["--downcase-colors", "--format-newlines"]
+      assert_equal 2, instance.selected_correctors.count
+    end
+
+    it "allows skipping a specific corrector" do
+      instance = cli.new
+      all = instance.selected_correctors.count
+      instance.parse_args! ["--no-downcase-colors"]
+      assert_equal all - 1, instance.selected_correctors.count
+    end
+
+    it "loads scss-lint config" do
+      instance = cli.new
+      instance.load_config!
+      assert_equal SCSSLint::Config, instance.config.class
+    end
+  end
+end

data/test/unit/downcase_colors_test.rb

@@ -0,0 +1,18 @@
+require_relative "../test_helper"
+
+class DowncaseColorsTest < Minitest::Test
+  describe "SCSSLint::AutoCorrect::Correctors::DowncaseColors" do
+    let(:corrector) { SCSSLint::AutoCorrect::Correctors::DowncaseColors }
+
+    it "basically works" do
+      corrector.new
+    end
+
+    it "process input" do
+      input = load_file "has_uppercase_colors.scss"
+      output = corrector.new.call input
+      refute_includes output, "#FF0000"
+      assert_includes output, "#ff0000"
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: scss_lint-auto_correct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dorian Marié
+- Troels Knak-Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: scss_lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A bunch of scripts for correcting some scss linting errors.
+email:
+- dorian@doma.io
+- troels@knak-nielsen.dk
+executables:
+- scss-lint-auto-correct
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- bin/scss-lint-auto-correct
+- lib/scss_lint/auto_correct.rb
+- lib/scss_lint/auto_correct/cli.rb
+- lib/scss_lint/auto_correct/correctors.rb
+- lib/scss_lint/auto_correct/correctors/base.rb
+- lib/scss_lint/auto_correct/correctors/double_quoting.rb
+- lib/scss_lint/auto_correct/correctors/downcase_colors.rb
+- lib/scss_lint/auto_correct/correctors/format_newlines.rb
+- 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/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/version.rb
+- test/fixtures/has_uppercase_colors.scss
+- test/test_helper.rb
+- test/unit/cli_test.rb
+- test/unit/downcase_colors_test.rb
+homepage: https://github.com/Dorian/scss-lint-auto-correct
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Auto corrections for SCSS lint tool
+test_files:
+- test/fixtures/has_uppercase_colors.scss
+- test/test_helper.rb
+- test/unit/cli_test.rb
+- test/unit/downcase_colors_test.rb