distincter2 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b8d1d5aa62302ef718c566a9053311075f4999fc1e8509c1e2d93e788f85a87
-  data.tar.gz: 66ebec72784df7a866f179c730f354120db1e227911655a8ee11ce509947adb5
+  metadata.gz: e7356757437f888b0a6ab4054086150075337e10a56bd32c970bd2bd1e6c5687
+  data.tar.gz: 385dddc273aab58dad6002c533feeb72002f886fdb82ef45ce35f12a8d7179f3
 SHA512:
-  metadata.gz: 81680f8b162f0851527be19be9a8018ebf34a9a613aab8f7451a9035ba3e8b1146303054810dff9724638ab3bd871965e27a2c030949c85804a2a477e0e6f4f4
-  data.tar.gz: 9c5898feafe48a5111c47bdbe99907c2b36eba081ffcc2d89f9e70cdaa9cbc542828f76f10cf6f64ba7d7dc68acb6a44a9793f2f4b0e324b11277b7e4c25fa1d
+  metadata.gz: 20c5b2ea990ec92ead8e5b0808ab0ce1cb75f2dc3bc0075c3945e1f40e5cfb5cc5fc17cfbe13368d34817841455d81c799103a615746665a0fa472c3759fa867
+  data.tar.gz: a8d452f076387b8087486e251adfdf9d43033213da477f8ff3ddacfceee6c212d70f3717ecb40369a9a5e0d3e25eeee62738788c6be162a00473b2c80a4f1e5e

data/README.md

@@ -47,6 +47,27 @@ BOOKS.md
 DONE.md
 ```
 
+## How to contribute
+
+### Documentation
+
+Just run:
+
+```shell
+$ rdoc
+```
+
+### Contribution
+
+Read [Commit Convention](./COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request.
+Then:
+
+```shell
+$ bundle exec rake
+```
+
+If you don't see any error messages, submit your pull request.
+
 ## Contributors
 
 * [@fartem](https://github.com/fartem) as Artem Fomchenkov

data/lib/distincter2/checker.rb

@@ -1,26 +1,31 @@
 # frozen_string_literal: true
 
 module Distincter2
-  # distincter2 checker.
-  # Handles a file and operate them.
+  # Class to check for duplicate lines in markdown files
   class D2Checker
-    # @param {D2Config} config
-    # @param {Boolean} mute
+    # Initialize the D2Checker with a configuration object and an optional mute flag
+    #
+    # @param config [Object] The configuration object containing settings for the checker
+    # @param mute [Boolean] A flag indicating whether to mute the output of duplicate lines (default: false)
     def initialize(config, mute: false)
       @config = config
       @mute = mute
     end
 
-    # @param {String} path
+    # Check for duplicate lines in markdown files within a given directory
+    #
+    # @param path [String] The path to the directory to check
+    # @return [Array] An array of duplicate lines found in the markdown files
     def check(path)
       duplicates = analyze_dir(path)
 
       exit(duplicates.empty? ? 0 : 1)
     end
 
-    # @param {String} path
-    # @return {String[]}
-    # rubocop:disable Metrics/MethodLength
+    # Recursively analyze a directory for duplicate lines in markdown files
+    #
+    # @param path [String] The path to the directory to analyze
+    # @return [Array] An array of duplicate lines found in the markdown files
     def analyze_dir(path)
       duplicates = []
       ::Dir.foreach(path).each do |entry|
@@ -45,18 +50,20 @@ module Distincter2
       duplicates
     end
 
-    # rubocop:enable Metrics/MethodLength
-
-    # @param {String} entry
+    # Check if a file can be analyzed based on the configuration settings
+    #
+    # @param entry [String] The name of the file to check
+    # @return [Boolean] True if the file can be analyzed, false otherwise
     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
+    # Analyze a markdown file for duplicate lines
+    #
+    # @param path [String] The path to the markdown file to analyze
+    # @return [Array] An array of duplicate lines found in the markdown file
     def analyze_file(path)
       lines = []
       ::File.open(path, 'r') do |file|
@@ -75,7 +82,5 @@ module Distincter2
 
       duplicates
     end
-
-    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/distincter2/config.rb

@@ -3,51 +3,71 @@
 require 'set'
 
 module Distincter2
-  # Distincter2 config.
+  # Class representing the configuration for Distincter2.
   class D2Config
-    # @param {String[]} exclude_paths
-    # @param {String} version
+    # Initializes a new instance of D2Config.
+    #
+    # @param exclude_paths [Array<String>] An array of paths to be excluded.
+    # @param version [String] The version of the configuration. Default is 'v1'.
     def initialize(exclude_paths, version = 'v1')
       @exclude_paths = exclude_paths.to_set
       @version = version
     end
 
-    attr_accessor :exclude_paths, :version
+    # Accessor for the exclude_paths attribute.
+    #
+    # @return [Set<String>] The set of paths to be excluded.
+    attr_accessor :exclude_paths
+
+    # Accessor for the version attribute.
+    #
+    # @return [String] The version of the configuration.
+    attr_accessor :version
   end
 
-  # D2Config with empty arguments.
-  class D2ConfigEmpty < ::Distincter2::D2Config
+  # Class representing an empty configuration for Distincter2.
+  # This class inherits from D2Config and initializes with an empty array of exclude_paths.
+  class D2EmptyConfig < ::Distincter2::D2Config
     # Constructor without paths.
+    #
+    # @return [void]
     def initialize
+      # Calls the parent class's initialize method with an empty array of exclude_paths.
       super([])
     end
   end
 
-  # D2Config parser.
+  # Class representing a parser for Distincter2 configuration files.
   class D2ConfigParser
-    # @param {String} config_path
+    # Initializes a new instance of D2ConfigParser.
+    #
+    # @param config_path [String] The path to the configuration file.
     def initialize(config_path)
       @config_path = config_path
     end
 
-    # @return {D2Config}
-    # rubocop:disable Metrics/MethodLength
+    # Parses the configuration file and returns a D2Config object.
+    #
+    # @return [Distincter2::D2Config] A D2Config object representing the parsed configuration.
     def parse
       exclude_paths = []
       version = 'v1'
+
+      # Open the configuration file and read its lines.
       ::File.open(@config_path, 'r') do |file|
         file.readlines.each do |line|
           l = line.strip
 
-          next if l == 'v1'
-
-          next if l.empty?
+          # Skip lines that contain the version number or are empty.
+          next if l == 'v1' || l.empty?
 
+          # Add the non-empty, non-version lines to the exclude_paths array.
           exclude_paths << l
         end
       end
+
+      # Create a new D2Config object with the parsed exclude_paths and version.
       ::Distincter2::D2Config.new(exclude_paths, version)
     end
-    # rubocop:enable Metrics/MethodLength
   end
 end

data/lib/distincter2.rb

@@ -5,18 +5,35 @@ require_relative './distincter2/config'
 
 module Distincter2
   # distincter2 runner. Just an entrypoint.
+  # This class represents the main entry point for the Distincter2 runner.
   class Distincter2
+    # This method starts the validation process for a given project path.
     #
-    # You need a project path to run validation.
+    # @param path [String] The path to the project directory.
+    # @return [void]
+    #
+    # @example
+    #   # Create an instance of Distincter2
+    #   distincter = Distincter2.new
+    #
+    #   # Start the validation process for a project located at '/path/to/project'
+    #   distincter.start('/path/to/project')
     def start(path)
+      # Construct the path to the distincter2_config.d2c file
       config_path = "#{path}/distincter2_config.d2c"
+
+      # Create a new D2Checker instance with the appropriate configuration
       checker = ::Distincter2::D2Checker.new(
         if ::File.exist?(config_path)
+          # If the config file exists, parse it and use the parsed configuration
           ::Distincter2::D2ConfigParser.new(config_path).parse
         else
-          ::Distincter2::D2ConfigEmpty.new
+          # If the config file does not exist, use an empty configuration
+          ::Distincter2::D2EmptyConfig.new
         end
       )
+
+      # Run the validation process using the checker
       checker.check(path)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: distincter2
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Artem Fomchenkov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2024-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize