tsv 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dccfc4465a2459edbb3847afe9a97085a30c246a
-  data.tar.gz: 8f6c86869945c3bae1a9653b91fc7c7b5fdfa0f0
+  metadata.gz: 901a06d59683d6bb8df05d6298bf0157ef09dac2
+  data.tar.gz: 76f1f731eb6d4bf236bfac4349c503fa5b734296
 SHA512:
-  metadata.gz: 0151a2a89fc5141711095bdc0f2f0fcb03de963947802cee913eeca5a19acfa18574c38978fa68f3012603399074bf68b13d079ee78979609f0e26fa3033b5ab
-  data.tar.gz: f6f18e7654c47a5a16721c4885e363beb2de78709806211a87da9b7684f86ddeff014c16df0ec3df8025463bce25df5606cfc4a10426c2d1831963c1fee10a9c
+  metadata.gz: 6b68ee097e32ef0c00b4066b1bcc4cc21efccde77a7af13661a1b7c108387ff1081fa4cd1a772eb4cb63871c2ff95baa786f21f262be04e2f8e30e1774063f21
+  data.tar.gz: 2643de24f05a2f19a0302954007720664f4af744266ddc0252152b467d1debecd8c4fa4f87010586662a5b6951ed68ab7764b4ab651baa1ccfebf1b85001fdbe

data/.travis.yml

@@ -9,7 +9,8 @@ rvm:
   - 2.0.0
   - 2.1.1
   - 2.1.2
-  - rbx-2.2.6
+  - 2.2.0
+  - rbx-2.5.1
   - jruby
 
 # Part of test suite - building gem and trying to require it via ruby -e
@@ -18,6 +19,6 @@ script: >
   rake build&&gem install pkg/tsv*.gem&&ruby -e 'require "tsv"; TSV.parse_file("spec/fixtures/example.tsv").to_a'&&rake
 
 matrix:
-  allow_failures: 
-    - rvm: rbx-2.2.6
+  allow_failures:
+    - rvm: rbx-2.5.1
     - rvm: jruby

data/CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased][unreleased]
 
+## [1.0.0] - 2015-02-14
+### Changed
+- Reworked Cyclist into Table
+
 ## [0.0.3] - 2014-12-26
 ### Fixed
 - Fixed case with empty column contents in TSV
@@ -12,13 +16,14 @@ All notable changes to this project will be documented in this file.
 
 ## [0.0.2] - 2014-08-13
 ### Changed
-- Internal refactorings
+- Internal refactoring
 
 ### Added
 - Testing built gem integrity via CI
 
 Changelog format taken from [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog)
 
-[unreleased]: https://github.com/mimimi/ruby-tsv/compare/v0.0.3...master
+[unreleased]: https://github.com/mimimi/ruby-tsv/compare/v1.0.0...master
+[1.0.0]: https://github.com/mimimi/ruby-tsv/compare/v0.0.3...v1.0.0
 [0.0.3]: https://github.com/mimimi/ruby-tsv/compare/v0.0.2...v0.0.3
 [0.0.2]: https://github.com/mimimi/ruby-tsv/compare/v0.0.1...v0.0.2

data/Gemfile

@@ -3,7 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in tsv.gemspec
 gemspec
 
-gem "codeclimate-test-reporter", group: :test, require: nil
-gem "rake"
-gem "rspec"
-gem "pry"
+group "test" do
+  gem "codeclimate-test-reporter", require: nil
+  gem "rake"
+  gem "rspec", "~> 3.1.0"
+  gem "pry"
+end

data/README.md

@@ -27,16 +27,21 @@ Or install it yourself as:
 
 #### TSV::parse
 
-`TSV.parse` accepts TSV as a whole string, returning lazy enumerator, yielding TSV::Row objects on demand
+`TSV.parse` accepts basically anything that can enumerate over lines, for example:
+
+* TSV as a whole string
+* any IO object - a TSV file pre-opened with `File.open`, `StringIO` buffer containing TSV data, etc
+
+It returns a lazy enumerator, yielding TSV::Row objects on demand.
 
 #### TSV::parse_file
 
 `TSV.parse_file` accepts path to TSV file, returning lazy enumerator, yielding TSV::Row objects on demand
 `TSV.parse_file` is also aliased as `[]`, allowing for `TSV[filename]` syntax
 
-#### TSV::Cyclist
+#### TSV::Table
 
-While TSV specification requires headers, popular use doesn't necessarily adhere. In order to cope both `TSV::parse` and `TSV::parse_file` return Cyclist objects, that apart from acting as enumerators expose two additional methods: `#with_headers` and `#without_headers`.  Neither method preserves read position by design.
+While TSV specification requires headers, popular use doesn't necessarily adhere. In order to cope both `TSV::parse` and `TSV::parse_file` return `TSV::Table` object, that apart from acting as enumerator exposes two additional methods: `#with_headers` and `#without_headers`.  Neither method preserves read position by design.
 
 #### TSV::Row
 

data/lib/tsv.rb

@@ -2,17 +2,17 @@ require 'forwardable'
 
 require "tsv/version"
 require "tsv/row"
-require "tsv/cyclist"
+require "tsv/table"
 
 module TSV
   extend self
 
   def parse(content, opts = {}, &block)
-    TSV::StringCyclist.new(content, opts, &block)
+    TSV::Table.new(content, opts, &block)
   end
-  
+
   def parse_file(filename, opts = {}, &block)
-    TSV::FileCyclist.new(filename, opts, &block)
+    TSV::Table.new(File.new(filename, 'r'), opts, &block)
   end
 
   alias :[] :parse_file

data/lib/tsv/{cyclist.rb → table.rb}

@@ -1,5 +1,5 @@
 module TSV
-  class Cyclist
+  class Table
     extend Forwardable
 
     def_delegators :enumerator, *Enumerator.instance_methods(false)
@@ -8,8 +8,8 @@ module TSV
     attr_accessor :source, :header
 
     def initialize(source, params = {}, &block)
-      self.header   = params.fetch(:header, true)
-      self.source = source.to_s
+      self.header = params.fetch(:header, true)
+      self.source = source
       self.enumerator.each(&block) if block_given?
     end
 
@@ -44,6 +44,10 @@ module TSV
       end
     end
 
+    def data_enumerator
+      source.each_line
+    end
+
     protected
 
     def generate_row_from(str)
@@ -54,18 +58,4 @@ module TSV
       (0...example_line.length).to_a.map(&:to_s)
     end
   end
-
-  class FileCyclist < Cyclist
-    alias :filepath :source
-
-    def data_enumerator
-      File.new(self.source).each_line
-    end
-  end
-
-  class StringCyclist < Cyclist
-    def data_enumerator
-      source.each_line
-    end
-  end
 end

data/lib/tsv/version.rb

@@ -1,3 +1,3 @@
 module TSV
-  VERSION = "0.0.3"
+  VERSION = "1.0.0"
 end

data/spec/{support/cyclist_generic.rb → lib/tsv/table_spec.rb}

@@ -1,4 +1,14 @@
-shared_examples_for "Cyclist" do
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper.rb')
+
+describe TSV::Table do
+  let(:source) { IO.read(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', filename)) }
+  let(:filename) { 'example.tsv' }
+
+  let(:header) { true }
+  let(:parameters) { { header: header } }
+
+  subject(:table) { TSV::Table.new(source, parameters) }
+
   describe "::new" do
     it "initializes header to true by default" do
       expect(subject.header).to be true
@@ -25,8 +35,8 @@ shared_examples_for "Cyclist" do
   end
 
   describe "#enumerator" do
-    it { expect(cyclist.enumerator).to be_a_kind_of(Enumerator) }
-    subject { cyclist.enumerator.to_a }
+    it { expect(table.enumerator).to be_a_kind_of(Enumerator) }
+    subject { table.enumerator.to_a }
 
     context "string is empty" do
       let(:filename) { 'empty.tsv' }
@@ -83,17 +93,17 @@ shared_examples_for "Cyclist" do
   end
 
   describe "#with_header" do
-    subject { cyclist.with_header }
-    
-    it "returns a Cyclist with header option set to true" do
+    subject { table.with_header }
+
+    it "returns a Table with header option set to true" do
       expect(subject.header).to be true
     end
   end
 
   describe "#without_header" do
-    subject { cyclist.without_header }
+    subject { table.without_header }
 
-    it "returns a Cyclist with header option set to false" do
+    it "returns a Table with header option set to false" do
       expect(subject.header).to be false
     end
   end
@@ -101,9 +111,9 @@ shared_examples_for "Cyclist" do
   describe "enumerator interfaces" do
     ( Enumerable.instance_methods(false) + Enumerator.instance_methods(false) ).each do |name|
       it "delegates #{name} to enumerator" do
-        expect(cyclist.enumerator).to receive(name)
-        cyclist.send(name)
+        expect(table.enumerator).to receive(name)
+        table.send(name)
       end
     end
   end
-end
+end

data/spec/lib/tsv_spec.rb

@@ -5,28 +5,55 @@ describe TSV do
 
   describe "#parse" do
     let(:header) { nil }
-    let(:content) { IO.read(File.join(File.dirname(__FILE__), '..', 'fixtures', filename)) }
     let(:parameters) { { header: header } }
 
-    subject { TSV.parse(content, parameters) }
+    context "given a string with content" do
+      let(:content) { IO.read(File.join(File.dirname(__FILE__), '..', 'fixtures', filename)) }
 
-    it "returns String Cyclist initialized with given data" do
-      expect(subject).to be_a TSV::StringCyclist
-      expect(subject.source).to eq(content)
+      subject { TSV.parse(content, parameters) }
+
+      it "returns Table initialized with given data" do
+        expect(subject).to be_a TSV::Table
+        expect(subject.source).to eq(content)
+      end
+
+      context "when block is given" do
+        it "passes block to Table" do
+          data = []
+
+          TSV.parse(content) do |i|
+            data.push i
+          end
+
+          headers = %w{first second third}
+          expect(data).to eq [ TSV::Row.new( ['0', '1', '2'], headers ),
+                               TSV::Row.new( ['one', 'two', 'three'], headers ),
+                               TSV::Row.new( ['weird data', 's@mthin#', 'else'], headers ) ]
+        end
+      end
     end
 
-    context "when block is given" do
-      it "passes block to Cyclist" do
+    context "given a opened IO object" do
+      let(:content) { File.open(File.join(File.dirname(__FILE__), '..', 'fixtures', filename), 'r') }
+
+      subject { TSV.parse(content, parameters) }
+
+      it "returns Table initialized with given data" do
+        expect(subject).to be_a TSV::Table
+        expect(subject.source).to eq(content)
+      end
+
+      it "can properly parse file" do
         data = []
-        
-        TSV.parse(content) do |i|
+
+        TSV.parse(content).each do |i|
           data.push i
         end
 
         headers = %w{first second third}
         expect(data).to eq [ TSV::Row.new( ['0', '1', '2'], headers ),
-                                TSV::Row.new( ['one', 'two', 'three'], headers ),
-                                TSV::Row.new( ['weird data', 's@mthin#', 'else'], headers ) ]
+                             TSV::Row.new( ['one', 'two', 'three'], headers ),
+                             TSV::Row.new( ['weird data', 's@mthin#', 'else'], headers ) ]
       end
     end
   end
@@ -36,13 +63,16 @@ describe TSV do
 
     subject { TSV.parse_file tsv_path }
 
-    it "returns Cyclist object initialized with given filepath" do
-      expect(subject).to be_a TSV::FileCyclist
-      expect(subject.filepath).to eq tsv_path
+    context "when no block is given" do
+      it "returns Table initialized with File object" do
+        expect(subject).to be_a TSV::Table
+        expect(subject.source).to be_kind_of(File)
+        expect(subject.source.path).to eq(tsv_path)
+      end
     end
 
     context "when block is given" do
-      it "passes block to Cyclist" do
+      it "passes block to Table" do
         data = []
 
         TSV.parse_file(tsv_path) do |i|
@@ -55,5 +85,27 @@ describe TSV do
                                 TSV::Row.new( ['weird data', 's@mthin#', 'else'], headers ) ]
       end
     end
+
+    context "when accessing unavailable files" do
+      subject { lambda { TSV.parse_file(tsv_path).to_a } }
+
+      context "when file is not found" do
+        let(:tsv_path) { "AManThatWasntThere.tsv" }
+
+        it "returns FileNotFoundException" do
+          expect(subject).to raise_error(Errno::ENOENT)
+        end
+      end
+    end
+
+    describe "intermediate file handle" do
+      it "raises IOError on write attempt" do
+        tempfile = Tempfile.new('tsv_test')
+        handle = TSV.parse_file(tempfile.path).source
+
+        expect{ handle.puts('test string please ignore') }.to raise_error(IOError, 'not opened for writing')
+      end
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tsv
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Dmytro Soltys
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies: []
 description: Streamed TSV parser
 email:
@@ -28,19 +28,17 @@ files:
 - README.md
 - Rakefile
 - lib/tsv.rb
-- lib/tsv/cyclist.rb
 - lib/tsv/row.rb
+- lib/tsv/table.rb
 - lib/tsv/version.rb
 - spec/fixtures/broken.tsv
 - spec/fixtures/empty-trailing.tsv
 - spec/fixtures/empty.tsv
 - spec/fixtures/example.tsv
-- spec/lib/tsv/file_cyclist_spec.rb
 - spec/lib/tsv/row_spec.rb
-- spec/lib/tsv/string_cyclist_spec.rb
+- spec/lib/tsv/table_spec.rb
 - spec/lib/tsv_spec.rb
 - spec/spec_helper.rb
-- spec/support/cyclist_generic.rb
 - spec/tsv_integration_spec.rb
 - tsv.gemspec
 homepage: ''
@@ -73,10 +71,8 @@ test_files:
 - spec/fixtures/empty-trailing.tsv
 - spec/fixtures/empty.tsv
 - spec/fixtures/example.tsv
-- spec/lib/tsv/file_cyclist_spec.rb
 - spec/lib/tsv/row_spec.rb
-- spec/lib/tsv/string_cyclist_spec.rb
+- spec/lib/tsv/table_spec.rb
 - spec/lib/tsv_spec.rb
 - spec/spec_helper.rb
-- spec/support/cyclist_generic.rb
 - spec/tsv_integration_spec.rb

data/spec/lib/tsv/file_cyclist_spec.rb

@@ -1,34 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper.rb')
-
-describe TSV::FileCyclist do
-  let(:tsv_path) { File.join(File.dirname(__FILE__), '..', '..', 'fixtures', filename) }
-  let(:source)   { tsv_path }
-  let(:filename) { 'example.tsv' }
-
-  let(:header) { true }
-  let(:parameters) { { header: header } }
-
-  subject(:cyclist) { TSV::FileCyclist.new(source, parameters) }
-
-  it_behaves_like "Cyclist"
-
-  describe "accessing unavailable files" do
-    subject { lambda { TSV::FileCyclist.new(tsv_path).to_a } }
-
-    context "when file is not found" do
-      let(:tsv_path) { "AManThatWasntThere.tsv" }
-
-      it "returns FileNotFoundException" do
-        expect(subject).to raise_error(Errno::ENOENT)
-      end
-    end
-
-    context "when filename is nil" do
-      let(:tsv_path) { nil }
-
-      it "returns FileNameInvalidException" do
-        expect(subject).to raise_error(Errno::ENOENT)
-      end
-    end
-  end
-end

data/spec/lib/tsv/string_cyclist_spec.rb

@@ -1,13 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper.rb')
-
-describe TSV::StringCyclist do
-  let(:source) { IO.read(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', filename)) }
-  let(:filename) { 'example.tsv' }
-
-  let(:header) { true }
-  let(:parameters) { { header: header } }
-
-  subject(:cyclist) { TSV::StringCyclist.new(source, parameters) }
-
-  it_behaves_like "Cyclist"
-end