slither 0.99.5 → 0.99.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67bb6ad8dd4ac38f63231d77f9e366543cf9b11589e89760da6c85da9912995b
-  data.tar.gz: 9b7be1bf9747a39d72ee06097226676c2d7c7a634f56fcbb290bf5d665b23fbb
+  metadata.gz: 8b051e82db86d3c7b5e19f807d932b639be6d9a63f90cdd7a8eb3ea4b2a5bdad
+  data.tar.gz: f4888aa4cadca12afe03740ff902218d75c39bec16f2e542182e7eb85b6580ba
 SHA512:
-  metadata.gz: 72590afbfbceec05c54e67fa4f534c16207579a6fc3412ff19739e7ecc805864e044f6625b468827cb6dae7d627960a7b24895b25cced9b57ea5884bb217a82e
-  data.tar.gz: e695c7f0871aae93d0fb2ae8c8e7cd10e36737304f5f9b244009728f44153bd9028c6f3085c0c433eb6e703cb4ba558c11e27479e80c416d460448b5eeed8a38
+  metadata.gz: a3f1b0e492b6a39e89cfe2a0db34b649fda0794f744c212fcba1d0b4d40e8a5e830342db67ff9285b5b526ece0e2aaa1f2833218c999acd0f5c57e0b69e18dab
+  data.tar.gz: af9d062e3c0a4653cd1670f4e07fd85533c5dba52ad127062a8e2b5ea09f4bff742aed87f12369b70a536a041fb4ef235fec28ea96a5d2ab16750ca35008ca6e

data/.rubocop.yml

@@ -1,6 +1,12 @@
+require:
+  - rubocop-rspec
+
 AllCops:
     NewCops: enable
 
+Naming/BlockForwarding:
+  EnforcedStyle: explicit
+
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes
@@ -20,3 +26,21 @@ Metrics/MethodLength:
 
 Style/Documentation:
   Enabled: false
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: never
+
+RSpec/ContextWording:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MessageSpies:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NestedGroups:
+  Enabled: false
+RSpec/SubjectStub:
+  Enabled: false

data/Gemfile

@@ -5,8 +5,11 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in slither.gemspec
 gemspec
 
+gem "bundler"
+gem "pry"
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
+gem "rubocop", "~> 1.76.1"
+gem "rubocop-rspec", "~> 3.6.0", require: false
+# Documentation tool
+gem "yard"

data/Gemfile.lock

@@ -1,26 +1,30 @@
 PATH
   remote: .
   specs:
-    slither (0.99.5)
+    slither (0.99.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
+    ast (2.4.3)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    json (2.6.3)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     method_source (1.0.0)
-    parallel (1.22.1)
-    parser (3.2.0.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    prism (1.4.0)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
-    rexml (3.2.5)
+    regexp_parser (2.10.0)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -34,30 +38,41 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.45.1)
+    rubocop (1.76.1)
       json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.24.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.24.1)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.4.2)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.34)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler
   pry
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 1.21)
+  rubocop (~> 1.76.1)
+  rubocop-rspec (~> 3.6.0)
   slither!
+  yard
 
 BUNDLED WITH
    2.3.25

data/README.md

@@ -1,6 +1,8 @@
 # Slither
 by Ryan Wood http://ryanwood.com
 
+Documentation: https://www.rubydoc.info/gems/slither
+
 # Description:
 
 A simple, clean DSL for describing, writing, and parsing fixed-width text files.

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[spec] # rubocop still working on it

data/lib/slither/column.rb

@@ -1,4 +1,4 @@
-require 'date'
+require "date"
 
 module Slither
   class ParserError < RuntimeError; end

data/lib/slither/definition.rb

@@ -1,48 +1,96 @@
-module Slither
-  class Definition
-    attr_reader :sections, :templates, :options
-
-    def initialize(options = {})
-      @sections = []
-      @templates = {}
-      @options = { :align => :right, :by_bytes => true }.merge(options)
-    end
-
-    def section(name, options = {}, &block)
-      if section_using_reserved_name?(name) || section_already_defined?(name)
-        raise( ArgumentError, "Reserved or duplicate section name: '#{name}'")
-      end
-
-      section = Slither::Section.new(name, @options.merge(options))
-      section.definition = self
-
-      yield(section)
-
-      sections << section
-      section
-    end
-
-    def template(name, options = {}, &block)
-      section = Slither::Section.new(name, @options.merge(options))
-      yield(section)
-      @templates[name] = section
-    end
-
-    def method_missing(method, *args, &block)
-      section(method, *args, &block)
-    end
-
-    private
-
-    def section_using_reserved_name?(name)
-      Section::RESERVED_NAMES.include?(name)
-    end
-
-    def section_already_defined?(name)
-      return false if sections.empty?
-
-      section_names = sections.map(&:name)
-      section_names.include?(name)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Slither
+  # A Definition is the parent object that contains the information about how a fixed-width file is
+  # formatted. It contains a collection of sections, each of which contains a collection of fields.
+  class Definition
+    attr_reader :sections, :templates, :options
+
+    # Initializes a new Definition object.
+    #
+    # @param options [Hash] An optional hash of configuration options.
+    # @option options [Symbol] :align ( :right ) The alignment for fields, can be :left, :right, or :center.
+    # @option options [Boolean] :by_bytes ( true ) Whether to align fields by bytes or characters.
+    #
+    def initialize(options = {})
+      @sections = []
+      @templates = {}
+      @options = { align: :right, by_bytes: true }.merge(options)
+    end
+
+    # Defines a new Section within the Definition.
+    #
+    # @param name [String] The name of the section.
+    # @param options [Hash] An optional hash of section-specific configuration options.
+    # @yield [Section] A block for defining fields within the section.
+    # @yieldparam section [Section] The section object to be configured.
+    # @return [Section] The newly created section.
+    #
+    # @raise [ArgumentError] if the section name is reserved or already defined.
+    #
+    # @example Define a section for the "header" part of the fixed-width file.
+    #   definition.section(:header, align: :left) do |section|
+    #     # The trap tells Slither which lines should fall into this section
+    #     section.trap { |line| line[0,4] == 'HEAD' }
+    #     # Use the boundary template for the columns
+    #     section.template(:boundary)
+    #   end
+    #
+    def section(name, options = {}, &block)
+      if section_using_reserved_name?(name) || section_already_defined?(name)
+        raise ArgumentError, "Reserved or duplicate section name: '#{name}'"
+      end
+
+      section = Slither::Section.new(name, @options.merge(options))
+      section.definition = self
+
+      yield(section) if block
+
+      sections << section
+      section
+    end
+
+    # Defines a template, which can be reused to create multiple sections with the same configuration.
+    #
+    # @param name [String] The name of the template.
+    # @param options [Hash] An optional hash of template-specific configuration options.
+    # @yield [section] A block for configuring the template.
+    # @yieldparam section [Section] The template object to be configured.
+    #
+    # @example Define a template for the "boundary" part of the fixed-width file.
+    #   definition.template(:boundary) do |section|
+    #     section.column(:record_type, 4)
+    #     section.column(::company_id, 12)
+    #
+    def template(name, options = {}, &block)
+      section = Slither::Section.new(name, @options.merge(options))
+      yield(section) if block
+      @templates[name] = section
+    end
+
+    # Provides a way to define sections using method calls. For example,
+    #  you can call `my_section` instead of `section('my_section')`.
+    #
+    # @param method [Symbol] The name of the section.
+    # @param args [Array] Additional arguments.
+    # @param block [Block] A block for defining fields within the section.
+    # @return [Section] The newly created section.
+    #
+    def method_missing(method, *args, &block) # rubocop:disable Style/MissingRespondToMissing
+      section(method, *args, &block)
+    end
+
+    private
+
+    def section_using_reserved_name?(name)
+      Section::RESERVED_NAMES.include?(name)
+    end
+
+    def section_already_defined?(name)
+      return false if sections.empty?
+
+      section_names = sections.map(&:name)
+      section_names.include?(name)
+    end
+  end
+end

data/lib/slither/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Slither
-  VERSION = "0.99.5"
+  VERSION = "0.99.7"
 end

data/lib/slither.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require_relative 'slither/column'
-require_relative 'slither/definition'
-require_relative 'slither/generator'
-require_relative 'slither/parser'
-require_relative 'slither/section'
+require_relative "slither/column"
+require_relative "slither/definition"
+require_relative "slither/generator"
+require_relative "slither/parser"
+require_relative "slither/section"
 require_relative "slither/version"
 
 module Slither
   class Error < StandardError; end
-  # Your code goes here...
-
   class DuplicateColumnNameError < StandardError; end
   class RequiredSectionNotFoundError < StandardError; end
   class RequiredSectionEmptyError < StandardError; end
@@ -19,8 +17,26 @@ module Slither
   class LineWrongSizeError < StandardError; end
   class SectionsNotSameLengthError < StandardError; end
 
+  class << self
+    private
+
+    def definitions
+      @@definitions ||= {} # rubocop:disable Style/ClassVars
+    end
 
-  def self.define(name, options = {}, &block)
+    def definition(name)
+      definitions[name]
+    end
+  end
+
+  # Define a Slither's definition to parse a file.
+  #
+  # name - String name of the definition, this should be unique.
+  # options - Hash of options to pass to the definition.
+  #           Ex: by_bytes: true, to parse by bytes
+  #           Ex: align: :left, to align the columns to the left
+  # block - Block to define the sections of the definition. See README.md for more info.
+  def self.define(name, options = {}, &block) # rubocop:disable Lint/UnusedMethodArgument
     definition = Definition.new(options)
     yield(definition)
     definitions[name] = definition
@@ -31,38 +47,28 @@ module Slither
   def self.generate(definition_name, data)
     definition = definition(definition_name)
     raise ArgumentError, "Definition name '#{name}' was not found." unless definition
+
     generator = Generator.new(definition)
     generator.generate(data)
   end
 
   # Writes the File
   def self.write(filename, definition_name, data)
-    File.open(filename, 'w') do |f|
-      f.write generate(definition_name, data)
-    end
+    File.write(filename, generate(definition_name, data))
   end
 
   def self.parse(filename, definition_name)
-    raise ArgumentError, "File #{filename} does not exist." unless File.exists?(filename)
+    raise ArgumentError, "File #{filename} does not exist." unless File.exist?(filename)
 
-    file_io = File.open(filename, 'r')
+    file_io = File.open(filename, "r")
     parseIo(file_io, definition_name)
   end
 
-  def self.parseIo(io, definition_name)
+  def self.parseIo(io, definition_name) # rubocop:disable Naming/MethodName
     definition = definition(definition_name)
     raise ArgumentError, "Definition name '#{definition_name}' was not found." unless definition
+
     parser = Parser.new(definition, io)
     definition.options[:by_bytes] ? parser.parse_by_bytes : parser.parse
   end
-
-  private
-
-  def self.definitions
-    @@definitions ||= {}
-  end
-
-  def self.definition(name)
-    definitions[name]
-  end
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: slither
 version: !ruby/object:Gem::Version
-  version: 0.99.5
+  version: 0.99.7
 platform: ruby
 authors:
 - Ryan Wood
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-16 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '2.6'
+date: 2025-06-18 00:00:00.000000000 Z
+dependencies: []
 description:
 email:
 executables: []
@@ -76,10 +34,11 @@ files:
 - lib/slither/section.rb
 - lib/slither/version.rb
 - sig/slither.rbs
-homepage: https://github.com/JorgeGarciaxyz/slither
+homepage: https://github.com/ryanwood/slither
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -88,14 +47,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A simple, clean DSL for describing, writing, and parsing fixed-width text