rspec-plugins 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "rspec"
+end

data/LICENSE

@@ -0,0 +1,191 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,44 @@
+rspec-plugins
+=============
+
+A simple plugin mechanism for RSpec.
+Make your hooks reusable through a plugin module.
+
+```ruby
+include 'rspec-plugins'
+
+class SimpleCounter < RSpec::Plugins::Base
+  attr_accessor :count
+
+  def initialize
+    super
+    @counter = 0
+  end
+
+  def increment(value = 1)
+    @count += value
+  end
+end
+
+RSpec::Plugins::Core.debug = true
+
+describe SimpleCounter do
+  include RSpec::Plugins::Core
+  plugins.enable :counter => SimpleCounter.new
+
+  plugin :counter, :increment
+  plugin :counter, :increment, 5
+end
+```
+
+# usage
+
+Please please have a look at the specs for now [(Counter Plugin Spec)](spec/counter_plugin_spec.rb).
+
+## debugging
+
+To enable debugging:
+
+```ruby
+RSpec::Plugins::Core.debug = true
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'fileutils'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# make test task the gem task
+task :default => :spec
+task :spec => :clean
+
+desc 'Remove generated files.'
+task :clean do
+  ['spec/reports', 'spec/coverage'].each do |path|
+    FileUtils.rm_rf(path) if File.exists?(path)
+  end
+end

data/lib/rspec-plugins.rb

@@ -0,0 +1,8 @@
+module RSpec
+    module Plugins
+        # here comes your code
+    end
+end
+
+require 'rspec-plugins/version'
+require 'rspec-plugins/core'

data/lib/rspec-plugins/core.rb

@@ -0,0 +1,106 @@
+require 'rspec/core'
+
+module RSpec::Plugins
+  module Core
+    class << self
+      attr_accessor :debug
+
+      def debug?
+        @debug ||= false
+      end
+
+      def log(message)
+        debug? && puts(message)
+      end
+
+      def included(example_group)
+        proxy = Proxy.new(example_group)
+        example_group.metadata[:plugins] = proxy
+        example_group.define_singleton_method(:plugins) { proxy }
+        example_group.define_singleton_method :plugin do |plugin_id, meth, *args, &block|
+          current_example_group = self
+          plugin = proxy[plugin_id]
+          if plugin.nil?
+              raise("No plugin with id :#{plugin_id} enabled. Enabled plugins: #{proxy.plugins.keys}")
+          else
+            current_example_group.before(:all) do
+              plugin.current_example_group = current_example_group
+              Core.log("Calling plugin method #{plugin}##{meth}")
+              plugin.send(meth, *args, &block)
+            end
+          end
+        end
+        log "Included RSpec::Plugins::Core in example group [#{example_group.description}]"
+      end
+    end
+  end
+
+  class Proxy
+    attr_reader :plugins, :example_group
+
+    def initialize(example_group)
+      @example_group = example_group
+      @plugins = {}
+    end
+
+    def [](key)
+      @plugins[key]
+    end
+
+    def enable(enable_plugins)
+      proxy = self
+      enable_plugins.each_pair do |key, plugin|
+        Core.log "Add plugin :#{key}"
+        plugin.proxy = proxy
+        # TODO check for duplicates
+        @plugins[key] = plugin
+        @example_group.send :before, :all do |running_example_group|
+          plugin.current_example_group = running_example_group
+          plugin.enable
+          Core.log "Enabled plugin :#{key}"
+        end
+        if plugin.respond_to?(:around)
+          @example_group.send :around, :each do |running_example|
+            Core.log "Calling #{plugin}#around"
+            plugin.around(running_example)
+          end
+        end
+        @example_group.send :after, :all do |running_example_group|
+          plugin.current_example_group = running_example_group
+          plugin.disable
+          proxy.plugins.delete(key)
+          Core.log "Disabled plugin :#{key}"
+        end
+      end
+    end
+  end
+
+  class Base
+    attr_accessor :enabled, :proxy, :current_example_group
+
+    def log(message)
+      Core.log(message)
+    end
+
+    def initialize
+      @enabled = false
+      @proxy = nil
+      @current_example_group = nil
+    end
+
+    def enable
+      @enabled = true
+    end
+
+    def disable
+      @enabled = false
+    end
+
+    def after(*args, &block)
+      plugin = self
+      @current_example_group.send :after, :all  do
+        block.call(plugin, *args)
+      end
+    end
+  end
+end

data/lib/rspec-plugins/version.rb

@@ -0,0 +1,6 @@
+module Rspec
+    module Plugins
+        VERSION = "0.0.1"
+    end
+end
+

data/rspec-plugins.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec-plugins/version'
+
+s = Gem::Specification.new
+
+s.name          = "rspec-plugins"
+s.version       = Rspec::Plugins::VERSION
+s.authors       = ["Ruben Jenster"]
+s.email         = ["r.jenster@drachenfels.de"]
+s.description   = %q{A plugin mechanism for RSpec}
+s.summary       = %q{Make your hooks reusable through in a plugin module or easily create a custom formatter.}
+s.homepage      = "http://github.com/Drachenfels-GmbH/rspec-plugins"
+
+s.files         = `git ls-files`.split($/)
+s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+s.require_paths = ["lib"]
+s.add_development_dependency "rake"
+
+s.add_development_dependency "simplecov"
+s.add_development_dependency "simplecov-rcov"
+
+s
+

data/spec/counter_plugin_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+class CounterPlugin < RSpec::Plugins::Base
+  attr_accessor :counter
+
+  def initialize
+    super
+    @counter = 0
+  end
+
+  def increment
+    @counter += 1
+  end
+end
+
+RSpec::Plugins::Core.debug = true
+
+describe '-- #1 plugins' do
+  include RSpec::Plugins::Core
+  plugins.enable :counter => CounterPlugin.new
+  plugins.enable :counter2 => CounterPlugin.new
+
+  let(:plugins) { example.metadata[:plugins] }
+
+  context "counter.increment 2, counter2.increment 1" do
+    plugin :counter, :increment
+    plugin :counter, :increment
+    plugin :counter2, :increment
+
+    describe "plugin :counter" do
+      subject { plugins[:counter] }
+      its(:counter) { should eq(2) }
+    end
+
+    describe "plugin :counter2" do
+      subject { plugins[:counter2] }
+      its(:counter) { should eq(1) }
+    end
+
+    context "counter.increment 1, counter2.increment 2" do
+      plugin :counter, :increment
+      plugin :counter2, :increment
+      plugin :counter2, :increment
+
+      describe "plugin :counter" do
+        subject { plugins[:counter] }
+        its(:counter) { should eq(3) }
+      end
+
+      describe "plugin :counter2" do
+        subject { plugins[:counter2] }
+        its(:counter) { should eq(3) }
+      end
+    end
+  end
+
+  context "counter2.increment 2" do
+    plugin :counter2, :increment
+    plugin :counter2, :increment
+
+    describe "plugin :counter" do
+      subject { plugins[:counter] }
+      its(:counter) { should eq(3) }
+    end
+
+    describe "plugin :counter2" do
+      subject { plugins[:counter2] }
+      its(:counter) { should eq(5) }
+    end
+  end
+end
+
+describe '-- #2 plugins' do
+  include RSpec::Plugins::Core
+
+  let(:plugins) { example.metadata[:plugins] }
+  plugins.enable :counter => CounterPlugin.new
+
+  describe "#plugins" do
+    subject { plugins[:counter] }
+    its(:counter) { should eq(0) }
+  end
+
+  describe "#plugins" do
+    plugin :counter, :increment
+    subject { plugins[:counter] }
+    its(:counter) { should eq(1) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'simplecov'
+require 'simplecov-rcov'
+
+SimpleCov.start do
+  formatter SimpleCov::Formatter::MultiFormatter[
+                SimpleCov::Formatter::HTMLFormatter,
+                SimpleCov::Formatter::RcovFormatter,
+            ]
+  add_filter "/spec/"
+end
+
+require "rspec"
+require_relative "../lib/rspec-plugins"
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rspec-plugins
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ruben Jenster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A plugin mechanism for RSpec
+email:
+- r.jenster@drachenfels.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rspec-plugins.rb
+- lib/rspec-plugins/core.rb
+- lib/rspec-plugins/version.rb
+- rspec-plugins.gemspec
+- spec/counter_plugin_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/Drachenfels-GmbH/rspec-plugins
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Make your hooks reusable through in a plugin module or easily create a custom
+  formatter.
+test_files:
+- spec/counter_plugin_spec.rb
+- spec/spec_helper.rb
+has_rdoc: