grinc 0.1.0

data/README.md

@@ -0,0 +1,32 @@
+# Grizzled Ruby
+
+## 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.
+
+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'
+
+## Copyright and License
+
+This code is copyright © 2011 Brian M. Clapper and is released under a
+BSD License.

data/Rakefile

@@ -0,0 +1,143 @@
+#                                                                  -*- ruby -*-
+#
+# NOTE: Man pages use the 'ronn' gem. http://rtomayko.github.com/ronn/
+
+require 'rake/clean'
+require 'pathname'
+
+PACKAGE = 'grinc'
+GEMSPEC = "#{PACKAGE}.gemspec"
+RUBY_FILES = FileList['bin/*']
+MAN_OUT_DIR = 'man'
+GH_PAGES_DIR = File.join('..', 'gh-pages')
+MAN_PUBLISH_DIR = File.join(GH_PAGES_DIR, 'man')
+MAN_SOURCE_DIR = 'src-man'
+MAN_SOURCES = FileList[File.join(MAN_SOURCE_DIR, '*.md')]
+
+MAN_PAGES = MAN_SOURCES.map do |m|
+  if m =~ %r{#{MAN_SOURCE_DIR}/([^.]+)\.([0-9])\.md$}
+    [File.join(MAN_OUT_DIR, "man#{$2}", "#{$1}.#{$2}.html"),
+     File.join(MAN_OUT_DIR, "man#{$2}", "#{$1}.#{$2}")]
+  else
+    raise StandardError.new("#{m} doesn't look like a man page source.")
+  end
+end.flatten
+
+def load_gem(spec)
+  eval File.open(spec).readlines.join('')
+end
+
+def gem_name(spec)
+  gem = load_gem(spec)
+  "#{PACKAGE}-#{gem.version.to_s}.gem"
+end
+
+GEM = gem_name(GEMSPEC)
+CLEAN << [MAN_OUT_DIR, GEM]
+
+# ---------------------------------------------------------------------------
+# Rules
+# ---------------------------------------------------------------------------
+
+def man_source
+  Proc.new do |man_target|
+    if man_target =~ %r{#{MAN_OUT_DIR}/man[0-9]/(.*\.[0-9])}
+      File.join("src-man", $1 + ".md")
+    elsif man_target =~ %r{#{MAN_OUT_DIR}/man[0-9]/(.*\.[0-9].html)}
+      File.join("src-man", $1 + ".md")
+    else
+      raise StandardError.new("Can't find source for man page #{man_target}")
+    end
+  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|
+  mkdir_p File.dirname(t.name)
+  sh "ronn --html --pipe #{t.source} >#{t.name}"
+end
+
+
+# ---------------------------------------------------------------------------
+# Tasks
+# ---------------------------------------------------------------------------
+
+task :default => :build
+
+desc "Build everything"
+task :build => [:gem, :doc]
+
+desc "Synonym for 'build'"
+task :all => :build
+
+desc "Build the gem (#{GEM})"
+task :gem => GEM
+
+file GEM => RUBY_FILES + ['Rakefile', GEMSPEC] do |t|
+  require 'rubygems/builder'
+  if !defined? Gem
+    raise StandardError.new("Gem package not defined.")
+  end
+  spec = eval File.new(GEMSPEC).read
+  Gem::Builder.new(spec).build
+end  
+
+desc "Build the documentation, locally"
+task :doc => :man
+
+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
+end
+
+desc "Publish the gem"
+task :publish => :gem do |t|
+  sh "gem push #{GEM}"
+end
+
+desc "Publish the docs. Not really of use to anyone but the author"
+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
+  cd MAN_OUT_DIR do
+    mkdir_p target
+    Dir['*.html'].each do |m|
+      cp m, target
+    end
+  end
+end
+
+desc "Synonym for 'pubchangelog'"
+task :changelog
+
+desc "Publish the change log. Not really of use to anyone but the author"
+task :pubchangelog do |t|
+  File.open(File.join(GH_PAGES_DIR, 'CHANGELOG.md'), 'w') do |f|
+    f.write <<EOF
+---
+title: Change Log for grinc
+layout: default
+---
+
+EOF
+    f.write File.open('CHANGELOG.md').read
+    f.close
+  end
+end
+
+task :pub
+
+desc "Alias for 'docpub'"
+task :docpub => :pubdoc

data/bin/grinc

@@ -0,0 +1,156 @@
+#!/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
+
+# ---------------------------------------------------------------------------
+# 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
+

data/grinc.gemspec

@@ -0,0 +1,36 @@
+#                                                                -*- ruby -*-
+
+Gem::Specification.new do |s|
+
+  s.name             = 'grinc'
+  s.version          = '0.1.0'
+  s.date             = '2011-03-25'
+  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
+result to an output file (or standard output).
+ENDDESC
+
+  s.add_dependency('grizzled-ruby', '>= 0.1.4')
+
+  # = 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('man/**/*.[0-9]')
+  s.files           += Dir.glob('src-man/**/*')
+
+
+  # = MANIFEST =
+  s.executables      = ['grinc']
+
+end
+
+

data/man/man1/grinc.1

@@ -0,0 +1,79 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "GRINC" "1" "March 2011" "" ""
+.
+.SH "NAME"
+\fBgrinc\fR \- Process includes on a text file
+.
+.SH "SYNOPSIS"
+\fBgrinc\fR [\-o output | \-\-output output] [\-n maxnest | \-\-maxnest maxnest] [files]
+.
+.SH "DESCRIPTION"
+\fIgrinc\fR runs an include file preprocessor on one or more files, writing the result to an output file (or standard output)\.
+.
+.P
+If the output file isn\'t specified, output is written to standard output\.
+.
+.P
+The \fIinclude\fR syntax is simple:
+.
+.IP "" 4
+.
+.nf
+
+%include "filespec"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+\fIfilespec\fR can be an absolute pathname, a relative pathname, a simple file name, or a URL\. For example:
+.
+.IP "" 4
+.
+.nf
+
+%include "/absolute/path/to/file"
+%include "\.\./relative/path/to/file"
+%include "local_reference"
+%include "http://localhost/path/to/my\.config"
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Relative and local file references are relative to the including file or URL\. That, if \fIgrinc\fR is processing file "/home/bmc/foo\.txt" and encounters an attempt to include file "bar\.txt", it will assume "bar\.txt" is to be found in "/home/bmc"\.
+.
+.P
+Similarly, if \fIgrinc\fR is processing URL "http://localhost/bmc/foo\.txt" and encounters an attempt to include file "bar\.txt", it will assume "bar\.txt" is to be found at "http://localhost/bmc/bar\.txt"\.
+.
+.P
+Nested includes are permitted; that is, an included file may, itself, include other files\. The maximum recursion level is configurable, via a command line option, and defaults to 100\.
+.
+.P
+Multiple input files are permitted; they are processed in turn, and their expanded outputs are concatenated to the output file\. If no input files are specified, \fIgrinc\fR reads standard input\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-n N\fR, \fB\-\-nesting=N\fR, \fB\-\-nesting N\fR
+The maximum number of nested include files\. Default: 100
+.
+.TP
+\fB\-o file\fR, \fB\-\-output=file\fR, \fB\-\-output file\fR
+Where to write the resulting expanded file\. Default: standard output\.
+.
+.SH "SEE ALSO"
+m4(1)
+.
+.SH "AUTHOR"
+Brian M\. Clapper, \fIbmc@clapper\.org\fR
+.
+.SH "COPYRIGHT"
+Copyright \(co 2011 Brian M\. Clapper
+.
+.SH "LICENSE"
+\fIgrinc\fR is released under a BSD license\.

data/src-man/grinc.1.md

@@ -0,0 +1,66 @@
+grinc(1) -- Process includes on a text file
+===========================================
+
+## SYNOPSIS
+
+`grinc` [-o output | --output output] [-n maxnest | --maxnest maxnest] [files]
+
+## DESCRIPTION
+
+*grinc* runs an include file preprocessor on one or more files, writing the
+result to an output file (or standard output).
+
+If the output file isn't specified, output is written to standard output.
+
+The *include* syntax is simple:
+
+    %include "filespec"
+
+*filespec* can be an absolute pathname, a relative pathname, a simple file
+name, or a URL. For example:
+
+    %include "/absolute/path/to/file"
+    %include "../relative/path/to/file"
+    %include "local_reference"
+    %include "http://localhost/path/to/my.config"
+
+Relative and local file references are relative to the including file or
+URL. That, if *grinc* is processing file "/home/bmc/foo.txt" and encounters
+an attempt to include file "bar.txt", it will assume "bar.txt" is to be
+found in "/home/bmc".
+
+Similarly, if *grinc* is processing URL "http://localhost/bmc/foo.txt" and
+encounters an attempt to include file "bar.txt", it will assume "bar.txt"
+is to be found at "http://localhost/bmc/bar.txt".
+
+Nested includes are permitted; that is, an included file may, itself,
+include other files. The maximum recursion level is configurable, via
+a command line option, and defaults to 100.
+
+Multiple input files are permitted; they are processed in turn, and their
+expanded outputs are concatenated to the output file. If no input files
+are specified, *grinc* reads standard input.
+
+## OPTIONS
+
+* `-n N`, `--nesting=N`, `--nesting N`:
+  The maximum number of nested include files. Default: 100
+
+* `-o file`, `--output=file`, `--output file`:
+  Where to write the resulting expanded file. Default: standard output.
+  
+## SEE ALSO
+
+m4(1)
+
+## AUTHOR
+
+Brian M. Clapper, [bmc@clapper.org](bmc@clapper.org)
+
+## COPYRIGHT
+
+Copyright © 2011 Brian M. Clapper
+
+## LICENSE
+
+*grinc* is released under a BSD license.

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: grinc
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Brian M. Clapper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-25 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: grizzled-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 1
+        - 4
+        version: 0.1.4
+  type: :runtime
+  version_requirements: *id001
+description: |
+  grinc runs an include file preprocessor on one or more files, writing the
+  result to an output file (or standard output).
+
+email: bmc@clapper.org
+executables: 
+- grinc
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- grinc.gemspec
+- bin/grinc
+- man/man1/grinc.1
+- src-man/grinc.1.md
+has_rdoc: true
+homepage: http://software.clapper.org/grinc
+licenses: 
+- BSD
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Command line include file preprocessor
+test_files: []
+