vclog 1.8.1 → 1.8.2

data/HISTORY.rdoc

@@ -1,158 +0,0 @@
-= RELEASE HISTORY
-
-== 1.8.1 / 2010-11-22
-
-This release corrects the tag dates on Histories. Where possible the tag date is used rather than the commit date (of the most recent commit made relative to the tag). Primarily this effects git repositories --a separate tag date is not supported by all SCMs. This release also fixes a bug in the hg adapter that prevented auto-tagging.
-
-Changes:
-
-* Use tag date instead of commit date in history.
-* Fix typo in hg adapter's autotag method.
-* Add history file option to autotag command.
-
-
-== 1.8.0 / 2010-11-21
-
-Under the hood, VCLog now has a Repo class that acts as a central controller. This has improved the code base substantially and should could to do so as this new design is further embraced. This release also introdces a new `autotag` feature, which makes it possible to "reverse engineer" a Release History file. It will parse the entries from a HISTORY.* file and ensure that corresponding tags exists in the version control system.
-
-Changes:
-
-* Add Repo class which acts as central control.
-* Add autotag feature to ensure release history tags exits.
-
-
-== 1.7.0 / 2010-06-27
-
-In this release the heuristics interface has changed such that the block is passed the commit message and the matchdata, instead of  the previous matchdata splat. The rule can alos return either the sybolic label or a two element array of label and new message, which allows the rule to "massage" the message as needed. This release also improves the git log parser to be much more robust. 
-
-Changes:
-
-* Pass message and matchadata to heuristics rule interface.
-* Improve git log parser, which should handle all possible cases now.
-
-
-== 1.6.1 / 2010-06-23
-
-This release repairs the Atom feed format and adds an RSS feed format. Both formats are nearly conformant with strict validations --only a couple minor issues remain to iron out (such as embedded feed url). Ragardless, they should work fine with feed readers (which are not as strict).
-
-Changes:
-
-* Repair and improve Atom feed format.
-* Add RSS feed format.
-* Fix Git email address value.
-* Add title to HTML Change Log format.
-
-
-== 1.6.0 / 2010-06-22
-
-Previous versions utilized a system of "commit tagging" to identify types of commits. This proved less than optimal --it was unconventional, but worse it was easy to forget to put the proper label in the message. The new version of VClog uses a customizable heuristics systems instead. Rather than be limited to a strict syntax structure, you can write matching rules in .config/vclog/rules.rb that determine the commit type, and set descriptive labels for each type. This makes it very easy to get excellent History output. Also in this release the command-line interface has changed to use subcommands. And the default output format is now an ANSI-color GNU-like format. Use `-f gnu` to get the old default format.
-
-Changes:
-
-* 2 Major Enhancements
-
-  * Heuristics system for categorizing commits
-  * Command-line interface uses subcommands
-
-
-== 1.5.0 / 2010-05-29
-
-This release adds support for Mercurial repositories and Atom newsfeed output format. The commandline inteface has change such that <code>--foramt</code>/<code>-f</code> is used to select the format instead of using the previous per-format options, e.g. use <code>-f xml</code> instead of <code>--xml</code>. This release also includes some subtantial changes under-the-hood --the first of a two part code refactoring process.
-
-Changes:
-
-* 2 Major Enhancements
-
-  * Add Mercurial support
-  * Add Atom feed format
-
-* 1 Minor Enhancement
-
-  * Select format using -f option.
-
-
-== 1.4.0 / 2010-05-26
-
-This release includes some basic improvments and a few bug fixes. The primary change you might encounter is the need to use -e or --extra in order to see the detailed Changes list in the Release History. Also changed 'git-log' to 'git log', as it seems the latest versions of git does not support the many executables any longer. SVN support requires xmlsimple library. Note also that SVN support is lack luster at this time becuase it hits the server every time an 'svn log' command is issued which is done once for each tag when a history is generated (any one know a better way?).
-
-Changes:
-
-* 1 Minor Enhancement
-
-  * Use -e or --extra to see Changes list in release history.
-  * Use xmlsimple for parsing SVN log output.
-  * Improve git log parsing with --pretty option.
-
-* 2 Bug Fixes
-
-  * Sort release tags in correct order.
-  * Change 'git-log' to 'git log'.
-
-
-== 1.3.0 / 2010-02-08
-
-For the an end-user the only significant change is the support of 'label:' notation for commit labels. I have found that I am much more apt to use them if they come first in the commit message and that some developers already use the 'label:' notation to specify 'system module' effected --a useful system of labeling.
-
-Changes:
-
-* 1 Major Enhancement
-
-  * Support 'label:' fromat commit types
-
-* 2 Implementation Enhancements
-
-  * Adjust location of plugins for latest version of Plugin gem.
-  * Use Erb as template system for all formats.
-
-* 1 Bug Fix
-
-  * Corrected error for --current and --bump commands.
-
-
-== 1.2.0 / 2009-10-26
-
-Version 1.2 overhuals the internals so that History output is based on scm tags, not on a pre-existing history file. This is really the proper way to go about it and those who use it will, I think, be happily surprised at how it promotes good practices for the maintenance of History files. This overhaul led to substantial changes in the command-line interface.
-
-Changes:
-
-* 2 Major Enhancements
-
-  * Rewrote History class.
-  * Changed command-line interface.
-
-
-== 1.1.0 / 2009-10-23
-
-This release adds yaml and json formats an improves
-the command.
-
-Changes:
-
-* 2 Major Enhancements
-
-    * Added YAML format.
-    * Added JSON format.
-
-* 1 Minor Enhancements
-
-    * Use OptionParser instead of GetoptLong.
-
-
-== 1.0.0 / 2009-10-13
-
-This is the first "production" release of VCLog.
-
-* 2 Major Enhancements
-
-    * Improved command line interface.
-    * Added output option to save changelog.
-
-
-== 0.1.0 / 2009-08-17
-
-This is the initial version of vclog.
-
-* 1 Major Enhancement
-
-    * Happy Birthday
-

data/LICENSE

@@ -1,203 +0,0 @@
-
-                             Apache License
-                        Version 2.0, January 2004
-                     http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-

data/lib/plugins/syckle/vclog.rb

@@ -1,221 +0,0 @@
-module Syckle::Plugins
-
-  # VClog service generates changelogs from
-  # SCM commit messages.
-  #
-  # TODO: Support multiple formats in one pass.
-  class VClog < Service
-
-    cycle :main, :document
-
-    #available do |project|
-    #  begin
-    #    require 'vclog/vcs'
-    #    true
-    #  rescue LoadError
-    #    false
-    #  end
-    #end
-
-    # Current version of project.
-    attr_accessor :version
-
-    # Changelog format. Default is +html+.
-    # Supports +html+, +xml+, +json+, +yaml+, +rdoc+, +markdown+, and +gnu+.
-    attr_reader :formats
-
-    # Changelog layout type (+changelog+ or +history+). Default is +changelog+.
-    attr_reader :type
-
-    # Output directory store results.
-    attr_accessor :output
-
-    # Show revision numbers (true/false)?
-    attr_accessor :rev
-
-    # Some formats, such as +rdoc+, use a title field. Defaults to project title.
-    attr_accessor :title
-
-    # Some formats can reference an optional stylesheet (namely +xml+ and +html+).
-    attr_accessor :style
-
-    # Minimum change level to include.
-    attr_accessor :level
-
-    # Reduced detail
-    attr_accessor :summary
-
-    #
-    def initialize_defaults
-      @version    = metadata.version
-      @title      = metadata.title
-      @formats    = ['atom']
-      @type       = 'log'
-      @level      = 0
-      @summary    = false
-    end
-
-    #
-    def valid?
-      return false unless format =~ /^(html|yaml|json|xml|rdoc|markdown|gnu|txt|atom|rss|ansi)$/
-      return false unless type   =~ /^(log|rel|history|changelog)$/
-      return true
-    end
-
-    #
-    def formats=(f)
-      @formats = f.to_list
-    end
-
-    alias_method :format=, :formats=
-
-    #
-    def type=(f)
-      @type = f.to_s.downcase
-    end
-
-    #++
-    # TODO: apply_naming_policy ?
-    #--
-
-    #
-    def document
-      require 'vclog'
-      formats.each do |format|
-        case type
-        when 'rel', 'history'
-          ext  = format_extension(format)
-          file = File.join(output || project.log, "vclog/history#{ext}")
-        else
-          ext  = format_extension(format)
-          file = File.join(output || project.log, "vclog/changelog#{ext}")
-        end
-        #apply_naming_policy('changelog', log_format.downcase)
-        if dryrun?
-          report "# vclog --#{type} -f #{format} >> #{file}"
-        else
-          changed = save(format, file)
-          if changed
-            report "Updated #{relative_from_root(file)}"
-          else
-            report "Current #{relative_from_root(file)}"
-          end
-        end
-      end
-    end
-
-    # Save changelog/history to +output+ file.
-    def save(format, output)
-      text = render(format)
-      if File.exist?(output)
-        if File.read(output) != text
-          File.open(output, 'w'){ |f| f << text }
-          true
-        else
-          false
-        end
-      else
-        dir = File.dirname(output)
-        mkdir_p(dir) unless File.exist?(dir)
-        File.open(output, 'w'){ |f| f << text }
-      end
-    end
-
-    ## Returns changelog or history depending on type selection.
-    #def log
-    #  @log ||= (
-    #    case type
-    #    when 'log', 'changelog'
-    #      log = vcs.changelog
-    #    when 'rel', 'history'
-    #      log = vcs.history(:title=>title, :version=>version)
-    #    else
-    #      log = vcs.changelog
-    #    end
-    #  )
-    #end
-
-    #def vclog_config
-    #  @vclog_config ||= (
-    #    vcf = VCLog::Config.new(project.root.to_s)
-    #    vcf.level = level
-    #    vcf
-    #  )
-    #end
-
-    # Access to version control system.
-    def vcs
-      #@vcs ||= VCLog::VCS.new #(self)
-      #@vcs ||= VCLog::Adapters.factory(vclog_config)
-      @vcs ||= VCLog::Repo.new(project.root.to_s, :level=>level)
-    end
-
-    # Convert log to desired format.
-    def render(format)
-      doctype = type
-      doctype = 'history'   if doctype == 'rel'
-      doctype = 'changelog' if doctype == 'log'
-
-      options = {
-        :stylesheet => style,
-        :revision   => rev,
-        :version    => version,
-        :title      => title,
-        :extra      => !summary
-      }
-
-      vcs.display(doctype, format, options)
-    end
-
-
-    #
-    def format_extension(format)
-      #case format.to_s
-      #when 'rss'
-      #  '-rss.xml'
-      #when 'atom'
-      #  '-atom.xml'
-      #else
-        ".#{format}"
-      #end
-    end
-
-=begin
-    #
-    def document_public_changelog
-      if output
-        file = project.root + output
-      else
-        file = project.root.glob_first("{CHANGES,CHANGELOG}{.txt,}", :casefold)
-      end
-
-      if file
-        #file = (project.root + file).to_s
-        if dryrun?
-          report "vclog > #{file}"
-        else
-          public_changelog = typed ? changelog.typed : changelog
-          if layout == 'rel'
-            changed = public_changelog.save(file.to_s, :rel, metadata.version, metadata.release)
-          else
-            changed = public_changelog.save(file.to_s, :gnu)
-          end
-          if changed
-            report "Updated #{relative_from_root(file)}"
-          else
-            report "#{relative_from_root(file)} is current"
-          end
-        end
-      end
-    end
-=end
-
-    #
-    def relative_from_root(path)
-      Pathname.new(path).relative_path_from(project.root)
-    end
-
-  end
-
-end
-