ariadne_view_components 0.0.34-x86_64-linux → 0.0.37-x86_64-linux

data/lib/ariadne/view_components/linters/base_linter.rb

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+require "json"
+require "openssl"
+require "ariadne/view_components/constants"
+
+require_relative "tag_tree_helpers"
+
+# :nocov:
+
+module ERBLint
+  module Linters
+    # Provides the basic linter logic. When inherited, you should define:
+    # * `TAGS` - required - The HTML tags that the component supports. It will be used by the linter to match elements.
+    # * `MESSAGE` - required - The message shown when there's an offense.
+    # * `CLASSES` - optional - The CSS classes that the component needs. The linter will only match elements with one of those classes.
+    # * `REQUIRED_ARGUMENTS` - optional - A list of HTML attributes that are required by the component.
+    class BaseLinter < Linter
+      include TagTreeHelpers
+
+      DUMP_FILE = ".erblint-counter-ignore.json"
+      DISALLOWED_CLASSES = [].freeze
+      CLASSES = [].freeze
+      REQUIRED_ARGUMENTS = [].freeze
+
+      class ConfigSchema < LinterConfig # rubocop:disable Style/Documentation
+        property :override_ignores_if_correctable, accepts: [true, false], default: false, reader: :override_ignores_if_correctable?
+      end
+
+      class << self
+        def inherited(base)
+          super
+          base.include(ERBLint::LinterRegistry)
+          base.config_schema = ConfigSchema
+        end
+      end
+
+      def run(processed_source)
+        @total_offenses = 0
+        @offenses_not_corrected = 0
+        (tags, tag_tree) = build_tag_tree(processed_source)
+
+        tags.each do |tag|
+          next if tag.closing?
+          next if self.class::TAGS&.none?(tag.name)
+
+          classes = tag.attributes["class"]&.value&.split(" ") || []
+          tag_tree[tag][:offense] = false
+
+          next if classes.intersect?(self.class::DISALLOWED_CLASSES)
+          next unless self.class::CLASSES.blank? || classes.intersect?(self.class::CLASSES)
+
+          args = map_arguments(tag, tag_tree[tag])
+          correction = correction(args)
+
+          attributes = tag.attributes.each.map(&:name).join(" ")
+          matches_required_attributes = self.class::REQUIRED_ARGUMENTS.blank? || self.class::REQUIRED_ARGUMENTS.all? { |arg| attributes.match?(arg) }
+
+          tag_tree[tag][:offense] = true
+          tag_tree[tag][:correctable] = matches_required_attributes && !correction.nil?
+          tag_tree[tag][:message] = message(args, processed_source)
+          tag_tree[tag][:correction] = correction
+        end
+
+        tag_tree.each do |tag, h|
+          next unless h[:offense]
+
+          @total_offenses += 1
+          # We always fix the offenses using blocks. The closing tag corresponds to `<% end %>`.
+          if h[:correctable]
+            add_correction(tag, h)
+          else
+            @offenses_not_corrected += 1
+            generate_offense(self.class, processed_source, tag, h[:message])
+          end
+        end
+
+        counter_correct?(processed_source)
+
+        dump_data(processed_source) if ENV["DUMP_LINT_DATA"] == "1"
+      end
+
+      def autocorrect(processed_source, offense)
+        return unless offense.context
+
+        lambda do |corrector|
+          if offense.context.include?(counter_disable)
+            correct_counter(corrector, processed_source, offense)
+          else
+            corrector.replace(offense.source_range, offense.context)
+          end
+        end
+      end
+
+      private
+
+      def add_correction(tag, tag_tree)
+        add_offense(tag.loc, tag_tree[:message], tag_tree[:correction])
+        add_offense(tag_tree[:closing].loc, tag_tree[:message], "<% end %>")
+      end
+
+      # Override this function to convert the HTML element attributes to argument for a component.
+      #
+      # @return [Hash] if possible to map all attributes to arguments.
+      # @return [Nil] if cannot map to arguments.
+      def map_arguments(_tag, _tag_tree)
+        nil
+      end
+
+      # Override this function to define how to autocorrect an element to a component.
+      #
+      # @return [String] with the text to replace the HTML element if possible to correct.
+      # @return [Nil] if cannot correct element.
+      def correction(_tag)
+        nil
+      end
+
+      # Override this function to customize the linter message.
+      #
+      # @return [String] message to show on linter error.
+      def message(_tag, _processed_source)
+        self.class::MESSAGE
+      end
+
+      def counter_disable
+        "erblint:counter #{self.class.name.demodulize}"
+      end
+
+      def correct_counter(corrector, processed_source, offense)
+        if processed_source.file_content.include?(counter_disable)
+          # update the counter if exists
+          corrector.replace(offense.source_range, offense.context)
+        else
+          # add comment with counter if none
+          corrector.insert_before(processed_source.source_buffer.source_range, "#{offense.context}\n")
+        end
+      end
+
+      def tags(processed_source)
+        processed_source.parser.nodes_with_type(:tag).map { |tag_node| BetterHtml::Tree::Tag.from_node(tag_node) }
+      end
+
+      def counter_correct?(processed_source)
+        comment_node = nil
+        expected_count = 0
+        rule_name = self.class.name.match(/:?:?(\w+)\Z/)[1]
+
+        processed_source.parser.ast.descendants(:erb).each do |node|
+          indicator_node, _, code_node, = *node
+          indicator = indicator_node&.loc&.source
+          comment = code_node&.loc&.source&.strip
+
+          if indicator == "#" && comment.start_with?("erblint:count") && comment.match(rule_name)
+            comment_node = node
+            expected_count = comment.match(/\s(\d+)\s?$/)[1].to_i
+          end
+        end
+
+        # Unless explicitly set, we don't want to mark correctable offenses if the counter is correct.
+        if !@config.override_ignores_if_correctable? && expected_count == @total_offenses
+          clear_offenses
+          return
+        end
+
+        if @offenses_not_corrected.zero?
+          # have to adjust to get `\n` so we delete the whole line
+          add_offense(processed_source.to_source_range(comment_node.loc.adjust(end_pos: 1)), "Unused erblint:count comment for #{rule_name}", "") if comment_node
+          return
+        end
+
+        first_offense = @offenses[0]
+
+        if comment_node.nil?
+          add_offense(processed_source.to_source_range(first_offense.source_range), "#{rule_name}: If you must, add <%# erblint:counter #{rule_name} #{@offenses_not_corrected} %> to bypass this check.", "<%# erblint:counter #{rule_name} #{@offenses_not_corrected} %>")
+        elsif expected_count != @offenses_not_corrected
+          add_offense(processed_source.to_source_range(comment_node.loc), "Incorrect erblint:counter number for #{rule_name}. Expected: #{expected_count}, actual: #{@offenses_not_corrected}.", "<%# erblint:counter #{rule_name} #{@offenses_not_corrected} %>")
+        # the only offenses remaining are not autocorrectable, so we can ignore them
+        elsif expected_count == @offenses_not_corrected && @offenses.size == @offenses_not_corrected
+          clear_offenses
+        end
+      end
+
+      def generate_offense(klass, processed_source, tag, message = nil, replacement = nil)
+        message ||= klass::MESSAGE
+        klass_name = klass.name.demodulize
+        offense = ["#{klass_name}:#{message}", tag.node.loc.source].join("\n")
+        add_offense(processed_source.to_source_range(tag.loc), offense, replacement)
+      end
+
+      def dump_data(processed_source)
+        return if @total_offenses.zero?
+
+        data = File.exist?(DUMP_FILE) ? JSON.parse(File.read(DUMP_FILE)) : {}
+
+        data[processed_source.filename] ||= {}
+        data[processed_source.filename][self.class.name.demodulize] = @total_offenses
+
+        File.write(DUMP_FILE, JSON.pretty_generate(data))
+      end
+    end
+  end
+end

data/lib/ariadne/view_components/linters/tag_tree_helpers.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module ERBLint
+  module Linters
+    # Helpers used by linters to organize HTML tags into abstract syntax trees.
+    module TagTreeHelpers
+      # from https://github.com/Shopify/erb-lint/blob/6179ee2d9d681a6ec4dd02351a1e30eefa748d3d/lib/erb_lint/linters/self_closing_tag.rb
+      SELF_CLOSING_TAGS = [
+        "area",
+        "base",
+        "br",
+        "col",
+        "command",
+        "embed",
+        "hr",
+        "input",
+        "keygen",
+        "link",
+        "menuitem",
+        "meta",
+        "param",
+        "source",
+        "track",
+        "wbr",
+        "img",
+      ].freeze
+
+      # This assumes that the AST provided represents valid HTML, where each tag has a corresponding closing tag.
+      # From the tags, we build a structured tree which represents the tag hierarchy.
+      # With this, we are able to know where the tags start and end.
+      def build_tag_tree(processed_source)
+        nodes = processed_source.ast.children
+        tag_tree = {}
+        tags = []
+        current_opened_tag = nil
+
+        nodes.each do |node|
+          if node.type == :tag
+            # get the tag from previously calculated list so the references are the same
+            tag = BetterHtml::Tree::Tag.from_node(node)
+            tags << tag
+
+            if tag.closing?
+              if current_opened_tag && tag.name == current_opened_tag.name
+                tag_tree[current_opened_tag][:closing] = tag
+                current_opened_tag = tag_tree[current_opened_tag][:parent]
+              end
+
+              next
+            end
+
+            self_closing = self_closing?(tag)
+
+            tag_tree[tag] = {
+              tag: tag,
+              closing: self_closing ? tag : nil,
+              parent: current_opened_tag,
+              children: [],
+            }
+
+            tag_tree[current_opened_tag][:children] << tag_tree[tag] if current_opened_tag
+            current_opened_tag = tag unless self_closing
+          elsif current_opened_tag
+            tag_tree[current_opened_tag][:children] << node
+          end
+        end
+
+        [tags, tag_tree]
+      end
+
+      def self_closing?(tag)
+        tag.self_closing? || SELF_CLOSING_TAGS.include?(tag.name)
+      end
+    end
+  end
+end

data/lib/ariadne/view_components/version.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
+# :nocov:
 module Ariadne
   module ViewComponents
-    VERSION = "0.0.34"
+    VERSION = "0.0.37"
   end
 end

data/lib/tasks/build.rake

@@ -19,6 +19,12 @@ namespace :ariadne_view_components do
     puts command.inspect
     system(*command)
   end
+
+  desc "Prepares the project for release"
+  task :prepare do |_, _args|
+    FileUtils.rm_rf("app/assets/javascripts")
+    system("script/prepare")
+  end
 end
 
 Rake::Task["assets:precompile"].enhance(["ariadne_view_components:build"]) if Rake::Task.task_defined?("assets:precompile")

data/lib/tasks/coverage.rake

@@ -8,9 +8,12 @@ namespace :coverage do
 
     SimpleCov.minimum_coverage(100)
 
-    SimpleCov.collate(Dir["simplecov-resultset-*/.resultset.json"], "rails") do
+    SimpleCov.collate(Dir["coverage/.resultset.json"], "rails") do
       formatter SimpleCov::Formatter::Console
 
+      minimum_coverage 90
+      maximum_coverage_drop 2
+
       add_group "Ignored Code" do |src_file|
         File.readlines(src_file.filename).grep(/:nocov:/).any?
       end

data/lib/tasks/docs.rake

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require "yard"
+require "yard/renders_one_handler"
+require "yard/renders_many_handler"
+
 require "active_support/inflector"
 require "fileutils"
 
@@ -301,7 +305,7 @@ namespace :docs do
     puts "Markdown compiled."
 
     if components_needing_docs.any?
-      puts "\nThe following components need documentation. Can you add them? #{components_needing_docs.map(&:name).join(", ")}"
+      puts "\nThe following components need documentation. Could you add it to them? #{components_needing_docs.map(&:name).join(", ")}"
     end
   end
 

data/lib/tasks/test.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  ENV["TZ"] = "Asia/Yerevan"
+
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_files = FileList[ENV["TESTS"] || "test/**/*_test.rb"]
+end
+
+Rake::TestTask.new(:bench) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/benchmarks/**/bench_*.rb"]
+  t.verbose = true
+  t.warning = false
+end

data/static/classes.yml

@@ -116,6 +116,8 @@
 - ".ariadne-ring-black"
 - ".ariadne-ring-opacity-5"
 - ".ariadne-text-gray-700"
+- ".ariadne-ml-2"
+- ".ariadne--mr-1"
 - ".ariadne-text-red-500"
 - ".ariadne-mt-0"
 - ".ariadne-text-slate-700"
@@ -137,7 +139,6 @@
 - ".ariadne-mt-4"
 - ".ariadne-pt-5"
 - ".ariadne--mx-2"
-- ".ariadne-flex-col"
 - ".ariadne-mt-6"
 - ".sm:ariadne-mt-0"
 - ".ariadne-grid"
@@ -159,6 +160,7 @@
 - ".md:ariadne-flex"
 - ".md:ariadne-divide-y-0"
 - ".ariadne-text-black"
+- ".ariadne-flex-col"
 - ".ariadne-hidden"
 - ".ariadne-list-none"
 - ".ariadne-border-slate-600"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ariadne_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.37
 platform: x86_64-linux
 authors:
 - Garen J. Torikian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tailwind_merge
@@ -112,20 +112,6 @@ files:
 - LICENSE.txt
 - README.md
 - app/assets/config/manifest.js
-- app/assets/javascripts/ariadne-form-with.d.ts
-- app/assets/javascripts/ariadne-form.d.ts
-- app/assets/javascripts/ariadne.d.ts
-- app/assets/javascripts/ariadne_view_components.js
-- app/assets/javascripts/ariadne_view_components.js.map
-- app/assets/javascripts/clipboard-copy-component.d.ts
-- app/assets/javascripts/comment-component.d.ts
-- app/assets/javascripts/rich-text-area-component.d.ts
-- app/assets/javascripts/slideover-component.d.ts
-- app/assets/javascripts/tab-container-component.d.ts
-- app/assets/javascripts/tab-nav-component.d.ts
-- app/assets/javascripts/time-ago-component.d.ts
-- app/assets/javascripts/time_ago_component.d.ts
-- app/assets/javascripts/tooltip-component.d.ts
 - app/assets/stylesheets/ariadne_view_components.css
 - app/assets/stylesheets/dropdown.css
 - app/assets/stylesheets/prosemirror.css
@@ -162,6 +148,7 @@ files:
 - app/components/ariadne/flash_component.rb
 - app/components/ariadne/flash_component/flash_component.html.erb
 - app/components/ariadne/flex_component.rb
+- app/components/ariadne/flex_component/flex_component.html.erb
 - app/components/ariadne/footer_component.rb
 - app/components/ariadne/footer_component/footer_component.html.erb
 - app/components/ariadne/grid_component.rb
@@ -224,6 +211,10 @@ files:
 - lib/ariadne/view_components/constants.rb
 - lib/ariadne/view_components/engine.rb
 - lib/ariadne/view_components/linters.rb
+- lib/ariadne/view_components/linters/argument_mappers/conversion_error.rb
+- lib/ariadne/view_components/linters/autocorrectable.rb
+- lib/ariadne/view_components/linters/base_linter.rb
+- lib/ariadne/view_components/linters/tag_tree_helpers.rb
 - lib/ariadne/view_components/statuses.rb
 - lib/ariadne/view_components/upstream.rb
 - lib/ariadne/view_components/version.rb
@@ -238,6 +229,7 @@ files:
 - lib/tasks/helpers/ast_processor.rb
 - lib/tasks/helpers/ast_traverser.rb
 - lib/tasks/static.rake
+- lib/tasks/test.rake
 - lib/yard/docs_helper.rb
 - lib/yard/renders_many_handler.rb
 - lib/yard/renders_one_handler.rb

data/app/assets/javascripts/ariadne-form-with.d.ts

@@ -1,20 +0,0 @@
-import { Controller } from '@hotwired/stimulus';
-import { TemplateResult } from 'lit-html';
-declare type HTMLFormField = HTMLInputElement | HTMLButtonElement | HTMLSelectElement | HTMLTextAreaElement;
-export default class AriadneFormWith extends Controller {
-    connect(): void;
-    disconnect(): void;
-    onBlur: (event: Event) => void;
-    onSubmit: (event: Event) => void;
-    validateForm(): boolean;
-    validateField(field: HTMLFormField): boolean;
-    shouldValidateField(field: HTMLFormField): boolean;
-    refreshErrorForInvalidField(field: HTMLFormField, isValid: boolean): void;
-    removeExistingErrorMessage(field: HTMLFormField): void;
-    showErrorForInvalidField(field: HTMLFormField): void;
-    buildFieldErrorHtml(field: HTMLFormField): string;
-    get formFields(): HTMLFormField[];
-    get firstInvalidField(): HTMLFormField | undefined;
-    getRenderString: (data: TemplateResult) => string;
-}
-export {};

data/app/assets/javascripts/ariadne-form.d.ts

@@ -1,22 +0,0 @@
-import { Controller } from '@hotwired/stimulus';
-import type { TemplateResult } from 'lit-html';
-declare type HTMLFormField = HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement;
-export default class AriadneFormWith extends Controller {
-    static targets: string[];
-    readonly formFieldTargets: [HTMLFormField];
-    connect(): void;
-    disconnect(): void;
-    onBlur: (event: Event) => void;
-    onSubmit: (event: Event) => void;
-    validateForm(): boolean;
-    validateField(field: HTMLFormField): boolean;
-    shouldValidateField(field: HTMLFormField): boolean;
-    refreshErrorForInvalidField(field: HTMLFormField, isValid: boolean): void;
-    removeExistingErrorMessage(field: HTMLFormField): void;
-    showErrorForInvalidField(field: HTMLFormField): void;
-    buildFieldErrorHtml(field: HTMLFormField): string;
-    get formFields(): HTMLFormField[];
-    get firstInvalidField(): HTMLFormField | undefined;
-    getRenderString: (data: TemplateResult) => string;
-}
-export {};

data/app/assets/javascripts/ariadne.d.ts

@@ -1,2 +0,0 @@
-import './tab-container-component';
-import './time-ago-component';