should_clean 0.0.2 → 0.0.3

data/lib/should_clean/cleaner.rb

@@ -5,8 +5,7 @@ module ShouldClean
       # order of convertors matter
       convertors = [
         Converters::NegativeConverter,
-        Converters::AdverbConverter,
-        Converters::RegularVerbConverter
+        Converters::PositiveConverter
       ]
 
       convertor = convertors.detect { |converter| text.match(converter.matcher) }

data/lib/should_clean/converters.rb

@@ -2,7 +2,6 @@ module ShouldClean
   module Converters
     autoload :Converter, 'should_clean/converters/converter'
     autoload :NegativeConverter, 'should_clean/converters/negative_converter'
-    autoload :RegularVerbConverter, 'should_clean/converters/regular_verb_converter'
-    autoload :AdverbConverter, 'should_clean/converters/adverb_converter'
+    autoload :PositiveConverter, 'should_clean/converters/positive_converter'
   end
 end

data/lib/should_clean/converters/converter.rb

@@ -1,18 +1,66 @@
 module ShouldClean
   module Converters
     class Converter
-      attr_accessor :text, :match_data
+      SUBJECT = /^\s*(it\s*'|it\s*"|it\s*%{)\s*/
+      NEGATIVE_SPEC = /#{SUBJECT}(should not|shouldn't)\s*/
+      POSITIVE_SPEC = /#{SUBJECT}(should)\s*/
+
+      attr_accessor :text, :splitter
 
       def initialize(text, match_data)
         @text = text
-        @match_data = match_data
+        @splitter = match_data[2]
+      end
+
+      def convert
+        "#{subject}#{active_verb}#{joiner}#{object}"
       end
 
       private
-      def splitter
-        match_data[0]
+      def verb
+        @verb ||= verb_and_object.first
+      end
+
+      def adverb
+        @adverb = ShouldClean::Adverbs.all.detect do |a|
+          adverb_and_expectation.lstrip.start_with?(a)
+        end
       end
 
+      def subject
+        @subject = subject_and_expectation.first
+      end
+
+      def object
+        @object ||= verb_and_object.last
+      end
+
+      def joiner
+        expectation.lstrip.split(/\W/, 2) # split limit gives the regexp match $&
+        @joiner = $&
+      end
+
+      def expectation
+        return @expectation if @expectation
+
+        if adverb
+          @expectation = adverb_and_expectation.split(adverb).last
+        else
+          @expectation = adverb_and_expectation
+        end
+      end
+
+      def adverb_and_expectation
+        @adverb_and_expectation ||= subject_and_expectation.last
+      end
+
+      def verb_and_object
+        @verb_and_object ||= expectation.lstrip.split(/\W/, 2)
+      end
+
+      def subject_and_expectation
+        @subject_and_expectation ||= text.split(splitter, 2)
+      end
     end
   end
 end

data/lib/should_clean/converters/negative_converter.rb

@@ -3,13 +3,21 @@ module ShouldClean
     class NegativeConverter < Converter
 
       def self.matcher
-        /should( not|n't)/
+        /#{NEGATIVE_SPEC}/
       end
 
-      def convert
-        text.gsub(splitter, 'does not')
+      private
+      def active_verb
+        if verb == 'be'
+          if adverb == 'by default'
+            @active_verb = 'does not default to'
+          else
+            @active_verb = 'is not'
+          end
+        else
+          @active_verb = ['does not', adverb, verb].compact.join(' ')
+        end
       end
-
     end
   end
 end

data/lib/should_clean/converters/positive_converter.rb

@@ -0,0 +1,22 @@
+module ShouldClean
+  module Converters
+    class PositiveConverter < Converter
+
+      def self.matcher
+        /#{POSITIVE_SPEC}/
+      end
+
+      private
+      def active_verb
+        return @active_verb if @active_verb
+
+        if adverb == 'by default' && verb == 'be'
+          @active_verb = "defaults to"
+        else
+          active_verb  = Conjugator.tpp(verb)
+          @active_verb = [adverb, active_verb].compact.join(' ')
+        end
+      end
+    end
+  end
+end

data/lib/should_clean/replacer.rb

@@ -3,8 +3,6 @@ require 'tempfile'
 
 module ShouldClean
   class Replacer
-    MATCHER = /^it\s*('|"|%{)/
-
     attr_accessor :file_path, :content
 
     def initialize(file_path)
@@ -18,12 +16,8 @@ module ShouldClean
       tmp_file = Tempfile.new('tmp.txt')
 
       content.each_line.each do |line|
-        if line.strip.match(MATCHER)
-          cleaned = Cleaner.clean(line)
-          tmp_file.puts cleaned || line
-        else
-          tmp_file.puts line
-        end
+        cleaned = Cleaner.clean(line)
+        tmp_file.puts cleaned || line
       end
 
       tmp_file.close

data/lib/should_clean/simulator.rb

@@ -3,8 +3,6 @@ require 'tempfile'
 
 module ShouldClean
   class Simulator
-    MATCHER = /^it\s*('|"|%{)/
-
     attr_accessor :content, :buffer
 
     def initialize(file_path, buffer = $stdout)
@@ -16,12 +14,10 @@ module ShouldClean
       return unless content.valid_encoding?
 
       content.each_line.each do |line|
-        if line.strip.match(MATCHER)
-          cleaned = Cleaner.clean(line)
-          if cleaned
-            buffer.puts("- #{line.strip}")
-            buffer.puts("+ #{cleaned.strip}")
-          end
+        cleaned = Cleaner.clean(line)
+        if cleaned
+          buffer.puts("- #{line.strip}")
+          buffer.puts("+ #{cleaned.strip}")
         end
       end
     end

data/lib/should_clean/version.rb

@@ -1,3 +1,3 @@
 module ShouldClean
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/should_clean/cleaner_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe ShouldClean::Cleaner do
 
-  describe "normal conversion from future to present tense" do
+  describe "regular verb converter" do
     it "converts spec defined with double quotes" do
       ShouldClean::Cleaner.clean('it "should action something"').
         should == 'it "actions something"'
@@ -22,26 +22,14 @@ describe ShouldClean::Cleaner do
       ShouldClean::Cleaner.clean('it "should do something"').
         should == 'it "does something"'
     end
-  end
-
-  describe "conversion of should variations" do
-    it "converts 'should not action' to 'does not action'" do
-      ShouldClean::Cleaner.clean('it "should not action"').
-        should == 'it "does not action"'
-    end
-
-    it "converts 'shouldn't action' to 'does not action'" do
-      ShouldClean::Cleaner.clean('it "shouldn\'t action"').
-        should == 'it "does not action"'
-    end
 
     it "converts 'should be able to action' to 'actions'" do
       ShouldClean::Cleaner.clean('it "should be able to action"').
-        should == 'it "actions"'
+        should == 'it "is able to action"'
     end
   end
 
-  describe "conversion of adverbs" do
+  describe "positive converter with adverb" do
     it "converts 'should correctly calculate' to 'correctly calculates'" do
       ShouldClean::Cleaner.clean('it "should correctly calculate"').
         should == 'it "correctly calculates"'
@@ -66,5 +54,56 @@ describe ShouldClean::Cleaner do
       ShouldClean::Cleaner.clean('it "should by default have"').
         should == 'it "by default has"'
     end
+
+    it "converts 'should by default be 1' to 'defaults to 1'" do
+      ShouldClean::Cleaner.clean('it "should by default be 1"').
+        should == 'it "defaults to 1"'
+    end
+
+    it "converts 'should automatically be 1' to 'automatically is 1'" do
+      ShouldClean::Cleaner.clean('it "should automatically be 1"').
+        should == 'it "automatically is 1"'
+    end
+  end
+
+  describe "negative converter" do
+    it "converts 'should not action' to 'does not action'" do
+      ShouldClean::Cleaner.clean('it "should not action"').
+        should == 'it "does not action"'
+    end
+
+    it "converts 'shouldn't action' to 'does not action'" do
+      ShouldClean::Cleaner.clean('it "shouldn\'t action"').
+        should == 'it "does not action"'
+    end
+
+    it "converts 'should not be foo' to 'is not foo'" do
+      ShouldClean::Cleaner.clean('it "should not be foo"').
+        should == 'it "is not foo"'
+    end
+
+    it "converts 'shouldn't be foo' to 'is not foo'" do
+      ShouldClean::Cleaner.clean('it "shouldn\'t be foo"').
+        should == 'it "is not foo"'
+    end
+  end
+
+  describe "negative converter with adverb" do
+    it "converts 'should not automatically save' to 'does not automatically save'" do
+      ShouldClean::Cleaner.clean('it "should not automatically save"').
+        should == 'it "does not automatically save"'
+    end
+
+    it "converts 'should not by default be 1' to 'does not default to 1'" do
+      ShouldClean::Cleaner.clean('it "should not by default be 1"').
+        should == 'it "does not default to 1"'
+    end
+  end
+
+  describe "no change required" do
+    it "constrain changes to beginning of doc string" do
+      ShouldClean::Cleaner.clean('it "asks for a failure_message_for_should when something"').
+        should == nil
+    end
   end
 end

metadata

@@ -1,46 +1,43 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: should_clean
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Sachin Ranchod
 - Dalibor Nasevic
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-09-06 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-description: Utility to remove unneeded shoulds from your RSpec test descriptions - 'it "should do something"' becomes 'it "does something"'
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utility to remove unneeded shoulds from your RSpec test descriptions
+  - 'it "should do something"' becomes 'it "does something"'
+email:
 - sachin.ranchod@gmail.com
 - dalibor.nasevic@gmail.com
-executables: 
+executables:
 - should_clean
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -53,10 +50,9 @@ files:
 - lib/should_clean/cleaner.rb
 - lib/should_clean/conjugator.rb
 - lib/should_clean/converters.rb
-- lib/should_clean/converters/adverb_converter.rb
 - lib/should_clean/converters/converter.rb
 - lib/should_clean/converters/negative_converter.rb
-- lib/should_clean/converters/regular_verb_converter.rb
+- lib/should_clean/converters/positive_converter.rb
 - lib/should_clean/replacer.rb
 - lib/should_clean/simulator.rb
 - lib/should_clean/version.rb
@@ -72,37 +68,31 @@ files:
 - spec/should_clean/simulator_spec.rb
 - spec/should_clean_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+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.3.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: It changes "it should do" to "it does" in your RSpec files
-test_files: 
+test_files:
 - spec/fixtures/broken_spec.txt
 - spec/fixtures/example_correct_spec.txt
 - spec/fixtures/example_spec.txt

data/lib/should_clean/converters/adverb_converter.rb

@@ -1,23 +0,0 @@
-module ShouldClean
-  module Converters
-    class AdverbConverter < Converter
-
-      def self.matcher
-        /should (#{ShouldClean::Adverbs.all.join('|')})/
-      end
-
-      def convert
-        prefix, postfix = text.split(splitter, 2)
-        verb, remainder = postfix.lstrip.split(/\W/, 2) # split limit gives the regexp match $&
-        active_verb = Conjugator.tpp(verb)
-        "#{prefix}#{adverb} #{active_verb}#{$&}#{remainder}"
-      end
-
-      private
-      def adverb
-        match_data[1]
-      end
-
-    end
-  end
-end

data/lib/should_clean/converters/regular_verb_converter.rb

@@ -1,18 +0,0 @@
-module ShouldClean
-  module Converters
-    class RegularVerbConverter < Converter
-
-      def self.matcher
-        /should (be able to)?/
-      end
-
-      def convert
-        method_name, description = text.split(splitter, 2)
-        verb, rest = description.lstrip.split(/\W/, 2) # split limit gives the regexp match $&
-        active_verb = Conjugator.tpp(verb)
-        "#{method_name}#{active_verb}#{$&}#{rest}"
-      end
-
-    end
-  end
-end