scan_left 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f717b22685d20e15af612d1b6beb8da9266b8cf47bf0185e7139c04836d4197a
-  data.tar.gz: 1f570181040fe2b5ae8b5519af3d2f3d49e8b6a3dc8d3586b8b5420648ca8a74
+  metadata.gz: c1557332192560cf4af4dadfe859d6af3daa27fb7a15c4e73095cfbb3edc8e08
+  data.tar.gz: e868d3a5e20160daf7aae34d13a53cb28c8e92a63eda2efe0327bcd14e554421
 SHA512:
-  metadata.gz: cc9941d161ccfcfd7e3e6346f3e28a2d09ef513eb134efe6ac00dd61e3f9dbc58984f926d16203377fd35aae13b57c423f33657f3e0ff5ab261f2f552c73bda7
-  data.tar.gz: c1b151cb5caec96b10865a566134664243d611c71b470c6b0bb63f3eecb8e6b227eb16ebd20c9d4227ff34a5fc773bead9ed6ca6484034c4099dc03f44ea44b3
+  metadata.gz: 3dd492ba1423dcf94da46b80886e82eee00bf4316a788a8bb56a9650d89d2347a3bc84ebe0b89bd7ba2a4661396879f1804d8453c9ac20646756b3a9589dcc6c
+  data.tar.gz: 7fe9dd080e5a6eb203966779f7fab8bc8e52b796bebcadeb9e677564804ee654fe013e25f4c4f919489718e24a9291198aa8328be1157dcd7d68a51f2e9ede71

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+# based on https://github.com/ruby/setup-ruby/blob/master/README.md
+name: Tests
+on: [push, pull_request]
+jobs:
+  ci:
+    name: CI
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ ubuntu-latest ]
+        ruby: [ 2.5, 2.6, 2.7, jruby ]
+    runs-on: ${{ matrix.os }}
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-
+    - name: bundle install
+      run: |
+        ruby -v
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+    - run: bundle exec rubocop
+    - run: bundle exec rspec

data/.gitignore

@@ -16,22 +16,6 @@
 # Ignore Byebug command history file.
 .byebug_history
 
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/
@@ -45,7 +29,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
+# Gemfile.lock
 .ruby-version
 .ruby-gemset
 .rspec_status

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_gem:
+  panolint: rubocop.yml
+Metrics/BlockLength:
+  Exclude:
+    - scan_left.gemspec
+    - spec/*.rb
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - Gemfile
+    - Rakefile
+    - bin/*

data/CHANGELOG.md

@@ -9,12 +9,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-### Removed 
+### Removed
+
+## [0.1.0] - 2020-05-08
+### Added
+- Initial implementation of `ScanLeft`
+- Code of conduct
+- Rubocop configuration
+- Tests run via Github Actions configuration
+
+### Changed
+- Bumped bundler version to 2.x
+
+### Removed
+- Scaffolding from the gem skeleton structure
 
 ## [0.0.1] - 2020-05-06
 ### Added
 - Initial gem project structure
 - Initial CHANGELOG.md based on keepachangelog.com
 
-[Unreleased]: https://github.com/panorama-ed/scan_left/compare/v0.0.1...HEAD
-[0.1.0]: https://github.com/panorama-ed/scan_left/releases/tag/v0.0.1
+[Unreleased]: https://github.com/panorama-ed/scan_left/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/panorama-ed/scan_left/compare/v0.0.1...v0.1.0
+[0.0.1]: https://github.com/panorama-ed/scan_left/releases/tag/v0.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at engineering@panoramaed.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +1,8 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in scan_left.gemspec
 gemspec
+
+gem "panolint", github: "panorama-ed/panolint"

data/Gemfile.lock

@@ -0,0 +1,88 @@
+GIT
+  remote: https://github.com/panorama-ed/panolint
+  revision: 5d1105a9b762a0d91a2164cafd92853372a126b8
+  specs:
+    panolint (0.1.2)
+      brakeman (~> 4.8)
+      rubocop (~> 0.81)
+      rubocop-performance (~> 1.5)
+      rubocop-rails (~> 2.5)
+      rubocop-rspec (~> 1.38)
+
+PATH
+  remote: .
+  specs:
+    scan_left (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.0)
+    brakeman (4.8.1)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rails (2.5.2)
+      activesupport
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    rubocop-rspec (1.39.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  panolint!
+  rake (~> 12.3)
+  rspec (~> 3.0)
+  scan_left!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,2 +1,66 @@
+![Tests](https://github.com/panorama-ed/scan_left/workflows/Tests/badge.svg)
+
 # scan_left
-A tiny Ruby gem to provide the 'scan_left' operation on any Ruby Enumerable.
+A tiny Ruby gem to provide the `#scan_left` operation on any Ruby
+`Enumerable`.
+
+## What does it do?
+
+Imagine a series of numbers which you want to *sum*. You accomplish
+this by processing all elements, adding each to the previous sum,
+returning the final result.
+
+Now imagine that, rather than just the final sum at the end of the
+series, you want *a series* of the partial sums after processing each
+element. This is called a ["Prefix
+Sum"](https://en.wikipedia.org/wiki/Prefix_sum).
+
+In functional programming (FP), the *sum* is generalized as the *fold*
+operation, in which an initial state and a binary operation are
+combined to "fold" a series of values into a single result. The
+closely related *prefix sum*, which produces a series of intermediate
+results, is generalized as the *scan* operation. Adding "left" to
+these operation names indicates that calculation is to proceed
+left-to-right.
+
+## Compare / Contrast with #inject
+
+Ruby's standard library operation `Enumerable#inject` implements the
+FP fold operation. It also implements the simpler reduce operation,
+which is a fold whose initial state is the first element of the
+series.
+
+The key differences between `#inject` and `#scan_left` are:
+
+  1. Incremental results: `#scan_left` returns a series of results
+     after processing each element of the input series. `#inject`
+     returns a single value, which equals the final result in the
+     series returned by `#scan_left`.
+
+  2. Laziness: `#scan_left` can preserve the laziness of the input
+     series.  As each incremental result is read from the output
+     series, the actual calculation is lazily performed against the
+     input. `#inject` cannot be a a lazy operation in general, as its
+     single result reflects a calculation across every element of the
+     input series.
+
+## Examples
+
+```
+require 'scan_left'
+
+ScanLeft.new([]).scan_left(0) { |s, x| s + x } == [0]
+[].inject(0) { |s, x| s + x }                  == 0
+
+ScanLeft.new([1]).scan_left(0) { |s, x| s + x } == [0, 1]
+[1].inject(0) { |s, x| s + x }                  == 1
+
+ScanLeft.new([1, 2, 3]).scan_left(0) { |s, x| s + x } == [0, 1, 3, 6]
+[1, 2, 3].inject(0) { |s, x| s + x }                  == 6
+```
+
+## Further Reading
+
+  * https://en.wikipedia.org/wiki/Fold_(higher-order_function)
+  * https://en.wikipedia.org/wiki/Prefix_sum#Scan_higher_order_function
+  * http://alvinalexander.com/scala/how-to-walk-scala-collections-reduceleft-foldright-cookbook#scanleft-and-scanright

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/scan_left.rb

@@ -1,6 +1,49 @@
+# frozen_string_literal: true
+
 require "scan_left/version"
 
-module ScanLeft
-  class Error < StandardError; end
-  # Your code goes here...
+# Original author: [Marc Siegel](https://github.com/ms-ati).
+
+# Provides the `#scan_left` operation on any Enumerable.
+class ScanLeft
+  attr_reader :enumerable
+
+  # @param [Enumerable]  enumerable  Stream to transform via `scan_left`
+  def initialize(enumerable)
+    @enumerable = enumerable
+  end
+
+  # Map the enumerable to the incremental state of a calculation by
+  # applying the given block, in turn, to each element and the
+  # previous state of the calculation, resulting in an enumerable of
+  # the state after each iteration.
+  #
+  # @return [Enumerable] Generate a stream of intermediate states
+  #   resulting from applying a binary operator. Equivalent to a
+  #   stream of `#inject` calls on first N elements, increasing N from
+  #   zero to the size of the stream. NOTE: Preserves laziness if
+  #   `enumerable` is lazy.
+  #
+  # @param initial [Object] Initial state value to yield.
+  #
+  # @yield [memo, obj] Invokes given block with previous state value
+  #   `memo` and next element of the stream `obj`.
+  #
+  # @yieldreturn [Object] The next state value for `memo`.
+  def scan_left(initial)
+    memo = initial
+    outs = enumerable.map { |*obj| memo = yield(memo, *obj) }
+    prepend_preserving_laziness(value: initial, enum: outs)
+  end
+
+  private
+
+  def prepend_preserving_laziness(value:, enum:)
+    case enum
+    when Enumerator::Lazy
+      [[value], enum].lazy.flat_map { |x| x }
+    else
+      [value] + enum
+    end
+  end
 end

data/lib/scan_left/version.rb

@@ -1,3 +1,5 @@
-module ScanLeft
-  VERSION = "0.0.1"
+# frozen_string_literal: true
+
+class ScanLeft
+  VERSION = "0.1.0"
 end

data/scan_left.gemspec

@@ -1,39 +1,45 @@
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "scan_left/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "scan_left"
-  spec.version       = ScanLeft::VERSION
-  spec.authors       = ["Marc Siegel"]
-  spec.email         = ["msiegel@panoramaed.com", "marc@usainnov.com"]
+  spec.name        = "scan_left"
+  spec.version     = ScanLeft::VERSION
+  spec.authors     = ["Marc Siegel"]
+  spec.email       = ["msiegel@panoramaed.com", "marc@usainnov.com"]
 
-  spec.summary       = %q{A tiny Ruby gem to provide the 'scan_left' operation on any Ruby Enumerable.}
-  spec.description   = %q{A tiny Ruby gem to provide the 'scan_left' operation on any Ruby Enumerable.}
-  spec.homepage      = "https://github.com/panorama-ed/scan_left"
+  spec.summary     = "A tiny Ruby gem to provide the 'scan_left' operation on "\
+                     "any Ruby Enumerable."
+  spec.description = spec.summary
+  spec.homepage    = "https://github.com/panorama-ed/scan_left"
+  spec.license     = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
     spec.metadata["allowed_push_host"] = "https://rubygems.org/" # allow pushes
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = spec.homepage
-    spec.metadata["changelog_uri"] = "https://github.com/panorama-ed/scan_left/blob/master/CHANGELOG.md"
+    spec.metadata["changelog_uri"] =
+      "https://github.com/panorama-ed/scan_left/blob/master/CHANGELOG.md"
   else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
+    raise "RubyGems 2.0 or newer is required to protect against "\
+          "public gem pushes."
   end
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.
+      split("\x0").
+      reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", "~> 12.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scan_left
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Marc Siegel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -60,11 +60,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -74,7 +78,8 @@ files:
 - lib/scan_left/version.rb
 - scan_left.gemspec
 homepage: https://github.com/panorama-ed/scan_left
-licenses: []
+licenses:
+- MIT
 metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/panorama-ed/scan_left