ratch 0.4.1 → 1.0.0

data/lib/ratch/dsl/meta.rb

@@ -1,125 +0,0 @@
-# = TITLE:
-#
-#   Metadata / Configuration DSL
-#
-# = COPYING:
-#
-#   Copyright (c) 2007 Psi T Corp.
-#
-#   This file is part of the Ratch program.
-#
-#   Ratch 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.
-#
-#   Ratch 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 Ratch.  If not, see <http://www.gnu.org/licenses/>.
-
-require 'yaml'
-require 'ratch/support/filename'  # string ?
-require 'ratch/metadata/package'
-require 'ratch/metadata/release'
-
-module Ratch
-module Dsl
-
-  module Meta
-
-    DEFAULT_FOLD = '{,meta/,meta/config/}'
-    DEFAULT_FILE = '{config,meta/config,meta/config/general}{.yaml,.yml,}'
-
-    def package
-      @package ||= Package.load
-    end
-
-    # Roll file information.
-
-    def release
-      @rollrc ||= Release.load
-    end
-    alias_method :rollrc, :release
-
-    # Load configuration data from a file. The file will
-    # be looked for in the current script directory then
-    # from the project root.
-    #
-    # Since they are YAML files, they can optionally
-    # end with '.yaml' or '.yml'.
-
-    def configuration(file=nil)
-      @configuration ||= {}
-      @configuration[file] ||= (
-        if file = config_file(file)
-          config_read(file)
-        else
-          Hash.new{ |h,k| h[k] = {} }
-        end
-     )
-    end
-
-    # If a +path+ is given it will first be looked for in the config directory of
-    # the utility directory. If not there, then it will be looked for in the project's trunk.
-    #
-    # If +path+ is not given then config.yaml or config/general.yaml will be used.
-    #
-    # TODO: Consider more carfully where configuration should be stored.
-
-    def config_file(path=nil)
-      if path
-        find = DEFAULT_FOLD + "#{path}{.yaml,.yml,}"
-      else
-        find = DEFAULT_FILE
-      end
-      Dir.glob(find, File::FNM_CASEFOLD).find{ |f| File.file?(f) }
-    end
-
-    #
-
-    def config_read(path)
-      #find = "{#{utility_directory}/,}#{path}{.yaml,.yml,}"
-      #if file = Dir.glob(find)[0]
-      if File.file?(path)
-        YAML::load(File.open(path)) || {}  # The || {} is in case the file is empty.
-      else
-        raise LoadError, "Missing file -- #{path}"
-      end
-    end
-
-    # Create an argument vector from a set of config options.
-    # TODO Deprecate in favor of Hash extension.
-
-    def config_vector(config, args_field=nil)
-      config.command_vector(args_field)
-    end
-
-    #     # Load task configuration if any.
-    #
-    #     def config_load(*names) #, defaults=nil)
-    #
-    #       names.inject({}) do |memo, name|
-    #         name     = name.to_s
-    #         #defaults = defaults || {}
-    #
-    #         if file = config_file(name)
-    #           config = YAML.load(File.open(file))
-    #         elsif file = Dir.glob("#{utility_directory}/config{,.yaml,.yml}")[0]
-    #           config = YAML.load(File.open(file))[name.to_s]
-    #         else
-    #           config = {}
-    #         end
-    #
-    #         config.update(memo)
-    #       end
-    #       #return defaults.update(config || {})
-    #     end
-
-  end
-
-end
-end

data/lib/ratch/dsl/options.rb

@@ -1,98 +0,0 @@
-# = TITLE:
-#
-#   Options DSL
-#
-# = COPYING:
-#
-#   Copyright (c) 2007 Psi T Corp.
-#
-#   This file is part of the ProUtils' Ratch program.
-#
-#   Ratch 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.
-#
-#   Ratch 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 Ratch.  If not, see <http://www.gnu.org/licenses/>.
-
-module Ratch
-module Dsl
-
-  # Options. There are derived from ARGV.
-
-  module Options
-
-    # Duplicate of ARGV.
-
-    def argv
-      @argv ||= ARGV.dup
-    end
-
-    # Convert command line argv to args.
-    #
-    # TODO Is this implmented as expected?
-
-    def command_parameters
-      argv.to_params
-    end
-
-    # Debug mode.
-
-    def debug?
-      @debug ||= %w{--debug}.any?{|a| argv.delete(a)}
-    end
-
-    #
-
-    def verbose?
-      @verbose ||= %w{--verbose}.any?{|a| argv.delete(a)}
-    end
-
-    #
-
-    def verbose!
-      @verbose = true
-    end
-
-    #
-
-    def trace?
-      @trace ||= %w{--trace}.any?{|a| argv.delete(a)}
-    end
-
-    #
-
-    def trace!
-      @trace = true
-    end
-
-    #
-
-    def noharm?
-      @noharm ||= %w{--dryrun --dry-run --noharm}.any?{|a| argv.delete(a)}
-    end
-    alias_method :dryrun?, :noharm? ; module_function :dryrun?
-
-    def noharm!
-      @noharm = true
-    end
-    alias_method :dryrun!, :noharm! ; module_function :dryrun!
-
-    # Force mode.
-
-    def force?
-      @force ||= %w{--force}.any?{|a| argv.delete(a)}
-    end
-
-    def force! ; @force = true ; end
-
-  end
-
-end
-end

data/lib/ratch/dsl/setup.rb

@@ -1,124 +0,0 @@
-# = TITLE:
-#
-#   Setup DSL
-#
-# = SYNOPSIS:
-#
-#   Mixen used to setup a package, eg. a manual install.
-#
-# = COPYING:
-#
-#   Copyright (c) 2007 Psi T Corp.
-#
-#   This file is part of the ProUtils' Box program.
-#
-#   Box 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.
-#
-#   Box 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 Box.  If not, see <http://www.gnu.org/licenses/>.
-
-#
-module Ratch
-module Dsl
-
-  # = Setup DSL
-  #
-  # Setup utilities provides a convenient way to install
-  # a ruby project via setup.rb.
-
-  module Setup
-
-    # Installation to a prefix destination using setup.rb.
-    # Some package types need this.
-
-    def prefix_install(prefix)
-      mkdir_p(prefix)
-
-      unless setup_rb
-        raise "Setup.rb is missing. Forced to abort."
-      end
-      # mock install
-      cmd = ''
-      cmd << 'ruby setup.rb '
-      cmd << '-q ' unless project.verbose?
-      cmd << 'config --installdirs=std ; '
-      cmd << 'ruby setup.rb '
-      cmd << '-q ' unless project.verbose?
-      cmd << "install --prefix=#{prefix}"
-      sh cmd
-    end
-
-    # If setup.rb is not found add a copy to the project.
-    # FIXME
-
-    def setup_rb
-      unless File.exist?('setup.rb')
-        f = File.join(libdir,'vendor','setup.rb')
-        if File.exist?(f)
-          cp(f,'.')
-        else
-          raise "setup.rb is not avaialble"
-        end
-      end
-      true
-    end
-
-    #     # Setup and install. This builds and installs a project
-    #     # using setup.rb or install.rb. If neither exist setup.rb
-    #     # will be created for the purpose.
-    #     #
-    #     #     options    Command line options to add to shell command.
-    #     #     script     Install script, default is install.rb or setup.rb
-    #     #--
-    #     #     source     Location of source. (Defaults to current directory)
-    #     #++
-    #
-    #     def setup(keys={})
-    #
-    #       options = keys['options']
-    #       script  = keys['script']
-    #       #source = keys.source || Dir.pwd
-    #
-    #       options = [options].flatten.compact
-    #
-    #       if script
-    #         exe = script + ' '
-    #         exe << options.join(' ')
-    #       elsif File.exist?('install.rb')
-    #         exe = 'ruby install.rb '
-    #         exe << options.join(' ')
-    #       elsif File.exist?('setup.rb') or setup_rb
-    #         exe = 'ruby setup.rb '
-    #         exe << '-q ' unless verbose?
-    #         exe << options.join(' ')
-    #         exe << ' all'
-    #       else
-    #         puts "Script setup.rb or install.rb is missing."
-    #         return nil
-    #       end
-    #
-    #       # SHELLS OUT!
-    #
-    #       #Dir.chdir(source) do
-    #         #begin
-    #           success = sh(exe)
-    #           puts "Installation complete!" if success
-    #         #rescue Errno::EACCES
-    #         #  puts "Permission denied"
-    #         #  exit -1
-    #         #end
-    #       #end
-    #     end
-
-  end
-
-end
-end

data/lib/ratch/dsl/sign.rb

@@ -1,243 +0,0 @@
-# = TITLE:
-#
-#   Sign DSL
-#
-# = COPYING:
-#
-#   Copyright (c) 2007 Psi T Corp.
-#
-#   This file is part of the ProUtils' Box program.
-#
-#   Box 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.
-#
-#   Box 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 Box.  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 Ratch
-module Dsl
-
-  # Create signitures for libraries.
-  # FIXME
-
-  module Sign
-
-    # 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
-end