maniok_bdd 0.0.0 → 0.1.0

data/README.md

@@ -1,19 +1,25 @@
 BDD with POROs
 
-[![Build Status](https://travis-ci.org/21croissants/maniok_bdd.png?branch=master)](https://travis-ci.org/21croissants/maniok_bdd) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/21croissants/maniok_bdd) [![Dependency Status](https://gemnasium.com/21croissants/maniok_bdd.png)](https://gemnasium.com/21croissants/maniok_bdd)
+[![Gem Version](https://badge.fury.io/rb/maniok_bdd.png)](http://badge.fury.io/rb/maniok_bdd)
+[![Dependency Status](https://gemnasium.com/21croissants/maniok_bdd.png)](https://gemnasium.com/21croissants/maniok_bdd)
+[![Build Status](https://travis-ci.org/21croissants/maniok_bdd.png?branch=master)](https://travis-ci.org/21croissants/maniok_bdd)
+[![Coverage Status](https://coveralls.io/repos/21croissants/maniok_bdd/badge.png?branch=master)](https://coveralls.io/r/21croissants/maniok_bdd)
+[![Code Climate](https://codeclimate.com/github/21croissants/maniok_bdd.png)](https://codeclimate.com/github/21croissants/maniok_bdd)
 
-Install
-=======
+# Documentation
+
+[Hosted on relish](https://www.relishapp.com/21croissants/maniok-bdd)
+
+# Install
 
     gem install maniok_bdd
 
-Usage
-=====
+# Usage
 
     CODE EXAMPLE
 
-Author
-======
+# Author
+
 [Jean-Michel Garnier](http://21croissants.com)<br/>
 
 License: MIT<br/>

data/lib/maniok_bdd/cli.rb

@@ -0,0 +1,36 @@
+class ManiokBdd::Cli
+
+  def initialize(args)
+    @feature_file = args.first
+  end
+
+  def run
+    gherkin_formatter = ManiokBdd::GherkinFormatter.build @feature_file
+
+    create_spec_acceptance_folder
+    write_file ruby_file, gherkin_formatter.to_s
+
+    0 # success:)
+  end
+
+  def create_spec_acceptance_folder
+    create_unless_exists "spec"
+    create_unless_exists File.join("spec", "acceptance")
+  end
+
+  def ruby_file
+    feature_file_basename = File.basename(@feature_file)
+    File.join "spec", "acceptance", "#{feature_file_basename}.rb"
+  end
+
+  private
+
+  def write_file(file_path, content)
+    open(file_path, 'w') { |f| f << content }
+  end
+
+  def create_unless_exists(path)
+    Dir.mkdir(path) unless Dir.exist?(path)
+  end
+
+end

data/lib/maniok_bdd/gherkin_formatter.rb

@@ -0,0 +1,101 @@
+require 'gherkin/parser/parser'
+
+class ManiokBdd::GherkinFormatter
+
+  def self.build(feature_file)
+    new.tap do |gherkin_formatter|
+      parser = Gherkin::Parser::Parser.new(gherkin_formatter, true)
+      parser.parse(File.read(feature_file), feature_file, 0)
+    end
+  end
+
+  def to_s
+    @feature.to_s
+  end
+
+  def feature(gherkin_model_feature)
+    @feature = Feature.new gherkin_model_feature
+  end
+
+  class Feature
+    attr_reader :scenarios
+
+    def initialize(gherkin_model_feature)
+      @gherkin_model_feature = gherkin_model_feature
+      @scenarios = []
+    end
+
+    def to_s
+      # TODO later
+      #{@gherkin_model_feature.description}
+
+      <<RUBY_FEATURE
+require 'spec_helper'
+
+Feature "#{@gherkin_model_feature.name}" do
+
+#{print_scenarios}
+end
+RUBY_FEATURE
+    end
+
+    def print_scenarios
+      @scenarios.map do |scenario|
+        scenario.to_s
+      end.join("\n")
+    end
+  end
+
+  def scenario(gherkin_model_scenario)
+    @feature.scenarios << (@current_scenario = Scenario.new(gherkin_model_scenario))
+  end
+
+  class Scenario
+    attr_reader :steps
+    def initialize(gherkin_model_scenario)
+      @gherkin_model_scenario = gherkin_model_scenario
+      @steps = []
+    end
+
+    def to_s
+      <<RUBY_SCENARIO
+  Scenario "#{@gherkin_model_scenario.name}" do
+
+#{print_steps}
+  end
+RUBY_SCENARIO
+    end
+
+    def print_steps
+      @steps.map do |step|
+        step.to_s
+      end.join("\n")
+    end
+  end
+
+  def step(gherkin_model_step)
+    @current_scenario.steps << Step.new(gherkin_model_step)
+  end
+
+  class Step
+    def initialize(gherkin_model_step)
+      @gherkin_model_step = gherkin_model_step
+    end
+
+    def to_s
+      <<RUBY_STEP
+    #{@gherkin_model_step.keyword}"#{@gherkin_model_step.name}" do
+
+    end
+RUBY_STEP
+    end
+  end
+
+  # to avoid undefined method `uri' & efo and keep Gherkin parser happy
+  def uri(*)
+  end
+
+  def eof
+  end
+
+end

data/lib/maniok_bdd/rspec/base_formatter.rb

@@ -0,0 +1,17 @@
+module ManiokBdd::RSpec
+  module BaseFormatter
+    def example_step_started(example, type, message, options)
+    end
+
+    def example_step_passed(example, type, message, options)
+    end
+
+    def example_step_pending(example, type, message, options)
+    end
+
+    def example_step_failed(example, type, message, options)
+    end
+  end
+end
+
+RSpec::Core::Formatters::BaseFormatter.send :include, ManiokBdd::RSpec::BaseFormatter

data/lib/maniok_bdd/rspec/documentation_formatter.rb

@@ -0,0 +1,54 @@
+module ManiokBdd::RSpec
+  module DocumentationFormatter
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+
+        alias :example_started_without_steps :example_started
+        alias :example_started :example_started_with_steps
+
+        alias :example_passed_without_steps :example_passed
+        alias :example_passed :example_passed_with_steps
+      end
+    end
+
+    module InstanceMethods
+      def example_started_with_steps(example)
+        example_started_without_steps(example)
+
+        if example.options[:with_steps]
+          full_message = "#{current_indentation}#{example.description}"
+          output.puts white(full_message)
+        end
+      end
+
+      def example_passed_with_steps(example)
+        example_passed_without_steps(example) unless example.options[:with_steps]
+      end
+
+      def example_step_passed(example_group, type, message, options)
+        full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message}"
+        output.puts green(full_message)
+      end
+
+      def example_step_pending(example_group, type, message, options)
+        full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message}"
+
+        if options[:pending] && options[:pending] != true
+          full_message << " (PENDING: #{options[:pending]})"
+        else
+          full_message << " (PENDING)"
+        end
+
+        output.puts yellow(full_message)
+      end
+
+      def example_step_failed(example_group, type, message, options)
+        full_message = "#{current_indentation}  #{type.to_s.capitalize} #{message} (FAILED)"
+        output.puts red(full_message)
+      end
+    end
+  end
+end
+
+RSpec::Core::Formatters::DocumentationFormatter.send :include, ManiokBdd::RSpec::DocumentationFormatter

data/lib/maniok_bdd/rspec/example_group.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module ManiokBdd
+  module RSpec
+    module ExampleGroup
+      def include_steps(*args)
+        name = args.shift
+        shared_block = RSpec.world.shared_example_steps[name]
+        shared_block or raise ArgumentError, "Could not find shared steps #{name.inspect}"
+        instance_eval_with_args(*args, &shared_block)
+      end
+
+      def Given(message, options = {}, &block)
+        Step :given, message, options, &block
+      end
+
+      def When(message, options = {}, &block)
+        Step :when, message, options, &block
+      end
+
+      def Then(message, options = {}, &block)
+        Step :then, message, options, &block
+      end
+
+      def And(message, options = {}, &block)
+        Step :and, message, options, &block
+      end
+
+      def But(message, options = {}, &block)
+        Step :but, message, options, &block
+      end
+
+      private
+
+      def Step(type, message, options = {}, &block)
+        ::RSpec.world.reporter.example_step_started(self, type, message, options)
+        if block_given? && !options[:pending]
+          begin
+            yield block
+          rescue Exception => e
+            ::RSpec.world.reporter.example_step_failed(self, type, message, options)
+            raise e
+          end
+          ::RSpec.world.reporter.example_step_passed(self, type, message, options)
+        else
+          ::RSpec.world.reporter.example_step_pending(self, type, message, options)
+        end
+      end
+
+    end
+  end
+end
+
+RSpec::Core::ExampleGroup.send :include, ManiokBdd::RSpec::ExampleGroup
+RSpec::Core::ExampleGroup.singleton_class.define_example_method :Scenario, :with_steps => true

data/lib/maniok_bdd/rspec/features.rb

@@ -0,0 +1,15 @@
+module ManiokBdd
+  module Features
+    def self.included(base)
+      base.instance_eval do
+        alias :Background :before
+      end
+    end
+  end
+end
+
+def self.Feature(*args, &block)
+  describe(*args, &block)
+end
+
+RSpec.configuration.include ManiokBdd::Features

data/lib/maniok_bdd/rspec/reporter.rb

@@ -0,0 +1,23 @@
+module ManiokBdd
+  module RSpec
+    module Reporter
+      def example_step_started(example, type, message, options)
+        notify :example_step_started, example, type, message, options
+      end
+
+      def example_step_passed(example, type, message, options)
+        notify :example_step_passed, example, type, message, options
+      end
+
+      def example_step_pending(example, type, message, options)
+        notify :example_step_pending, example, type, message, options
+      end
+
+      def example_step_failed(example, type, message, options)
+        notify :example_step_failed, example, type, message, options
+      end
+    end
+  end
+end
+
+RSpec::Core::Reporter.send :include, ManiokBdd::RSpec::Reporter

data/lib/maniok_bdd/rspec/shared_steps.rb

@@ -0,0 +1,22 @@
+module ManiokBdd
+  module RSpec
+    module SharedSteps
+
+      def shared_steps(name, &block)
+        ensure_shared_example_steps_name_not_taken(name)
+        RSpec.world.shared_example_steps[name] = block
+      end
+
+      private
+
+      def ensure_shared_example_steps_name_not_taken(name)
+        if RSpec.world.shared_example_steps.has_key?(name)
+          raise ArgumentError.new("Shared example steps '#{name}' already exists")
+        end
+      end
+
+    end
+  end
+end
+
+include ManiokBdd::RSpec::SharedSteps

data/lib/maniok_bdd/rspec/world.rb

@@ -0,0 +1,11 @@
+module ManiokBdd
+  module RSpec
+    module World
+      def shared_example_steps
+        @shared_example_steps ||= {}
+      end
+    end
+  end
+end
+
+RSpec::Core::World.send :include, ManiokBdd::RSpec::World

data/lib/maniok_bdd/version.rb

@@ -1,3 +1,3 @@
 module ManiokBdd
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/lib/maniok_bdd.rb

@@ -1,4 +1,18 @@
-require "maniok_bdd/version"
+require 'maniok_bdd/version'
 
 module ManiokBdd
 end
+
+require 'rspec/core/formatters/base_formatter'
+require 'rspec/core/formatters/documentation_formatter'
+require "rspec/core/example_group"
+require 'rspec/core/reporter'
+require 'rspec/core/world'
+
+require 'maniok_bdd/rspec/features'
+require 'maniok_bdd/rspec/base_formatter'
+require 'maniok_bdd/rspec/documentation_formatter'
+require 'maniok_bdd/rspec/example_group'
+require 'maniok_bdd/rspec/reporter'
+require 'maniok_bdd/rspec/world'
+require 'maniok_bdd/rspec/shared_steps'

metadata

@@ -2,14 +2,14 @@
 name: maniok_bdd
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Jean-Michel Garnier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: jean-michel@21croissants.com
@@ -18,6 +18,15 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/maniok_bdd/cli.rb
+- lib/maniok_bdd/gherkin_formatter.rb
+- lib/maniok_bdd/rspec/base_formatter.rb
+- lib/maniok_bdd/rspec/documentation_formatter.rb
+- lib/maniok_bdd/rspec/example_group.rb
+- lib/maniok_bdd/rspec/features.rb
+- lib/maniok_bdd/rspec/reporter.rb
+- lib/maniok_bdd/rspec/shared_steps.rb
+- lib/maniok_bdd/rspec/world.rb
 - lib/maniok_bdd/version.rb
 - lib/maniok_bdd.rb
 homepage: http://github.com/21croissants/maniok_bdd
@@ -34,7 +43,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3479588527671171048
+      hash: -2301873164338472506
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
@@ -43,7 +52,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3479588527671171048
+      hash: -2301873164338472506
   none: false
 requirements: []
 rubyforge_project: