binman 3.1.1 → 3.2.0

data/HISTORY.markdown

@@ -1,3 +1,13 @@
+## Version 3.2.0 (2012-10-14)
+
+Minor:
+
+  * add binman:web task to produce man pages in HTML
+
+Other:
+
+  * gemspec: package only roff files from inside man/
+
 ## Version 3.1.1 (2012-10-13)
 
 Patch:

data/README.markdown

@@ -29,7 +29,7 @@ If you only want to view pre-built manual pages:
 
 If you also want to build your own manual pages:
 
-    gem install md2man -v '~> 1'
+    gem install md2man -v '~> 1.4'
 
 ### Prerequisites
 
@@ -39,9 +39,9 @@ If you also want to build your own manual pages:
 
     git clone git://github.com/sunaku/binman
     cd binman
-    bundle install --binstubs=bundle_bin
-    bundle_bin/binman --help  # run it directly
-    bundle exec rake -T       # packaging tasks
+    bundle install
+    bundle exec binman --help # run it directly
+    bundle exec rake --tasks  # packaging tasks
 
 ## Usage
 
@@ -214,8 +214,8 @@ You can also write the manual as a multi-line Ruby comment inside an `if 0`:
 
 Add the following lines to your gemspec:
 
-    s.files += Dir['man/**/*']
-    s.add_development_dependency 'md2man', '~> 1'
+    s.files += Dir['man/man?/*.?']
+    s.add_development_dependency 'md2man', '~> 1.4'
 
 Add the following line to your Rakefile:
 
@@ -224,6 +224,7 @@ Add the following line to your Rakefile:
 You now have a `rake binman` task that pre-builds UNIX manual page files for
 your `bin/` scripts into a `man/` directory so that your end-users do not need
 [md2man] installed in order to view the manual pages you've embedded therein!
+There are also sub-tasks to build manual pages individually as [roff] or HTML.
 
 If you're using Bundler, this task also hooks into its gem packaging tasks and
 ensures that your UNIX manual pages are pre-built and packaged into your gem:
@@ -235,6 +236,7 @@ ensures that your UNIX manual pages are pre-built and packaged into your gem:
 
 Released under the ISC license.  See the LICENSE file for details.
 
+[roff]: http://troff.org
 [binman]: https://github.com/sunaku/binman
 [binman-api]: http://rubydoc.info/gems/binman/frames
 [binman-bin]: https://raw.github.com/sunaku/binman/master/bin/binman

data/bin/binman

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 =begin =======================================================================
 
-# BINMAN 1 2012-10-13 3.1.1
+# BINMAN 1 2012-10-14 3.2.0
 
 ## NAME
 

data/binman.gemspec

@@ -11,11 +11,11 @@ Gem::Specification.new do |s|
   s.summary       = 'man pages for bin scripts'
   s.description   = 'Produces UNIX manual pages for executable scripts.'
 
-  s.files         = `git ls-files`.split("\n") + Dir['man/**/*']
+  s.files         = `git ls-files`.split("\n") + Dir['man/man?/*.?']
   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']
 
-  s.add_development_dependency 'md2man', '~> 1'
+  s.add_development_dependency 'md2man', '~> 1.4'
   s.add_development_dependency 'rake', '>= 0.9.2.2', '< 1'
 end

data/lib/binman/rakefile.rb

@@ -1,19 +1,37 @@
 require 'rake'
 
-directory path = 'man/man1'
-bins = FileList['bin/*']
-mans = bins.pathmap("#{path}/%n.1")
+# build man pages before building ruby gem using bundler
+%w[build install release].each {|t| task t => :binman }
 
-desc 'Build UNIX manual pages for bin/ scripts.'
-task :binman => mans
+#-----------------------------------------------------------------------------
+desc 'Build manual pages for bin/ scripts.'
+task :binman => ['binman:man', 'binman:web']
+#-----------------------------------------------------------------------------
+
+directory dir = 'man/man1'
+bins = FileList['bin/*']
+mkds = bins.pathmap("#{dir}/%n.1.markdown")
 
-bins.zip(mans).each do |bin, man|
-  file man => [bin, path] do
+bins.zip(mkds).each do |src, dst|
+  file dst => [dir, src] do
     require 'binman'
-    roff = BinMan.dump(bin)
-    File.open(man, 'w') {|f| f << roff }
+    output = BinMan.load(src)
+    File.open(dst, 'w') {|f| f << output }
   end
 end
 
-# build man pages before building ruby gem using bundler
-%w[build install release].each {|t| task t => :binman }
+#-----------------------------------------------------------------------------
+desc 'Build UNIX manual pages for bin/ scripts.'
+task 'binman:man' => mkds do
+#-----------------------------------------------------------------------------
+  require 'md2man/rakefile'
+  Rake::Task['md2man:man'].invoke
+end
+
+#-----------------------------------------------------------------------------
+desc 'Build HTML manual pages for bin/ scripts.'
+task 'binman:web' => mkds do
+#-----------------------------------------------------------------------------
+  require 'md2man/rakefile'
+  Rake::Task['md2man:web'].invoke
+end

data/lib/binman/version.rb

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/man/man1/binman.1

@@ -1,4 +1,4 @@
-.TH BINMAN 1 2012\-10\-13 3.1.1
+.TH BINMAN 1 2012\-10\-14 3.2.0
 .SH NAME
 .PP
 binman \- man pages for bin scripts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binman
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -81,12 +81,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2476896195516585469
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2476896195516585469
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23