ripcols 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bea749aa6951592e0f088129785105768125e22b1a3152aa7c3d6115f67248a8
+  data.tar.gz: 3d4770babf2b19aab4fdb1a32f0f7c4b44bc4ae9ebb87adc13412d1668940e27
+SHA512:
+  metadata.gz: b42e2a8d38917700901906abdbd0e6e10e88d3e4db265c38644979dd02ebc022865aeccbce37f1bb2f4a436c3129db4091b4c16db175ef87ac955217256c256a
+  data.tar.gz: e656032c6cd11b6b61a4195e66efbc48788b1c515ffeea1d99e11741febbbd1a69c484f225c4aaa1a606ffd7c359b712d68e177d838643bf56cf66bfff11c5a3

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# bundler
+vendor/bundle

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ripcols.gemspec
+gemspec
+gem 'irb', require: false

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ripcols (0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    irb (1.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  irb
+  rake (~> 10.0)
+  ripcols!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 noor-rahim
+
+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,36 @@
+# Ripcols
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ripcols'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ripcols
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/noor-rahim/ripcols.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ripcols"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ripcols.rb

@@ -0,0 +1,67 @@
+require "json"
+require "ripcols/ripper"
+require "ripcols/version"
+
+module Ripcols
+  at_exit {
+
+    # todo: print helpful message, rather than exiting directly
+    req_file = self.caller_files.first
+    exit if req_file.nil?
+
+    patterns = Object.constants
+      .filter { |c| c.to_s.start_with?("HEADER_") || c.to_s.start_with?("LINE_") }
+      .map { |c| [c, Object.const_get(c)] }
+      .to_h
+
+    fbuf =
+      if ::ARGV.empty?
+        self.file_contents $stdin
+      else
+        open( ::ARGV.first ) { |f| self.file_contents(f) }
+      end
+
+    r = Ripper.new( patterns, fbuf )
+    puts JSON.dump( r.parse )
+
+  }
+
+  private
+
+  # here for future, in case we need to do some preprocessing on file
+  def self.file_contents f
+    # until f.eof? || ((ch = f.readchar) != "\n")
+    # end
+    # ch && f.ungetc(ch)
+    # f.pos = [f.pos.pred, 0].max
+    f.read
+  end
+
+
+  # taken from
+  # https://github.com/sinatra/sinatra/blob/eee711bce740d38a9a91aa6028688c9a6d74b23b/lib/sinatra/base.rb#L1505
+
+  # Like Kernel#caller but excluding certain magic entries and without
+  # line / method information; the resulting array contains filenames only.
+  def self.caller_files
+    cleaned_caller(1).flatten
+  end
+
+
+  CALLERS_TO_IGNORE = [ # :nodoc:
+    /^\(.*\)$/,                                         # generated code
+    /rubygems\/(custom|core_ext\/kernel)_require\.rb$/, # rubygems require hacks
+    /bundler(\/(?:runtime|inline))?\.rb/,               # bundler require hacks
+    /<internal:/,                                       # internal in ruby >= 1.9.2
+    /src\/kernel\/bootstrap\/[A-Z]/,                    # maglev kernel files
+    /ripcols\/lib\/ripcols.rb/,                         # this file
+  ]
+
+  # Like Kernel#caller but excluding certain magic entries
+  def self.cleaned_caller(keep = 3)
+    Kernel.caller(1).
+      map!    { |line| line.split(/:(?=\d|in )/, 3)[0,keep] }.
+      reject { |file, *_| CALLERS_TO_IGNORE.any? { |pattern| file =~ pattern } }
+  end
+
+end

data/lib/ripcols/ripper.rb

@@ -0,0 +1,199 @@
+module Ripcols
+
+  class Ripper
+    @@REQUIRED_PATTERNS = %i(HEADER_BEGIN HEADER_END LINE_END)
+
+    def initialize(patterns, str, column_gap=3, out_f=$stdout, err_f=$stderr)
+      unless @@REQUIRED_PATTERNS.all? { |req_pattern| patterns.include? req_pattern }
+        raise ArgumentError, "all required keys not present.\n Required keys:  #{@@REQUIRED_PATTERNS}"
+      end
+
+      @COL_GAP = column_gap
+
+      # @in_f = in_f
+      @fbuf = str
+      @out_f = out_f
+
+      col_del = /\s{#{@COL_GAP},}/
+      @patterns = patterns.dup
+      @patterns[:HEADER_COL_SEP]  ||= col_del
+      @patterns[:LINE_COL_SEP]    ||= col_del
+      @patterns[:LINE_SEP]        ||= /\n/
+      # @patterns[:LINE_HEADER_SEP] ||= /\n+/
+
+      @hbuf = nil
+      @bbuf = nil
+
+      @line_column_begin = 0
+    end
+
+    def parse
+      headers = parse_head
+      lines = body_lines.split( @patterns[:LINE_SEP] )
+      # col_sep = @patterns[:LINE_COL_SEP]
+      lines.map { |line| columize_line(line, headers) }
+    end
+
+
+    def parse_head
+      hbuf = header_lines
+      k = hbuf.lines.reduce([]) do |grouping, l|
+        off = 0
+        l.strip
+          .split( @patterns[:'HEADER_COL_SEP'] )
+          .each do |w|
+            if w.empty?
+              next
+            end
+            bc = l.index(w, off)
+            off = ec = bc + w.length
+            insert_to( grouping , w, bc, ec )
+          end
+        grouping
+      end
+
+      k = k.sort { |(_, abc), (_, bbc)| abc <=> bbc }
+          .map { |(titles, bc, ec)| [titles.join(' '), bc, ec] }
+
+      if k.first
+        # todo: (possible BUG!)
+        #  this code will break, when the initial columns dont begin from 0,
+        #  its better to have some kind of hinting to know where the column
+        #  begins.
+        #
+        # going with simplicity, beginning_column_position of 1st column be 0,
+        k.first[1] = @line_column_begin
+      end
+
+      k
+    end
+
+    def debug!
+      seperate_body_head
+      puts "HEADER\n______"
+      p header_lines
+      puts "BODY\n____"
+      p body_lines
+    end
+
+
+    private
+
+    # line : single line of string
+    # headers : [ (title, bc, ec) ...+ ]
+    #
+    # OUTPUT
+    # ======
+    # columized_line : Hash
+    # => {"col1": "matching stripped text", ...* }
+    #
+    # Note
+    # ====
+    # blank columns will not be part of the result.
+    #
+    def columize_line line, headers
+      return Hash[] if headers.empty?
+
+      ks = {}
+      idx = 0
+      delim = @patterns[:LINE_COL_SEP]
+      unresolved = nil
+
+      headers.each do |(title, bc, ec)|
+
+        if unresolved
+          if (unresolved[:text][:ec] + @COL_GAP) < bc
+            head = unresolved[:header]
+            ks[ head[:title] ] = unresolved[:text][:text]
+            idx = unresolved[:text][:ec]
+            unresolved = nil
+          end
+        end
+
+        break unless bc_idx = line.index( /\S/, idx )
+        ec_idx = line.index( delim, bc_idx ) || -1
+        val = line[ ec_idx == -1 ? (bc_idx .. ec_idx) : (bc_idx ... ec_idx) ]
+        if (bc_idx - @COL_GAP) <= ec
+          unresolved = nil
+          idx = ec_idx
+          ks[title] = val # line[bc_idx ... ec_idx]
+
+          break if ec_idx == -1
+        else
+          unresolved = {
+            "text":   Hash[:text, val, :bc, bc_idx, :ec, ec_idx],
+            "header": Hash[:title, title, :bc, bc, :ec, ec],
+          }
+        end
+
+      end
+
+      ks
+    end
+
+
+    def seperate_body_head
+      fbuf = @fbuf
+      hbeg_idx = @patterns[:HEADER_BEGIN] =~ fbuf
+      unless hbeg_idx
+        raise ArgumentError, "Failed to located beginning of Header"
+      end
+
+      head_begin_buf = fbuf[ hbeg_idx .. -1 ]
+      if head_begin_buf.start_with? "\n"
+        head_begin_buf.sub!(/\n+/, '')
+      end
+      hend_idx = @patterns[:HEADER_END] =~ head_begin_buf
+      unless hend_idx
+        raise ArgumentError, @patterns[:HEADER_END], "Failed to locate ending of Header"
+      end
+      @hbuf = head_begin_buf[ 0..hend_idx ]
+
+      bbuf = $~.post_match
+      if bbuf.start_with? "\n"
+        bbuf.sub!(/\n+/, '')
+      end
+      lend_idx = @patterns[:LINE_END] =~ bbuf
+      unless lend_idx
+        raise ArgumentError, @patterns[:LINE_END], "Failed to locate ending of lines"
+      end
+      @bbuf = $~.pre_match
+    end
+
+    def header_lines
+      return @hbuf if @hbuf
+      seperate_body_head
+      @hbuf
+    end
+
+    def body_lines
+      return @bbuf if @bbuf
+      seperate_body_head
+      @bbuf
+    end
+
+    # check whether given 2 groups appear within boundaries of each other
+    # group = [ title, beginning_column, ending_col ]
+    # note: the ending column is exclusive
+    def overlap?( group_a, group_b )
+      (_, a_bc, a_ec) = group_a
+      (_, b_bc, b_ec) = group_b
+      (b_bc.between?( a_bc, a_ec.pred ) ||
+       b_ec.between?( a_bc, a_ec.pred ) ||
+       a_bc.between?( b_bc, b_ec.pred ))
+    end
+
+
+    def insert_to( grouping , title, bc, ec )
+      group = grouping.find { |group| overlap?(group, [title, bc, ec]) }
+      if group
+        group[0].push( title )
+        ibc, iec = group[1..2]
+        group[1] = [bc, ibc].min
+        group[2] = [ec, iec].max
+      else
+        grouping.push( [[title], bc, ec] )
+      end
+    end
+  end
+end

data/lib/ripcols/version.rb

@@ -0,0 +1,3 @@
+module Ripcols
+  VERSION = "0.1.4"
+end

data/ripcols.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ripcols/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ripcols"
+  spec.version       = Ripcols::VERSION
+  spec.authors       = ["noor-rahim"]
+  spec.email         = ["noorrahim619@gmail.com"]
+
+  spec.summary       = %q{a library to parse unstructured table of data, ...}
+  spec.description   = %q{...}
+  spec.homepage      = "https://github.com/noor-rahim/ripcols"
+  spec.license       = "MIT"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/noor-rahim/ripcols"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: ripcols
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- noor-rahim
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: "..."
+email:
+- noorrahim619@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ripcols.rb
+- lib/ripcols/ripper.rb
+- lib/ripcols/version.rb
+- ripcols.gemspec
+homepage: https://github.com/noor-rahim/ripcols
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/noor-rahim/ripcols
+  source_code_uri: https://github.com/noor-rahim/ripcols
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: a library to parse unstructured table of data, ...
+test_files: []