object_enumerate 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 380bf967685082971fd49b0913526d97c792c9c1049a85b3813cf298117c322d
+  data.tar.gz: 2b0048f1ceab75af3796cdffd52bec00b3173f39c93510c1a045282c10a7344d
+SHA512:
+  metadata.gz: b826e1ade022d351157eaae41f16b5ef1fad2fe6f10c73576f1369804301cfecd49dd20464a010bc803796a8cb6c5ea7f99a524f2c56fe90780fd405c930c2e8
+  data.tar.gz: a796f6ff93ed172d728a524fbee252d7fb4c955575249dfa8daa81b112d03b3a837048bbbc202cb90fdecd936e2769bbcde5141b5be779dff9e7dd0d3b916805

data/README.md

@@ -0,0 +1,84 @@
+# `Object#enumerate`
+
+This is a small (exactly 1 method) gem to showcase my proposal to core Ruby.
+
+[The proposal at Ruby tracker](https://bugs.ruby-lang.org/issues/14423).
+
+[Discussion log](https://docs.google.com/document/d/e/2PACX-1vR2LdBE87iEcEsVuUUr0G2L6LxSPeGMg_0oeHeh0HYmX36iIa9zkWYlFHilH5D4I_RBJpQnr09yOZaE/pub) from developers meeting:
+
+> Naruse: interesting proposal
+>
+> Akr: adding method to Object sounds too radical to me.
+>
+> Usa: I think there is a chance if this is a method of Enumerable.
+>
+> Shyouhei: my feeling is this should start as a gem.
+
+So, considering Shyouhei's last remark, I am providing this gem for interested parties to experiment.
+
+I still **strongly believe** the method should be a part of language core, so the gem is made as a proof-of-concept, to make experimentation with an idea simple.
+
+## Synopsys
+
+`Object#enumerate` takes a block and returns an instance of infinite `Enumerator`, where each next element is made by applying the block to the previous.
+
+## Examples of usage
+
+`Object#enumerate` can provide idiomatic replacement for a lot of `while` and `loop` constructs, the same way `each` replaces `for`.
+
+```ruby
+require 'object_enumerate'
+
+# Most idiomatic "infinite sequence" possible:
+p 1.enumerate(&:succ).take(5)
+# => [1, 2, 3, 4, 5]
+
+# Easy Fibonacci
+p [0, 1].enumerate { |f0, f1| [f1, f0 + f1] }.take(10).map(&:first)
+#=> [0, 1, 1, 2, 3, 5, 8, 13, 21, 34]
+
+# Find next Tuesday
+require 'date'
+Date.today.enumerate(&:succ).detect { |d| d.wday == 2 }
+# => #<Date: 2018-05-22 ((2458261j,0s,0n),+0s,2299161j)>
+
+
+# Tree navigation
+# ---------------
+require 'nokogiri'
+require 'open-uri'
+
+# Find some element on page, then make list of all parents
+p Nokogiri::HTML(open('https://www.ruby-lang.org/en/'))
+  .at('a:contains("Ruby 2.2.10 Released")')
+  .enumerate(&:parent)
+  .take_while { |node| node.respond_to?(:parent)  }
+  .map(&:name)
+# => ["a", "h3", "div", "div", "div", "div", "div", "div", "body", "html"]
+
+# Pagination
+# ----------
+require 'octokit'
+
+Octokit.stargazers('rails/rails')
+# ^ this method returned just an array, but have set `.last_response` to full response, with data
+# and pagination. So now we can do this:
+p Octokit.last_response
+  .enumerate { |response| response.rels[:next].get } # pagination: `get` fetches next Response
+  .first(3)                                          # take just 3 pages of stargazers
+  .flat_map(&:data)                                  # `data` is parsed response content (stargazers themselves)
+  .map { |h| h[:login] }
+# => ["wycats", "brynary", "macournoyer", "topfunky", "tomtt", "jamesgolick", ...
+```
+
+### Alternative synopsys
+
+_Not implemented in the gem, just provided for a sake of core language proposal._
+
+```ruby
+Enumerable.enumerate(1, &:succ)
+Enumerable(1, &:succ)
+Enumerator.from(1, &:succ)
+```
+
+I personally don't believe any of those look clear enough, so, however risky adding new method to `Object` could look, I'd vote for it.

data/examples.rb

@@ -0,0 +1,34 @@
+require_relative 'lib/object_enumerate'
+require 'pp'
+
+# Most idiomatic "infinite sequence" possible:
+p 1.enumerate(&:succ).take(5)
+
+# Easy Fibonacci
+p [0, 1].enumerate { |f0, f1| [f1, f0 + f1] }.take(10).map(&:first)
+
+require 'date'
+
+# Find next Tuesday
+Date.today.enumerate(&:succ).detect { |d| d.wday == 2 }
+
+require 'nokogiri'
+require 'open-uri'
+
+# Find some element on page, then make list of all parents
+p Nokogiri::HTML(open('https://www.ruby-lang.org/en/'))
+  .at('a:contains("Ruby 2.2.10 Released")')
+  .enumerate(&:parent)
+  .take_while { |node| node.respond_to?(:parent)  }
+  .map(&:name)
+
+require 'octokit'
+
+Octokit.stargazers('rails/rails')
+# ^ this method returned just an array, but have set `.last_response` to full response, with data
+# and pagination. So now we can do this:
+p Octokit.last_response
+  .enumerate { |response| response.rels[:next].get } # pagination: `get` fetches next Response
+  .first(3) # take just 3 pages of stargazers
+  .flat_map(&:data) # data is parsed response content (stargazers themselves)
+  .map { |h| h[:login] }

data/lib/object_enumerate.rb

@@ -0,0 +1,13 @@
+class Object
+  def enumerate
+    raise ArgumentError, "No block given" unless block_given?
+    Enumerator.new do |y|
+      val = self
+      y << val
+      loop do
+        val = yield(val)
+        y << val
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: object_enumerate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Victor Shepelev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "    This is just a showcase gem to support language core proposal: https://bugs.ruby-lang.org/issues/14423\n"
+email: zverok.offline@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples.rb
+- lib/object_enumerate.rb
+homepage: https://github.com/zverok/object_enumerate
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: 'Object#enumerate: Simple infinite enumerators'
+test_files: []