hoe-deveiate 0.1.1 → 0.2.0

data/ChangeLog

@@ -1,8 +1,36 @@
+2013-03-03  Michael Granger  <ged@FaerieMUD.org>
+
+	* History.rdoc, lib/hoe/deveiate.rb:
+	Bump minor version, update history.
+	[da47f9e5264f] [tip]
+
+	* lib/hoe/deveiate.rb:
+	Add some quality-checking tasks
+	[93add4a5e309]
+
+	* .rvm.gems, Rakefile:
+	Update dependencies
+	[f41ba2607ff9]
+
+2012-05-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/hoe/deveiate.rb:
+	Split task definitions into smaller functions.
+	[902b816f2ba0]
+
 2012-04-23  Michael Granger  <ged@FaerieMUD.org>
 
+	* .hgtags:
+	Added tag v0.1.1 for changeset e80394a2f00e
+	[6673b996f982]
+
+	* .hgsigs:
+	Added signature for changeset 35d7484d0920
+	[e80394a2f00e] [v0.1.1]
+
 	* History.rdoc, lib/hoe/deveiate.rb:
 	Bump patch version, update history.
-	[35d7484d0920] [tip]
+	[35d7484d0920]
 
 	* README.rdoc, lib/hoe/deveiate.rb:
 	Fix initialization when the .hoerc has no 'mail' config.
@@ -12,7 +40,7 @@
 
 	* .hgtags:
 	Added tag v0.1.0 for changeset 6718b0b0e871
-	[a0585ee6ae54] [github/master]
+	[a0585ee6ae54]
 
 	* .hgsigs:
 	Added signature for changeset 0f4c2dd5f035

data/History.rdoc

@@ -1,3 +1,10 @@
+== v0.2.0 [2013-03-03] Michael Granger <ged@FaerieMUD.org>
+
+- Add some quality-checking tasks
+- Update dependencies
+- Split task definitions into smaller functions.
+
+
 == v0.1.1 [2012-04-23] Michael Granger <ged@FaerieMUD.org>
 
 - Fix initialization when the user's .hoerc doesn't have a mail section.

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+#encoding: utf-8
 
 require 'hoe'
 
@@ -6,22 +7,26 @@ Hoe.add_include_dirs 'lib'
 
 Hoe.plugin :mercurial
 Hoe.plugin :signing
+Hoe.plugin :highline
 
 # Hoe.plugins.delete :publish
 Hoe.plugins.delete :rubyforge
 
-hoespec = Hoe.spec 'hoe-deveiate' do
+
+# The specification
+$hoespec = Hoe.spec 'hoe-deveiate' do
 	self.readme_file = 'README.rdoc'
 	self.history_file = 'History.rdoc'
 	self.extra_rdoc_files = Rake::FileList[ '*.rdoc' ]
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
+	self.dependency 'hoe', '~> 3.5.1'
 	self.dependency 'hoe-highline', '~> 0.0'
 	self.dependency 'hoe-mercurial', '~> 1.4'
-	self.dependency 'mail', '~> 2.4'
-	self.dependency 'rspec', '~> 2.9'
-	self.dependency 'rdoc', '~> 3.12'
+	self.dependency 'mail', '~> 2.5'
+	self.dependency 'rspec', '~> 2.13'
+	self.dependency 'rdoc', '~> 4.0'
 
 	self.spec_extras[:licenses] = ["BSD"]
 	self.require_ruby_version( '>=1.8.7' )
@@ -34,5 +39,5 @@ task :test_email, [:address] do |task, args|
 	Rake::Task[:send_email].execute
 end
 
-ENV['VERSION'] ||= hoespec.spec.version.to_s
+ENV['VERSION'] ||= $hoespec.spec.version.to_s
 

data/lib/hoe/deveiate.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/env ruby
+# -*- ruby -*-
+#encoding: utf-8
 
 require 'hoe'
 require 'mail'
@@ -13,10 +14,16 @@ Hoe.plugin( :highline, :mercurial )
 module Hoe::Deveiate
 
 	# Library version constant
-	VERSION = '0.1.1'
+	VERSION = '0.2.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: 35d7484d0920 $
+	REVISION = %q$Revision: da47f9e5264f $
+
+	# Regexp to match trailing whitespace
+	TRAILING_WHITESPACE_RE = /[ \t]+$/
+
+	# Emoji for style advisories
+	SADFACE = "\u{1f622}"
 
 
 	### Set up defaults
@@ -44,6 +51,7 @@ module Hoe::Deveiate
 	end
 
 
+	### Generate an announcement email.
 	def generate_mail
 		$stderr.puts "Generating an announcement email."
 		abort "no email config in your ~/.hoerc" unless defined?( @email_config )
@@ -83,6 +91,66 @@ module Hoe::Deveiate
 
 	### Add tasks
 	def define_deveiate_tasks
+		self.define_quality_tasks
+		self.define_sanitycheck_tasks
+		self.define_packaging_tasks
+		self.define_announce_tasks
+	end
+
+
+	### Set up tasks for various code-quality checks.
+	def define_quality_tasks
+		self.define_whitespace_checker_tasks
+
+		# Quality-check before checking in
+		task 'hg:precheckin' => :quality_check
+		task 'git:precheckin' => :quality_check
+
+		desc "Run several quality-checks on the code"
+		task :quality_check => [ :check_whitespace ]
+	end
+
+
+	### Set up tasks that check for poor whitespace discipline
+	def define_whitespace_checker_tasks
+
+		desc "Check source code for inconsistent whitespace"
+		task :check_whitespace => [
+			:check_for_trailing_whitespace,
+			:check_for_mixed_indentation,
+		]
+
+		desc "Check source code for trailing whitespace"
+		task :check_for_trailing_whitespace do
+			lines = find_matching_source_lines do |line, _|
+				line =~ TRAILING_WHITESPACE_RE
+			end
+
+			unless lines.empty?
+				desc = "Found some trailing whitespace"
+				describe_lines_that_need_fixing( desc, lines, TRAILING_WHITESPACE_RE )
+				fail
+			end
+		end
+
+		desc "Check source code for mixed indentation"
+		task :check_for_mixed_indentation do
+			lines = find_matching_source_lines do |line, _|
+				line =~ /([ ]\t)/
+			end
+
+			unless lines.empty?
+				desc = "Found mixed indentation"
+				describe_lines_that_need_fixing( desc, lines, /[ ]\t/ )
+				fail
+			end
+		end
+
+	end
+
+
+	### Set up some sanity-checks as dependencies of higher-level tasks
+	def define_sanitycheck_tasks
 
 		task 'hg:precheckin' => [:spec] if File.directory?( 'spec' )
 		task 'hg:prep_release' => [ :check_manifest, :check_history ]
@@ -91,6 +159,12 @@ module Hoe::Deveiate
 		task :check_manifest => 'ChangeLog'
 		task :prerelease => 'ChangeLog'
 
+	end
+
+
+	### Set up tasks for use in packaging.
+	def define_packaging_tasks
+
 		### Task: prerelease
 		unless Rake::Task.task_defined?( :pre )
 			desc "Append the package build number to package versions"
@@ -117,8 +191,14 @@ module Hoe::Deveiate
 			end
 		end
 
+	end
+
+	### Define tasks used to announce new releases
+	def define_announce_tasks
+
 		# Avoid broken Hoe 3.0 task
-		Rake::Task[:announce].clear
+		Rake::Task[:announce].clear if Rake::Task.task_defined?( :announce )
+		Rake::Task[:send_email].clear if Rake::Task.task_defined?( :send_email )
 
 		desc "Announce a new release"
 		task :announce => :send_email
@@ -171,5 +251,86 @@ module Hoe::Deveiate
 
 	end
 
+
+	# Return tuples of the form:
+	#
+	#   [ <filename>, <line number>, <line> ]
+	#
+	# for every line in the Gemspec's source files for which the block
+	# returns true.
+	def find_matching_source_lines
+		matches = []
+
+		source_files = $hoespec.spec.files.grep( /\.(h|c|rb)$/ )
+
+		source_files.each do |filename|
+			previous_line = nil
+
+			IO.foreach( filename ).with_index do |line, i|
+				matches << [filename, i + 1, line] if yield( line, previous_line )
+				previous_line = line
+			end
+		end
+
+		return matches
+	end
+
+
+	### Output a listing of the specified lines with the given +description+, highlighting
+	### the characters matched by the specified +re+.
+	def describe_lines_that_need_fixing( description, lines, re )
+		say "\n"
+		say SADFACE + "  " + color( "Oh noes! " + description, :header )
+
+		grouped_lines = group_line_matches( lines )
+
+		grouped_lines.each do |filename, linegroups|
+			linegroups.each do |group, lines|
+				if group.min == group.max
+					say color("%s:%d" % [ filename, group.min ], :bold)
+				else
+					say color("%s:%d-%d" % [ filename, group.min, group.max ], :bold)
+				end
+
+				lines.each_with_index do |line, i|
+					say "%s: %s" % [
+						color( group.to_a[i].to_s, :dark, :white ),
+						highlight_problems( line, re )
+					]
+				end
+				say "\n"
+			end
+		end
+	end
+
+
+	# Return a Hash, keyed by filename, whose values are tuples of Ranges
+	# and lines extracted from the given [filename, linenumber, line] +tuples+.
+	def group_line_matches( tuples )
+		by_file = tuples.group_by {|tuple| tuple.first }
+
+		return by_file.each_with_object({}) do |(filename, lines), hash|
+			linegroups = lines.slice_before( [0] ) do |line, last_linenum|
+				rval = line[1] > last_linenum.first.succ
+				last_linenum[0] = line[1]
+				rval
+			end
+
+			hash[filename] = linegroups.map do |group|
+				rng = group.first[1] .. group.last[1]
+				grouplines = group.transpose.last
+				[ rng, grouplines ]
+			end
+		end
+	end
+
+
+	### Transform invisibles in the specified line into visible analogues.
+	def highlight_problems( line, re )
+		line \
+			.gsub( re )    { color $&, :on_red } \
+			.gsub( /\t+/ ) { color "\u{21e5}   " * $&.length, :dark, :white }
+	end
+
 end # module Hoe::Deveiate
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hoe-deveiate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,42 +10,44 @@ autorequire:
 bindir: bin
 cert_chain:
 - !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURMRENDQWhTZ0F3SUJB
-  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREE4TVF3d0NnWURWUVFEREFOblpX
-  UXgKRnpBVkJnb0praWFKay9Jc1pBRVpGZ2RmWVdWeWFXVmZNUk13RVFZS0Na
-  SW1pWlB5TEdRQkdSWURiM0puTUI0WApEVEV3TURreE5qRTBORGcxTVZvWERU
-  RXhNRGt4TmpFME5EZzFNVm93UERFTU1Bb0dBMVVFQXd3RFoyVmtNUmN3CkZR
-  WUtDWkltaVpQeUxHUUJHUllIWDJGbGNtbGxYekVUTUJFR0NnbVNKb21UOGl4
-  a0FSa1dBMjl5WnpDQ0FTSXcKRFFZSktvWklodmNOQVFFQkJRQURnZ0VQQURD
-  Q0FRb0NnZ0VCQUx5Ly9CRnhDMWYvY1BTbnd0SkJXb0ZpRnJpcgpoN1JpY0kr
-  am9xL29jVlhRcUk0VERXUHlGLzh0cWt2dCtyRDk5WDlxczJZZVI4Q1UvWWlJ
-  cExXclFPWVNUNzBKCnZEbjdVdmhiMm11RlZxcTYrdm9iZVRrSUxCRU82cGlv
-  bldERzhqU2JvM3FLbTFSaktKRHdnOXA0d05LaFB1dTgKS0d1ZS9CRmI2N0tm
-  bHF5QXBQbVBlYjNWZGQ5Y2xzcHpxZUZxcDdjVUJNRXBGUzZMV3h5NEdrK3F2
-  RkZKQkpMQgpCVUhFL0xaVkpNVnpmcEM1VXErUW1ZN0IrRkgvUXFObmRuM3RP
-  SGdzUGFkTFROaW11QjFzQ3VMMWE0ejNQZXBkClRlTEJFRm1FYW81RGszSy9R
-  OG84dmxiSUIvakJEVFV4NkRqYmd4dzc3OTA5eDZnSTlkb1U0TEQ1WE1jQ0F3
-  RUEKQWFNNU1EY3dDUVlEVlIwVEJBSXdBREFMQmdOVkhROEVCQU1DQkxBd0hR
-  WURWUjBPQkJZRUZKZW9Ha09yOWw0Qgorc2FNa1cvWlhUNFVlU3ZWTUEwR0NT
-  cUdTSWIzRFFFQkJRVUFBNElCQVFCRzJLT2J2WUkyZUh5eUJVSlNKM2pOCnZF
-  blUzZDYwem5BWGJyU2QycWIzcjFsWTFFUEREM2JjeTBNZ2dDZkdkZzNYdTU0
-  ejIxb3F5SWRrOHVHdFdCUEwKSElhOUVnZkZHU1VFZ3ZjSXZhWXFpTjRqVFV0
-  aWRmRUZ3K0x0anM4QVA5Z1dnU0lZUzZHcjM4VjBXR0ZGTnpJSAphT0Qyd211
-  OW9vL1JmZlc0aFMvOEd1dmZNemN3N0NRMzU1d0ZSNEtCL255emUrRXNaMVk1
-  RGVyQ0FhZ01WdURRClUwQkxtV0RGelBHR1dsUGVRQ3JZSENyK0FjSnorTlJu
-  YUhDS0xaZFNLai9SSHVUT3QrZ2JsUmV4OEZBaDhOZUEKY21saFhlNDZwWk5K
-  Z1dLYnhaYWg4NWpJang5NWhSOHZPSStOQU01aUg5a09xSzEzRHJ4YWNUS1Bo
-  cWo1UGp3RgotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
-date: 2012-04-23 00:00:00.000000000 Z
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURiRENDQWxTZ0F3SUJB
+  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREErTVF3d0NnWURWUVFEREFOblpX
+  UXgKR1RBWEJnb0praWFKay9Jc1pBRVpGZ2xHWVdWeWFXVk5WVVF4RXpBUkJn
+  b0praWFKay9Jc1pBRVpGZ052Y21jdwpIaGNOTVRNd01qSTNNVFkwT0RVNFdo
+  Y05NVFF3TWpJM01UWTBPRFU0V2pBK01Rd3dDZ1lEVlFRRERBTm5aV1F4CkdU
+  QVhCZ29Ka2lhSmsvSXNaQUVaRmdsR1lXVnlhV1ZOVlVReEV6QVJCZ29Ka2lh
+  SmsvSXNaQUVaRmdOdmNtY3cKZ2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJ
+  QkR3QXdnZ0VLQW9JQkFRRGI5Mm1reVl3dUdCZzFvUnh0MnRrSAorVW8zTEFz
+  YUwvQVBCZlNMenk4bzMrQjNBVUhLQ2pNVWFWZUJvWmRXdE1IQjc1WDNWUWx2
+  WGZaTXlCeGo1OVZvCmNEdGhyM3pkYW80SG55cnpBSVFmN0JPNVk4S0J3VkQr
+  eXlYQ0QvTjY1VFR3cXNRbk8zaWU3VTUvOXV0MXJuTnIKT2tPekFzY013a2ZR
+  eEJrWER6anZBV2E2VUY0YzVjOWtSL1Q3OWlBMjFrRHg5K2JVTWVudFU1OWFD
+  SnRVY2J4YQo3a2NLSmhQRVlzazRPZHhSOXEyZHBoTk1GRFFzSWRSTzhyeXdY
+  NUZSSHZjYitxblhDMTdSdnhMSHRPanlzUHRwCkVXc1lvWk14eUNESnBVcWJ3
+  b2VpTSt0QUhvejJBQk12M0FoaWUzUWViNitNWk5BdE1tYVdmQngzZGcydSsv
+  V04KQWdNQkFBR2pkVEJ6TUFrR0ExVWRFd1FDTUFBd0N3WURWUjBQQkFRREFn
+  U3dNQjBHQTFVZERnUVdCQlNaMGhDVgpxb0hyMTIyZkdLZWxxZmZ6RVFCaHN6
+  QWNCZ05WSFJFRUZUQVRnUkZuWldSQVJtRmxjbWxsVFZWRUxtOXlaekFjCkJn
+  TlZIUklFRlRBVGdSRm5aV1JBUm1GbGNtbGxUVlZFTG05eVp6QU5CZ2txaGtp
+  Rzl3MEJBUVVGQUFPQ0FRRUEKVmxjZnlxNkd3eUU4aTBRdUZQQ2VWT3dKYW5l
+  U3Zjd3gzMTZEQXBqeTkvdHQyWUQySG9tTGJ0cFh0amk1UVhvcgpPTjZvbG40
+  dFdCSUIzS2xicjNzenE1b1IzUmMxRDAyU2FCVGFseFNuZHA0TTZVa1c5aFJG
+  dTVqbjk4cERCNGZxCjVsOHdNTVUwWGRtcXgxVll2eXNWQWpWRlZDL1c0Tk52
+  bG1nKzJtRWdTVlpQNUs2VGM5cURoM2VNUUlub1l3NmgKdDFZQTZSc1VKSHA1
+  dkdReWhQMXgzNFlwTEFhbHk4aWNibnMvOFBxT2Y3T3NuOXp0bWc4Yk9NSkNl
+  YjMyZVFMago2bUtDd2pwZWd5dEUwb2lmWGZGOGs3NUE5MTA1Y0JuTmlNWk9l
+  MXRYaXFZYy9leENnV3ZiZ2d1cnpET2NSa1p1Ci9ZU3VzYWlEWEhLVTJPM0Fr
+  YzNodEE9PQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCg==
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hoe-highline
+  name: hoe
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 3.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -53,15 +55,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
-  name: hoe-mercurial
+  name: hoe-highline
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -69,15 +71,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
-  name: mail
+  name: hoe-mercurial
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,15 +87,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: mail
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -101,15 +103,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '2.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -117,23 +119,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
-  name: hoe
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
 description: ! 'A collection of Rake tasks and utility functions I use to maintain
   my Open
 
@@ -178,7 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: hoe-deveiate
-rubygems_version: 1.8.21
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A collection of Rake tasks and utility functions I use to maintain my Open