rewire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b8c5b21459cdeb7d24dc60323d2da26c802dcf3
+  data.tar.gz: 1fc9b208773bd2ce473649c7e936a387443d21f4
+SHA512:
+  metadata.gz: f8b88b42d79adb8340ad17640081bde3f8198fee3c8d412218eedc093068398413d9fe2de80996ea8c36cee32528c7350f2d1ee1a29b8aef36adecc6b1a0f5ac
+  data.tar.gz: a35f6758f244cc41a1aefc50be1edb93b0620911db1894e72d2c1682af95bc5f0879054ac133905dd3c44881127dd48b8a22305935546dd09aef34286dfd786f

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rewire.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ronie Uliana
+
+MIT License
+
+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,81 @@
+# Rewire
+
+Flow Based Programming in Ruby (or "Pipes in Ruby").
+
+(The next step after "DeadlySerious"[https://rubygems.org/gems/deadly_serious] gem)
+
+I think I finally figured out why components in a flow based program are not "functions" or "methods". I believe the main point is the ability to pass its own result forward several times.
+
+---------------     ---------------
+| component A | --> | component B |
+---------------     ---------------
+
+"A" can call "B" an *arbitrary* number of times. That works very differently of a function or method "return"
+
+So, adding to the other benefits, as easy parallelism and high modificability, I strongly believe the paradigm itself is really strong for pratical programs.
+
+The main goal of this gem is to provide the foundation of a "killer application" based solely on pipes (a new web framework, probably :p). Other than that, I'm using it to study the paradigm.
+
+The plan is to keep this gem minimal and add new features in new (other) gems.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rewire'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rewire
+
+## Usage
+
+The result of the computations is always collected in an object. The object ("output" below), needs to respond to the "<<" method, so arrays, strings and IOs can be used.
+
+```ruby
+require 'rewire'
+
+# Declare the component.
+# It receives 2 parameters, the output ("out" below) and the packet,
+# meaning the data passed to the pipe.
+upcaser = Rewire::Pipe.new { |out, packet| out << packet.upcase }
+
+output = []
+
+# Connect pipe to output.
+pipe =  upcaser | output
+
+# Pass things to the pipe.
+pipe << 'test'
+pipe << 'another test'
+
+# Output collects results.
+puts output # => ['TEST', 'ANOTHER TEST']
+```
+
+### A more complex example
+
+```ruby
+require 'rewire'
+
+pipeline =
+  Pipe { |out, packet| 
+```
+
+
+## TODO
+
+ - Fiber based pipes
+ - Process based pipes
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/rewire/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rewire.rb

@@ -0,0 +1,10 @@
+require "rewire/version"
+
+module Rewire; end
+
+require 'rewire/emitter'
+require 'rewire/pipe'
+
+def Pipe(&logic)
+  Rewire::Pipe.new(&logic)
+end

data/lib/rewire/emitter.rb

@@ -0,0 +1,39 @@
+module Rewire
+  class Emitter
+    def self.new(pipe, next_emitter = nil)
+      if next_emitter
+        TrunkEmitter.new(pipe, next_emitter)
+      else
+        LeafEmitter.new(pipe)
+      end
+    end
+  end
+
+  class LeafEmitter
+    def initialize(pipe)
+      @pipe = pipe
+    end
+
+    def |(pipe)
+      Emitter.new(@pipe, Emitter.new(pipe))
+    end
+
+    def <<(pack)
+      @pipe << pack
+    end
+  end
+
+  class TrunkEmitter
+    def initialize(pipe, next_emitter)
+      @pipe, @next_emitter = pipe, next_emitter
+    end
+
+    def |(pipe)
+      Emitter.new(@pipe, @next_emitter | pipe)
+    end
+
+    def <<(pack)
+      @pipe.process(@next_emitter, pack)
+    end
+  end
+end

data/lib/rewire/pipe.rb

@@ -0,0 +1,21 @@
+module Rewire
+  class Pipe
+    def initialize(&logic)
+      @logic = logic
+    end
+
+    def |(pipe)
+      Emitter.new(self) | pipe
+    end
+
+    def <<(pack)
+      output = []
+      (self | output) << pack
+      output
+    end
+
+    def process(receiver, pack)
+      @logic[receiver, pack]
+    end
+  end
+end

data/lib/rewire/version.rb

@@ -0,0 +1,3 @@
+module Rewire
+  VERSION = "0.1.0"
+end

data/rewire.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rewire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rewire"
+  spec.version       = Rewire::VERSION
+  spec.authors       = ["Ronie Uliana"]
+  spec.email         = ["ronie.uliana@vagas.com.br"]
+  spec.summary       = %q{A gem to create pipelines}
+  spec.description   = %q{Perfect to process lots of data using several processors or machines and low memory.}
+  spec.homepage      = "http://github.com/ruliana/rewire"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec"
+
+end

data/spec/lib/rewire/pipe_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Rewire::Pipe do
+  it 'runs a simple pipe' do
+    upcaser = Rewire::Pipe.new { |out, packet| out << packet.upcase }
+
+    output = []
+    pipe = upcaser | output
+
+    pipe << 'test'
+    pipe << 'another test'
+
+    expect(output).to eq ['TEST', 'ANOTHER TEST']
+  end
+
+  it 'creates its own output (sink) when none is provided' do
+    pipe = Rewire::Pipe.new { |out, packet| out << packet }
+    output = pipe << 'test'
+    expect(output).to eq ['test']
+  end
+
+  it 'outputs empty array if no "emission" (filter)' do
+    output = []
+    pipe = Rewire::Pipe.new do |out, packet|
+      # no emission
+    end | output
+    pipe << 'test'
+    expect(output).to eq []
+  end
+
+  it 'emits can be used more times in a single Pipe' do
+    output = []
+    pipe = Rewire::Pipe.new do |out, packet|
+      out << packet
+      out << packet
+    end | output
+    pipe << 'test'
+    expect(output).to eq ['test', 'test']
+  end
+
+  it 'creates a pipe using the "Pipe" function' do
+    pipe = Pipe { |out, packet| }
+    expect(pipe.class).to eq Rewire::Pipe
+  end
+
+  it 'connects two pipes' do
+    output = []
+    pipe = Pipe { |out, packet| out << packet.upcase } | Pipe { |out, packet| out << [packet.size, packet] } | output
+    pipe << 'test'
+    expect(output).to eq [[4, 'TEST']]
+  end
+
+  it 'creates its own output (sink) even with connected pipes' do
+    pipe = Pipe { |out, packet| out << packet.upcase } | Pipe { |out, packet| out << [packet.size, packet] }
+    output = pipe << 'test'
+    expect(output).to eq [[4, 'TEST']]
+  end
+
+  it 'run iteratively' do
+    source = [1, 2, 3]
+    sink = []
+
+    pipe =
+      Pipe { |out, n| out << n * 2 } |
+      Pipe { |out, n| out << n + 1 } |
+      sink
+
+    source.each { |it| pipe << it }
+
+    expect(sink).to eq [3, 5, 7]
+  end
+
+  it 'compounds immutable pipes (they can be reused)' do
+    pipe_a =
+      Pipe { |out, n| out << n * 2 } |
+      Pipe { |out, n| out << n + 1 }
+
+    pipe_b =
+      Pipe { |out, n| out << n + 2 }
+
+    compound_pipe_1 = pipe_a | pipe_b
+    compound_pipe_2 = pipe_b | pipe_a
+
+    expect(compound_pipe_1 << 3).to eq [9]
+    expect(compound_pipe_2 << 3).to eq [11]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rewire'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rewire
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronie Uliana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: guard-rspec
+  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: Perfect to process lots of data using several processors or machines
+  and low memory.
+email:
+- ronie.uliana@vagas.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rewire.rb
+- lib/rewire/emitter.rb
+- lib/rewire/pipe.rb
+- lib/rewire/version.rb
+- rewire.gemspec
+- spec/lib/rewire/pipe_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/ruliana/rewire
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A gem to create pipelines
+test_files:
+- spec/lib/rewire/pipe_spec.rb
+- spec/spec_helper.rb