mountain_berry_fields-rspec 1.0.0

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
+features/proving_grounds
+.DS_Store

data/.simplecov

@@ -0,0 +1,5 @@
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/features/'
+  add_filter 'formatter.rb' # this gets acceptance tested, not unit tested
+end

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Josh Cheek
+
+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/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+
+task :rspec do
+  require 'rspec'
+  Dir.glob("spec/**/*_spec.rb").each { |filename| require File.expand_path filename }
+  RSpec::Core::Runner.run []
+end
+
+require 'cucumber/rake/task'
+default_cucumber_opts = "features --format pretty --tags ~@not-implemented"
+Cucumber::Rake::Task.new(:cucumber)      { |t| t.cucumber_opts = default_cucumber_opts + " --tags ~@wip" }
+Cucumber::Rake::Task.new('cucumber:wip') { |t| t.cucumber_opts = default_cucumber_opts + " --tags @wip" }
+
+
+task default: [:rspec, :cucumber]
+
+

data/Readme.md

@@ -0,0 +1,7 @@
+# RSpec strategy for Mountain Berry Fields
+
+As this is an official plugin, it is documented as part of the main [MountainBerryFields](https://github.com/JoshCheek/mountain_berry_fields) code.
+
+If you have it installed (`gem install mountain_berry_fields-rspec`), then it will be automatically loaded by MountainBerryFields, no further steps are necessary.
+If you are using Bundler, make sure it is in your Gemfile. If using Rubygems, set it as a development dependency
+([example](https://github.com/JoshCheek/mountain_berry_fields/blob/be751536c8b0f94c84b09167fa83616b94b13b12/mountain_berry_fields.gemspec#L22)).

data/features/step_definitions/steps.rb

@@ -0,0 +1,46 @@
+Given 'the file "$filename":' do |filename, body|
+  in_proving_grounds do
+    ensure_dir File.dirname filename
+    File.write filename, interpret_curlies(body)
+  end
+end
+
+When 'I run "$command"' do |command|
+  in_proving_grounds { cmdline command }
+end
+
+Then /^it exits with a status of (\d+)$/ do |status|
+  last_cmdline.exitstatus.should eq(status.to_i), "Expected #{status}, got #{last_cmdline.exitstatus}. STDERR: #{last_cmdline.stderr}"
+end
+
+Then /^it exits with a status of (\d+), and a stderr of:$/ do |status, stderr|
+  last_cmdline.exitstatus.should == status.to_i
+  last_cmdline.stderr.chomp.should == interpret_curlies(stderr).chomp
+end
+
+Then /^it prints nothing to (stdout|stderr)$/ do |descriptor|
+  last_cmdline.send(descriptor).should == ''
+end
+
+Then 'I see the file "$filename"' do |filename|
+  in_proving_grounds { File.exist?(filename).should be_true }
+end
+
+Then 'I see the file "$filename":' do |filename, body|
+  in_proving_grounds do
+    File.exist?(filename).should be_true, "#{filename} doesn't exist"
+
+    body && strip_trailing_whitespace(File.read(filename)).should ==
+            strip_trailing_whitespace(body)
+  end
+end
+
+Then 'I do not see the file "$filename"' do |filename|
+  in_proving_grounds { File.exist?(filename).should be_false }
+end
+
+And 'I pry' do
+  require 'pry'
+  binding.pry
+end
+

data/features/support/env.rb

@@ -0,0 +1,73 @@
+require 'fileutils'
+module ProvingGrounds
+  def proving_grounds_dir
+    File.expand_path "../../proving_grounds", __FILE__
+  end
+
+  def in_proving_grounds(&block)
+    make_proving_grounds
+    FileUtils.cd(proving_grounds_dir) { return block.call }
+  end
+
+  def make_proving_grounds
+    FileUtils.mkdir_p proving_grounds_dir
+  end
+
+  def remove_proving_grounds
+    FileUtils.rm_r proving_grounds_dir
+  end
+
+  def ensure_dir(dirname)
+    FileUtils.mkdir_p dirname
+  end
+end
+
+
+module Helpers
+  def interpret_curlies(string)
+    string.gsub /{{.*?}}/ do |code|
+      code.sub! /^{{/, ''
+      code.sub! /}}$/, ''
+      eval code
+    end
+  end
+
+  def strip_trailing_whitespace(text)
+    text.gsub /\s+$/, ''
+  end
+end
+
+require 'open3'
+class CommandLine
+  module CukeHelpers
+    def cmdline(command, options={})
+      @last_cmdline = CommandLine.new(command, options)
+      @last_cmdline.execute
+      @last_cmdline
+    end
+
+    def last_cmdline
+      @last_cmdline
+    end
+  end
+
+  attr_reader :command, :options, :stderr, :stdout
+
+  def initialize(command, options={})
+    @command, @options = command, options
+  end
+
+  def execute
+    @stdout, @stderr, @status = Open3.capture3(command, @options)
+  end
+
+  def exitstatus
+    @status.exitstatus
+  end
+end
+
+ENV['RUBYLIB'] = "#{File.expand_path "../../../bin", __FILE__}:#{ENV['RUBYLIB']}"
+World ProvingGrounds
+World CommandLine::CukeHelpers
+World Helpers
+After { remove_proving_grounds }

data/features/test_with_rspec.feature

@@ -0,0 +1,88 @@
+Feature: Testing with :rspec
+
+  Scenario: Passing RSpec
+    Given the file "Readme.mountain_berry_fields.md":
+    """
+    # Whatever
+
+
+        <% test 'My RSpec example', with: :rspec do %>
+        describe 'an example' do
+          it('passes') { true.should be_true }
+        end
+        <% end %>
+
+    ya see?
+    """
+    When I run "mountain_berry_fields Readme.mountain_berry_fields.md"
+    Then it prints nothing to stdout
+    And it prints nothing to stderr
+    And it exits with a status of 0
+    And I see the file "Readme.md":
+    """
+    # Whatever
+
+
+        describe 'an example' do
+          it('passes') { true.should be_true }
+        end
+
+    ya see?
+    """
+
+  Scenario: Failing RSpec
+    Given the file "Readme.mountain_berry_fields.md":
+    """
+    # Whatever
+
+
+        <% test 'My RSpec example', with: :rspec do %>
+        describe 'an example' do
+          it('fails 1') { true.should be_false, 'failure message 1' }
+          it('fails 2') { true.should be_false, 'failure message 2' }
+        end
+        <% end %>
+
+    ya see?
+    """
+    When I run "mountain_berry_fields Readme.mountain_berry_fields.md"
+    Then it exits with a status of 1, and a stderr of:
+    """
+    FAILURE: My RSpec example
+    an example fails 1:
+      failure message 1
+
+    backtrace:
+      /spec.rb:2:in `block (2 levels) in <top (required)>'
+    """
+    And I do not see the file "Readme.md"
+
+
+  Scenario: Invalid example
+    Given the file "Readme.mountain_berry_fields.md":
+    """
+    # Whatever
+
+
+        <% test 'My RSpec example', with: :rspec do %>
+        describe 'an example' do
+          it('is invalid syntax') { }}}}
+        end
+        <% end %>
+
+    ya see?
+    """
+    When I run "mountain_berry_fields Readme.mountain_berry_fields.md"
+    Then it exits with a status of 1, and a stderr of:
+    """
+    FAILURE: My RSpec example
+    -:2: syntax error, unexpected '}', expecting keyword_end
+          it('is invalid syntax') { }}}}
+                                      ^
+
+    original file:
+        describe 'an example' do
+          it('is invalid syntax') { }}}}
+        end
+    """
+    And I do not see the file "Readme.md"

data/lib/mountain_berry_fields/test/rspec.rb

@@ -0,0 +1,77 @@
+require 'open3'
+require 'json'
+require 'tmpdir'
+
+class MountainBerryFields
+  class Test
+
+    class RSpec
+      Deject self
+      dependency(:file_class)           { File              }
+      dependency(:dir_class)            { Dir               }
+      dependency(:open3_class)          { Open3             }
+      dependency(:syntax_checker_class) { RubySyntaxChecker }
+
+      def syntax_checker
+        @syntax_checker ||= syntax_checker_class.new code_to_test
+      end
+
+      Strategy.register :rspec, self
+
+      include Strategy
+
+      def pass?
+        @passed ||= syntax_checker.valid? && begin
+          dir_class.mktmpdir 'mountain_berry_fields_rspec' do |dir|
+            @tempdir_name = dir
+            file_class.write "#{dir}/spec.rb", @code_to_test
+            @output, @error, status = open3_class.capture3 "rspec '#{dir}/spec.rb' " \
+                                                           "-r '#{formatter_filename}' " \
+                                                           "-f MountainBerryFields::Test::RSpec::Formatter " \
+                                                           "--fail-fast"
+            status.success?
+          end
+        end
+        @passed
+      end
+
+      def syntax_error_message
+        return if syntax_checker.valid?
+        syntax_checker.invalid_message
+      end
+
+      def failure_message
+        syntax_error_message ||
+          "#{spec_failure_description.chomp}:\n"      \
+          "  #{spec_failure_message.chomp}\n"         \
+          "\n"                                        \
+          "backtrace:\n"                              \
+          "  #{spec_failure_backtrace.join "\n  "}\n"
+      end
+
+      private
+
+      def spec_failure_description
+        result['full_description']
+      end
+
+      def spec_failure_message
+        result['message']
+      end
+
+      def spec_failure_backtrace
+        result['backtrace'].map { |line| line.gsub @tempdir_name, '' }
+      end
+
+      def result
+        @result ||= JSON.parse @output
+      end
+
+      def formatter_filename
+        File.expand_path "../rspec_formatter.rb", __FILE__
+      end
+    end
+  end
+end
+
+

data/lib/mountain_berry_fields/test/rspec_formatter.rb

@@ -0,0 +1,16 @@
+require 'rspec/core/formatters/base_formatter'
+require 'json'
+
+class MountainBerryFields
+  class Test
+    class RSpec
+      class Formatter < ::RSpec::Core::Formatters::BaseFormatter
+        def example_failed(example)
+          print JSON.dump 'full_description' => example.full_description,
+                          'message'          => example.exception.message,
+                          'backtrace'        => format_backtrace(example.exception.backtrace, example)
+        end
+      end
+    end
+  end
+end

data/mountain_berry_fields-rspec.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Josh Cheek"]
+  gem.email         = ["josh.cheek@gmail.com"]
+  gem.description   = %q{When testing embedded code examples with MountainBerryFields, you may wish to use RSpec. This enables that integration}
+  gem.summary       = %q{MountainBerryFields strategy for RSpec}
+  gem.homepage      = "https://github.com/JoshCheek/mountain_berry_fields-rspec"
+
+  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.name          = "mountain_berry_fields-rspec"
+  gem.require_paths = ["lib"]
+  gem.version       = '1.0.0'
+
+  gem.add_runtime_dependency     'deject',                '~> 0.2.2'
+  gem.add_development_dependency 'rspec',                 '~> 2.10.0' # this might be overly strict, maybe do research and see how far back we can go
+
+  gem.add_development_dependency 'mountain_berry_fields', '~> 1.0.0'
+  gem.add_development_dependency 'surrogate',             '~> 0.5.1'
+  gem.add_development_dependency 'cucumber',              '~> 1.2.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+require 'surrogate/rspec'
+require 'mountain_berry_fields'
+require 'mountain_berry_fields/test/rspec'
+
+RSpec::Matchers.define :pass do
+  match { |matcher| matcher.pass? }
+end
+
+module Mock
+  class SyntaxChecker
+    Surrogate.endow self
+    define(:initialize) { |syntax| }
+    define(:valid?) { true }
+    define(:invalid_message) { "shit ain't valid" }
+  end
+
+  class Dir
+    Surrogate.endow self do
+      define(:chdir)    { |dir,    &block| block.call }
+      define(:mktmpdir) { |prefix, &block| block.call }
+    end
+  end
+
+  class File
+    Surrogate.endow self do
+      define(:exist?) { true }
+      define(:write)  { true }
+      define(:read)   { "file contents" }
+    end
+  end
+
+  class Open3
+    Surrogate.endow self do
+      define(:capture3) { |invocation| ["stdout", "stderr", @exitstatus||Process::Status.new] }
+    end
+
+
+    def self.exit_with_failure!
+      @exitstatus = Process::Status.new.will_have_success? false
+      self
+    end
+
+    def self.exit_with_success!
+      @exitstatus = Process::Status.new.will_have_success? true
+      self
+    end
+  end
+
+  module Process
+    class Status
+      Surrogate.endow self
+      define(:success?) { true }
+    end
+  end
+end
+
+MountainBerryFields::Test::RSpec.override(:syntax_checker_class) { Mock::SyntaxChecker }

data/spec/test/rspec_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe MountainBerryFields::Test::RSpec do
+  it 'is registered it the strategy list under :rspec' do
+    MountainBerryFields::Test::Strategy.for(:rspec).should == described_class
+  end
+
+  let(:passing_spec) { <<-EOF.gsub /^ {4}/, '' }
+    describe 'an example' do
+      it('passes') { true.should be_true }
+    end
+  EOF
+
+  let(:failing_spec) { <<-EOF.gsub /^ {4}/, '' }
+    describe 'an example' do
+      it('fails') { true.should be_false, 'the message' }
+    end
+  EOF
+
+  let(:spec_with_two_failures) { <<-EOF.gsub /^ {4}/, '' }
+    describe 'an example' do
+      it('fails 1') { true.should be_false, 'failure message 1' }
+      it('fails 2') { true.should be_false, 'failure message 2' }
+    end
+  EOF
+
+  let(:file_class)  { Mock::File.clone }
+  let(:dir_class)   { Mock::Dir.clone }
+  let(:open3_class) { Mock::Open3.clone }
+  let(:the_spec)    { passing_spec }
+
+  it 'checks input syntax first' do
+    rspec = described_class.new the_spec
+    syntax_checker = rspec.syntax_checker
+    syntax_checker.was initialized_with the_spec
+    syntax_checker.will_have_valid? false  # rename to valid_syntax
+    syntax_checker.will_have_invalid_message "you call that code?"
+    rspec.should_not pass
+    rspec.failure_message.should == "you call that code?"
+  end
+
+  it 'writes the file to a temp dir' do
+    rspec = described_class.new(the_spec).with_dependencies(dir_class: dir_class, file_class: file_class, open3_class: open3_class)
+    dir_class.will_mktmpdir true
+    rspec.pass?
+    rspec.dir_class.was told_to(:mktmpdir).with('mountain_berry_fields_rspec') { |block|
+      block.call_with '/temp_dir'
+      block.before { file_class.was_not told_to :write }
+      block.after  { file_class.was     told_to(:write).with("/temp_dir/spec.rb", the_spec) }
+    }
+  end
+
+  it 'invokes rspec against the temp dir' do
+    rspec = described_class.new(the_spec).with_dependencies(dir_class: dir_class, file_class: file_class, open3_class: open3_class)
+    dir_class.will_mktmpdir true
+    rspec.pass?
+    rspec.dir_class.was told_to(:mktmpdir).with('mountain_berry_fields_rspec') { |block|
+      block.call_with '/temp_dir'
+      block.before { open3_class.was_not told_to :capture3 }
+      block.after  { open3_class.was     told_to :capture3 } # not testing string directly, will let cukes verify it comes out right
+    }
+  end
+
+  it 'passes when rspec executes successfully' do
+    open3_class = Mock::Open3.clone.exit_with_success!
+    rspec = described_class.new(the_spec).with_dependencies(dir_class: dir_class, file_class: file_class, open3_class: open3_class)
+    rspec.should pass
+
+    open3_class = Mock::Open3.clone.exit_with_failure!
+    rspec = described_class.new(the_spec).with_dependencies(dir_class: dir_class, file_class: file_class, open3_class: open3_class)
+    rspec.should_not pass
+  end
+
+  it 'pulls its failure message from the JSON output of the results, showing the description, message, and backtrace without the temp dir' do
+    temp_dir = 'some_temp_dir'
+    open3_class.will_capture3 [%'{"full_description":"THE DESCRIPTION","message":"THE MESSAGE","backtrace":["#{temp_dir}/THE BACKTRACE"]}', '', Mock::Process::Status.new]
+    rspec = described_class.new(the_spec).with_dependencies(dir_class: dir_class, file_class: file_class, open3_class: open3_class)
+    rspec.pass?
+    dir_class.was told_to(:mktmpdir).with(anything) { |block| block.call_with temp_dir }
+    rspec.failure_message.should include 'THE DESCRIPTION'
+    rspec.failure_message.should include 'THE MESSAGE'
+    rspec.failure_message.should include 'THE BACKTRACE'
+  end
+end
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: mountain_berry_fields-rspec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Josh Cheek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deject
+  requirement: &70101747405880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70101747405880
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70101747403840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70101747403840
+- !ruby/object:Gem::Dependency
+  name: mountain_berry_fields
+  requirement: &70101747402400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70101747402400
+- !ruby/object:Gem::Dependency
+  name: surrogate
+  requirement: &70101747417580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *70101747417580
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70101747416660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70101747416660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70101747415900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101747415900
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70101747414980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70101747414980
+description: When testing embedded code examples with MountainBerryFields, you may
+  wish to use RSpec. This enables that integration
+email:
+- josh.cheek@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .simplecov
+- Gemfile
+- LICENSE
+- Rakefile
+- Readme.md
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/test_with_rspec.feature
+- lib/mountain_berry_fields/test/rspec.rb
+- lib/mountain_berry_fields/test/rspec_formatter.rb
+- mountain_berry_fields-rspec.gemspec
+- spec/spec_helper.rb
+- spec/test/rspec_spec.rb
+homepage: https://github.com/JoshCheek/mountain_berry_fields-rspec
+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.17
+signing_key: 
+specification_version: 3
+summary: MountainBerryFields strategy for RSpec
+test_files:
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/test_with_rspec.feature
+- spec/spec_helper.rb
+- spec/test/rspec_spec.rb