rake-deveiate 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2ea1b2c13c4a64b66b4f9f70ed3fa8c253e38b8070fbbc2c9b6e2e05b2a34c2
-  data.tar.gz: 5d151b30f0a6e0f4e2ec550ef2fbb74981f3bba2c89561a2dc32ac52afea864a
+  metadata.gz: c82c9f76fc2792d7c73c6343234fa7bf2ddd898e16f6fd5bcf5889e3e1a2b3e8
+  data.tar.gz: d12fa1ea8df3bfab3cde2d3ba5b51c0d7e3a194a33e57987fcc8ab42fa453c44
 SHA512:
-  metadata.gz: '08c1efed49f74b109300bb0362fa319faa49c3e4d0ba3191c48da5c4e49364ee559da560ab4fa3fb0081829e452c51981527763459972d5099a9ea08d0266b60'
-  data.tar.gz: 901f6960dbcc3d70a834dcb408f402c5ce298f9413fc1fe5acfe088d6f5439f5aa97031bec3fc4df5471bcde057b935340f27c2dd834566bc72974f1002160e3
+  metadata.gz: 9b48f19a65ff709311f5c0db3fc09db4c1cc66a9209f04c46f596e21f28f35fb70317c222044222486c0e4d36e72ecd3bc2ef9e7f1cd13f7c85ecf58d1ae0511
+  data.tar.gz: 2fc376b80482c3e48368c7f0e2f3df5ed9fcb5e2c9fcb1e1660c72f09fa4362f5a53f7c81b1a04f6679077b3e11e116bc3f22a2a7d1ae037452a6ba00ede92e4

data/History.md

@@ -2,6 +2,13 @@
 
 ---
 
+## v0.12.0 [2020-03-04] Michael Granger <ged@FaerieMUD.org>
+
+Improvements:
+
+- Add fixup tasks, example global rakefile
+
+
 ## v0.11.0 [2020-02-26] Michael Granger <ged@FaerieMUD.org>
 
 Improvements:

data/data/rake-deveiate/Rakefile.erb

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'rake/deveiate'
+
+
+Rake::DevEiate.setup( '<%= project.name %>' )
+

data/data/rake-deveiate/global.rake

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+begin
+	require 'rake/deveiate'
+rescue LoadError => err
+	msg = err.respond_to?( :full_message ) ?
+		err.full_message( highlight: true, order: :bottom ) :
+		err.message
+	warn "%p while loading rake-deveiate: %s" % [ err.class, msg ]
+end
+
+
+if defined?( Rake::DevEiate ) && !Rake::DevEiate.already_setup?
+	default_name = File.basename( Dir.pwd ).downcase
+
+	Rake::DevEiate.setup( default_name )
+
+end
+
+

data/lib/rake/deveiate.rb

@@ -3,6 +3,7 @@
 
 require 'pathname'
 require 'etc'
+require 'tempfile'
 
 begin
   gem 'rdoc'
@@ -34,7 +35,7 @@ class Rake::DevEiate < Rake::TaskLib
 	VERSION_PATTERN = /VERSION\s*=\s*(?<quote>['"])(?<version>\d+(\.\d+){2}.*)\k<quote>/
 
 	# The version of this library
-	VERSION = '0.11.0'
+	VERSION = '0.12.0'
 
 	# The server to release to by default
 	DEFAULT_GEMSERVER = 'https://rubygems.org/'
@@ -126,12 +127,18 @@ class Rake::DevEiate < Rake::TaskLib
 	end
 
 
+	### Returns +true+ if Rake::DevEiate has already been set up.
+	def self::already_setup?
+		Rake::Task.task_defined?( 'deveiate' )
+	end
+
 
 	### Create the devEiate tasks for a gem with the given +name+.
 	def initialize( name, **options, &block )
 		@name          = validate_gemname( name )
 		@options       = options
 
+		@rakefile      = PROJECT_DIR + 'Rakefile'
 		@manifest_file = DEFAULT_MANIFEST_FILE.dup
 		@project_files = self.read_manifest
 		@executables   = self.find_executables
@@ -202,6 +209,10 @@ class Rake::DevEiate < Rake::TaskLib
 	# The title of the library for things like docs, gemspec, etc.
 	attr_accessor :title
 
+	##
+	# The project's Rakefile
+	attr_pathname :rakefile
+
 	##
 	# The file that will be the main page of documentation
 	attr_pathname :readme_file
@@ -304,6 +315,13 @@ class Rake::DevEiate < Rake::TaskLib
 
 	### Set up a simple default task
 	def define_default_tasks
+
+		# task used to indicate that rake-deveiate has already been setup once; for
+		# global rakefiles.
+		task :deveiate do
+			# no-op
+		end
+
 		desc "The task that runs by default"
 		task( :default => :spec )
 
@@ -631,9 +649,13 @@ class Rake::DevEiate < Rake::TaskLib
 		case File.extname( filename )
 		when '.md' then return '#'
 		when '.rdoc' then return '='
-		else
-			raise "Don't know what header character is appropriate for %s" % [ filename ]
+		when ''
+			if filename == 'Rakefile'
+				return '#'
+			end
 		end
+
+		raise "Don't know what header character is appropriate for %s" % [ filename ]
 	end
 
 
@@ -661,6 +683,26 @@ class Rake::DevEiate < Rake::TaskLib
 	end
 
 
+	### Yield an IO to the block open to a file that will replace +filename+ if the
+	### block returns successfully.
+	def write_replacement_file( filename, **opts )
+		path = Pathname( filename ).expand_path
+		mode = path.stat.mode
+		owner = path.stat.uid
+		group = path.stat.gid
+
+		tmpfile = Tempfile.create( path.basename.to_s, **opts ) do |fh|
+			yield( fh )
+
+			newfile = Pathname( fh.path ).expand_path
+			newfile.rename( path )
+
+			path.chown( owner, group )
+			path.chmod( mode )
+		end
+	end
+
+
 	### Output debugging information about documentation.
 	def output_documentation_debugging
 		summary = self.extract_summary

data/lib/rake/deveiate/checks.rb

@@ -195,6 +195,6 @@ module Rake::DevEiate::Checks
 	end
 
 
-end # module Rake::DevEiate::Docs
+end # module Rake::DevEiate::Checks
 
 

data/lib/rake/deveiate/fixup.rb

@@ -0,0 +1,252 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'rake'
+require 'hglib'
+
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# Fixup and conversion tasks
+module Rake::DevEiate::Fixup
+	extend Rake::DSL
+
+
+	# Pattern for matching lines in the Manifest that shouldn't be there
+	MANIFEST_CRUFT_LINE = %r{
+		^(?:			# Match whole lines
+			changelog
+		)$
+	}xim
+
+	# Pathnames of Bundler-related files
+	BUNDLER_FILES = [
+		Rake::DevEiate::PROJECT_DIR + 'Gemfile',
+		Rake::DevEiate::PROJECT_DIR + 'Gemfile.lock',
+		Rake::DevEiate::PROJECT_DIR + 'Gemfile.devel',
+		Rake::DevEiate::PROJECT_DIR + 'Gemfile.devel.lock',
+	]
+
+	# Pathnames of legacy dependency files
+	LEGACY_DEPSFILES = [
+		Rake::DevEiate::PROJECT_DIR + '.gems',
+		Rake::DevEiate::PROJECT_DIR + '.rvm.gems',
+	]
+
+	# Gems to add to the 'development' group of the deps file
+	DEV_GEMDEPS = %w[
+		rake-deveiate
+		rdoc-generator-fivefish
+	]
+
+
+	### Define fixup tasks
+	def define_tasks
+		super if defined?( super )
+
+		self.define_hoe_fixup_tasks
+	end
+
+
+	### Set up tasks that check for poor whitespace discipline
+	def define_hoe_fixup_tasks
+
+		desc "Perform various fixup tasks on the current project."
+		task :fixup => 'fixup:all'
+
+		namespace :fixup do
+
+			task :all => [
+				:rakefile,
+				:manifest,
+				:bundler,
+				:depsfiles,
+			]
+
+			desc "Remove hoe from the Rakefile and re-generate it"
+			task :rakefile, &method( :do_fixup_rakefile )
+
+
+			desc "Clean up cruft from the manifest file"
+			task :manifest, &method( :do_fixup_manifest )
+
+
+			desc "Remove Bundler-related files"
+			task :bundler, &method( :do_fixup_bundler )
+
+
+			desc "Fix up dependencies file/s"
+			task :depsfiles, &method( :do_fixup_legacy_depsfiles )
+
+		end
+
+		task :fixup_debug, &method( :do_fixup_debug )
+		task :debug => :fixup_debug
+	end
+
+
+
+	### Task function -- output debugging for fixup tasks.
+	def do_fixup_debug( task, args )
+		fixups = []
+
+		fixups << "De-hoeify the Rakefile" if self.rakefile_needs_hoe_fixup?
+		fixups << "Remove cruft from the manifest" if self.manifest_needs_fixup?
+		fixups << "Remove bundler files" if self.bundler_files_present?
+		fixups << "Convery legacy dependency files" if self.legacy_deps_files_present?
+
+		self.prompt.say( "Fixups available:", color: :bright_green )
+
+		if fixups.empty?
+			self.prompt.say( "None; project looks clean." )
+		else
+			fixups.each do |desc|
+				self.prompt.say "[ ] %s" % [ desc ]
+			end
+		end
+
+		self.prompt.say( "\n" )
+	end
+
+
+	### Return +true+ if the Rakefile in the current project directory needs to be
+	### cleaned up.
+	def rakefile_needs_hoe_fixup?
+		return false unless self.rakefile.exist? && !self.rakefile.zero?
+		return self.rakefile.read.split( /^__END__/m, 2 ).first.match?( /hoe/i )
+	end
+
+
+	### Returns +true+ if the manifest file has crufty lines in it.
+	def manifest_needs_fixup?
+		return false unless self.manifest_file.exist?
+		return self.manifest_file.each_line.any?( MANIFEST_CRUFT_LINE )
+	end
+
+
+	### Return +true+ if there are Bundler-related files in the project.
+	def bundler_files_present?
+		return BUNDLER_FILES.any?( &:exist? )
+	end
+
+
+	### Return +true+ if there are legacy dependency files in the project
+	def legacy_deps_files_present?
+		return LEGACY_DEPSFILES.any?( &:exist? )
+	end
+
+
+	### Replace the current Rakefile with a generated one of it is a Hoe-based one.
+	def do_fixup_rakefile( task, * )
+		unless self.rakefile_needs_hoe_fixup?
+			self.trace "Not a hoe-based Rakefile; skipping"
+			return
+		end
+
+		original = self.rakefile.read
+
+		self.write_replacement_file( self.rakefile, encoding: 'utf-8' ) do |fh|
+
+			self.trace "Re-generating Rakefile from a template"
+			template = Rake::DevEiate::Generate::RAKEFILE_TEMPLATE
+			boilerplate = self.load_and_render_template( template, 'Rakefile' )
+			fh.print( boilerplate )
+
+			self.trace "Appending the old Rakefile contents in an END section"
+			fh.puts
+			fh.puts "__END__"
+			fh.puts
+			fh.print( original )
+		end
+	end
+
+
+	### Clean up cruft from the manifest file.
+	def do_fixup_manifest( task, * )
+		unless self.manifest_needs_fixup?
+			self.trace "Manifest is clean; skipping"
+			return
+		end
+
+		self.write_replacement_file( self.manifest_file, encoding: 'utf-8' ) do |fh|
+			self.trace "Removing cruft from the manifest"
+			self.manifest_file.each_line do |line|
+				next if line.match?( MANIFEST_CRUFT_LINE )
+				fh.puts( line )
+			end
+		end
+	end
+
+
+	### Remove any bundler-related files.
+	def do_fixup_bundler( task, * )
+		BUNDLER_FILES.each do |file|
+			next unless file.exist?
+			self.trace "Removing bundler file %s..." % [ file ]
+			self.hg.rm( file, force: true )
+		end
+	end
+
+
+	### Convert legacy dependency files to the newer form.
+	def do_fixup_legacy_depsfiles( task, * )
+		unless self.legacy_deps_files_present?
+			self.trace "No legacy dependency files; skipping"
+			return
+		end
+
+		new_depsfile = Rake::DevEiate::GEMDEPS_FILE
+
+		LEGACY_DEPSFILES.each do |depsfile|
+			next unless depsfile.readable?
+
+			if new_depsfile.exist?
+				self.hg.rm( depsfile )
+			else
+				depnames = depsfile.each_line.map do |line|
+					line.split( /\s+/, 2 ).first
+				end
+
+				raise "Failed to read dependencies from %s!" % [ depsfile ] if depnames.empty?
+
+				self.trace "Recording move of %s to %s" % [ depsfile, new_depsfile ]
+				self.hg.mv( depsfile, new_depsfile )
+
+				newest_deps = self.find_latest_versions( *depnames ).
+					reject {|tuple| tuple.name.include?('hoe') }
+				dev_deps = self.find_latest_versions( *DEV_GEMDEPS )
+
+				self.write_replacement_file( new_depsfile, encoding: 'utf-8' ) do |fh|
+					fh.puts "source 'https://rubygems.org/'"
+					fh.puts
+
+					newest_deps.each do |dep|
+						fh.puts "gem '%s', '%s'" %
+							[ dep.name, dep.version.approximate_recommendation ]
+					end
+
+					fh.puts
+					fh.puts "group :development do"
+					dev_deps.each do |dep|
+						fh.puts "\tgem '%s', '%s'" %
+							[ dep.name, dep.version.approximate_recommendation ]
+					end
+					fh.puts "end"
+				end
+			end
+		end
+	end
+
+
+	### Find the latest version for the specified +gemnames+ and return them as Gem::Specifiations
+	def find_latest_versions( *gemnames )
+		pattern = /\A#{Regexp.union(gemnames)}\Z/
+		fetcher = Gem::SpecFetcher.fetcher
+		return fetcher.
+			detect( :latest ) {|tuple| pattern =~ tuple.name && tuple.platform == 'ruby' }.
+			transpose.first
+	end
+
+end # module Rake::DevEiate::Fixups
+
+

data/lib/rake/deveiate/generate.rb

@@ -12,6 +12,7 @@ module Rake::DevEiate::Generate
 
 
 	# Template files
+	RAKEFILE_TEMPLATE = 'Rakefile.erb'
 	README_TEMPLATE = 'README.erb'
 	HISTORY_TEMPLATE = 'History.erb'
 
@@ -27,12 +28,14 @@ module Rake::DevEiate::Generate
 	def define_tasks
 		super if defined?( super )
 
+		file( self.rakefile.to_s )
 		file( self.readme_file.to_s )
 		file( self.history_file.to_s )
 		file( self.manifest_file.to_s )
 		file( RUBY_VERSION_FILE.to_s )
 		file( GEMSET_FILE.to_s )
 
+		task( self.rakefile, &method(:do_generate_rakefile) )
 		task( self.readme_file, &method(:do_generate_readme_file) )
 		task( self.history_file, &method(:do_generate_history_file) )
 		task( self.manifest_file, &method(:do_generate_manifest_file) )
@@ -41,6 +44,7 @@ module Rake::DevEiate::Generate
 
 		desc "Generate any missing project files."
 		task :generate => [
+			self.rakefile,
 			self.readme_file,
 			self.history_file,
 			self.manifest_file,
@@ -48,11 +52,26 @@ module Rake::DevEiate::Generate
 			GEMSET_FILE,
 		]
 
+		# Abstract named tasks; mostly for invoking programmatically
+		namespace :generate do
+			task :rakefile => self.rakefile
+			task :readme => self.readme_file
+			task :history_file => self.history_file
+			task :manifest => self.manifest_file
+			task :ruby_version_file => RUBY_VERSION_FILE
+			task :gemset_file => GEMSET_FILE
+		end
+
 		desc "Diff the manifest file against the default set of project files."
 		task( :diff_manifest, &method(:do_diff_manifest) )
 	end
 
 
+	### Generate a Rakefile if one doesn't already exist. Error if one does.
+	def do_generate_rakefile( task, args )
+		self.generate_from_template( task.name, RAKEFILE_TEMPLATE )
+	end
+
 
 	### Generate a README file if one doesn't already exist. Error if one does.
 	def do_generate_readme_file( task, args )
@@ -110,11 +129,11 @@ module Rake::DevEiate::Generate
 	def generate_from_template( filename, template_path )
 		self.prompt.ok "Generating #{filename}..."
 		File.open( filename, FILE_CREATION_FLAGS, 0644, encoding: 'utf-8' ) do |io|
-			result = self.load_and_render_template( template_path )
+			result = self.load_and_render_template( template_path, filename )
 			io.print( result )
 		end
 	end
 
-end # module Rake::DevEiate::Hg
+end # module Rake::DevEiate::Generate
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake-deveiate
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   jBZSA+N+xUTgUWpXjjwsLZjzJkhWATJWq+krNXcqpwXo6HsjmdUxoFMt63RBb+sI
   XrxOxp8o0uOkU7FdLSGsyqJ2LzsR4obN
   -----END CERTIFICATE-----
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2020-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: hglib
   requirement: !ruby/object:Gem::Requirement
@@ -174,9 +188,12 @@ files:
 - README.md
 - data/rake-deveiate/History.erb
 - data/rake-deveiate/README.erb
+- data/rake-deveiate/Rakefile.erb
+- data/rake-deveiate/global.rake
 - lib/rake/deveiate.rb
 - lib/rake/deveiate/checks.rb
 - lib/rake/deveiate/docs.rb
+- lib/rake/deveiate/fixup.rb
 - lib/rake/deveiate/gem_dep_finder.rb
 - lib/rake/deveiate/gemspec.rb
 - lib/rake/deveiate/generate.rb