banzai 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33df5d09bd02ee144ba10a0b34d13071ba1d3855
-  data.tar.gz: ab729868341e7b5145c3f70fdf263099dd079fc1
+SHA256:
+  metadata.gz: 5f5811af68c70c358149d1715e7c34c1ee457a1d9c4f0c276dfab9a150e79e3e
+  data.tar.gz: b68891654e1d0f84b1570949e2468917e51a5c867982c2edc8c9e4c337b882d6
 SHA512:
-  metadata.gz: 864fba492a923a8ff6c24b4ce8e5ea56d8b8b47d8a1b414722ded28d5c20aea51228c975e04071e9f30f81537918f46a6190abc1556949e81a97d9e6b053b552
-  data.tar.gz: 34c9122ab610c73c9b91bcc8dcf2454d7f6fb06d7877c3fb0ecf5c6c55ee3dfbaecb4e9e25501a4f496e6056e99f4a849041464bacea12575d62425fe13fdb41
+  metadata.gz: 2fece6ef4f371f9eb356f733037d903a4aa0589a955284f2d19e08c4b8c73bc2125b6710ab92ab954573933778fca1c3afbdb21181f3d4c1377769bb123012f5
+  data.tar.gz: f1b5823211f65a050db0540e2c207b25abe6a14b8b5ec731cfbba7b9ab080f0fcee2d25b49774731e79a9f43853ffdc2862e89288968f48fbf3683d757a5fae5

data/README.md

@@ -16,13 +16,15 @@ First, implement some filters:
 ```ruby
 class GaussianBlur < Banzai::Filter
   def call(input)
-    # ... filter implementation ...
+    # process input
+    # ...
   end
 end 
 
 class Nostalgia < Banzai::Filter
   def call(input)
-    # ... filter implementation ...
+    # process input
+    # ...
   end
 end
 ```
@@ -31,23 +33,25 @@ Then you can apply them to some input:
 
 ```ruby
 GaussianBlur.new(radius:1.1).call(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):
 
-# 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)
+```ruby
+Nostalgia.call(image)
 ```
 
-Use pipelines to apply multiple fitlers:
+To apply multiple filters to input use `Banzai::Pipeline`. Note that you can
+combine filter class and it's instances:
 
 ```ruby
-# Note that you can combine classes and instances
-# Use instances when you need to pass options to the filter
 blurred_effect = Banzai::Pipeline.new(GaussianBlur.new(radius:1.1), Nostalgia)
 blurred_effect.call(image)
 ```
 
-Pipeline is just another filter, so you can mix them too into a new
-pipeline:
+`Banzai::Pipeline` is just another filter, so you can mix them with filters
+into a new pipeline:
 
 ```ruby
 Banzai::Pipeline.new(blurred_effect, RoundCorners.new(radius:0.87))
@@ -80,28 +84,10 @@ Open a pull request but first make sure this is green:
 
     bundle exec rake
 
+## Code status
 
-## Licence
-
-Copyright (c) 2015 Dejan Simic
-
-MIT License
+[![Circle CI](https://circleci.com/gh/dejan/banzai.svg?style=svg&circle-token=2636aac2d1b87f82160412f7613caa76d66d59ce)](https://circleci.com/gh/dejan/banzai)
 
-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.
+## Licence
 
-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.
+Banzai is released under the [MIT License](https://raw.githubusercontent.com/dejan/banzai/master/MIT-LICENCE).

data/lib/banzai.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Banzai is a simple toolkit for processing any input using filters.
 # Multiple filters can be combined into a pipeline that will transform input
 # by appliyng filters in chain feeding next one with the output of the previous.

data/lib/banzai/filter.rb

@@ -1,26 +1,30 @@
+# frozen_string_literal: true
+
 module Banzai
   # Filter transforms an input into desired output. The process of
   # transformation should be implemented in the {#call} method.
   class Filter
     attr_reader :options
 
-    # @param options [Hash] filter parameters that method {#call} can utilize
+    # @param [Hash] options The parameters that method {#call} can  utilize
     #   to make processing customizable
     def initialize(options = {})
       @options = options
     end
 
-    # Subclass should redefine this method to transform input to desired output
+    # Subclass should redefine this method to transform input to desired output.
+    # Input and return value should be the same type to provide way of chaining
+    # filters
     #
-    # @param input [Object] the type of the input is not defined since it will
-    #   depend on the (re)implementation of the method
+    # @param [Object] input
+    # @return [Object] the desired output
     def call(input)
       input
     end
 
     # Delegates to {#call} by creating an instance with default options
     #
-    # @param input [Object]
+    # @param [Object] input
     def self.call(input)
       new.call(input)
     end

data/lib/banzai/pipeline.rb

@@ -1,11 +1,23 @@
+# frozen_string_literal: true
+
 module Banzai
-  # Pipeline is a filter that accept an array of filters that will be applied
+  # Pipeline is a filter that accepts an array of filters that will be applied
   # to input sequentially.
+  #
+  # @example Create a pipeline and process input
+  #   Pipeline.new(GaussianBlur.new(radius:1.1), Nostalgia).call(image)
+  #
   class Pipeline < Filter
+    # @param [Array<Filter>] filters array of filters that will be in the
+    #   pipeline. They can be either Filter class or instance.
     def initialize(*filters)
       @filters = filters.flatten
     end
 
+    # Process input by sending it down the filters pipeline
+    #
+    # @param [Object] input
+    # @return [Object]
     def call(input)
       @filters.inject(input) do |content, filter|
         filter.call(content)

data/spec/filter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.describe Banzai::Filter, 'subclass' do
   # A simple Filter implementation for testing
   class Yell < Banzai::Filter

data/spec/pipeline_spec.rb

@@ -1,18 +1,20 @@
-RSpec.describe Banzai::Pipeline do
-  # Simple filter implementation for testing
-  class Strip < Banzai::Filter
-    def call(input)
-      input.strip
-    end
+# frozen_string_literal: true
+
+# Simple filter implementation for testing
+class Strip < Banzai::Filter
+  def call(input)
+    input.strip
   end
+end
 
-  # Simple filter implementation for testing
-  class Upcase < Banzai::Filter
-    def call(input)
-      input.upcase
-    end
+# Simple filter implementation for testing
+class Upcase < Banzai::Filter
+  def call(input)
+    input.upcase
   end
+end
 
+RSpec.describe Banzai::Pipeline do
   let(:input) { '    ohai ' }
   let(:output) { 'OHAI' }
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'banzai'
 
 RSpec.configure do |config|

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: banzai
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Dejan Simic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-03 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.53.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12
 description: Toolkit for processing input using filters and pipelines
 email:
 - desimic@gmail.com
@@ -72,12 +86,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Toolkit for processing input using filters and pipelines
 test_files:
-- spec/filter_spec.rb
-- spec/pipeline_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 
+- spec/pipeline_spec.rb
+- spec/filter_spec.rb