distincter2 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a8604db5a2f754b08135af05307d7164d0d54988163e91c20c91a09809a007f
-  data.tar.gz: 813d231a8ee7b4ace12726bedc9a9ebc2cd45e5be04e12446dc478ab36d6749b
+  metadata.gz: 4b8d1d5aa62302ef718c566a9053311075f4999fc1e8509c1e2d93e788f85a87
+  data.tar.gz: 66ebec72784df7a866f179c730f354120db1e227911655a8ee11ce509947adb5
 SHA512:
-  metadata.gz: cce320b5a321b1b589011dcaea2ee56b457512dfdf07f39cd2521a9d5af09978721462392bceeba8f9ed5afa0eea78a0577b839812d0d0f54b1db5e415490844
-  data.tar.gz: 86fe736d56978146e074c396b04fb92d7b747fc5adf3bc2726e5ad80139dc523f522066cf26089fad8b80cedb28f351a5e2a189cfb6af6639dcbd7d61665b9e8
+  metadata.gz: 81680f8b162f0851527be19be9a8018ebf34a9a613aab8f7451a9035ba3e8b1146303054810dff9724638ab3bd871965e27a2c030949c85804a2a477e0e6f4f4
+  data.tar.gz: 9c5898feafe48a5111c47bdbe99907c2b36eba081ffcc2d89f9e70cdaa9cbc542828f76f10cf6f64ba7d7dc68acb6a44a9793f2f4b0e324b11277b7e4c25fa1d

data/README.md

@@ -1,6 +1,7 @@
 # distincter2
 
 [![GitHubActions](https://github.com/fartem/distincter2/workflows/Build/badge.svg)](https://github.com/fartem/distincter2/actions?branch=master)
+[![codebeat badge](https://codebeat.co/badges/69d6a564-ddda-495b-9e10-107bf7691fb0)](https://codebeat.co/projects/github-com-fartem-distincter2-master)
 [![Gem Version](https://badge.fury.io/rb/distincter2.svg)](https://badge.fury.io/rb/distincter2)
 
 ## About
@@ -22,6 +23,30 @@ $ distincter2 ./path_to_directory_with_markdown_files
 $ ./bin/local_distincter2 ./path_to_directory_with_markdown_files
 ```
 
+### Config
+
+Add `distincter2_config.d2c` to root of your project and add excluded files line by line. Below you can find examples.
+
+#### v1
+
+Provides basic list for excluding files by names (without directories).
+
+Add `v1`:
+
+```text
+v1
+
+BOOKS.md
+DONE.md
+```
+
+Or without `v1`:
+
+```text
+BOOKS.md
+DONE.md
+```
+
 ## Contributors
 
 * [@fartem](https://github.com/fartem) as Artem Fomchenkov

data/bin/distincter2

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'distincter2'
 require 'colorize'
 

data/lib/distincter2/checker.rb

@@ -1,42 +1,61 @@
+# frozen_string_literal: true
+
 module Distincter2
   # distincter2 checker.
   # Handles a file and operate them.
   class D2Checker
-    # Mute if you don't want to see errors in output
-    def initialize(mute: false)
+    # @param {D2Config} config
+    # @param {Boolean} mute
+    def initialize(config, mute: false)
+      @config = config
       @mute = mute
     end
 
-    # Check entrypoint.
+    # @param {String} path
     def check(path)
       duplicates = analyze_dir(path)
+
       exit(duplicates.empty? ? 0 : 1)
     end
 
-    # Analyze given directory with recursion.
+    # @param {String} path
+    # @return {String[]}
     # rubocop:disable Metrics/MethodLength
     def analyze_dir(path)
       duplicates = []
       ::Dir.foreach(path).each do |entry|
         next if entry.start_with?('.')
 
-        file = "#{::File.absolute_path(path)}/#{::File.basename(entry)}"
-        analyze_result = []
+        entry_name = ::File.basename(entry)
+
+        file = "#{::File.absolute_path(path)}/#{entry_name}"
         if ::File.directory?(file)
           analyze_result = analyze_dir(file)
         else
           next unless entry.end_with?('.md')
 
+          next unless can_analyze(entry_name)
+
           analyze_result = analyze_file(file)
         end
+
         duplicates += analyze_result unless analyze_result.empty?
       end
+
       duplicates
     end
 
     # rubocop:enable Metrics/MethodLength
 
-    # Analyze given file.
+    # @param {String} entry
+    def can_analyze(entry)
+      return false unless @config.version == 'v1'
+
+      @config.exclude_paths.none?(entry)
+    end
+
+    # @param {String} path
+    # @return {String[]}
     # rubocop:disable Metrics/MethodLength
     def analyze_file(path)
       lines = []
@@ -45,6 +64,7 @@ module Distincter2
           lines << line if !line.empty? && line.start_with?('-')
         end
       end
+
       duplicates = lines.select { |line| lines.count(line) > 1 }
                         .uniq
       unless @mute
@@ -52,6 +72,7 @@ module Distincter2
           puts("#{path} : #{duplicate}")
         end
       end
+
       duplicates
     end
 

data/lib/distincter2/config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Distincter2
+  # Distincter2 config.
+  class D2Config
+    # @param {String[]} exclude_paths
+    # @param {String} version
+    def initialize(exclude_paths, version = 'v1')
+      @exclude_paths = exclude_paths.to_set
+      @version = version
+    end
+
+    attr_accessor :exclude_paths, :version
+  end
+
+  # D2Config with empty arguments.
+  class D2ConfigEmpty < ::Distincter2::D2Config
+    # Constructor without paths.
+    def initialize
+      super([])
+    end
+  end
+
+  # D2Config parser.
+  class D2ConfigParser
+    # @param {String} config_path
+    def initialize(config_path)
+      @config_path = config_path
+    end
+
+    # @return {D2Config}
+    # rubocop:disable Metrics/MethodLength
+    def parse
+      exclude_paths = []
+      version = 'v1'
+      ::File.open(@config_path, 'r') do |file|
+        file.readlines.each do |line|
+          l = line.strip
+
+          next if l == 'v1'
+
+          next if l.empty?
+
+          exclude_paths << l
+        end
+      end
+      ::Distincter2::D2Config.new(exclude_paths, version)
+    end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/distincter2.rb

@@ -1,12 +1,22 @@
+# frozen_string_literal: true
+
 require_relative './distincter2/checker'
+require_relative './distincter2/config'
 
 module Distincter2
   # distincter2 runner. Just an entrypoint.
   class Distincter2
-    # distincter2 starter.
+    #
     # You need a project path to run validation.
     def start(path)
-      checker = ::Distincter2::D2Checker.new
+      config_path = "#{path}/distincter2_config.d2c"
+      checker = ::Distincter2::D2Checker.new(
+        if ::File.exist?(config_path)
+          ::Distincter2::D2ConfigParser.new(config_path).parse
+        else
+          ::Distincter2::D2ConfigEmpty.new
+        end
+      )
       checker.check(path)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distincter2
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -93,6 +93,7 @@ files:
 - bin/distincter2
 - lib/distincter2.rb
 - lib/distincter2/checker.rb
+- lib/distincter2/config.rb
 homepage: https://github.com/fartem/distincter2
 licenses:
 - MIT