rspec_editor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8b6316137788bc95666da4a037b8f58f39ffc0a
+  data.tar.gz: 7222d4f778a0befe47c637b0f20ed2c29e1c3add
+SHA512:
+  metadata.gz: 68b8b77cbf73ab9cab54aabba4437ec864de08387654414b4c1e7a5d4a9928dc1f9184680b4fdbb64d88aa448b90c8bf52df633c9ff51ce540092ec654f0ad1f
+  data.tar.gz: bfc5ac54818e9d3ce5881bc37cff4d456131a19d8a8570d88d5a7b9d68f7e6e6583b0e5279e45c08a85346502568452ab587ce4c58a2a79b0982874f25d204d4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.rspec.error.log
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec_editor.gemspec
+# gemspec
+
+group :development do
+  gem "pry", "~> 0.9"
+  gem "pry-debugger", "~> 0.2"
+  gem "rake", "~> 10.2"
+  gem "awesome_print", "~> 1.2"
+  gem "rspec", "~> 3.1"
+  gem "guard", "~> 2.6"
+  gem "guard-rspec", "~> 4.2"
+  gem "simplecov", "~> 0.9"
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+guard 'rspec', cmd: 'bundle exec rspec --require rspec_editor -f d --format RspecEditor::Formatter' do
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/.*_spec.rb$})
+  watch(%r{spec_helper\.rb$})   { "spec" }
+  watch(%r{^spec/rspec\d+/.*_spec_example.rb$}) { "spec/rspec_spec.rb" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kurt Stephens
+
+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,38 @@
+# RspecEditor
+
+RSpec 2 and 3 Formatter that interfaces with your editor: emacs, vim,
+etc.
+
+Writes a file that can be interpreted as `grep -n` output.
+Then invokes your editor.
+Works well with emacs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_editor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec_editor
+
+## Usage
+
+   $ export RSPEC_EDITOR=emacsclient
+   $ export RSPEC_EDITOR_OUT=rspec.errors.log
+   $ rspec -require rspec_editor -f d -f RspecEditor::Formatter
+
+## Contributing
+
+1. Fork it ( https://github.com/kstephens/rspec_editor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+desc 'Run specs.'
+task :spec do
+  sh %q[COVERAGE=1 bundle exec rspec]
+end
+

data/lib/rspec_editor/editor.rb

@@ -0,0 +1,119 @@
+require 'rspec_editor'
+
+module RspecEditor
+  class Editor
+    attr_accessor :editor, :output_file
+
+    def check_enabled!
+      unless enabled?
+        log "set $RSPEC_EDITOR to enable."
+      end
+      self
+    end
+
+    def enabled?
+      ! ! editor
+    end
+
+    def editor
+      @editor ||= ENV['RSPEC_EDITOR']
+    end
+
+    def output_file
+      @output_file ||= ENV['RSPEC_EDITOR_OUT'] || '.rspec.error.log'
+    end
+
+    def current_directory
+      @current_directory ||= Dir.pwd
+    end
+
+    def open
+      return if @out
+      @log_already_exists = File.exist?(output_file)
+      @out = File.open(@tmp_file = "#{output_file}.tmp", "w")
+      puts "-*- mode: grep; mode: auto-revert; default-directory: \"#{current_directory}/\" -*-"
+      puts ""
+    end
+
+    def close *args
+      return self unless @out
+      @out.close rescue nil
+      @out = nil
+      File.rename(@tmp_file, output_file)
+      if @log_already_exists
+        log "# Refresh #{output_file} in your editor."
+      else
+        editor! output_file
+      end
+      self
+    ensure
+      @out = @log_already_exists = nil
+    end
+
+    def puts msg
+      @out.puts msg
+    end
+
+    def open_example! location
+      if location.to_s =~ /^([^:]+)(:(\d+))?$/
+        file, line = $1, $3
+        editor! file, line
+      else
+        raise ArgumentError, "Invalid location"
+      end
+    end
+
+    def editor! file, line = nil
+      cmd = editor_cmd(file, line)
+      log "Using editor: #{cmd}"
+      begin
+        system! cmd if cmd
+      rescue
+        $stderr.puts "  #{self}: ERROR: #{cmd}: #{$!.inspect}"
+      end
+    end
+
+    def editor_cmd file, line = nil
+      file = File.expand_path(file)
+      line = nil if line && line.empty?
+      editor = self.editor
+      case editor
+      when ""
+        cmd = nil
+      when /emacs/
+        line &&= "+#{line}"
+        unless File.exist?(editor)
+          editor = emacsclient
+        end
+        cmd = "#{editor} -q -n #{line} #{file}"
+      when /vi/
+        line &&= "+#{line}"
+        cmd = "#{editor} --remote #{line} #{file}"
+      else
+        line &&= "--line #{line}"
+        cmd = "#{editor} #{line} #{file}"
+      end
+      cmd
+    end
+
+    def system! cmd
+      Process.fork do
+        system(cmd)
+      end
+    end
+
+    def log msg
+      $stderr.puts "  #{self.class}: #{msg}"
+    end
+
+    def emacsclient
+      @emacsclient ||=
+      [
+        '/Applications/Aquamacs.app/Contents/MacOS/bin/emacsclient',
+        '/opt/local/bin/emacsclient',
+        '/usr/bin/emacsclient',
+      ].find{|f| File.executable? f} || 'emacsclient'
+    end
+  end
+end
+

data/lib/rspec_editor/formatter.rb

@@ -0,0 +1,14 @@
+require 'rspec/version'
+
+module RspecEditor
+  case RSpec::Version::STRING
+  when /^2\./
+    require 'rspec_editor/rspec2/formatter'
+    Formatter = Rspec2::Formatter
+  when /^3\./
+    require 'rspec_editor/rspec3/formatter'
+    Formatter = Rspec3::Formatter
+  else
+    raise "#{self}: RSpec VERSION #{RSpec::Version::STRING} is unsupported"
+  end
+end

data/lib/rspec_editor/rspec2/formatter.rb

@@ -0,0 +1,55 @@
+require "rspec/core/formatters/base_formatter"
+
+module RspecEditor
+module Rspec2
+  class Formatter < RSpec::Core::Formatters::BaseFormatter
+    def initialize *args, &blk
+      @editor = Editor.new
+      @editor.check_enabled!
+      super
+    end
+
+    def start_dump
+      result = super
+      if editor.enabled?
+        begin
+          editor.open
+          process_examples!
+          result
+        ensure
+          editor.close
+        end
+      end
+      result
+    end
+
+    private
+
+    attr_reader :editor
+
+    def process_examples!
+      failed_examples.each do | example |
+        write_example! example, editor
+      end
+    end
+
+    def write_example! example, editor
+      location = example.location
+      # location = File.expand_path(location)
+      editor.puts "#{location}: # #{example.full_description}"
+
+      exc = example.execution_result[:exception]
+      exc_desc = exc.inspect.gsub(/\n/, ' ')
+      editor.puts "#{location}: # #{exc_desc}"
+
+      i = 0
+      format_backtrace(exc.backtrace, example).each do |backtrace_info|
+        # backtrace_info = File.expand_path(backtrace_info)
+        editor.puts "%70s # %d" % [ backtrace_info.to_s, i += 1 ]
+      end
+
+      editor.puts ""
+    end
+  end
+end
+end

data/lib/rspec_editor/rspec3/formatter.rb

@@ -0,0 +1,56 @@
+require "rspec/core/formatters/base_text_formatter"
+
+module RspecEditor
+module Rspec3
+  class Formatter < RSpec::Core::Formatters::BaseTextFormatter
+    RSpec::Core::Formatters.register self, :open, :example_failed, :close
+
+    def initialize *args
+      super(nil)
+      @editor = Editor.new
+      @editor.check_enabled!
+    end
+    attr_reader :failed_examples
+
+    def open *args
+      if @editor.enabled?
+        @editor.open
+      end
+    end
+
+    def example_failed failure
+      return unless @editor.enabled?
+      @editor.open
+
+      example = failure.example
+      # location = File.expand_path(location)
+      location = example.location
+      editor.puts "#{location}: # #{example.full_description}"
+
+      exc = example.execution_result.exception
+      exc_desc = exc.inspect.gsub(/\n/, ' ')
+      editor.puts "#{location}: # #{exc_desc}"
+
+      i = 0
+      exc.backtrace.each do | bt |
+        bt = bt.to_s
+        next if bt =~ %r{/lib/rspec/core/}
+        break if bt =~ %r{/(?:bin|exe)/rspec:}
+        # next if bt =~ %r{/bin/rspec:}
+        # backtrace_info = File.expand_path(backtrace_info)
+        editor.puts "%70s # %d" % [ bt, i += 1 ]
+      end
+
+      editor.puts ""
+    end
+
+    def close *args
+      editor.close
+    end
+
+    private
+
+    attr_reader :editor
+  end
+end
+end

data/lib/rspec_editor/version.rb

@@ -0,0 +1,3 @@
+module RspecEditor
+  VERSION = "0.1.0"
+end

data/lib/rspec_editor.rb

@@ -0,0 +1,9 @@
+require "rspec_editor/version"
+
+module RspecEditor
+  def self.root_dir
+    File.expand_path('../../', __FILE__)
+  end
+end
+require 'rspec_editor/editor'
+require 'rspec_editor/formatter'

data/rspec_editor.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_editor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec_editor"
+  spec.version       = RspecEditor::VERSION
+  spec.authors       = ["Kurt Stephens"]
+  spec.email         = ["ks.github@kurtstephens.com"]
+  spec.summary       = %q{RSpec Formatter that interfaces with your editor.}
+  spec.description   = %q{RSpec Formatter that interfaces with your editor.}
+  spec.homepage      = "https://github.com/kstephens/rspec_editor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "guard", "~> 2.6"
+  spec.add_development_dependency "guard-rspec", "~> 4.2"
+  spec.add_development_dependency "simplecov", "~> 0.9"
+end

data/spec/lib/rspec_editor/editor_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'rspec_editor/editor'
+
+module RspecEditor
+  class Editor
+    RSpec.describe Editor do
+      subject do
+        obj = Editor.new
+        obj.editor = editor
+        obj.output_file = output_file
+        def obj.system! cmd ; @system = cmd ; end
+        def obj.system ; @system ; end
+        obj
+      end
+      let(:output_file) { "tmp/test.#{$$}.log" }
+      after { File.unlink(output_file) rescue nil }
+      let(:output_file_content) { File.read(output_file) }
+
+      context "editor = emacs" do
+        let(:editor) { "emacs" }
+        it "writes an output file" do
+          subject.open
+          subject.puts "FOO"
+          subject.close
+
+          expect(output_file_content) .to include("-*- mode: grep")
+          expect(output_file_content) .to include("FOO")
+          expect(subject.system) .to match(%r{/emacsclient -q -n })
+        end
+      end
+
+      context "editor = vim" do
+        let(:editor) { "vim" }
+        it "writes an output file" do
+          subject.open
+          subject.puts "FOO"
+          subject.close
+
+          expect(output_file_content) .to include("-*- mode: grep")
+          expect(output_file_content) .to include("FOO")
+          expect(subject.system) .to match(%r{vim --remote })
+        end
+      end
+    end
+  end
+end

data/spec/rspec2/rspec2_spec_example.rb

@@ -0,0 +1,5 @@
+describe "RSpec 2" do
+  it "logs a failure" do
+    1 .should == 2
+  end
+end

data/spec/rspec3/rspec3_spec_example.rb

@@ -0,0 +1,5 @@
+RSpec.describe "RSpec 3" do
+  it "logs a failure" do
+    expect(1) .to eq 2
+  end
+end

data/spec/rspec_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'rspec_editor'
+
+RSpec.describe RspecEditor do
+  let(:output) { "tmp/test.#{$$}.log" }
+  let(:output_content) { File.read(output) }
+  after { File.unlink(output) rescue nil }
+
+  context "RSpec 2" do
+    let(:version) { '~> 2.99' }
+    let(:spec) { 'spec/rspec2/rspec2_spec_example.rb' }
+    it "should write to output file" do
+      run_rspec!
+      validate_output!
+    end
+  end
+
+  context "RSpec 3" do
+    let(:version) { '~> 3.0' }
+    let(:spec) { 'spec/rspec3/rspec3_spec_example.rb' }
+    it "should write to output file" do
+      run_rspec!
+      validate_output!
+    end
+  end
+
+  def validate_output!
+    expect(output_content) .to match(/mode: grep;/m)
+    expect(output_content) .to match(/mode: auto-revert;/m)
+    expect(output_content) .to match(/default-directory: /m)
+    expect(output_content) .to match(/_spec_example.rb:\d+: # RSpec \d logs a failure/m)
+  end
+
+  def run_rspec!
+    run_cmd! "rspec '_#{rspec_version}_' -I '#{RspecEditor.root_dir}/lib' --require rspec/version --require rspec_editor -f RspecEditor::Formatter #{spec}"
+  end
+
+  let(:rspec_version) { gem_version 'rspec', version }
+
+  def run_cmd! cmd
+    Bundler.with_clean_env do
+      ENV.keys.grep(/^BUNDLE_/).each{|k| ENV.delete(k)}
+      ENV['RSPEC_EDITOR']     = ''
+      ENV['RSPEC_EDITOR_OUT'] = output
+      $stderr.puts "    Running: #{cmd}"
+      system cmd
+    end
+  end
+
+  def gem_version name, version
+    version = Gem::Requirement.new(version)
+    specs = all_installed_gems[name]
+    specs_matching = specs.select{|g| version.satisfied_by?(g.version)}
+    version = specs_matching.first.version.to_s
+    version
+  end
+
+  # http://stackoverflow.com/questions/5177634/list-of-installed-gems
+  def all_installed_gems
+    Gem::Specification.all = nil
+    result = Gem::Specification.sort_by{ |g| [g.version, g.name] }.reverse.group_by{ |g| g.name }
+    Gem::Specification.reset
+    result
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'rspec'
+require 'pry'
+require 'awesome_print'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end
+

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: rspec_editor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kurt Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: RSpec Formatter that interfaces with your editor.
+email:
+- ks.github@kurtstephens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec_editor.rb
+- lib/rspec_editor/editor.rb
+- lib/rspec_editor/formatter.rb
+- lib/rspec_editor/rspec2/formatter.rb
+- lib/rspec_editor/rspec3/formatter.rb
+- lib/rspec_editor/version.rb
+- rspec_editor.gemspec
+- spec/lib/rspec_editor/editor_spec.rb
+- spec/rspec2/rspec2_spec_example.rb
+- spec/rspec3/rspec3_spec_example.rb
+- spec/rspec_spec.rb
+- spec/spec_helper.rb
+- tmp/.keep
+homepage: https://github.com/kstephens/rspec_editor
+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.2.2
+signing_key: 
+specification_version: 4
+summary: RSpec Formatter that interfaces with your editor.
+test_files:
+- spec/lib/rspec_editor/editor_spec.rb
+- spec/rspec2/rspec2_spec_example.rb
+- spec/rspec3/rspec3_spec_example.rb
+- spec/rspec_spec.rb
+- spec/spec_helper.rb