sync_enum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29058cd0e8c7631c47f92729165ce7d17a3f7ce12f89dd3038edafd7860b2abd
+  data.tar.gz: ab716ac8d40e25f5d7f024f870b70ab8ec7f79f3c88c477a3f141963ae9d115b
+SHA512:
+  metadata.gz: bc48c2672decd18cc58a77835606887e66399d3a80d8195a31821228e9f1df0bfc4e358f14740cc4a6c6e198eab473d1dd0665c3e81bc5ad67764d0cb34f24ed
+  data.tar.gz: a1fa3a8735a4681c8ee3c56a72dcd23efe75a08c627c54ea317e0b058cf8f551f92c9e86d0a1217c1d3ed2b25f0948d8944e16064d2e715c246ff863eca28358

data/.gitattributes

@@ -0,0 +1,14 @@
+# By default, git should determine if a file is binary, and normalize it
+# when the file is not binary (text).
+* text=auto
+
+# These files are text and should be normalized to CRLF in the working
+# directory.
+*.rb text
+*.yml text
+*.md text
+*.bat text
+
+# These files are binary, and should not be normalized.
+*.mar binary
+*.pdf binary

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/temp/
+/data/
+/.idea/
+/*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,12 @@
+# RSpec default options
+# ./.rspec is loaded automatically by RSpec
+#
+# RSpec automatically adds to $LOAD_PATH:
+#   <project>/spec
+#   <project>/lib  # at least in RubyMine
+
+--format documentation
+--color
+
+# load the contents of spec/spec_helper.rb
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 80

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-15
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at tesar@rutgers.edu. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sync_enum.gemspec
+gemspec
+
+gem 'launchy', '~> 2.5'
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    sync_enum (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  launchy (~> 2.5)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+  rubocop-rake
+  rubocop-rspec
+  sync_enum!
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Bruce Tesar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# SyncEnum
+
+Iterate over multiple enumerators in parallel, using the external interface
+based on the #next method. Each call to #next returns an array, containing
+the next element for each of the enumerators. A StopIteration exception
+is raised as soon as any of the enumerators runs out of elements.
+
+SyncEnum differs from the standard library's REXML::SyncEnumerator in its
+use of the #next external iterator interface, while REXML::SyncEnumerator
+uses an #each internal interator interface. The external interface is more
+convenient when you expect to end iteration before reaching the end of
+any of the enumerations, including cases where an enumerator generates
+an unending sequence.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sync_enum'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sync_enum
+
+## Usage
+
+Require the sync_enum gem in your code:
+
+```ruby
+require 'sync_enum'
+```
+
+Create a new SyncEnum by giving the constructor the enumerators as
+arguments:
+
+```ruby
+se = SyncEnum.new(enum1, enum2, ...)
+```
+
+Each call to #next will return an array of the next elements of the
+enumerators, in the same order as the enumerators were given to the
+constructor.
+
+```ruby
+se.next # => [enum1.next, enum2.next, ...]
+```
+
+This can be used in a loop construction, where the loop keyword silently
+rescues the StopIteration exception.
+
+```ruby
+se = SyncEnum.new(enum1, enum2, enum3)
+loop do
+  values = se.next
+  next_from_enum1 = values[0]
+  break if condition_for_stopping_early
+end
+# To get here, either one of the enumerators ran out of elements, or the
+# break statement was executed.
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and
+then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/brucetesar/sync_enum. This project is intended to be a
+safe, welcoming space for collaboration, and contributors are expected to
+adhere to the
+[code of conduct](https://github.com/brucetesar/sync_enum/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SyncEnum project's codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/brucetesar/sync_enum/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'launchy'
+
+desc 'delete all files/directories in the temp dir'
+task :clear_temp do
+  Dir.glob('temp/*').each do |f|
+    rm_rf(f, verbose: false)
+  end
+end
+
+# ***********
+# RSpec Tasks
+# ***********
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# *************
+# RuboCop Tasks
+# *************
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-rspec'
+end
+
+# task default: %i[spec rubocop]
+
+# **********
+# RDoc Tasks
+# **********
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rdoc|
+  files = %w[README.md LICENSE.txt CHANGELOG.md lib/**/*.rb bin/**/*.rb]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = 'README' # page to start on
+  rdoc.title = 'sync_enum Docs'
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+desc 'display RDoc in browser'
+task :rdoc_in_browser do
+  # Display the rdoc documentation in the system's default browser.
+  Launchy.open('doc/rdoc/index.html')
+end
+
+desc 'Regenerate RDoc and display in browser'
+task rerdoc_in_browser: [:rerdoc] do
+  # Display the rdoc documentation in the system's default browser.
+  Launchy.open('doc/rdoc/index.html')
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'sync_enum'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sync_enum.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Author: Bruce Tesar
+
+require 'sync_enum/version'
+require 'sync_enum/sync_enum'

data/lib/sync_enum/sync_enum.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Author: Bruce Tesar
+
+# Allows a collection of enumerators to be iterated over in parallel,
+# using the same call to next as a normal enumerator.
+class SyncEnum
+  # Returns a new SyncEnum, containing each of the enumerators
+  # provided as arguments to #new.
+  # === Parameters
+  # * *enums - each argument is a distinct enumerator, and the returned
+  #   arrays of values are ordered exactly as the enumerators are in
+  #   the argument list.
+  # :call-seq:
+  #   new(*enums) -> sync_enum
+  def initialize(*enums)
+    @enum_bank = enums
+  end
+
+  # Returns an array containing the next set of values. The first
+  # value in the returned array is the next element of the first
+  # enumerator, the second value in the returned array is the next
+  # element of the second enumerator, and so forth.
+  #
+  # A StopIteration exception is raised as soon as next is called and
+  # one of the enumerators is out of elements. If no enumerators were
+  # provided to the constructor, StopIteration is raised on the first
+  # call to next.
+  # :call-seq:
+  #   next -> array or raise StopIteration
+  def next
+    raise StopIteration if @enum_bank.empty?
+
+    @enum_bank.map(&:next)
+  end
+end

data/lib/sync_enum/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class SyncEnum
+  # The version number for sync_enum.
+  VERSION = '0.1.0'
+end

data/sync_enum.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'lib/sync_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sync_enum'
+  spec.version       = SyncEnum::VERSION
+  spec.authors       = ['Bruce Tesar']
+  spec.email         = ['tesar@rutgers.edu']
+
+  spec.summary       = 'Iterates over multiple enumerators.'
+  spec.description   =
+    <<~ENDOFSTRING
+      Iterate over multiple enumerators in parallel, using the external
+      interface based on the #next method. Each call to #next returns an
+      array, containing the next element for each of the enumerators. A
+      StopIteration exception is raised as soon as any of the enumerators
+      runs out of elements.
+
+      SyncEnum differs from the standard library's REXML::SyncEnumerator in
+      its use of the #next external iterator interface, while
+      REXML::SyncEnumerator uses an #each internal interator interface. The
+      external interface is more convenient when you expect to end
+      iteration before reaching the end of any of the enumerations,
+      including cases where an enumerator generates an unending sequence.
+    ENDOFSTRING
+
+  spec.homepage      = 'https://github.com/brucetesar/sync_enum'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] =
+    'https://github.com/brucetesar/sync_enum'
+  spec.metadata['changelog_uri'] =
+    'https://github.com/brucetesar/sync_enum/blob/master/CHANGELOG.md'
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject \
+      { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Register the development-specific dependencies
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sync_enum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruce Tesar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: |
+  Iterate over multiple enumerators in parallel, using the external
+  interface based on the #next method. Each call to #next returns an
+  array, containing the next element for each of the enumerators. A
+  StopIteration exception is raised as soon as any of the enumerators
+  runs out of elements.
+
+  SyncEnum differs from the standard library's REXML::SyncEnumerator in
+  its use of the #next external iterator interface, while
+  REXML::SyncEnumerator uses an #each internal interator interface. The
+  external interface is more convenient when you expect to end
+  iteration before reaching the end of any of the enumerations,
+  including cases where an enumerator generates an unending sequence.
+email:
+- tesar@rutgers.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sync_enum.rb
+- lib/sync_enum/sync_enum.rb
+- lib/sync_enum/version.rb
+- sync_enum.gemspec
+homepage: https://github.com/brucetesar/sync_enum
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/brucetesar/sync_enum
+  source_code_uri: https://github.com/brucetesar/sync_enum
+  changelog_uri: https://github.com/brucetesar/sync_enum/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Iterates over multiple enumerators.
+test_files: []