yes_ship_it 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 168ad942fbfdb7207ece3f1fce5986fac3511b43
-  data.tar.gz: 57c44bc9c84c57bd10db8b989f886b3a9c596b69
+  metadata.gz: f7a38b12c557de98e6ea36e0f82cb9f65e44a5bf
+  data.tar.gz: 478894aeceac04cc8027ba88bf78578e65b649d9
 SHA512:
-  metadata.gz: d36f142bd4848d0187e030f3d881027d140fa8e922fe3d4b91db372e709e8ddc14266157ddecef0c849058af7dd9e71195d5c10ce57de2e2dedfc2c17de1dc9c
-  data.tar.gz: 84a63ab61af12d0c76f173daf0c226c1f97cbb13581441499963c2ec99601b7c255b2c5306ae2f99b3a447b1c66d05c63e25f949976d186731e943055b789db8
+  metadata.gz: 0956fb1a9f67912b750729dc6132fe1dcd8784d23da178878e808eb167f37947772d65d21fa46f1a98bf2ba26129718a5e95ee3e8e5ba7624c3e785ac4affd85
+  data.tar.gz: 349837d22c00fb3c2decdda42dc37ea29cd6a85ed86937caa1c89b0bac346c7af55e1da6eefa3897588e92e976f0e09ad7b70ecc174cdcd7f5f08fe86be3d5c0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change log of yes_ship_it
 
+## Version 0.0.6
+
+* Add support for local assertion plugins. `yes_ship_it plugin generate` creates
+  the scaffold for a new plugin. `yes_ship_it plugin list` shows all available
+  local plugins.
+* Support reading versions from C/C++ header files
+* Don't overwrite existing config with `yes_ship_it init` (bug #5)
+* Implement detection of ruby and generic projects in `yes_ship_it init`
+* Support `obs_project` parameter in `submitted_rpm` assertion
+
 ## Version 0.0.5
 
 * Handle missing credentials for Rubygems, when pushing gems

data/MIT-LICENSE

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/assertions/built_gem.rb

@@ -1,6 +1,6 @@
 module YSI
   class BuiltGem < Assertion
-    def display_name
+    def self.display_name
       "built gem"
     end
 
@@ -14,8 +14,7 @@ module YSI
 
     def check
       if !File.exist?(gemspec_file)
-        @error = "I need a gemspec: #{gemspec_file}"
-        return nil
+        raise AssertionError.new("I need a gemspec: #{gemspec_file}")
       end
 
       if !File.exist?(gem_file)
@@ -25,13 +24,8 @@ module YSI
       gem_file
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        `gem build #{gemspec_file}`
-        if $?.to_i != 0
-          return nil
-        end
-      end
+    def assert(executor)
+      executor.run_command(["gem", "build", gemspec_file])
       gem_file
     end
   end

data/assertions/change_log.rb

@@ -2,32 +2,26 @@ module YSI
   class ChangeLog < Assertion
     needs "version"
 
-    def display_name
+    def self.display_name
       "change log"
     end
 
     def check
       if !File.exist?("CHANGELOG.md")
-        @error = "Expected change log in CHANGELOG.md"
-        return nil
+        raise AssertionError.new("Expected change log in CHANGELOG.md")
       end
 
-      @error = check_content(File.read("CHANGELOG.md"))
-      if @error
-        return nil
-      end
+      check_content(File.read("CHANGELOG.md"))
 
       "CHANGELOG.md"
     end
 
-    def assert(dry_run: false)
+    def assert(_executor)
     end
 
     def check_content(content)
-      if content =~ /#{engine.version}/
-        nil
-      else
-        return "Can't find version #{engine.version} in change log"
+      if content !~ /#{engine.version}/
+        raise AssertionError.new("Can't find version #{engine.version} in change log")
       end
     end
   end

data/assertions/published_gem.rb

@@ -2,7 +2,7 @@ module YSI
   class PublishedGem < Assertion
     needs "built_gem"
 
-    def display_name
+    def self.display_name
       "published gem"
     end
 
@@ -25,19 +25,13 @@ module YSI
       nil
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        begin
-          if !File.exist?(File.expand_path("~/.gem/credentials"))
-            @error = "You need to log in to Rubygems first by running `gem push #{gem_file}` manually"
-            return nil
-          end
-          Cheetah.run(["gem", "push", gem_file])
-        rescue Cheetah::ExecutionFailed => e
-          @error = e.message
-          return nil
-        end
+    def assert(executor)
+      if !File.exist?(File.expand_path("~/.gem/credentials"))
+        raise AssertionError.new("You need to log in to Rubygems first by running `gem push #{gem_file}` manually")
       end
