rubycut-vclog 1.9.4

data/lib/vclog/cli/bump.rb

@@ -0,0 +1,29 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  #
+  class Bump < Abstract
+
+    #
+    def self.terms
+      ['bump']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog-bump"
+        opt.separator(" ")
+        opt.separator("Display a bumped version number.")
+      end
+    end
+
+    #
+    def execute
+      puts repo.bump #(version)
+    end
+
+  end
+
+end

data/lib/vclog/cli/formats.rb

@@ -0,0 +1,28 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  # Command to display a list of available formats.
+  #
+  class Formats < Abstract
+
+    #
+    def self.terms
+      ['formats', 'templates']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog-formats"
+      end
+    end
+
+    #
+    def execute
+      puts "  ansi  gnu  rdoc  markdown  xml  html  atom  rss  json  yaml"
+    end
+
+  end
+
+end

data/lib/vclog/cli/log.rb

@@ -0,0 +1,86 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  # VCLog provides cross-vcs ChangeLogs. It works by
+  # parsing the native changelog a VCS system produces
+  # into a common model, which then can be used to
+  # produce Changelogs in a variety of formats.
+  #
+  # VCLog currently support git, hg and svn, with cvs and
+  # darcs in the works.
+  #
+  # To produce a GNU-like changelog:
+  #
+  #   $ vclog
+  #
+  # For XML format:
+  #
+  #   $ vclog -f xml
+  #
+  # Or for a micorformat-ish HTML:
+  #
+  #   $ vclog -f html
+  #
+  # To use the library programmatically, please see the API documentation.
+  #
+  class Log < Abstract
+
+    # Setup options for log command.
+    #
+    # Returns a instance of OptionParser.
+    def parser
+      super do |parser|
+        parser.banner = 'Usage: vclog [options]'
+        parser.separator(' ')
+        parser.separator('Print a change log or release history.')
+        parser.separator(' ')
+        parser.separator('OPTIONS: (use varies with format)')
+        parser.on('-f', '--format FORMAT', 'output format (ansi,gnu,html,...)') do |format|
+          options[:format] = format.to_sym
+        end
+        parser.on('-r', '--release', '--history', 'show release history, instead of changelog') do
+          options[:type] = :history
+        end
+        parser.on('-t', '--title TITLE', 'document title') do |string|
+          options[:title] = string
+        end
+        parser.on('-v', '--version NUM', 'use as current version number') do |num|
+          options[:version] = num
+        end
+        parser.on('-l', '--level NUMBER', 'lowest level of commit to display (default: 0)') do |num|
+          options[:level] = num.to_i
+        end
+        parser.on('-p', '--point', 'split commit message into per-point entries') do
+          options[:point] = true
+        end
+        parser.separator(' ')
+        parser.separator('XML/HTML OPTIONS: (applies only to xml/html formats)')
+        parser.on('-S', '--style URI', 'provide a stylesheet URI (css or xsl)') do |uri|
+          options[:stylesheet] = uri
+        end
+        parser.separator(' ')
+        parser.separator('TEXT OPTIONS: (applies only to text formats)')
+        parser.on('-i', '--id', 'include reference/revision id in output') do
+          options[:reference] = true  # TODO: change to :id ?
+        end
+        parser.on('-d', '--detail', 'include commit message details (no effect if -p)') do
+          options[:detail] = true
+        end
+        parser.on('-s', '--summary', 'exclude commit messages from report') do
+          options[:summary] = true
+        end
+        #parser.on('--typed', "catagorize by commit type") do
+        #  typed = true
+        #end
+      end
+    end
+
+    #
+    def execute
+      puts repo.report(options)
+    end
+
+  end
+
+end

data/lib/vclog/cli/news.rb

@@ -0,0 +1,29 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  #
+  class News < Abstract
+
+    #
+    def self.terms
+      ['news']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog-news"
+        opt.separator(" ")
+        opt.separator("Display first release note from history file.")
+      end
+    end
+
+    #
+    def execute
+      puts repo.history_file.news #(version)
+    end
+
+  end
+
+end

data/lib/vclog/cli/version.rb

@@ -0,0 +1,30 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  # Display the current version.
+  #
+  class Version < Abstract
+
+    #
+    def self.terms
+      ['version']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog version"
+        opt.separator(" ")
+        opt.separator("Display the current version number.")
+      end
+    end
+
+    #
+    def execute
+      puts repo.version
+    end
+
+  end
+
+end

data/lib/vclog/config.rb

@@ -0,0 +1,143 @@
+require 'vclog/heuristics'
+#require 'vclog/rc'
+
+module VCLog
+
+  # Get/set master configruation(s).
+  def self.configure(&block)
+    @config ||= []
+    @config << block if block
+    @config
+  end
+
+  # Encapsulates configuration settings for running vclog.
+  #
+  # We recommend putting vclog configuration in a project's `etc/vclog.rb`
+  # file. For Rails projects, however, `config/vclog.rb` can be used. If
+  # usig a subdirectory is not suitable to a project then simply using
+  # the more traditional `.vclog` file works too.
+  #
+  class Config
+
+    # File glob for identifying the project's root directory.
+    #
+    # NOTE: SVN support is limited to repos with a trunk directory.
+    ROOT_GLOB = "{.git,.hg,_darcs,.svn/trunk}"
+
+    #
+    # Default vclog config file glob looks for these possible matches:
+    #
+    # * vclog.rb
+    # * etc/vclog.rb
+    # * config/vclog.rb
+    #
+    # The configuration file can also be a hidden dot file if preferred:
+    #
+    # * .vclog
+    # * .etc/vclog.rb
+    # * .config/vclog.rb
+    #
+    # Root files have precedence over files in subdirectories, and the `.rb`
+    # file extension is optional in all cases.
+    #
+    FILE_GLOBS = [ '{,.}vclog{,.rb}', '{.,}{etc/,config/}vclog{,.rb}' ]
+
+    #
+    #
+    #
+    def initialize(options={})
+      @root    = options[:root]  || lookup_root
+      @level   = options[:level] || 0
+      @force   = options[:force] || false
+      @version = options[:version]
+    end
+
+    #
+    # Project's root directory.
+    #
+    attr :root
+
+    #
+    # Default change level.
+    #
+    def level
+      heuristics.level
+    end
+
+    #
+    # Force mode active?
+    #
+    def force?
+      @force
+    end
+
+    #
+    # Indicates the version of HEAD.
+    #
+    def version
+      @version
+    end
+
+    #
+    # Load heuristics.
+    #
+    def heuristics
+      @heuristics ||= (
+        if file
+          Heuristics.load(file)
+        else
+          h = Heuristics.new
+          if config = VCLog.configure
+            config.each{ |c| c.call(h) }
+          end
+          h
+        end
+      )
+    end
+
+    #
+    # Which version control system?
+    #
+    def vcs_type
+      @vcs_type ||= (
+        dir = nil
+        Dir.chdir(root) do
+          dir = Dir.glob("{.git,.hg,.svn,_darcs}").first
+        end
+        dir[1..-1] if dir
+      )
+    end
+
+    #
+    # The vclog config file.
+    #
+    def file
+      #DEFAULT_GLOBS.find{ |g| Dir.glob(g).first }
+    end
+
+    #
+    # Find project root. This searches up from the current working
+    # directory for a source control manager directory.
+    #
+    # * `.git/`
+    # * `.hg/`
+    # * `_darcs/`
+    # * `.svn/trunk`
+    #
+    # If all else fails the current directory is returned.
+    #
+    def lookup_root
+      root = nil
+      Dir.ascend(Dir.pwd) do |path|
+        check = Dir[ROOT_GLOB].first
+        if check
+          root = path
+          break
+        end
+      end
+      root || Dir.pwd
+    end
+
+  end
+
+end

data/lib/vclog/core_ext.rb

@@ -0,0 +1,11 @@
+require 'facets/string/fold'
+require 'facets/string/indent'
+require 'facets/string/tabto'
+require 'facets/string/margin'
+require 'facets/enumerable/group_by'
+require 'facets/kernel/ask'
+
+class OpenStruct
+  method_undef(:type) if method_defined?(:type)
+end
+

data/lib/vclog/heuristics.rb

@@ -0,0 +1,192 @@
+require 'vclog/heuristics/type'
+require 'vclog/heuristics/rule'
+
+module VCLog
+
+  # Heuristics stores a set of rules to be applied to commmits
+  # in order to assign them priority levels and report labels.
+  #
+  class Heuristics
+
+    #
+    # Load heuristics from a designated file.
+    #
+    # @param [String] file 
+    #   Configuration file.
+    #
+    def self.load(file)
+      raise LoadError unless File.exist?(file)
+      new{ instance_eval(File.read(file), file) }
+    end
+
+    #
+    # Load heuristics given a script.
+    #
+    # @param [String] script
+    #   Configuration script.
+    #
+    def self.eval(script, file='(eval)', line=0)
+      new{ instance_eval(text, file, line) }
+    end
+
+    #
+    # Initialize new heurtistics set.
+    #
+    def initialize(&block)
+      @rules = []
+
+      @types = Hash.new{ |h,k| h[k] = h[:default] }
+      @types[:default] = Type.new(:default, -1, "Nominal Changes")
+
+      @colors = [:blue, :blue, :cyan, :green, :yellow, :red, :red]
+
+      if block
+        instance_eval(&block)
+      else
+        default
+      end
+    end
+
+    #
+    # Apply heuristics to a commit.
+    #
+    # @param [Change] commit
+    #   Instance of Change encapsulates an SCM commit.
+    #
+    def apply(commit)
+      # apply rules, breaking on first rule found that fits.
+      @rules.find{ |rule| rule.call(commit) }
+
+      unless commit.level
+        commit.level = types[commit.type].level
+      end
+
+      unless commit.label
+        commit.label = types[commit.type].label
+      end
+
+      # apply color for commit level
+      color = @colors[commit.level + (@colors.size / 2)]
+      color ||= (commit.level > 0 ? @colors.first : @colors.last)
+      commit.color = color
+    end
+
+    #
+    # Define a new rule.
+    #
+    def on(pattern=nil, &block)
+      @rules << Rule.new(pattern, &block)
+    end
+
+    #
+    # Convenience method for setting-up commit types, which can
+    # be easily assigned, setting both label and level in one go.
+    #
+    def type(type, level, label)
+      @types[type.to_sym] = Type.new(type, level, label)
+    end
+
+    # @deprecated
+    alias_method :set, :type
+
+    #
+    # Access to defined types.
+    #
+    # @example
+    #   commit.type = :major
+    #
+    attr :types
+
+    #
+    # Set color list. The center element cooresponds to `level=0`.
+    # Elements before the center are incrementally higher levels
+    # and those after are lower.
+    #
+    # @example
+    #   colors :red, :yellow, :green, :cyan, :blue
+    #
+    def colors(*list)
+      @colors = list
+    end
+
+    #
+    # Set default level.
+    #
+    def level(integer=nil)
+      @level = integer.to_i is integer
+      @level
+    end
+
+    #
+    # Default settings.
+    #
+    def default
+      type :major,    3, "Major Enhancements"
+      type :minor,    2, "Minor Enhancements"
+      type :bug,      1, "Bug Fixes"
+      type :default,  0, "Nominal Changes"
+      type :doc,     -1, "Documentation Changes"
+      type :test,    -2, "Test/Spec Adjustments"
+      type :admin,   -3, "Administrative Changes"
+
+      on /\A(\w+):/ do |commit, md|
+        type = md[1].to_sym
+        commit.type    = type
+        commit.message = commit.message.sub(md[0],'').strip
+        true
+      end
+
+      on /\[(\w+)\]\s*$/ do |commit, md|
+        type = md[1].to_sym
+        commit.type    = type
+        commit.message = commit.message.sub(md[0],'').strip
+        true
+      end
+
+      on /updated? (README|PROFILE|PACKAGE|VERSION|MANIFEST)/ do |commit|
+        commit.type = :admin
+      end
+
+      on /(bump|bumped|prepare) version/ do |commit|
+        commit.type = :admin
+      end
+    end
+
+    #
+    # Work on next-gen default heuristics.
+    #
+    def default2
+      type :major,    3, "Major Enhancements"
+      type :minor,    2, "Minor Enhancements"
+      type :bug,      1, "Bug Fixes"
+      type :default,  0, "Nominal Changes"
+      type :doc,     -1, "Documentation Changes"
+      type :test,    -2, "Test/Spec Adjustments"
+      type :admin,   -3, "Administrative Changes"
+
+      # test/spec file only changes
+      on do |commit|
+        if commit.files.all?{ |f| f.start_with?('test') || f.start_with?('spec') }
+          commit.type = :test
+        end
+      end
+    end
+
+   private
+
+    # TODO: applies types that are "close", to help overlook typos.
+    #
+    #def close_type(type)
+    #  case type.to_s
+    #  when 'maj', 'major' then :major
+    #  when 'min', 'minor' then :minor
+    #  when 'bug'          then :bug
+    #  when ''             then :other
+    #  else
+    #    type.to_sym
+    #  end
+    #end
+
+  end
+
+end