ariadne_view_components 0.0.1

data/lib/rubocop/cop/ariadne/component_name_migration.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+# :nocov:
+module RuboCop
+  module Cop
+    module Ariadne
+      # This cop ensures that components don't use deprecated component names
+      #
+      # bad
+      # Ariadne::ComponentNameComponent.new()
+      #
+      # good
+      # Ariadne::Beta::ComponentName.new()
+      class ComponentNameMigration < BaseCop
+        DEPRECATIONS = {
+          "Ariadne::TestComponent" => "Ariadne::Beta::Test",
+        }.freeze
+
+        def on_send(node)
+          return unless node.method_name == :new && !node.receiver.nil? && DEPRECATIONS.key?(node.receiver.const_name)
+
+          add_offense(node.receiver, message: "Don't use deprecated names")
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            corrector.replace(node, DEPRECATIONS[node.const_name])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ariadne/no_tag_memoize.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+# :nocov:
+module RuboCop
+  module Cop
+    module Ariadne
+      # This cop ensures that tags are not set with ||=
+      #
+      # bad
+      # @attributes[:tag] ||= :h1
+      #
+      # good
+      # @attributes[:tag] = fetch_or_raise(TAG_OPTIONS, tag)
+      #
+      # good
+      # @attributes[:tag] = :h2
+      class NoTagMemoize < RuboCop::Cop::Cop
+        INVALID_MESSAGE = <<~STR
+          Avoid `[:tag] ||=`. Instead, try one of the following:
+            - Don't allow consumers to update the tag by having a fixed tag (e.g. `attributes[:tag] = :div`)
+            - Use the `fetch_or_raise` helper to only allow a tag from a restricted list.
+        STR
+
+        def_node_search :tag_memoized?, <<~PATTERN
+          (or-asgn
+            (send
+              _
+              _
+              (sym :tag)
+            )
+            _
+          )
+        PATTERN
+
+        def on_or_asgn(node)
+          add_offense(node, message: INVALID_MESSAGE) if tag_memoized?(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ariadne/system_argument_instead_of_class.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "ariadne/classify/utilities"
+
+# :nocov:
+module RuboCop
+  module Cop
+    module Ariadne
+      # This cop ensures that components use System Arguments instead of CSS classes.
+      #
+      # bad
+      # Component.new(classes: "mr-1")
+      #
+      # good
+      # Component.new(mr: 1)
+      class SystemArgumentInsteadOfClass < BaseCop
+        INVALID_MESSAGE = <<~STR
+          Avoid using CSS classes when you can use System Arguments: https://ariadne.style/view-components/system-arguments.
+        STR
+
+        def on_send(node)
+          return unless valid_node?(node)
+          return unless node.arguments?
+
+          # we are looking for hash arguments and they are always last
+          kwargs = node.arguments.last
+
+          return unless kwargs.type == :hash
+
+          # find classes pair
+          classes_arg = kwargs.pairs.find { |kwarg| kwarg.key.value == :classes }
+
+          return if classes_arg.nil?
+          return unless classes_arg.value.type == :str
+
+          # get actual classes
+          classes = classes_arg.value.value
+
+          attributes = ::Ariadne::Classify::Utilities.classes_to_hash(classes)
+
+          # no classes are fixable
+          return if attributes[:classes] == classes
+
+          add_offense(classes_arg, message: INVALID_MESSAGE)
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            args = ::Ariadne::Classify::Utilities.classes_to_args(node.value.value)
+            corrector.replace(node.loc.expression, args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/ariadne.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+Dir[File.join(__dir__, "ariadne", "*.rb")].sort.each { |file| require file }

data/lib/tasks/ariadne_view_components.rake

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+ERB_GLOB = "**/*.html{+*,}.erb"
+RB_GLOB = "**/*.rb"
+BLOCK_EXPR = /\s*((\s+|\))do|\{)(\s*\|[^|]*\|)?\s*\Z/.freeze # copied from Rails: action_view/template/handlers/erb/erubi.rb
+
+namespace :ariadne_view_components do
+  desc "Report arguments used in each component"
+  task :report, [:paths] do |_, args|
+    require "rubocop"
+    require "better_html"
+    require "better_html/parser"
+    require "erb_lint/processed_source"
+    require_relative "helpers/ast_processor"
+
+    paths = args[:paths].split
+    stats = {}
+
+    rb_files = paths.reduce([]) { |mem, path| mem + Dir[File.join(path, RB_GLOB)] }
+
+    rb_files.each do |f|
+      ast = RuboCop::AST::ProcessedSource.from_file(f, RUBY_VERSION.to_f).ast
+      AstProcessor.process_ast(ast, stats)
+    end
+
+    erb_files = paths.reduce([]) { |mem, path| mem + Dir[File.join(path, ERB_GLOB)] }
+
+    erb_files.each do |f|
+      erb_ast = ERBLint::ProcessedSource.new(f, File.read(f)).ast
+
+      erb_ast.descendants(:erb).each do |erb_node|
+        indicator, _, code_node, = *erb_node
+
+        next if indicator&.children&.first == "#" # don't analyze comments
+
+        trimmed_source = code_node.loc.source.sub(BLOCK_EXPR, "").strip
+        ast = RuboCop::AST::ProcessedSource.new(trimmed_source, RUBY_VERSION.to_f).ast
+        AstProcessor.process_ast(ast, stats)
+      end
+    end
+
+    File.open(".ariadne-view-components-report.json", "w") do |f|
+      f.write(JSON.pretty_generate(stats))
+      f.write($INPUT_RECORD_SEPARATOR)
+    end
+  end
+end

data/lib/tasks/coverage.rake

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+namespace :coverage do
+  desc "Run coverage report. This should ideally be done only on CI."
+  task :report do
+    require "simplecov"
+    require "simplecov-console"
+
+    SimpleCov.minimum_coverage(100)
+
+    SimpleCov.collate(Dir["simplecov-resultset-*/.resultset.json"], "rails") do
+      formatter SimpleCov::Formatter::Console
+
+      add_group "Ignored Code" do |src_file|
+        File.readlines(src_file.filename).grep(/:nocov:/).any?
+      end
+    end
+  end
+end

data/lib/tasks/custom_utilities.yml

@@ -0,0 +1,310 @@
+:font_size:
+  "00":
+  - f00
+  1:
+  - f1
+  2:
+  - f2
+  3:
+  - f3
+  4:
+  - f4
+  5:
+  - f5
+  6:
+  - f6
+  :small:
+  - text-small
+  :normal:
+  - text-normal
+:top:
+  0:
+  - top-0
+  false:
+  - top-0
+:bottom:
+  0:
+  - bottom-0
+  false:
+  - bottom-0
+:left:
+  0:
+  - left-0
+  false:
+  - left-0
+:right:
+  0:
+  - right-0
+  false:
+  - right-0
+:underline:
+  true:
+  - text-underline
+  false:
+  - no-underline
+:font_family:
+  :mono:
+  - text-mono
+:font_style:
+  :italic:
+  - text-italic
+:text_transform:
+  :uppercase:
+  - text-uppercase
+:text_align:
+  :right:
+  - text-right
+  - text-sm-right
+  - text-md-right
+  - text-lg-right
+  - text-xl-right
+  :left:
+  - text-left
+  - text-sm-left
+  - text-md-left
+  - text-lg-left
+  - text-xl-left
+  :center:
+  - text-center
+  - text-sm-center
+  - text-md-center
+  - text-lg-center
+  - text-xl-center
+:font_weight:
+  :light:
+  - text-light
+  :normal:
+  - text-normal
+  :bold:
+  - text-bold
+  :semibold:
+  - text-semibold
+  :emphasized:
+  - text-emphasized
+:box_shadow:
+  true:
+  - color-shadow-small
+  :small:
+  - color-shadow-small
+  :medium:
+  - color-shadow-medium
+  :large:
+  - color-shadow-large
+  :extra_large:
+  - color-shadow-extra-large
+  :none:
+  - box-shadow-none
+  false:
+  - box-shadow-none
+:border:
+  :left:
+  - border-left
+  :top:
+  - border-top
+  :bottom:
+  - border-bottom
+  :right:
+  - border-right
+  :y:
+  - border-y
+  :x:
+  - border-x
+  true:
+  - border
+  0:
+  - border-0
+  false:
+  - border-0
+  :dashed:
+  - border-dashed
+:border_top:
+  0:
+  - border-top-0
+:border_bottom:
+  0:
+  - border-bottom-0
+:border_left:
+  0:
+  - border-left-0
+:border_right:
+  0:
+  - border-right-0
+:border_radius:
+  0:
+  - rounded-0
+  1:
+  - rounded-1
+  2:
+  - rounded-2
+  3:
+  - rounded-3
+:justify_content:
+  :flex_start:
+  - flex-justify-start
+  - flex-sm-justify-start
+  - flex-md-justify-start
+  - flex-lg-justify-start
+  - flex-xl-justify-start
+  :flex_end:
+  - flex-justify-end
+  - flex-sm-justify-end
+  - flex-md-justify-end
+  - flex-lg-justify-end
+  - flex-xl-justify-end
+  :center:
+  - flex-justify-center
+  - flex-sm-justify-center
+  - flex-md-justify-center
+  - flex-lg-justify-center
+  - flex-xl-justify-center
+  :space_between:
+  - flex-justify-between
+  - flex-sm-justify-between
+  - flex-md-justify-between
+  - flex-lg-justify-between
+  - flex-xl-justify-between
+  :space_around:
+  - flex-justify-around
+  - flex-sm-justify-around
+  - flex-md-justify-around
+  - flex-lg-justify-around
+  - flex-xl-justify-around
+:align_items:
+  :flex_start:
+  - flex-items-start
+  - flex-sm-items-start
+  - flex-md-items-start
+  - flex-lg-items-start
+  - flex-xl-items-start
+  :flex_end:
+  - flex-items-end
+  - flex-sm-items-end
+  - flex-md-items-end
+  - flex-lg-items-end
+  - flex-xl-items-end
+  :center:
+  - flex-items-center
+  - flex-sm-items-center
+  - flex-md-items-center
+  - flex-lg-items-center
+  - flex-xl-items-center
+  :baseline:
+  - flex-items-baseline
+  - flex-sm-items-baseline
+  - flex-md-items-baseline
+  - flex-lg-items-baseline
+  - flex-xl-items-baseline
+  :stretch:
+  - flex-items-stretch
+  - flex-sm-items-stretch
+  - flex-md-items-stretch
+  - flex-lg-items-stretch
+  - flex-xl-items-stretch
+:flex_wrap:
+  :wrap:
+  - flex-wrap
+  - flex-sm-wrap
+  - flex-md-wrap
+  - flex-lg-wrap
+  - flex-xl-wrap
+  :nowrap:
+  - flex-nowrap
+  - flex-sm-nowrap
+  - flex-md-nowrap
+  - flex-lg-nowrap
+  - flex-xl-nowrap
+  :reverse:
+  - flex-wrap-reverse
+  - flex-sm-wrap-reverse
+  - flex-md-wrap-reverse
+  - flex-lg-wrap-reverse
+  - flex-xl-wrap-reverse
+:direction:
+  :column:
+  - flex-column
+  - flex-sm-column
+  - flex-md-column
+  - flex-lg-column
+  - flex-xl-column
+  :column_reverse:
+  - flex-column-reverse
+  - flex-sm-column-reverse
+  - flex-md-column-reverse
+  - flex-lg-column-reverse
+  - flex-xl-column-reverse
+  :row:
+  - flex-row
+  - flex-sm-row
+  - flex-md-row
+  - flex-lg-row
+  - flex-xl-row
+  :row_reverse:
+  - flex-row-reverse
+  - flex-sm-row-reverse
+  - flex-md-row-reverse
+  - flex-lg-row-reverse
+  - flex-xl-row-reverse
+:flex:
+  1:
+  - flex-1
+  - flex-sm-1
+  - flex-md-1
+  - flex-lg-1
+  - flex-xl-1
+  :auto:
+  - flex-auto
+  - flex-sm-auto
+  - flex-md-auto
+  - flex-lg-auto
+  - flex-xl-auto
+:align_self:
+  :auto:
+  - flex-self-auto
+  - flex-sm-self-auto
+  - flex-md-self-auto
+  - flex-lg-self-auto
+  - flex-xl-self-auto
+  :start:
+  - flex-self-start
+  - flex-sm-self-start
+  - flex-md-self-start
+  - flex-lg-self-start
+  - flex-xl-self-start
+  :end:
+  - flex-self-end
+  - flex-sm-self-end
+  - flex-md-self-end
+  - flex-lg-self-end
+  - flex-xl-self-end
+  :center:
+  - flex-self-center
+  - flex-sm-self-center
+  - flex-md-self-center
+  - flex-lg-self-center
+  - flex-xl-self-center
+  :baseline:
+  - flex-self-baseline
+  - flex-sm-self-baseline
+  - flex-md-self-baseline
+  - flex-lg-self-baseline
+  - flex-xl-self-baseline
+  :stretch:
+  - flex-self-stretch
+  - flex-sm-self-stretch
+  - flex-md-self-stretch
+  - flex-lg-self-stretch
+  - flex-xl-self-stretch
+:flex_grow:
+  0:
+  - flex-grow-0
+  - flex-sm-grow-0
+  - flex-md-grow-0
+  - flex-lg-grow-0
+  - flex-xl-grow-0
+:flex_shrink:
+  0:
+  - flex-shrink-0
+  - flex-sm-shrink-0
+  - flex-md-shrink-0
+  - flex-lg-shrink-0
+  - flex-xl-shrink-0