rake-deveiate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53275d426cc35203e19ffb6354a49628d385b4b457b312863f98de52c1c205ae
+  data.tar.gz: 9cc9b5659a6612aef89b69d153777ac1f2c29fb9ad8504c4e80d66dfc295243a
+SHA512:
+  metadata.gz: 305c88f5e61673c7b898ac213daff8bb6013b0a9ea243c4eb46b175ea59f44e2913d0b632782a38f1f211a6afe9ac0dc640febfb3915564916c7dd22a99cebc2
+  data.tar.gz: 063f316622af921ba648aaf65ebf65efd486f71c17fedae4baab90e95c2a82eb6c407350984711c8d7b8084bc6ae6742d9d6ddd5de3e6e6b0a35903010405a85

data/History.md

@@ -0,0 +1,7 @@
+# Release History for rake-deveiate
+
+---
+
+## v0.1.0 [2019/10/02] Michael Granger <ged@FaerieMUD.org>
+
+First release.

data/README.md

@@ -0,0 +1,84 @@
+# Rake Tasks for DevEiate Libraries
+
+home
+: https://hg.sr.ht/~ged/rake-deveiate
+
+github
+: https://github.com/ged/rake-deveiate
+
+docs
+: https://deveiate.org/code/rake-deveiate/
+
+
+## Description
+
+This is a collection of Rake tasks I use for development. I distribute them as
+a gem mostly so people who wish to contribute to the other Open Source
+libraries I maintain can do so easily, but of course you're welcome to use them
+yourself if you find them useful.
+
+
+## Prerequisites
+
+* Ruby 2.6+
+
+
+## Installation
+
+    $ gem install rake-deveiate
+
+
+## Usage
+
+Make a Rakefile with the following content:
+
+    require 'rake/deveiate'
+    
+    Rake::DevEiate.setup( 'gemname' )
+
+You can also pass a block to customize the project settings:
+
+    Rake::DevEiate.setup( 'gemname' ) do |project|
+        project.description = <<~END_DESC
+          This is a gem that does some stuff. It does a few things well, a lot of
+          things sufficiently, and nothing badly.
+        END_DESC
+        project.authors = [ 'J. Random Hacker <jrandom@example.com>' ]
+    end
+
+
+
+## Authors
+
+- Michael Granger <ged@FaerieMUD.org>
+
+
+## License
+
+Copyright (c) 2019, Michael Granger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/data/rake-deveiate/History.erb

@@ -0,0 +1,5 @@
+<%= header_char %> Release History for <%= project.name %>
+
+---
+
+

data/data/rake-deveiate/README.erb

@@ -0,0 +1,64 @@
+<%= header_char %> <%= project.name.gsub(/\b([a-z])/) {|m| m.upcase } %>
+
+home
+: https://hg.sr.ht/~ged/<%= project.name %>
+
+github
+: https://github.com/ged/<%= project.name %>
+
+docs
+: https://deveiate.org/code/<%= project.name %>
+
+
+<%= header_char * 2 %> Description
+
+A gem of some sort.
+
+
+<%= header_char * 2 %> Prerequisites
+
+* Ruby <%= RUBY_VERSION.sub(/\.\d+$/, '') %>
+
+
+<%= header_char * 2 %> Installation
+
+    $ gem install <%= project.name %>
+
+
+<%= header_char * 2 %> Authors
+
+<% project.authors.each do |author| -%>
+- <%= author %>
+<% end -%>
+
+
+<%= header_char * 2 %> License
+
+Copyright (c) <%= Date.today.year %>, <%= project.author_names.join(' and ') %>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/lib/rake/deveiate/checks.rb

@@ -0,0 +1,200 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'rake'
+
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# Sanity and quality check tasks
+module Rake::DevEiate::Checks
+	extend Rake::DSL
+
+	# Emoji for style advisories
+	SADFACE = "\u{1f622}"
+
+	# Tab-arrow character
+	TAB_ARROW = "\u{21e5}"
+
+	# Regexp to match trailing whitespace
+	TRAILING_WHITESPACE_RE = /\p{Blank}+$/m
+
+	# Regexp to match lines with mixed indentation
+	MIXED_INDENT_RE = /(?<!#)([ ]\t)/
+
+
+	### Set up task defaults
+	def setup( _name, **options )
+		super if defined?( super )
+
+		@quality_check_whitelist = Rake::FileList.new
+	end
+
+
+	##
+	# The Rake::FileList containing files which should not be quality-checked.
+	attr_reader :quality_check_whitelist
+
+
+	### Define check tasks
+	def define_tasks
+		super if defined?( super )
+
+		self.define_quality_checker_tasks
+		self.define_sanity_checker_tasks
+
+		desc "Run several quality-checks on the code"
+		task :quality_checks => [ 'quality_checks:all' ]
+
+		desc "Run several sanity-checks on the code"
+		task :sanity_checks => [ 'sanity_checks:all' ]
+
+		task :check => [ :quality_checks, :sanity_checks ]
+
+	end
+
+
+	### Set up tasks that check for poor whitespace discipline
+	def define_quality_checker_tasks
+
+		namespace :quality_checks do
+
+			task :all => [ :whitespace ]
+
+			desc "Check source code for inconsistent whitespace"
+			task :whitespace => [
+				:for_trailing_whitespace,
+				:for_mixed_indentation,
+			]
+
+			desc "Check source code for trailing whitespace"
+			task :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 :for_mixed_indentation do
+				lines = find_matching_source_lines do |line, _|
+					line =~ MIXED_INDENT_RE
+				end
+
+				unless lines.empty?
+					desc = "Found mixed indentation"
+					describe_lines_that_need_fixing( desc, lines, /[ ]\t/ )
+					fail
+				end
+			end
+
+		end
+
+	end
+
+
+	### Set up some sanity-checks as dependencies of higher-level tasks
+	def define_sanity_checker_tasks
+
+		namespace :sanity_checks do
+
+			desc "Check source code for common problems"
+			task :all
+
+		end
+
+	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 = self.project_files.grep( /\.(h|c|rb)$/ )
+		source_files -= self.quality_check_whitelist
+
+		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 )
+		self.prompt.say "\n"
+		self.prompt.say SADFACE + "  "
+		self.prompt.error( "Uh-oh! " + description )
+
+		grouped_lines = group_line_matches( lines )
+
+		grouped_lines.each do |filename, linegroups|
+			linegroups.each do |group, lines|
+				if group.min == group.max
+					self.prompt.say( "%s:%d" % [ filename, group.min ], color: :bold )
+				else
+					self.prompt.say( "%s:%d-%d" % [ filename, group.min, group.max ], color: :bold )
+				end
+
+				lines.each_with_index do |line, i|
+					self.prompt.say "%s: %s" % [
+						self.pastel.dark.white( group.to_a[i].to_s ),
+						highlight_problems( line, re )
+					]
+				end
+				self.prompt.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|
+			last_linenum = 0
+			linegroups = lines.slice_before do |filename, linenum|
+				gap = linenum > last_linenum + 1
+				last_linenum = linenum
+				gap
+			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 )    { self.pastel.on_red( $& ) }.
+			gsub( /\t+/ ) { self.pastel.dark.white( "#{TAB_ARROW}   " * $&.length ) }
+	end
+
+
+end # module Rake::DevEiate::Docs
+
+

data/lib/rake/deveiate/docs.rb

@@ -0,0 +1,34 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/phony'
+require 'rdoc/task'
+
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# Documentation-generation tasks
+module Rake::DevEiate::Docs
+	extend Rake::DSL
+
+
+	### Define documentation tasks
+	def define_tasks
+		super if defined?( super )
+
+		task :docs => :phony
+
+		RDoc::Task.new( 'docs' ) do |rdoc|
+			rdoc.main = self.readme_file.to_s
+			rdoc.rdoc_files = self.rdoc_files
+			rdoc.generator = :fivefish
+			rdoc.title = self.title
+			rdoc.rdoc_dir = Rake::DevEiate::DOCS_DIR.to_s
+		end
+
+	end
+
+end # module Rake::DevEiate::Docs
+
+

data/lib/rake/deveiate/gem_dep_finder.rb

@@ -0,0 +1,97 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'set'
+require 'rubygems'
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# A dependency finder that groks the GemDependencyApi
+class Rake::DevEiate::GemDepFinder
+
+	### Create a new GemDepFinder that will find dependencies in the given
+	### +depfile+.
+	def initialize( depfile )
+		@depfile = Pathname( depfile )
+		@dependencies = Set.new
+		@current_groups = Set.new
+	end
+
+
+
+	######
+	public
+	######
+
+	##
+	# The Pathname of the file to find dependencies in
+	attr_reader :depfile
+
+	##
+	# The Set of Gem::Dependency objects that describe the loaded dependencies
+	attr_reader :dependencies
+
+	##
+	# The current set of groups to add to any declared gems
+	attr_reader :current_groups
+
+
+	### Load the dependencies file.
+	def load
+		source = self.depfile.read
+		self.instance_eval( source, self.depfile.to_s, 1 )
+	end
+
+
+	#
+	# Gem Dependency API methods
+	#
+
+
+	### Declare a dependency on a gem. Ignores every option except :group.
+	def gem( name, *requirements, **options )
+		if options[:group] == :development ||
+			options[:groups]&.include?( :development ) ||
+			self.current_groups.include?( :development )
+
+			requirements.push( :development )
+		end
+
+		dependency = Gem::Dependency.new( name, *requirements )
+
+		self.dependencies.add( dependency )
+	end
+
+
+	### Declare a group block.
+	def group( *names )
+		options = names.pop if names.last.is_a?( Hash )
+		previous_groups = self.current_groups.dup
+		self.current_groups.replace( names )
+
+		yield
+	ensure
+		self.current_groups.replace( previous_groups ) if previous_groups
+	end
+
+
+	### Raise, as the gemdeps file should be the authoritative source.
+	def gemspec( * )
+		raise "Circular dependency: can't depend on the gemspec to build itself"
+	end
+
+
+	### Ignore a gem dependency API call.
+	def no_op_method( * ) # :nodoc:
+		yield if block_given?
+	end
+
+	alias_method :source, :no_op_method
+	alias_method :git, :no_op_method
+	alias_method :platform, :no_op_method
+	alias_method :platforms, :no_op_method
+	alias_method :ruby, :no_op_method
+
+
+end # class Rake::DevEiate::GemDepFinder
+

data/lib/rake/deveiate/gemspec.rb

@@ -0,0 +1,177 @@
+# -*- ruby -*-
+# frozen_string_literal: true
+
+require 'etc'
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/deveiate' unless defined?( Rake::DevEiate )
+
+
+# Gemspec-generation tasks
+module Rake::DevEiate::Gemspec
+	extend Rake::DSL
+
+	# Pattern for splitting parsed authors list items into name and email
+	AUTHOR_PATTERN = /^(?<name>.*)\s<(?<email>.*)>$/
+
+
+	##
+	# The path to the file used to sign released gems
+	attr_accessor :signing_key
+
+
+	### Set some defaults when the task lib is set up.
+	def setup( _name, **options )
+		super if defined?( super )
+
+		@signing_key = options[:signing_key] || Gem.default_key_path
+
+		@gemspec = nil
+	end
+
+
+	### Reset any cached data when project attributes change.
+	def reset
+		super if defined?( super )
+		@gemspec = nil
+	end
+
+
+	### Define gemspec tasks
+	def define_tasks
+		super if defined?( super )
+
+		gemspec_file = "#{self.name}.gemspec"
+
+		if self.has_manifest?
+			file( self.manifest_file )
+			file( gemspec_file => self.manifest_file )
+		else
+			file( gemspec_file )
+		end
+
+		task( gemspec_file ) do |task|
+			self.prompt.say "Updating gemspec"
+
+			spec = self.make_prerelease_gemspec
+
+			File.open( task.name, 'w' ) do |fh|
+				fh.write( spec.to_ruby )
+			end
+		end
+
+		desc "(Re)Generate the gemspec file"
+		task :gemspec => gemspec_file
+
+		CLEAN.include( gemspec_file.to_s )
+
+		task :checkin => :gemspec
+
+		task( :gemspec_debug, &method(:do_gemspec_debug) )
+		task :debug => :gemspec_debug
+	end
+
+
+	### Task function -- output debugging for gemspec tasks.
+	def do_gemspec_debug( task, args )
+		gemspec = self.gemspec
+		gemspec_src = gemspec.to_yaml
+
+		self.prompt.say( "Gemspec:", color: :bright_green )
+		self.prompt.say( indent(gemspec_src, 4) )
+		self.prompt.say( "\n" )
+	end
+
+
+	### Return the project's Gem::Specification, creating it if necessary.
+	def gemspec
+		return @gemspec ||= self.make_gemspec
+	end
+
+
+	### Validate the gemspec, raising a Gem::InvalidSpecificationException if it's
+	### not valid.
+	def validate_gemspec( packaging=true, strict=false )
+		return self.gemspec.validate( packaging, strict )
+	end
+
+
+	### Return a Gem::Specification created from the project's metadata.
+	def make_gemspec
+		spec = Gem::Specification.new
+
+		spec.name         = self.name
+		spec.description  = self.description
+		spec.homepage     = self.homepage
+		spec.summary      = self.summary || self.extract_summary
+		spec.files        = self.project_files
+		spec.signing_key  = self.resolve_signing_key.to_s
+		spec.cert_chain   = self.cert_files.map( &File.method(:expand_path) ).to_a
+		spec.version      = self.version
+		spec.licenses     = self.licenses
+		spec.date         = Date.today
+
+		self.authors.each do |author|
+			if ( m = author.match(AUTHOR_PATTERN) )
+				spec.authors ||= []
+				spec.authors << m[:name]
+				spec.email ||= []
+				spec.email << m[:email] if m[:email]
+			else
+				self.prompt.warn "Couldn't extract author name + email from %p" % [ author ]
+			end
+		end
+
+		self.dependencies.each do |dep|
+			if dep.runtime?
+				spec.add_runtime_dependency( dep )
+			else
+				spec.add_development_dependency( dep )
+			end
+		end
+
+		return spec
+	end
+
+
+	### Return a Gem::Specification with its properties modified to be suitable for
+	### a pre-release gem.
+	def make_prerelease_gemspec
+		spec = self.make_gemspec
+
+		spec.version     = self.prerelease_version
+		spec.signing_key = nil
+		spec.cert_chain  = []
+
+		return spec
+	end
+
+
+	### Return a version string
+	def prerelease_version
+		return "#{self.version.bump}.0.pre.#{Time.now.strftime("%Y%m%d%H%M%S")}"
+	end
+
+
+	### Resolve the path of the signing key
+	def resolve_signing_key
+		path = Pathname( self.signing_key ).expand_path
+		path = path.readlink if path.symlink?
+		return path
+	end
+
+
+	#######
+	private
+	#######
+
+	### Return a copy of the given text prefixed by +spaces+ number of spaces.
+	def indent( text, spaces=4 )
+		prefix = ' ' * spaces
+		return text.gsub( /(?<=\A|\n)/m, prefix )
+	end
+
+end # module Rake::DevEiate::Gemspec
+
+