ruby_native 0.17.2 → 0.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a20e456fe2c38a3885bd29bc796da70a6ef238bf30de87297ca14f9f407d783d
-  data.tar.gz: b266e12b4c911bb57ba5c21eb6748f270a13a7449e27296fb5bf5fefb4b20d96
+  metadata.gz: 0c51153c763a49fbf4d88fa288adcfe46ef69402685a9ccc8ccdf9bfe9b35da8
+  data.tar.gz: 624eb747e1fccc0bf7e14d7b4a96822ea98fbd69ff9902cca01920e29997ac28
 SHA512:
-  metadata.gz: 7a59080e79c82b040910d146ad1b3f214ef247a1f251783ba951400bf099bc1f161b41195b2230bb0da977988ae7850be1be6aff1e4f89c16a539b7b7dcef8f3
-  data.tar.gz: 289783ff033617cc3b77f697334e861985f98786562d978b923118c56638c0411931df89929bf9c771cbe77a88d71f38d6f177fbb1762c66badfdb039fa7379c
+  metadata.gz: a4fe11e26a297f5ce16e995ad2892c5da65ba14b9703e0ea1c5f6bf1659bb43f3dfb18cdee60667159e71c8f4ca56dc44f8f7a731ce292f41416e15c46355525
+  data.tar.gz: 8d71d20c92e2a9203d2948df069ea4ed1fb6b20e6f76a13e38bcd67dfbd860c4982829f21fba5f2102cf145cc60bf97397d348c7ce5da2ad65de5b96ea1d93a7

data/config/signals.yml

@@ -7,6 +7,15 @@
 #
 # `owner: shell` marks a signal the app writes into the page rather than one
 # your views emit.
+#
+# `helper` names the helper that can emit the signal; `always: true` means every
+# call to that helper emits it. Without `always`, `check` cannot count a helper
+# call against the signal: native_fab_tag emits data-native-color only when you
+# pass `color:`, so counting it would report markup the view never renders.
+#
+# `renders_when` covers the helpers that can render nothing at all, naming the
+# keyword values they need in order to emit anything. A call that passes
+# something else, or something only known at request time, is left uncounted.
 ---
 signals:
   data-native-action:
@@ -19,6 +28,7 @@ signals:
   data-native-badge:
     since: "0.3.2"
     helper: native_badge_tag
+    always: true
     singleton: true
   data-native-badge-home:
     since: "0.3.2"
@@ -42,50 +52,63 @@ signals:
   data-native-fab:
     since: "0.8.0"
     helper: native_fab_tag
+    always: true
     singleton: true
   data-native-form:
     since: "0.1.2"
     helper: native_form_tag
+    always: true
     singleton: true
   data-native-haptic:
     since: "0.2.7"
     helper: native_haptic_data
+    always: true
   data-native-href:
     since: "0.4.0"
     helper: native_fab_tag
   data-native-icon:
     since: "0.4.0"
     helper: native_fab_tag
+    always: true
   data-native-identity:
     since: "0.12.0"
     helper: native_identity_tag
+    always: true
     singleton: true
   data-native-keyboard-toolbar:
     since: "0.15.0"
     helper: native_keyboard_tag
+    always: true
+    renders_when:
+      toolbar: false
     singleton: true
   data-native-menu:
     since: "0.14.0"
     helper: native_menu_tag
+    always: true
   data-native-menu-item:
     since: "0.4.0"
   data-native-navbar:
     since: "0.4.0"
     helper: native_navbar_tag
+    always: true
     singleton: true
   data-native-overscroll-bottom:
     since: "0.5.0"
     helper: native_overscroll_tag
+    always: true
     singleton: true
   data-native-overscroll-top:
     since: "0.5.0"
     helper: native_overscroll_tag
+    always: true
     singleton: true
   data-native-position:
     since: "0.4.0"
   data-native-presentation:
     since: "0.11.2"
     helper: native_presentation_tag
+    always: true
     singleton: true
   data-native-price:
     since: "0.5.3"
@@ -97,12 +120,14 @@ signals:
   data-native-push:
     since: "0.1.2"
     helper: native_push_tag
+    always: true
     singleton: true
   data-native-restore:
     since: "0.5.3"
   data-native-review:
     since: "0.9.3"
     helper: native_review_tag
+    always: true
   data-native-segment:
     since: "0.10.12"
   data-native-selected:
@@ -120,6 +145,9 @@ signals:
   data-native-tabs:
     since: "0.1.2"
     helper: native_tabs_tag
+    always: true
+    renders_when:
+      enabled: true
     singleton: true
   data-native-title:
     since: "0.4.0"

data/lib/ruby_native/cli/check/signal_collector.rb

@@ -1,29 +1,131 @@
+require "prism"
+
 module RubyNative
   class CLI
     class Check
-      # Walks a parsed template and records every data-native-* attribute with
-      # the lines it appears on. Attribute names built out of ERB cannot be
-      # resolved statically and are skipped rather than guessed at.
+      # Walks a parsed template and records every data-native-* signal with the
+      # lines it appears on, whether the view writes the attribute by hand or
+      # calls the helper that emits it. Attribute names built out of ERB cannot
+      # be resolved statically and are skipped rather than guessed at.
       #
       # Subclasses Herb::Visitor, so this file is only loaded once `herb` is
       # known to be present.
       class SignalCollector < Herb::Visitor
-        attr_reader :signals
+        COMMENT_OPENING = "<%#".freeze
 
         def initialize
           @signals = {}
           super
         end
 
+        # Attributes and helper calls arrive from different visits, so the lines
+        # for one signal are not collected in document order.
+        def signals
+          @signals.transform_values(&:sort)
+        end
+
         def visit_html_attribute_name_node(node)
           name = node.children.filter_map { |child| child.content if child.respond_to?(:content) }.join
 
-          if name.start_with?("data-native-")
-            (@signals[name] ||= []) << node.location.start.line
-          end
+          record(name, node.location.start.line) if name.start_with?("data-native-")
+
+          super
+        end
+
+        def visit_erb_content_node(node)
+          record_helper_calls(node)
+
+          super
+        end
+
+        # `<%= native_navbar_tag "Orders" do |navbar| %>` opens a block, so its
+        # Ruby arrives here instead, without the `end` that would let it parse
+        # on its own.
+        def visit_erb_block_node(node)
+          record_helper_calls(node, suffix: "\nend")
 
           super
         end
+
+        private
+
+        def record_helper_calls(node, suffix: "")
+          return if node.tag_opening&.value == COMMENT_OPENING
+
+          source = node.content&.value
+          return if source.nil?
+
+          # Ruby that does not parse is the app's own syntax error, which Rails
+          # raises on render and `herb lint` reports properly. Staying quiet
+          # here keeps `check` to the one job it claims.
+          result = Prism.parse(source + suffix)
+          return unless result.success?
+
+          line = node.location.start.line
+          calls(result.value).each do |call|
+            helper = call.name.to_s
+            signals = RubyNative::Signals.signals_for_helper(helper)
+            next if signals.empty? || !renders?(call, helper)
+
+            signals.each { |signal| record(signal, line) }
+          end
+        end
+
+        # A helper that can render nothing only counts when its arguments prove
+        # it renders. `native_tabs_tag(enabled: @show)` decides at request time,
+        # so it is skipped rather than guessed at, the same as an attribute name
+        # built out of ERB.
+        def renders?(call, helper)
+          condition = RubyNative::Signals.render_condition(helper)
+          return true unless condition
+
+          condition.all? do |keyword, required|
+            given = keyword_value(call, keyword)
+
+            given.nil? ? true : given == required
+          end
+        end
+
+        # nil when the keyword is absent, which leaves the helper's own default
+        # in charge. :unknown for anything that is not a literal, so it never
+        # equals what the condition requires.
+        def keyword_value(call, keyword)
+          pairs = call.arguments&.arguments&.grep(Prism::KeywordHashNode)&.flat_map(&:elements)
+          return nil if pairs.nil?
+
+          assoc = pairs.find do |pair|
+            pair.is_a?(Prism::AssocNode) && pair.key.is_a?(Prism::SymbolNode) &&
+              pair.key.unescaped == keyword.to_s
+          end
+          return nil unless assoc
+
+          case assoc.value
+          when Prism::TrueNode then true
+          when Prism::FalseNode then false
+          else :unknown
+          end
+        end
+
+        # A literal in an argument is not a call, so `placeholder: "native_tabs_tag"`
+        # reads as the string it is. That is the whole reason for parsing rather
+        # than scanning the source for helper names.
+        def calls(root)
+          found = []
+          stack = [root]
+
+          while (node = stack.pop)
+            next unless node.is_a?(Prism::Node)
+
+            found << node if node.is_a?(Prism::CallNode)
+            stack.concat(node.compact_child_nodes)
+          end
+
+          found
+        end
+
+        def record(name, line)
+          (@signals[name] ||= []) << line
+        end
       end
     end
   end

data/lib/ruby_native/signals.rb

@@ -41,6 +41,45 @@ module RubyNative
         all.dig(name, "helper")
       end
 
+      # Signals a helper emits on every call, keyed by helper name. Only
+      # `always` signals are listed: native_fab_tag can emit data-native-color,
+      # but only when you pass `color:`, so counting it against a call would
+      # have `check` report markup the view never renders.
+      def helper_signals
+        @helper_signals ||= begin
+          map = {}
+          all.each do |name, meta|
+            helper = meta["helper"]
+            (map[helper] ||= []) << name if helper && meta["always"]
+          end
+          map.freeze
+        end
+      end
+
+      def signals_for_helper(helper)
+        helper_signals.fetch(helper, [])
+      end
+
+      # The keyword values a helper needs in order to render at all, keyed by
+      # helper name. native_tabs_tag(enabled: false) returns an empty string, so
+      # `always` alone would count a call that never reaches the page.
+      def render_conditions
+        @render_conditions ||= begin
+          map = {}
+          all.each do |_name, meta|
+            helper = meta["helper"]
+            next unless helper && meta["always"] && meta["renders_when"]
+
+            (map[helper] ||= {}).merge!(meta["renders_when"])
+          end
+          map.freeze
+        end
+      end
+
+      def render_condition(helper)
+        render_conditions[helper]
+      end
+
       # Closest known signal within one or two edits, for "did you mean". A
       # genuinely unrelated attribute gets no suggestion rather than a
       # confusing one.

data/lib/ruby_native/version.rb

@@ -1,3 +1,3 @@
 module RubyNative
-  VERSION = "0.17.2"
+  VERSION = "0.17.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_native
 version: !ruby/object:Gem::Version
-  version: 0.17.2
+  version: 0.17.3
 platform: ruby
 authors:
 - Joe Masilotti