README.md in linepipe-0.1.1 vs README.md in linepipe-0.1.2
- old
+ new
@@ -1,10 +1,12 @@
# Linepipe
A tool to aid in processing data in a pipeline, making every step easily
testable and benchmarkable.
+[![Build Status](https://travis-ci.org/wimdu/linepipe.png?branch=master)](https://travis-ci.org/wimdu/linepipe)
+
## Installation
Add this line to your application's Gemfile:
gem 'linepipe'
@@ -21,38 +23,38 @@
Linepipe's DSL consists of 4 different parts:
* `setup`: Optional setup that will be run at the beginning.
* `data`: The input data.
-* `process`: As many of these as you want will conform the steps of your
+* `step`: As many of these as you want will conform the steps of your
algorithm.
* `expect`: In development mode, each of these will be run against your final
output data to ensure its conformity with your expectations.
While developing a processing algorithm, `Linepipe.develop` is your friend. Each
`process` block will be reduced against your data in order, and then each
`expect` block will be run against the final output to ensure that it works.
```ruby
-linepipe = Linepipe.run do
+linepipe = Linepipe.develop do
data {
%w(foo bar baz)
}
- process("Upcasing") { |data|
+ step("Upcasing") { |data|
data.map(&:upcase)
}
- process("Reversing") { |data|
+ step("Reversing") { |data|
data.reverse
}
expect { |data|
data == %w(BAZ BAR FOO)
}
end
-linepipe.result # => %W(BAZ BAR FOO)
+linepipe.output # => %W(BAZ BAR FOO)
```
Once you're comfortable with your algorithm, just change your call to
`Linepipe.develop` to `Linepipe.run` and no expectations will be run.