grizzled-ruby 0.1.3 → 0.1.4

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log for Grizzled Ruby
+
+Version 0.1.4 (25 March, 2011)
+
+- Fixed some gem issues.
+- Moved *grinc* to its own gem and repo.
+
+---
+
+Version 0.1.3 (24 March, 2011)
+
+* Correct minor problems in *grinc* that shouldn't have been pushed, but
+  were.
+
+---
+
+Version 0.1.2 (24 March, 2011)
+
+* Cleaned up API documentation.
+* Added *grinc* command/executable.
+
+---
+
+Version 0.1.1 (18 March, 2011)
+
+* Added `Grizzled::FileUtil::ZipUtil` module, which contains some
+  simplified, front-end "zip" and "unzip" wrappers for the `rubyzip` gem.
+* Added the `Grizzled::FileUtil.make_directory_tree` method, which creates
+  a directory tree from a nested hash specification.
+
+---
+
+Version 0.1.0 (12 March, 2011)
+
+* Initial version published to the web and to RubyGems.

data/LICENSE.md

@@ -0,0 +1,31 @@
+Grizzled Ruby is released under a **BSD license**, adapted from
+<http://opensource.org/licenses/bsd-license.php>
+
+Copyright &copy; 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", 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.

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,121 @@
+#                                                                  -*- ruby -*-
+#
+# NOTE: Man pages use the 'ronn' gem. http://rtomayko.github.com/ronn/
+
+require 'rake/clean'
+require 'pathname'
+
+PACKAGE = 'grizzled-ruby'
+GEMSPEC = "#{PACKAGE}.gemspec"
+RDOC_OUT_DIR = 'rdoc'
+GH_PAGES_DIR = File.join('..', 'gh-pages')
+RDOC_PUBLISH_DIR = File.join(GH_PAGES_DIR, 'apidocs')
+RUBY_SRC_DIR = 'lib'
+RUBY_FILES = FileList[File.join(RUBY_SRC_DIR, '**', '*.rb')]
+
+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 << [RDOC_OUT_DIR, GEM]
+
+# ---------------------------------------------------------------------------
+# Rules
+# ---------------------------------------------------------------------------
+
+# ---------------------------------------------------------------------------
+# Tasks
+# ---------------------------------------------------------------------------
+
+task :default => :build
+
+desc "Build everything"
+task :build => [:test, :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 => :rdoc
+
+file 'rdoc' => RUBY_FILES do |t|
+  require 'rdoc/rdoc'
+  puts('Running rdoc...')
+  mkdir_p File.dirname(RDOC_OUT_DIR) unless File.exists? RDOC_OUT_DIR
+  r = RDoc::RDoc.new
+  r.document(['-U', '-m', "#{RUBY_SRC_DIR}/grizzled.rb", '-o', RDOC_OUT_DIR,
+              RUBY_SRC_DIR])
+end
+
+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 => [:pubrdoc, :pubchangelog]
+
+task :pubrdoc => :doc do |t|
+  target = Pathname.new(RDOC_PUBLISH_DIR).expand_path.to_s
+  cd RDOC_OUT_DIR do
+    mkdir_p target
+    cp_r '.', target
+  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 Grizzled Ruby
+layout: default
+---
+
+EOF
+    f.write File.open('CHANGELOG.md').read
+    f.close
+  end
+end
+
+task :pub
+
+desc "Alias for 'docpub'"
+task :docpub => :pubdoc
+
+desc "Run the unit tests"
+task :test do |t|
+  FileList[File.join('test', '**', 't[cs]_*.rb')].each do |tf|
+    cd File.dirname(tf) do |dir|
+      ruby File.basename(tf)
+    end
+  end
+end

data/grizzled-ruby.gemspec

@@ -0,0 +1,32 @@
+#                                                                -*- ruby -*-
+
+Gem::Specification.new do |s|
+
+  s.name             = 'grizzled-ruby'
+  s.version          = '0.1.4'
+  s.date             = '2011-03-25'
+  s.summary          = 'Some general-purpose Ruby modules, classes, and tools'
+  s.authors          = ['Brian M. Clapper']
+  s.license          = 'BSD'
+  s.email            = 'bmc@clapper.org'
+  s.homepage         = 'http://software.clapper.org/grizzled-ruby'
+  s.has_rdoc         = true
+
+  s.description      = <<-ENDDESC
+Grizzled Ruby is a general purpose library of Ruby modules, classes and tools.
+ENDDESC
+
+  s.require_paths    = ['lib']
+
+  # = MANIFEST =
+  s.files            = Dir.glob('[A-Z]*')
+  s.files           += Dir.glob('*.gemspec')
+  s.files           += Dir.glob('lib/**/*')
+  s.files           += Dir.glob('rdoc/**/*')
+
+
+  # = MANIFEST =
+  s.test_files       = FileList['test/**/tc_*.rb'].to_a
+end
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grizzled-ruby
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Brian M. Clapper
@@ -15,21 +15,26 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -04:00
+date: 2011-03-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
 description: |
-  Grizzled Ruby is a general purpose library of Ruby modules and classes.
+  Grizzled Ruby is a general purpose library of Ruby modules, classes and tools.
 
 email: bmc@clapper.org
-executables: 
-- grinc
+executables: []
+
 extensions: []
 
 extra_rdoc_files: []
 
 files: 
+- README.md
+- LICENSE.md
+- CHANGELOG.md
+- Rakefile
+- grizzled-ruby.gemspec
 - lib/grizzled/fileutil.rb
 - lib/grizzled/stack.rb
 - lib/grizzled/fileutil/includer.rb
@@ -45,7 +50,6 @@ files:
 - test/fileutil/tc_includer.rb
 - test/fileutil/tc_make_dir_tree.rb
 - test/string/tc_template.rb
-- bin/grinc
 has_rdoc: true
 homepage: http://software.clapper.org/grizzled-ruby
 licenses: 
@@ -76,10 +80,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
-summary: Miscellaneous, general-purpose Ruby modules and classes
+summary: Some general-purpose Ruby modules, classes, and tools
 test_files: 
 - test/tc_stack.rb
 - test/tc_forwarder.rb

data/bin/grinc

@@ -1,151 +0,0 @@
-#!/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 '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
-  $stderr.puts("#{PROGRAM_NAME}: #{$!}")
-  exit 1
-
-else
-  exit 0
-end
-