mountain_berry_fields-magic_comments 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,18 @@
+#!/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 @@
+# Magic Comments 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-magic_comments`), 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#L21)).

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 "../../../lib", __FILE__
+World ProvingGrounds
+World CommandLine::CukeHelpers
+World Helpers
+After { remove_proving_grounds }

data/features/test_with_magic_comments.feature

@@ -0,0 +1,69 @@
+Feature: Testing with :magic_comments
+
+  Scenario: Passing magic comments
+    Given the file "Readme.mountain_berry_fields.md":
+    """
+    # Whatever
+
+        <% test 'basic addition', with: :magic_comments do %>
+        1 + 1 # => 2
+        <% end %>
+
+    More shit here
+    """
+    When I run "mountain_berry_fields Readme.mountain_berry_fields.md"
+    Then it exits with a status of 0
+    And I see the file "Readme.md":
+    """
+    # Whatever
+
+        1 + 1 # => 2
+
+    More shit here
+    """
+
+
+  Scenario: Failing magic comments
+    Given the file "Readme.mountain_berry_fields.md":
+    """
+    # Whatever
+
+        <% test 'basic addition', with: :magic_comments do %>
+        1 + 2 # => 12
+        <% end %>
+
+    More shit here
+    """
+    When I run "mountain_berry_fields Readme.mountain_berry_fields.md"
+    Then it exits with a status of 1, and a stderr of:
+    """
+    FAILURE: basic addition
+    Expected: 1 + 2 # => 12
+    Actual:   1 + 2 # => 3
+    """
+    And I do not see the file "Readme.md"
+
+
+  Scenario: Invalid example
+    Given the file "Readme.mountain_berry_fields.md":
+    """
+    # Whatever
+
+        <% test 'basic addition', with: :magic_comments do %>
+        } + { # => 12
+        <% end %>
+
+    More shit here
+    """
+    When I run "mountain_berry_fields Readme.mountain_berry_fields.md"
+    Then it exits with a status of 1, and a stderr of:
+    """
+    FAILURE: basic addition
+    -:1: syntax error, unexpected '}'
+        } + { # => 12
+         ^
+
+    original file:
+        } + { # => 12
+    """
+    And I do not see the file "Readme.md"

data/lib/mountain_berry_fields/test/magic_comments.rb

@@ -0,0 +1,99 @@
+require 'rcodetools/xmpfilter'
+require 'mountain_berry_fields'
+
+class MountainBerryFields
+  class Test
+
+    # test strategy for magic comments:
+    #
+    # 1 + 2 # => 3
+    #
+    # Like that, but if the output isn't 3, then this will fail your test
+    class MagicComments
+
+      Strategy.register :magic_comments, self
+      include Strategy
+
+      Deject self
+      dependency(:syntax_checker_class) { RubySyntaxChecker }
+
+      def syntax_checker
+        @syntax_checker ||= syntax_checker_class.new code_to_test
+      end
+
+      def result
+        @result ||= Rcodetools::XMPFilter.run(
+          code_to_test,
+          :interpreter => "ruby",
+          :options => [],
+          :min_codeline_size => 50,
+          :libs => [],
+          :evals => [],
+          :include_paths => [],
+          :dump => nil,
+          :wd => nil,
+          :warnings => false,
+          :use_parentheses => true,
+          :column => nil,
+          :output_stdout => true,
+          :test_script => nil,
+          :test_method => nil,
+          :detect_rct_fork => false,
+          :use_rbtest => false,
+          :detect_rbtest => false,
+          :execute_ruby_tmpfile => false
+        ).join
+      end
+
+      def syntax_error_message
+        return if syntax_checker.valid?
+        syntax_checker.invalid_message
+      end
+
+      def pass?
+        each_line_pair do |expected_line, actual_line|
+          return false unless normalize(expected_line) == normalize(actual_line)
+        end
+        true
+      end
+
+      def failure_message
+        syntax_error_message ||
+          each_line_pair do |expected_line, actual_line|
+            next if lines_match? expected_line, actual_line
+            return "Output had extra line: #{actual_line}\n" unless expected_line
+            return "Input had extra line: #{expected_line}\n" unless actual_line
+            return "Expected: #{expected_line.gsub /^\s+/, ''}\nActual:   #{actual_line.lstrip.gsub /^\s+/, ''}\n" if expected_line != actual_line
+          end
+      end
+
+      def lines_match?(line1, line2)
+        normalize(line1) == normalize(line2)
+      end
+
+      def normalize(line)
+        return unless line
+        line.gsub!(/(#<\w+?):(0x[0-9a-f]+)/, '\1')         # replace anonymous instances
+        line.gsub!(/#<(#<Class>):(0x[0-9a-f]+)>/, '#<\1>') # replace anonymous instances of anonymous classes end
+        line
+      end
+
+      def each_line_pair
+        result_lines = lines result
+        code_to_test_lines = lines code_to_test
+
+        while result_lines.any? || code_to_test_lines.any?
+          yield chomp_or_nil(code_to_test_lines.shift), chomp_or_nil(result_lines.shift)
+        end
+      end
+
+      def lines string
+        string.lines.to_a
+      end
+
+      def chomp_or_nil value
+        value && value.chomp
+      end
+    end
+  end
+end

data/mountain_berry_fields-magic_comments.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Josh Cheek"]
+  gem.email         = ["josh.cheek@gmail.com"]
+  gem.description   = %q{Test code samples embedded in files like readmes}
+  gem.summary       = %q{Test code samples embedded in files like readmes}
+  gem.homepage      = "https://github.com/JoshCheek/mountain_berry_fields-magic_comments"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |file| File.basename file }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mountain_berry_fields-magic_comments"
+  gem.require_paths = ["lib"]
+  gem.version       = '1.0.0'
+
+  gem.add_runtime_dependency 'rcodetools',                '~> 0.8.5.0'
+  gem.add_runtime_dependency 'deject',                    '~> 0.2.2'
+
+  gem.add_development_dependency 'mountain_berry_fields', '~> 1.0.0'
+  gem.add_development_dependency 'surrogate',             '~> 0.5.1'
+  gem.add_development_dependency 'rspec',                 '~> 2.10.0'
+  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,19 @@
+require 'surrogate/rspec'
+require 'mountain_berry_fields'
+require 'mountain_berry_fields/test/magic_comments.rb'
+
+
+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
+end
+
+MountainBerryFields::Test::MagicComments.override(:syntax_checker_class) { Mock::SyntaxChecker }

data/spec/test/magic_comments_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+test_class = MountainBerryFields::Test
+
+describe test_class::MagicComments do
+  it 'is registered it the strategy list under :magic_comments' do
+    test_class::Strategy.for(:magic_comments).should == described_class
+  end
+
+  specify '#pass? returns true if the output is the same as the input' do
+    described_class.new('1 + 1 # => 2').should pass
+    described_class.new('1 + 2 # => 2').should_not pass
+    described_class.new("a=1\nb=2\na+b # => 3").should pass
+  end
+
+  it 'ignores warnings in the output' do
+    described_class.new("1").should pass
+  end
+
+  it 'ignores differences that look like object inspections' do
+    described_class.new("Object.new # => #<Object:0x007f9ef108b578>").should pass
+    described_class.new("Object.new # => #<NotObject:0x007f9ef108b578>").should_not pass
+    described_class.new("Class.new.new # => #<#<Class:0x007fc6d388b548>:0x007fc6d388b4f8>").should pass
+  end
+
+  describe '#failure_message' do
+    it "provides Ruby's syntax message if the syntax is not valid" do
+      magic_comments = described_class.new '}'
+      syntax_checker = magic_comments.syntax_checker
+      syntax_checker.was initialized_with '}'
+      syntax_checker.will_have_valid? false  # should surrogate provide: will_be_valid? ?
+      syntax_checker.will_have_invalid_message "} ain't no kinda valid"
+      magic_comments.should_not pass
+      magic_comments.failure_message.should == "} ain't no kinda valid"
+    end
+
+    it 'identifies the first output line that differs from the input' do
+      magic_comments = described_class.new <<-CODE.gsub(/^\s*/, '')
+        1 + 2     # => 3
+        "a" + "b" # => "ba"
+        5 + 6     # => 345678
+      CODE
+      magic_comments.pass?
+      magic_comments.failure_message.should == %Q(Expected: "a" + "b" # => "ba"\n) +
+                                               %Q(Actual:   "a" + "b" # => "ab"\n)
+    end
+
+    it 'strips leading white spaces off of failures' do
+      magic_comments = described_class.new("    \t\t   1 + 1 # => 4")
+      magic_comments.pass?
+      magic_comments.failure_message.should == %Q(Expected: 1 + 1 # => 4\n) +
+                                               %Q(Actual:   1 + 1 # => 2\n)
+    end
+
+    it 'identifies missing output' do
+      magic_comments = described_class.new("puts 1\nputs 2\n")
+      magic_comments.pass?
+      magic_comments.failure_message.should == "Output had extra line: # >> 1\n"
+    end
+
+    it 'identifies missing input' do
+      magic_comments = described_class.new("puts 1\n# >> 1\n# >> 2\n")
+      magic_comments.pass?
+      magic_comments.failure_message.should == "Input had extra line: # >> 2\n"
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: mountain_berry_fields-magic_comments
+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: rcodetools
+  requirement: &70125641193040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70125641193040
+- !ruby/object:Gem::Dependency
+  name: deject
+  requirement: &70125641192560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70125641192560
+- !ruby/object:Gem::Dependency
+  name: mountain_berry_fields
+  requirement: &70125641192080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70125641192080
+- !ruby/object:Gem::Dependency
+  name: surrogate
+  requirement: &70125641191620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *70125641191620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70125641191160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70125641191160
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70125641190700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70125641190700
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70125641190320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70125641190320
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &70125641189860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70125641189860
+description: Test code samples embedded in files like readmes
+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_magic_comments.feature
+- lib/mountain_berry_fields/test/magic_comments.rb
+- mountain_berry_fields-magic_comments.gemspec
+- spec/spec_helper.rb
+- spec/test/magic_comments_spec.rb
+homepage: https://github.com/JoshCheek/mountain_berry_fields-magic_comments
+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.11
+signing_key: 
+specification_version: 3
+summary: Test code samples embedded in files like readmes
+test_files:
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- features/test_with_magic_comments.feature
+- spec/spec_helper.rb
+- spec/test/magic_comments_spec.rb
+has_rdoc: