rubycut-vclog 1.9.4

data/lib/vclog/change_point.rb

@@ -0,0 +1,77 @@
+module VCLog
+
+  # The Change class models an entry in a change log.
+  #
+  class ChangePoint
+
+    # Type of change, as assigned by hueristics.
+    attr_accessor :type
+
+    # The priority level of this change, as assigned by hueristics.
+    # This can be `nil`, as Heuristics will always make sure a
+    # commit has an inteer level before going out to template.
+    attr_accessor :level
+
+    # The descriptive label of this change, as assigned by hueristics.
+    attr_accessor :label
+
+    # ANSI color to apply. Actually this can be a list
+    # of any support ansi gem terms, but usually it's 
+    # just the color term, such as `:red`.
+    attr_accessor :color
+
+    #
+    def initialize(change, message)
+      @change  = change
+      @message = message.strip
+
+      @label = nil
+      @level = nil
+    end
+
+    # Change from which point is derived.
+    attr :change
+
+    # The point's message.
+    attr_accessor :message
+    alias_method :msg,  :message
+    alias_method :msg=, :message=
+
+    # Delegate missing methods to +change+.
+    def method_missing(s,*a,&b)
+      if @change.respond_to?(s)
+        @change.send(s,*a,&b)
+      else
+p caller
+        super(s,*a,&b)
+      end
+    end
+
+    # Change points do not have sub-points.
+    def points
+      []
+    end
+
+    # Apply heuristic rules to change.
+    def apply_heuristics(heuristics)
+      heuristics.apply(self)
+    end
+
+    #
+    def to_h
+      { 'author'   => change.author,
+        'date'     => change.date,
+        'id'       => change.id,
+        'message'  => message,
+        'type'     => type
+      }
+    end
+
+    #
+    def to_s(*)
+      message
+    end
+
+  end
+
+end

data/lib/vclog/changelog.rb

@@ -0,0 +1,233 @@
+require 'vclog/core_ext'
+require 'vclog/change'
+
+module VCLog
+
+  # A ChangeLog encapsulates a list of Change objects.
+  #
+  class ChangeLog
+
+    include Enumerable
+
+    #DIR = File.dirname(__FILE__)
+
+    #
+    # Seconds in a day.
+    #
+    DAY = 24*60*60
+
+    #
+    # Array of Change or ChangePoint instances.
+    #
+    attr :changes
+
+    #
+    # Setup new ChangeLog instance.
+    #
+    # @param [Array<Change>] changes
+    #   An array of Change objects.
+    #
+    def initialize(changes=nil)
+      @changes = []
+      @changes = changes if changes
+    end
+
+    #def changes=(changes)
+    #  @changes = []
+    #  changes.each do |change|
+    #    case change
+    #    when Change
+    #      @changes << change
+    #    else
+    #      @changes << Change.new(change)
+    #    end
+    #  end
+    #end
+
+    # Add a change entry to the log.
+    def change(data={})
+      @changes << Change.new(data)
+    end
+
+    #
+    # Sort changes in place.
+    #
+    def sort!(&block)
+      changes.sort!(&block)
+    end
+
+    #
+    # Iterate over each change.
+    #
+    def each(&block)
+      changes.each(&block)
+    end
+
+    #
+    # Is the changelog void of any changes?
+    #
+    def empty?
+      changes.empty?
+    end
+
+    #
+    # Return the number of changes in the changelog.
+    #
+    def size
+      changes.size
+    end
+
+    #
+    # And a change to the changelog.
+    #
+    def <<(entry)
+      case entry
+      when Change, ChangePoint
+        @changes << entry
+      else
+        #raise "Not a Change ro ChangePoint instance - #{entry.inspect}"
+      end
+    end
+
+    #
+    # Return a new changelog with entries having a level higer or
+    # equal to the given level.
+    #
+    def above(level)
+      above = changes.select{ |entry| entry.level >= level }
+      self.class.new(above)
+    end
+
+    #
+    # Return a new changelog with entries occuring after the
+    # given date limit.
+    #
+    def after(date_limit)
+      after = changes.select{ |entry| entry.date > date_limit + DAY }
+      self.class.new(after)
+    end
+
+    #
+    # Return a new changelog with entries occuring before the
+    # given date limit.
+    #
+    def before(date_limit)
+      before = changes.select{ |entry| entry.date <= date_limit + DAY }
+      self.class.new(before)
+    end
+
+    # Return a new changelog with entries that have a specified type.
+    # TODO: Be able to specify which types to include or omit.
+    #def typed
+    #  self.class.new(changes.select{ |e| e.type })
+    #end
+
+    #
+    def by_type
+      mapped = {}
+      changes.each do |entry|
+        mapped[entry.type] ||= self.class.new
+        mapped[entry.type] << entry
+      end
+      mapped
+    end
+
+    #
+    def by_author
+      mapped = {}
+      changes.each do |entry|
+        mapped[entry.author] ||= self.class.new
+        mapped[entry.author] << entry
+      end
+      mapped
+    end
+
+    #
+    def by_date
+      mapped = {}
+      changes.each do |entry|
+        mapped[entry.date.strftime('%Y-%m-%d')] ||= self.class.new
+        mapped[entry.date.strftime('%Y-%m-%d')] << entry
+      end
+      mapped = mapped.to_a.sort{ |a,b| b[0] <=> a[0] }
+      mapped
+    end
+
+    #
+    #def by_date
+    #  mapped = {}
+    #  changes.each do |entry|
+    #    mapped[entry.date.strftime('%Y-%m-%d')] ||= self.class.new
+    #    mapped[entry.date.strftime('%Y-%m-%d')] << entry
+    #  end
+    #  mapped
+    #end
+
+    #
+    # Convert to list of hash.
+    #
+    # @return [Array<Hash>]
+    #
+    # @todo Not a Hash! Need to rename method.
+    #
+    def to_h
+      map{ |change| change.to_h }
+    end
+
+  end
+
+end
+
+
+
+# TODO: THIS IS HERE AS A REMINDER ABOUT TEH XSL TEMPLATE.
+#       WHAT TO DO WITH IT?
+
+=begin
+    ###################
+    # Save Chaqngelog #
+    ###################
+
+    # Save changelog as file in specified format.
+    def save(file, format=:gnu, *args)
+      case format.to_sym
+      when :xml
+        text = to_xml
+#save_xsl(file)
+      when :html
+        text = to_html(*args)
+      when :rel
+        text = to_rel(file, *args)
+      when :yaml
+        text = to_yaml(file)
+      when :json
+        text = to_json(file)
+      else
+        text = to_gnu
+      end
+
+      FileUtils.mkdir_p(File.dirname(file))
+
+      different = true
+      if File.exist?(file)
+        different = (File.read(file) != text)
+      end
+
+      File.open(file, 'w') do |f|
+        f << text
+      end if different
+    end
+
+    #
+    def save_xsl(file)
+      #xslfile = file.chomp(File.extname(file)) + '.xsl'
+      xslfile = File.join(File.dirname(file), 'log.xsl')
+      unless File.exist?(xslfile)
+        FileUtils.mkdir_p(File.dirname(xslfile))
+        File.open(xslfile, 'w') do |f|
+          f << DEFAULT_LOG_XSL
+        end
+      end
+    end
+=end
+

data/lib/vclog/cli.rb

@@ -0,0 +1,8 @@
+require 'vclog/repo'
+
+require 'vclog/cli/log'
+require 'vclog/cli/formats'
+require 'vclog/cli/bump'
+require 'vclog/cli/version'
+require 'vclog/cli/autotag'
+

data/lib/vclog/cli/abstract.rb

@@ -0,0 +1,92 @@
+require 'vclog'
+require 'optparse'
+
+module VCLog
+
+  module CLI
+
+    #
+    def self.register
+      @register ||= []
+    end
+
+    # Abstract base class for all command classes.
+    #
+    class Abstract
+
+      #
+      def self.run(argv)
+        new.run(argv)
+      rescue => err
+        if $DEBUG
+          raise err
+        else
+          puts err.message
+          exit -1
+        end
+      end
+
+      #
+      def self.inherited(subclass)
+        CLI.register << subclass
+      end
+
+      #
+      def self.terms
+        [name.split('::').last.downcase]
+      end
+
+      #
+      def initialize
+        @options = {}
+      end
+
+      #
+      def options
+        @options
+      end
+
+      #
+      def parser(&block)
+        parser = OptionParser.new(&block)
+
+        parser.separator " "
+        parser.separator "SYSTEM OPTIONS:"
+        parser.on('--debug', 'show debugging information') do
+          $DEBUG = true
+        end
+        parser.on('--help' , '-h', 'display this help information') do
+          puts parser
+          exit
+        end
+        parser
+      end
+
+      # Run the command.
+      def run(argv=nil)
+        argv ||= ARGV.dup
+
+        parser.parse!(argv)
+
+        @arguments = argv
+
+        root  = Dir.pwd  # TODO: find root
+
+        @repo = VCLog::Repo.new(root, options)
+
+        execute
+      end
+
+      # Repo is set in #run.
+      def repo
+        @repo
+      end
+
+      #
+      attr :arguments
+
+    end
+
+  end
+
+end

data/lib/vclog/cli/autotag.rb

@@ -0,0 +1,36 @@
+require 'vclog/cli/abstract'
+
+module VCLog::CLI
+
+  #
+  class Autotag < Abstract
+
+    #
+    def self.terms
+      ['autotag']
+    end
+
+    #
+    def parser
+      super do |opt|
+        opt.banner = "Usage: vclog autotag"
+        opt.separator(" ")
+        opt.separator("DESCRIPTION:")
+        opt.separator("  Ensure each entry in History has been tagged.")
+        opt.separator(" ")
+        opt.separator("SPECIAL OPTIONS:")
+        opt.on('--prefix', '-p', 'tag label prefix'){ options[:prefix] = true }
+        opt.on('--file'  , '-f FILE', 'specify history file'){ options[:history_file] = file }
+        opt.on('--force' , '-y', 'perform tagging without confirmation'){ options[:force] = true }
+        opt.on('--dryrun', '-n', 'run in dryrun mode'){ $DRYRUN = true }
+      end
+    end
+
+    #
+    def execute
+      repo.autotag(options[:prefix])
+    end
+
+  end
+
+end