RubyGems - binman - Versions diffs - 3.0.0 → 3.0.1 - Mend

binman 3.0.0 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

data/HISTORY.markdown CHANGED Viewed

@@ -1,90 +1,116 @@
+------------------------------------------------------------------------------
+Version 3.0.1 (2012-02-02)
+------------------------------------------------------------------------------
+Patch:
+  * BinMan.help(): ignore `-h` and `--help` options after standard `--` flag.
+  * BinMan.show(): write temp file because not all systems support `man -l`.
+Other:
+  * HISTORY: group changes by version number components.
+  * README: add instructions on pre-building man pages.
+  * README: fix installation commands for development.
+  * bundler suggests moving all dev deps into gemspec.
 ------------------------------------------------------------------------------
 Version 3.0.0 (2012-01-09)
 ------------------------------------------------------------------------------
-Breaking changes:
+Major:
+  * Removed the `binman/gemspec` helper library because it did not play well
+    with Bundler.  Use the standard `add_runtime_dependency` method instead.
+    [This example][1] shows what work is involved in upgrading.
-* Removed the `binman/gemspec` helper library because it did not play well
-  with Bundler.  Use the standard `add_runtime_dependency` method instead.
+Minor:
-External changes:
+  * The `binman/Rakefile` helper library now hooks into Bundler's Rake tasks.
+    Be sure to add the `man/**/*` files to your gemspec [accordingly][1].
-* The `binman/Rakefile` helper library now hooks into Bundler's Rake tasks.
+[1]: https://github.com/sunaku/md2man/commit/75d7a0064fa86f1c98dd01391ad82245fd387c20
 ------------------------------------------------------------------------------
 Version 2.0.0 (2011-12-06)
 ------------------------------------------------------------------------------
-Breaking changes:
+Major:
-* Removed the deprecated `binman/rake_tasks` helper library.  Use
-  `binman/rakefile` instead.
+  * Removed the deprecated `binman/rake_tasks` helper library.  Use
+    `binman/rakefile` instead.
-External changes:
+Patch:
-* Fixed infinite looping in the `binman/gemspec` helper library.
+  * Fixed infinite looping in the `binman/gemspec` helper library.
-Internal changes:
+Other:
-* Upgraded to md2man v1 for Markdown to UNIX man page conversion.
+  * Upgraded to md2man v1 for Markdown to UNIX man page conversion.
-* Do not hard-code the version number in `binman/gemspec` helper.
+  * Do not hard-code the version number in `binman/gemspec` helper.
 ------------------------------------------------------------------------------
 Version 1.1.0 (2011-11-05)
 ------------------------------------------------------------------------------
-Compatible changes:
+Alert:
-* The `binman/rake_tasks` library has been renamed (with deprecation) to
-  `binman/rakefile`.  The deprecation warning will be removed in the next
-  major release.
+  * 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:
+Minor:
-* 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.
+  * 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)
 ------------------------------------------------------------------------------
-Incompatible changes:
+Major:
-* The `BinMan::dump()` method and corresponding `binman dump` command now
-  extract the leading comment header from their input before returning the
-  markdown to roff conversion thereof.
+  * The `BinMan::dump()` method and corresponding `binman dump` command now
+    extract the leading comment header from their input before returning the
+    markdown to roff conversion thereof.
-* The `BinMan::read()` method and corresponding `binman read` command have
-  been renamed to `BinMan::load()` and `binman load` respectively.
+  * The `BinMan::read()` method and corresponding `binman read` command have
+    been renamed to `BinMan::load()` and `binman load` respectively.
-New features:
+Minor:
-* Added `BinMan::conv()` method and corresponding `binman conv` command to
-  encapsulate the markdown to roff conversion process.
+  * Added `BinMan::conv()` method and corresponding `binman conv` command to
+    encapsulate the markdown to roff conversion process.
-Bug fixes:
+Patch:
-* Pre-built man pages included alongside a `bin/` script were not displayed.
-  Instead, binman was (incorrectly) always trying to convert the leading
-  comment header from the `bin/` script into a UNIX man page for display.
+  * Pre-built man pages included alongside a `bin/` script were not displayed.
+    Instead, binman was (incorrectly) always trying to convert the leading
+    comment header from the `bin/` script into a UNIX man page for display.
-Housekeeping:
+Other:
-* README: explain dev deps and `man/` dir packaging.
+  * README: explain dev deps and `man/` dir packaging.
 ------------------------------------------------------------------------------
 Version 0.1.2 (2011-10-13)
 ------------------------------------------------------------------------------
-Housekeeping:
+Minor:
+  * The [Redcarpet2] library is not a runtime gem dependency anymore.
-* Extracted `BinMan::Renderer` into [redcarpet-manpage] library.
+Other:
-* The [Redcarpet2] library is not a runtime gem dependency anymore.
+  * Extracted `BinMan::Renderer` into [redcarpet-manpage] library.
-* Forgot to introduce leading comment headers in binman(1) man page.
+  * Forgot to introduce leading comment headers in binman(1) man page.
 [Redcarpet2]: https://github.com/tanoku/redcarpet
 [redcarpet-manpage]: http://rdoc.info/github/sunaku/redcarpet-manpage
@@ -93,29 +119,29 @@ Housekeeping:
 Version 0.1.1 (2011-10-13)
 ------------------------------------------------------------------------------
