slither 0.99.5 → 0.99.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67bb6ad8dd4ac38f63231d77f9e366543cf9b11589e89760da6c85da9912995b
-  data.tar.gz: 9b7be1bf9747a39d72ee06097226676c2d7c7a634f56fcbb290bf5d665b23fbb
+  metadata.gz: 768c19e4aa4f4c50f7dc74b68c303e65f86fce7bdc5adc6c19a4f241a21efbd7
+  data.tar.gz: 990745fa073fb8422a527334849dff46dd6d263de739feefd4355c2ca7aea3b5
 SHA512:
-  metadata.gz: 72590afbfbceec05c54e67fa4f534c16207579a6fc3412ff19739e7ecc805864e044f6625b468827cb6dae7d627960a7b24895b25cced9b57ea5884bb217a82e
-  data.tar.gz: e695c7f0871aae93d0fb2ae8c8e7cd10e36737304f5f9b244009728f44153bd9028c6f3085c0c433eb6e703cb4ba558c11e27479e80c416d460448b5eeed8a38
+  metadata.gz: 27fbfe19454cfb409d21666261d3fc913a75e4cb4a4fc7f7c8e6500f66257f4cb364087a7554f97d225d869a3788c841e7f6940df0fe32e09875aae8e63e162b
+  data.tar.gz: 4a163683f0cea49ba1747a875b472feb825fe79fbc1d7c59f1ce0ff526a9d31ec0a49d8519b895ccea9cb3b9945875f6989e8cd6ec5bf9ad7bcce67f560a3f6e

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-rspec", "~> 2.22.0", require: false
+# Documentation tool
+gem "yard"

data/Gemfile.lock

@@ -14,7 +14,7 @@ GEM
     parallel (1.22.1)
     parser (3.2.0.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
@@ -46,18 +46,30 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler
   pry
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rspec (~> 2.22.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/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.6"
 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,7 +17,13 @@ module Slither
   class LineWrongSizeError < StandardError; end
   class SectionsNotSameLengthError < StandardError; 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)
     definition = Definition.new(options)
     yield(definition)
@@ -31,19 +35,20 @@ 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|
+    File.open(filename, "w") do |f|
       f.write generate(definition_name, data)
     end
   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')
     parseIo(file_io, definition_name)
@@ -52,6 +57,7 @@ module Slither
   def self.parseIo(io, definition_name)
     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

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: slither
 version: !ruby/object:Gem::Version
-  version: 0.99.5
+  version: 0.99.6
 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: 2024-01-22 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: