ltsv 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.sw*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 condor
+
+MIT License
+
+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,69 @@
+# Ltsv
+
+LTSV: A Parser / Dumper for Labelled Tab-Separated Values (LTSV)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ltsv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ltsv
+
+## Usage
+
+At first, you should require ltsv:
+
+    require 'ltsv'
+
+In addition, if you manage gems with bundler, you should add the statement below into your Gemfile:
+
+    gem 'ltsv'
+
+
+### parsing LTSV
+
+    # parse string
+    string = "label1:value1\tlabel2:value2"
+    values = LTSV.parse(string) # => {:label1 => "value1", :label2 => "value2"}
+
+    # parse via stream
+    # content: as below
+    # label1_1:value1_1\tlabel1_2:value1_2
+    # label2_1:value2_1\tlabel2_2:value2_2
+    stream = File.open("some_file.ltsv", "r")
+    values = LTSV.parse(stream)
+    # => [{:label1_1 => "value1_2", :label1_2 => "value1_2"},
+    #     {:label2_1 => "value2_2", :label2_2 => "value2_2"}]
+
+Current limitation: parsed string should be in one line. If you include any special chars that may affect to the processing( "\r", "\n", "\t", "\\"), you should properly escape it with backslash.
+
+### loading LTSV file
+
+    # parse via path
+    values = LTSV.parse("some_path.ltsv")
+
+    # parse via stream
+    stream = File.open("some_file.ltsv", "r")
+    values = LTSV.load(stream) # => same as LTSV.parse(stream)
+
+### dumping into LTSV
+
+    value = {label1: "value1", label2: "value2"}
+    dumped = LTSV.dump(value) # => "label1:value1\tlabel2:value2"
+
+Dumped objects should respond to :to_hash.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/ltsv.rb

@@ -0,0 +1,140 @@
+# = ltsv - A parser / dumper for Labelled Tab-Separated Values(LTSV)
+#
+# Copyright (C) 2013 TOYODA Naoto.
+#
+#
+module LTSV
+  VERSION = "0.0.1"
+
+  # Parsing given stream or string.
+  # If you specified a stream as the first argument,
+  # this method behaves as same as #load.
+  #
+  # == Arguments:
+  # * _io_or_string_: a target to parse. Possible values are: String, IO.  
+  #   If you give the string value, it stands the content to parse.  
+  #   If you give the IO value, it stands the stream which provides the contents to parse.
+  # == Options:
+  # * _symbolize_keys_ : Whether the label will be available as symbol or not.  
+  #   Default value is true.
+  # * _encoding_ : The encoding of the stream given as the first argument.  
+  #   It is effective only when the first argument is an instance of IO.  
+  #   Default value: Encoding.default_external
+  # == Returns:
+  # * An instance of Hash : When you give the string as the first argument.
+  # * An Array of Hash : When you give the IO as the first argument.
+  def parse(io_or_string, options = {})
+    case io_or_string
+    when String
+      parse_string(io_or_string, options)
+    when IO
+      parse_io(io_or_string = {})
+    end
+  end
+
+  # Parsing the content of the given stream or path.
+  # If you specified a stream as the first argument,
+  # this method behaves as same as #load.
+  #
+  # == Arguments:
+  # * _io_or_string_: a target to parse. Possible values are: String, IO.  
+  #   If you give the string value, it stands the path of the file to parse.  
+  #   If you give the IO value, it stands the stream which provides the contents to parse.  
+  #   *Note* : If you give the IO value, this method behaves like #parse.
+  # == Options:
+  # * _symbolize_keys_ : Whether the label will be available as symbol or not.  
+  #   Default value is true.
+  # * _encoding_ : The encoding of the stream given as the first argument.  
+  #   Default value: Encoding.default_external
+  # == Returns:
+  # * An Array of Hash : Each hash stands for a line of the io or the file.
+  def load(io_or_string, options = {})
+    encoding_opt = options.delete :encoding
+    encoding =
+      encoding_opt ? Encoding.find(encoding_opt) : Encoding.default_external
+
+    case io_or_string
+    when String
+      File.open(io_or_string, "r:#{encoding}"){|f|parse_io(f)}
+    when IO
+      parse_io(io)
+    end
+  end
+
+  # Dumping the value given into a new String.
+  # Each special character will be escaped with backslash('\'), and the expression should be contained in a single line.
+  #
+  # == Arguments:
+  # * _value_: a target to dump. It should respond to :to_hash.
+  # == Returns:
+  # * A LTSV String
+  def dump(value)
+    raise ArgumentError, "dump should take an argument of hash" unless
+      value.respond_to? :to_hash
+
+    hash = value.to_hash
+
+    hash.inject('') do |s, kv|
+      s << "\t" if s.bytesize > 0
+
+      (k, v) = kv
+      value = escape v
+      s << k.to_s << ':' << value
+    end
+  end
+
+  private
+
+  def parse_io(io, options)#:nodoc:
+    io.map{|l|parse_string l, options}
+  end
+
+  def parse_string(string, options)#:nodoc:
+    symbolize_keys = options.delete(:symbolize_keys)
+    symbolize_keys = true if symbolize_keys.nil?
+
+    string.split("\t").inject({}) do |h, i|
+      (key, value) = i.split(':', 2)
+      key = key.to_sym if symbolize_keys
+      unescape!(value)
+      h[key] = value.empty? ? nil : value
+      h
+    end
+  end
+
+  def unescape!(string)#:nodoc:
+    return nil if !string || string == ''
+
+    string.gsub!(/\\([a-z\\])/) do |m|
+      case $1
+      when 'r'
+        "\r"
+      when 'n'
+        "\n"
+      when 't'
+        "\t"
+      when '\\'
+        '\\'
+      else
+        m
+      end
+    end
+  end
+
+  def escape(string)#:nodoc:
+    value = string.kind_of?(String) ? string.dup : string.to_s
+
+    value.gsub!("\\", "\\\\")
+    value.gsub!("\n", "\\n")
+    value.gsub!("\r", "\\r")
+    value.gsub!("\t", "\\t")
+
+    value
+  end
+
+  module_function :load, :parse, :dump, :parse_io, :parse_string, :unescape!, :escape
+
+  class <<self
+    private :parse_io, :parse_string, :unescape!, :escape
+  end
+end

data/ltsv.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ltsv'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ltsv"
+  gem.version       = LTSV::VERSION
+  gem.authors       = ["condor"]
+  gem.email         = ["condor1226@gmail.com"]
+  gem.description   = %q{A Parser / Dumper for LTSV}
+  gem.summary       = %q{A Parser / Dumper for LTSV}
+  gem.homepage      = "https://github.com/condor/ltsv"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec'
+end

data/spec/ltsv_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe LTSV do
+
+  describe :parse do
+    context 'String argument' do
+      it 'can parse labeled tab separated values into hash' do
+        line = "label1:value1\tlabel2:value2"
+        LTSV.parse(line).should == {:label1 => 'value1', :label2 => 'value2'}
+      end
+
+      it 'can parse the value that contains escape sequences' do
+
+        LTSV.parse("label1:value1\tlabel2:value\\nvalue").should ==
+          {:label1 => 'value1', :label2 => "value\nvalue"}
+
+        LTSV.parse("label1:value1\tlabel2:value\\rvalue").should ==
+          {:label1 => 'value1', :label2 => "value\rvalue"}
+
+        LTSV.parse("label1:value1\tlabel2:value\\tvalue").should ==
+          {:label1 => 'value1', :label2 => "value\tvalue"}
+
+        LTSV.parse("label1:value1\tlabel2:value\\\\value").should ==
+          {:label1 => 'value1', :label2 => "value\\value"}
+      end
+
+      it 'parses the value as-is when the backslash with a following ordinal character' do
+
+        LTSV.parse("label1:value1\tlabel2:value\\avalue").should ==
+          {:label1 => 'value1', :label2 => "value\\avalue"}
+      end
+
+      it 'parses the empty value field as nil' do
+        LTSV.parse("label1:\tlabel2:value2").should ==
+          {:label1 => nil, :label2 => 'value2'}
+      end
+    end
+  end
+
+  describe :load do
+  end
+
+  describe :dump do
+
+    specify 'dump into the format "label1:value1\tlabel2:value2"' do
+      LTSV.dump({:label1 => "value1", :label2 => "value2"}).should ==
+        "label1:value1\tlabel2:value2"
+    end
+
+    specify 'CRs, LFs, TABs, and backslashes in the value should be escaped' do
+      LTSV.dump({:label1 => "value\rvalue"}).should == "label1:value\\rvalue"
+      LTSV.dump({:label1 => "value\nvalue"}).should == "label1:value\\nvalue"
+      LTSV.dump({:label1 => "value\tvalue"}).should == "label1:value\\tvalue"
+      LTSV.dump({:label1 => "value\\value"}).should == "label1:value\\value"
+    end
+
+    specify ':s in the value should not be escaped' do
+      LTSV.dump({:label1 => "value:value"}).should == "label1:value:value"
+    end
+
+    specify 'should not fail when object to dump responds to :to_hash' do
+      target = Object.new
+      target.instance_eval do
+        def to_hash
+          {:label => 'value'}
+        end
+      end
+      LTSV.dump(target).should == "label:value"
+    end
+
+    specify 'fails when object to dump does not respond to :to_hash' do
+      lambda{LTSV.dump(Object.new)}.should raise_exception(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'ltsv'))

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: ltsv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- condor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Parser / Dumper for LTSV
+email:
+- condor1226@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ltsv.rb
+- ltsv.gemspec
+- spec/ltsv_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/condor/ltsv
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Parser / Dumper for LTSV
+test_files:
+- spec/ltsv_spec.rb
+- spec/spec_helper.rb