binman 1.0.0 → 1.1.0

data/HISTORY.markdown

@@ -1,3 +1,19 @@
+------------------------------------------------------------------------------
+Version 1.1.0 (2011-11-05)
+------------------------------------------------------------------------------
+
+Compatible changes:
+
+* The `binman/rake_tasks` library has been renamed (with deprecation) to
+  `binman/rakefile`.  The deprecation warning will be removed in the next
+  major release.
+
+New features:
+
+* Add `binman/gemspec` packaging convenience library which automatically
+  builds and includes your UNIX man page files in your gem packages and also
+  adds binman as a runtime and development gem dependency.
+
 ------------------------------------------------------------------------------
 Version 1.0.0 (2011-10-13)
 ------------------------------------------------------------------------------

data/README.markdown

@@ -87,13 +87,16 @@ Add the following line to your `Rakefile` and you've got a `binman` task!
 
 It will pre-build UNIX man page files for your `bin/` scripts into a `man/`
 directory so that your end-users do not need the markdown to roff converter
-installed in order to view your man pages!  Just remember to add the `man/`
-directory's contents to your gemspec or release package:
+installed in order to view your man pages!
 
-    Gem::Specification.new do |s|
-      # ... your stuff ...
-      s.files += Dir['man/**/*']
-    end
+### In your gemspec
+
+To automatically build and include your UNIX man page files in your gem
+packages, add the following line to the top of your `*.gemspec` file:
+
+    require 'binman/gemspec'
+
+Doing this also adds binman as a runtime and development gem dependency.
 
 ------------------------------------------------------------------------------
 License

data/Rakefile

@@ -1,2 +1,2 @@
 require "bundler/gem_tasks"
-require "binman/rake_tasks"
+require "binman/rakefile"

data/bin/binman

@@ -2,7 +2,7 @@
 # encoding: utf-8
 =begin
 
-BINMAN 1 "2011-10-13" "1.0.0" "Ruby User Manuals"
+BINMAN 1 "2011-11-05" "1.1.0" "Ruby User Manuals"
 =================================================
 
 NAME
@@ -97,6 +97,6 @@ when 'show'
 when 'load', 'dump', 'conv'
   puts BinMan.send(command, source)
 else
-  warn 'bad command; try --help'
+  warn 'binman: bad command; try --help'
   exit!
 end

data/binman.gemspec

@@ -1,10 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "binman/version"
-
-# pre-build man page files
-require 'binman/rake_tasks'
-Rake::Task[:binman].invoke
+require "binman/gemspec"
 
 Gem::Specification.new do |s|
   s.name        = "binman"
@@ -15,7 +12,7 @@ Gem::Specification.new do |s|
   s.summary     = "UNIX man pages for Ruby bin/ scripts"
   s.description = nil
 
-  s.files         = `git ls-files`.split("\n").concat(Dir['man/**/*'])
+  s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]

data/lib/binman/gemspec.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+
+class Gem::Specification
+  alias _582ab9fd_ffc8_4972_b37f_1a46031a9163 initialize
+  def initialize *args, &block
+    _582ab9fd_ffc8_4972_b37f_1a46031a9163(*args, &block)
+
+    # pre-build man page files
+    require 'binman/rake_tasks'
+    Rake::Task[:binman].invoke
+
+    # and add them to the gem
+    self.files += Dir['man/**/*']
+
+    # add binman as dependency
+    unless self.name == 'binman'
+      binman_gem = ['binman', '~> 1']
+      self.add_runtime_dependency(*binman_gem)
+      binman_vers = Gem::Dependency.new(*binman_gem)
+      binman_spec = Gem::SpecFetcher.fetcher.fetch(binman_vers).flatten.first
+      binman_spec.development_dependencies.unshift(binman_vers).each do |dep|
+        self.add_development_dependency dep.name, dep.requirements_list
+      end
+    end
+  end
+end

data/lib/binman/rake_tasks.rb

@@ -1,18 +1,2 @@
-require 'rake'
-
-path = 'man/man1'
-bins = FileList['bin/*']
-mans = bins.pathmap("#{path}/%n.1")
-
-bins.zip(mans).each do |bin, man|
-  file man => [bin, path] do
-    require 'binman'
-    roff = BinMan.dump(bin)
-    File.open(man, 'w') {|f| f << roff }
-  end
-end
-
-
-desc 'Build UNIX man pages for bin/ scripts.'
-task :binman => mans
-directory path
+warn 'binman: "binman/rake_tasks" is deprecated; use "binman/rakefile" instead'
+require 'binman/rakefile'

data/lib/binman/rakefile.rb

@@ -0,0 +1,18 @@
+require 'rake'
+
+path = 'man/man1'
+bins = FileList['bin/*']
+mans = bins.pathmap("#{path}/%n.1")
+
+bins.zip(mans).each do |bin, man|
+  file man => [bin, path] do
+    require 'binman'
+    roff = BinMan.dump(bin)
+    File.open(man, 'w') {|f| f << roff }
+  end
+end
+
+
+desc 'Build UNIX man pages for bin/ scripts.'
+task :binman => mans
+directory path

data/lib/binman/version.rb

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/man/man1/binman.1

@@ -1,4 +1,4 @@
-.TH BINMAN 1 "2011-10-13" "1.0.0" "Ruby User Manuals"
+.TH BINMAN 1 "2011-11-05" "1.1.0" "Ruby User Manuals"
 .SH NAME
 .PP
 binman \- UNIX man pages for Ruby \fBbin/\fP scripts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binman
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-14 00:00:00.000000000 Z
+date: 2011-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet-manpage
-  requirement: &19205100 !ruby/object:Gem::Requirement
+  requirement: &20757380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 0.0.1
   type: :development
   prerelease: false
-  version_requirements: *19205100
+  version_requirements: *20757380
 description: ''
 email:
 - sunaku@gmail.com
@@ -39,7 +39,9 @@ files:
 - bin/binman
 - binman.gemspec
 - lib/binman.rb
+- lib/binman/gemspec.rb
 - lib/binman/rake_tasks.rb
+- lib/binman/rakefile.rb
 - lib/binman/version.rb
 - man/man1/binman.1
 homepage: http://github.com/sunaku/binman
@@ -67,3 +69,4 @@ signing_key:
 specification_version: 3
 summary: UNIX man pages for Ruby bin/ scripts
 test_files: []
+has_rdoc: