chandler 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28c48e717e5bfe8d315838375675db111b000913
-  data.tar.gz: 887b51655dca90533757f24715e81afaf1df6c11
+  metadata.gz: 5673a567ce734fb8e24c014c16de889faf2087a6
+  data.tar.gz: 524071c288c0424a61ba2d36da70c9af4a1f2a0a
 SHA512:
-  metadata.gz: 3e9fbca039407baae857944739451a995303a8a67e1ca692266aaf2644cbd326114d22d1dcc0838dda68b6a569244276773145fbe6b5201c9da89ce1522dc221
-  data.tar.gz: 3a188794e3bd013b64532385567a1fce8de60446dfd9a7d629dd414f5d86192e0838ab60a1c6fc1a7949f3b9f8557a1ff90b03e62d976dc21831673f79f80c57
+  metadata.gz: f89c8cdf4c90fd1586723fef2e89452a543694c2705e2343842493fc0217f42179304c4046a48c29bb0a2710a50c79b0a6dc13bcbe9b00523489abc13e2603ea
+  data.tar.gz: e32af5f2b0cbf6cf0e2637915e28640184f7f02bf88bbd3a7dcd6522aeb033a95d77928bae07581be592fa8076e19bc60b96367b306c0d5d940f4015ce049604

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.1
   Exclude:
     - "*.gemspec"
 

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
+  - 2.3.0
 before_install: gem install bundler -v 1.10.4

data/CHANGELOG.md

@@ -8,6 +8,13 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec
 
 * Your contribution here!
 
+## [0.2.0][] (2016-02-19)
+
+* Chandler now understands versions at Markdown/Rdoc h1-level headings (previously only h2 and h3 were searched).
+* If Chandler can't find any version tags, print an error message rather than exiting silently.
+* If Chandler can't find a version in your CHANGELOG, it will log a warning rather than exiting with an uncaught exception.
+* Add `--tag-prefix` option to allow for other Git version tag formats (e.g. `myapp-v1.0.0`; see [#3](https://github.com/mattbrictson/chandler/issues/3))
+
 ## [0.1.2][] (2015-10-26)
 
 * Fix Windows test failures introduced in 0.1.1
@@ -21,6 +28,7 @@ chandler is in a pre-1.0 state. This means that its APIs and behavior are subjec
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/mattbrictson/chandler/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/mattbrictson/chandler/compare/v0.1.2...v0.2.0
 [0.1.2]: https://github.com/mattbrictson/chandler/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/mattbrictson/chandler/compare/v0.1.0...v0.1.1

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Matt Brictson
+Copyright (c) 2016 Matt Brictson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -12,6 +12,8 @@
 
 chandler scans your git repository for version tags (e.g. `v1.0.2`), parses out the corresponding release notes for those tags from your CHANGELOG, and uploads those notes to the GitHub releases area via the GitHub API.
 
+Chandler makes reasonable assumptions as to the name of your CHANGELOG file, your project's GitHub repository URL, and the naming convention of your Git version tags. These can all be overridden with command line options.
+
 ### Why go through the trouble?
 
 GitHub's releases feature is a nice UI for browsing the history of your project and downloading snapshots of each version. It is also structured data that can be queried via GitHub's API, making it a available for third-party integrations. For example, [Sibbell][] can automatically send the release notes out to interested parties whenever you publish a new version.
@@ -72,6 +74,7 @@ Other command-line options:
 * `--git=/path/to/project/.git` – location of the local git repository (defaults to `.git`)
 * `--github=username/repo` – GitHub repository to upload to (if unspecified, chandler will guess based on your git remotes)
 * `--changelog=History.md` – location of the CHANGELOG (defaults to `CHANGELOG.md`)
+* `--tag-prefix=myapp-` – specify Git version tags are in the format `myapp-1.0.0` instead of `1.0.0`
 
 
 ## Rakefile integration

data/Rakefile

@@ -3,13 +3,8 @@ require "rake/testtask"
 require "rubocop/rake_task"
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-task "release:rubygem_push" do
-  # Delay loading Chandler until this point, since it requires Ruby >= 2.1,
-  # which may not be available in all environments (e.g. Travis).
-  # We assume that the person doing `rake release` has Ruby >= 2.1.
-  require "chandler/tasks"
-  Rake.application.invoke_task("chandler:push")
-end
+require "chandler/tasks"
+task "release:rubygem_push" => "chandler:push"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"

data/chandler.gemspec

@@ -29,5 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
   spec.add_development_dependency "mocha"
-  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop", ">= 0.37.0"
 end

data/lib/chandler/changelog.rb

@@ -10,9 +10,11 @@ module Chandler
     NoMatchingVersion = Class.new(StandardError)
 
     HEADING_PATTERNS = [
-      /^##[[:space:]]+.*\n/,  # Markdown "atx" style
+      /^#[[:space:]]+.*\n/,   # Markdown "atx" style
+      /^##[[:space:]]+.*\n/,
       /^###[[:space:]]+.*\n/,
-      /^==[[:space:]]+.*\n/,  # Rdoc style
+      /^=[[:space:]]+.*\n/,   # Rdoc style
+      /^==[[:space:]]+.*\n/,
       /^===[[:space:]]+.*\n/,
       /^\S.*\n-+\n/           # Markdown "Setext" style
     ].freeze
@@ -32,10 +34,14 @@ module Chandler
     #
     def fetch(tag)
       versions.fetch(tag.version_number) do
-        fail NoMatchingVersion, "Couldn’t find #{tag} in #{path}"
+        raise NoMatchingVersion, "Couldn’t find #{tag} in #{path}"
       end
     end
 
+    def basename
+      File.basename(path.to_s)
+    end
+
     private
 
     # Transforms the changelog into a hash where the keys are version numbers
@@ -45,19 +51,16 @@ module Chandler
     # The version numbers are assumed to be contained at Markdown or Rdoc
     # headings. The release notes for those version numbers are the text
     # delimited by those headings. The algorithm tries various styles of these
-    # Markdown and Rdoc headings (see `HEADING_PATTERNS`) until it finds one
-    # that matches.
+    # Markdown and Rdoc headings (see `HEADING_PATTERNS`).
     #
     # The resulting hash entries look like:
     # { "1.0.1" => "\nRelease notes for 1.0.1.\n" }
     #
     def versions
       @versions ||= begin
-        versions = HEADING_PATTERNS.find do |heading_re|
-          found = versions_at_headings(heading_re)
-          break(found) unless found.empty?
+        HEADING_PATTERNS.reduce({}) do |found, heading_re|
+          versions_at_headings(heading_re).merge(found)
         end
-        versions || {}
       end
     end
 

data/lib/chandler/cli/parser.rb

@@ -51,6 +51,11 @@ module Chandler
             config.changelog_path = p
           end
 
+          opts.on("--tag-prefix=[PREFIX]",
+                  "Use PREFIX to identify Git version tags") do |p|
+            config.tag_prefix = p
+          end
+
           opts.on("--dry-run",
                   "Simulate, but don’t actually push to GitHub") do |d|
             config.dry_run = d

data/lib/chandler/commands/push.rb

@@ -1,6 +1,7 @@
 require "chandler/logging"
 require "chandler/refinements/color"
 require "chandler/refinements/version_format"
+require "forwardable"
 
 module Chandler
   module Commands
@@ -8,6 +9,9 @@ module Chandler
     # from the CHANGELOG, and creates (or updates) the release notes for that
     # tag on GitHub.
     class Push
+      extend Forwardable
+      def_delegators :config, :github, :changelog, :tag_mapper
+
       include Logging
       using Chandler::Refinements::Color
       using Chandler::Refinements::VersionFormat
@@ -20,34 +24,44 @@ module Chandler
       end
 
       def call
-        benchmarking_each_tag do |tag|
+        exit_with_warning if tags.empty?
+
+        each_tag_with_version_and_notes do |tag, version, notes|
           github.create_or_update_release(
             :tag => tag,
-            :title => tag.version_number,
-            :description => changelog.fetch(tag).strip
+            :title => version.version_number,
+            :description => notes
           )
         end
       end
 
       private
 
-      def github
-        config.github
-      end
-
-      def changelog
-        config.changelog
-      end
-
-      def benchmarking_each_tag
+      def each_tag_with_version_and_notes
         width = tags.map(&:length).max
         tags.each do |tag|
+          version, notes = changelog_version_and_notes_for_tag(tag)
+          next if notes.nil?
+
           ellipsis = "…".ljust(1 + width - tag.length)
           benchmark("Push #{tag.blue}#{ellipsis}") do
-            yield(tag)
+            yield(tag, version, notes)
           end
         end
       end
+
+      def exit_with_warning
+        error("No version tags found.")
+        exit(1)
+      end
+
+      def changelog_version_and_notes_for_tag(tag)
+        version = tag_mapper.call(tag)
+        [version, changelog.fetch(version).strip]
+      rescue Chandler::Changelog::NoMatchingVersion
+        info("Skip #{tag} (no #{version} entry in #{changelog.basename})".gray)
+        nil
+      end
     end
   end
 end

data/lib/chandler/configuration.rb

@@ -5,8 +5,8 @@ require "chandler/logger"
 
 module Chandler
   class Configuration
-    attr_accessor :changelog_path, :git_path, :github_repository, :dry_run
-    attr_accessor :logger
+    attr_accessor :changelog_path, :git_path, :github_repository, :dry_run,
+                  :tag_prefix, :logger
 
     def initialize
       @changelog_path = "CHANGELOG.md"
@@ -20,7 +20,7 @@ module Chandler
     end
 
     def git
-      @git ||= Chandler::Git.new(:path => git_path)
+      @git ||= Chandler::Git.new(:path => git_path, :tag_mapper => tag_mapper)
     end
 
     def github
@@ -35,5 +35,10 @@ module Chandler
     def github_repository
       @github_repository || git.origin_remote
     end
+
+    def tag_mapper
+      return ->(tag) { tag } if tag_prefix.nil?
+      ->(tag) { tag[/^#{Regexp.escape(tag_prefix)}(.*)/, 1] }
+    end
   end
 end

data/lib/chandler/git.rb

@@ -7,15 +7,16 @@ module Chandler
     using Chandler::Refinements::VersionFormat
 
     Error = Class.new(StandardError)
-    attr_reader :path
+    attr_reader :path, :tag_mapper
 
     # Initializes the Git object with the path to the `.git` directory of the
     # desired git repository.
     #
     # Chandler::Git.new(:path => "/path/to/my/project/.git")
     #
-    def initialize(path:)
+    def initialize(path:, tag_mapper:)
       @path = path
+      @tag_mapper = tag_mapper
     end
 
     # Uses `git tag -l` to obtain the list of tags, then returns the subset of
@@ -23,12 +24,13 @@ module Chandler
     #
     # version_tags # => ["v0.0.1", "v0.2.0", "v0.2.1", "v0.3.0"]
     #
-    # rubocop:disable Style/SymbolProc
     def version_tags
-      tags = git("tag", "-l").lines.map(&:strip).select { |v| v.version? }
-      tags.sort_by { |t| Gem::Version.new(t.version_number) }
+      tags = git("tag", "-l").lines.map(&:strip).select do |tag|
+        version_part = tag_mapper.call(tag)
+        version_part && version_part.version?
+      end
+      tags.sort_by { |t| Gem::Version.new(tag_mapper.call(t).version_number) }
     end
-    # rubocop:enable Style/SymbolProc
 
     # Uses `git remote -v` to list the remotes and returns the URL of the
     # first one labeled "origin".
@@ -52,7 +54,7 @@ module Chandler
 
       message = "Failed to execute: #{args.join(' ')}"
       message << "\n#{err}" unless err.nil?
-      fail Error, message
+      raise Error, message
     end
   end
 end

data/lib/chandler/github.rb

@@ -61,7 +61,7 @@ module Chandler
       message = "Couldn’t load GitHub credentials from ~/.netrc.\n"
       message << "For .netrc instructions, see: "
       message << "https://github.com/octokit/octokit.rb#using-a-netrc-file"
-      fail MissingCredentials, message
+      raise MissingCredentials, message
     end
   end
 end

data/lib/chandler/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Chandler
-  VERSION = "0.1.2"
+  VERSION = "0.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chandler
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-26 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: netrc
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.37.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.37.0
 description: 
 email:
 - chandler@mattbrictson.com
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Syncs CHANGELOG entries to GitHub's release notes