Use String#remove

Thibaut · Thibaut · commit bcd4a5b52218 · 2014-04-19T12:11:24.000-04:00
diff --git a/lib/docs/core/filter.rb b/lib/docs/core/filter.rb
@@ -41,7 +41,7 @@ def subpath_to(url)
     end
 
     def slug
-      @slug ||= subpath.sub(/\A\//, '').sub(/\.html\z/, '')
+      @slug ||= subpath.sub(/\A\//, '').remove(/\.html\z/)
     end
 
     def root_page?
diff --git a/lib/docs/core/scrapers/file_scraper.rb b/lib/docs/core/scrapers/file_scraper.rb
@@ -34,7 +34,7 @@ def process_response?(response)
     end
 
     def file_path_for(url)
-      File.join self.class.dir, url.sub(base_url.to_s, '')
+      File.join self.class.dir, url.remove(base_url.to_s)
     end
 
     def read_file(path)
diff --git a/lib/docs/core/subscriber.rb b/lib/docs/core/subscriber.rb
@@ -17,11 +17,11 @@ def log(msg)
     end
 
     def format_url(url)
-      url.to_s.sub %r{\Ahttps?://}, ''
+      url.to_s.remove %r{\Ahttps?://}
     end
 
     def format_path(path)
-      path.to_s.sub File.join(File.expand_path('.'), ''), ''
+      path.to_s.remove File.join(File.expand_path('.'), '')
     end
 
     def justify(str)
diff --git a/lib/docs/filters/angular/entries.rb b/lib/docs/filters/angular/entries.rb
@@ -3,7 +3,7 @@ class Angular
     class EntriesFilter < Docs::EntriesFilter
       def get_name
         name = slug.split(':').last
-        name.sub! %r{\Ang\.}, ''
+        name.remove! %r{\Ang\.}
         name << " (#{subtype})" if subtype == 'directive' || subtype == 'filter'
         name
       end
diff --git a/lib/docs/filters/backbone/entries.rb b/lib/docs/filters/backbone/entries.rb
@@ -8,7 +8,7 @@ def additional_entries
         css('[id]').each do |node|
           # Module
           if node.name == 'h2'
-            type = node.content.sub 'Backbone.', ''
+            type = node.content.remove 'Backbone.'
             if type.capitalize! # sync, history
               entries << [node.content, node['id'], type]
             end
diff --git a/lib/docs/filters/c/clean_html.rb b/lib/docs/filters/c/clean_html.rb
@@ -35,7 +35,7 @@ def call
         end
 
         css('area[href]').each do |node|
-          node['href'] = node['href'].sub('.html', '')
+          node['href'] = node['href'].remove('.html')
         end
 
         doc
diff --git a/lib/docs/filters/c/entries.rb b/lib/docs/filters/c/entries.rb
@@ -15,17 +15,17 @@ class EntriesFilter < Docs::EntriesFilter
 
       def get_name
         name = at_css('#firstHeading').content.strip
-        name.sub! 'C keywords: ', ''
-        name.sub! %r{\s\(.+\)}, ''
+        name.remove! 'C keywords: '
+        name.remove! %r{\s\(.+\)}
         name = name.split(',').first
         REPLACE_NAMES[name] || name
       end
 
       def get_type
         if type = at_css('.t-navbar > div:nth-child(4) > :first-child').try(:content)
           type.strip!
-          type.sub! ' library', ''
-          type.sub! ' utilities', ''
+          type.remove! ' library'
+          type.remove! ' utilities'
           type
         end
       end
diff --git a/lib/docs/filters/core/clean_text.rb b/lib/docs/filters/core/clean_text.rb
@@ -4,7 +4,7 @@ class CleanTextFilter < Filter
 
     def call
       html.strip!
-      while html.gsub!(EMPTY_NODES_RGX, ''); end
+      while html.remove!(EMPTY_NODES_RGX); end
       html
     end
   end
diff --git a/lib/docs/filters/core/normalize_paths.rb b/lib/docs/filters/core/normalize_paths.rb
@@ -21,7 +21,7 @@ def store_path
     end
 
     def normalized_subpath
-      normalize_path subpath.sub(/\A\//, '')
+      normalize_path subpath.remove(/\A\//)
     end
 
     def normalize_href(href)
diff --git a/lib/docs/filters/cpp/entries.rb b/lib/docs/filters/cpp/entries.rb
@@ -10,10 +10,10 @@ class EntriesFilter < Docs::EntriesFilter
 
       def get_name
         name = at_css('#firstHeading').content.strip
-        name.sub! 'C++ concepts: ', ''
-        name.sub! 'C++ keywords: ', ''
-        name.sub! 'C++ ', ''
-        name.sub! %r{\s\(.+\)}, ''
+        name.remove! 'C++ concepts: '
+        name.remove! 'C++ keywords: '
+        name.remove! 'C++ '
+        name.remove! %r{\s\(.+\)}
         name.sub! %r{\AStandard library header <(.+)>\z}, '\1'
         name = name.split(',').first
         REPLACE_NAMES[name] || name
@@ -24,17 +24,17 @@ def get_type
           'Keywords'
         elsif type = at_css('.t-navbar > div:nth-child(4) > :first-child').try(:content)
           type.strip!
-          type.sub! ' library', ''
-          type.sub! ' utilities', ''
-          type.sub! 'C++ ', ''
+          type.remove! ' library'
+          type.remove! ' utilities'
+          type.remove! 'C++ '
           type.capitalize!
           type
         end
       end
 
       def additional_entries
         return [] unless include_default_entry?
-        names = at_css('#firstHeading').content.gsub(%r{\(.+?\)}, '').split(',')[1..-1]
+        names = at_css('#firstHeading').content.remove(%r{\(.+?\)}).split(',')[1..-1]
         names.each(&:strip!).reject! do |name|
           name.size <= 2 || name == '...' || name =~ /\A[<>]/ || name.start_with?('operator')
         end
diff --git a/lib/docs/filters/css/entries.rb b/lib/docs/filters/css/entries.rb
@@ -60,7 +60,7 @@ class EntriesFilter < Docs::EntriesFilter
 
       def get_name
         case type
-        when 'Data Types' then "<#{super.gsub(' value', '')}>"
+        when 'Data Types' then "<#{super.remove ' value'}>"
         when 'Functions'  then "#{super}()"
         else super
         end
diff --git a/lib/docs/filters/d3/clean_html.rb b/lib/docs/filters/d3/clean_html.rb
@@ -4,7 +4,7 @@ class CleanHtmlFilter < Filter
       def call
         # Remove links inside <h2> and add "id" attributes
         css('h2 > a').each do |node|
-          node.parent['id'] = node['name'].sub('wiki-', '') if node['name']
+          node.parent['id'] = node['name'].remove('wiki-') if node['name']
           node.before(node.children).remove
         end
 
@@ -26,7 +26,7 @@ def call
           next unless node['name'] || node.content == '#'
           parent = node.parent
           parent.name = 'h6'
-          parent['id'] = (node['name'] || node['href'].sub(/\A.+#/, '')).sub('wiki-', '')
+          parent['id'] = (node['name'] || node['href'].remove(/\A.+#/)).remove('wiki-')
           parent.css('a[name]').remove
           node.remove
         end
diff --git a/lib/docs/filters/d3/entries.rb b/lib/docs/filters/d3/entries.rb
@@ -12,7 +12,7 @@ def get_type
       def additional_entries
         css('h6[id]').inject [] do |entries, node|
           name = node.content
-          name.sub! %r{\(.*\z}, ''
+          name.remove! %r{\(.*\z}
           entries << [name, node['id']] unless name == entries.last.try(:first)
           entries
         end
diff --git a/lib/docs/filters/git/clean_html.rb b/lib/docs/filters/git/clean_html.rb
@@ -18,7 +18,7 @@ def other
         end
 
         css('> h1').each do |node|
-          node.content = node.content.sub(/\(\d\) Manual Page/, '')
+          node.content = node.content.remove(/\(\d\) Manual Page/)
         end
 
         unless at_css('> h2')
diff --git a/lib/docs/filters/go/clean_html.rb b/lib/docs/filters/go/clean_html.rb
@@ -18,7 +18,7 @@ def call
 
         # Remove triangle character
         css('h2', '.exampleHeading').each do |node|
-          node.content = node.content.sub("\u25BE", '')
+          node.content = node.content.remove("\u25BE")
           node.name = 'h2'
         end
 
diff --git a/lib/docs/filters/go/entries.rb b/lib/docs/filters/go/entries.rb
@@ -3,7 +3,7 @@ class Go
     class EntriesFilter < Docs::EntriesFilter
       def get_name
         name = at_css('h1').content
-        name.sub! 'Package ', ''
+        name.remove! 'Package '
         name
       end
 
diff --git a/lib/docs/filters/javascript/entries.rb b/lib/docs/filters/javascript/entries.rb
@@ -19,9 +19,9 @@ def get_name
           name
         else
           name = super
-          name.sub! 'Functions and function scope.', ''
-          name.sub! 'Operators.', ''
-          name.sub! 'Statements.', ''
+          name.remove! 'Functions and function scope.'
+          name.remove! 'Operators.'
+          name.remove! 'Statements.'
           name
         end
       end
@@ -34,7 +34,7 @@ def get_type
         elsif slug.start_with? 'Functions_and_function_scope'
           'Function'
         elsif slug.start_with? 'Global_Objects'
-          object, method = *slug.sub('Global_Objects/', '').split('/')
+          object, method = *slug.remove('Global_Objects/').split('/')
           if object.end_with? 'Error'
             'Errors'
           elsif INTL_OBJECTS.include?(object)
diff --git a/lib/docs/filters/jquery_mobile/entries.rb b/lib/docs/filters/jquery_mobile/entries.rb
@@ -6,7 +6,7 @@ class EntriesFilter < Docs::EntriesFilter
 
       def get_name
         name = at_css('h1').content.strip
-        name.sub! ' Widget', ''
+        name.remove! ' Widget'
         name.prepend '.' if name.start_with? 'jqm'
         name << ' event' if type == 'Events' && !name.end_with?(' event')
         name
diff --git a/lib/docs/filters/jquery_ui/entries.rb b/lib/docs/filters/jquery_ui/entries.rb
@@ -6,7 +6,7 @@ class EntriesFilter < Docs::EntriesFilter
 
       def get_name
         name = at_css('h1').content.strip
-        name.sub! ' Widget', ''
+        name.remove! ' Widget'
         name.gsub!(/ [A-Z]/) { |str| str.downcase! }
         name
       end
diff --git a/lib/docs/filters/knockout/entries.rb b/lib/docs/filters/knockout/entries.rb
@@ -15,7 +15,7 @@ class EntriesFilter < Docs::EntriesFilter
       def get_name
         return NAME_BY_SLUG[slug] if NAME_BY_SLUG.has_key?(slug)
         name = at_css('h1').content.strip
-        name.sub! 'The ', ''
+        name.remove! 'The '
         name.sub! %r{"(.+?)"}, '\1'
         name.gsub!(/ [A-Z]/) { |str| str.downcase! }
         name
diff --git a/lib/docs/filters/lodash/entries.rb b/lib/docs/filters/lodash/entries.rb
@@ -6,7 +6,7 @@ def additional_entries
 
         css('h2').each do |node|
           type = node.content.split.first
-          type.gsub! %r{\W}, '' # remove quotation marks
+          type.remove! %r{\W} # remove quotation marks
 
           node.parent.css('h3').each do |heading|
             name = heading.content
diff --git a/lib/docs/filters/moment/clean_html.rb b/lib/docs/filters/moment/clean_html.rb
@@ -4,7 +4,7 @@ class CleanHtmlFilter < Filter
       def call
         # Set id attributes on headings
         css('a.target').each do |node|
-          node.next_element['id'] = node['name'].sub(/\A\//, '').sub(/\/\z/, '').gsub('/', '-')
+          node.next_element['id'] = node['name'].remove(/\A\//).remove(/\/\z/).gsub('/', '-')
         end
 
         css('> article', '.prose', 'h2 > a', 'h3 > a', 'pre > code').each do |node|
diff --git a/lib/docs/filters/moment/entries.rb b/lib/docs/filters/moment/entries.rb
@@ -31,8 +31,8 @@ def additional_entries
             name.prepend 'Language#'
           else
             name = node.content.strip
-            name.sub! %r{\s[\d\.]+\z}, '' # remove version number
-            name.sub! %r{\s\(.+\)\z}, ''  # remove parenthesis
+            name.remove! %r{\s[\d\.]+\z} # remove version number
+            name.remove! %r{\s\(.+\)\z}  # remove parenthesis
             name.prepend 'Parse: ' if type == 'Parse'
           end
 
diff --git a/lib/docs/filters/node/entries.rb b/lib/docs/filters/node/entries.rb
@@ -54,8 +54,8 @@ def additional_entries
           end
 
           # Classes
-          if name.sub! 'Class: ', ''
-            name.sub! 'events.', '' # EventEmitter
+          if name.remove! 'Class: '
+            name.remove! 'events.' # EventEmitter
             klass = name
             entries << [name, node['id']]
             next
@@ -70,7 +70,7 @@ def additional_entries
 
           name.gsub! %r{\(.*?\)}, '()'
           name.gsub! %r{\[.+?\]}, '[]'
-          name.sub! 'assert(), ', '' # assert/assert.ok
+          name.remove! 'assert(), ' # assert/assert.ok
 
           # Skip all that start with an uppercase letter ("Example") or include a space ("exports alias")
           next unless (name.first.upcase! && !name.include?(' ')) || name.start_with?('Class Method')
@@ -80,15 +80,15 @@ def additional_entries
           # Differentiate socket classes (net, dgram, etc.)
           name.sub!('socket.') { "#{klass.sub('.', '_').downcase!}." }
 
-          name.sub! 'Class Method:', ''
-          name.sub! 'buf.',          'buffer.'
-          name.sub! 'buf[',          'buffer['
-          name.sub! 'child.',        'childprocess.'
-          name.sub! 'decoder.',      'stringdecoder.'
-          name.sub! 'emitter.',      'eventemitter.'
-          name.sub! %r{\Arl\.},      'interface.'
-          name.sub! 'rs.',           'readstream.'
-          name.sub! 'ws.',           'writestream.'
+          name.remove! 'Class Method:'
+          name.sub! 'buf.',     'buffer.'
+          name.sub! 'buf[',     'buffer['
+          name.sub! 'child.',   'childprocess.'
+          name.sub! 'decoder.', 'stringdecoder.'
+          name.sub! 'emitter.', 'eventemitter.'
+          name.sub! %r{\Arl\.}, 'interface.'
+          name.sub! 'rs.',      'readstream.'
+          name.sub! 'ws.',      'writestream.'
 
           # Skip duplicates (listen, connect, etc.)
           unless name == entries[-1].try(:first) || name == entries[-2].try(:first)
diff --git a/lib/docs/filters/php/entries.rb b/lib/docs/filters/php/entries.rb
@@ -82,7 +82,7 @@ class EntriesFilter < Docs::EntriesFilter
       def get_name
         return 'IntlException' if slug == 'class.intlexception'
         name = css('> .sect1 > .title', 'h1', 'h2').first.content
-        name.sub! 'The ', ''
+        name.remove! 'The '
         name.sub! ' class', ' (class)'
         name.sub! ' interface', ' (interface)'
         name
@@ -91,7 +91,7 @@ def get_name
       def get_type
         type = at_css('.up').content.strip
         type = 'SPL/Iterators' if type.end_with? 'Iterator'
-        type.sub! ' Functions', ''
+        type.remove! ' Functions'
 
         TYPE_BY_NAME_STARTS_WITH.each_pair do |key, value|
           break type = value if name.start_with?(key)
diff --git a/lib/docs/filters/postgresql/entries.rb b/lib/docs/filters/postgresql/entries.rb
@@ -18,15 +18,15 @@ def get_name
         if %w(Overview Introduction).include?(name)
           result[:pg_chapter_name]
         else
-          name.sub! ' (Common Table Expressions)', ''
+          name.remove! ' (Common Table Expressions)'
           REPLACE_NAMES[name] || name
         end
       end
 
       def clean_heading_name(name)
-        name.sub! %r{\A[\d\.\s]+}, ''
-        name.sub! 'Using ', ''
-        name.sub! %r{\AThe }, ''
+        name.remove! %r{\A[\d\.\s]+}
+        name.remove! 'Using '
+        name.remove! %r{\AThe }
         name
       end
 
@@ -41,7 +41,7 @@ def get_type
           if type.start_with?('Func') && (match = name.match(/\A(?!Form|Seq|Set|Enum)(.+) Func/))
             "Functions: #{match[1]}"
           else
-            type.sub 'SQL ', ''
+            type.remove 'SQL '
           end
         end
       end
@@ -104,10 +104,10 @@ def get_heading_entries(selector)
       def get_custom_entries(selector)
         css(selector).inject [] do |entries, node|
           name = node.content
-          name.gsub! %r{\(.*?\)}m, ''
-          name.gsub! %r{\[.*?\]}m, ''
+          name.remove! %r{\(.*?\)}m
+          name.remove! %r{\[.*?\]}m
           name.squeeze! ' '
-          name.sub! %r{\([^\)]*\z}, '' # bug fix: json_populate_record
+          name.remove! %r{\([^\)]*\z} # bug fix: json_populate_record
           name = '||' if name.include? ' || '
           id = name.gsub(/[^a-z0-9\-_]/) { |char| char.ord }
           id = id.parameterize
@@ -129,7 +129,7 @@ def get_comparison_entries
       end
 
       def additional_entry_prefix
-        type.dup.sub!('Functions: ', '') || self.name
+        type.dup.remove!('Functions: ') || self.name
       end
 
       def skip_additional_entries?
diff --git a/lib/docs/filters/python/clean_html.rb b/lib/docs/filters/python/clean_html.rb
diff --git a/lib/docs/filters/python/entries.rb b/lib/docs/filters/python/entries.rb
diff --git a/lib/docs/filters/rdoc/entries.rb b/lib/docs/filters/rdoc/entries.rb
diff --git a/lib/docs/filters/sass/clean_html.rb b/lib/docs/filters/sass/clean_html.rb
diff --git a/lib/docs/filters/sass/entries.rb b/lib/docs/filters/sass/entries.rb
diff --git a/lib/docs/subscribers/filter_subscriber.rb b/lib/docs/subscribers/filter_subscriber.rb
diff --git a/lib/tasks/docs.thor b/lib/tasks/docs.thor
diff --git a/test/lib/docs/storage/file_store_test.rb b/test/lib/docs/storage/file_store_test.rb
