tinycode 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3438fb3aab3c2d58592ed6c9bc1f63f37e98effbecb60a67f110d4306a3822aa
-  data.tar.gz: 65b47a8b537de5b3e40b6c0dfd7efd5789135e2ae71d463df1e372cc697eb436
+  metadata.gz: 1e5a75ffceb25e155db277a905e940cbf22a3f43a666113aede98b5457176aca
+  data.tar.gz: f095520fdf8e46c939f7937957fb831951118d11ebef414a8d08bbee86b1a331
 SHA512:
-  metadata.gz: 2214f092bbbc76b3daa8f694a2ddf04556ae80a5627cb80e0060ad25b842ad431c948a828e1d0f0dcb29ab1a3dc8171e3f8ca81a4c9f1f66b3495074dfd126fd
-  data.tar.gz: b9824631c29c06ec9fd66b1e127f9a3c35c5956ee4514758c07b3290317a253609a36d73201795686ea419fb0a86444ed043e353d3397d2ecf279435a40c4d3a
+  metadata.gz: 5146523a4517a8effb28f426c6922cb0338ec6a66de0a545b75385551e9a2ed0158e5292f8af441f15c1888cff7deb99e6e9550e029f26e3e7e5a16519a80255
+  data.tar.gz: 0ad1a83f8c3f5d2a3ddbe5639d23e618a3dc4988825740d52ded2077188b5c373ce644b75b829be49fa0128fdad705fa690cc6b1107e4b0a0427361c3691bfa8

data/.rubocop.yml

@@ -32,6 +32,8 @@ Metrics/BlockLength:
 
 RSpec/MultipleExpectations:
   Enabled: false
+RSpec/ExampleLength:
+  Max: 10
 
 Style/AsciiComments:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tinycode (0.1.1)
+    tinycode (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -14,14 +14,14 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.6)
     rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rerun (0.13.1)
       listen (~> 3.0)
     rexml (3.2.5)
@@ -47,7 +47,7 @@ GEM
       rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
+    rubocop-ast (1.14.0)
       parser (>= 3.0.1.1)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
@@ -61,10 +61,13 @@ GEM
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
     unicode-display_width (2.1.0)
-    yard (0.9.26)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)

data/README.md

@@ -85,13 +85,13 @@ gem 'tinycode'
 And then execute:
 
 ```sh
-$ bundle install
+bundle install
 ```
 
 Or install it yourself as:
 
 ```sh
-$ gem install tinycode
+gem install tinycode
 ```
 
 ## Usage
@@ -148,8 +148,7 @@ copyright dates.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+the Free Software Foundation, version 3.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of

data/Rakefile

@@ -12,8 +12,13 @@ RuboCop::RakeTask.new(:lint) do |task|
 end
 YARD::Rake::YardocTask.new
 
-task :watch do
-  sh 'rerun -p "{**/*.{rb,gemspec},exe/**/*,Gemfile*,Rakefile}" -x rake yard spec lint:auto_correct'
+task :dev do
+  sh 'bundle install'
+  sh 'rerun -p "{**/*.{rb,gemspec},exe/**/*,Gemfile*,Rakefile}" -x rake yard spec'
+end
+
+task :autofixlint do
+  sh 'rerun -p "{**/*.{rb,gemspec},exe/**/*,Gemfile*,Rakefile}" -x rake lint:auto_correct'
 end
 
 task default: [:spec, :lint]

data/bin/acid_test.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require_relative '../lib/tinycode'
+
+ITERATIONS = 100_000
+MAX_INPUT_LENGTH = 4096
+
+MAX_INPUT_LENGTH.times do |input_length|
+  results = []
+  ITERATIONS.times do
+    input = SecureRandom.bytes(input_length)
+    begin
+      Tinycode.load(input)
+      results << 'Success'
+    rescue Tinycode::ParseError => e
+      results <<
+        if e.message =~ /\AUnexpected character: /
+          'Unexpected character: ...'
+        else
+          e.message
+        end
+    rescue Error
+      warn "Attempted to parse #{input.inspect} but got unexpected error:"
+      raise
+    end
+  end
+  puts "==== For inputs of length #{input_length}:"
+  results.tally.to_a.sort_by(&:last).each do |result, times|
+    puts "#{result} x#{times}"
+  end
+  puts
+end
+
+puts "Congratulations! Was unable to find a vector that results in an unexpected error for sizes <= #{MAX_INPUT_LENGTH}"

data/lib/tinycode/module.rb

@@ -28,17 +28,25 @@ module Tinycode
     end
 
     def load(tinycode)
-      raise ArgumentError, "Cannot convert #{tinycode.class} to String" if !tinycode.respond_to?(:to_str)
-
-      tinycode = tinycode.to_str.b
+      tinycode = implicitly_convert_str(tinycode).b
       struct, length = load_with_length(tinycode)
-      raise ParseError, 'Input is longer than expected' if length != tinycode.length
+      raise 'a load_ implementation claims it read past the end of stream!' if length > tinycode.length
+      raise ParseError, 'Stream is longer than expected' if length < tinycode.length
 
       struct
     end
 
     private
 
+    def implicitly_convert_str(obj)
+      raise ArgumentError, "Cannot convert #{obj.class} to String" if !obj.respond_to?(:to_str)
+
+      str = obj.to_str
+      raise ArgumentError, "#{obj.class}#to_str did not return String, got #{str.class}" if !str.is_a?(String)
+
+      str
+    end
+
     def load_with_length(tinycode)
       case tinycode[0]
       when /[\w \t\n]/ then load_id(tinycode)
@@ -53,7 +61,8 @@ module Tinycode
       when '#'         then load_fixed_integer(tinycode, U64, length: 8, unpack: 'Q>')
       when "\0"        then [nil, 1]
       when '?'         then load_boolean(tinycode)
-      else raise ParseError, "Unexpected character: #{tinycode[0]}"
+      when nil then raise ParseError, 'Unexpected end of stream'
+      else          raise ParseError, "Unexpected character: #{tinycode[0].inspect}"
       end
     end
 
@@ -93,7 +102,7 @@ module Tinycode
 
     def dump_string(str, code: "'")
       str = str.encode('UTF-8').b unless str.encoding == Encoding::ASCII_8BIT
-      if str =~ /\A[\w \t\n]+\z/
+      if str =~ /\A[\w \t\n][^':]*\z/
         [str, code].pack('a*a')
       else
         [code, str.length, str].pack('awa*')
@@ -102,18 +111,23 @@ module Tinycode
 
     def load_id(tinycode)
       length = tinycode.index(/[':]/)
-      value = tinycode[0...length]
-      value = if tinycode[length] == ':'
-                value.to_sym
-              else
-                value.force_encoding('UTF-8')
-              end
+      raise ParseError, 'Unexpected end of stream' if !length
+
+      value = tinycode[0...length].force_encoding('UTF-8')
+      raise ParseError, 'invalid byte sequence in UTF-8 string' if !value.valid_encoding?
+
+      value = value.to_sym if tinycode[length] == ':'
       [value, length + 1]
     end
 
     def load_string(tinycode)
       str_length, offset = load_varint(tinycode[1..])
-      [tinycode[(1 + offset)...(1 + offset + str_length)].force_encoding('UTF-8'), 1 + offset + str_length]
+      raise ParseError, 'Unexpected end of stream' if tinycode.length < 1 + offset + str_length
+
+      str = tinycode[(1 + offset)...(1 + offset + str_length)].force_encoding('UTF-8')
+      raise ParseError, 'invalid byte sequence in UTF-8 string' if !str.valid_encoding?
+
+      [str, 1 + offset + str_length]
     end
 
     def dump_symbol(sym)
@@ -136,6 +150,7 @@ module Tinycode
     def load_integer(tinycode)
       value, offset = load_varint(tinycode[1..])
       value = -value if tinycode[0] == '-'
+      raise ParseError, '-0 is not a valid integer' if value == 0 && tinycode[0] == '-'
 
       [value, 1 + offset]
     end
@@ -145,11 +160,15 @@ module Tinycode
     end
 
     def load_fixed_integer(tinycode, clazz, length:, unpack:)
+      raise ParseError, 'Unexpected end of stream' if tinycode.length < length + 1
+
       [clazz.new(tinycode[1...(1 + length)].unpack1(unpack)), 1 + length]
     end
 
     def load_varint(tinycode)
       length = tinycode.each_byte.lazy.take_while {|b| b > 0x7F }.count + 1
+      raise ParseError, 'Unexpected end of stream' if length > tinycode.length
+
       [tinycode[0...length].unpack1('w'), length]
     end
 
@@ -157,7 +176,7 @@ module Tinycode
       case tinycode[1]
       when 'T' then [true, 2]
       when 'F' then [false, 2]
-      else raise ParseError, 'Malformed boolean'
+      else raise ParseError, 'Malformed boolean value'
       end
     end
   end

data/lib/tinycode/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tinycode
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/tinycode.gemspec

@@ -3,20 +3,24 @@
 require_relative 'lib/tinycode/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'tinycode'
-  spec.version = Tinycode::VERSION
-  spec.summary = 'An encoder and decoder for tinycode'
-  spec.description = 'tinycode is a bencode like encoding that supports more ' \
-    'data-types and slightly smaller encoded sizes.'
-  spec.authors = ['Alex Gittemeier']
-  spec.license = 'GPL-3.0'
-  spec.email = ['me@a.lexg.dev']
-  spec.metadata['source_code_uri'] = 'https://gitlab.com/windows93/tinycode'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-  # spec.metadata['changelog_uri'] =
+  spec.name        = 'tinycode'
+  spec.version     = Tinycode::VERSION
+  spec.summary     = 'An encoder and decoder for tinycode'
+  spec.description = <<~DESCRIPTION
+    tinycode is a bencode like encoding that supports more data-types
+    and slightly smaller encoded sizes.
+  DESCRIPTION
+  spec.author      = 'Alex Gittemeier'
+  spec.email       = 'me@a.lexg.dev'
+  spec.license     = 'GPL-3.0-only'
 
-  spec.homepage = spec.metadata['source_code_uri']
-  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['homepage_uri']          = 'https://gitlab.com/windows93/tinycode'
+  spec.metadata['source_code_uri']       = 'https://gitlab.com/windows93/tinycode/-/tree/stable'
+  spec.metadata['documentation_uri']     = 'https://www.rubydoc.info/gems/tinycode/'
+  spec.metadata['bug_tracker_uri']       = 'https://gitlab.com/windows93/tinycode/-/issues'
+  spec.metadata['changelog_uri']         = 'https://gitlab.com/windows93/tinycode/-/commits/stable'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.homepage = spec.metadata['homepage_uri']
 
   # 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.
@@ -25,9 +29,6 @@ Gem::Specification.new do |spec|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) {|f| File.basename(f) }
-  spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.6.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinycode
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Gittemeier
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2021-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -122,10 +122,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: tinycode is a bencode like encoding that supports more data-types and
-  slightly smaller encoded sizes.
-email:
-- me@a.lexg.dev
+description: |
+  tinycode is a bencode like encoding that supports more data-types
+  and slightly smaller encoded sizes.
+email: me@a.lexg.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -138,6 +138,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/acid_test.rb
 - lib/tinycode.rb
 - lib/tinycode/core_ext.rb
 - lib/tinycode/fixed_integer.rb
@@ -147,11 +148,14 @@ files:
 - tinycode.gemspec
 homepage: https://gitlab.com/windows93/tinycode
 licenses:
-- GPL-3.0
+- GPL-3.0-only
 metadata:
-  source_code_uri: https://gitlab.com/windows93/tinycode
-  rubygems_mfa_required: 'true'
   homepage_uri: https://gitlab.com/windows93/tinycode
+  source_code_uri: https://gitlab.com/windows93/tinycode/-/tree/stable
+  documentation_uri: https://www.rubydoc.info/gems/tinycode/
+  bug_tracker_uri: https://gitlab.com/windows93/tinycode/-/issues
+  changelog_uri: https://gitlab.com/windows93/tinycode/-/commits/stable
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: