textfsm 0.2.0

data/lib/textfsm/rule.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# Ruby port of Google TextFSM rules. Copyright 2010 Google Inc.
+# Modified in 2026. Licensed under Apache-2.0; see LICENSE.
+require_relative "errors"
+require_relative "pattern"
+
+module TextFSM
+  class Rule
+    LINE_ACTIONS = { "Continue" => :continue, "Next" => :next, "Error" => :error }.freeze
+    RECORD_ACTIONS = { "Clear" => :clear, "Clearall" => :clear_all, "Record" => :record, "NoRecord" => :no_record }.freeze
+    OPERATIONS = (LINE_ACTIONS.keys + RECORD_ACTIONS.keys).freeze
+    TARGET = '(?:[\p{L}\p{N}_]+|".*")'
+    ACTION = /\A\s+(?<line>Continue|Next|Error)(?:\.(?<record>Clear|Clearall|Record|NoRecord))?(?:\s+(?<target>#{TARGET}))?\z/
+    RECORD_ACTION = /\A\s+(?<record>Clear|Clearall|Record|NoRecord)(?:\s+(?<target>#{TARGET}))?\z/
+    STATE_ACTION = /\A(?:\s+(?<target>#{TARGET}))?\z/
+    private_constant :LINE_ACTIONS, :RECORD_ACTIONS, :TARGET, :ACTION, :RECORD_ACTION, :STATE_ACTION
+
+    attr_reader :source, :pattern, :line_number, :line_action, :record_action, :next_state, :error_message
+
+    def initialize(line, line_number:, fields:)
+      @line_number = line_number
+      @line_action = :next
+      @record_action = :no_record
+      @next_state = @error_message = nil
+      @action_source = ""
+      line = line.strip
+      action = /\A(.*)\s->(.*)\z/.match(line)
+      @source = (action ? action[1] : line).freeze
+      @pattern = Pattern.new(substitute(@source, fields))
+      parse_action(action[2]) if action
+      freeze
+    rescue TemplateError => e
+      raise TemplateError, "#{e.message}. Line: #{@line_number}."
+    end
+
+    def to_s
+      "  #{@source}#{" -> #{@action_source}" unless @action_source.empty?}"
+    end
+
+    private
+
+    def substitute(text, fields)
+      text.gsub(/\$(?:\$|\{[a-zA-Z_][a-zA-Z_0-9]*\}|[a-zA-Z_][a-zA-Z_0-9]*|)/) do |token|
+        next "$" if token == "$$"
+
+        name = token[1] == "{" ? token[2...-1] : token[1..]
+        fields.fetch(name) { raise TemplateError, "Invalid variable substitution #{token.inspect}" }.capture_source
+      end
+    end
+
+    def parse_action(action)
+      match = ACTION.match(action) || RECORD_ACTION.match(action) || STATE_ACTION.match(action)
+      raise TemplateError, "Badly formatted rule action #{action.inspect}" unless match
+
+      parts = match.named_captures
+      @line_action = LINE_ACTIONS.fetch(parts["line"], :next)
+      @record_action = RECORD_ACTIONS.fetch(parts["record"], :no_record)
+      target = parts["target"]&.freeze
+      raise TemplateError, "Continue cannot specify a new state" if @line_action == :continue && target
+      raise TemplateError, "Only Error can specify a quoted message" if @line_action != :error && target&.start_with?('"')
+
+      if @line_action == :error
+        @error_message = target
+      else
+        @next_state = target
+      end
+      operation = [parts["line"], parts["record"]].compact.join(".")
+      @action_source = [operation, target].compact.reject(&:empty?).join(" ").freeze
+    end
+  end
+end

data/lib/textfsm/table.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require_relative "data"
+
+module TextFSM
+  class Table
+    include Enumerable
+
+    attr_reader :header, :rows
+
+    def initialize(header = [], rows = [])
+      raise ArgumentError, "Header and rows must be Arrays" unless header.is_a?(Array) && rows.is_a?(Array) && rows.all?(Array)
+      raise ArgumentError, "Duplicate table columns" unless header.uniq == header
+      raise ArgumentError, "Rows must have one value per column" unless rows.all? { |row| row.size == header.size }
+
+      @header = Data.copy(header, immutable: true)
+      @rows = Data.copy(rows, immutable: true)
+    end
+
+    def each(&)
+      return enum_for(__method__) { size } unless block_given?
+
+      @rows.each(&)
+      self
+    end
+
+    def size
+      @rows.size
+    end
+
+    def empty?
+      @rows.empty?
+    end
+
+    def [](index)
+      @rows[index]
+    end
+
+    def to_a
+      Data.copy(@rows)
+    end
+
+    def to_hashes
+      to_a.map { |row| @header.zip(row).to_h }
+    end
+
+    def to_s
+      ([@header] + @rows).map { |row| "#{row.join(', ')}\n" }.join
+    end
+
+    # Keep left rows, add new columns, and use the first matching right row.
+    # Without keys, align by position. Missing matches receive empty values.
+    def merge(other, keys: [])
+      dup.merge!(other, keys: keys)
+    end
+
+    def merge!(other, keys: [])
+      missing = (keys - @header) | (keys - other.header)
+      raise KeyError, "Unknown key columns: #{missing.join(', ')}" unless missing.empty?
+
+      columns = other.header - @header
+      return self if columns.empty?
+
+      right_columns = columns.map { |column| other.header.index(column) }
+      left_keys = keys.map { |key| @header.index(key) }
+      right_keys = keys.map { |key| other.header.index(key) }
+      lookup = {}
+      unless keys.empty?
+        other.each do |row|
+          lookup[row.values_at(*right_keys)] ||= row
+        end
+      end
+      rows = @rows.each_with_index.map do |row, index|
+        right = keys.empty? ? other[index] : lookup[row.values_at(*left_keys)]
+        row + (right ? right.values_at(*right_columns) : Array.new(columns.size, ""))
+      end
+      header = Data.copy(@header + columns, immutable: true)
+      rows = Data.copy(rows, immutable: true)
+      @header = header
+      @rows = rows
+      self
+    end
+
+    def sort!(&)
+      @rows = @rows.sort(&).freeze
+      self
+    end
+
+    def sort_by!(&)
+      return enum_for(__method__) { size } unless block_given?
+
+      @rows = @rows.sort_by(&).freeze
+      self
+    end
+  end
+end

data/lib/textfsm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TextFSM
+  VERSION = "0.2.0"
+end

data/lib/textfsm.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "textfsm/version"
+require_relative "textfsm/parser"
+require_relative "textfsm/cli_table"

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: textfsm
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- TextFSM Ruby contributors
+bindir: exe
+cert_chain: []
+date: 2026-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: strscan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Parses semi-structured text using Google TextFSM template syntax, with
+  field options, state transitions, and CLI template indexes.
+executables:
+- textfsm
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- NOTICE
+- README.md
+- examples/cisco_bgp_summary_example
+- examples/cisco_bgp_summary_template
+- examples/cisco_ipv6_interface_example
+- examples/cisco_ipv6_interface_template
+- examples/cisco_version_example
+- examples/cisco_version_template
+- examples/f10_ip_bgp_summary_example
+- examples/f10_ip_bgp_summary_template
+- examples/f10_version_example
+- examples/f10_version_template
+- examples/index
+- examples/juniper_bgp_summary_example
+- examples/juniper_bgp_summary_template
+- examples/juniper_version_example
+- examples/juniper_version_template
+- examples/unix_ifcfg_example
+- examples/unix_ifcfg_template
+- exe/textfsm
+- lib/textfsm.rb
+- lib/textfsm/cli.rb
+- lib/textfsm/cli_table.rb
+- lib/textfsm/data.rb
+- lib/textfsm/errors.rb
+- lib/textfsm/field.rb
+- lib/textfsm/index_table.rb
+- lib/textfsm/options.rb
+- lib/textfsm/parser.rb
+- lib/textfsm/pattern.rb
+- lib/textfsm/rule.rb
+- lib/textfsm/table.rb
+- lib/textfsm/version.rb
+homepage: https://github.com/gatework/textfsm
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/gatework/textfsm
+  bug_tracker_uri: https://github.com/gatework/textfsm/issues
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.12
+specification_version: 4
+summary: A Ruby state machine for parsing text with TextFSM templates
+test_files: []