distincter2 1.1.4 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a0b38aad8d0e98961b541dbc6bca3ca880feda0e3c6fe23fdc52f90d75ba598
-  data.tar.gz: 0abbe05d2e3974cdd88b256b22b8dd890e94172629aa51d8f6e48f2edb8e5d3b
+  metadata.gz: 9ffd3065d97f5ea86eaa09c2a0a12f1d86bbce35409c8469ae4a3593284d831a
+  data.tar.gz: 40b4baf7cddb4ce8123442a7efb7b6e3c21a7a07236e0c3fe523877bc1c8901e
 SHA512:
-  metadata.gz: c3cf97a6ec15e1a5ab94d03cc109fbfc9266eee27b95917c639070d220e1c670306365174b113f18eb4f655dd6c4ccd6f69414f4ed89a4c2bb432977a79a4095
-  data.tar.gz: cd77f9422e9ef6607dfcb8657e3811eddc9806c72327203010747959e8aed3b8ff1d2403e2c1e364df9082424774e90deaaa59f9b3029f9d33b649e9b44c2992
+  metadata.gz: 238b6ca822da1fe8752e8dfbeea444cccf51ac237f9e044543ac92552d012bd4c330d4798bcd666e758b372bd5ad21c585abf8539f8ad41afe976780c79833bc
+  data.tar.gz: f526bdee7e4be1bebd6af837d223bef292c67c7b34d7a7078afa3d8def5722d11d1b88cc120e4b669c94927dbed3f324cf3d3f500b89f77a16406c9dd362e7e6

data/README.md

@@ -1,13 +1,37 @@
 # 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
+
 A tool that can check lists in Markdown files and find duplicates.
 
 ## How to use
 
+### Global installation
+
+```shell
+$ gem i distincter2
+$ distincter2 ./path_to_directory_with_markdown_files
+```
+
+### Local installation
+
 ```shell
 $ ./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:
+
+```text
+BOOKS.md
+DONE.md
+```
+
 ## Contributors
 
 * [@fartem](https://github.com/fartem) as Artem Fomchenkov

data/bin/distincter2

@@ -1,6 +1,19 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'distincter2'
+require 'colorize'
+
+# @param text String
+def red_colored_text(text)
+  text.colorize(:light_red)
+end
 
-distincter2 = ::Distincter2::Distincter2.new
-distincter2.start(::ARGV[0])
+if ::ARGV.empty?
+  puts red_colored_text('ERROR: You need to provide a path to directory with files.').to_s
+  exit(1)
+else
+  distincter2 = ::Distincter2::Distincter2.new
+  distincter2.start(::ARGV[0])
+end

data/lib/distincter2/checker.rb

@@ -1,42 +1,54 @@
+# 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 if @config.exclude_paths.include?(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} path
+    # @return {String[]}
     # rubocop:disable Metrics/MethodLength
     def analyze_file(path)
       lines = []
@@ -45,6 +57,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 +65,7 @@ module Distincter2
           puts("#{path} : #{duplicate}")
         end
       end
+
       duplicates
     end
 

data/lib/distincter2/config.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module Distincter2
+  # Distincter2 config.
+  class D2Config
+    # @param {String[]} exclude_paths
+    def initialize(exclude_paths)
+      @exclude_paths = exclude_paths.to_set
+    end
+
+    attr_accessor :exclude_paths
+  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}
+    def parse
+      exclude_paths = []
+      ::File.open(@config_path, 'r') do |file|
+        exclude_paths += file.readlines.map(&:strip)
+      end
+      ::Distincter2::D2Config.new(exclude_paths)
+    end
+  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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: distincter2
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.3.0
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-09-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -79,7 +93,8 @@ files:
 - bin/distincter2
 - lib/distincter2.rb
 - lib/distincter2/checker.rb
-homepage: http://github.com/fartem/distincter2
+- lib/distincter2/config.rb
+homepage: https://github.com/fartem/distincter2
 licenses:
 - MIT
 metadata: {}