slither 0.99.4 → 0.99.5

data/lib/slither/generator.rb

@@ -1,26 +1,46 @@
-class Slither
-  class Generator
-		
-		def initialize(definition)
-			@definition = definition
-		end
-		
-		def generate(data)
-	    @builder = []
-	    @definition.sections.each do |section|
-	      content = data[section.name]
-	      if content
-  	      content = [content] unless content.is_a?(Array)
-  	      raise(Slither::RequiredSectionEmptyError, "Required section '#{section.name}' was empty.") if content.empty?
-  	      content.each do |row|
-  	        @builder << section.format(row)
-  	      end
-  	    else
-  	      raise(Slither::RequiredSectionEmptyError, "Required section '#{section.name}' was empty.") unless section.optional
-	      end
-	    end
-	    @builder.join("\n")
-		end
-		
-	end
-end
+# frozen_string_literal: true
+
+module Slither
+  class Generator
+    def initialize(definition)
+      @definition = definition
+    end
+
+    def generate(data)
+      @builder = []
+
+      sections.each do |section|
+        content = data[section.name]
+
+        if content
+          content = [content] unless content.is_a?(Array)
+
+          raise_required_section_empty(section) if content.empty?
+
+          content.each do |row|
+            builder << section.format(row)
+          end
+        else
+          raise_required_section_empty(section) unless section.optional
+        end
+      end
+
+      builder.join("\n")
+    end
+
+    private
+
+    attr_reader :definition, :builder
+
+    def sections
+      definition.sections
+    end
+
+    def raise_required_section_empty(section)
+      raise(
+        Slither::RequiredSectionEmptyError,
+        "Required section '#{section.name}' was empty."
+      )
+    end
+  end
+end

data/lib/slither/parser.rb

@@ -1,53 +1,118 @@
-class Slither
-  class Parser
-        
-    def initialize(definition, file)
-      @definition = definition
-      @file = file
-      # This may be used in the future for non-linear or repeating sections
-      @mode = :linear
-    end
-    
-    def parse()
-      @parsed = {}
-      @content = read_file      
-      unless @content.empty?
-        @definition.sections.each do |section|
-          rows = fill_content(section)
-          raise(Slither::RequiredSectionNotFoundError, "Required section '#{section.name}' was not found.") unless rows > 0 || section.optional
-        end
-      end
-      @parsed
-    end
-    
-    private
-    
-      def read_file
-        content = []
-        File.open(@file, 'r') do |f|
-          while (line = f.gets) do
-            content << line
-          end
-        end
-        content
-      end
-      
-      def fill_content(section)
-        matches = 0
-        loop do
-          line = @content.first
-          break unless section.match(line) 
-          add_to_section(section, line)
-          matches += 1
-          @content.shift
-        end
-        matches
-      end
-      
-      def add_to_section(section, line)
-        @parsed[section.name] = [] unless @parsed[section.name]
-        @parsed[section.name] << section.parse(line)
-      end
-    
-  end
-end
+module Slither
+  class Parser
+    def initialize(definition, file_io)
+      @definition = definition
+      @file = file_io
+      # This may be used in the future for non-linear or repeating sections
+      @mode = :linear
+    end
+
+    def parse
+      parsed = {}
+
+      @file.each_line do |line|
+        line&.chomp!
+
+        next if line.empty?
+
+        @definition.sections.each do |section|
+          if section.match(line)
+            validate_length(line, section)
+            parsed = fill_content(line, section, parsed)
+          end
+        end
+      end
+
+      @definition.sections.each do |section|
+        unless parsed[section.name] || section.optional
+          raise(Slither::RequiredSectionNotFoundError,
+                "Required section '#{section.name}' was not found.")
+        end
+      end
+      parsed
+    end
+
+    def parse_by_bytes
+      parsed = {}
+
+      all_section_lengths = @definition.sections.map(&:length)
+      byte_length = all_section_lengths.max
+      all_section_lengths.each do |bytes|
+        next unless bytes != byte_length
+
+        raise(
+          Slither::SectionsNotSameLengthError, "All sections must have the same number of bytes for parse by bytes"
+        )
+      end
+
+      while (record = @file.read(byte_length))
+
+        unless remove_newlines! && byte_length == record.length
+          parsed_line = parse_for_error_message(record)
+          raise(Slither::LineWrongSizeError, "Line wrong size: No newline at #{byte_length} bytes. #{parsed_line}")
+        end
+
+        record.force_encoding(@file.external_encoding)
+
+        @definition.sections.each do |section|
+          parsed = fill_content(record, section, parsed) if section.match(record)
+        end
+      end
+
+      @definition.sections.each do |section|
+        unless parsed[section.name] || section.optional
+          raise(Slither::RequiredSectionNotFoundError,
+                "Required section '#{section.name}' was not found.")
+        end
+      end
+      parsed
+    end
+
+    private
+
+    def fill_content(line, section, parsed)
+      parsed[section.name] ||= []
+      parsed[section.name] << section.parse(line)
+      parsed
+    end
+
+    def validate_length(line, section)
+      return unless line.length != section.length
+
+      parsed_line = parse_for_error_message(line)
+      raise Slither::LineWrongSizeError,
+            "Line wrong size: (#{line.length} when it should be #{section.length}. #{parsed_line})"
+    end
+
+    def remove_newlines!
+      return true if @file.eof?
+
+      b = @file.getbyte
+
+      if b == 10 || (b == 13 && @file.getbyte == 10)
+        true
+      else
+        @file.ungetbyte b
+        false
+      end
+    end
+
+    def newline?(char_code)
+      # \n or LF -> 10
+      # \r or CR -> 13
+      [10, 13].any? { |code| char_code == code }
+    end
+
+    def parse_for_error_message(line)
+      parsed = ""
+
+      line.force_encoding(@file.external_encoding)
+
+      @definition.sections.each do |section|
+        parsed = section.parse_when_problem(line) if section.match(line)
+      end
+
+      parsed
+    end
+  end
+end

data/lib/slither/section.rb

@@ -1,54 +1,64 @@
-class Slither
+module Slither
   class Section
     attr_accessor :definition, :optional
-    attr_reader :name, :columns, :options
-    
+    attr_reader :name, :columns, :options, :length
+
     RESERVED_NAMES = [:spacer]
-    
+
     def initialize(name, options = {})
       @name = name
       @options = options
       @columns = []
       @trap = options[:trap]
       @optional = options[:optional] || false
+      @length = 0
     end
-    
+
     def column(name, length, options = {})
       raise(Slither::DuplicateColumnNameError, "You have already defined a column named '#{name}'.") if @columns.map do |c|
         RESERVED_NAMES.include?(c.name) ? nil : c.name
       end.flatten.include?(name)
       col = Column.new(name, length, @options.merge(options))
       @columns << col
+      @length += length
       col
     end
-    
+
     def spacer(length)
       column(:spacer, length)
     end
-    
+
     def trap(&block)
       @trap = block
     end
-    
+
     def template(name)
       template = @definition.templates[name]
       raise ArgumentError, "Template #{name} not found as a known template." unless template
-      @columns = @columns + template.columns
+      @columns += template.columns
+      @length += template.length
       # Section options should trump template options
       @options = template.options.merge(@options)
     end
-    
+
+    # Format a data Hash using columns width.
+    # - Data - hash, based on columns definitions content.
+    # Ex: Having the next 2 columns .column(:id, 5) && .column(:name, 10)
+    #     we pass the data hash data = { id: 3, name: "Ryan" }
+    #     the result is the content of the hash based on the columns width:
+    # format(data)
+    #   => "    3      Ryan"
     def format(data)
       # raise( ColumnMismatchError,
       #   "The '#{@name}' section has #{@columns.size} column(s) defined, but there are #{data.size} column(s) provided in the data."
       # ) unless @columns.size == data.size
-      row = ''      
+      row = ''
       @columns.each do |column|
         row += column.format(data[column.name])
       end
       row
     end
-    
+
     def parse(line)
       line_data = line.unpack(unpacker)
       row = {}
@@ -57,20 +67,28 @@ class Slither
       end
       row
     end
-    
+
+    def parse_when_problem(line)
+      line_data = line.unpack(@columns.map { |c| "a#{c.length}" }.join(''))
+      row = ''
+      @columns.each_with_index do |c, i|
+        row << "\n'#{c.name}':'#{line_data[i]}'" unless RESERVED_NAMES.include?(c.name)
+      end
+      row
+    end
+
     def match(raw_line)
       raw_line.nil? ? false : @trap.call(raw_line)
     end
-    
+
     def method_missing(method, *args)
       column(method, *args)
     end
-  
+
     private
-      
-      def unpacker
-        @columns.map { |c| c.unpacker }.join('')
-      end
 
-  end  
-end
+    def unpacker
+      @columns.map { |c| c.unpacker }.join('')
+    end
+  end
+end

data/lib/slither/version.rb

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

data/lib/slither.rb

@@ -1,7 +1,68 @@
-$: << File.dirname(__FILE__)
-require 'slither/slither'
-require 'slither/definition'
-require 'slither/section'
-require 'slither/column'
-require 'slither/parser'
-require 'slither/generator'
+# 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/version"
+
+module Slither
+  class Error < StandardError; end
+  # Your code goes here...
+
+  class DuplicateColumnNameError < StandardError; end
+  class RequiredSectionNotFoundError < StandardError; end
+  class RequiredSectionEmptyError < StandardError; end
+  class FormattedStringExceedsLengthError < StandardError; end
+  class ColumnMismatchError < StandardError; end
+  class LineWrongSizeError < StandardError; end
+  class SectionsNotSameLengthError < StandardError; end
+
+
+  def self.define(name, options = {}, &block)
+    definition = Definition.new(options)
+    yield(definition)
+    definitions[name] = definition
+    definition
+  end
+
+  # Generate a File from Data.
+  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
+  end
+
+  def self.parse(filename, definition_name)
+    raise ArgumentError, "File #{filename} does not exist." unless File.exists?(filename)
+
+    file_io = File.open(filename, 'r')
+    parseIo(file_io, definition_name)
+  end
+
+  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
+
+  private
+
+  def self.definitions
+    @@definitions ||= {}
+  end
+
+  def self.definition(name)
+    definitions[name]
+  end
+end

data/sig/slither.rbs

@@ -0,0 +1,4 @@
+module Slither
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,51 +1,71 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: slither
-version: !ruby/object:Gem::Version 
-  hash: 411
-  prerelease: false
-  segments: 
-  - 0
-  - 99
-  - 4
-  version: 0.99.4
+version: !ruby/object:Gem::Version
+  version: 0.99.5
 platform: ruby
-authors: 
+authors:
 - Ryan Wood
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-
-date: 2010-10-07 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bones
+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
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 2
-        - 5
-        - 1
-        version: 2.5.1
+      - !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
-  version_requirements: *id001
-description: A simple, clean DSL for describing, writing, and parsing fixed-width text files.
-email: ryan.wood@gmail.com
+  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'
+description:
+email:
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- History.txt
-- README.rdoc
-files: 
-- History.txt
-- README.rdoc
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
 - Rakefile
 - TODO
 - lib/slither.rb
@@ -54,51 +74,30 @@ files:
 - lib/slither/generator.rb
 - lib/slither/parser.rb
 - lib/slither/section.rb
-- lib/slither/slither.rb
-- slither.gemspec
-- spec/column_spec.rb
-- spec/definition_spec.rb
-- spec/generator_spec.rb
-- spec/parser_spec.rb
-- spec/section_spec.rb
-- spec/slither_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/ryanwood/slither
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --main
-- README.rdoc
-require_paths: 
+- lib/slither/version.rb
+- sig/slither.rbs
+homepage: https://github.com/JorgeGarciaxyz/slither
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: !binary |
-  AA==
-
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 2
-summary: A simple, clean DSL for describing, writing, and parsing fixed-width text files
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A simple, clean DSL for describing, writing, and parsing fixed-width text
+  files.
 test_files: []
-

data/History.txt

@@ -1,16 +0,0 @@
-  
-== 0.99.2 / 2009-04-28
-
-* Added better support for float formatting
-* Added the money_with_implied_decimal type
-  
-== 0.99.1 / 2009-04-22
-
-* Make the missing method build a column  i.e. body.record_type 1
-* Prevent duplicate column names
-* Better error messages
-* Implement custom padding (spaces (default), zero)
-
-== 0.99.0 / 2009-04-14
-
-* Initial Release