hoe-highline 0.0.1

data/ChangeLog

@@ -0,0 +1,26 @@
+2011-03-12  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.0.1 for changeset f9a3499e47b2
+	[6cb01cee05f5] [master, tip]
+
+	* .hgsigs:
+	Added signature for changeset 4a7fd6f5e4ce
+	[f9a3499e47b2] [v0.0.1]
+
+	* README.md, Rakefile:
+	Fixed some README and demo stuff.
+	[4a7fd6f5e4ce]
+
+	* Rakefile:
+	Added dependency on Hoe itself.
+	[09a1581eede1] [github/master]
+
+	* .autotest:
+	Remove unused autotest config
+	[611cdca315db]
+
+	* .autotest, History.md, Manifest.txt, README.md, Rakefile,
+	lib/hoe/highline.rb:
+	Initial version
+	[12c9e44f7d0e]

data/History.md

@@ -0,0 +1,4 @@
+## 0.0.1 [2011-01-23] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/README.md

@@ -0,0 +1,179 @@
+# hoe_highline
+
+* https://bitbucket.org/ged/hoe-highline
+* https://github.com/ged/hoe-highline
+
+## Description
+
+A Hoe plugin for building interactive Rake tasks.
+
+Hoe-highline, as you might have guessed from the name, adds prompting and
+displaying functions from the [HighLine][highline] gem to your Rake
+environment, allowing you to ask questions, prompt for passwords, build menus,
+and other fun stuff.
+
+
+## Installation
+
+    gem install hoe-highline
+
+
+## Usage
+
+	# in your Rakefile
+
+	Hoe.plugin :highline
+
+	Hoe.spec 'mygem' do
+
+		# Configure the highline terminal to your liking
+		highline.wrap_at = :auto  # Auto-wrap output
+
+	end
+
+	# Generate an email, show it, confirm they want to send it, then prompt
+	# for a SMTP connection information before sending
+	task :send_email do
+		message = generate_email( :full )
+		say "About to send this:"
+		say( mail )
+
+		if agree( "Okay to send it? " )
+			require 'socket'
+			require 'net/smtp'
+			require 'etc'
+
+			username = ask( "Email username: " ) do |q|
+				q.default = Etc.getlogin  # default to the current user
+			end
+			password = ask( "Email password: " ) do |q|
+				q.echo = '*'  # Hide the password
+			end
+
+			say "Creating SMTP connection to #{SMTP_HOST}:#{SMTP_PORT}"
+			smtp = Net::SMTP.new( SMTP_HOST, SMTP_PORT )
+			smtp.set_debug_output( $stderr )
+			smtp.esmtp = true
+			smtp.enable_starttls
+
+			helo = Socket.gethostname
+			smtp.start( helo, username, password, :plain ) do |smtp|
+				smtp.send_message( message, email_from, *email_to )
+			end
+		else
+			abort "Okay, aborting."
+		end
+	end
+
+There is also a 'demo' task in this library's Rakefile that has a few ideas for things you might want to do. Running it looks like this:
+
+	hoe-highline Demo
+
+	You can prompt for a yes-or-no answer with agree()
+	Know what I mean (nudge, nudge, wink, wink)? [yn] y
+	What's it like?
+
+	You can ask for input with ask()
+	What could be better than that? Nothing!
+	Actually, that was a rhetorical question, but you answered: "Nothing!"
+
+	You can also ask() for things like passwords with a little configuration
+	Super sekrit password: **********
+	Okay, using your 10-character password for something nefarious...
+
+	You can also use choose() for building a menu.
+	What editor do you prefer?
+	1. Emacs
+	2. vi
+	3. Textmate
+	4. pico
+	5. RubyMine
+	6. FreeRIDE
+	?  3
+	Good to know (you picked "Textmate").
+
+	Or build a complex menu using a block.
+	Announce a new release:
+	1. ruby-talk
+	2. Blog
+	3. Twitter
+	4. Exit
+	?  2
+	Posting to blog.you.com!
+	1. ruby-talk
+	2. Twitter
+	3. Exit
+	?  1
+	Sending mail!
+	1. Twitter
+	2. Exit
+	?  2
+
+	There is also a list() function for display stuff in a compact list
+	For example, here's a list of the available tasks:
+	.hg/branch                    ChangeLog
+	check_extra_deps              check_manifest
+	clobber                       clobber_docs
+	commit-msg.txt                config_hoe
+	default                       demo
+	deps:list                     doc
+	gem                           generate_key
+	hg:ci                         hg:commit
+	hg:prep_release               hg:pull
+	hg:push_without_confirmation  hg:update
+	newb                          package
+	pkg/hoe-highline-0.0.1.gem    pkg/hoe-highline-0.0.1.tgz
+	pre                           prerelease
+	rcov                          rcov_overlay
+	release_sanity                release_to
+	ridocs                      
+
+## Contributing
+
+You can check out the current development source with Mercurial via its
+[Bitbucket project][bitbucket]. Or if you prefer Git, via 
+[its Github mirror][github].
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+## License
+
+Copyright (c) 2011, 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.
+
+
+[highline]: http://highline.rubyforge.org/
+[bitbucket]: https://bitbucket.org/ged/hoe-highline
+[github]: https://github.com/ged/ruby-openldap
+

data/Rakefile

@@ -0,0 +1,142 @@
+#!/usr/bin/env rake
+
+require 'hoe'
+
+Hoe.add_include_dirs 'lib'
+
+Hoe.plugin :highline
+Hoe.plugin :mercurial
+Hoe.plugin :signing
+
+Hoe.plugins.delete :rubyforge
+
+hoespec = Hoe.spec 'hoe-highline' do
+	self.readme_file = 'README.md'
+	self.history_file = 'History.md'
+
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+
+	self.extra_deps.push *{
+		'highline' => '~> 1.6',
+		'hoe' => '~> 2.8',
+	}
+
+	self.spec_extras[:licenses] = ["BSD"]
+	self.spec_extras[:signing_key] = '/Volumes/Keys/ged-private_gem_key.pem'
+
+	self.require_ruby_version( '>=1.8.7' )
+
+	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+
+	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+
+	if self.respond_to?( :highline )
+		self.highline.wrap_at = :auto
+	else
+		abort "Ack! The plugin doesn't seem to be loaded; that won't do at all."
+	end
+end
+
+
+desc "A series of demos of how this plugin can be used"
+task :demo do
+	say "<%= color 'hoe-highline Demo', :header %>"
+
+	say "\n<%= color 'You can prompt for a yes-or-no answer with agree()', :subheader %>"
+	if agree "Know what I mean (nudge, nudge, wink, wink)? <%= color '[yn]', :values %> ", true
+		say "What's it like?"
+	else
+		say "Ah, more's the pity."
+	end
+
+	say "\n<%= color 'You can ask for input with ask()', :subheader %>"
+	result = ask "What could be better than that? "
+	say "Actually, that was a rhetorical question, but you answered: %p" % [ result ]
+
+	say "\n<%= color 'You can also ask() for things like passwords with a little " +
+	    "configuration', :subheader %>"
+	result = ask( "Super sekrit password: " ) {|q| q.echo = color("*", :warning) }
+	say "Okay, using your %d-character password for something nefarious..." % [ result.length ]
+
+	say "\n<%= color 'You can also use choose() for building a menu.', :subheader %>"
+	say "What editor do you prefer?"
+	choice = choose( 'Emacs', 'vi', 'Textmate', 'pico', 'RubyMine', 'FreeRIDE' )
+	say "Good to know (you picked %p)." % [ choice ]
+
+	say "\n<%= color 'Or build a complex menu using a block.', :subheader %>"
+	say "Announce a new release:"
+	done = false
+	remaining = [ :mail, :blog, :twitter ]
+	until done || remaining.empty?
+		choose do |menu|
+			menu.choice( "ruby-talk" ) do
+				say "Sending mail!"
+				remaining.delete( :mail )
+			end if remaining.include?( :mail )
+
+			menu.choice( "Blog" ) do
+				say "Posting to blog.you.com!"
+				remaining.delete( :blog )
+			end if remaining.include?( :blog )
+
+			menu.choice( "Twitter" ) do
+				say "Twerp! Twerp!"
+				remaining.delete( :twitter )
+			end if remaining.include?( :twitter )
+
+			menu.choice( "Exit" ) do
+				done = true
+			end
+		end
+	end
+
+	say "\n<%= color 'There is also a list() function for display stuff in a compact " +
+	    "list', :subheader %>"
+	say "For example, here's a list of the available tasks:"
+	say list( Rake.application.tasks.map(&:to_s), :columns_across )
+
+end
+
+
+ENV['VERSION'] ||= hoespec.spec.version.to_s
+
+begin
+	include Hoe::MercurialHelpers
+
+	### Task: prerelease
+	desc "Append the package build number to package versions"
+	task :pre do
+		rev = get_numeric_rev()
+		trace "Current rev is: %p" % [ rev ]
+		hoespec.spec.version.version << "pre#{rev}"
+		Rake::Task[:gem].clear
+
+		Gem::PackageTask.new( hoespec.spec ) do |pkg|
+			pkg.need_zip = true
+			pkg.need_tar = true
+		end
+	end
+
+	### Make the ChangeLog update if the repo has changed since it was last built
+	file '.hg/branch'
+	file 'ChangeLog' => '.hg/branch' do |task|
+		$stderr.puts "Updating the changelog..."
+		content = make_changelog()
+		File.open( task.name, 'w', 0644 ) do |fh|
+			fh.print( content )
+		end
+	end
+
+	# Rebuild the ChangeLog immediately before release
+	task :prerelease => 'ChangeLog'
+
+rescue NameError => err
+	task :no_hg_helpers do
+		fail "Couldn't define the :pre task: %s: %s" % [ err.class.name, err.message ]
+	end
+
+	task :pre => :no_hg_helpers
+	task 'ChangeLog' => :no_hg_helpers
+
+end
+

data/lib/hoe/highline.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'hoe'
+require 'highline'
+require 'forwardable'
+
+# Add Highline command-line interaction functions to Hoe Rakefiles.
+# 
+# @author Michael Granger <ged@FaerieMUD.org>
+# 
+module Hoe::Highline
+	extend Forwardable
+
+	# Library version constant
+	VERSION = '0.0.1'
+
+	# Version-control revision constant
+	REVISION = %q$Revision: 12c9e44f7d0e $
+
+	# HighLine color scheme
+	COLOR_SCHEME = {
+		:header    => [ :bold, :yellow ],
+		:subheader => [ :bold, :white ],
+		:values    => [ :bold, :white ],
+		:error     => [ :red ],
+		:warning   => [ :yellow ],
+		:message   => [ :reset ],
+	}
+
+
+	# The HighLine object used for prompting
+	attr_accessor :highline
+
+
+	### Set up the plugin's instance variables.
+	def initialize_highline
+		HighLine.color_scheme = HighLine::ColorScheme.new( COLOR_SCHEME )
+		@highline = HighLine.new( $stdin, $stderr )
+
+		self.extra_dev_deps << ['hoe-highline', "~> #{VERSION}"] unless
+			self.name == 'hoe-highline'
+	end
+
+
+	### Hoe hook -- add the Highline functions to Kernel when the plugin is
+	### loaded.
+	def define_highline_tasks
+		$terminal = self.highline
+
+		::Kernel.extend( Forwardable )
+		::Kernel.def_delegators :$terminal, :agree, :ask, :choose, :color, :list, :say
+	end
+
+
+end # module Hoe::Highline
+

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification 
+name: hoe-highline
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Granger
+autorequire: 
+bindir: bin
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDLDCCAhSgAwIBAgIBADANBgkqhkiG9w0BAQUFADA8MQwwCgYDVQQDDANnZWQx
+  FzAVBgoJkiaJk/IsZAEZFgdfYWVyaWVfMRMwEQYKCZImiZPyLGQBGRYDb3JnMB4X
+  DTEwMDkxNjE0NDg1MVoXDTExMDkxNjE0NDg1MVowPDEMMAoGA1UEAwwDZ2VkMRcw
+  FQYKCZImiZPyLGQBGRYHX2FlcmllXzETMBEGCgmSJomT8ixkARkWA29yZzCCASIw
+  DQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALy//BFxC1f/cPSnwtJBWoFiFrir
+  h7RicI+joq/ocVXQqI4TDWPyF/8tqkvt+rD99X9qs2YeR8CU/YiIpLWrQOYST70J
+  vDn7Uvhb2muFVqq6+vobeTkILBEO6pionWDG8jSbo3qKm1RjKJDwg9p4wNKhPuu8
+  KGue/BFb67KflqyApPmPeb3Vdd9clspzqeFqp7cUBMEpFS6LWxy4Gk+qvFFJBJLB
+  BUHE/LZVJMVzfpC5Uq+QmY7B+FH/QqNndn3tOHgsPadLTNimuB1sCuL1a4z3Pepd
+  TeLBEFmEao5Dk3K/Q8o8vlbIB/jBDTUx6Djbgxw77909x6gI9doU4LD5XMcCAwEA
+  AaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJeoGkOr9l4B
+  +saMkW/ZXT4UeSvVMA0GCSqGSIb3DQEBBQUAA4IBAQBG2KObvYI2eHyyBUJSJ3jN
+  vEnU3d60znAXbrSd2qb3r1lY1EPDD3bcy0MggCfGdg3Xu54z21oqyIdk8uGtWBPL
+  HIa9EgfFGSUEgvcIvaYqiN4jTUtidfEFw+Ltjs8AP9gWgSIYS6Gr38V0WGFFNzIH
+  aOD2wmu9oo/RffW4hS/8GuvfMzcw7CQ355wFR4KB/nyze+EsZ1Y5DerCAagMVuDQ
+  U0BLmWDFzPGGWlPeQCrYHCr+AcJz+NRnaHCKLZdSKj/RHuTOt+gblRex8FAh8NeA
+  cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
+  -----END CERTIFICATE-----
+
+date: 2011-03-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 8
+        version: "2.8"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe-mercurial
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 1
+        - 2
+        - 1
+        version: 1.2.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 2
+        - 9
+        - 1
+        version: 2.9.1
+  type: :development
+  version_requirements: *id004
+description: |-
+  A Hoe plugin for building interactive Rake tasks.
+  
+  Hoe-highline, as you might have guessed from the name, adds prompting and
+  displaying functions from the [HighLine][highline] gem to your Rake
+  environment, allowing you to ask questions, prompt for passwords, build menus,
+  and other fun stuff.
+email: 
+- ged@FaerieMUD.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- ChangeLog
+- History.md
+- README.md
+- Rakefile
+- lib/hoe/highline.rb
+has_rdoc: true
+homepage: https://bitbucket.org/ged/hoe-highline
+licenses: 
+- BSD
+post_install_message: 
+rdoc_options: 
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hoe-highline
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A Hoe plugin for building interactive Rake tasks
+test_files: []
+