proutils 0.3.0

data/lib/proutils/xact/extract.rb

@@ -0,0 +1,211 @@
+# Title:
+#   Xacto
+#
+# Synopsis:
+#   Extractor is a tool for extracting code from embedded comment blocks.
+#
+# COPYRIGHT:
+#   Copyright (c) 2006,2007 Thomas Sawyer & Tyler Rick
+#
+# LICENSE:
+#   Distributed under the Ruby/GPL dual license.
+#
+# Authors:
+#   - Thomas Sawyer
+#   - Tyler Rick
+#
+# Todo:
+#   - Should extract_block handle more than the first matching block?
+#   - How can we handle embedded code in stadard comments? Eg. #
+#   - Should this code be wrapped in toplevel Ratchets module?
+
+require 'fileutils'
+require 'open-uri'
+require 'facets/string/tabs'  # for margin
+
+module Xact
+
+  # Text Extraction class.
+
+  class Extractor
+
+    attr :file
+    attr :options
+
+    alias_method :uri, :file
+
+    # New extractor.
+
+    def initialize(file, options={})
+      @file    = file
+      @options = options
+    end
+
+    # Read file.
+
+    def raw
+      @raw ||= open(@file) # File.read(@file)
+    end
+
+    #
+
+    def text
+      if options[:unxml]
+        @text = raw.gsub!(/\<(*.?)\>/, '')
+      else
+        @text = raw
+      end
+    end
+
+
+    # Extract Pattern.
+
+    def extract_pattern(pattern)
+      pattern = Regexp.new(pattern)
+
+      md = pattern.match(text)
+      if clip = md ? md[1] : nil
+        offset = text[0...md.begin(1)].count("\n")
+        return clip, offset
+      else
+        raise "Pattern not found -- #{pattern}"
+        return nil, nil
+      end
+    end
+
+    # Extract Block.
+
+    def extract_block(start, stop)
+      start = Regexp.new(start)
+      stop  = Regexp.new(stop)
+
+      md_start = start.match(text)
+      if md_start
+        md_stop = stop.match(text[md_start.end(0)..-1])
+        if md_stop
+          clip = text[md_start.end(0)...(md_stop.begin(0)+md_start.end(0))]
+        else
+          raise "Pattern not found -- #{stop}"
+          return nil, nil
+        end
+        offset = text[0...md_start.begin(0)].count("\n")  #?
+        return clip, offset
+      else
+        raise "Pattern not found -- #{start}"
+        return nil, nil
+      end
+    end
+
+    #################
+    # Ruby Specific #
+    #################
+
+    # Returns a Ruby comment block with a given handle.
+
+    def extract_ruby_block_comment(handle)
+      b = Regexp.escape(handle)
+      if b == ''
+        pattern = /^=begin.*?\n(.*?)\n=end/mi
+      else
+        pattern = /^=begin[ \t]+#{b}.*?\n(.*?)\n=end/mi
+      end
+      extract_pattern(pattern)
+    end
+
+    # Returns a Ruby method comment.
+
+    def extract_ruby_method_comment(meth) #=nil )
+      #if meth
+        regexp  = Regexp.escape(meth)
+        pattern = /(\A\s*\#.*?^\s*def #{regexp}/mi
+        extract_pattern(pattern)
+      #else
+      #  prog.scan /^\s*\#/mi
+      #  md = pattern_inline_all.match( prog )
+      #end
+    end
+
+#     # Extract the matching comment block.
+#
+#     def extract_block( handle='test' )
+#       text = File.read(file)
+#       md = pattern_block(handle).match(text)
+#       code = md ? md[1] : nil
+#       unless code
+#         puts "Code block not found -- #{handle}"
+#         exit 0 #return nil
+#       end
+#       offset = text[0...md.begin(1)].count("\n")
+#       return code, offset
+#     end
+#
+#     # Returns the comment inline regexp to match against.
+#
+#     def pattern_inline( mark )
+#       m = Regexp.escape(mark)
+#       /(\A\s*\#.*?^\s*def #{m}/mi
+#     end
+#
+#     def extract_inline( fname, mark=nil )
+#       prog = File.read( file )
+#       if mark
+#         md = pattern_inline(mark).match( prog )
+#       else
+#         prog.scan /^\s*\#/mi
+#         md = pattern_inline_all.match( prog )
+#       end
+#     end
+
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class ExtractorTest < Test::Unit::TestCase
+
+    def exacto_knife
+      @knife ||= Extractor.new('/dev/null')
+    end
+
+    def build_pattern_block(block, code)
+      exacto_knife.pattern_block(block).match(code)
+    end
+
+    # Usual case.
+
+    def test_pattern_block
+      assert_equal "require 'foo'\nfoo", build_pattern_block('test', "=begin test\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+    # Some tests for when the block is empty ('') -- should it act as a wildcard and match *any* block,
+    # or should Extractor::Command#initialize complain about that.
+
+    def test_pattern_block_no_handle
+      assert_equal "require 'foo'\nfoo", build_pattern_block('', "=begin\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+    def test_pattern_block_no_handle_given
+      assert_equal "require 'foo'\nfoo", build_pattern_block('', "=begin test\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+    # Yes, I know, as a side-effect of this regexp change, it will also match some invalid "blocks", like =beginblah. But that
+    # seems like a nonissue, given that the Ruby parser would reject that syntax anyway.
+
+    def test_pattern_block_side_effects
+      assert_equal "require 'foo'\nfoo", build_pattern_block('', "=beginblah\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+  end
+
+=end

data/lib/proutils/xact/save.rb

@@ -0,0 +1,151 @@
+# Title:
+#   Xacto
+#
+# Synopsis:
+#   Extractor is a tool for extracting code from embedded comment blocks.
+#
+# COPYRIGHT:
+#   Copyright (c) 2006,2007 Thomas Sawyer & Tyler Rick
+#
+# LICENSE:
+#   Distributed under the Ruby/GPL dual license.
+#
+# Authors:
+#   - Thomas Sawyer
+#   - Tyler Rick
+#
+# Todo:
+#   - Should extract_block handle more than the first matching block?
+#   - How can we handle embedded code in stadard comments? Eg. #
+#   - Should this code be wrapped in toplevel Ratchets module?
+
+require 'fileutils'
+require 'facets/string/tabs'  # for margin
+
+module Xact
+
+  #
+
+  module ExtractAndSave
+
+    extend self
+
+    # Extract unit tests. This task scans every package script
+    # looking for sections of the form:
+    #
+    #     =begin test
+    #       ...
+    #     =end
+    #
+    # With appropriate headers, it copies these sections to files
+    # in your project's test/ dir, which then can be run using the
+    # Ratchet test task. The exact directory layout of the files to
+    # be tested is reflected in the test directory. You can then
+    # use project.rb's test task to run the tests.
+    #
+    #     files      Files to extract ['lib/**/*.rb']
+    #     output     Test directory   ['test/']
+    #
+
+    def test_extract(files=nil)
+      output = 'test/embedded'     # Don't think output should be setable.
+
+      files  = files || 'lib/**/*.rb'
+      files = 'lib/**/*.rb' if TrueClass == files
+      files = [files].flatten.compact
+
+      filelist = files.collect{ |f| Dir.glob(f) }
+      filelist.flatten!
+      if filelist.empty?
+        puts "No scripts found from which to extract tests."
+        return
+      end
+
+      FileUtils.mkdir_p(output) unless File.directory?(output)
+
+      #vrunner = VerbosityRunner.new("Extracting", verbosity?)
+      #vrunner.setup(filelist.size)
+
+      filelist.each do |file|
+        #vrunner.prepare(file)
+
+        testing = extract_test_from_file( file )
+        if testing.strip.empty?
+          status = "[NONE]"
+        else
+          complete_test = create_test(testing, file)
+          libpath = File.dirname(file)
+          testfile = "test_" + File.basename(file)
+          fp = File.join(output, libpath, testfile)
+          unless File.directory?( File.dirname(fp))
+            FileUtils.mkdir_p(File.dirname(fp))
+          end
+          File.open(fp, "w"){ |fw| fw << complete_test }
+          status = "[TEST]"
+        end
+
+        #vrunner.complete(file, status)
+      end
+
+      #vrunner.finish(
+      #  :normal => "#{filelist.size} files had tests extracted.",
+      #  :check => false
+      #)
+    end
+
+    private
+
+    # Extract test from a file's testing comments.
+
+    def extract_test_from_file( file )
+      return nil if ! File.file?( file )
+      tests = ""; inside = false
+      fstr = File.read( file )
+      fstr.split(/\n/).each do |l|
+        if l =~ /^=begin[ ]*test/i
+          tests << "\n"
+          inside = true
+          next
+        elsif inside and l =~ /^=[ ]*end/
+          inside = false
+          next
+        end
+        if inside
+          tests << l << "\n"
+        end
+      end
+      tests
+    end
+
+    # Generate the test.
+
+    def create_test( testing, file )
+      fp = file.split(/[\/]/)
+      if fp[0] == 'lib'
+        reqf = "require '#{fp[1..-1].join('/')}'"
+      else
+        reqf = ''
+      end
+      teststr = <<-HERE.margin
+        `#  _____         _
+        `# |_   _|__  ___| |_
+        `#   | |/ _ \\/ __| __|
+        `#   | |  __/\\__ \\ |_
+        `#   |_|\\___||___/\\__|
+        `#
+        `# for #{file}
+        `#
+        `# Extracted #{Time.now}
+        `# Project.rb Test Extraction
+        `#
+        `
+        `#{reqf}
+        `
+      HERE
+      teststr << testing << "\n"
+      teststr
+    end
+
+  end
+
+end

data/meta/MANIFEST

@@ -0,0 +1,100 @@
+# -x pkg -x doc -x work
+CHANGES
+COPYING
+README
+RELEASE
+TODO
+bin
+bin/icli
+bin/mint
+bin/rtar
+bin/xact
+data
+data/mint
+data/mint/cherry
+data/mint/cherry/_scaffold.rb
+data/mint/roll
+data/mint/roll/name-1.0.0.roll
+data/mint/ruby
+data/mint/ruby/README
+data/mint/ruby/README.first
+data/mint/ruby/README.license
+data/mint/ruby/bin
+data/mint/ruby/data
+data/mint/ruby/doc
+data/mint/ruby/doc/index.html
+data/mint/ruby/doc/log
+data/mint/ruby/doc/log/ChangeLog
+data/mint/ruby/doc/log/TODO
+data/mint/ruby/doc/note
+data/mint/ruby/ext
+data/mint/ruby/lib
+data/mint/ruby/meta
+data/mint/ruby/meta/MANIFEST
+data/mint/ruby/meta/name-1.0.0.roll
+data/mint/ruby/script
+data/mint/ruby/script/finish_scaffold
+data/mint/ruby/script/setup
+data/mint/ruby/test
+data/mint/website
+data/mint/website/css
+data/mint/website/css/clean.css
+data/mint/website/img
+data/mint/website/index.html
+demo
+demo/demo_rtar
+demo/demo_rtar/Lorem_ipsum.txt
+demo/demo_rtar/lib
+demo/demo_rtar/lib/demo_rock
+demo/demo_rtar/lib/demo_rock/tryme.rb
+demo/demo_rtar/meta
+demo/demo_rtar/meta/data
+demo/demo_rtar/web
+demo/demo_rtar/web/index.html
+demo/demo_rtar/web/rocklobster.jpg
+demo/mint
+demo/mint/loremipsum.txt
+demo/mint/tryme.rb
+lib
+lib/proutils
+lib/proutils/icli
+lib/proutils/icli/abstract_host.rb
+lib/proutils/icli/gforge.rb
+lib/proutils/icli/rubyforge.rb
+lib/proutils/icli/tool.rb
+lib/proutils/icli/uploadutils.rb
+lib/proutils/mint
+lib/proutils/mint/copier.rb
+lib/proutils/mint/fileutils.rb
+lib/proutils/mint/help.txt
+lib/proutils/rtar
+lib/proutils/rtar/rtar.rb
+lib/proutils/rtar/vendor
+lib/proutils/rtar/vendor/archive
+lib/proutils/rtar/vendor/archive/tar
+lib/proutils/rtar/vendor/archive/tar/minitar
+lib/proutils/rtar/vendor/archive/tar/minitar/command.rb
+lib/proutils/rtar/vendor/archive/tar/minitar.rb
+lib/proutils/xact
+lib/proutils/xact/extract.rb
+lib/proutils/xact/save.rb
+meta
+meta/MANIFEST
+meta/config.yaml
+meta/icli.yaml
+meta/project.yaml
+meta/proutils.roll
+task
+task/changelog
+task/clobber
+task/clobber/package
+task/prepare
+task/publish
+task/rdoc
+task/release
+task/setup
+task/test
+test
+test/fixture.rb
+test/lib
+test/lib/test_exacto.rb

data/meta/config.yaml

@@ -0,0 +1,12 @@
+---
+
+rdoc:
+  title: ProUtils
+  main: README
+  template: jamis
+  options: [ '--all', '--inline-source' ]
+  exclude:
+    - lib/proutils/rtar/vendor
+
+publish:
+  project: proutils

data/meta/icli.yaml

@@ -0,0 +1,16 @@
+---
+rubyforge:
+  project  : proutils
+  username : transami
+
+  release:
+    store     : pkg
+    package   : proutils
+    notelog   : RELEASE
+    changelog : CHANGES
+
+  publish: {}
+
+  announce:
+    message: README
+

data/meta/project.yaml

@@ -0,0 +1,27 @@
+title    : ProUtils
+summary  : Ruby Recursive Archival Format
+description: >
+  ProUtils is a collect of handy command line tools. Think of it as a
+  supplement to the ubinqutous GNU CoreUtils.
+
+author     : Trans <transfire at gmail.com>
+homepage   : "http://proutils.rubyforge.org"
+download   : "https://rubyforge.org/frs/?group_id=4411"
+maillist   : proutils-talk@rubyforge.org
+repository : "http://proutils.rubyforge.org/svn/"
+created    : "2006-05-09"
+
+dependency:
+  - [ facets    , '> 2.2.0']
+  - [ httpclient, '> 2.0.0' ]
+
+executables:
+  - icli
+  - mint
+  - rtar
+  - xact
+  # - exrb
+
+exclude  : [ doc, task, pkg ]
+document : true
+

data/meta/proutils.roll

@@ -0,0 +1,3 @@
+proutils 0.3.0 beta 2007-12-17
+lib/proutils
+

data/test/fixture.rb

@@ -0,0 +1,6 @@
+
+=begin test
+  puts "here"
+=end
+
+

data/test/lib/test_exacto.rb

@@ -0,0 +1,54 @@
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+# for lib/exacto.rb
+#
+# Extracted Fri Feb 23 00:03:20 EST 2007
+# Project.rb Test Extraction
+#
+
+require 'exacto.rb'
+
+
+  require 'test/unit'
+
+  class ExactoTest < Test::Unit::TestCase
+
+    def exacto_knife
+      @knife ||= Exacto.new('/dev/null')
+    end
+
+    def build_pattern_block(block, code)
+      exacto_knife.pattern_block(block).match(code)
+    end
+
+    # Usual case.
+
+    def test_pattern_block
+      assert_equal "require 'foo'\nfoo", build_pattern_block('test', "=begin test\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+    # Some tests for when the block is empty ('') -- should it act as a wildcard and match *any* block,
+    # or should Exacto::Command#initialize complain about that.
+
+    def test_pattern_block_no_handle
+      assert_equal "require 'foo'\nfoo", build_pattern_block('', "=begin\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+    def test_pattern_block_no_handle_given
+      assert_equal "require 'foo'\nfoo", build_pattern_block('', "=begin test\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+    # Yes, I know, as a side-effect of this regexp change, it will also match some invalid "blocks", like =beginblah. But that
+    # seems like a nonissue, given that the Ruby parser would reject that syntax anyway.
+
+    def test_pattern_block_side_effects
+      assert_equal "require 'foo'\nfoo", build_pattern_block('', "=beginblah\nrequire 'foo'\nfoo\n=end")[1]
+    end
+
+  end
+
+

data/work/ANN

@@ -0,0 +1,14 @@
+    ______                __
+   / ____/ __ ____  _____/ /_ ___
+  / __/ \ /  / __ `/ ___/ __/ __ \
+ / /__ >   </ /_/ / /__/ /_/ /_/ /
+/_____/_/ \_\__,_/\___/\__/\____/  v.$version
+
+$description
+
+$homepage
+
+$news
+
+$slogan
+