banzai 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87ecd06527099239eda1d67d3200f3c8bd8af7db
-  data.tar.gz: 1deddcd37be707e8f0672792ba3448c1715f20ae
+  metadata.gz: 33df5d09bd02ee144ba10a0b34d13071ba1d3855
+  data.tar.gz: ab729868341e7b5145c3f70fdf263099dd079fc1
 SHA512:
-  metadata.gz: 8480c04557749e992d7acb89e1d8049638f190679a4305399abce780e05b55da529d3aca33a69fc4504dc078dd697f2811c72616dc1f354af6ea3b539d581a8c
-  data.tar.gz: 709ea20a481df1a63b6f15bd9a94b62090e199bdc168c1cebadfba4f23699c294f8880db1d5333d787502828b4d4590cbe71d67f7c673d108ed98803e2af959e
+  metadata.gz: 864fba492a923a8ff6c24b4ce8e5ea56d8b8b47d8a1b414722ded28d5c20aea51228c975e04071e9f30f81537918f46a6190abc1556949e81a97d9e6b053b552
+  data.tar.gz: 34c9122ab610c73c9b91bcc8dcf2454d7f6fb06d7877c3fb0ecf5c6c55ee3dfbaecb4e9e25501a4f496e6056e99f4a849041464bacea12575d62425fe13fdb41

data/README.md

@@ -74,6 +74,12 @@ pipeline = Banzai::Pipeline.new(StripFilter, UpcaseFilter)
 puts pipeline.call('    ohai ') # prints "OHAI"
 ```
 
+## Contributing
+
+Open a pull request but first make sure this is green:
+
+    bundle exec rake
+
 
 ## Licence
 

data/lib/banzai.rb

@@ -1,3 +1,6 @@
+# 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.
 module Banzai
   autoload :Version,  'banzai/version'
   autoload :Filter,   'banzai/filter'

data/lib/banzai/filter.rb

@@ -1,20 +1,28 @@
 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
 
-    def initialize(options={})
+    # @param options [Hash] filter parameters that method {#call} can utilize
+    #   to make processing customizable
+    def initialize(options = {})
       @options = options
     end
 
-    # This method should be redefined in subclasses
+    # Subclass should redefine this method to transform input to desired output
+    #
+    # @param input [Object] the type of the input is not defined since it will
+    #   depend on the (re)implementation of the method
     def call(input)
-      raise NotImplementedError
+      input
     end
 
+    # Delegates to {#call} by creating an instance with default options
+    #
+    # @param input [Object]
     def self.call(input)
       new.call(input)
     end
-
   end
 end

data/lib/banzai/pipeline.rb

@@ -1,15 +1,15 @@
 module Banzai
+  # Pipeline is a filter that accept an array of filters that will be applied
+  # to input sequentially.
   class Pipeline < Filter
-
     def initialize(*filters)
       @filters = filters.flatten
     end
-  
+
     def call(input)
       @filters.inject(input) do |content, filter|
         filter.call(content)
       end
     end
-
   end
 end

data/spec/filter_spec.rb

@@ -1,26 +1,27 @@
-describe Banzai::Filter, 'subclass' do
-
-  class LeetFilter < Banzai::Filter
+RSpec.describe Banzai::Filter, 'subclass' do
+  # A simple Filter implementation for testing
+  class Yell < Banzai::Filter
     def call(input)
-      input.gsub(/elite/, '1337')
+      input.to_s.upcase + '!' * level
     end
-  end
 
-  context 'instance' do
-    it 'is created with options' do
-      filter = LeetFilter.new(:mode => 'hardcore')
-      expect(filter.options[:mode]).to eq 'hardcore'
+    def level
+      options[:level] || 1
     end
+  end
 
-    it 'applies to input' do
-      expect(LeetFilter.new.call('elite security')).to eq '1337 security'
+  subject { Yell }
+  let(:input) { 'chunky bacon' }
+
+  describe '.call' do
+    it 'filters the input' do
+      expect(subject.call(input)).to eq 'CHUNKY BACON!'
     end
   end
 
-  context 'class' do
-    it 'applies to input' do
-      expect(LeetFilter.call('elite security')).to eq '1337 security'
+  describe '#call' do
+    it 'filters the input using options' do
+      expect(subject.new(level: 3).call(input)).to eq 'CHUNKY BACON!!!'
     end
   end
-
 end

data/spec/pipeline_spec.rb

@@ -1,25 +1,36 @@
-describe Banzai::Pipeline do
-
-  class StripFilter < Banzai::Filter
+RSpec.describe Banzai::Pipeline do
+  # Simple filter implementation for testing
+  class Strip < Banzai::Filter
     def call(input)
       input.strip
     end
   end
 
-  class UpcaseFilter < Banzai::Filter
+  # Simple filter implementation for testing
+  class Upcase < Banzai::Filter
     def call(input)
       input.upcase
     end
   end
 
-  it 'applies provided filters to input' do
-    pipeline = Banzai::Pipeline.new(StripFilter, UpcaseFilter)
-    expect(pipeline.call('    ohai ')).to eq 'OHAI'
-  end
+  let(:input) { '    ohai ' }
+  let(:output) { 'OHAI' }
 
-  it 'accepts array of filters' do
-    pipeline = Banzai::Pipeline.new([StripFilter, UpcaseFilter])
-    expect(pipeline.call('    ohai ')).to eq 'OHAI'
+  describe 'initialized with array of filters' do
+    subject { Banzai::Pipeline.new([Strip, Upcase]) }
+    describe '.call' do
+      it 'filters the input' do
+        expect(subject.call(input)).to eq output
+      end
+    end
   end
 
+  describe 'initialized with splatted array of filters' do
+    subject { Banzai::Pipeline.new(Strip, Upcase) }
+    describe '.call' do
+      it 'filters the input' do
+        expect(subject.call(input)).to eq output
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,98 +1,11 @@
 require 'banzai'
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
   config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
     mocks.verify_partial_doubles = true
   end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
 end

metadata

@@ -1,37 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: banzai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dejan Simic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-27 00:00:00.000000000 Z
-dependencies: []
-description: Simple toolkit for processing input using filter/pipeline concept
+date: 2015-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: yard
+  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: Toolkit for processing input using filters and pipelines
 email:
 - desimic@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- Gemfile
 - README.md
-- Rakefile
-- banzai.gemspec
 - lib/banzai.rb
 - lib/banzai/filter.rb
 - lib/banzai/pipeline.rb
-- lib/banzai/version.rb
 - spec/filter_spec.rb
 - spec/pipeline_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/dejan/banzai
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -52,8 +75,9 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Simple toolkit for processing input using filter/pipeline concept
+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: 

data/.gitignore

@@ -1,17 +0,0 @@
-*.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/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/Gemfile

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in banzai.gemspec
-gemspec
-
-group :development do
-  gem 'bundler'
-  gem 'rake'
-  gem 'rspec'
-end

data/Rakefile

@@ -1,12 +0,0 @@
-#!/usr/bin/env rake
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
-
-task :default => :test
-

data/banzai.gemspec

@@ -1,19 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'banzai/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "banzai"
-  gem.version       = Banzai::VERSION
-  gem.authors       = ["Dejan Simic"]
-  gem.email         = ["desimic@gmail.com"]
-  gem.description   = %q{Simple toolkit for processing input using filter/pipeline concept}
-  gem.summary       = %q{Simple toolkit for processing input using filter/pipeline concept}
-  gem.homepage      = "https://github.com/dejan/banzai"
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-end

data/lib/banzai/version.rb

@@ -1,3 +0,0 @@
-module Banzai
-  VERSION = "0.1.1"
-end