marcdouane 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ac5051e1dda30d1dd98035ba682431ac8e32788b4187772eea00e1306f5ca1d
-  data.tar.gz: 2b60396b0e783bf920602fd49c2d04e4288e2c9b35e1485f85e7a94a5653d046
+  metadata.gz: 1ae9e6bd5c948110c746ef7ef8091fb9858d2ef9358f80dacdd424573009906b
+  data.tar.gz: b1843497ea7c116a1d466f9b9368929db9d00390391740d45671d2fea3baee81
 SHA512:
-  metadata.gz: e054ef7079b1bf87c8203d3db165a43c3b26ffa7fc7fd1301a346060b0b25e60b7868f82550972992291b16875a5ce22512784417f489f990a673aa49fb1f501
-  data.tar.gz: 3982749d76b7e586a67b6ed6a5b8ef13bcc3ecea6c0877166ac6fe00605979fd2904c5c069d9b1a0d16da9bbac9e98f186c2a21264038f7849648d78166d426e
+  metadata.gz: 54cd432ee92e94694c9df60c3709bcdbeef5fcfbb0a8fb5ff35f4a84f91be2e3c0f2626c5128391e15525d978af61edbd775888401b82d93f5d4fcd32dd298c8
+  data.tar.gz: f89fc35dc945765eb1b54f4a3f864f2af3b827adb1ada8e5e9962c033d545776909a684a61b190dc100ff8436b142b0db0042e3f53384192ab21768223ab45ca

data/README.md

@@ -12,7 +12,8 @@ Install the gem and add to the application's Gemfile by executing:
 bundle add marcdouane
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If bundler is not being used to manage dependencies, install the gem
+by executing:
 
 ```bash
 gem install marcdouane
@@ -50,9 +51,14 @@ I'm doing it
 
 ## Contributing
 
-A rule must inherit `Marcdouane::Rule`. It must answer to `check!` and
-raise a `Marcdouane::Error` with an `ERROR_MESSAGE` and a line
-number. Example:
+You can generate a new rule with `bundle exec thor generate_rule
+YourRuleName` which will write the class file, require it and add a
+new test-case for it.
+
+A rule must inherit `Marcdouane::Rule`. It must answer to `check!`
+and call `error!` to signal a faulty line. The message defaults to the
+class's `ERROR_MESSAGE` but can be overriden through the `message`
+parameter. The line-number is 0-indexed. Example:
 
 ```ruby
 class CheckAnglois < Marcdouane::Rule
@@ -62,15 +68,21 @@ class CheckAnglois < Marcdouane::Rule
     File
       .read(file)
       .lines
-      .each_with_index(line, index) do
-      raise Marcdouane:Error.new(ERROR_MESSAGE, index + 1) if line =~ /anglois/
+      .each_with_index do |line, index|
+      error!(index) if line =~ /anglois/
     end
   end
 end
 ```
 
-It is then expected to be tested throughout the Cucumber feature tests
-like such:
+This will get the CLI to output:
+
+```
+<filename>:<line_number>: [CheckAnglois] Do not mention the English
+```
+
+All rules are expected to be tested via the extensive test suite in
+`features/rules.features`, using Cucumber and Aruba like such:
 
 ```feature
 Feature: Built-in Markdown Rules

data/Thorfile

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "thor/group"
+
+# Generates a new rule for Marcdouane, prompting an error message and
+# filling in some tests too.
+class GenerateRule < Thor::Group
+  include Thor::Actions
+
+  desc "Generate a new rule for Marcdouane"
+
+  argument :name,
+           type: :string,
+           desc: "Camel-case identifier of the rule"
+
+  def create_rule_file
+    create_file "lib/marcdouane/rules/#{underscore(name)}.rb" do
+      @msg = ask("What is the error message to be displayed on a faulty line?")
+
+      <<~RB
+        # frozen_string_literal: true
+
+        module Marcdouane
+          module Rules
+            class #{name} < Rule
+              ERROR_MESSAGE = "#{@msg}"
+
+              def check!; end
+            end
+          end
+        end
+      RB
+    end
+  end
+
+  def add_test_case
+    append_to_file "features/rules.feature" do
+      <<-CUKE
+
+  @wip
+  Rule: #{@msg}
+    Example: FIXME
+      Given a file named "foo.md" with:
+      """
+      Faulty content
+      """
+      When I run `marcdouane check "foo.md"`
+      Then it should fail with:
+      """
+      foo.md:1: [#{name}] #{@msg}
+      """
+      CUKE
+    end
+  end
+
+  def letsgo
+    puts "Done! Use `bundle exec cucumber -t @wip` to get going."
+  end
+
+  private
+
+  def underscore(str)
+    str.instance_eval do
+      gsub("::", "/")
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr("-", "_")
+        .downcase
+    end
+  end
+end

data/bin/marcdouane

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
 require "dry/cli"
 require "marcdouane"
 
+# rubocop:disable Style/Documentation
 module Marcdouane
   module CLI
     module Commands
@@ -36,32 +36,43 @@ module Marcdouane
                  required: true,
                  desc: "Files to check against"
 
+        option :"custom-rules",
+               type: :string,
+               required: false,
+               desc: "Path to a file containing custom rules"
+
         def call(files: [], **options)
+          check_files!(files)
+
+          if options[:"custom-rules"]
+            load options[:"custom-rules"]
+          end
+
+          files
+            .map  { |file| Marcdouane::FileChecker.call(file, options) }
+            .then { |codes| exit(codes.max) }
+        end
+
+        def check_files!(files)
           if files.empty?
             puts "No files provided."
-            return
+            exit 0
           end
 
-          exit_code = 0
-
           files.each do |file|
-            if !File.exist?(file)
-              $stderr.puts "`#{file}' is missing, or not a valid file."
-              exit_code = 1
-            else
-              exit_code = Marcdouane::FileChecker.call(file, options)
+            unless File.exist?(file)
+              warn "`#{file}' is missing, or not a valid file."
+              exit 1
             end
           end
-
-          exit(exit_code)
         end
       end
 
-
       register "version", Version, aliases: ["v", "-v", "--version"]
       register "check", Check
     end
   end
 end
+# rubocop:enable Style/Documentation
 
 Dry::CLI.new(Marcdouane::CLI::Commands).call

data/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/lib/marcdouane/file_checker.rb

@@ -6,33 +6,53 @@ require "yaml"
 require_relative "rules"
 
 module Marcdouane
+  # FileChecker grabs all rules available and then calls them on a
+  # file, transmitting any options fed to the CLI.  and then calls all
+  # the rules
   class FileChecker
     class << self
+      attr_reader :exit_code
+
       def call(file, options)
         verbose = options.fetch(:verbose)
 
-        parse_config!(options[:config])
+        parse_config!(options[:config]) unless options[:config].nil?
 
         puts "Checking `#{file}'..." if verbose
 
-        exit_code = 0
+        @exit_code = 0
+
+        rules
+          .map { |klass| run_rule(file, klass, options) }
+          .tap  { |_codes| puts "Done." if verbose }
+          .then { @exit_code }
+      end
+
+      def run_rule(file, klass, options)
+        rule = klass.new(file, options)
 
-        rules.each do |rule|
-          rule.new(file, options).check!
-        rescue Marcdouane::Error => e
-          $stderr.puts("#{file}:#{e.line_number}: #{e.message}")
+        rule.subscribe("rule.error") do |event|
+          print_error(file, rule, event[:line_number], event[:msg])
 
-          exit_code = 1
+          @exit_code = 1
         end
 
-        puts "Done." if verbose
+        rule.check!
+      end
 
-        exit_code
+      def print_error(file, rule, line_number, msg)
+        warn(
+          format(
+            "%<file>s:%<line_number>s: [%<rule_class>s] %<message>s",
+            file:,
+            line_number:,
+            rule_class: rule.identifier,
+            message: msg
+          )
+        )
       end
 
       def parse_config!(path)
-        return if path.nil?
-
         config = YAML.load_file(path)
 
         config.each do |klass, hash|

data/lib/marcdouane/rules/consistent_header_style.rb

@@ -2,30 +2,27 @@
 
 module Marcdouane
   module Rules
+    # Ensure that headers style is consistent: either the '#'-prefix
+    # style or the '=' underscore style, but not both.
     class ConsistentHeaderStyle < Rule
       ERROR_MESSAGE = "Use a unique, consistent header style"
 
       def check!
-        reference_style, style = nil
+        reference_style = nil
 
+        # we need to dup otherwise seeking directly into the
+        # @markdown.source confuses Inkmark and subsequent headers
+        # will have nil byte ranges
         source = @markdown.source.lines.dup
 
         @markdown.on(:heading) do |header|
           line_number = line_number_from_byte_range(header.byte_range)
 
-          raw_line = source[line_number]
-
-          if raw_line.start_with?("#")
-            style = :normal
-          else
-            style = :underline
-          end
+          style = source[line_number].start_with?("#") ? :normal : :underline
 
           reference_style ||= style
 
-          if reference_style != style
-            error!(line_number)
-          end
+          error!(line_number) if reference_style != style
         end
 
         @markdown.walk

data/lib/marcdouane/rules/no_consecutive_blank_lines.rb

@@ -11,7 +11,7 @@ module Marcdouane
           .source
           .lines
           .each_cons(2)
-          .each_with_index do |pair, index|
+          .with_index do |pair, index|
           if pair.map(&:strip).all?(&:empty?)
             error!(index + 2)
           end

data/lib/marcdouane/rules/rule.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "dry/configurable"
+require "dry/events/publisher"
 require "inkmark"
 
 module Marcdouane
@@ -13,6 +14,7 @@ module Marcdouane
     # ERROR_MESSAGE when the check fails.
     class Rule
       extend Dry::Configurable
+      include Dry::Events::Publisher[:marcdouane] # I don't know what that identifier is for
 
       attr_reader :file, :options, :markdown
 
@@ -25,6 +27,8 @@ module Marcdouane
             frontmatter: true
           }
         )
+
+        register_event("rule.error")
       end
 
       def line_number_from_byte_range(range)
@@ -35,17 +39,14 @@ module Marcdouane
         self.class.to_s.split("::").last
       end
 
-      # Produces an error that will be collected and output by the
-      # CLI. It must be called with the 0-indexed line-number, and an
-      # optional `message` override instead of the class's
-      # ERROR_MESSAGE.
+      # Publishes an error event, picked up by the FileChecker
+      # somewhere down the line. It must be called with the 0-indexed
+      # line-number, and an optional `message` override instead of the
+      # class's ERROR_MESSAGE.
       def error!(machine_line_number, message = nil)
         msg = message || self.class.const_get("ERROR_MESSAGE")
 
-        raise Marcdouane::Error.new(
-          "[#{identifier}] #{msg}",
-          machine_line_number + 1
-        )
+        publish("rule.error", msg: msg, line_number: machine_line_number + 1)
       end
     end
   end

data/lib/marcdouane/rules/single_top_level_header.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Marcdouane
+  module Rules
+    # Ensure that there is only a single top-level header in the file.
+    class SingleTopLevelHeader < Rule
+      ERROR_MESSAGE = "A top-level header is already present"
+
+      def check!
+        previously_seen = false
+
+        @markdown.on(:heading) do |header|
+          if header.level == 1
+            if previously_seen
+              error!(line_number_from_byte_range(header.byte_range))
+            else
+              previously_seen = true
+            end
+          end
+        end
+
+        @markdown.walk
+      end
+    end
+  end
+end

data/lib/marcdouane/rules.rb

@@ -2,8 +2,4 @@
 
 require_relative "rules/rule"
 
-require_relative "rules/ensure_headers_cascade"
-require_relative "rules/line_length"
-require_relative "rules/no_consecutive_blank_lines"
-require_relative "rules/start_with_top_level_header"
-require_relative "rules/consistent_header_style"
+Dir["#{File.dirname(__FILE__)}/rules/*.rb"].map(&method(:require))

data/lib/marcdouane/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Marcdouane
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/marcdouane.rb

@@ -3,15 +3,5 @@
 require_relative "marcdouane/version"
 require_relative "marcdouane/file_checker"
 
-module Marcdouane
-  class Error < StandardError
-    attr_reader :msg, :line_number
-
-    def initialize(msg, line_number)
-      @msg = msg
-      @line_number = line_number
-
-      super(@msg)
-    end
-  end
-end
+# Marcdouane is a pretty Markdown linter
+module Marcdouane; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: marcdouane
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stéphane Maniaci
@@ -37,6 +37,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: dry-events
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: inkmark
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +91,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Thorfile
 - bin/marcdouane
+- cucumber.yml
 - lib/marcdouane.rb
 - lib/marcdouane/file_checker.rb
 - lib/marcdouane/rules.rb
@@ -86,6 +102,7 @@ files:
 - lib/marcdouane/rules/line_length.rb
 - lib/marcdouane/rules/no_consecutive_blank_lines.rb
 - lib/marcdouane/rules/rule.rb
+- lib/marcdouane/rules/single_top_level_header.rb
 - lib/marcdouane/rules/start_with_top_level_header.rb
 - lib/marcdouane/version.rb
 - logo.jpeg
@@ -96,6 +113,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/freesteph/marcdouane
   source_code_uri: https://github.com/freesteph/marcdouane
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib