yes_ship_it 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 444ecc2191ed065ffeb7d23921a8518897ef5f59
-  data.tar.gz: 41ccaa7257b29964108a58bd27ddd5a9519984b8
+  metadata.gz: f0a3bdc9066a3756da3d10312af339a670ebb3b5
+  data.tar.gz: f0c52e701d5bc7ede706a76cdc1550d9d9199cfd
 SHA512:
-  metadata.gz: e5ab4853e2fd9337988199767d0264046b49f3122c773bda25d15d0f182f9f75caa73fa30764cb6dfa4c53fc72b1dafb52ccdba7ed625a9fafbf2d2599042afb
-  data.tar.gz: 9396162f0020b8ce79e9fc15475010f41b0da38a55c3f677172436a12e1c2d61b3a8d5152a07721688f1f5ab7037b6d9fc78d1a6323d3eb12da132c9a7fb84c4
+  metadata.gz: 881cc76db9867a69368e18a8e0f45ab05c8de8c008160897806d01cf3ed425600bfefe9ad2c388c73e458d859eb5298b396d08e709293148b1fe959b51ce3a10
+  data.tar.gz: 8593fe6bd2e0369073444351c81dfda0ba02c0728ace57d53401b97427c23c8c8a58e8d94ffd4d33d9d9397cea0c6e09f525c3a24a426159c57e16075a25f34b

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change log of yes_ship_it
+
+## Version 0.0.2
+
+* Don't run assertions when dependent assertions have failed
+* Add support for including standard configs for certain scenarios. The first
+  and only one for now is ruby_gems for releasing Ruby Gems.
+* Add helper command `yes_ship_it changelog` to show the git log with all
+  changes since last release as inspiration for the actual change log
+* Check that the change log contains an entry for the version to be released
+
+## Version 0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -58,12 +58,12 @@ A more detailed configuration could look like this:
 
 ```yaml
 assertions:
-  ci_green
-  release_notes
-  version_number
-  gem_built
-  release_tagged
-  gem_pushed
+  - ci_green
+  - release_notes
+  - version_number
+  - gem_built
+  - release_tagged
+  - gem_pushed
 ```
 
 There can be more configuration on a general level or the level of the

data/assertions/built_gem.rb

@@ -33,7 +33,8 @@ module YSI
 
     def assert(dry_run: false)
       if !dry_run
-        if !system("gem build #{gemspec_file}")
+        `gem build #{gemspec_file}`
+        if $?.to_i != 0
           return nil
         end
       end

data/assertions/change_log.rb

@@ -1,5 +1,7 @@
 module YSI
   class ChangeLog < Assertion
+    needs "version"
+
     attr_reader :error
 
     def initialize(engine)
@@ -16,10 +18,23 @@ module YSI
         return nil
       end
 
+      @error = check_content(File.read("CHANGELOG.md"))
+      if @error
+        return nil
+      end
+
       "CHANGELOG.md"
     end
 
     def assert(dry_run: false)
     end
+
+    def check_content(content)
+      if content =~ /#{engine.version}/
+        nil
+      else
+        return "Can't find version #{engine.version} in change log"
+      end
+    end
   end
 end

data/assertions/published_gem.rb

@@ -1,5 +1,7 @@
 module YSI
   class PublishedGem < Assertion
+    needs "built_gem"
+
     attr_accessor :error
 
     def initialize(engine)

data/assertions/pushed_tag.rb

@@ -1,11 +1,13 @@
 module YSI
   class PushedTag < Assertion
+    needs "tag"
+
     def display_name
       "pushed tag"
     end
 
     def tag
-      "v#{@engine.version}"
+      @engine.tag
     end
 
     def check

data/assertions/tag.rb

@@ -1,11 +1,13 @@
 module YSI
   class Tag < Assertion
+    needs "version"
+
     def display_name
       "tag"
     end
 
     def tag
-      "v#{@engine.version}"
+      @engine.tag
     end
 
     def check

data/bin/yes_ship_it

@@ -2,8 +2,26 @@
 
 require_relative("../lib/yes_ship_it.rb")
 
-puts "Shipping..."
-puts
+options = {}
+option_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: yes_ship_it [options] [command]"
+
+  opts.separator ""
+  opts.separator "Commands:"
+  opts.separator "  changelog - show change log since last release"
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("--dry-run", "Just pretend. Don't change anything.") do |v|
+    options[:dry_run] = v
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+option_parser.parse!
 
 config_file = "yes_ship_it.conf"
 
@@ -12,14 +30,29 @@ if !File.exist?(config_file)
   exit 1
 end
 
-engine = YSI::Engine.new
-engine.dry_run = ARGV == ["--dry-run"]
+if ARGV == ["changelog"]
+  engine = YSI::Engine.new
+  engine.check_assertion(YSI::Version)
+  tag = `git tag`.split("\n").last
+  system("git log #{tag}..HEAD")
+  exit 0
+elsif ARGV.empty?
+  puts "Shipping..."
+  puts
+
+  engine = YSI::Engine.new
+  engine.dry_run = options[:dry_run]
 
-begin
-  engine.read(config_file)
+  begin
+    engine.read(config_file)
 
-  exit engine.run
-rescue YSI::Error => e
-  STDERR.puts e
+    exit engine.run
+  rescue YSI::Error => e
+    STDERR.puts e
+    exit 1
+  end
+else
+  $stderr.puts "Unrecognized arguments: #{ARGV.join(" ")}"
+  puts option_parser
   exit 1
 end

data/configs/ruby_gem.conf

@@ -0,0 +1,7 @@
+assertions:
+  - version
+  - change_log
+  - tag
+  - built_gem
+  - published_gem
+  - pushed_tag

data/lib/version.rb

@@ -0,0 +1,3 @@
+module YSI
+  VERSION = "0.0.2"
+end

data/lib/yes_ship_it/assertion.rb

@@ -3,8 +3,38 @@ module YSI
     attr_reader :error
     attr_accessor :engine
 
+    def self.class_for_name(name)
+      class_name = name.split("_").map { |n| n.capitalize }.join
+      begin
+        Object.const_get("YSI::" + class_name)
+      rescue NameError
+        raise YSI::Error.new("Error: Unknown assertion '#{name}'")
+      end
+    end
+
+    def self.needs(dependency)
+      @dependency_names ||= []
+      # Classes might not all be loaded yet, so delay class name lookup to
+      # first invocation of #needs
+      @dependency_names << dependency
+    end
+
+    def self.dependency_names
+      @dependency_names || []
+    end
+
     def initialize(engine)
       @engine = engine
     end
+
+    def needs
+      @dependencies ||= self.class.dependency_names.map do |d|
+        Assertion.class_for_name(d)
+      end
+    end
+
+    def needs?(dependency)
+      needs.include?(dependency)
+    end
   end
 end

data/lib/yes_ship_it/engine.rb

@@ -5,15 +5,6 @@ module YSI
     attr_accessor :out
     attr_accessor :dry_run
 
-    def self.class_for_assertion_name(name)
-      class_name = name.split("_").map { |n| n.capitalize }.join
-      begin
-        Object.const_get("YSI::" + class_name)
-      rescue NameError
-        raise YSI::Error.new("Error: Unknown assertion '#{name}'")
-      end
-    end
-
     def initialize
       @assertions = []
       @out = STDOUT
@@ -22,30 +13,64 @@ module YSI
     def read(filename)
       config = YAML.load_file(filename)
 
-      assertions = config["assertions"]
-      if assertions
-        assertions.each do |assertion|
-          if assertion == "version_number"
-            out.puts "Warning: use `version` instead of `version_number`."
-            out.puts
-            assertion = "version"
-          end
+      config.each do |key,value|
+        if key == "include"
+          included_file = value
+          configs_path = File.expand_path("../../../configs", __FILE__)
+          read(File.join(configs_path, included_file + ".conf"))
+        elsif key == "assertions"
+          assertions = value
+          if assertions
+            assertions.each do |assertion|
+              if assertion == "version_number"
+                out.puts "Warning: use `version` instead of `version_number`."
+                out.puts
+                assertion = "version"
+              end
 
-          @assertions << YSI::Engine.class_for_assertion_name(assertion).new(self)
+              @assertions << YSI::Assertion.class_for_name(assertion).new(self)
+            end
+          end
         end
       end
     end
 
+    def check_assertion(assertion_class)
+      assertion_class.new(self).check
+    end
+
     def project_name
       File.basename(Dir.pwd)
     end
 
+    def tag
+      "v#{version}"
+    end
+
+    def dependency_errored?(assertion, errored_assertions)
+      assertion.needs.each do |need|
+        errored_assertions.each do |errored_assertion|
+          if errored_assertion.class == need
+            return true
+          end
+        end
+      end
+      false
+    end
+
     def run
       failed_assertions = []
       errored_assertions = []
+      skipped_assertions = []
 
       @assertions.each do |assertion|
         out.print "Checking #{assertion.display_name}: "
+        if dependency_errored?(assertion, errored_assertions) ||
+           dependency_errored?(assertion, skipped_assertions)
+          out.puts "skip (because dependency errored)"
+          skipped_assertions << assertion
+          next
+        end
         success = assertion.check
         if success
           out.puts success

data/lib/yes_ship_it.rb

@@ -1,5 +1,6 @@
 require "yaml"
 require "rest-client"
+require "optparse"
 
 require_relative "yes_ship_it/assertion.rb"
 require_relative "yes_ship_it/engine.rb"

data/spec/data/yes_ship_it.include.conf

@@ -0,0 +1,2 @@
+include:
+  ruby_gem

data/spec/integration/cli_spec.rb

@@ -24,8 +24,7 @@ Warning: use `version` instead of `version_number`.
 
 Checking version number: error
   Expected version in lib/version.rb
-Checking change log: error
-  Expected change log in CHANGELOG.md
+Checking change log: skip (because dependency errored)
 
 Couldn't ship red_herring. Help me.
 EOT
@@ -119,5 +118,79 @@ EOT
         working_directory: File.join(dir, "red_herring"))).
         to exit_with_success(expected_output)
     end
+
+    it "checks the change log" do
+      dir = given_directory
+
+      setup_test_git_repo("004", dir)
+
+      expected_output = <<EOT
+Shipping...
+
+Checking version number: 0.0.2
+Checking change log: error
+  Can't find version 0.0.2 in change log
+Checking built gem: fail
+Checking tag: fail
+
+Couldn't ship red_herring. Help me.
+EOT
+
+      expect(run_command(working_directory: File.join(dir, "red_herring"))).
+        to exit_with_error(1, "", expected_output)
+    end
+
+    it "skips assertions with errored dependencies" do
+      dir = nil
+      given_directory do
+        dir = given_directory "test_project" do
+          given_file("yes_ship_it.conf", from: "yes_ship_it.include.conf")
+        end
+      end
+
+      expected_output = <<EOT
+Shipping...
+
+Checking version number: error
+  Expected version in lib/version.rb
+Checking change log: skip (because dependency errored)
+Checking tag: skip (because dependency errored)
+Checking built gem: error
+  I need a gemspec: test_project.gemspec
+Checking published gem: skip (because dependency errored)
+Checking pushed tag: skip (because dependency errored)
+
+Couldn't ship test_project. Help me.
+EOT
+
+      expect(run_command(working_directory: dir)).
+        to exit_with_error(1, "", expected_output)
+    end
+  end
+
+  describe "changelog helper" do
+    it "shows changelog since last version" do
+      dir = given_directory
+
+      setup_test_git_repo("005", dir)
+
+      expected_output = <<EOT
+commit 22cb6af3f7ea8385a8d0c62340c99265e0c8a63d
+Author: Cornelius Schumacher <schumacher@kde.org>
+Date:   Fri Jul 10 23:54:01 2015 +0200
+
+    Implement magic method
+
+commit 40ec45663e2a3cf32895b451cc43e667463af431
+Author: Cornelius Schumacher <schumacher@kde.org>
+Date:   Fri Jul 10 23:50:08 2015 +0200
+
+    Add magic method
+EOT
+
+      expect(run_command(args: ["changelog"],
+        working_directory: File.join(dir, "red_herring"))).
+        to exit_with_success(expected_output)
+    end
   end
 end

data/spec/unit/assertion_spec.rb

@@ -0,0 +1,15 @@
+require_relative "spec_helper"
+
+describe YSI::Assertion do
+  describe ".class_for_name" do
+    it "creates VersionNumber class" do
+      expect(YSI::Assertion.class_for_name("version")).
+        to be(YSI::Version)
+    end
+
+    it "creates ChangeLog class" do
+      expect(YSI::Assertion.class_for_name("change_log")).
+        to be(YSI::ChangeLog)
+    end
+  end
+end

data/spec/unit/assertions/change_log_spec.rb

@@ -0,0 +1,52 @@
+require_relative "../spec_helper.rb"
+
+describe YSI::ChangeLog do
+  describe "checks content of change log" do
+    it "when empty" do
+      engine = YSI::Engine.new
+      engine.version = "1.2.3"
+      a = YSI::ChangeLog.new(engine)
+      expect(a.check_content("")).to eq("Can't find version 1.2.3 in change log")
+    end
+
+    it "when no version" do
+      engine = YSI::Engine.new
+      engine.version = "1.2.3"
+      a = YSI::ChangeLog.new(engine)
+      content = <<EOT
+# Change log
+
+## Version 1.0.0
+
+* Some changes
+EOT
+      expect(a.check_content(content)).to eq("Can't find version 1.2.3 in change log")
+    end
+
+    it "when all info is there" do
+      engine = YSI::Engine.new
+      engine.version = "1.2.3"
+      a = YSI::ChangeLog.new(engine)
+      content = <<EOT
+# Change log
+
+## Version 1.2.3
+
+* Some changes
+EOT
+      expect(a.check_content(content)).to be_nil
+    end
+  end
+
+  describe "dependencies" do
+    it "#needs?" do
+      a = YSI::ChangeLog.new(YSI::Engine)
+      expect(a.needs?(YSI::Version)).to be(true)
+    end
+
+    it "#needs" do
+      a = YSI::ChangeLog.new(YSI::Engine)
+      expect(a.needs).to eq([YSI::Version])
+    end
+  end
+end

data/spec/unit/assertions/pushed_tag_spec.rb

@@ -0,0 +1,15 @@
+require_relative "../spec_helper.rb"
+
+describe YSI::PushedTag do
+  describe "dependencies" do
+    it "#needs?" do
+      a = YSI::PushedTag.new(YSI::Engine)
+      expect(a.needs?(YSI::Tag)).to be(true)
+    end
+
+    it "#needs" do
+      a = YSI::PushedTag.new(YSI::Engine)
+      expect(a.needs).to eq([YSI::Tag])
+    end
+  end
+end

data/spec/unit/engine_spec.rb

@@ -5,18 +5,6 @@ include GivenFilesystemSpecHelpers
 describe YSI::Engine do
   use_given_filesystem
 
-  describe "#class_for_assertion_name" do
-    it "creates VersionNumber class" do
-      expect(YSI::Engine.class_for_assertion_name("version")).
-        to be(YSI::Version)
-    end
-
-    it "creates ChangeLog class" do
-      expect(YSI::Engine.class_for_assertion_name("change_log")).
-        to be(YSI::ChangeLog)
-    end
-  end
-
   describe "#read" do
     it "reads valid configuration" do
       path = nil
@@ -45,6 +33,13 @@ describe YSI::Engine do
         ysi.read(path)
       }.to raise_error YSI::Error
     end
+
+    it "throws error when file does not exist" do
+      ysi = YSI::Engine.new
+      expect {
+        ysi.read("/this/file/does/not/exist.conf")
+      }.to raise_error Errno::ENOENT
+    end
   end
 
   it "runs assertions" do
@@ -65,4 +60,48 @@ describe YSI::Engine do
 
     ysi.run
   end
+
+  it "runs assertion" do
+    ysi = YSI::Engine.new
+
+    expect_any_instance_of(YSI::Version).to receive(:check)
+
+    ysi.check_assertion(YSI::Version)
+  end
+
+  it "provides tag" do
+    ysi = YSI::Engine.new
+    ysi.version = "1.2.3"
+
+    expect(ysi.tag).to eq("v1.2.3")
+  end
+
+  it "loads standard config" do
+    ysi_standard = YSI::Engine.new
+    ysi_standard.read("configs/ruby_gem.conf")
+
+    ysi = YSI::Engine.new
+    ysi.read(given_file("yes_ship_it.include.conf"))
+
+    expect(ysi.assertions.count).to be >= 6
+    ysi_standard.assertions.each_with_index do |assertion, i|
+      expect(assertion.class).to eq(ysi.assertions[i].class)
+    end
+  end
+
+  describe "#dependency_errored?" do
+    it "returns true, if no dependency errored" do
+      engine = YSI::Engine.new
+      errored_assertions = []
+      assertion = YSI::ChangeLog.new(engine)
+      expect(engine.dependency_errored?(assertion, errored_assertions)).to be(false)
+    end
+
+    it "returns false, if a dependency errored" do
+      engine = YSI::Engine.new
+      errored_assertions = [YSI::Version.new(engine)]
+      assertion = YSI::ChangeLog.new(engine)
+      expect(engine.dependency_errored?(assertion, errored_assertions)).to be(true)
+    end
+  end
 end

data/spec/unit/spec_helper.rb

@@ -1,5 +1,7 @@
 require_relative "../../lib/yes_ship_it.rb"
 
+require "given_filesystem/spec_helpers"
+
 support = File.expand_path("../support", __FILE__) + "/*.rb"
 
 Dir[support].each { |f| require f }

data/yes_ship_it.conf

@@ -1,9 +1,3 @@
 # Experimental release automation. See https://github.com/cornelius/yes_ship_it.
-
-assertions:
-  - version
-  - change_log
-  - built_gem
-  - published_gem
-  - tag
-  - pushed_tag
+include:
+  ruby_gem

data/yes_ship_it.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "yes_ship_it"
+  s.version     = YSI::VERSION
+  s.license     = 'MIT'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Cornelius Schumacher']
+  s.email       = ['schumacher@kde.org']
+  s.homepage    = "http://github.com/cornelius/yes_ship_it"
+  s.summary     = "The ultimate release script"
+  s.description = "Whenever the answer is 'Yes, ship it!' you will need yes_ship_it. It is the ultimate helper in releasing software.."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "yes_ship_it"
+
+  s.add_development_dependency "rspec", "~>3"
+  s.add_development_dependency "given_filesystem"
+  s.add_development_dependency "cli_tester"
+
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yes_ship_it
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Cornelius Schumacher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -60,7 +60,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rspec
+- CHANGELOG.md
+- Gemfile
 - README.md
 - assertions/built_gem.rb
 - assertions/change_log.rb
@@ -69,6 +72,8 @@ files:
 - assertions/tag.rb
 - assertions/version.rb
 - bin/yes_ship_it
+- configs/ruby_gem.conf
+- lib/version.rb
 - lib/yes_ship_it.rb
 - lib/yes_ship_it/assertion.rb
 - lib/yes_ship_it/engine.rb
@@ -77,15 +82,23 @@ files:
 - spec/data/red_herring-001.tar.gz
 - spec/data/red_herring-002.tar.gz
 - spec/data/red_herring-003.tar.gz
+- spec/data/red_herring-004.tar.gz
+- spec/data/red_herring-005.tar.gz
 - spec/data/yes_ship_it.conf
+- spec/data/yes_ship_it.include.conf
 - spec/data/yes_ship_it.unknown.conf
 - spec/integration/cli_spec.rb
 - spec/integration/spec_helper.rb
+- spec/unit/assertion_spec.rb
+- spec/unit/assertions/change_log_spec.rb
+- spec/unit/assertions/pushed_tag_spec.rb
 - spec/unit/assertions_spec.rb
 - spec/unit/engine_spec.rb
 - spec/unit/spec_helper.rb
 - spec/unit/support/assertion_examples.rb
+- yes_ship_it-0.0.1.gem
 - yes_ship_it.conf
+- yes_ship_it.gemspec
 homepage: http://github.com/cornelius/yes_ship_it
 licenses:
 - MIT