slither 0.99.4 → 0.99.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 67bb6ad8dd4ac38f63231d77f9e366543cf9b11589e89760da6c85da9912995b
+  data.tar.gz: 9b7be1bf9747a39d72ee06097226676c2d7c7a634f56fcbb290bf5d665b23fbb
+SHA512:
+  metadata.gz: 72590afbfbceec05c54e67fa4f534c16207579a6fc3412ff19739e7ecc805864e044f6625b468827cb6dae7d627960a7b24895b25cced9b57ea5884bb217a82e
+  data.tar.gz: e695c7f0871aae93d0fb2ae8c8e7cd10e36737304f5f9b244009728f44153bd9028c6f3085c0c433eb6e703cb4ba558c11e27479e80c416d460448b5eeed8a38

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+    NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# 0.99.5
+* Use bundler to define the base skeleton of the Gem
+* Specify dependencies so far: rspec, rubocop and pry
+* Specify Ruby version (>3.0)
+* Add some docs-comments
+* Update specs to rspec 3.0
+
+## 0.99.4
+
+## 0.99.3
+
+## 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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at jorge.mgg94@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in slither.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    slither (0.99.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  slither!
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jorge Garcia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,95 @@
+# Slither
+by Ryan Wood http://ryanwood.com
+
+# Description:
+
+A simple, clean DSL for describing, writing, and parsing fixed-width text files.
+
+## Features:
+
+* Easy DSL syntax
+* Can parse and format fixed width files
+* Templated sections for reuse
+* Helpful error messages for invalid data
+
+## Synopsis:
+
+Create a Slither::Defintion to describe a file format
+```ruby
+  Slither.define :simple, :by_bytes => false do |d|
+
+    # This is a template section that can be reused in other sections
+    d.template :boundary do |t|
+      t.column :record_type, 4
+      t.column :company_id, 12
+    end
+
+    # Create a header section
+    #   alternatively, you can define the section on the fly by using metaprogramming
+    #   ex: d.header(:align => :left) { |header| ... }
+    d.section(:header, :align => :left) do |header|
+      # The trap tells Slither which lines should fall into this section
+      header.trap { |line| line[0,4] == 'HEAD' }
+      # Use the boundary template for the columns
+      header.template :boundary
+    end
+
+    d.section(:body) do |body|
+      body.trap { |line| line[0,4] =~ /[^(HEAD|FOOT)]/ }
+      body.column :id, 10, :type => :integer
+      body.column :name, 10, :align => :left
+      body.spacer 3
+      body.column :state, 2
+    end
+
+    d.section(:footer) do |footer|
+      footer.trap { |line| line[0,4] == 'FOOT' }
+      footer.template :boundary
+      footer.column :record_count, 10
+    end
+  end
+```
+
+Supported types are: `string, integer, date, float, money, and money_with_implied_decimal`.
+
+Use `:by_bytes => true` (default) to allow newlines within rows and specify length in bytes.
+Use `:by_bytes => false` to support sections of different lengths and length specification
+in number of characters.
+
+Then either feed it a nested struct with data values to create the file in the defined format:
+
+```ruby
+  test_data = {
+    :body => [
+      { :id => 12, :name => "Ryan", :state => 'SC' },
+      { :id => 23, :name => "Joe", :state => 'VA' },
+      { :id => 42, :name => "Tommy", :state => 'FL' },
+    ],
+    :header => { :record_type => 'HEAD', :company_id => 'ABC'  },
+    :footer => { :record_type => 'FOOT', :company_id => 'ABC'  }
+  }
+
+  # Generates the file as a string
+  puts Slither.generate(:simple, test_data)
+  # =>
+  #   HEAD         ABC
+  #         12Ryan         SC
+  #         23Joe          VA
+  #         42Tommy        FL
+  # FOOT         ABC
+
+  # Writes the file
+  Slither.write(output_filename, :simple, test_data)
+```
+
+or parse files already in that format into a nested hash:
+```ruby
+   parsed_data = Slither.parse(input_filename, :simple)
+   parsed_data = Slither.parseIo(io_object, :simple)
+```
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Slither project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ryanwood/slither/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,37 +1,12 @@
-require 'rake'
-require 'spec/rake/spectask'
-
-desc "Run all examples with RCov"
-Spec::Rake::SpecTask.new('rcov') do |t|
-  t.spec_files = FileList['spec/*.rb']
-  t.rcov = true
-  t.rcov_opts = ['--exclude', 'spec']
-end
-
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  load 'tasks/setup.rb'
-end
-
-ensure_in_path 'lib'
-require 'bones'
-
-task :default => 'spec:run'
-
-PROJ.name = 'slither'
-PROJ.authors = 'Ryan Wood'
-PROJ.email = 'ryan.wood@gmail.com'
-PROJ.url = 'http://github.com/ryanwood/slither'
-PROJ.version = '0.99.3'
-PROJ.exclude = %w(\.git .gitignore ^tasks \.eprj ^pkg)
-PROJ.readme_file = 'README.rdoc'
-
-#PROJ.rubyforge.name = 'codeforpeople'
-
-PROJ.rdoc.exclude << '^data'
-PROJ.notes.exclude = %w(^README\.rdoc$ ^data ^pkg)
-
-# PROJ.svn.path = 'bones'
-# PROJ.spec.opts << '--color'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/TODO

@@ -10,4 +10,5 @@
 
 == 1.x
 
-* Alternate Section Flow (other than linear), i.e. repeatable sections (think batch)
+* Alternate Section Flow (other than linear), i.e. repeatable sections (think batch)
+* Equivalent of parse by bytes, but with chars.  Use "io.gets nil, num_chars_per_line"

data/lib/slither/column.rb

@@ -1,11 +1,11 @@
 require 'date'
 
-class Slither
+module Slither
   class ParserError < RuntimeError; end
-  
+
   class Column
     attr_reader :name, :length, :alignment, :type, :padding, :precision, :options
-    
+
     def initialize(name, length, options = {})
       assert_valid_options(options)
       @name = name
@@ -16,13 +16,13 @@ class Slither
       @padding = options[:padding] || :space
       @truncate = options[:truncate] || false
       # Only used with floats, this determines the decimal places
-      @precision = options[:precision] 
+      @precision = options[:precision]
     end
-    
+
     def unpacker
       "A#{@length}"
     end
-       
+
     def parse(value)
       case @type
         when :integer
@@ -40,87 +40,107 @@ class Slither
         else value.strip
       end
     rescue
-      raise ParserError, "The value '#{value}' could not be converted to type #{@type}: #{$!}"
+      raise ParserError, "Error parsing column ''#{name}'. The value '#{value}' could not be converted to type #{@type}: #{$!}"
     end
-    
+
     def format(value)
-      pad(formatter % to_s(value))
+      string_formatted = formatter % to_s(value)
+
+      pad(string_formatted)
     rescue
       puts "Could not format column '#{@name}' as a '#{@type}' with formatter '#{formatter}' and value of '#{value}' (formatted: '#{to_s(value)}'). #{$!}"
     end
-       
+
     private
-    
-      def formatter
-        "%#{aligner}#{sizer}s"
-      end
-          
-      def aligner
-        @alignment == :left ? '-' : ''
-      end
-      
-      def sizer
-        (@type == :float && @precision) ? @precision : @length
-      end
-      
-      # Manually apply padding. sprintf only allows padding on numeric fields.
-      def pad(value)
-      	return value unless @padding == :zero
-      	matcher = @alignment == :right ? /^ +/ : / +$/
-      	space = value.match(matcher)
-      	return value unless space
-      	value.gsub(space[0], '0' * space[0].size)
-      end
-      
-      def to_s(value)
-        result = case @type
-          when :date            
-            # If it's a DBI::Timestamp object, see if we can convert it to a Time object
-            unless value.respond_to?(:strftime)
-              value = value.to_time if value.respond_to?(:to_time)
-            end
-            if value.respond_to?(:strftime)        
-              if @options[:format]
-                value.strftime(@options[:format])
-              else
-                value.strftime
-              end
+
+    # String formatter https://www.rubyguides.com/2012/01/ruby-string-formatting/
+    # https://www.dotnetperls.com/format-ruby
+    # Generates a string formatter using padding. Supports padding to the right or left as follow:
+    # formatter (right side)
+    # => "%10s"
+    #   This will generate a formatter of 10 char string right aligned.
+    #
+    # formatter (left side)
+    # => "%-10s"
+    #   This will generate a formatter of 10 char strign left aligned.
+    def formatter
+      @formatter ||= "%#{aligner}#{sizer}s"
+    end
+
+    # Pad aligment, related with string formatting, we use - for left or nothing for right.
+    def aligner
+      @alignment == :left ? '-' : ''
+    end
+
+    def sizer
+      (@type == :float && @precision) ? @precision : @length
+    end
+
+    # Manually apply padding. sprintf only allows padding on numeric fields.
+    def pad(value)
+      return value unless @padding == :zero
+
+      matcher = @alignment == :right ? /^ +/ : / +$/
+      space = value.match(matcher)
+
+      return value unless space
+
+      value.gsub(space[0], '0' * space[0].size)
+    end
+
+    def inspect
+      "#<#{self.class} #{instance_variables.map{|iv| "#{iv}=>#{instance_variable_get(iv)}"}.join(', ')}>"
+    end
+
+    def to_s(value)
+      result = case @type
+        when :date
+          # If it's a DBI::Timestamp object, see if we can convert it to a Time object
+          unless value.respond_to?(:strftime)
+            value = value.to_time if value.respond_to?(:to_time)
+          end
+          if value.respond_to?(:strftime)
+            if @options[:format]
+              value.strftime(@options[:format])
             else
-              value.to_s
+              value.strftime
             end
-          when :float
-            @options[:format] ? @options[:format] % value.to_f : value.to_f.to_s
-          when :money
-            "%.2f" % value.to_f
-          when :money_with_implied_decimal
-            "%d" % (value.to_f * 100)
-          else 
+          else
             value.to_s
-        end
-        validate_size result
+          end
+        when :float
+          @options[:format] ? @options[:format] % value.to_f : value.to_f.to_s
+        when :money
+          "%.2f" % value.to_f
+        when :money_with_implied_decimal
+          "%d" % (value.to_f * 100)
+        else
+          value.to_s
       end
+      validate_size result
+    end
 
-      def assert_valid_options(options)
-        unless options[:align].nil? || [:left, :right].include?(options[:align])
-          raise ArgumentError, "Option :align only accepts :right (default) or :left"
-        end
-        unless options[:padding].nil? || [:space, :zero].include?(options[:padding])
-          raise ArgumentError, "Option :padding only accepts :space (default) or :zero"
-        end
+    def assert_valid_options(options)
+      unless options[:align].nil? || [:left, :right].include?(options[:align])
+        raise ArgumentError, "Option :align only accepts :right (default) or :left"
       end
-      
-      def validate_size(result)
-        # Handle when length is out of range
-        if result.length > @length
-          if @truncate
-            start = @alignment == :left ? 0 : -@length
-            result = result[start, @length]
-          else
-            raise Slither::FormattedStringExceedsLengthError, 
-              "The formatted value '#{result}' in column '#{@name}' exceeds the allowed length of #{@length} chararacters."
-          end
+      unless options[:padding].nil? || [:space, :zero].include?(options[:padding])
+        raise ArgumentError, "Option :padding only accepts :space (default) or :zero"
+      end
+    end
+
+    def validate_size(result)
+      # Handle when length is out of range
+      if result.length > @length
+        if @truncate
+          start = @alignment == :left ? 0 : -@length
+          result = result[start, @length]
+        else
+          raise Slither::FormattedStringExceedsLengthError,
+            "The formatted value '#{result}' in column '#{@name}' exceeds the allowed length of #{@length} chararacters."
         end
-        result
       end
-  end  
-end
+      result
+    end
+  end
+end

data/lib/slither/definition.rb

@@ -1,33 +1,48 @@
-class Slither  
+module Slither
   class Definition
     attr_reader :sections, :templates, :options
-    
+
     def initialize(options = {})
       @sections = []
       @templates = {}
-      @options = { :align => :right }.merge(options)
+      @options = { :align => :right, :by_bytes => true }.merge(options)
     end
-    
+
     def section(name, options = {}, &block)
-      raise( ArgumentError, "Reserved or duplicate section name: '#{name}'") if  
-      Section::RESERVED_NAMES.include?( name ) || 
-      (@sections.size > 0 && @sections.map{ |s| s.name }.include?( name ))
-    
+      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
+
+      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
-  end  
-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