banzai 0.0.1 → 0.1.0

data/README.md

@@ -14,42 +14,64 @@ First, implement some filters:
 
 ```ruby
 class GaussianBlur < Banzai::Filter
-  def apply(input)
+  def call(input)
     # ... filter implementation ...
   end
 end 
 
 class Nostalgia < Banzai::Filter
-  def apply(input)
+  def call(input)
     # ... filter implementation ...
   end
 end
 ```
 
-Then you can apply them to some input 
+Then you can apply them to some input:
 
 ```ruby
-# same as GaussianBlur.new.apply(image)
-GaussianBlur.apply(image)
+GaussianBlur.new(radius:1.1).call(image)
 
-# if you need to pass same filter options
-GaussianBlur.new(radius:1.1).apply(image)
+# You can also use class method *call* if filter doesn't have options, 
+# or you want to apply default ones (defined in implementation itself)
+GaussianBlur.call(image)
 ```
 
-Or if you want to apply multiple filter to an image create pipeline:
+Use pipelines to apply multiple fitlers:
 
 ```ruby
 # note that you can combine classes and instances
 blurred_effect = Banzai::Pipeline.new [GaussianBlur.new(radius:1.1), Nostalgia] 
-blurred_effect.apply(image)
+blurred_effect.call(image)
 ```
 
 Pipeline is just another filter, so you can mix them too into a new
 pipeline:
+
 ```ruby
 Banzai::Pipeline.new [blurred_effect, RoundCorners.new(radius:0.87)] 
 ```
 
+## Working Example
+
+Here's a simple working example:
+
+```ruby
+class StripFilter < Banzai::Filter
+  def call(input)
+    input.strip
+  end
+end
+
+class UpcaseFilter < Banzai::Filter
+  def call(input)
+    input.upcase
+  end
+end
+
+pipeline = Banzai::Pipeline.new [StripFilter, UpcaseFilter]
+puts pipeline.call('    ohai ') # prints "OHAI"
+```
+
 ## Licence
 
 Copyright (c) 2012 Dejan Simic

data/lib/banzai/filter.rb

@@ -8,12 +8,12 @@ module Banzai
     end
 
     # should be redefined in subclass
-    def apply(input)
+    def call(input)
       raise NotImplementedError
     end
     
-    def self.apply(input)
-      new.apply(input)
+    def self.call(input)
+      new.call(input)
     end
 
   end

data/lib/banzai/pipeline.rb

@@ -5,9 +5,9 @@ module Banzai
       @filters = filters
     end
   
-    def apply(input)
+    def call(input)
       @filters.inject(input) do |content, filter|
-        filter.apply(content)
+        filter.call(content)
       end
     end
 

data/lib/banzai/version.rb

@@ -1,3 +1,3 @@
 module Banzai
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/test/banzai/filter_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class LeetFilter < Banzai::Filter
-  def apply(input)
+  def call(input)
     input.gsub(/elite/, '1337')
   end
 end
@@ -14,8 +14,8 @@ describe Banzai::Filter do
     end
 
     it 'applies to some input' do
-      assert_equal '1337 security', LeetFilter.apply('elite security')
-      assert_equal '1337 security', LeetFilter.new.apply('elite security')
+      assert_equal '1337 security', LeetFilter.call('elite security')
+      assert_equal '1337 security', LeetFilter.new.call('elite security')
     end
   end
 end

data/test/banzai/pipeline_test.rb

@@ -1,13 +1,13 @@
 require 'test_helper'
 
 class StripFilter < Banzai::Filter
-  def apply(input)
+  def call(input)
     input.strip
   end
 end
 
 class UpcaseFilter < Banzai::Filter
-  def apply(input)
+  def call(input)
     input.upcase
   end
 end
@@ -15,6 +15,6 @@ end
 describe Banzai::Pipeline do
   it 'applies to input' do
     pipeline = Banzai::Pipeline.new [StripFilter, UpcaseFilter]
-    assert_equal 'OHAI', pipeline.apply('    ohai ')
+    assert_equal 'OHAI', pipeline.call('    ohai ')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banzai
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-29 00:00:00.000000000 Z
 dependencies: []
 description: Simple toolkit for processing input using filter/pipeline concept
 email: