remlint 0.1.0

data/tasks/generate_tables.rb

@@ -0,0 +1,175 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Regenerates lib/remlint/tables.rb from the Remind C sources.
+#
+# Every fact the linter asserts about Remind's vocabulary -- which keywords
+# exist, how far each may be abbreviated, which functions take how many
+# arguments, which system variables are writable and over what range -- is
+# transcribed from the tables Remind itself dispatches on:
+#
+#   src/token.c  TokArray[]    keyword, minimum abbreviation length, type
+#   src/funcs.c  Func[]        builtin name, min args, max args
+#   src/var.c    SysVarArr[]   $SysVar name, modifiable flag, type, min, max
+#
+# Hand-maintaining that vocabulary would guarantee drift the first time Remind
+# gains a function. Run this against a Remind checkout instead:
+#
+#   ruby tasks/generate_tables.rb /path/to/remind
+#
+# The generated file is committed, so the gem builds and tests without a
+# Remind checkout present.
+
+require "pathname"
+
+SOURCE_ROOT = Pathname.new(ARGV.fetch(0, "..")).expand_path
+OUTPUT      = Pathname.new(__dir__).join("../lib/remlint/tables.rb").cleanpath
+
+# `{ "banner", 3, T_Banner, 0 },` -- name, minimum abbreviation length, type.
+TOKEN_ROW = /^\s*\{\s*"([a-z0-9-]+)"\s*,\s*(\d+)\s*,\s*(T_\w+)\s*,/
+
+# `{ "ampm", 1, 4, 1, FAmpm, NULL },` -- name, min args, max args.
+# NO_MAX_ARGS (127) is Remind's "variadic" sentinel.
+FUNC_ROW = /^\s*\{\s*"([a-z0-9_]+)"\s*,\s*(\d+|NO_MAX_ARGS)\s*,\s*(\d+|NO_MAX_ARGS)\s*,/
+
+# `{"FormWidth", 1, INT_TYPE, &FormWidth, 20, 500 },`
+# -- name, modifiable, type, value, min, max. The min/max columns only bound
+# anything for INT_TYPE; for the other types they are 0/0 filler.
+SYSVAR_ROW = /^\s*\{\s*"(\w+)"\s*,\s*([01])\s*,\s*(\w+)\s*,\s*[^,]+,\s*([^,]+),\s*([^}]+)\}/
+
+NO_MAX_ARGS = 127
+
+def read_source(relative)
+  path = SOURCE_ROOT.join(relative)
+
+  unless path.exist?
+    abort "#{path} not found; pass the root of a Remind checkout as ARGV[0]"
+  end
+
+  path.read
+end
+
+def scan(relative, pattern)
+  read_source(relative).each_line.filter_map do |line|
+    match = line.match(pattern)
+
+    if match
+      yield match
+    end
+  end
+end
+
+def parse_arg_count(text)
+  if text == "NO_MAX_ARGS"
+    NO_MAX_ARGS
+  else
+    Integer(text)
+  end
+end
+
+# Only INT_TYPE variables carry a real range, and only when the two columns
+# actually differ -- `0, 0` is Remind's filler, not a variable pinned to zero.
+def parse_bounds(type, min, max)
+  if type == "INT_TYPE" && min.strip.match?(/\A-?\d+\z/) && max.strip.match?(/\A-?\d+\z/) && min.strip != max.strip
+    [Integer(min.strip), Integer(max.strip)]
+  else
+    [nil, nil]
+  end
+end
+
+def literal(value)
+  case value
+  when nil    then "nil"
+  when String then value.inspect
+  else value.to_s
+  end
+end
+
+def render_rows(rows, columns)
+  widths = columns.to_h do |column|
+    [column, rows.map { |row| literal(row[column]).length }.max]
+  end
+
+  rows.map do |row|
+    cells = columns.map do |column|
+      literal(row[column]).ljust(widths.fetch(column))
+    end
+
+    "      [#{cells.join(', ')}],"
+  end
+end
+
+keywords = scan("src/token.c", TOKEN_ROW) do |match|
+  {
+    name:   match[1].upcase,
+    minlen: Integer(match[2]),
+    type:   match[3],
+  }
+end
+
+functions = scan("src/funcs.c", FUNC_ROW) do |match|
+  {
+    name: match[1],
+    min:  parse_arg_count(match[2]),
+    max:  parse_arg_count(match[3]),
+  }
+end
+
+sysvars = scan("src/var.c", SYSVAR_ROW) do |match|
+  min, max = parse_bounds(match[3], match[4], match[5])
+
+  {
+    name:       match[1],
+    modifiable: match[2] == "1",
+    type:       match[3],
+    min:        min,
+    max:        max,
+  }
+end
+
+# src/version.h.in holds an unsubstituted @VERSION@ placeholder in a source
+# tree that has not been configured, so take the number from its origin.
+version = read_source("configure.ac")[/AC_INIT\(\s*remind\s*,\s*([^,\s)]+)/, 1] || "unknown"
+
+body = <<~GENERATED
+  # frozen_string_literal: true
+
+  # GENERATED FILE -- do not edit by hand.
+  #
+  # Transcribed from Remind #{version} by tasks/generate_tables.rb, which reads
+  # the same tables the interpreter dispatches on (src/token.c, src/funcs.c,
+  # src/var.c). Regenerate rather than patch:
+  #
+  #   ruby tasks/generate_tables.rb /path/to/remind
+  module RemLint
+    # Remind's vocabulary, exactly as the interpreter knows it.
+    module Tables
+      # Remind's variadic sentinel: `char(...)` and friends take any number of
+      # arguments above their minimum.
+      NO_MAX_ARGS = #{NO_MAX_ARGS}
+
+      # [keyword, minimum abbreviation length, token type]. Remind accepts any
+      # prefix at least `minlen` characters long, which is why `INC` is
+      # `INCLUDE` and `SCAN` is `SCANFROM`.
+      KEYWORD_ROWS = [
+  #{render_rows(keywords, %i[name minlen type]).join("\n")}
+      ].freeze
+
+      # [name, minimum arguments, maximum arguments].
+      FUNCTION_ROWS = [
+  #{render_rows(functions, %i[name min max]).join("\n")}
+      ].freeze
+
+      # [name, modifiable, type, minimum, maximum]. Non-modifiable variables
+      # are readable but reject `SET`; the bounds are populated only for the
+      # integer-valued variables Remind range-checks.
+      SYSVAR_ROWS = [
+  #{render_rows(sysvars, %i[name modifiable type min max]).join("\n")}
+      ].freeze
+    end
+  end
+GENERATED
+
+OUTPUT.write(body)
+
+puts "#{OUTPUT}: #{keywords.size} keywords, #{functions.size} functions, #{sysvars.size} system variables"

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: remlint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nathan Kidd
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.88'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.88'
+- !ruby/object:Gem::Dependency
+  name: scampi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  RemLint checks Remind reminder files for style, consistency and structure:
+  unbalanced IF/ENDIF blocks, mistyped $SysVars, wrong argument counts,
+  continuations that do not continue, and trailing whitespace that breaks
+  rem2ps. Its vocabulary is transcribed from Remind's own dispatch tables, so
+  keyword abbreviations and function arities match the interpreter exactly.
+
+  It reads Remind out of shell heredocs as well as .rem files, and reports
+  line numbers in the enclosing file.
+email: nathanblenheimkidd@gmail.com
+executables:
+- remlint
+extensions: []
+extra_rdoc_files:
+- docs/remlint.md
+files:
+- LICENSE
+- config/default.yml
+- docs/remlint-rules.md
+- docs/remlint.md
+- exe/remlint
+- lib/remlint.rb
+- lib/remlint/cli.rb
+- lib/remlint/command.rb
+- lib/remlint/config.rb
+- lib/remlint/date_literal.rb
+- lib/remlint/document.rb
+- lib/remlint/expr_lexer.rb
+- lib/remlint/extractors.rb
+- lib/remlint/formatter.rb
+- lib/remlint/invocation.rb
+- lib/remlint/logical_line.rb
+- lib/remlint/offense.rb
+- lib/remlint/rule.rb
+- lib/remlint/rules.rb
+- lib/remlint/rules/addomit_without_scanfrom.rb
+- lib/remlint/rules/advance_warning_body.rb
+- lib/remlint/rules/banner_placement.rb
+- lib/remlint/rules/calendar_text_limited.rb
+- lib/remlint/rules/callback_signature.rb
+- lib/remlint/rules/clause_needs_full_date.rb
+- lib/remlint/rules/clause_requires_at.rb
+- lib/remlint/rules/clause_value_range.rb
+- lib/remlint/rules/color_component_range.rb
+- lib/remlint/rules/coordinate_not_string.rb
+- lib/remlint/rules/dangling_continuation.rb
+- lib/remlint/rules/date_out_of_range.rb
+- lib/remlint/rules/debug_command.rb
+- lib/remlint/rules/easterdate_from_today.rb
+- lib/remlint/rules/function_arity.rb
+- lib/remlint/rules/function_redefinition.rb
+- lib/remlint/rules/generated_file_edited.rb
+- lib/remlint/rules/hebrew_date.rb
+- lib/remlint/rules/iftrig_with_satisfy.rb
+- lib/remlint/rules/include_path.rb
+- lib/remlint/rules/info_clause.rb
+- lib/remlint/rules/info_substitution_without_header.rb
+- lib/remlint/rules/invocation_mismatch.rb
+- lib/remlint/rules/keyword_case.rb
+- lib/remlint/rules/license_header.rb
+- lib/remlint/rules/line_length.rb
+- lib/remlint/rules/literal_type_mismatch.rb
+- lib/remlint/rules/localization_pack.rb
+- lib/remlint/rules/moon_phase_argument.rb
+- lib/remlint/rules/omit_aware_delta.rb
+- lib/remlint/rules/push_vars_missing_name.rb
+- lib/remlint/rules/repeat_trigger.rb
+- lib/remlint/rules/satisfy_constraint.rb
+- lib/remlint/rules/shell_maxlen.rb
+- lib/remlint/rules/shell_use_while_run_disabled.rb
+- lib/remlint/rules/string_escape.rb
+- lib/remlint/rules/syntax.rb
+- lib/remlint/rules/system_variable_assignment.rb
+- lib/remlint/rules/tag_syntax.rb
+- lib/remlint/rules/text_after_eof_marker.rb
+- lib/remlint/rules/time_zone_name.rb
+- lib/remlint/rules/tk_tag_namespace.rb
+- lib/remlint/rules/todo_complete_through.rb
+- lib/remlint/rules/trailing_whitespace.rb
+- lib/remlint/rules/translate_command.rb
+- lib/remlint/rules/unbalanced_blocks.rb
+- lib/remlint/rules/unbalanced_delimiters.rb
+- lib/remlint/rules/unknown_special_type.rb
+- lib/remlint/rules/unknown_substitution_sequence.rb
+- lib/remlint/rules/unknown_system_variable.rb
+- lib/remlint/rules/unquoted_shell_substitution.rb
+- lib/remlint/rules/until_before_from.rb
+- lib/remlint/rules/world_writable_script.rb
+- lib/remlint/runner.rb
+- lib/remlint/source.rb
+- lib/remlint/tables.rb
+- lib/remlint/trigger.rb
+- lib/remlint/version.rb
+- lib/remlint/vocabulary.rb
+- tasks/generate_tables.rb
+homepage: https://dianne.skoll.ca/projects/remind/
+licenses:
+- GPL-2.0-only
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: A style and consistency linter for Remind reminder files
+test_files: []