transpec 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c98c4880892b0c69338d5a58b145fb47e6efbc14
-  data.tar.gz: 27d7e201e95c233d9e13887a9d22642e99034952
+  metadata.gz: f3d0d724597250da7c8777978b0966f79bb8ef4a
+  data.tar.gz: d8cd06841df2954393cbe9ce26bb6d4b892fb8d7
 SHA512:
-  metadata.gz: 265a268cf2858c97c587c561c58cb0b129951d6f8b69acec44ac652457ad9eb11ff01e25d506914f34661239e792c37b0e9443448a92f5587a219b43af37e4cd
-  data.tar.gz: 901f0dcc5290387aec5377f3514c61134199351000621520090d35aecd46be78063239a47c66f7ca3cd414ef6182f7aba845b067761cce0ee6774e999bc4aef3
+  metadata.gz: eaf64a911679b0b2277c3643ee3e53a2b92b8ac3b0f8d5730f6a5399e4179114b0290c32b4c308968601884a47728f52f77d8babbfdafb3309407a8ef7e8dddd
+  data.tar.gz: 081bd5d3f7d4e0b91a7ec37754cee098c0fcc714862044304549daff2f2e263ecb3c0d3a120c1299e049d4dcdcd7750d4cc93d9d8e9b5cf548e3fd6f69b101c6

data/.rubocop.yml

@@ -11,3 +11,7 @@ WordArray:
 # TODO
 Documentation:
   Enabled: false
+
+# Currently IndentationWidth reports false positive offence around here document.
+IndentationWidth:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# CHANGELOG
+
+## v0.0.2
+
+* Support conversion from `be_close(expected, delta)` to `be_within(delta).of(expected)`
+
+## v0.0.1
+
+* Initial release

data/Guardfile

@@ -12,3 +12,7 @@ guard :rubocop do
   watch(%r{.+\.rb$})
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end
+
+guard :shell do
+  watch('README.md.erb') { `rake readme` }
+end

data/README.md

@@ -1,13 +1,96 @@
+[![Gem Version](https://badge.fury.io/rb/transpec.png)](http://badge.fury.io/rb/transpec) [![Dependency Status](https://gemnasium.com/yujinakayama/transpec.png)](https://gemnasium.com/yujinakayama/transpec) [![Build Status](https://travis-ci.org/yujinakayama/transpec.png?branch=master)](https://travis-ci.org/yujinakayama/transpec) [![Coverage Status](https://coveralls.io/repos/yujinakayama/transpec/badge.png)](https://coveralls.io/r/yujinakayama/transpec) [![Code Climate](https://codeclimate.com/github/yujinakayama/transpec.png)](https://codeclimate.com/github/yujinakayama/transpec)
+
 # Transpec
 
 **Transpec** automatically converts your specs into latest [RSpec](http://rspec.info/) syntax with static analysis.
 
-See the following pages for new RSpec syntax:
+This aims to facilitate smooth transition to RSpec 3.
+
+See the following pages for the new RSpec syntax and the plan for RSpec 3:
 
 * [Myron Marston » RSpec's New Expectation Syntax](http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax)
 * [RSpec's new message expectation syntax - Tea is awesome.](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
 * [Myron Marston » The Plan for RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3)
 
+Note that Transpec does not yet support all conversions for the RSpec changes,
+and also the changes for RSpec 3 is not fixed and may vary in the future.
+So it's recommended to follow updates of both RSpec and Transpec.
+
+## Example
+
+Here's an example spec:
+
+```ruby
+describe Account do
+  subject(:account) { Account.new(logger) }
+  let(:logger) { mock('logger') }
+
+  describe '#balance' do
+    context 'initially' do
+      it 'is zero' do
+        account.balance.should == 0
+      end
+    end
+  end
+
+  describe '#close' do
+    it 'logs an account closed message' do
+      logger.should_receive(:account_closed).with(account)
+      account.close
+    end
+  end
+
+  describe '#renew' do
+    context 'when the account is renewable and not closed' do
+      before do
+        account.stub(:renewable? => true, :closed? => false)
+      end
+
+      it 'does not raise error' do
+        lambda { account.renew }.should_not raise_error
+      end
+    end
+  end
+end
+```
+
+Transpec would convert it to the following form:
+
+```ruby
+describe Account do
+  subject(:account) { Account.new(logger) }
+  let(:logger) { double('logger') }
+
+  describe '#balance' do
+    context 'initially' do
+      it 'is zero' do
+        expect(account.balance).to eq(0)
+      end
+    end
+  end
+
+  describe '#close' do
+    it 'logs an account closed message' do
+      expect(logger).to receive(:account_closed).with(account)
+      account.close
+    end
+  end
+
+  describe '#renew' do
+    context 'when the account is renewable and not closed' do
+      before do
+        allow(account).to receive(:renewable?).and_return(true)
+        allow(account).to receive(:closed?).and_return(false)
+      end
+
+      it 'does not raise error' do
+        expect { account.renew }.not_to raise_error
+      end
+    end
+  end
+end
+```
+
 ## Installation
 
 ```bash
@@ -16,17 +99,31 @@ $ gem install transpec
 
 ## Basic Usage
 
-Run `transpec` with no arguments in your project directory:
+Before converting your specs:
+
+* Make sure your project has `rspec` gem dependency `2.14` or later. If not, change your `*.gemspec` or `Gemfile` to do so.
+* Run `rspec` and check if all the specs pass.
+
+Then, run `transpec` with no arguments in the project root directory:
 
 ```bash
+$ cd some-project
 $ transpec
+Processing spec/spec_helper.rb
+Processing spec/spec_spec.rb
+Processing spec/support/file_helper.rb
+Processing spec/support/shared_context.rb
+Processing spec/transpec/ast/scanner_spec.rb
+Processing spec/transpec/ast/scope_stack_spec.rb
 ```
 
-This will inspect and overwrite all spec files in the `spec` directory.
+This will convert and overwrite all spec files in the `spec` directory.
+
+After the conversion, run `rspec` again and check if all pass.
 
-For more information, please see the help with `--help` option.
+## Compatibility
 
-**TODO:** Add more description
+Tested on MRI 1.9, MRI 2.0 and JRuby in 1.9 mode.
 
 ## Contributing
 

data/README.md.erb

@@ -0,0 +1,107 @@
+[![Gem Version](https://badge.fury.io/rb/transpec.png)](http://badge.fury.io/rb/transpec) [![Dependency Status](https://gemnasium.com/yujinakayama/transpec.png)](https://gemnasium.com/yujinakayama/transpec) [![Build Status](https://travis-ci.org/yujinakayama/transpec.png?branch=master)](https://travis-ci.org/yujinakayama/transpec) [![Coverage Status](https://coveralls.io/repos/yujinakayama/transpec/badge.png)](https://coveralls.io/r/yujinakayama/transpec) [![Code Climate](https://codeclimate.com/github/yujinakayama/transpec.png)](https://codeclimate.com/github/yujinakayama/transpec)
+
+# Transpec
+
+**Transpec** automatically converts your specs into latest [RSpec](http://rspec.info/) syntax with static analysis.
+
+This aims to facilitate smooth transition to RSpec 3.
+
+See the following pages for the new RSpec syntax and the plan for RSpec 3:
+
+* [Myron Marston » RSpec's New Expectation Syntax](http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax)
+* [RSpec's new message expectation syntax - Tea is awesome.](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
+* [Myron Marston » The Plan for RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3)
+
+Note that Transpec does not yet support all conversions for the RSpec changes,
+and also the changes for RSpec 3 is not fixed and may vary in the future.
+So it's recommended to follow updates of both RSpec and Transpec.
+
+## Example
+
+Here's an example spec:
+
+```ruby
+<%=
+example = <<END
+describe Account do
+  subject(:account) { Account.new(logger) }
+  let(:logger) { mock('logger') }
+
+  describe '#balance' do
+    context 'initially' do
+      it 'is zero' do
+        account.balance.should == 0
+      end
+    end
+  end
+
+  describe '#close' do
+    it 'logs an account closed message' do
+      logger.should_receive(:account_closed).with(account)
+      account.close
+    end
+  end
+
+  describe '#renew' do
+    context 'when the account is renewable and not closed' do
+      before do
+        account.stub(:renewable? => true, :closed? => false)
+      end
+
+      it 'does not raise error' do
+        lambda { account.renew }.should_not raise_error
+      end
+    end
+  end
+end
+END
+-%>
+```
+
+Transpec would convert it to the following form:
+
+```ruby
+<%= Transpec::Rewriter.new.rewrite(example) -%>
+```
+
+## Installation
+
+```bash
+$ gem install transpec
+```
+
+## Basic Usage
+
+Before converting your specs:
+
+* Make sure your project has `rspec` gem dependency `<%= rspec_version %>` or later. If not, change your `*.gemspec` or `Gemfile` to do so.
+* Run `rspec` and check if all the specs pass.
+
+Then, run `transpec` with no arguments in the project root directory:
+
+```bash
+$ cd some-project
+$ transpec
+Processing spec/spec_helper.rb
+Processing spec/spec_spec.rb
+Processing spec/support/file_helper.rb
+Processing spec/support/shared_context.rb
+Processing spec/transpec/ast/scanner_spec.rb
+Processing spec/transpec/ast/scope_stack_spec.rb
+```
+
+This will convert and overwrite all spec files in the `spec` directory.
+
+After the conversion, run `rspec` again and check if all pass.
+
+## Compatibility
+
+Tested on MRI 1.9, MRI 2.0 and JRuby in 1.9 mode.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -1,7 +1,9 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+Rubocop::RakeTask.new(:style)
 
 namespace :ci do
   desc "#{Rake::Task['spec'].comment} for CI environment"
@@ -16,12 +18,31 @@ namespace :ci do
   end
 end
 
-desc 'Check code style with RuboCop'
-task :style do
-  sh('rubocop')
-end
-
 desc 'Run RSpec and RuboCop'
 task all: [:spec, :style]
 
+desc 'Generate README.md'
+task :readme do
+  require 'erb'
+  require 'transpec'
+
+  gem_specification = Gem::Specification.load('transpec.gemspec')
+  rspec_dependency = gem_specification.dependencies.find { |d| d.name == 'rspec' }
+  rspec_requirement = rspec_dependency.requirement
+  rspec_version = rspec_requirement.requirements.first.find { |r| r.is_a?(Gem::Version) }
+
+  erb = ERB.new(File.read('README.md.erb'), nil, '-')
+  content = erb.result(binding)
+  File.write('README.md', content)
+end
+
+task :abort_unless_latest_readme_is_committed => :readme do
+  unless Transpec::Git.clean?
+    warn 'Commit README.md before release.'
+    exit 1
+  end
+end
+
+Rake::Task[:release].enhance([:abort_unless_latest_readme_is_committed])
+
 task default: :all

data/bin/transpec

@@ -2,7 +2,7 @@
 # coding: utf-8
 
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
-require 'transpec'
+require 'transpec/cli'
 
 result = Transpec::CLI.run
 exit(result ? 0 : 1)

data/lib/transpec/ast/scanner.rb

@@ -1,5 +1,8 @@
 # coding: utf-8
 
+require 'transpec/ast/scope_stack'
+require 'parser'
+
 module Transpec
   module AST
     class Scanner

data/lib/transpec/ast/scope_stack.rb

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require 'transpec/util'
+
 module Transpec
   module AST
     class ScopeStack < Array

data/lib/transpec/cli.rb

@@ -1,5 +1,9 @@
 # coding: utf-8
 
+require 'transpec/configuration'
+require 'transpec/git'
+require 'transpec/rewriter'
+require 'transpec/version'
 require 'optparse'
 require 'find'
 

data/lib/transpec/rewriter.rb

@@ -1,6 +1,14 @@
 # coding: utf-8
 
-require 'parser'
+require 'transpec/ast/scanner'
+require 'transpec/configuration'
+require 'transpec/syntax'
+require 'transpec/syntax/be_close'
+require 'transpec/syntax/double'
+require 'transpec/syntax/matcher'
+require 'transpec/syntax/method_stub'
+require 'transpec/syntax/should'
+require 'transpec/syntax/should_receive'
 require 'parser/current'
 
 module Transpec
@@ -95,7 +103,7 @@ module Transpec
     end
 
     def process_double(double)
-      double.replace_deprecated_method! if @configuration.replace_deprecated_method?
+      double.convert_to_double! if @configuration.replace_deprecated_method?
     end
 
     def process_method_stub(method_stub)
@@ -105,5 +113,9 @@ module Transpec
         method_stub.replace_deprecated_method!
       end
     end
+
+    def process_be_close(be_close)
+      be_close.convert_to_be_within! if @configuration.replace_deprecated_method?
+    end
   end
 end

data/lib/transpec/syntax.rb

@@ -41,7 +41,10 @@ module Transpec
     end
 
     def self.target_node?(node)
-      false
+      return false unless node.type == :send
+      receiver_node, method_name, *_ = *node
+      return false unless target_receiver_node?(receiver_node)
+      target_method_names.include?(method_name)
     end
 
     def initialize(node, ancestor_nodes, in_example_group_context, source_rewriter)
@@ -54,5 +57,37 @@ module Transpec
     def parent_node
       @ancestor_nodes.last
     end
+
+    def expression_range
+      @node.loc.expression
+    end
+
+    protected
+
+    def self.target_receiver_node?(node)
+      false
+    end
+
+    def self.target_method_names
+      []
+    end
+
+    private
+
+    def remove(range)
+      @source_rewriter.remove(range)
+    end
+
+    def insert_before(range, content)
+      @source_rewriter.insert_before(range, content)
+    end
+
+    def insert_after(range, content)
+      @source_rewriter.insert_after(range, content)
+    end
+
+    def replace(range, content)
+      @source_rewriter.replace(range, content)
+    end
   end
 end