gurke 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e85f846008f8a50b146bf69dca846d1e7fd57549
+  data.tar.gz: 71265a8d33673e0df171d924be526d98aef0d2cd
+SHA512:
+  metadata.gz: 0c010846e3ed562d0bd1c1c52abdd47c0b38e27b35913de6c4490898baee435cd3c7149483e810831c762651586b7170a883c818042b0636da63925358014259
+  data.tar.gz: ff7a64e2be4a0086c3a569d1c80150c07da7b1404725d9119487a37e9a8967735c3db821f2fd9091a70481aa8bf33f9c248060ccaea8ac25b26d06c7bf66cb0b

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+*.iml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gurke-formatters-headless.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+MIT License
+
+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.
+
+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.

data/README.md

@@ -0,0 +1,74 @@
+# Gurke
+
+**Gurke** is a highly opinionated cucumber toolkit overtaking cucumbers formatter to add webm flv video recording with headless (xvfb), multiple output formatters, global available current step and scenario and additional hooks.
+
+Unfinished, not recommended, highly dangerous!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gurke'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gurke
+
+## Usage
+
+```
+require 'gurke'
+
+require 'cucumber/formatter/pretty'
+require 'cucumber/formatter/junit'
+require 'gurke/formatters/headless'
+
+class MyExternalTool < ::Gurke::Formatters::Base
+  def quiet?
+    options[:quiet]
+  end
+
+  def before_features(features)
+    puts 'BUUUH!' unless quiet?
+  end
+end
+
+Gurke::Formatter.config do
+  use Cucumber::Formatter::Pretty
+  use Cucumber::Formatter::JUnit
+  use MyExternalTool, quiet: true
+  use Gurke::Formatters::Headless, dir: 'report/html', recording: true, record_all: true
+end
+```
+
+```
+Gurke.current.step
+Gurke.current.scenario
+
+Gurke.before :features do |*args|
+  # ...
+end
+
+Gurke.before :feature_element do |*args|
+  # ...
+end
+
+Gurke.after :step_result do |*args|
+  # ...
+end
+
+#...
+
+```
+
+## TODO
+
+* Headless Dir & HTML Template
+
+## Contributing
+
+Don't even think about it.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gurke.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gurke'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Jan Graichen']
+  spec.email         = %w(jg@altimos.de)
+  spec.description   = %q{A description}
+  spec.summary       = %q{A summary}
+  spec.homepage      = 'https://github.com/jgraichen/gurke'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'cucumber'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/gurke/current.rb

@@ -0,0 +1,31 @@
+module Gurke
+  class Current
+    attr_accessor :scenario, :step
+
+    class << self
+      def instance
+        @instance ||= new
+      end
+
+      def scenario
+        instance.scenario
+      end
+
+      def step
+        instance.step
+      end
+    end
+
+    class Formatter < Gurke::Formatters::Base
+      def before_scenario(scenario)
+        Current.instance.scenario = scenario
+      end
+
+      def before_step(step)
+        Current.instance.step = step
+      end
+    end
+
+    ::Gurke::Formatter.use Formatter
+  end
+end

data/lib/gurke/formatter.rb

@@ -0,0 +1,177 @@
+require 'active_support/core_ext/string/inflections'
+require 'gurke/formatters/base'
+
+module Gurke
+  class Formatter
+    attr_reader :runtime, :options
+    attr_reader :current_feature, :current_step
+
+    def initialize(runtime, path_or_io, options)
+      @runtime, @path_or_io, @options = runtime, path_or_io, options
+
+      self.class.formatters.each do |klass, opts|
+        if klass.respond_to?(:gurkig?) && klass.gurkig?
+          formatters << klass.new(self, opts)
+        else
+          legacy << klass.new(runtime, path_or_io, options)
+        end
+      end
+
+      self.class.instance = self
+    end
+
+    def formatters
+      @formatters ||= []
+    end
+
+    def legacy
+      @legacy ||= []
+    end
+
+    ## -- Before callbacks --
+
+    def before_features(features)
+      invoke :before, :features, [features]
+    end
+
+    def before_feature(feature)
+      invoke :before, :feature, [feature]
+    end
+
+    def before_tags(tags)
+      invoke :before, :tags, [tags]
+    end
+
+    def before_background(background)
+      invoke :before, :background, [background]
+    end
+
+    def before_steps(steps)
+      invoke :before, :steps, [steps]
+    end
+
+    def before_step(step)
+      invoke :before, :step, [step]
+    end
+
+    def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
+      invoke :before, :step_result, [keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line]
+    end
+
+    def before_feature_element(element)
+      invoke :before, :feature_element, [element]
+      invoke :before, :scenario, args: [element]
+    end
+
+    ## -- Element callbacks --
+
+    def manual_step(step, opts)
+      invoke nil, :manual_step, args: [step, opts]
+    end
+
+    def feature_name(name, description)
+      invoke nil, :feature_name, [name, description]
+    end
+
+    def tag_name(name)
+      invoke nil, :tag_name, [name]
+    end
+
+    def background_name(keyword, name, file_colon_line, source_indent)
+      invoke nil, :background_name, [keyword, name, file_colon_line, source_indent]
+    end
+
+    def scenario_name(keyword, name, file_colon_line, source_indent)
+      invoke nil, :scenario_name, [keyword, name, file_colon_line, source_indent]
+    end
+
+    def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
+      invoke nil, :step_name, [keyword, step_match, status, source_indent, background, file_colon_line]
+    end
+
+    def exception(exception, status)
+      invoke nil, :exception, [exception, status]
+    end
+
+    ## -- After callbacks --
+
+    def after_feature_element(element)
+      invoke :after, :feature_element, [element]
+      invoke :before, :scenario, args: [element]
+    end
+
+    def after_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
+      invoke :after, :step_result, [keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line]
+    end
+
+    def after_step(step)
+      invoke :after, :step, [step]
+    end
+
+    def after_steps(steps)
+      invoke :after, :steps, [steps]
+    end
+
+    def after_background(background)
+      invoke :after, :background, [background]
+    end
+
+    def after_tags(tags)
+      invoke :after, :tags, [tags]
+    end
+
+    def after_feature(feature)
+      invoke :after, :feature, [feature]
+    end
+
+    def after_features(features)
+      invoke :after, :features, [features]
+    end
+
+    private
+    def invoke(type, name, args = {})
+      args = { args: args, legacy: args } if Array === args
+
+      if args[:args]
+        (type == :after ? formatters.reverse : formatters).each do |fmt|
+          mth = type.nil? ? name : "#{type}_#{name}"
+          fmt.send mth, *args[:args] if fmt.respond_to? mth
+        end
+      end
+
+      if args[:legacy]
+        legacy.each do |fmt|
+          mth = type.nil? ? name : "#{type}_#{name}"
+          fmt.send mth, *args[:legacy] if fmt.respond_to? mth
+        end
+      end
+    end
+
+    class << self
+      attr_reader :legacy_formatter
+      attr_accessor :instance
+
+      def formatters
+        @formatters ||= {}
+      end
+
+      def config(&block)
+        instance_eval &block
+      end
+
+      def use(formatter, options = {})
+        klass = lookup_formatter(formatter)
+        raise InvalidArgument.new 'Cannot find formatters `#{formatters}\'.' unless klass
+
+        formatters[klass] = options
+      end
+
+      private
+      def lookup_formatter(formatter)
+        return formatter if formatter.is_a? Class
+        formatter.camelize.safe_constantize
+      end
+    end
+  end
+end
+

data/lib/gurke/formatters/base.rb

@@ -0,0 +1,17 @@
+module Gurke
+  module Formatters
+    class Base
+      attr_reader :main, :options
+
+      def initialize(main, options)
+        @main, @options = main, options
+      end
+
+      class << self
+        def gurkig?
+          true
+        end
+      end
+    end
+  end
+end

data/lib/gurke/formatters/headless.rb

