j8-functional 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9e2b0c42cb60af7daa1868853d3789fce763c7facc1f32babed4332f84c3006
+  data.tar.gz: 13a446ec85d5a3a76762eaae53523ace453cc4485ef6da899f03607263d61b0d
+SHA512:
+  metadata.gz: 55410484125ad656e0c51b19a1429d92392925be037d7ef7c881fab92f5431024c67660ab106ded38f66ce105337f47e5d2d6c392f97753b5f87690680a92ee5
+  data.tar.gz: 2b2740b2aa100b765c1aa99c87c8a047a8fa0ebf8190a415a37c37364c6db6add34ffab9be03240f2e56db6f0dae179086a1636c4f4a5632fb94ebbc8fdcc3d9

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,30 @@
+---
+
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Naming/FileName:
+  Exclude:
+    - '**/j8-functional.rb'
+
+Lint/EmptyClass:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/Semicolon:
+  Exclude:
+    - '**/function_spec.rb'
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - '**/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 john@shields.wtf. 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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in j8-functional.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    j8-functional (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    ffi (1.13.1)
+    gem-release (2.2.0)
+    method_source (1.0.0)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-doc (1.1.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.6.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  gem-release
+  j8-functional!
+  pry
+  pry-doc
+  rake (~> 10.0)
+  rb-inotify
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 John Shields
+
+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,142 @@
+# J8::Streams
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/j8/streams`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'j8-functional'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install j8-functional
+
+## Usage
+
+Needs to be filled in. Demos
+
+```ruby
+def demo(values)
+  values
+    &.j8_stream
+    &.map { |o| o + 5 }
+    &.filter { |o| o % 3 == 0 }
+    &.to_a
+end
+
+[18] pry(main)> demo([6,54,3,1,3,5,6,90,85])
+=> [6, 90]
+[19] pry(main)>
+
+class Mod3Predicate < J8::Predicate
+  def initialize; end
+
+  def test(o)
+    o % 3 == 0
+  end
+end
+
+def demo2(values)
+  values
+    &.j8_stream
+    &.map { |o| o + 5 }
+    &.filter(Mod3Predicate.new)
+    &.to_a
+end
+
+[19] pry(main)> demo2([6,54,3,1,3,5,6,90,85])
+=> [6, 90]
+[20] pry(main)>
+
+class ModPredicate < J8::Predicate
+  def initialize(mod)
+    @mod = mod
+  end
+
+  def test(o)
+    o % @mod == 0
+  end
+end
+
+def demo3(values)
+  values
+    &.j8_stream
+    &.map { |o| o + 5 }
+    &.filter(ModPredicate.new(3))
+    &.to_a
+end
+
+[20] pry(main)> demo3([6,54,3,1,3,5,6,90,85])
+=> [6, 90]
+[21] pry(main)>
+
+class Add5Function < J8::Function
+  def initialize; end
+
+  def apply(o)
+    o + 5
+  end
+end
+
+def demo4(values)
+  values
+    &.j8_stream
+    &.map(Add5Function.new)
+    &.filter(ModPredicate.new(3))
+    &.to_a
+end
+
+[21] pry(main)> demo4([6,54,3,1,3,5,6,90,85])
+=> [6, 90]
+[22] pry(main)>
+
+class AddFunction < J8::Function
+  def initialize(amount)
+    @amount = amount
+  end
+
+  def apply(o)
+    o + @amount
+  end
+end
+
+def demo5(values)
+  values
+    &.j8_stream
+    &.map(AddFunction.new(5))
+    &.filter(ModPredicate.new(3))
+    &.to_a
+end
+
+[22] pry(main)> demo5([6,54,3,1,3,5,6,90,85])
+=> [6, 90]
+[23] pry(main)>
+```
+
+## 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 tags, 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/[USERNAME]/j8-functional. 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/[USERNAME]/j8-functional/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 J8::Streams project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/j8-functional/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+def empty_directory(directory)
+  FileUtils.remove_entry(directory)
+  FileUtils.mkdir(directory)
+end
+
+# clean up the workspace
+task(:clean) do
+  empty_directory('doc')
+  empty_directory('out')
+  empty_directory('pkg')
+end
+
+# unit tests
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+  task.rspec_opts = '--require spec_helper ' \
+                    '--format documentation ' \
+                    '--format html ' \
+                    '--out out/rspec_unit.html'
+end
+task(default: :spec)
+
+# configure rubocop
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = [
+    '--format', 'simple',
+    '--format', 'html',
+    '--out', 'out/rubocop.html',
+    'lib/**/*.rb',
+    'spec/**/*.rb'
+  ]
+end
+task(default: :rubocop)
+
+# Require tests, syntax and documentation to pass before building
+task(build: %i[spec rubocop])
+
+# Require a succesful build before release
+task(release: %i[build])
+
+task(:console) do
+  # protect ctrl-c in pry
+  trap(:SIGINT) {}
+  sh 'bundle exec bin/console'
+end

data/bin/console

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'j8/functional'
+
+require 'pry'
+require 'rb-inotify'
+
+def reloadable_dirs
+  Dir[File.join(__dir__, '..', 'lib', '**', '*.rb')]
+    .map { |path| File.dirname(path) }
+    .push(File.join(__dir__, '..', 'lib'))
+    .to_set
+    .to_a
+end
+
+def reloadable_files
+  reloadable_dirs.map { |dir| Dir["#{dir}/**/*.rb"] }.flatten
+end
+
+def reload!
+  reloadable_files.each(&method(:load))
+end
+
+def reloadable_notifier(dirs) # rubocop:disable Metrics/MethodLength
+  INotify::Notifier.new.tap do |notifier|
+    dirs.each do |dir|
+      notifier.watch(dir, :modify, :recursive) do |event|
+        path = File.join(event.watcher.path, event.name)
+        next unless path.end_with?('.rb')
+
+        begin
+          load File.expand_path(path)
+        rescue => e # rubocop:disable Style/RescueStandardError
+          puts "Failed to load #{path}. #{e.class}: #{e.message}"
+          next
+        end
+      end
+    end
+  end.run
+end
+
+def restart_reloader
+  return if @reloader_thread&.alive?
+
+  @reloader_thread&.join
+  @reloader_thread = Thread.new do
+    Thread.current.report_on_exception = false
+    reloadable_notifier(reloadable_dirs)
+  end
+end
+
+restart_reloader
+Pry.start