netstring 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58bf8216c488dc9bf16c5f2826816f32e9d326c0
+  data.tar.gz: fe341a3b67a1fab40772771588180ecb193712a8
+SHA512:
+  metadata.gz: 4891518572806c60b05d3f4c8726c2039b0ce40a108fa68694771250075dc8f1c6a5613fa0312ab2c7c2eabdc2b40d3169c567143fd7a5930de78004feb25942
+  data.tar.gz: 5c2cf2d5e27208946073ec204c3b01adf3cc797763ed5567b4020c1dd6ba2d5a644736a4ba8cad282b645428bc97a8c9dc5e9c0bda1a22c3e457b4c326e3e2bc

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+doc/*
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 James McKinney
+
+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,56 @@
+# Netstring: A netstring parser and emitter
+
+[![Gem Version](https://badge.fury.io/rb/netstring.svg)](http://badge.fury.io/rb/netstring)
+[![Build Status](https://secure.travis-ci.org/jpmckinney/netstring.png)](http://travis-ci.org/jpmckinney/netstring)
+[![Dependency Status](https://gemnasium.com/jpmckinney/netstring.png)](https://gemnasium.com/jpmckinney/netstring)
+[![Coverage Status](https://coveralls.io/repos/jpmckinney/netstring/badge.png)](https://coveralls.io/r/jpmckinney/netstring)
+[![Code Climate](https://codeclimate.com/github/jpmckinney/netstring.png)](https://codeclimate.com/github/jpmckinney/netstring)
+
+See the [netstring](http://cr.yp.to/proto/netstrings.txt) specification for details.
+
+## Usage
+
+```ruby
+require "netstring"
+```
+
+Dump:
+
+```ruby
+netstring = Netstring.dump("xyz") # "3:xyz,"
+```
+
+Load:
+
+```ruby
+string = Netstring.load("3:xyz,") # "xyz"
+```
+
+Get the netstring from which the string was loaded:
+
+```ruby
+string.netstring # "3:xyz,"
+```
+
+Load concatenated netstrings:
+
+```ruby
+netstring = "1:x,3:xyz,"
+string1 = Netstring.load(netstring1) # "x"
+offset = string1.netstring.size
+netstring = netstring[offset..-1]
+string2 = Netstring.load(netstring) # "xyz"
+```
+
+Load concatenated netstrings in a loop:
+
+```ruby
+netstring = "1:x,3:xyz,"
+strings = []
+until netstring.empty?
+  strings << Netstring.load(netstring)
+  netstring = netstring[strings.last.netstring.size..-1]
+end
+```
+
+Copyright (c) 2014 James McKinney, released under the MIT license

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/USAGE

@@ -0,0 +1 @@
+See README.md for full usage details.

data/lib/netstring.rb

@@ -0,0 +1,61 @@
+require 'delegate'
+
+# A netstring parser and emitter.
+#
+# @see http://cr.yp.to/proto/netstrings.txt
+class Netstring < SimpleDelegator
+  class Error < StandardError; end
+
+  # Returns the netstring.
+  #
+  # @return [String] the netstring
+  attr_reader :netstring
+
+  # Dumps a string to a netstring.
+  #
+  # @param [String] s a string
+  # @return [String] a netstring
+  def self.dump(s)
+    unless String === s
+      raise Error, "#{s.inspect} is not a String"
+    end
+    "#{s.size}:#{s},"
+  end
+
+  # Loads a string from a netstring.
+  #
+  # The netstring may be multiple concatenated netstrings.
+  #
+  # The return value is a `Netstring` object, whose `#to_s` method returns the
+  # string, and whose `#offset` method returns the length of the netstring.
+  #
+  # @param [String] n a netstring
+  # @return [Netstring] a string
+  def self.load(n)
+    unless String === n
+      raise Error, "#{n.inspect} is not a String"
+    end
+    match = n.match(/\A(\d+):/)
+    unless match
+      raise Error, 'bad netstring header'
+    end
+    size = Integer(match[1])
+    unless n[match.end(0) + size] == ','
+      raise Error, 'expected "," delimiter'
+    end
+    Netstring.new(n, match.end(0), size)
+  end
+
+  # Initializes a netstring.
+  #
+  # The netstring may be multiple concatenated netstrings.
+  #
+  # @param [String] n a netstring
+  # @param [Integer] start the start of the string in the netstring
+  # @param [Integer] length the length of the string in the netstring
+  def initialize(n, start, length)
+    super(n[start, length])
+
+    @netstring = n[0, start + length + 1]
+  end
+end

data/netstring.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "netstring"
+  s.version     = "0.0.2"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["James McKinney"]
+  s.homepage    = "http://github.com/jpmckinney/netstring"
+  s.summary     = %q{A netstring parser and emitter}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('coveralls')
+  s.add_development_dependency('json', '~> 1.8') # to silence coveralls warning
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rspec', '~> 3.1')
+end

data/spec/netstring_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+RSpec.describe Netstring do
+  let :strings do
+    {
+      '' => '0:,',
+      'x' => '1:x,',
+      'xy' => '2:xy,',
+    }
+  end
+
+  let :netstrings do
+    strings.invert
+  end
+
+  describe '.dump' do
+    it 'should dump a netstring' do
+      strings.each do |string,netstring|
+        expect(Netstring.dump(string)).to eq(netstring)
+      end
+    end
+
+    it 'should not dump a non-string' do
+      {
+        nil => 'nil',
+        true => 'true',
+        false => 'false',
+        1 => '1',
+        1.1 => '1.1',
+        [] => '[]',
+        {} => '{}',
+      }.each do |nonstring,inspect|
+        expect{Netstring.dump(nonstring)}.to raise_error(Netstring::Error, "#{inspect} is not a String")
+      end
+    end
+  end
+
+  describe '.load' do
+    it 'should load a netstring' do
+      netstrings.each do |netstring,string|
+        expect(Netstring.load(netstring)).to eq(string)
+      end
+    end
+
+    it 'should not load a nonstring' do
+      {
+        nil => 'nil',
+        true => 'true',
+        false => 'false',
+        1 => '1',
+        1.1 => '1.1',
+        [] => '[]',
+        {} => '{}',
+      }.each do |nonstring,inspect|
+        expect{Netstring.load(nonstring)}.to raise_error(Netstring::Error, "#{inspect} is not a String")
+      end
+    end
+
+    it 'should not load a non-netstring' do
+      [
+        ['1', ':', 'x', ','],
+        ['1', ':', 'xy', ','],
+        ['2', ':', 'x', ','],
+      ].each do |tokens|
+        1.upto(4) do |n|
+          tokens.permutation(n) do |p|
+            nonnetstring = p.join
+            unless ['1:x,'].include?(nonnetstring)
+              expect{Netstring.load(nonnetstring)}.to raise_error(Netstring::Error)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  describe '#initialize' do
+    it 'should initialize a netstring' do
+      expect(Netstring.new('1:x,2:xy,', 2, 1)).to eq('x')
+    end
+  end
+
+  describe '#netstring' do
+    it 'should return the netstring' do
+      expect(Netstring.new('1:x,2:xy,', 2, 1).netstring).to eq('1:x,')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+require 'simplecov'
+require 'coveralls'
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require 'rspec'
+require File.dirname(__FILE__) + '/../lib/netstring'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: netstring
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- James McKinney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- USAGE
+- lib/netstring.rb
+- netstring.gemspec
+- spec/netstring_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jpmckinney/netstring
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A netstring parser and emitter
+test_files:
+- spec/netstring_spec.rb
+- spec/spec_helper.rb