semmy 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bc7f29004979528fcaddf47d8f0538d6b3e7176
-  data.tar.gz: c176ee31e95d87d6e6c097db4861fcc5d9ce9dfb
+  metadata.gz: e37930e9fb640ca1d09d44ad75a455267528fdcb
+  data.tar.gz: d9b8a83c5b32ed68a8409b40107709676ec24aef
 SHA512:
-  metadata.gz: ae0601113bb307b34a638267abc40487a37d1abd53704c3c7cd3649689d758fb0d17d658f1a51109bd571ccb271fb5d2e71e1b62b4ecb64f056264eb0893b3b5
-  data.tar.gz: 64fc0cae3c667e031da0198b82982b542152e5f33873453e345a9e1fd8dbdbd832a33f3ba031e0d30e1df8438ba7b4619b757313ba49403ad7d56cc7e18c7af8
+  metadata.gz: 97963c7d57e85aa7f04d94f0fbb9c3def74e5a387163f390e0764b8cff55ed2762693d3bafded2206f2fa5a5666c58b0a9a73eae1b27f3492e62a0adeb09c0ce
+  data.tar.gz: bf42378f8c9817d88923613b9daab2c37fb96fae91ca1a262cc3f39fb9e3b2c58be477d6e758b04ddd4288e87ca26a761088431837422b015d467cca5fb17c5f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+### Version 0.4.0
+
+2017-07-13
+
+[Compare changes](https://github.com/tf/semmy/compare/0-3-stable...v0.4.0)
+
+- Only keep sections for current minor version in changelog and link
+  to previous stable branch.
+- Compare minor versions to previous stable branch.
+
 ### Version 0.3.0
 
 2016-09-09

data/lib/semmy/changelog.rb

@@ -42,7 +42,7 @@ module Semmy
 
       def version_heading
         config.changelog_version_section_heading % {
-          version: options[:new_version]
+          version: version
         }
       end
 
@@ -53,48 +53,63 @@ module Semmy
       def compare_link_for_versions
         Changelog.compare_link(config,
                                homepage: options[:homepage],
-                               old_version_tag: old_version_tag,
-                               new_version_tag: new_version_tag)
+                               old_version_tag: old_ref,
+                               new_version_tag: Changelog.version_tag(version))
       end
 
-      def old_version_tag
-        Changelog.version_tag(options[:old_version])
+      def old_ref
+        if VersionString.patch_level?(version)
+          Changelog.version_tag(VersionString.previous_version(version))
+        else
+          VersionString.previous_stable_branch_name(version, config.stable_branch_name)
+        end
       end
 
-      def new_version_tag
-        Changelog.version_tag(options[:new_version])
+      def version
+        options[:version]
       end
     end
 
-    InsertUnreleasedSection = Struct.new(:config, :options) do
+    UpdateForMinor = Struct.new(:config, :options) do
       def call(contents)
-        insert_before(version_line_matcher,
-                      contents,
-                      unreleased_section(contents))
+        replace_starting_at(version_line_matcher,
+                            contents,
+                            unreleased_section)
       end
 
       private
 
-      def unreleased_section(contents)
+      def unreleased_section
         <<-END.unindent
           #{config.changelog_unrelased_section_heading}
 
-          #{compare_link_for_master(contents)}
+          #{compare_link_for_master}
 
           #{config.changelog_unrelased_section_blank_slate}
+
+          #{link_to_changelog_on_previous_minor_stable_branch}
         END
       end
 
-      def compare_link_for_master(contents)
+      def compare_link_for_master
         Changelog.compare_link(config,
                                homepage: options[:homepage],
-                               old_version_tag: last_version_tag(contents),
+                               old_version_tag: previous_stable_branch_name,
                                new_version_tag: 'master')
       end
 
-      def last_version_tag(contents)
-        match = contents.match(version_line_matcher)
-        match && Changelog.version_tag(match[1])
+      def link_to_changelog_on_previous_minor_stable_branch
+        config.changelog_previous_changes_link % {
+          branch: previous_stable_branch_name,
+          url: Changelog.file_url(config,
+                                  homepage: options[:homepage],
+                                  branch: previous_stable_branch_name)
+        }
+      end
+
+      def previous_stable_branch_name
+        VersionString.previous_stable_branch_name(options[:version],
+                                                  config.stable_branch_name)
       end
 
       def version_line_matcher
@@ -103,13 +118,12 @@ module Semmy
                    })
       end
 
-      def insert_before(line_matcher, text, inserted_text)
-        text.dup.tap do |result|
-          unless (result.sub!(line_matcher, inserted_text + "\n\\0"))
-            fail(InsertPointNotFound,
-                 "Insert point not found.")
-          end
+      def replace_starting_at(line_matcher, text, inserted_text)
+        unless text =~ line_matcher
+          fail(InsertPointNotFound, 'Insert point not found.')
         end
+
+        [text.split(line_matcher).first, inserted_text].join
       end
     end
 
@@ -122,13 +136,21 @@ module Semmy
     end
 
     def compare_url(config, interpolations)