@@ -0,0 +1,97 @@
+require 'fileutils'
+require 'headless'
+
+module Gurke
+  module Formatters
+    class Headless < Base
+      attr_reader :tmpdir
+
+      def initialize(*args)
+        super
+
+        @tmpdir   = options.delete(:tmpdir) { |el| Dir.mktmpdir }
+        @headless = ::Headless.new video: video_options
+        @index    = 0
+      end
+
+      def video_options
+        {
+            codec: 'libvpx',
+            log_file_path: File.join(tmpdir, 'ffmpeg.log'),
+            tmp_file_path: File.join(tmpdir, 'ffmpeg.tmp.webm')
+        }
+      end
+
+      def dir
+        File.mkdir
+      end
+
+      def recording?
+        !!options[:recording]
+      end
+
+      def record_all?
+        !!options[:record_all]
+      end
+
+      # -- Start / Stop --
+
+      def before_features(features)
+        @headless.start
+        at_exit { destroy }
+      end
+
+      def after_features(features)
+        destroy
+
+        # TODO: Dir / Template / Whatever - just test atm
+      end
+
+      # -- Intercept scenarios --
+
+      def before_feature_element(scenario)
+        if recording?
+          @headless.video.start_capture
+        end
+      end
+
+      def after_feature_element(scenario)
+        if recording?
+          if scenario.failed? || record_all?
+            # TODO: Dir / Template / Whatever - just test atm
+            file = File.join('report', "#{scenario.name}.flv")
+            @headless.video.stop_and_save file
+          else
+            @headless.video.stop_and_discard
+          end
+        end
+
+        # TODO: Dir / Template / Whatever - just test atm
+      end
+
+      # -- Intercept steps --
+
+      def manual_step(step, opts)
+        take_sceenshot step
+      end
+
+      def after_step(step)
+        take_sceenshot step
+      end
+
+      private
+      def destroy
+        @headless.destroy if @headless
+      end
+
+      def take_sceenshot(step)
+        return if step.background?
+
+        filename = "#{step.keyword}#{step.name}".downcase.gsub(/[^A-z0-9]+/, '_')
+
+        # TODO: Dir / Template / Whatever - just test atm
+        @headless.take_screenshot "report/#{@index += 1}_#{filename}.png"
+      end
+    end
+  end
+end

data/lib/gurke/hooks.rb

@@ -0,0 +1,42 @@
+module Gurke
+  class Hooks
+    attr_reader :hooks
+
+    def initialize
+      @hooks = {}
+    end
+
+    def add(target, &block)
+      target.to_s.tap do |target|
+        hooks[target] ||= []
+        hooks[target] << block
+      end
+    end
+
+    def invoke(target, *args)
+      return unless hooks[target]
+
+      hooks[target].each do |hook|
+        hook.call *args
+      end
+    end
+
+    class << self
+      def before; @before ||= new end
+      def after; @after ||= new end
+    end
+
+    class Formatter < Formatters::Base
+      %w(features feature scenario step).each do |name|
+        define_method "before_#{name}" do |*args|
+          Hooks.before.invoke name, *args
+        end
+        define_method "after_#{name}" do |*args|
+          Hooks.after.invoke name, *args
+        end
+      end
+    end
+
+    ::Gurke::Formatter.use Formatter
+  end
+end

data/lib/gurke/patch/cucumber_cli_configuration.rb

@@ -0,0 +1,16 @@
+# Patch configuration to always use
+module Cucumber
+  module Cli
+    class Configuration
+      alias_method :orig_formatter_class, :formatter_class
+      def formatter_class(format)
+        unless @__gurke_original_formatter_registered
+          ::Gurke::Formatter.use orig_formatter_class(format)
+          @__gurke_original_formatter_registered = true
+        end
+
+        ::Gurke::Formatter
+      end
+    end
+  end
+end

data/lib/gurke.rb

@@ -0,0 +1,30 @@
+require 'cucumber'
+
+require 'gurke/patch/cucumber_cli_configuration'
+require 'gurke/formatter'
+
+require 'gurke/current'
+require 'gurke/hooks'
+
+
+module Gurke
+  class << self
+    def current
+      @current ||= Gurke::Current.instance
+    end
+
+    def before(stage, &block)
+      Hooks.before.add stage, &block
+    end
+
+    def after(stage, &block)
+      Hooks.after.add stage, &block
+    end
+
+    def step!(opts = {})
+      if (fmt = Gurke::Formatter.instance)
+        fmt.manual_step current.step, opts
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: gurke
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A description
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gurke.gemspec
+- lib/gurke.rb
+- lib/gurke/current.rb
+- lib/gurke/formatter.rb
+- lib/gurke/formatters/base.rb
+- lib/gurke/formatters/headless.rb
+- lib/gurke/hooks.rb
+- lib/gurke/patch/cucumber_cli_configuration.rb
+homepage: https://github.com/jgraichen/gurke
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A summary
+test_files: []