ruby_sscanf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df915cc66b1691fb7e9c74d48aba08cb60cec10d
+  data.tar.gz: 81529318abc9886ad74ebe0f749bbe8d3b3efe96
+SHA512:
+  metadata.gz: 61ecf231774391b5a9b956179a08c1e04153b1a6e7f2faf505e38906431608419054cfbca1b9cda961fac4a20600c9ceb94e7e6f9c13579eef526f7de6002c85
+  data.tar.gz: 65adab881ced2faf3c4440d779db0997aeb0e8c48fa9cf31053b4063f3f3ff7bf955fe0996ca1f3a120046351ac5aa34823ccf35b245236c5e386accae023c24

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+docs/.~lock.*
+*.bat
+*.zip
+*.tmp
+rdoc
+test/tmp
+test/version_tmp
+tmp
+temp.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby_sscanf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Camilleri
+
+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 @@
+# RubySscanf
+
+The ruby_sscanf gem monkey patches the String class to support the sscanf
+instance method. This method is modeled after the POSIX "C" standard sscanf
+but with alterations and omissions to suit the Ruby programming language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_sscanf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_sscanf
+
+## Usage
+
+The basic usage for sscanf is:
+
+```ruby
+"<input string>".sscanf("<format string>")
+```
+Where the input string is a collection of formatted information and the
+format string is a description of that format. The output of the sscanf method
+is an array of data extracted from the input string.
+
+The format string consists of literal string components and format specifiers.
+
+Literal string components match themselves in the input string. If the literal
+has a trailing space, then this matches zero or more spaces. The special
+sequence '%%' matches one '%'.
+
+The layout of a format specifier is:
+
+    %[skip_flag][width]format
+
+* The % sign is the lead-in character.
+* The optional skip flag, the * causes any data extracted to be ignored.
+* The width field is an integer field that determines the amount of text to be
+parsed.
+* The format field determines the type of data being parsed.
+
+The supported format field values are:
+<br>
+* b - Scan for an (optionally signed) binary number with an optional
+leading '0b' or '0B'.
+* c - Grab the next character. If a positive width is specified, grab width
+characters. For a negative width, grab characters to the position from the
+end of the input. For example a width of -1 will grab all of the remaining
+input data.
+* d - Scan for an (optionally signed) decimal number.
+* f - Scan for an (optionally signed) floating point number.
+* i - Scan for an (optionally signed) integer. If the number begins with '0x'
+or '0X', process hexadecimal; with '0b' or '0B', process binary, if '0', '0o',
+or '0O', process octal, else process decimal.
+* j - Scan for an (optionally signed) complex number in the form
+[+-]?float[+-]float[ij]
+* o - Scan for an (optionally signed) octal number with an optional
+leading '0', '0o' or '0O'.
+* q - Scan for a quoted string. That is a string enclosed by either '...'
+or "...".
+* r - Scan for an (optionally signed) rational number in the form
+[+-]?decimal/decimal[r]?
+* s - Scan for a space terminated string.
+* u - Scan for a decimal number.
+* x - Scan for an (optionally signed) hexadecimal number with an optional
+leading '0x' or '0X'.
+* [chars] - Scan for a contiguous string of characters in the set [chars].
+* [^chars] - Scan for a contiguous string of characters not in the set [^chars]
+
+## Contributing
+
+#### Plan A
+
+1. Fork it ( https://github.com/PeterCamilleri/format_engine/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+#### Plan B
+
+Go to the GitHub repository and raise an issue calling attention to some
+aspect that could use some TLC or a suggestion or idea. Apply labels to
+the issue that match the point you are trying to make. Then follow your
+issue and keep up-to-date as it is worked on. Or not as pleases you.
+All input are greatly appreciated.
+

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+# coding: utf-8
+
+require 'rake/testtask'
+require 'rdoc/task'
+require "bundler/gem_tasks"
+
+#Generate internal documentation with rdoc.
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+
+  #List out all the files to be documented.
+  rdoc.rdoc_files.include("lib/**/*.rb", "license.txt", "README.md")
+
+  #Make all access levels visible.
+  rdoc.options << '--visibility' << 'private'
+  #rdoc.options << '--verbose'
+  #rdoc.options << '--coverage-report'
+
+  #Set a title.
+  rdoc.options << '--title' << 'fOOrth Language Internals'
+
+end
+
+#Run the format_engine unit test suite.
+Rake::TestTask.new do |t|
+  #List out all the test files.
+  t.test_files = FileList['tests/**/*.rb']
+  t.verbose = false
+end
+
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+end
+
+desc "Run an IRB Session with format_engine loaded."
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require './lib/ruby_sscanf'
+  puts "Starting an IRB console with ruby_sscanf."
+  puts "Use 'quit' to exit."
+  puts
+  ARGV.clear
+  IRB.start
+end
+
+desc "What version of code is this?"
+task :vers do |t|
+  puts
+  puts "ruby_sscanf version = #{RubySscanf::VERSION}"
+end

data/lib/ruby_sscanf.rb

@@ -0,0 +1,69 @@
+
+require 'format_engine'
+require_relative 'ruby_sscanf/version'
+
+class String
+
+  DECIMAL  = /[+-]?\d+/
+  HEX      = /[+-]?(0[xX])?\h+/
+  OCTAL    = /[+-]?(0[oO])?[0-7]+/
+  BINARY   = /[+-]?(0[bB])?[01]+/
+  INTEGER  = /[+-]?((0[xX]\h+)|(0[bB][01]+)|(0[oO]?[0-7]*)|([1-9]\d*))/
+  FLOAT    = /[+-]?\d+(\.\d+)?([eE][+-]?\d+)?/
+  RATIONAL = /[+-]?\d+\/\d+(r)?/
+  COMPLEX  = %r{(?<num> \d+(\.\d+)?([eE][+-]?\d+)?){0}
+                [+-]?\g<num>[+-]\g<num>[ij]
+               }x
+  QUOTED   = /("([^\\"]|\\.)*")|('([^\\']|\\.)*')/
+
+  #Get the parsing engine.
+  def self.get_engine
+    Thread.current[:ruby_sscanf_engine] ||= FormatEngine::Engine.new(
+      "%b"  => lambda {parse(BINARY) ? dst << found.to_i(2) : :break},
+      "%*b" => lambda {parse(BINARY) || :break},
+
+      "%c"  => lambda {dst << grab},
+      "%*c" => lambda {grab},
+
+      "%d"  => lambda {parse(DECIMAL) ? dst << found.to_i : :break},
+      "%*d" => lambda {parse(DECIMAL) || :break},
+
+      "%f"  => lambda {parse(FLOAT) ? dst << found.to_f : :break},
+      "%*f" => lambda {parse(FLOAT) || :break},
+
+      "%i"  => lambda {parse(INTEGER) ? dst << found.to_i(0) : :break},
+      "%*i" => lambda {parse(INTEGER) || :break},
+
+      "%j"  => lambda {parse(COMPLEX) ? dst << Complex(found) : :break},
+      "%*j" => lambda {parse(COMPLEX) || :break},
+
+      "%o"  => lambda {parse(OCTAL) ? dst << found.to_i(8) : :break},
+      "%*o" => lambda {parse(OCTAL) || :break},
+
+      "%q"  => lambda do
+        parse(QUOTED) ? dst << found[1..-2].gsub(/\\./) {|seq| seq[-1]} : :break
+      end,
+      "%*q" => lambda {parse(QUOTED) || :break},
+
+      "%r"  => lambda {parse(RATIONAL) ? dst << found.to_r : :break},
+      "%*r" => lambda {parse(RATIONAL) || :break},
+
+      "%s"  => lambda {parse(/\S+/) ? dst << found : :break},
+      "%*s" => lambda {parse(/\S+/) || :break},
+
+      "%u"  => lambda {parse(/\d+/) ? dst << found.to_i : :break},
+      "%*u" => lambda {parse(/\d+/) || :break},
+
+      "%x"  => lambda {parse(HEX) ? dst << found.to_i(16) : :break},
+      "%*x" => lambda {parse(HEX) || :break},
+
+      "%["  => lambda {parse(fmt.regex) ? dst << found : :break},
+      "%*[" => lambda {parse(fmt.regex) || :break})
+  end
+
+  #Scan the formatted input.
+  def sscanf(format)
+    String.get_engine.do_parse(self, [], format)
+  end
+
+end

data/lib/ruby_sscanf/version.rb

@@ -0,0 +1,3 @@
+module RubySscanf
+  VERSION = "0.1.0"
+end

data/ruby_sscanf.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruby_sscanf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_sscanf"
+  spec.version       = RubySscanf::VERSION
+  spec.authors       = ["Peter Camilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = "A string parser."
+  spec.description   = "A formatted string data parser for Ruby"
+  spec.homepage      = "http://teuthida-technologies.com/"
+  spec.license       = "MIT"
+
+  raw_list           = `git ls-files`.split($/)
+  spec.files         = raw_list.keep_if {|entry| !entry.start_with?("docs") }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_runtime_dependency "format_engine", ">= 0.5"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', "~> 5.5.1"
+  spec.add_development_dependency 'minitest_visible', "~> 0.0.1"
+  spec.add_development_dependency 'rdoc', "~> 4.0.1"
+
+end

data/tests/scan_tests.rb

@@ -0,0 +1,66 @@
+require_relative '../lib/ruby_sscanf'
+gem              'minitest'
+require          'minitest/autorun'
+require          'minitest_visible'
+
+
+# Test the internals of the parser engine. This is not the normal interface.
+class ScanTester < Minitest::Test
+
+  #Track mini-test progress.
+  MinitestVisible.track self, __FILE__
+
+  def test_that_it_can_scan
+    result = "12 34 -56".sscanf "%d %2d %4d"
+    assert_equal([12, 34, -56] , result)
+
+    result = "255 0b11111111 0377 0xFF 0 ".sscanf "%i %i %i %i %i"
+    assert_equal([255, 255, 255, 255, 0] , result)
+
+    result = "7 10 377".sscanf "%o %o %o"
+    assert_equal([7, 8, 255] , result)
+
+    result = "10 10011 11110000".sscanf "%b %b %b"
+    assert_equal([2, 19, 240] , result)
+
+    result = "0 F FF FFF FFFF".sscanf "%x %x %x %x %x"
+    assert_equal([0, 15, 255, 4095, 65535] , result)
+
+    result = "Hello Silly World".sscanf "%s %*s %s"
+    assert_equal(["Hello", "World"] , result)
+
+    result = "Hello Silly World".sscanf "%5c %*5c %5c"
+    assert_equal(["Hello", "World"] , result)
+
+    result = "42 The secret is X".sscanf "%i %-1c"
+    assert_equal([42, "The secret is X"] , result)
+
+    result = "42 The secret is X".sscanf "%i %-2c%c"
+    assert_equal([42, "The secret is ", "X"] , result)
+
+    result = "42 The secret is X".sscanf "%i %*-2c%c"
+    assert_equal([42,  "X"] , result)
+
+    result = "9.99 1.234e56 -1e100".sscanf "%f %f %f"
+    assert_equal([9.99, 1.234e56, -1e100] , result)
+
+    result = "85% 75%".sscanf "%f%% %f%%"
+    assert_equal([85, 75] , result)
+
+    result = "12 34 -56".sscanf "%u %u %u"
+    assert_equal([12, 34] , result)
+
+    result = "1/2 3/4r -5/6".sscanf "%r %r %r"
+    assert_equal(['1/2'.to_r, '3/4'.to_r, '-5/6'.to_r] , result)
+
+    result = "1+2i 3+4j -5e10-6.2i".sscanf "%j %j %j"
+    assert_equal([Complex('1+2i'), Complex('3+4j'), Complex('-5e10-6.2i')] , result)
+
+    result = "'quote' 'silly' \"un quote\" 'a \\''  ".sscanf "%q %*q %q %q"
+    assert_equal(["quote", "un quote", "a '"] , result)
+
+    result = "a b c".sscanf "%[a] %[b] %[c]"
+    assert_equal(["a", "b", "c"] , result)
+  end
+
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: ruby_sscanf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Camilleri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: format_engine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.1
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+description: A formatted string data parser for Ruby
+email:
+- peter.c.camilleri@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ruby_sscanf.rb
+- lib/ruby_sscanf/version.rb
+- ruby_sscanf.gemspec
+- tests/scan_tests.rb
+homepage: http://teuthida-technologies.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A string parser.
+test_files: []