-New features:
+Minor:
-* `BinMan.read()` now supports embedded document (=begin/=end) comments also.
-  See binman(1) for the new, complete description of leading comment headers.
+  * `BinMan.read()` now supports embedded document (=begin/=end) comments
+    also.  See binman(1) for the new description of leading comment headers.
-Bug fixes:
+Patch:
-* Ignore encoding comment line after shebang line.
+  * Ignore encoding comment line after shebang line.
-* roff: fix first paragraphs inside list items.
+  * roff: fix first paragraphs inside list items.
-Housekeeping:
+Other:
-* gemspec: build man page files before building gem.
+  * gemspec: build man page files before building gem.
-* binman: raise error and suggest --help option.
+  * binman: raise error and suggest --help option.
-* README: add link to example of binman markdown.
+  * README: add link to example of binman markdown.
-* README: add obligatory screenshot! >:-)
+  * README: add obligatory screenshot! >:-)
 ------------------------------------------------------------------------------
 Version 0.0.1 (2011-10-12)
 ------------------------------------------------------------------------------
-* First release!  Happy birthday!  Woohoo!  :-)
+First release!  Happy birthday!  Woohoo!  :-)

data/README.markdown CHANGED Viewed

@@ -41,29 +41,21 @@ As a Ruby gem (with extra cheese and everything please):
     gem install binman --development
-As a Git clone:
+### Development
     git clone git://github.com/sunaku/binman
     cd binman
-    bundle install
+    bundle install --binstubs=bundle_bin
+    bundle_bin/binman --help  # run it directly
+    bundle exec rake -T       # packaging tasks
 ------------------------------------------------------------------------------
-Invocation
+Usage
 ------------------------------------------------------------------------------
-If installed as a Ruby gem:
-    binman
-If installed as a Git clone:
-    bundle exec ruby -Ilib bin/binman
-Just pass `--help` to see its man page.
+### At the command line
-------------------------------------------------------------------------------
-Usage
-------------------------------------------------------------------------------
+    binman --help
 ### In your bin/ scripts
@@ -79,24 +71,26 @@ Or, if you're on a diet:
 See the [API documentation][binman-api] for more delicious recipes.
-### In your Rakefile
+### Pre-building man pages
-Add the following line to your `Rakefile` and you've got a `binman` task!
+Add the following lines to your gemspec:
-    require 'binman/rakefile'
+    s.files += Dir["man/**/*"]
+    s.add_development_dependency 'md2man', '~> 1'
-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!
+Add the following line to your Rakefile:
-### In your gemspec
+    require 'binman/rakefile'
-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:
+You now have a `rake binman` task that pre-builds UNIX man 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 man pages you've embedded therein!
-    require 'binman/gemspec'
+If you're using Bundler, this task also hooks into its gem packaging tasks and
+ensures that your UNIX man page files are pre-built and included in your gem:
-Doing this also adds binman as a runtime and development gem dependency.
+    bundle exec rake build
+    gem spec pkg/*.gem | fgrep man/man
 ------------------------------------------------------------------------------
 License

data/bin/binman CHANGED Viewed

@@ -2,7 +2,7 @@
 # encoding: utf-8
 =begin
-BINMAN 1 "2012-01-09" "3.0.0"
+BINMAN 1 "2012-02-02" "3.0.1"
 =============================
 NAME

data/binman.gemspec CHANGED Viewed

@@ -17,4 +17,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_development_dependency "md2man", "~> 1"
+  s.add_development_dependency "rake", ">= 0.9.2.2", "< 1"
 end

data/lib/binman.rb CHANGED Viewed

@@ -55,16 +55,24 @@ module BinMan
     begin
       roff = conv(header)
-      IO.popen('man -l -', 'w') {|man| man.puts roff }
+      require 'tempfile'
+      Tempfile.open 'binman' do |temp|
+        temp.write roff
+        temp.close
+        system 'man', temp.path
+      end
     rescue => error
       warn "binman: #{error}"
       puts header
     end
   end
-  # Shows leading comment header from given source as UNIX man page and exits.
+  # Shows leading comment header from given source as UNIX man page and exits
+  # if the given argument vector contains '-h' or '--help', except after '--'.
   def help source=nil, argv=ARGV
-    unless argv.grep(/^(-h|--help)$/).empty?
+    limit = argv.index('--') || argv.length
+    index = [argv.index('-h'), argv.index('--help')].compact.min
+    if index and index < limit
       show source
       exit
     end

data/lib/binman/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module BinMan
-  VERSION = "3.0.0"
+  VERSION = "3.0.1"
 end

data/man/man1/binman.1 CHANGED Viewed

@@ -1,4 +1,4 @@
-.TH BINMAN 1 "2012\-01\-09" "3.0.0"
+.TH BINMAN 1 "2012\-02\-02" "3.0.1"
 .SH NAME
 .PP
 binman \- UNIX man pages for Ruby \fB\fCbin/\fR scripts

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: binman
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
   prerelease:
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-01-10 00:00:00.000000000 Z
+date: 2012-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: md2man
-  requirement: &17179080 !ruby/object:Gem::Requirement
+  requirement: &18830780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,21 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *17179080
+  version_requirements: *18830780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &18829640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+    - - <
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: *18829640
 description: ''
 email:
 - sunaku@gmail.com
@@ -54,12 +68,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3512884628236364112
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3512884628236364112
 requirements: []
 rubyforge_project:
 rubygems_version: 1.8.11
@@ -67,4 +87,3 @@ signing_key:
 specification_version: 3
 summary: UNIX man pages for Ruby bin/ scripts
 test_files: []
-has_rdoc: