quarry 0.3.0 → 0.4.0

data/work/sandbox/build/sign.rb

@@ -0,0 +1,241 @@
+# = TITLE:
+#
+#   Sign DSL
+#
+# = COPYING:
+#
+#   Copyright (c) 2007,2008 Tiger Ops
+#
+#   This file is part of the Reap program.
+#
+#   Reap is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   Reap is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU General Public License for more details.
+#
+#   You should have received a copy of the GNU General Public License
+#   along with Reap.  If not, see <http://www.gnu.org/licenses/>.
+#
+# = TODO:
+#   - Do signitures belong under data/{name}/?
+#     Heck do all these metadata files belong there?
+#     OTOH using remote require, how would one access these?
+#     should they be contigious to the libs themselves?
+
+#require 'autorake/tasks/manifest'
+
+#
+module Quarry
+
+  # Create signitures for libraries.
+  # FIXME
+
+  class Sign < Build
+
+    # Default set of files to sign.
+    DEFAULT_SIGN_FILES = ['lib/**/*', 'ext/**/*']
+
+    DEFAULT_PUBLIC_KEY  = 'pubkey.pem'
+    DEFAULT_PRIVATE_KEY = '_privkey.pem'
+
+    # Generate file signitures. This task generates signitures
+    # for each library file using public/private keys.
+    # The sign script will generate encrypted signitures for
+    # files in the project --by default the lib/ and ext/ files.
+    #
+    #   name       Project name [name]
+    #   keyfile    Pathname to .pem file for private key
+    #   files      Files to include/exclude.
+    #   output     Directory to store signiture files
+    #               [data/{name}/signitures/]
+    #
+    # By default the keyfile is '_privkey.pem'. (BE SURE NEVER
+    # TO PUBLISH THIS FILE!!!) But if no a private key file is
+    # given/found, this will ask if you would like to
+    # generate one. It also can generate a public key for the
+    # project if it does not have one.
+    #
+    # There are two ways to approach key usage here. Either
+    # a per project key pair, or use a personal key pair.
+
+    def sign( override=nil )
+      name     = info.project
+      keyfile  = info.private_key
+
+      output   = info.sign_output
+      files    = info.sign_files
+
+      files    ||= DEFAULT_SIGN_FILES
+      keyfile  ||= DEFAULT_PRIVATE_KEY
+      output   ||= File.join('data',name,'signitures')
+
+      files = Dir.multiglob_with_default(DEFAULT_SIGN_FILES, files)
+
+      unless File.directory?( dir = File.dirname(output) )
+        puts "Output directory #{dir} doesn't exist."
+        return nil
+      end
+
+      output = File.expand_path(output)
+
+      unless keyfile and File.exist?(keyfile)
+        ans = ask("Private key file required. Generate one?", "yN")
+        case ans
+        when 'y', 'Y'
+          keyfile = genkey(name)
+          puts "\nFile '#{keyfile}' created. Be sure to keep this file private and secure."
+        else
+          puts "Task cancelled."
+          exit -1
+          #return nil
+        end
+      end
+
+      keyfile = File.expand_path(keyfile)
+
+      generate_signitures(keyfile, files, output)
+    end
+
+    private
+
+    # Generate a signiture for a file.
+
+    def generate_signitures( keyfile, files, to_folder )
+      privkey = load_key(keyfile)
+
+      dir = File.dirname(to_folder)
+      save_key(privkey.public_key, File.join(dir, DEFAULT_PUBLIC_KEY))
+
+      fu.mkdir_p(to_folder)
+      files.each do |file|
+        next if File.directory?(file)
+        sig = sign_file(privkey, file)
+        write_signiture(to_folder, file, sig)
+      end
+    end
+
+    # Write signiture to file.
+
+    def write_signiture( to_folder, file, sig )
+      sigfile = File.join(to_folder, file + '.sig')
+      fu.mkdir_p(File.dirname(sigfile))
+      if project.dryrun?
+        puts "(save #{sigfile})" unless project.quiet?
+      else
+        File.open( sigfile, 'w' ) do |f|
+          f << sig
+        end
+      end
+    end
+
+    # Generate a signiture of a file.
+
+    def sign_file( key, file )
+      plain = File.read( file )
+      dig = digester(info.digest||'sha256').new
+      sig = key.sign(dig, plain)
+      return sig
+    end
+
+    # Verify a signiture of a file.
+
+    def verify_signiture?( pubkey, sig, plain )
+      plain = plain.read if IO === plain
+      dig = digester(info.digest||'sha256').new
+      success = pubkey.verify(dig, sig, plain)
+      return success
+    end
+
+    # Generate a public key from a private key.
+    #
+    #def pubkey( privkey )
+    #  pubkey = privkey.public_key
+    #  return pubkey
+    #end
+
+    # Load key.
+
+    def load_key( file )
+      key = OpenSSL::PKey::RSA.new(File.read(file))
+    end
+
+    # Save key.
+
+    def save_key( key, file )
+      if project.dryrun?
+        puts "(save #{file})" unless project.quiet?
+      else
+        File.open( file, 'w' ) do |f|
+          f << key.to_pem
+        end
+      end
+    end
+
+    # Generate a private key and save it to '_privkey.pem'.
+
+    def genkey( name )
+      key = OpenSSL::PKey::RSA.new(2048){ print "." } # @name }
+      save_key( key, PRIVATE_KEY )
+      return PRIVATE_KEY
+    end
+
+    #   def write_keypair( libname )
+    #     privkey = genkey( libname )
+    #     pubkey = privkey.public_key
+    #     save_key( privkey, "privkey.pem" )
+    #     save_key( pubkey, "pubkey.pem" )
+    #     puts "Key pair generated. Please secure privkey.pem."
+    #   end
+    #
+    #   # Generate a private key.
+    #
+    #   def genkey( libname='.' )
+    #     key = OpenSSL::PKey::RSA.new(2048) { print "." } # libname }
+    #     return key
+    #   end
+    #
+    #   # Generate a public key from a private key.
+    #
+    #   def pubkey( privkey )
+    #     pubkey = privkey.public_key
+    #     return pubkey
+    #   end
+
+    # Return a digest class for given +type+.
+    # Supported digests are:
+    #
+    # * md5
+    # * sha1
+    # * sha128  (same as sha1)
+    # * sha256
+    # * sha512
+    #
+    # Default digest type is sha256.
+
+  #   def digester( type=nil )
+  #     require 'openssl'
+  #     type = 'sha256' unless type
+  #     case type.to_s.downcase
+  #     when 'md5'
+  #       require 'digest/md5'
+  #       Digest::MD5
+  #     when 'sha128', 'sha1'
+  #       require 'digest/sha1'  #need?
+  #       OpenSSL::Digest::SHA1
+  #     when 'sha256'
+  #       require 'digest/sha1'  #need?
+  #       OpenSSL::Digest::SHA256
+  #     when 'sha512'
+  #       require 'digest/sha1'  #need?
+  #       OpenSSL::Digest::SHA512
+  #     end
+  #   end
+
+  end
+
+end

data/work/sandbox/build/stamp.rb

@@ -0,0 +1,37 @@
+rquire 'quarry/build'
+
+module Quarry
+
+  # Create a VERSION stamp.
+
+  class Stamp < Build
+
+    attr_accessor :file
+    attr_accessor :name
+    attr_accessor :version
+    attr_accessor :status
+
+    attr_accessor :default
+    attr_accessor :libpath
+
+    # Update release "stamp" (.roll) file.
+
+    def stamp
+      w = ''
+      w << "#{name} #{version} #{status} #{Time.now.strftime('%Y-%m-%d')}"
+      w << " #{default}" if default
+      w << "\n"
+      w << libpath.join("\n")
+
+      if dryrun?
+        puts file + ":"
+        puts w
+      else
+        File.open(file, 'w'){|f| f << w}
+        puts "#{file} updated."
+      end
+    end
+
+  end
+
+end

data/work/sandbox/build/stats.rb

@@ -0,0 +1,154 @@
+require 'quarry/build'
+
+module Quarry
+
+  #
+
+  class Stats < Build
+
+    DEFAULT_LOADPATH = ['lib']
+
+    # List of file path(s) of project scripts to code count.
+
+    attr_accessor :loadpath
+    attr_accessor :exclude
+
+    alias_method :include, :loadpath
+    alias_method :include=, :loadpath=
+
+    # Simple code count analysis.
+    #
+    # Scan source code counting files, lines of code and
+    # comments and presents a report of it's findings.
+    #
+    #   scripts    Files to include and/or exclude in
+    #              analysis. The default includes all
+    #              files in the lib/ and ext/ directories.
+    #
+    # TODO Support - and + augmentations for configuration ?
+
+    def stats(options=nil)
+      options ||= {}
+
+      glob = options[:include] || options[:loadpath] || loadpath || DEFAULT_LOADPATH
+      excl = options[:exclude] || exclude  || []
+
+      if String===glob
+        glob = glob.split(/[:;]/)
+      end
+
+      files = multiglob_r(*glob) - multiglob_r(*excl)
+
+      #() #.inject([]){ |memo, find| memo.concat(glob(find)); memo }
+      #Dir.multiglob_with_default(DEFAULT_STATS_FILES)
+
+      fc, l, c, r, t, s = *line_count(*files)
+
+      fct, lt, ct, rt, tt, st = *([0]*6)
+      if File.directory?('test')
+        fct, lt, ct, rt, tt, st = *line_count('test/**/*')
+        t = lt if lt > 0
+      end
+
+      rat = lambda do |d,n|
+        if d > n and n != 0
+          "%.1f" % [ d.to_f / n ]
+        elsif n > d and d != 0
+          "-" #"%.1f:1" % [ n.to_f / d ]
+        elsif d == 0 or n == 0
+          "-"
+        else
+          "1.0"
+        end
+      end
+
+      per = lambda do |n,d|
+        if d != 0
+          (((n.to_f / d)*100).to_i).to_s + "%"
+        else
+          "-"
+        end
+      end
+
+      max = l.to_s.size + 4
+
+      puts
+      #puts "FILES:"
+      #puts "  source: #{fc}"
+      #puts "  test  : #{fct}"
+      #puts "  total : #{fc+fct}"
+      #puts
+      #puts "LINES:"
+      #puts "  code  : %#{max}s   %4s" % [ c.to_s, per[c,l] ]
+      #puts "  docs  : %#{max}s   %4s" % [ r.to_s, per[r,l] ]
+      #puts "  space : %#{max}s   %4s" % [ s.to_s, per[s,l] ]
+      #puts "  test  : %#{max}s   %4s" % [ t.to_s, per[t,l] ]
+      #puts "  total : %#{max}s   %4s" % [ l.to_s, per[l,l] ]
+      #puts
+      #puts "Ratio to 1 :"
+      #puts "  code to test : #{rat[c,t]} #{per[c,t]}"
+
+      head = ["Total", "Code", "-%-", "Docs", "-%-", "Blank", "-%-", "Files"]
+      prod = [l.to_s, c.to_s, per[c,l], r.to_s, per[r,l], s.to_s, per[s,l], fc]
+      test = [lt.to_s, ct.to_s, per[ct,l], rt.to_s, per[rt,l], st.to_s, per[st,l], fct]
+      totl = [(l+lt), (c+ct), per[c+ct,l+lt], (r+rt), per[r+rt,l+lt], (s+st), per[s+st,l+lt], (fc+fct)]
+
+      puts "TYPE    %#{max}s %#{max}s %4s %#{max}s %4s %#{max}s %4s %#{max}s" % head
+      puts "Source  %#{max}s %#{max}s %4s %#{max}s %4s %#{max}s %4s %#{max}s" % prod
+      puts "Test    %#{max}s %#{max}s %4s %#{max}s %4s %#{max}s %4s %#{max}s" % test
+      puts "Total   %#{max}s %#{max}s %4s %#{max}s %4s %#{max}s %4s %#{max}s" % totl
+      puts
+      puts "RATIO     Code    Docs    Blank   Test   Total"
+      puts "Code   %7s %7s %7s %7s %7s" % [ rat[c,c], rat[c,r], rat[c,s], rat[c,t], rat[c,l] ]
+      puts "Docs   %7s %7s %7s %7s %7s" % [ rat[r,c], rat[r,r], rat[r,s], rat[r,t], rat[r,l] ]
+      puts "Blank  %7s %7s %7s %7s %7s" % [ rat[s,c], rat[s,r], rat[s,s], rat[s,t], rat[s,l] ]
+      puts "Test   %7s %7s %7s %7s %7s" % [ rat[t,c], rat[t,r], rat[t,s], rat[t,t], rat[t,l] ]
+      puts "Total  %7s %7s %7s %7s %7s" % [ rat[l,c], rat[l,r], rat[l,s], rat[l,t], rat[l,l] ]
+      puts
+    end
+
+    private
+
+    # Return line counts for files.
+
+    def line_count( *files )
+      files = files.inject([]) do |memo, find|
+        memo.concat(Dir.glob(find)); memo
+      end
+
+      fc, l, c, t, r = 0, 0, 0, 0, 0
+      bt, rb = false, false
+
+      files.each do |fname|
+        next unless fname =~ /.*rb/      # TODO should this be done?
+        fc += 1
+        File.open( fname ) do |f|
+          while line = f.gets
+            l += 1
+            next if line =~ /^\s*$/
+            case line
+            when /^=begin\s+test/
+              tb = true; t+=1
+            when /^=begin/
+              rb = true; r+=1
+            when /^=end/
+              t+=1 if tb
+              r+=1 if rb
+              rb, tb = false, false
+            when /^\s*#/
+              r += 1
+            else
+              c+=1 if !(rb or tb)
+              r+=1 if rb
+              t+=1 if tb
+            end
+          end
+        end
+      end
+      s = l - c - r - t
+      return fc, l, c, r, t, s
+    end
+
+  end
+
+end

data/work/sandbox/build/svn.rb

@@ -0,0 +1,193 @@
+require 'quarry/build'
+
+module Quarry
+
+  #
+
+  class Svn < Build
+
+    # Tag current version (via rubyforge).
+
+    def tag
+      name, version = release.name, release.version
+
+      config = configuration['tag']
+
+      prefix = commandline('prefix') || config['prefix']
+      prefix = prefix + '_' if prefix && prefix !~ /[_-]$/
+
+      tagdir = config['tagdir'] || 'tags'
+
+      rubyforge_username = ENV['RUBYFORGE_USERNAME']
+      rubyforge_project = config['project'] || name
+
+      abort "Need RUBYFORGE_USERNAME evironment setting." unless rubyforge_username
+
+      tagname = "#{prefix}#{version}"
+      tagname = File.join(tagdir, tagname) if tagdir
+
+      puts "Tag '#{tagname}' ?"
+
+      case ask("Continue? [yN]").strip.downcase
+      when 'y', 'yes'
+        svn "copy", "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{name}/trunk",
+                    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{name}/#{tagname}"
+      end
+    end
+
+    # Create changelog.
+
+    def log(format=:rd)
+      case format
+      when :rd
+        log_rd
+      when :xml
+        log_xml
+      end
+    end
+
+    # Create a human readable changelog.
+
+    def log_rd
+      config = configuration['log']
+      txtlog = config['file'] || 'ChangeLog'
+
+      text = `svn log`
+
+      changes = log_parse(text)
+      sorted  = log_organize(changes)
+      string  = log_format(sorted)
+
+      if dryrun?
+        puts string
+      else
+        File.open(txtlog, 'w'){|f| f << string }
+      end
+    end
+
+    private
+
+    #
+
+    def log_parse(text)
+      changes = []
+      entries = text.split(/^[-]+\n/)
+      entries.shift # get rid of emtpy first
+      entries.each do |entry|
+        lines = entry.split(/\n/)
+        data  = lines.shift
+        text  = lines.join("\n").strip
+
+        rev, who, date, *rest = *data.split('|')
+        rev.strip!
+        who.strip!
+        date = date.strip.split(/\s+/).first
+
+        changes << [ date, who, rev, text ]
+      end
+      changes
+    end
+
+    #
+
+    def log_organize(changes)
+      mapped = {}
+      changes.each do |date, who, rev, text|
+        mapped[[date, who]] ||= []
+        mapped[[date, who]] << [text, rev]
+      end
+      sorted = []
+      mapped.each do |(date, who), entries|
+        sorted << [ date, who, entries ]
+      end
+      sorted.sort{ |a,b| b[0] <=> a[0] }
+    end
+
+    #
+
+    def log_format(sorted)
+      string = "= ChangeLog\n\n"
+      sorted.each do |date, who, entries|
+        string << "== #{date}  #{who}\n\n"  # no email :(
+        entries.each do |entry|
+          string << "* #{entry.first} (#{entry.last})\n"
+        end
+        string << "\n"
+      end
+      string
+    end
+
+    public
+
+    # Create a XML-formatted changelog.
+
+    def log_xml
+      config  = configuration['log']
+      xmlfile = config['xmlfile'] || 'doc/changelog.xml'
+      xslfile = File.join(File.dirname(xmlfile), 'changelog.xsl')
+
+      log_xsl(xslfile)
+
+      text = `svn log --xml`
+      i = text.index("?>\n")
+      text.insert(i+2, "\n" + '<?xml-stylesheet href="changelog.xsl" type="text/xsl" ?>')
+
+      if dryrun?
+        puts text
+      else
+        File.open(xmlfile){ |f| f << text }
+      end
+    end
+
+    private
+
+    #
+
+    def log_xsl(xslfile)
+      if force? or not File.exist?(xslfile)
+        File.open(xslfile, 'w') do |f|
+          f << XSLOG
+        end
+      end
+    end
+
+    XSLOG = <<-END
+    <?xml version="1.0" encoding="ISO-8859-1"?>
+    <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
+
+      <xsl:output cdata-section-elements="script"/>
+
+      <xsl:template match="/">
+        <html>
+          <head>
+            <title>Changelog</title>
+            <link REL='SHORTCUT ICON' HREF="../img/ruby-sm.png" />
+            <style>
+              td { font-family: sans-serif;  padding: 0px 10px; }
+            </style>
+          </head>
+          <body>
+          <div class="container">
+            <h1>Changelog</h1>
+            <table style="width: 100%;">
+              <xsl:apply-templates />
+            </table>
+          </div>
+          </body>
+        </html>
+      </xsl:template>
+
+      <xsl:template match="logentry">
+          <tr>
+            <td><b><pre><xsl:value-of select="msg"/></pre></b></td>
+            <td><xsl:value-of select="author"/></td>
+            <td><xsl:value-of select="date"/></td>
+          </tr>
+      </xsl:template>
+
+    </xsl:stylesheet>
+    END
+
+  end
+
+end