grinc 0.1.0 → 0.1.1

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log for grinc
+
+Version 0.1.1
+
+- Rearranged code include command runner and library. Keeps rdoc happier,
+  anyway.
+- Fixed "install" rake task.
+
+----
+
+Version 0.1.0 (25 March, 2011)
+
+- Moved *grinc* to its own gem and repo, from Grizzled Ruby, and published it.

data/README.md

@@ -1,32 +1,18 @@
-# Grizzled Ruby
+# grinc
 
 ## Intro
 
-The Grizzled Ruby Utility Library is a general-purpose Ruby library
-with a variety of different modules and classes. Basically, it's an
-organized dumping ground for various useful APIs I find I need. It's
-similar, in concept, to my [Grizzled Python][] and [Grizzled Scala][]
-libraries, for [Python][] and [Scala][], respectively.
+*grinc* runs an include file preprocessor on one or more files, writing the
+result to an output file (or standard output). It uses the
+`Grizzled::FileUtil::Includer` class in the [Grizzled Ruby][] gem.
 
-It can be built as a gem, but the gem isn't (yet) public.
-
-[Grizzled Python]: http://software.clapper.org/grizzled/
-[Grizzled Scala]: http://software.clapper.org/grizzled-scala/
-[Scala]: http://www.scala-lang.org/
-[Python]: http://www.python.org/
-
-## To build
-
-    $ git clone git://github.com/bmc/grizzled-ruby.git
-    $ cd grizzled-ruby
-    $ gem build grizzled-ruby.gemspec
-    $ gem install grizzled-ruby
-
-## To use in your code
-
-    require 'grizzled'
+For installation instructions and additional documentation, see the
+[*grinc* web page][].
 
 ## Copyright and License
 
 This code is copyright © 2011 Brian M. Clapper and is released under a
 BSD License.
+
+[*grinc* web page]: http://software.clapper.org/grinc/
+[Grizzled Ruby]: http://software.clapper.org/grizzled-ruby/

data/Rakefile

@@ -7,7 +7,7 @@ require 'pathname'
 
 PACKAGE = 'grinc'
 GEMSPEC = "#{PACKAGE}.gemspec"
-RUBY_FILES = FileList['bin/*']
+RUBY_FILES = FileList['bin/*', 'lib/*']
 MAN_OUT_DIR = 'man'
 GH_PAGES_DIR = File.join('..', 'gh-pages')
 MAN_PUBLISH_DIR = File.join(GH_PAGES_DIR, 'man')
@@ -33,7 +33,7 @@ def gem_name(spec)
 end
 
 GEM = gem_name(GEMSPEC)
-CLEAN << [MAN_OUT_DIR, GEM]
+CLEAN << [MAN_OUT_DIR] + FileList['*.gem']
 
 # ---------------------------------------------------------------------------
 # Rules
@@ -51,18 +51,17 @@ def man_source
   end
 end
 
-# Make man/man?/thing.? from src-man/thing.?/md
-rule %r{#{MAN_OUT_DIR}/man[0-9]/.*\.[0-9]} => [man_source, 'Rakefile'] do |t|
-  mkdir_p File.dirname(t.name)
-  sh "ronn --roff --pipe #{t.source} >#{t.name}"
-end
-
 # Make man/man?/thing.?.html from src-man/thing.?/md
-rule %r{#{MAN_OUT_DIR}/man[0-9]/.*\.[0-9]\.html} => [man_source, 'Rakefile'] do |t|
+rule %r{#{MAN_OUT_DIR}/man[0-9]/[^.]+\.[0-9]\.html} => [man_source, 'Rakefile'] do |t|
   mkdir_p File.dirname(t.name)
   sh "ronn --html --pipe #{t.source} >#{t.name}"
 end
 
+# Make man/man?/thing.? from src-man/thing.?/md
+rule %r{#{MAN_OUT_DIR}/man[0-9]/[^.]+\.[0-9]} => [man_source, 'Rakefile'] do |t|
+  mkdir_p File.dirname(t.name)
+  sh "ronn --roff --pipe #{t.source} >#{t.name}"
+end
 
 # ---------------------------------------------------------------------------
 # Tasks
@@ -77,7 +76,7 @@ desc "Synonym for 'build'"
 task :all => :build
 
 desc "Build the gem (#{GEM})"
-task :gem => GEM
+task :gem => [GEM, :doc]
 
 file GEM => RUBY_FILES + ['Rakefile', GEMSPEC] do |t|
   require 'rubygems/builder'
@@ -95,9 +94,8 @@ task :man => MAN_PAGES + ['Rakefile']
 
 desc "Install the gem"
 task :install => :gem do |t|
-  require 'rubygems/installer'
   puts("Installing from #{GEM}")
-  Gem::Installer.new(GEM).install
+  sh "gem install #{GEM}"
 end
 
 desc "Publish the gem"
@@ -110,10 +108,11 @@ task :pubdoc => [:pubman, :pubchangelog]
 
 desc "Publish the man pages. Not really of use to anyone but the author"
 task :pubman => :man do |t|
-  target = Pathname.new(MAN_PUBLISH_DIR).expand_path.to_s
+  target_dir = Pathname.new(MAN_PUBLISH_DIR).expand_path.to_s
   cd MAN_OUT_DIR do
-    mkdir_p target
-    Dir['*.html'].each do |m|
+    mkdir_p target_dir
+    Dir['**/*.html'].each do |m|
+      target = File.join(target_dir, File.basename(m))
       cp m, target
     end
   end

data/bin/grinc

@@ -37,120 +37,7 @@
 # SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #++
 
-require 'optparse'
 require 'rubygems'
-require 'grizzled/fileutil/includer'
-
-include Grizzled::FileUtil
-
-# ---------------------------------------------------------------------------
-# Constants
-# ---------------------------------------------------------------------------
-
-DEFAULT_MAX_NEST = 100
-PROGRAM_NAME = 'grinc'
-
-# ---------------------------------------------------------------------------
-# Classes
-# ---------------------------------------------------------------------------
-
-class Parameters
-  attr_reader :output, :max_nesting, :input_paths
-
-  def initialize(options_hash, argv)
-    @output = options_hash[:output]
-    @max_nesting = options_hash[:max_nesting] || DEFAULT_MAX_NEST
-    @input_paths = argv.length == 0 ? nil : argv
-  end
-
-  def to_s
-    inspect
-  end
-end
-
-class UsageError < StandardError; end
-
-# ---------------------------------------------------------------------------
-# Parameter parsing
-# ---------------------------------------------------------------------------
-
-def parse_params
-  options_hash = {}
-  error = nil
-  option_parser = OptionParser.new do |opts|
-    opts.program_name = PROGRAM_NAME
-    opts.banner = "Usage: #{opts.program_name} [OPTIONS] inputfile ..."
-    opts.separator ''
-    opts.separator 'OPTIONS:'
-
-    opts.on('-o FILE', 'Output file. Default: standard output.') do |f|
-      options_hash[:output] = f
-    end
-
-    opts.on('-n', '--nesting n',
-            "Max nesting. Default: #{DEFAULT_MAX_NEST}") do |n|
-      if n !~ /^[0-9]+$/
-        error = "Non-numeric parameter \"#{n}\" to -n option."
-      end
-      options_hash[:max_nesting] = n.to_i
-    end
-  end
-
-  begin
-    option_parser.parse!(ARGV)
-  rescue OptionParser::InvalidOption => ex
-    error = ex.to_s
-  end
-
-  if error
-    $stderr.puts(error) unless error.nil?
-    option_parser.display
-    raise UsageError.new
-  end
-
-  if ARGV.length == 0
-    options_hash[:input_files] = nil
-  else
-    options_hash[:input_files] = ARGV
-  end
-
-  Parameters.new(options_hash, ARGV)
-end
-
-def process_include(input_file, output_file, max_nesting = 100)
-  Includer.new(input_file, :max_nesting => max_nesting).each do |line|
-    output_file.write(line)
-  end
-end
-
-# ---------------------------------------------------------------------------
-# Main logic
-# ---------------------------------------------------------------------------
-
-begin
-  params = parse_params
-  out = params.output.nil? ? $stderr : File.open(params.output, 'w')
-
-  if params.input_paths.nil?
-    process_include($stdin, out, params.max_nesting)
-  else
-    params.input_paths.each do |f|
-      process_include(File.open(f), out, params.max_nesting)
-    end
-  end
-
-rescue UsageError
-  exit 1
-
-rescue Interrupt
-  $stderr.puts("\nAborted")
-  exit 1
-
-rescue
-  $stderr.puts("#{PROGRAM_NAME}: #{$!}")
-  exit 1
-
-else
-  exit 0
-end
+require 'grizzled/grinc'
 
+exit Grizzled::Grinc::GrincRunner.new.run

data/grinc.gemspec

@@ -3,14 +3,13 @@
 Gem::Specification.new do |s|
 
   s.name             = 'grinc'
-  s.version          = '0.1.0'
-  s.date             = '2011-03-25'
+  s.version          = '0.1.1'
+  s.date             = '2011-03-26'
   s.summary          = 'Command line include file preprocessor'
   s.authors          = ['Brian M. Clapper']
   s.license          = 'BSD'
   s.email            = 'bmc@clapper.org'
   s.homepage         = 'http://software.clapper.org/grinc'
-  s.has_rdoc         = false
 
   s.description      = <<-ENDDESC
 grinc runs an include file preprocessor on one or more files, writing the
@@ -22,8 +21,8 @@ ENDDESC
   # = MANIFEST =
   s.files            = Dir.glob('[A-Z]*')
   s.files           += Dir.glob('*.gemspec')
-  s.files           += Dir.glob('lib/**/*')
   s.files           += Dir.glob('bin/**/*')
+  s.files           += Dir.glob('lib/**/*')
   s.files           += Dir.glob('man/**/*.[0-9]')
   s.files           += Dir.glob('src-man/**/*')
 

data/lib/grizzled/grinc.rb

@@ -0,0 +1,165 @@
+#!/usr/bin/env ruby
+#
+# See the man page or http://software.clapper.org/grizzled-ruby/grinc/
+# for documentation.
+#--
+# This software is released under a BSD license, adapted from
+# http://opensource.org/licenses/bsd-license.php
+#
+# Copyright (c) 2011, Brian M. Clapper
+# 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 names "clapper.org", "Grizzled Ruby Library", nor the
+#   names of its 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 HOLDER 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.
+#++
+
+require 'optparse'
+require 'rubygems'
+require 'grizzled/fileutil/includer'
+
+include Grizzled::FileUtil
+
+module Grizzled
+
+  module Grinc
+
+    # -----------------------------------------------------------------------
+    # Constants
+    # -----------------------------------------------------------------------
+
+    DEFAULT_MAX_NEST = 100
+    PROGRAM_NAME = 'grinc'
+
+    # -----------------------------------------------------------------------
+    # Classes
+    # -----------------------------------------------------------------------
+
+    class Parameters
+      attr_reader :output, :max_nesting, :input_paths
+
+      def initialize(options_hash, argv)
+        @output = options_hash[:output]
+        @max_nesting = options_hash[:max_nesting] || DEFAULT_MAX_NEST
+        @input_paths = argv.length == 0 ? nil : argv
+      end
+
+      def to_s
+        inspect
+      end
+    end
+
+    class UsageError < StandardError; end
+
+    class GrincRunner
+      def initialize
+      end
+
+      def run
+        begin
+          params = parse_params
+          out = params.output.nil? ? $stderr : File.open(params.output, 'w')
+
+          if params.input_paths.nil?
+            process_include($stdin, out, params.max_nesting)
+          else
+            params.input_paths.each do |f|
+              process_include(File.open(f), out, params.max_nesting)
+            end
+          end
+
+        rescue UsageError
+          return 1
+
+        rescue Interrupt
+          $stderr.puts("\nAborted")
+          return 1
+
+        rescue
+          $stderr.puts("#{PROGRAM_NAME}: #{$!}")
+          return 1
+
+        else
+          return 0
+        end
+      end
+
+      def parse_params
+        options_hash = {}
+        error = nil
+        option_parser = OptionParser.new do |opts|
+          opts.program_name = PROGRAM_NAME
+          opts.banner = "Usage: #{opts.program_name} [OPTIONS] inputfile ..."
+          opts.separator ''
+          opts.separator 'OPTIONS:'
+
+          opts.on('-o FILE', 'Output file. Default: standard output.') do |f|
+            options_hash[:output] = f
+          end
+
+          opts.on('-n', '--nesting n',
+                  "Max nesting. Default: #{DEFAULT_MAX_NEST}") do |n|
+            if n !~ /^[0-9]+$/
+              error = "Non-numeric parameter \"#{n}\" to -n option."
+            end
+            options_hash[:max_nesting] = n.to_i
+          end
+        end
+
+        begin
+          option_parser.parse!(ARGV)
+        rescue OptionParser::InvalidOption => ex
+          error = ex.to_s
+        end
+
+        if error
+          $stderr.puts(error) unless error.nil?
+          option_parser.display
+          raise UsageError.new
+        end
+
+        if ARGV.length == 0
+          options_hash[:input_files] = nil
+        else
+          options_hash[:input_files] = ARGV
+        end
+
+        Parameters.new(options_hash, ARGV)
+      end
+
+      private
+
+      def process_include(input_file, output_file, max_nesting = 100)
+        Includer.new(input_file, :max_nesting => max_nesting).each do |line|
+          output_file.write(line)
+        end
+      end
+    end
+
+  end # module Grinc
+end # module Grizzled
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grinc
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Brian M. Clapper
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-25 00:00:00 -04:00
+date: 2011-03-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,10 +46,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- README.md
+- CHANGELOG.md
 - Rakefile
+- README.md
 - grinc.gemspec
 - bin/grinc
+- lib/grizzled/grinc.rb
 - man/man1/grinc.1
 - src-man/grinc.1.md
 has_rdoc: true
@@ -82,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Command line include file preprocessor