+
+      executor.run_command(["gem", "push", gem_file])
+
       gem_file
     end
   end

data/assertions/pushed_code.rb

@@ -2,22 +2,20 @@ module YSI
   class PushedCode < Assertion
     needs "release_branch"
 
-    def display_name
+    def self.display_name
       "pushed code"
     end
 
     def check
-      if Git.new.needs_push?
+      if Git.new(Executor.new).needs_push?
         return nil
       else
         return "up-to-date"
       end
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        Git.new.push
-      end
+    def assert(executor)
+      Git.new(executor).push
       return "pushed"
     end
   end

data/assertions/pushed_tag.rb

@@ -2,7 +2,7 @@ module YSI
   class PushedTag < Assertion
     needs "tag"
 
-    def display_name
+    def self.display_name
       "pushed tag"
     end
 
@@ -11,7 +11,7 @@ module YSI
     end
 
     def check
-      response = `git ls-remote --tags origin #{tag}`
+      response = Executor.new.run_command(["git", "ls-remote", "--tags", "origin", tag])
       if response.include?(tag)
         return response
       end
@@ -19,10 +19,8 @@ module YSI
       nil
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        `git push --tags`
-      end
+    def assert(executor)
+      executor.run_command(["git", "push", "--tags"])
       tag
     end
   end

data/assertions/release_archive.rb

@@ -1,6 +1,6 @@
 module YSI
   class ReleaseArchive < Assertion
-    def display_name
+    def self.display_name
       "release archive"
     end
 
@@ -25,19 +25,14 @@ module YSI
       nil
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        Dir.mktmpdir do |tmp_dir|
-          archive_dir = "#{engine.project_name}-#{engine.version}"
-          cmd = "git clone #{Dir.pwd} #{File.join(tmp_dir, archive_dir)} 2>/dev/null"
-          system(cmd)
-          FileUtils.mkdir_p(File.dirname(release_archive))
-          excludes = [".git", ".gitignore", "yes_ship_it.conf"]
-          exclude_options = excludes.map { |e| "--exclude '#{e}'" }.join(" ")
-          if !system("cd #{tmp_dir}; tar czf #{release_archive} #{exclude_options} #{archive_dir}")
-            return nil
-          end
-        end
+    def assert(executor)
+      Dir.mktmpdir do |tmp_dir|
+        archive_dir = "#{engine.project_name}-#{engine.version}"
+        executor.run_command(["git", "clone", Dir.pwd, File.join(tmp_dir, archive_dir)])
+        FileUtils.mkdir_p(File.dirname(release_archive))
+        excludes = [".git", ".gitignore", "yes_ship_it.conf"]
+        exclude_options = excludes.map { |e| ["--exclude", e] }.flatten
+        executor.run_command(["tar", "czf", release_archive] + exclude_options + [archive_dir], working_directory: tmp_dir)
       end
       filename
     end

data/assertions/release_branch.rb

@@ -1,6 +1,6 @@
 module YSI
   class ReleaseBranch < Assertion
-    def display_name
+    def self.display_name
       "release branch"
     end
 
@@ -23,14 +23,13 @@ module YSI
 
     def check
       if current_branch != branch
-        @error = "Not on release branch '#{branch}'"
-        return nil
+        raise AssertionError.new("Not on release branch '#{branch}'")
       else
         return branch
       end
     end
 
-    def assert(dry_run: false)
+    def assert(_executor)
       branch
     end
   end

data/assertions/submitted_rpm.rb

@@ -5,7 +5,7 @@ module YSI
     attr_reader :obs_user, :obs_password
     attr_reader :obs_package_files
 
-    def display_name
+    def self.display_name
       "submitted RPM"
     end
 
@@ -46,34 +46,34 @@ module YSI
       erb.result(RpmSpecHelpers.new(engine).get_binding)
     end
 
+    def base_url
+      "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/#{obs_project}/#{engine.project_name}"
+    end
+
     def check
       if !obs_project
-        @error = "OBS project is not set"
-        return nil
+        raise AssertionError.new("OBS project is not set")
       end
       if !engine.release_archive
-        @error = "Release archive is not set. Assert release_archive before submitted_rpm"
-        return nil
+        raise AssertionError.new("Release archive is not set. Assert release_archive before submitted_rpm")
       end
 
       read_obs_credentials(File.expand_path("~/.oscrc"))
 
+      @obs_package_files = []
+
       begin
-        url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}"
-        xml = RestClient.get(url)
+        xml = RestClient.get(base_url)
       rescue RestClient::Exception => e
         if e.is_a?(RestClient::ResourceNotFound)
           return nil
         elsif e.is_a?(RestClient::Unauthorized)
