scan_left 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f17ebc3bc1c0efac49788a32791e641484601143338d20256955610d9cf32ad
-  data.tar.gz: 6d4c65c014fde57ecbf17a76946be7aba809bc1c35e404064549d56eff84c651
+  metadata.gz: ada6f02fa663948a57b934fced8f69dbd24a4eface9f62fcad535d7ecc3fe6e3
+  data.tar.gz: 660026f96d8d1e84404043256043851012be5a0dd85fd3373641e372cce95865
 SHA512:
-  metadata.gz: 8745ddd8bf3bab39029173a7a415a6f1a61de6d704e0b86b11a3f86d92f539f984d727a8c6cd00dd1f233c505b35b0bf39ad24ada01787649e4df83c88ece6aa
-  data.tar.gz: f923f89e2ee99a13e32597dc5535eaff2cfd520815e6287889e558079545b9d950fb7fc913010c2f8952bc61bac208c1f40a0bcbd86aecd56ac5b5c3fdb37b84
+  metadata.gz: d3f355a17a62e271ac8c1a5c65e07be7f2a31059a5a74db9de38ce5db7e2ad187e2bd1cb2b910d7fa20f12446905b4cf0ffa485dc813cb2a3f89d03d6868c23d
+  data.tar.gz: 9bb78ebd390fbb37d93c9a95e0b6d6ea02467e3d42445dfda5e546dcfb8bff754652b0c77d9d36984b509c2814a8a37181d42871ccf2548c7f4a66d63ba8b7ec

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.1] - 2020-05-15
+### Added
+- Additional documentation and examples
+
+### Changed
+- Fixed formatting inside of YARD documentation comments
+- Fixed syntax highlighting in examples in YARD doc comments
+
 ## [0.2.0] - 2020-05-14
 ### Added
 - Optional refinement to add a `#scan_left` directly to `Enumerable`
@@ -33,7 +41,8 @@ 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.2.0...HEAD
+[Unreleased]: https://github.com/panorama-ed/scan_left/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/panorama-ed/scan_left/compare/v0.2.0...v0.2.1
 [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

@@ -1,18 +1,18 @@
 GIT
   remote: https://github.com/panorama-ed/panolint
-  revision: 5d1105a9b762a0d91a2164cafd92853372a126b8
+  revision: 145a6b9415534d5563f319798297d00e3c184fd1
   specs:
     panolint (0.1.2)
       brakeman (~> 4.8)
-      rubocop (~> 0.81)
+      rubocop (~> 0.83)
       rubocop-performance (~> 1.5)
       rubocop-rails (~> 2.5)
-      rubocop-rspec (~> 1.38)
+      rubocop-rspec (~> 1.39)
 
 PATH
   remote: .
   specs:
-    scan_left (0.2.0)
+    scan_left (0.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -24,12 +24,11 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
     ast (2.4.0)
-    brakeman (4.8.1)
+    brakeman (4.8.2)
     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)
@@ -51,8 +50,7 @@ GEM
       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)
+    rubocop (0.83.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)

data/lib/scan_left.rb

@@ -1,16 +1,28 @@
 # frozen_string_literal: true
 
-# Original author: [Marc Siegel](https://github.com/ms-ati).
+# Original author: {Marc Siegel}[https://github.com/ms-ati].
 
 require "scan_left/enumerable_with_scan_left"
 require "scan_left/version"
 
-# Provides the {#scan_left} operation on any Enumerable.
+# Wraps any +Enumerable+ to provide the {#scan_left} operation.
+#
+# Please see {file:README.md} for details, examples, background, and further
+# reading about this operation.
+#
+# *Note:* if you'd prefer to use the {#scan_left} method directly on any
+# +Enumerable+ instance, please see the optional refinement
+# {EnumerableWithScanLeft}.
+#
+# @example
+#   ScanLeft.new([1, 2, 3]).scan_left(0) { |s, x| s + x } == [0, 1, 3, 6]
+#
+# @see EnumerableWithScanLeft
 class ScanLeft
-  # @return [Enumerable]  Stream to transform via {#scan_left}
+  # @return [Enumerable]  Enumerable to transform via {#scan_left}
   attr_reader :enumerable
 
-  # @param [Enumerable]  enumerable  Stream to transform via {#scan_left}
+  # @param enumerable [Enumerable]  Enumerable to transform via {#scan_left}
   def initialize(enumerable)
     @enumerable = enumerable
   end

data/lib/scan_left/enumerable_with_scan_left.rb

@@ -1,27 +1,30 @@
 # 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.
+# *Optional*
+# {refinement}[https://docs.ruby-lang.org/en/2.7.0/syntax/refinements_rdoc.html]
+# which refines +Enumerable+ to add a +#scan_left+ method, in order to provide
+# a more natural syntax in comparison to explicitly creating instances of the
+# +ScanLeft+ class.
 #
-# Without using this refinement:
-# ScanLeft.new([1,2,3]).scan_left(0, &:+) => [0, 1, 3, 6]
+# Without using this refinement, we wrap Enumerables in +ScanLeft+ instances:
 #
-# Using this refinement:
-# [1,2,3].scan_left(0, &:+)               => [0, 1, 3, 6]
+#   ScanLeft.new([1,2,3]).scan_left(0, &:+)  # => [0, 1, 3, 6]
 #
+# Using this refinement, we can call +#scan_left+ directly on any Enumerable:
 #
-# Example:
+#   [1,2,3].scan_left(0, &:+)                # => [0, 1, 3, 6]
 #
-# class Foo
-#   using EnumerableWithScanLeft
+# @example
+#   class Foo
+#     using EnumerableWithScanLeft
 #
-#   def bar(x)
-#     [1,2,3].scan_left(x, &:+)
+#     def bar(x)
+#       [1,2,3].scan_left(x, &:+)
+#     end
 #   end
-# end
 #
-# Foo.new.bar(10) => [10, 11, 13, 16]
+#   Foo.new.bar(10)  # => [10, 11, 13, 16]
+#
 module EnumerableWithScanLeft
   refine Enumerable do
     def scan_left(initial, &block)

data/lib/scan_left/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scan_left
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Marc Siegel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-14 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler