pied_piper 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87334c647e9be342839edbef72429d045ed689e4d4279493829e157de81df18a
+  data.tar.gz: 39a736f7f6c659f22ee63e5742e6109ddbec69d4c1550ea7a862e52fac9cb646
+SHA512:
+  metadata.gz: 86ae9191ce94fe5ca8699a43818b6ad640fd5e164208242d51b527e5449247b5b91cc2401530d85d444ed34323ef9203ae6146c596c36bc9b56c77de6d50b3d4
+  data.tar.gz: 5721440aa08e28016e20985f009135f3388cc6d944aab30cba66bd44ebc0c7c66f3c749f64cec0692ade4d5c3712009fe162b01b291753ba62763d23035c9caa

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

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 christophweegen@googlemail.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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pied_piper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    pied_piper (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  pied_piper!
+  pry
+  rake (~> 12.3)
+  rspec (~> 3.8)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Christoph Weegen
+
+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,183 @@
+# PiedPiper - Don't let him lure you away...
+
+This gem provides "Unix-like" pipe functionality in Ruby.
+
+Another inspiration for this gem were `|>` pipes and functional programming in [Elixir](https://elixir-lang.org).
+
+If you want to read about the inspiration for the name `PiedPiper`, it's an old german [fairy tale](https://en.wikipedia.org/wiki/Pied_Piper_of_Hamelin), of a guy who played pipe and hypnotized and lured all children out of town with his music and they were never be seen again.
+
+Despite the word "pipe" there's also another common thing between the fairy tale and pipes in this gem:
+
+There's a "piper" object who lures "children" (other objects) away ( through pipes ) until they never be seen again ( are transformed into other objects ).  :-)
+
+If you never worked with pipes, this little analogy may help to understand what's happening.
+
+Have fun with PiedPiper and don't let him lure you away :-)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pied_piper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pied_piper
+
+## Usage
+
+First you have to initialize a piper object with another object of your choice:
+
+```ruby
+require "pied_piper"
+
+piper = PiedPiper.new("rats and children")
+```
+
+A shortcut to get a piper object anywhere you want, is shown in the following example. Only use this if your name is "Chuck Norris of Hamelin", since it "roundhouse pipes" (monkey-patches) Ruby's `Kernel` module :-D
+
+```ruby
+require 'pied_piper/kernel'
+
+piper = pipe("rats and children")
+```
+
+Once you have a piper object you can pipe it "Unix-style".
+
+Our initial object (e.g: `"rats and children"`), is passed around through each pipe from left to right and transformed by one of the following objects:
+
+### Symbol/String Pipes
+
+1. A Symbol or String, this calls a method on the piped object with the same name:
+
+```ruby
+p = pipe("rats and children")
+p | :upcase | p.end
+# => "RATS AND CHILDREN"
+```
+
+Note: Since "piping" is not a native Ruby syntax feature, rather than a method call in disguise (e.g: `p.|(:upcase)`), the underlying `PiedPiper` class, which wraps the initial object (e.g: `"foo"`) and on which the pipe method is called, is just a wrapper for the initial object which handles piping logic.
+
+Everytime you "pipe" you create a new object of class `PiedPiper`, which wraps the mutated inital object again (e.g: from `"foo"` to `"FOO"`).
+
+At the end of each pipe-chain, the piped object has to be "unwrapped" again by ending the pipe-chain with the `.end` method on the pipe object or by just writing `PiedPiper::EndOfPipe` or if you have required `pied_piper/kernel` you can just write `pipe_end`.
+
+```ruby
+p = pipe("rats and children")
+
+p | :upcase | p.end
+# => "RATS AND CHILDREN"
+
+p | :upcase | PiedPiper::EndOfPipe
+# => "RATS AND CHILDREN"
+
+p | :upcase | pipe_end # when PiedPiper::Kernel was required
+# => "RATS AND CHILDREN"
+```
+
+### Array Pipes
+
+An Array, whose first element (Symbol/String) again acts as a method call on the piped object and additonal elements which act as parameters to the method call.
+
+```ruby
+p = pipe("Pied Piper")
+
+concat = [:concat, " of", " Hamelin"]
+
+p | concat  | p.end
+# => "Pied Piper of Hamelin"
+```
+
+### Proc Object Pipes
+
+An Object of `Proc` class which takes exactly one parameter:
+- `Proc.new { |child| ... }`
+- `proc { |child| ... }`
+- `lambda { |child| ... }`
+- `->(child) { ... }`
+
+```ruby
+p = pipe("Hypnotized child")
+
+no_happy_end = ->(child) { child + " was never seen again" }
+
+p | no_happy_end | p.end
+# => "Hypnotized child was never seen again"
+```
+
+### Method Object Pipe
+
+An object of the `Method` class, where the piped object will be used as the first parameter. You can pass an Array if you need additional parameters:
+
+```ruby
+class PiedPiperOfHamelin
+  def self.plays_song_on_pipe(audience = "Children", effect = "slightly")
+    puts "#{audience} feel already #{effect + " "}hypnotized!"
+  end
+end
+
+p = pipe("You")
+hypnotize = PiedPiperOfHamelin.method(:plays_song_on_pipe)
+
+p | hypnotize | p.end
+# => "You feel already slightly hypnotized!"
+
+p | [hypnotize, "VERY"] | p.end
+# => "You feel already VERY hypnotized!"
+```
+
+### Combining Pipes
+
+Once you know the basic building blocks, you can combine them and build your own pipes of arbitrary length:
+
+```ruby
+piper = pipe('You')
+lures = [:+, " feel"]
+you = ->(str) { str + " hypnotized!" }
+away = :upcase
+
+piper | lures | you | away | h.end
+# => "YOU FEEL HYPNOTIZED!"
+```
+
+### Multiline Pipes
+
+Sadly Ruby's syntax doesn't allow for totally nice multiline pipes ( at least not in a way I already found out ). Thus multiline pipes have to be written like this ( since they're actually just inline syntactic sugar for methods like `obj.|(arg)` under the hood:
+
+```ruby
+piper = pipe('You')
+lures = [:+, " feel"]
+you = ->(str) { str + " hypnotized!" }
+away = :upcase
+
+piper
+  .|(lures)
+  .|(you)
+  .|(away).
+  .|(h.end)
+# => "YOU FEEL HYPNOTIZED!"
+```
+
+## 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/christophweegen/pied-piper. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PiedPiper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/christophweegen/pied-piper/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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pied_piper"
+
+# 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/pied_piper/kernel.rb

@@ -0,0 +1,11 @@
+module PiedPiper::Kernel
+  ::Kernel.class_eval do
+    def pipe(obj = nil)
+      PiedPiper.new(obj)
+    end
+
+    def pipe_end
+      PiedPiper::EndOfPipe
+    end
+  end
+end

data/lib/pied_piper/version.rb

@@ -0,0 +1,3 @@
+class PiedPiper
+  VERSION = '0.1.1'.freeze
+end

data/lib/pied_piper.rb

@@ -0,0 +1,42 @@
+require 'pied_piper/version'
+
+class PiedPiper
+  class EndOfPipe; end
+  attr_reader :object
+
+  def initialize(object)
+    @object = object
+  end
+
+  def end
+    EndOfPipe
+  end
+
+  def |(function)
+    return object if function == EndOfPipe
+
+    piped_result = result(function)
+    PiedPiper.new(piped_result)
+  end
+
+  private
+
+  def result(function)
+    case function
+    when Symbol
+      @object.send(function)
+    when Array
+      meth, *args = function
+      case meth
+      when Symbol
+        @object.send(meth, *args)
+      when Method
+        meth.call(@object, *args)
+      end
+    when Proc
+      function.call(@object, *args)
+    when Method
+      function.call(@object, *args)
+    end
+  end
+end

data/pied_piper.gemspec

@@ -0,0 +1,42 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pied_piper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pied_piper'
+  spec.version       = PiedPiper::VERSION
+  spec.authors       = ['Christoph Weegen']
+  spec.email         = ['christophweegen@googlemail.com']
+
+  spec.summary       = 'Unix-like pipes in Ruby'
+  spec.description   = 'Unix-like pipes in Ruby'
+  spec.homepage      = 'https://github.com/christophweegen/pied-piper'
+  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"
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/christophweegen/pied-piper'
+    spec.metadata['changelog_uri'] = 'https://github.com/christophweegen/pied-piper/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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{^(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', '~> 2.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: pied_piper
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christoph Weegen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-10 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: pry
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Unix-like pipes in Ruby
+email:
+- christophweegen@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pied_piper.rb
+- lib/pied_piper/kernel.rb
+- lib/pied_piper/version.rb
+- pied_piper.gemspec
+homepage: https://github.com/christophweegen/pied-piper
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/christophweegen/pied-piper
+  source_code_uri: https://github.com/christophweegen/pied-piper
+  changelog_uri: https://github.com/christophweegen/pied-piper/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Unix-like pipes in Ruby
+test_files: []