scan_left 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1557332192560cf4af4dadfe859d6af3daa27fb7a15c4e73095cfbb3edc8e08
-  data.tar.gz: e868d3a5e20160daf7aae34d13a53cb28c8e92a63eda2efe0327bcd14e554421
+  metadata.gz: 6f17ebc3bc1c0efac49788a32791e641484601143338d20256955610d9cf32ad
+  data.tar.gz: 6d4c65c014fde57ecbf17a76946be7aba809bc1c35e404064549d56eff84c651
 SHA512:
-  metadata.gz: 3dd492ba1423dcf94da46b80886e82eee00bf4316a788a8bb56a9650d89d2347a3bc84ebe0b89bd7ba2a4661396879f1804d8453c9ac20646756b3a9589dcc6c
-  data.tar.gz: 7fe9dd080e5a6eb203966779f7fab8bc8e52b796bebcadeb9e677564804ee654fe013e25f4c4f919489718e24a9291198aa8328be1157dcd7d68a51f2e9ede71
+  metadata.gz: 8745ddd8bf3bab39029173a7a415a6f1a61de6d704e0b86b11a3f86d92f539f984d727a8c6cd00dd1f233c505b35b0bf39ad24ada01787649e4df83c88ece6aa
+  data.tar.gz: f923f89e2ee99a13e32597dc5535eaff2cfd520815e6287889e558079545b9d950fb7fc913010c2f8952bc61bac208c1f40a0bcbd86aecd56ac5b5c3fdb37b84

data/CHANGELOG.md

@@ -5,11 +5,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [0.2.0] - 2020-05-14
 ### Added
+- Optional refinement to add a `#scan_left` directly to `Enumerable`
+- Badges in README.md for tests, gem version, and docs
+- Documentation link in gemspec to rubydoc.info
 
 ### Changed
-
-### Removed
+- Improved YARD doc formatting for RubyDoc.info
 
 ## [0.1.0] - 2020-05-08
 ### Added
@@ -29,6 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Initial gem project structure
 - Initial CHANGELOG.md based on keepachangelog.com
 
-[Unreleased]: https://github.com/panorama-ed/scan_left/compare/v0.1.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/scan_left/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/panorama-ed/scan_left/compare/v0.1.0...v0.2.0
 [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/Gemfile.lock

@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    scan_left (0.1.0)
+    scan_left (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,12 @@
+# scan_left
 ![Tests](https://github.com/panorama-ed/scan_left/workflows/Tests/badge.svg)
 
-# scan_left
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/panorma-ed/scan_left)
+[![Docs Coverage](http://inch-ci.org/github/panorama-ed/scan_left.png)](http://inch-ci.org/github/panorama-ed/scan_left)
+
+[![Gem Version](https://img.shields.io/gem/v/scan_left.svg)](https://rubygems.org/gems/scan_left)
+[![Gem Downloads](https://img.shields.io/gem/dt/scan_left.svg)](https://rubygems.org/gems/scan_left)
+
 A tiny Ruby gem to provide the `#scan_left` operation on any Ruby
 `Enumerable`.
 
@@ -32,12 +38,12 @@ series.
 
 The key differences between `#inject` and `#scan_left` are:
 
-  1. Incremental results: `#scan_left` returns a series of results
+  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
+  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
@@ -46,8 +52,10 @@ The key differences between `#inject` and `#scan_left` are:
 
 ## Examples
 
-```
-require 'scan_left'
+```ruby
+require "scan_left"
+
+# For comparison, results from #inject are shown as well:
 
 ScanLeft.new([]).scan_left(0) { |s, x| s + x } == [0]
 [].inject(0) { |s, x| s + x }                  == 0
@@ -57,6 +65,18 @@ ScanLeft.new([1]).scan_left(0) { |s, x| s + x } == [0, 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
+
+# OPTIONAL: To avoid explicitly using the `ScanLeft` class, you may
+# choose to use the provided refinement on Enumerable. 
+#
+# This refinement adds a `#scan_left` method directly to Enumerable 
+# for a more concise syntax.
+
+using EnumerableWithScanleft
+
+[].scan_left(0) { |s, x| s + x }        => [0]
+[1].scan_left(0) { |s, x| s + x }       => [0, 1]
+[1, 2, 3].scan_left(0) { |s, x| s + x } => [0, 1, 3, 6]
 ```
 
 ## Further Reading

data/lib/scan_left.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
-require "scan_left/version"
-
 # Original author: [Marc Siegel](https://github.com/ms-ati).
 
-# Provides the `#scan_left` operation on any Enumerable.
+require "scan_left/enumerable_with_scan_left"
+require "scan_left/version"
+
+# Provides the {#scan_left} operation on any Enumerable.
 class ScanLeft
+  # @return [Enumerable]  Stream to transform via {#scan_left}
   attr_reader :enumerable
 
-  # @param [Enumerable]  enumerable  Stream to transform via `scan_left`
+  # @param [Enumerable]  enumerable  Stream to transform via {#scan_left}
   def initialize(enumerable)
     @enumerable = enumerable
   end
@@ -20,16 +22,16 @@ class ScanLeft
   #
   # @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
+  #   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.
+  #   +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`.
+  #   +memo+ and next element of the stream +obj+.
   #
-  # @yieldreturn [Object] The next state value for `memo`.
+  # @yieldreturn [Object] The next state value for +memo+.
   def scan_left(initial)
     memo = initial
     outs = enumerable.map { |*obj| memo = yield(memo, *obj) }

data/lib/scan_left/enumerable_with_scan_left.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# This refines `Enumerable` to add a `#scan_left` method. This allows
+# for a more natural syntax than explicitly using the `ScanLeft`
+# class.
+#
+# Without using this refinement:
+# ScanLeft.new([1,2,3]).scan_left(0, &:+) => [0, 1, 3, 6]
+#
+# Using this refinement:
+# [1,2,3].scan_left(0, &:+)               => [0, 1, 3, 6]
+#
+#
+# Example:
+#
+# class Foo
+#   using EnumerableWithScanLeft
+#
+#   def bar(x)
+#     [1,2,3].scan_left(x, &:+)
+#   end
+# end
+#
+# Foo.new.bar(10) => [10, 11, 13, 16]
+module EnumerableWithScanLeft
+  refine Enumerable do
+    def scan_left(initial, &block)
+      ScanLeft.new(self).scan_left(initial, &block)
+    end
+  end
+end

data/lib/scan_left/version.rb

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

data/scan_left.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
     spec.metadata["source_code_uri"] = spec.homepage
     spec.metadata["changelog_uri"] =
       "https://github.com/panorama-ed/scan_left/blob/master/CHANGELOG.md"
+    spec.metadata["documentation_uri"] = "https://rubydoc.info/gems/scan_left"
   else
     raise "RubyGems 2.0 or newer is required to protect against "\
           "public gem pushes."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scan_left
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Marc Siegel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ files:
 - bin/console
 - bin/setup
 - lib/scan_left.rb
+- lib/scan_left/enumerable_with_scan_left.rb
 - lib/scan_left/version.rb
 - scan_left.gemspec
 homepage: https://github.com/panorama-ed/scan_left
@@ -85,6 +86,7 @@ metadata:
   homepage_uri: https://github.com/panorama-ed/scan_left
   source_code_uri: https://github.com/panorama-ed/scan_left
   changelog_uri: https://github.com/panorama-ed/scan_left/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/scan_left
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: A tiny Ruby gem to provide the 'scan_left' operation on any Ruby Enumerable.