stream_lines 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e832d9790c71431c43722f116cca885d3fee985001b12f5d0c53cc17e78c7b8
-  data.tar.gz: 76338bc7e203bfa59f3aed2469db3694951dfd5905c6bcfe416b08f1512f3289
+  metadata.gz: d12669d8a8c0f786d731b6fb98374e4105b483379e6ad9b0cb346a62289c5481
+  data.tar.gz: 67607b92517c8b6151e576258314ed4896344893b1a5160602e018aa0aae7d28
 SHA512:
-  metadata.gz: 3d980bdddd41227418da10447e57599ee94cea52b7ea926e1cb3f0efd8a3b71b7e8f44c70ed7a62dc37ea31ac97e84a1f5d20677ecb933bd26be7c2348e533c5
-  data.tar.gz: 721610a59f59862772b0ea259b6f22c0e84f058d458538ae993478324e9e315dc6fa0b469eaebb56fd630f59bd43b3bb43956f2111855c22cb00bb744296018c
+  metadata.gz: 178c5fc570b8dba9330efcd6493b2437fdbd6ed277e3ec653d7c6e436fcb959fea89110781059e5a6acf3e821fa5cb098afcee35664dbac028469baf3542f5cf
+  data.tar.gz: a9e08b3b01ad37fd2daf0e1e10ed729fb8ceabe0e151c2e147c0d131216bf2f1cca2562240890db816a869fc2c7f8c52618796769b20cb8c92e920b16cf11ff0

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "10:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - 1.12.0

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,32 @@
+name: Tests (Ruby)
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version:
+          - 2.6
+          - 2.7
+          - 3.0
+          - 3.1
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Ruby version
+        run: ruby -v
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake

data/.github/workflows/{ci-tests.yml → style-check.yml}

@@ -5,7 +5,7 @@
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
-name: Tests
+name: Style Check
 
 on:
   push:
@@ -16,15 +16,15 @@ on:
       - '*'
 
 jobs:
-  test:
+  rubocop:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: 3.0
     - name: Install dependencies
       run: bundle install
-    - name: Run tests
-      run: bundle exec rake
+    - name: Run Rubocop
+      run: bundle exec rubocop -D

data/.rubocop.yml

@@ -1,4 +1,6 @@
 AllCops:
+  NewCops: 'enable'
+  TargetRubyVersion: 2.5
   Exclude:
     - '*.gemspec'
     - 'vendor/bundle/**/*'

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.0
+3.1.2

data/Gemfile.lock

@@ -1,84 +1,85 @@
 PATH
   remote: .
   specs:
-    stream_lines (0.4.0)
+    stream_lines (0.4.1)
       httparty (~> 0.14)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.1)
-    awesome_print (1.8.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
     backports (3.17.2)
-    bundler-audit (0.7.0.1)
+    bundler-audit (0.9.0.1)
       bundler (>= 1.2.0, < 3)
-      thor (>= 0.18, < 2)
+      thor (~> 1.0)
     bundler-gem_version_tasks (0.2.1)
     byebug (11.1.3)
     charlock_holmes (0.7.7)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.2)
-    ffi (1.13.0)
-    get_process_mem (0.2.5)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.3.4)
+    ffi (1.13.1)
+    get_process_mem (0.2.7)
       ffi (~> 1.0)
     hashdiff (1.0.1)
-    httparty (0.18.1)
+    httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    memory_profiler (0.9.14)
+    memory_profiler (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
+    mime-types-data (3.2021.0901)
     multi_json (1.14.1)
     multi_xml (0.6.0)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.22.1)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.5)
+    public_suffix (4.0.6)
     rack (2.2.3)
     rack-protection (2.0.8.1)
       rack
-    rainbow (3.0.0)
-    rake (13.0.1)
-    regexp_parser (1.7.1)
-    rexml (3.2.4)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    rubocop (0.87.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.1.0)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.2)
-    safe_yaml (1.0.5)
-    simplecov (0.18.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     sinatra (2.0.8.1)
       mustermann (~> 1.0)
       rack (~> 2.0)
@@ -91,13 +92,14 @@ GEM
       rack-protection (= 2.0.8.1)
       sinatra (= 2.0.8.1)
       tilt (~> 2.0)
-    thor (1.0.1)
+    thor (1.1.0)
     tilt (2.0.10)
-    unicode-display_width (1.7.0)
-    webmock (3.8.3)
-      addressable (>= 2.3.6)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    webrick (1.7.0)
 
 PLATFORMS
   ruby
@@ -113,12 +115,13 @@ DEPENDENCIES
   memory_profiler
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop (~> 0.87.1)
+  rubocop (~> 1.27.0)
   simplecov (~> 0.17)
   sinatra (~> 2.0)
   sinatra-contrib (~> 2.0)
   stream_lines!
   webmock (~> 3.0)
+  webrick (~> 1.7)
 
 BUNDLED WITH
-   2.0.2
+   2.3.11

data/README.md

@@ -1,7 +1,7 @@
 # StreamLines
 
 [![Gem Version](https://badge.fury.io/rb/stream_lines.svg)](https://badge.fury.io/rb/stream_lines)
-![](https://github.com/jdlubrano/stream_lines/workflows/Tests/badge.svg)
+[![Tests (Ruby)](https://github.com/jdlubrano/stream_lines/actions/workflows/ruby-tests.yml/badge.svg)](https://github.com/jdlubrano/stream_lines/actions/workflows/ruby-tests.yml)
 
 An API for streaming files from remote locations one line at a time.
 
@@ -55,6 +55,37 @@ stream.each_slice(100) do |lines|
 end
 ```
 
+##### Caveats
+
+This library strives to provide streamed data via an `Enumerable` interface.
+In order to be memory-efficient, however, each time the stream is iterated over,
+a new GET request is made to fetch the data from its remote URL.  For example,
+
+```ruby
+url = 'https://my.remote.file/file.txt'
+stream = StreamLines::Reading::Stream.new(url)
+do_something_with_first_row(stream.first) # GET request made
+
+stream.each do |line| # same GET request made
+  # Do something with the line of data (the line will be a String)
+end
+```
+
+makes two GET requests.  The call to `first` makes a GET request to fetch
+the first row of data.  The subsequent call to `each` makes the same GET
+request.  To avoid unnecessary requests, I recommend a slightly different
+approach, which may not be intuitive but does make only one network request:
+
+```
+url = 'https://my.remote.file/file.txt'
+stream = StreamLines::Reading::Stream.new(url)
+
+stream.each_with_index do |line, i|
+  do_something_with_first_row(line) if i.zero?
+  # Do something with the line of data (the line will be a String)
+end
+```
+
 ##### CSVs
 
 This gem provides first-class support for streaming CSVs from a remote URL.

data/lib/stream_lines/reading/csv.rb

@@ -23,6 +23,7 @@ module StreamLines
       def initialize(url, **csv_options)
         @url = url
         @csv_options = accepted_csv_options(csv_options)
+        @first_row_headers = @csv_options[:headers] == true
 
         encoding = @csv_options[:encoding] || Encoding.default_external
         @stream = Stream.new(url, encoding: encoding)
@@ -41,7 +42,7 @@ module StreamLines
       attr_reader :url
 
       def first_row_headers?
-        @csv_options[:headers] == true
+        @first_row_headers
       end
 
       def assign_first_row_headers(first_line)

data/lib/stream_lines/version.rb

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

data/stream_lines.gemspec

@@ -38,9 +38,10 @@ 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.87.1'
+  spec.add_development_dependency 'rubocop', '~> 1.27.0'
   spec.add_development_dependency 'simplecov', '~> 0.17'
   spec.add_development_dependency 'sinatra', '~> 2.0'
   spec.add_development_dependency 'sinatra-contrib', '~> 2.0'
+  spec.add_development_dependency 'webrick', '~> 1.7'
   spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stream_lines
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Joel Lubrano
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2022-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: 1.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.87.1
+        version: 1.27.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -234,14 +248,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - joel.lubrano@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci-tests.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
+- ".github/workflows/style-check.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -270,7 +286,7 @@ metadata:
   homepage_uri: https://github.com/jdlubrano/stream_lines
   source_code_uri: https://github.com/jdlubrano/stream_lines
   changelog_uri: https://github.com/jdlubrano/stream_lines/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -285,8 +301,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: A utility to stream lines of a file over HTTP
 test_files: []