pull_stream 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 27794f863308351d25448a43ee44c0fa158a2740
+  data.tar.gz: 518bcddb9fc1d33c96136cd10a9711eda4a0f7e1
+SHA512:
+  metadata.gz: c3f21bcc1a1bbfdc40c9c9731a6a5b8ebe91fc281f2d72b864f46d282637b12ac70defc2b543eb5695de893509d20e9ca66b4853a786948c35d1445843a49958
+  data.tar.gz: 8f64b2481efaf3a74c3f081dcde8b182c6aa01abb109f979ea1662c6436f4c7f19fe73d22b9710068f25855838cbcafdbf6d357bc1b002ce81c7d06157214b78

data/.gitignore

@@ -0,0 +1,14 @@
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+bin/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.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 kieran.a.gibb@gmail.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Kieran
+
+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,120 @@
+# Ruby Pull Stream
+
+A minimal pull based data streaming client for Ruby.
+
+![sinking ducky](https://media.giphy.com/media/WV61B73quTNW8/giphy.gif)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pull_stream'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pull_stream
+
+## Usage
+
+In classic-streams, streams _push_ data to the next stream in the pipeline. With pull streams, data is pulled out of the source stream, into the destination. `pull_stream` is a Ruby implementation of a Javascript module [pull-stream](https://github.com/pull-stream/pull-stream) used by the [Scuttlebutt](http://scuttlebutt.nz/) community. It has been built as a means to improve my knowledge of pull-streams in Node. It may prove to be useful in Ruby though I am yet to conceive of an application.
+
+`pull_stream` opens up a `pull` method that takes any number of arguments. The first must be a _source_. The last must be a _sink_. Any number of _through_'s can be added in the middle.
+
+```ruby
+pull(
+  source,
+  map,
+  filter,
+  take,
+  sink
+)
+```
+
+Simply include the `Pull` module into any class and begin pulling streams
+
+```ruby
+include Pull
+
+ducks = ["Alice the Duck", "Gary the Gopher", "Bob the Duck", "Grace the Duck", "Elvis the Duck"]
+
+pull(
+  pull.values(ducks),
+  # Lets objectify our ducks
+  pull.map do |duck|
+    name, type = duck.split(" the ")
+    OpenStruct.new(name: name, type: type)
+  end,
+  # Lets make sure we've only got ducks, this filters out Gary, sorry Gary
+  pull.filter { |duck| duck.type == "Duck" },
+  # Turns out these ducks are actually Pochards
+  pull.map do |duck|
+    duck.tap { |d| d.type = "Pochard" }
+  end,
+  # Spit out each duck one at a time...
+  pull.drain do |duck|
+    puts duck
+  end
+)
+
+#<OpenStruct name="Alice", type="Pochard">
+#<OpenStruct name="Bob", type="Pochard">
+#<OpenStruct name="Grace", type="Pochard">
+#<OpenStruct name="Elvis", type="Pochard">
+```
+
+If a _sink_ is not provided, pull returns itself as a source, and can be used in another pull stream.
+
+```ruby
+source = pull(
+  pull.values([1, 2, 3, 4, 5]),
+  pull.map { |value| value ** 2 }
+)
+
+pull(
+  source,
+  # Apply more throughs and a sink
+)
+```
+
+### Pull Stream's API
+
+```
+pull.values # source
+pull.keys # source
+pull.infinity # source
+
+pull.map # through
+pull.filter # through
+pull.take # through
+
+pull.drain # sink
+pull.collect # sink
+pull.log # sink
+pull.reduce # sink
+```
+
+
+## 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/kgibb8/ruby_pull_stream. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pull Stream project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pull/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/pull.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "pull/version"
+
+require "pull/source/values"
+require "pull/source/infinity"
+
+require "pull/through/map"
+require "pull/through/filter"
+require "pull/through/take"
+
+require "pull/sink/drain"
+require "pull/sink/collect"
+require "pull/sink/log"
+require "pull/sink/reduce"
+
+require "pull/helper"
+
+module Pull
+  def pull(*args)
+    return Pull::Helper.new if args.empty?
+    recurse(nil, args)
+    true
+  end
+
+  private
+
+  def recurse(streamer, args)
+    return if args.empty?
+    arg = args.shift
+    raise TypeError unless arg.respond_to?(:call)
+
+    recurse(
+      streamer.nil? ? arg.() : arg.(streamer),
+      args
+    )
+  end
+end

data/lib/pull/helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Pull
+  class Helper
+    def values(args)
+      Pull::Values.new(args)
+    end
+
+    def infinity
+      Pull::Infinity.new
+    end
+
+    def drain(&block)
+      Pull::Drain.new(&block)
+    end
+
+    def collect(&block)
+      Pull::Collect.new(&block)
+    end
+
+    def map(&block)
+      Pull::Map.new(&block)
+    end
+
+    def filter(&block)
+      Pull::Filter.new(&block)
+    end
+
+    def take(limit)
+      Pull::Take.new(limit)
+    end
+
+    def log
+      Pull::Log.new
+    end
+  end
+end

data/lib/pull/sink/collect.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Pull
+  class Collect
+    DEFAULT_DONE_CALLBACK = -> () {
+      puts "DONE"
+    }
+
+    def initialize(&block)
+      @block = block
+      @collection = []
+    end
+
+    def call(read, done = DEFAULT_DONE_CALLBACK)
+      raise TypeError unless read.respond_to?(:call)
+      drained = Pull::Drain.new do |value|
+        @collection << value
+      end
+      drained.(read)
+      block.call(@collection)
+    end
+
+    private
+
+    attr_reader :block
+  end
+end
+

data/lib/pull/sink/drain.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Pull
+  class Drain
+    DEFAULT_DONE_CALLBACK = -> () {
+      puts "DONE"
+    }
+
+    def initialize(&block)
+      @block = block
+      @continuing = true
+    end
+
+    def call(read, done = DEFAULT_DONE_CALLBACK)
+      raise TypeError unless read.respond_to?(:call)
+      while @continuing
+        return done.() && break if !@continuing
+        @continuing = read.(nil, -> (value) {
+          block.call(value)
+        })
+      end
+    end
+
+    private
+
+    attr_reader :block
+  end
+end
+

data/lib/pull/sink/log.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Pull
+  class Log
+    DEFAULT_DONE_CALLBACK = -> () {
+      puts "DONE"
+    }
+
+    def call(read, done = DEFAULT_DONE_CALLBACK)
+      raise TypeError unless read.respond_to?(:call)
+      Pull::Drain.new do |value|
+        puts value
+      end.(read)
+    end
+  end
+end

data/lib/pull/sink/reduce.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pull
+  class Reduce
+    DEFAULT_DONE_CALLBACK = -> () {
+      puts "DONE"
+    }
+
+    def initialize(accumulator, &block)
+      @accumulator = accumulator
+      @block = block
+    end
+
+    def call(read, done = DEFAULT_DONE_CALLBACK)
+      raise TypeError unless read.respond_to?(:call)
+      drained = Pull::Drain.new do |value|
+        @accumulator = block.call(@accumulator, value)
+      end
+      drained.(read)
+    end
+
+    private
+
+    attr_reader :block
+  end
+end

data/lib/pull/source/infinity.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pull
+  class Infinity
+    DEFAULT_ABORT_PROC = -> () {
+      puts "abort abort"
+    }
+
+    def initialize(on_abort = DEFAULT_ABORT_PROC)
+      @index = 0
+    end
+
+    def call
+      -> (finish, callback) {
+        if finish
+          on_abort.()
+          return nil
+        end
+
+        callback.(@index)
+        @index += 1
+        return true
+      }
+    end
+  end
+end

data/lib/pull/source/values.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Pull
+  class Values
+    DEFAULT_ABORT_PROC = -> () {
+      puts "abort abort"
+    }
+
+    def initialize(array, on_abort = DEFAULT_ABORT_PROC)
+      array = objectify(array) unless array.kind_of?(Array)
+
+      @array = array
+      @index = 0
+      @on_abort = on_abort
+    end
+
+    def call
+      -> (finish, callback) {
+        if finish
+          on_abort.()
+          return nil
+        end
+
+        return false if !array[@index]
+
+        callback.(array[@index])
+        @index += 1
+        return true
+      }
+    end
+
+    private
+
+    attr_reader :array, :on_abort
+
+    def objectify(object)
+      if object.kind_of?(Hash)
+        object.map { |k, v| v }
+      else
+        object.pretty_print_instance_variables.inject([]) do |coll, iv|
+          coll << object.instance_variable_get(iv)
+        end
+      end
+    end
+  end
+end

data/lib/pull/through/filter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Pull
+  class Filter
+    def initialize(&block)
+      @block = block
+    end
+
+    def call(read)
+      -> (finish, callback) {
+        if finish
+          on_abort.()
+          return nil
+        end
+
+        read.(nil, -> (value) {
+          pass = block.call(value)
+          callback.(value) if pass
+        })
+      }
+    end
+
+    private
+
+    attr_reader :block
+  end
+end

data/lib/pull/through/map.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pull
+  class Map
+    def initialize(&block)
+      @block = block
+    end
+
+    def call(read)
+      -> (finish, callback) {
+        if finish
+          on_abort.()
+          return nil
+        end
+
+        read.(nil, -> (value) {
+          callback.(block.call(value))
+        })
+      }
+    end
+
+    private
+
+    attr_reader :block
+  end
+end

data/lib/pull/through/take.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pull
+  class Take
+    def initialize(limit)
+      @limit = limit
+      @index = 0
+    end
+
+    def call(read)
+      -> (finish, callback) {
+        if finish
+          on_abort.()
+          return nil
+        end
+
+        read.(nil, -> (value) {
+          return nil if @index >= @limit
+          callback.(value)
+          @index += 1
+        })
+      }
+    end
+  end
+end

data/lib/pull/version.rb

@@ -0,0 +1,3 @@
+module Pull
+  VERSION = "1.0.0"
+end

data/pull_stream.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pull/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pull_stream"
+  spec.version       = Pull::VERSION
+  spec.authors       = ["Kieran"]
+  spec.email         = ["kieran@tenthousandthings.org.uk"]
+
+  spec.summary       = %q{A minimal pull based data streaming client}
+  spec.description   = %q{A minimal pull based data streaming client}
+  spec.homepage      = "https://ruby-pull-stream.github.io"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: pull_stream
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kieran
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: pry-byebug
+  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: A minimal pull based data streaming client
+email:
+- kieran@tenthousandthings.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/pull.rb
+- lib/pull/helper.rb
+- lib/pull/sink/collect.rb
+- lib/pull/sink/drain.rb
+- lib/pull/sink/log.rb
+- lib/pull/sink/reduce.rb
+- lib/pull/source/infinity.rb
+- lib/pull/source/values.rb
+- lib/pull/through/filter.rb
+- lib/pull/through/map.rb
+- lib/pull/through/take.rb
+- lib/pull/version.rb
+- pull_stream.gemspec
+homepage: https://ruby-pull-stream.github.io
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: A minimal pull based data streaming client
+test_files: []