-          @error = "No credentials set for OBS. Use osc to do this."
-          return nil
+          raise AssertionError.new("No credentials set for OBS. Use osc to do this.")
         else
-          @error = e.to_s
-          return nil
+          raise AssertionError.new(e.to_s)
         end
       end
 
-      @obs_package_files = []
       doc = REXML::Document.new(xml)
       doc.elements.each("directory/entry") do |element|
         file_name = element.attributes["name"]
@@ -85,7 +85,7 @@ module YSI
       nil
     end
 
-    def assert(dry_run: false)
+    def assert(executor)
       engine.out.puts "..."
 
       old_files = []
@@ -96,34 +96,20 @@ module YSI
       end
 
       engine.out.puts "  Uploading release archive '#{archive_file_name}'"
-      if !dry_run
-        url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}/#{archive_file_name}"
-        file = File.new(engine.release_archive, "rb")
-        begin
-          RestClient.put(url, file, content_type: "application/x-gzip")
-        rescue RestClient::Exception => e
-          STDERR.puts e.inspect
-        end
-      end
+      url = "#{base_url}/#{archive_file_name}"
+      file = File.new(engine.release_archive, "rb")
+      executor.http_put(url, file, content_type: "application/x-gzip")
 
       spec_file = engine.project_name + ".spec"
       engine.out.puts "  Uploading spec file '#{spec_file}'"
-      if !dry_run
-        url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}/#{spec_file}"
-        content = create_spec_file("rpm/#{spec_file}.erb")
-        begin
-          RestClient.put(url, content, content_type: "text/plain")
-        rescue RestClient::Exception => e
-          STDERR.puts e.inspect
-        end
-      end
+      url = "#{base_url}/#{spec_file}"
+      content = create_spec_file("rpm/#{spec_file}.erb")
+      executor.http_put(url, content, content_type: "text/plain")
 
       old_files.each do |file|
         engine.out.puts "  Removing '#{file}'"
-        if !dry_run
-          url = "https://#{obs_user}:#{obs_password}@api.opensuse.org/source/home:cschum:go/#{engine.project_name}/#{file}"
-          RestClient.delete(url)
-        end
+        url = "#{base_url}/#{file}"
+        executor.http_delete(url)
       end
 
       engine.out.print "... "

data/assertions/tag.rb

@@ -2,7 +2,7 @@ module YSI
   class Tag < Assertion
     needs "version"
 
-    def display_name
+    def self.display_name
       "tag"
     end
 
@@ -11,9 +11,9 @@ module YSI
     end
 
     def check
-      `git tag`.each_line do |line|
+      Executor.new.run_command(["git", "tag"]).each_line do |line|
         if line.chomp == tag
-          `git show #{tag}`.each_line do |show_line|
+          Executor.new.run_command(["git", "show", tag]).each_line do |show_line|
             if show_line =~ /Date:\s+(.*)/
               @engine.tag_date = $1
             end
@@ -24,10 +24,8 @@ module YSI
       return nil
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        `git tag -a #{tag} -m "Version #{@engine.version}"`
-      end
+    def assert(executor)
+      executor.run_command(["git", "tag", "-a", tag, "-m", engine.version])
       tag
     end
   end

data/assertions/version.rb

@@ -2,14 +2,13 @@ module YSI
   class Version < Assertion
     parameter :version_file, "lib/version.rb"
 
-    def display_name
+    def self.display_name
       "version number"
     end
 
     def check
       if !File.exist?(version_file)
-        @error = "Expected version in #{version_file}"
-        return nil
+        raise AssertionError.new("Expected version in #{version_file}")
       end
 
       version = parse_version(version_file)
@@ -17,11 +16,10 @@ module YSI
         @engine.version = version
         return @engine.version
       end
-      @error = "Couldn't find version in #{version_file}"
-      nil
+      raise AssertionError.new("Couldn't find version in #{version_file}")
     end
 
-    def assert(dry_run: false)
+    def assert(_executor)
     end
 
     def parse_version(file_name)
@@ -37,6 +35,12 @@ module YSI
             return $1
           end
         end
+      elsif file_name =~ /\.h$/
+        File.read(file_name).each_line do |line|
+          if line =~ /#define .*_VERSION "(.*)"/
+            return $1
+          end
+        end
       end
       nil
     end

data/assertions/working_directory.rb

@@ -1,6 +1,6 @@
 module YSI
   class WorkingDirectory < Assertion
-    def display_name
+    def self.display_name
       "working directory"
     end
 
@@ -30,12 +30,11 @@ module YSI
       if status == "clean"
         return status
       else
-        @error = status
-        return nil
+        raise AssertionError.new(status)
       end
     end
 
-    def assert(dry_run: false)
+    def assert(_executor)
       "clean"
     end
   end

data/assertions/yes_it_shipped.rb

@@ -2,7 +2,7 @@ module YSI
   class YesItShipped < Assertion
     needs "tag"
 
-    def display_name
+    def self.display_name
       "pushed to yes-it-shipped"
     end
 
@@ -15,17 +15,11 @@ module YSI
       end
     end
 
-    def assert(dry_run: false)
-      if !dry_run
-        begin
-          RestClient.post("https://yes-it-shipped.herokuapp.com/releases",
-            project: engine.project_name, version: engine.version,
-            release_date_time: engine.tag_date, project_url: engine.project_url,
-            release_url: engine.release_url, ysi_config_url: engine.config_url)
-        rescue RestClient::Exception
-          return nil
-        end
-      end
+    def assert(executor)
+      executor.http_post("https://yes-it-shipped.herokuapp.com/releases",
+        project: engine.project_name, version: engine.version,
+        release_date_time: engine.tag_date, project_url: engine.project_url,
+        release_url: engine.release_url, ysi_config_url: engine.config_url)
       "#{engine.project_name}-#{engine.version}"
     end
   end

data/bin/yes_ship_it

@@ -37,19 +37,30 @@ if ARGV == ["changelog"]
   system("git log #{tag}..HEAD")
   exit 0
 elsif ARGV == ["init"]
-  File.open("yes_ship_it.conf", "w") do |file|
-    file.puts "# Experimental release automation. See https://github.com/cornelius/yes_ship_it."
-    file.puts "include:"
-    file.puts "  ruby_gem"
+  YSI::Init.new(Dir.pwd).setup_config
+elsif ARGV[0] == "plugin"
+  plugin = YSI::Plugin.new(Dir.pwd)
+  if ARGV[1] == "list"
+    plugin.list
+  elsif ARGV[1] == "generate"
+    if !ARGV[2].is_a?(String) && !ARGV[3].is_a?(String)
+      STDERR.puts "Parameters are missing. Use for example"
+      STDERR.puts
+      STDERR.puts "    yes_ship_it plugin generate my_plugin \"My plugin\""
+      STDERR.puts
+      STDERR.puts "to generate a plugin `my_plugin` with a display name of \"My plugin\"."
+      exit 1
+    end
+    plugin.generate(ARGV[2], ARGV[3])
+  else
+    STDERR.puts "Invalid command"
+    STDERR.puts
+    STDERR.puts option_parser
+    exit 1
   end
-  puts "Initialized directory for shipping."
-  puts
-  puts "Check the file `yes_ship_it.conf` and adapt it to your needs."
-  puts
-  puts "Happy shipping!"
 elsif ARGV.empty?
   if !File.exist?(config_file)
-    STDERR.puts("Unable to find file `yes_ship_it.conf`. I need it.")
+    STDERR.puts "Unable to find file `yes_ship_it.conf`. I need it."
     exit 1
   end
 
@@ -61,6 +72,8 @@ elsif ARGV.empty?
   engine.data_dir = options[:data_dir] if options[:data_dir]
 
   begin
+    YSI::Plugin.new(Dir.pwd).load
+
     engine.read(config_file)
 
     exit engine.run

data/lib/version.rb

@@ -1,3 +1,3 @@
 module YSI
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/yes_ship_it/assertion.rb

@@ -1,12 +1,14 @@
 module YSI
   class Assertion
-    attr_reader :error
     attr_accessor :engine
 
+    def self.class_name(name)
+      name.split("_").map { |n| n.capitalize }.join
+    end
+
     def self.class_for_name(name)
-      class_name = name.split("_").map { |n| n.capitalize }.join
       begin
-        Object.const_get("YSI::" + class_name)
+        Object.const_get("YSI::" + class_name(name))
       rescue NameError
         raise YSI::Error.new("Error: Unknown assertion '#{name}'")
       end
@@ -53,6 +55,10 @@ module YSI
       @parameter_defaults = {}
     end
 
+    def display_name
+      self.class.display_name
+    end
+
     def needs
       @dependencies ||= self.class.dependency_names.map do |d|
         Assertion.class_for_name(d)

data/lib/yes_ship_it/dry_executor.rb

@@ -0,0 +1,15 @@
+module YSI
+  class DryExecutor
+    def run_command(args)
+    end
+
+    def http_post(url, data)
+    end
+
+    def http_put(url, data, options)
+    end
+
+    def http_delete(url)
+    end
+  end
+end