Complain when description and summary are identical

git-svn-id: svn+ssh://rubyforge.org/var/svn/rubygems/trunk@2166 3d4018f9-ac1a-0410-99e9-8a154d859a19

ChangeLog

@@ -1,5 +1,10 @@
 # -*- coding: utf-8 -*-
 
+2009-04-14  Eric Hodel  <drbrain@segment7.net>
+
+	* lib/rubygems/specification.rb:  Complain when summary and
+	  description are identical.
+
 2009-04-08  Eric Hodel  <drbrain@segment7.net>
 
 	* lib/rubygems/specification.rb:  Strip directories, complain for

doc/release_notes/rel_1_3_2.rdoc

@@ -25,7 +25,7 @@ Select New Features:
   * #validate strips directories and errors on not-files.
   * #description no longer removes newlines.
   * #name must be a String.
-  * FIXME is no longer allowed in various fields.
+  * FIXME and TODO are no longer allowed in various fields.
   * Added support for a license attribute.  Feature #11041 (partial).
   * Removed Gem::Specification::list, too much process growth.  Bug #23668 by
     Steve Purcell.

lib/rubygems/specification.rb

@@ -890,11 +890,15 @@ def validate
 
     # Warnings
 
-    %w[author email homepage rubyforge_project summary].each do |attribute|
+    %w[author description email homepage rubyforge_project summary].each do |attribute|
       value = self.send attribute
       alert_warning "no #{attribute} specified" if value.nil? or value.empty?
     end
 
+    if summary and not summary.empty? and description == summary then
+      alert_warning 'description and summary are identical'
+    end
+
     alert_warning "RDoc will not be generated (has_rdoc == false)" unless
       has_rdoc
 

test/test_gem_specification.rb

@@ -952,6 +952,25 @@ def test_validate_description
     util_setup_validate
 
     Dir.chdir @tempdir do
+      @a1.description = ''
+
+      use_ui @ui do
+        @a1.validate
+      end
+
+      assert_equal "WARNING:  no description specified\n", @ui.error, 'error'
+
+      @ui = MockGemUi.new
+      @a1.summary = 'this is my summary'
+      @a1.description = @a1.summary
+
+      use_ui @ui do
+        @a1.validate
+      end
+
+      assert_equal "WARNING:  description and summary are identical\n",
+                   @ui.error, 'error'
+
       @a1.description = 'FIXME (describe your package)'
 
       e = assert_raises Gem::InvalidSpecificationException do