-      config.changelog_compare_url % interpolations
-        .merge(repository: repository_url(config,
-                                          interpolations[:homepage]))
+      config.compare_url % url_interpolations(config, interpolations)
+    end
+
+    def file_url(config, interpolations)
+      config.file_url % url_interpolations(config, interpolations)
+        .merge(path: config.changelog_path)
     end
 
     private
 
+    def url_interpolations(config, interpolations)
+      interpolations.merge(repository: repository_url(config,
+                                                      interpolations[:homepage]))
+    end
+
     def repository_url(config, homepage)
       if config.github_repository
         "https://github.com/#{config.github_repository}"

data/lib/semmy/configuration.rb

@@ -9,11 +9,14 @@ module Semmy
 
     attr_accessor :github_repository
 
+    attr_accessor :compare_url
+    attr_accessor :file_url
+
     attr_accessor :changelog_path
     attr_accessor :changelog_version_section_heading
-    attr_accessor :changelog_compare_url
     attr_accessor :changelog_unrelased_section_heading
     attr_accessor :changelog_unrelased_section_blank_slate
+    attr_accessor :changelog_previous_changes_link
 
     attr_accessor :source_files_with_docs_tags
     attr_accessor :rewritten_since_doc_tag
@@ -26,11 +29,14 @@ module Semmy
       @prepare_commit_message = 'Prepare %{version} release'
       @bump_commit_message = 'Bump version to %{version}'
 
+      @compare_url = '%{repository}/compare/%{old_version_tag}...%{new_version_tag}'
+      @file_url = '%{repository}/blob/%{branch}/%{path}'
+
       @changelog_path = 'CHANGELOG.md'
       @changelog_version_section_heading = '### Version %{version}'
-      @changelog_compare_url = '%{repository}/compare/%{old_version_tag}...%{new_version_tag}'
       @changelog_unrelased_section_heading = '### Changes on `master`'
       @changelog_unrelased_section_blank_slate = 'None so far.'
+      @changelog_previous_changes_link = "See\n[%{branch} branch](%{url})\nfor previous changes."
 
       @source_files_with_docs_tags = '{app,lib}/**/*.{js,rb,scss}'
       @rewritten_since_doc_tag = 'edge'

data/lib/semmy/files.rb

@@ -4,9 +4,10 @@ module Semmy
 
     def rewrite(path, update)
       content = File.binread(path)
+      updated_content = update.call(content)
 
       File.open(path, 'wb') do |file|
-        file.write(update.call(content))
+        file.write(updated_content)
       end
     end
 

data/lib/semmy/tasks.rb

@@ -52,7 +52,7 @@ module Semmy
       task 'release:after:master' => [
         'semmy:branches:create_stable',
         'semmy:versioning:bump_minor',
-        'semmy:changelog:add_unreleased_section',
+        'semmy:changelog:update_for_minor',
         'semmy:commit:bump'
       ]
 

data/lib/semmy/tasks/changelog_sections.rb

@@ -4,28 +4,27 @@ module Semmy
       def define
         namespace 'changelog' do
           task 'close_section' do
-            new_version = Project.version
-            old_version = VersionString.previous_version(new_version)
+            version = Project.version
             homepage = Gemspec.homepage
 
-            Shell.info("Inserting #{new_version} section " \
+            Shell.info("Inserting #{version} section " \
                        "in #{config.changelog_path}.")
 
             Files.rewrite(config.changelog_path,
                           Changelog::CloseSection.new(config,
-                                                      new_version: new_version,
-                                                      old_version: old_version,
+                                                      version: version,
                                                       homepage: homepage,
                                                       date: Date.today))
           end
 
-          task 'add_unreleased_section' do
-            Shell.info('Inserting unreleased section ' \
+          task 'update_for_minor' do
+            Shell.info('Updating changelog ' \
                        "in #{config.changelog_path}.")
 
             Files.rewrite(config.changelog_path,
-                          Changelog::InsertUnreleasedSection.new(config,
-                                                                 homepage: Gemspec.homepage))
+                          Changelog::UpdateForMinor.new(config,
+                                                        version: Project.version,
+                                                        homepage: Gemspec.homepage))
           end
         end
       end

data/lib/semmy/version.rb

@@ -1,3 +1,3 @@
 module Semmy
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/semmy/version_string.rb

@@ -36,6 +36,10 @@ module Semmy
       version.split('.')[0..1].join('.')
     end
 
+    def patch_level?(version)
+      components(version)[:patch].to_i > 0
+    end
+
     def components(version)
       components = version.split('.')
 
@@ -59,5 +63,24 @@ module Semmy
 
       components.join('.')
     end
+
+    def previous_stable_branch_name(version, stable_branch_name_pattern)
+      stable_branch_name_pattern % previous_minor_version_components(version)
+    end
+
+    private
+
+    def previous_minor_version_components(version)
+      components = version.split('.').map(&:to_i)
+
+      if components[1].zero?
+        fail(NoPreviousMinor, "Cannot get previous minor version of #{version}.")
+      end
+
+      {
+        major: components[0],
+        minor: components[1] - 1
+      }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semmy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tim Fischbach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-09 00:00:00.000000000 Z
+date: 2017-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Rake tasks for a semantic versioning of gems