css_class_duplicates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed329f3f9209fa5ff1ff79b79714d651327162fbf6c99c5f1c9619f843c60c6c
+  data.tar.gz: aceea4196b63d6bd9343baf34a193c5b65d64f39f7423b8f549c38296cf4d889
+SHA512:
+  metadata.gz: 2588d4c48f3ff26c61b227265fdf3365a6eb4adc272b9839b070a7f7ca51bd96c686489124cff2b32781b77d0e1d9d674d6d2f9a2d3ebcb7b68e7e22cd5a2e43
+  data.tar.gz: 4b24ca2142a1ca85c0f6dbb44970619efebc25b3f0f119906a1f24cb3353d15d7558625fac1f90f846a463586961c7a745f4573dc6790a40cf8b1df892cf65af

data/config/default.yml

@@ -0,0 +1,22 @@
+files:
+  include:
+    - "**/*.html.erb"
+  # exclude:
+  # - "app/views/layouts/**"
+
+matches:
+  type: 'exact'
+  # type: 'partial'
+
+filters:
+  classes:
+    min: 2
+    # include:
+    #  - '*'               # Include the match only if it contains the class
+    # exclude:
+    #  - 'first:*'         # Exclude the match if it contains the class
+    #  - 'btn btn-primary' # Exclude the match if it contains the classes
+    # delete:
+    #  - 'hidden'          # Deletes the class from match
+  matches:
+    min: 2

data/exe/css_class_duplicates

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'benchmark'
+require 'css_class_duplicates'
+
+cli = CssClassDuplicates::CLI.new
+result = 0
+
+time = Benchmark.realtime { result = cli.run }
+
+puts "Finished in #{time} seconds"
+exit result

data/lib/css_class_duplicates/cli.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  # The CLI is a class responsible of handling all the command line interface logic.
+  class CLI
+    STATUS_SUCCESS = 0
+    STATUS_ERROR = 0
+
+    def initialize
+      @options = {}
+    end
+
+    def run
+      entities = []
+
+      config = Config.new
+      config.files.each do |file_name|
+        entities.concat(config.parser.call(file_name))
+      end
+
+      entities = config.merger.call(entities)
+      entities = config.filter.call(entities)
+      config.printer.call(entities)
+
+      STATUS_SUCCESS
+    rescue StandardError, SyntaxError, LoadError => e
+      warn e.message
+      warn e.backtrace
+      STATUS_ERROR
+    end
+  end
+end

data/lib/css_class_duplicates/config.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'rake/file_list'
+
+module CssClassDuplicates
+  # This class represents the configuration of the gem.
+  # A Config is associated with a YAML configuration
+  # file from which it was read.
+  class Config
+    PROJECT_CONFIG = '.css_class_duplicates.yml'
+    DEFAULT_CONFIG = File.expand_path('../../config/default.yml', __dir__)
+
+    def initialize
+      filename = File.exist?(PROJECT_CONFIG) ? PROJECT_CONFIG : DEFAULT_CONFIG
+      @config = YAML.load_file(filename)
+    end
+
+    def files
+      Rake::FileList.new.tap do |file_list|
+        if (files = @config['files'])
+          if (include = files['include'])
+            file_list.include(include)
+          end
+          if (exclude = files['exclude'])
+            file_list.exclude(exclude)
+          end
+        else
+          file_list.include('**/*')
+        end
+      end
+    end
+
+    def parser
+      @parser ||= Parser.new(@config['filters'])
+    end
+
+    def merger
+      @merger ||= Merger.new(@config['matches'])
+    end
+
+    def filter
+      @filter ||= Filter.new(@config['filters'])
+    end
+
+    def printer
+      @printer ||= Printer.new
+    end
+  end
+end

data/lib/css_class_duplicates/filter.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  # This class filters found results to exclude CSS classes that aren't duplicated
+  class Filter
+    def initialize(config)
+      @min_classes = config.dig('classes', 'min') || 2
+      @min_matches = config.dig('matches', 'min') || 2
+    end
+
+    def call(entities)
+      entities.select do |entity|
+        entity.classes.size >= @min_classes && entity.files.size >= @min_matches
+      end
+    end
+  end
+end

data/lib/css_class_duplicates/globber.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  # The class compares strings using wildcard symbols
+  class Globber
+    def self.for(value)
+      return value if value.is_a?(Regexp)
+
+      escaped = Regexp.escape(value).gsub('\*', '.*?')
+      Regexp.new("^#{escaped}$", Regexp::IGNORECASE)
+    end
+  end
+end

data/lib/css_class_duplicates/match.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  Match = Struct.new(:classes, :files)
+end

data/lib/css_class_duplicates/merger.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  # This class merges found results
+  class Merger
+    def initialize(config)
+      @type = config['type']
+    end
+
+    def call(entities)
+      matches = entities.group_by(&:classes).map do |classes, items|
+        Match.new(classes, items.map(&:files).flatten)
+      end
+      matches = add_partial_matches(matches) if @type == 'partial'
+      matches
+    end
+
+    private
+
+    def add_partial_matches(matches)
+      match_idx = matches.to_h { |match| [match.classes, match] }
+
+      matches.combination(2) do |match1, match2|
+        partial = match1.classes.intersection(match2.classes)
+        next if partial.empty?
+
+        existing = (match_idx[partial] ||= Match.new(partial, []))
+        existing.files = (existing.files + match1.files + match2.files).uniq
+      end
+
+      match_idx.values
+    end
+  end
+end

data/lib/css_class_duplicates/parser.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  # This class searches for CSS classes
+  class Parser
+    MATCHER = /
+      \s+class\s*=\s*["']?([\w\s\-_:]+)["']?|       # class = "hello world"
+      class:\s*["']?([\w\s\-_:]+)["']?|             # class: 'hello world'
+      ["']?class["']?\s=>\s*["']?([\w\s\-_:]+)["']? # 'class' => "hello world"
+    /x.freeze
+    WHITESPACE = /\s/.freeze
+
+    def initialize(config)
+      classes = config.dig('classes')
+      @include = to_regex_array(classes&.dig('include'))
+      @exclude = to_regex_array(classes&.dig('exclude'))
+      @delete = to_regex_array(classes&.dig('delete'))
+    end
+
+    def call(file_name)
+      content = File.read(file_name)
+
+      matches = Scanner.new(content).matches(MATCHER)
+      matches.map do |match, line|
+        classes = match.split(WHITESPACE).reject(&:empty?)
+        next if classes.empty?
+
+        classes = filter(classes.map(&:downcase).sort)
+        next if classes.empty?
+
+        Match.new(classes, ["#{file_name}:#{line}"])
+      end.compact
+    end
+
+    private
+
+    def filter(classes)
+      return [] if @include.any? && !any?(@include, classes)
+      return [] if @exclude.any? && any?(@exclude, classes)
+
+      classes.reject { |value| include?(@delete, value) }
+    end
+
+    def any?(list, values)
+      values.any? { |value| include?(list, value) } || include?(list, values.join(' '))
+    end
+
+    def include?(list, value)
+      list.any? { |regex| value =~ regex }
+    end
+
+    def to_regex_array(array)
+      array&.map { |pattern| Globber.for(pattern) } || []
+    end
+  end
+end

data/lib/css_class_duplicates/printer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  # This class renders the result in console.
+  class Printer
+    def call(entities)
+      entities.sort_by { |entity| [-entity.files.size, -entity.classes.size] }.each do |entity|
+        puts "#{entity.files.size} matches for \"#{entity.classes.join(' ')}\""
+        entity.files.uniq.sort.each do |file_name|
+          puts "  #{file_name}"
+        end
+        puts
+      end
+    end
+  end
+end

data/lib/css_class_duplicates/scanner.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'English'
+
+module CssClassDuplicates
+  # This class scans string and returns all found matches with positions
+  class Scanner
+    NEW_LINE = /(\r\n|\r|\n)/.freeze
+
+    def initialize(content)
+      @content = content
+    end
+
+    def matches(regex)
+      matches_with_positions(regex).map do |match, start_position|
+        [match, file_line(start_position)]
+      end
+    end
+
+    private
+
+    def matches_with_positions(regex)
+      matches = []
+      @content.scan(regex) do |captures|
+        captures.each_with_index do |capture, index|
+          next unless capture
+
+          start_position, end_position = $LAST_MATCH_INFO.offset(index + 1)
+          matches << [capture, start_position, end_position]
+        end
+      end
+      matches
+    end
+
+    def file_line(position)
+      file_lines.index { |line_length| (position -= line_length) <= 0 } + 1
+    end
+
+    def file_lines
+      @file_lines ||= @content.split(NEW_LINE).map(&:length).each_slice(2).map(&:sum)
+    end
+  end
+end

data/lib/css_class_duplicates/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CssClassDuplicates
+  VERSION = '0.1.0'
+end

data/lib/css_class_duplicates.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'css_class_duplicates/cli'
+require_relative 'css_class_duplicates/config'
+require_relative 'css_class_duplicates/filter'
+require_relative 'css_class_duplicates/globber'
+require_relative 'css_class_duplicates/match'
+require_relative 'css_class_duplicates/merger'
+require_relative 'css_class_duplicates/parser'
+require_relative 'css_class_duplicates/printer'
+require_relative 'css_class_duplicates/scanner'
+require_relative 'css_class_duplicates/version'
+
+module CssClassDuplicates
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: css_class_duplicates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kushnir
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-05 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      The gem searches for CSS class set duplicates, so they can be replaced with something meaningful,
+      like "border border-gray-400 bg-gray-100 mt-1 ..." can be replaced with "widget".
+      Supports Tailwind CSS and its alternatives
+email:
+- akushnir2009@gmail.com
+executables:
+- css_class_duplicates
+extensions: []
+extra_rdoc_files: []
+files:
+- config/default.yml
+- exe/css_class_duplicates
+- lib/css_class_duplicates.rb
+- lib/css_class_duplicates/cli.rb
+- lib/css_class_duplicates/config.rb
+- lib/css_class_duplicates/filter.rb
+- lib/css_class_duplicates/globber.rb
+- lib/css_class_duplicates/match.rb
+- lib/css_class_duplicates/merger.rb
+- lib/css_class_duplicates/parser.rb
+- lib/css_class_duplicates/printer.rb
+- lib/css_class_duplicates/scanner.rb
+- lib/css_class_duplicates/version.rb
+homepage: https://github.com/a-kushnir/css_class_duplicates
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/a-kushnir/css_class_duplicates
+  source_code_uri: https://github.com/a-kushnir/css_class_duplicates
+  bug_tracker_uri: https://github.com/a-kushnir/css_class_duplicates/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.10
+signing_key:
+specification_version: 4
+summary: CSS class duplication search tool.
+test_files: []