stream_lines 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c2fd50863a37c75523351cac80ccecf777bd54a06c72544558ffa825b63531
-  data.tar.gz: cda429e3f9e80828196874ea92834043e4bc4d87835aa16b8464a4b10061af4d
+  metadata.gz: e013c9cf1743dc898ba15674efbd7580f8adb5c6a9e9c51f809aa909396d757c
+  data.tar.gz: fc035c2bf4443ff31ad72c0b4b49fa12c49249a9ac69dd497d5e693fa3e59c26
 SHA512:
-  metadata.gz: 1176bdabbc7a563b23fcbe14cd7edee5ab1070c7e3b8949eea51ec087c04504acb58ffecff33387a0e00f67ee83df449aa84a90debf2629dd829e76fcf3112e3
-  data.tar.gz: d98cbf64f7fd4ccd10f7f2ba183f5316a9e704dd8572ba5c79d21653e6045a304d5f229d86cf437b38db9ef1c31e7ab390d0eb3befcba8e06af7a615c8a854cd
+  metadata.gz: 1b90ff2f6d5e448a860acb2239d502c65bbbe5e42cf172b05ab13fb33dbbbe9128ddac072fffda287713d858d34723f2a210e741ce283d3978183ac9392dba24
+  data.tar.gz: 2fe851b3093d5c64b78f7e0112f132310f53ae2b6a254ec46d0bbdd35187dd1a4f26cd532fd51146fecfd88e11b8e33d1e0e4c817307b7e8c8a34aceed6d5362

data/.rubocop.yml

@@ -7,7 +7,7 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*.rb'
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 99
 
 Style/Documentation:

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.4
+ruby-2.7.0

data/.travis.yml

@@ -2,6 +2,7 @@
 language: ruby
 cache: bundler
 rvm:
+  - 2.7.0
   - 2.6.0
   - 2.5.0
 before_install: gem install bundler -v 2.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stream_lines (0.1.0)
+    stream_lines (0.2.0)
       httparty (~> 0.14)
 
 GEM
@@ -16,7 +16,7 @@ GEM
       bundler (>= 1.2.0, < 3)
       thor (~> 0.18)
     bundler-gem_version_tasks (0.2.1)
-    byebug (11.0.1)
+    byebug (11.1.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -25,24 +25,24 @@ GEM
     get_process_mem (0.2.5)
       ffi (~> 1.0)
     hashdiff (1.0.0)
-    httparty (0.17.1)
+    httparty (0.17.3)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     jaro_winkler (1.5.4)
-    json (2.2.0)
     memory_profiler (0.9.14)
-    mime-types (3.3)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.1009)
     multi_json (1.14.1)
     multi_xml (0.6.0)
-    mustermann (1.0.3)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
     parallel (1.19.1)
-    parser (2.6.5.0)
+    parser (2.7.0.2)
       ast (~> 2.4.0)
-    public_suffix (4.0.1)
-    rack (2.0.7)
-    rack-protection (2.0.7)
+    public_suffix (4.0.3)
+    rack (2.0.8)
+    rack-protection (2.0.8.1)
       rack
     rainbow (3.0.0)
     rake (13.0.1)
@@ -50,45 +50,45 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
     rspec-expectations (3.9.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (0.77.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
     safe_yaml (1.0.5)
-    simplecov (0.17.1)
+    simplecov (0.18.1)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sinatra (2.0.7)
+      simplecov-html (~> 0.11.0)
+    simplecov-html (0.11.0)
+    sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
-      rack-protection (= 2.0.7)
+      rack-protection (= 2.0.8.1)
       tilt (~> 2.0)
-    sinatra-contrib (2.0.7)
+    sinatra-contrib (2.0.8.1)
       backports (>= 2.8.2)
       multi_json
       mustermann (~> 1.0)
-      rack-protection (= 2.0.7)
-      sinatra (= 2.0.7)
+      rack-protection (= 2.0.8.1)
+      sinatra (= 2.0.8.1)
       tilt (~> 2.0)
     thor (0.20.3)
     tilt (2.0.10)
     unicode-display_width (1.6.0)
-    webmock (3.7.6)
+    webmock (3.8.1)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -106,7 +106,7 @@ DEPENDENCIES
   memory_profiler
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 0.77.0)
+  rubocop (~> 0.79.0)
   simplecov (~> 0.17)
   sinatra (~> 2.0)
   sinatra-contrib (~> 2.0)

data/README.md

@@ -1,5 +1,7 @@
 # StreamLines
 
+[![Build Status](https://travis-ci.com/jdlubrano/stream_lines.svg?branch=master)](https://travis-ci.com/jdlubrano/stream_lines)
+
 An API for streaming files from remote locations one line at a time.
 
 ## Background
@@ -50,6 +52,39 @@ stream.each_slice(100) do |lines|
 end
 ```
 
+##### CSVs
+
+This gem provides first-class support for streaming CSVs from a remote URL.
+
+```ruby
+url = 'https://my.remote.file/file.csv'
+stream = StreamLines::Reading::CSV.new(url)
+
+stream.each do |row|
+  # each row will be an array
+end
+
+# Supports most Ruby CSV options (see ignored options below)
+stream = StreamLines::Reading::CSV.new(url, headers: true)
+
+stream.each do |row|
+  # each row is a CSV::Row object that you can access like row['column_name']
+end
+```
+
+Most options that you can pass to
+[Ruby's CSV library](https://ruby-doc.org/stdlib-2.6.1/libdoc/csv/rdoc/CSV.html#method-c-new)
+are supported; however, the following options are explicitly ignored:
+
+* `return_headers`
+* `header_converters`
+* `skip_lines`
+
+I suspect that these options are not used terribly frequently, and each would
+require additional logic in the `StreamLines::Reading::CSV#each` method.
+Rather than attempting to implement sensible solutions for these options, I am
+choosing to explicitly ignore them until there is enough outcry to support them.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/stream_lines/reading/csv.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'csv'
+require 'stream_lines/error'
+require 'stream_lines/reading/stream'
+
+module StreamLines
+  module Reading
+    class CSV
+      # NOTE: (jdlubrano)
+      # I suspect that these options are not used terribly frequently, and each
+      # would require additional logic in the #each method.  Rather than
+      # attempting to implement sensible solutions for these options, I am
+      # choosing to explicitly ignore them until there is enough outcry to
+      # support them.
+      IGNORED_CSV_OPTIONS = %i[
+        return_headers
+        header_converters
+        skip_lines
+      ].freeze
+
+      include Enumerable
+
+      def initialize(url, **csv_options)
+        @url = url
+        @csv_options = accepted_csv_options(csv_options)
+        @stream = Stream.new(url)
+      end
+
+      def each(&block)
+        @stream.each_with_index do |line, i|
+          next assign_first_row_headers(line) if i.zero? && first_row_headers?
+
+          block.call(::CSV.parse_line(line, **@csv_options))
+        end
+      end
+
+      private
+
+      attr_reader :url
+
+      def first_row_headers?
+        @csv_options[:headers] == true
+      end
+
+      def assign_first_row_headers(first_line)
+        header_row = ::CSV.parse_line(first_line)
+        @csv_options[:headers] = header_row
+      end
+
+      def accepted_csv_options(csv_options)
+        csv_options.transform_keys(&:to_sym)
+                   .delete_if { |key, _value| IGNORED_CSV_OPTIONS.include?(key) }
+      end
+    end
+  end
+end

data/lib/stream_lines/version.rb

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

data/stream_lines.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'memory_profiler'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 0.77.0'
+  spec.add_development_dependency 'rubocop', '~> 0.79.0'
   spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'sinatra', '~> 2.0'
   spec.add_development_dependency 'sinatra-contrib', '~> 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream_lines
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Lubrano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-30 00:00:00.000000000 Z
+date: 2020-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 0.79.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.77.0
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -244,6 +244,7 @@ files:
 - lib/stream_lines.rb
 - lib/stream_lines/error.rb
 - lib/stream_lines/reading.rb
+- lib/stream_lines/reading/csv.rb
 - lib/stream_lines/reading/stream.rb
 - lib/stream_lines/version.rb
 - stream_lines.gemspec
@@ -269,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A utility to stream lines of a file over HTTP