sleet 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8eb6437ac9bdfb783a8d168289c197d3dbc7626e2f3e68a1484d6c538f1106b
-  data.tar.gz: 695273c145d440bc2ab46a9ba3238641b04fb8d655135ad3f6a281f44e414deb
+  metadata.gz: 8805bb18d2e088cf5f63494b42e29e4e05afcd187917c8260823911242d5910b
+  data.tar.gz: 3611f50834801d5c2330a1f30a249faf89985bc0675a1d4b00911c25405565ae
 SHA512:
-  metadata.gz: 88eee7ed041b3fdf4c886fd7bebe2f0e8ca4df3d68623d40f0c2647b8a9f6b0cbc752e25d73a9b40373682b5628267e8fc12755e23bb9c8519c9b557a975495b
-  data.tar.gz: fe6e5e4a5eab4eef4cf992e35fb1ad2e2040873986509141082fd75a42f543dfc4c46acdc12ad470c093ebe39db03b33b6d60223df3d0bb15ae76d532b0f85d8
+  metadata.gz: 92c65ac25258e338d9e86af77142a172621af44ea3ab9aad61bf91924c2e4a3f8fe15c0428c5acce1c80412e20789c8a8aadfe9e02644aeccaa54888b829038d
+  data.tar.gz: eaf9852bceea8250b85a499af61dda56463aeb6fd85ea1b49c0566b0b99c65ff09ba9ea02a9e0200b13a268960c211402892b2b88d38ce70d06f6db324334ca1

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 # Changelog
 
-## [v0.4.3](https://github.com/coreyja/sleet/tree/v0.4.3) (2020-03-06)
+## [v0.5.0](https://github.com/coreyja/sleet/tree/v0.5.0) (2020-06-13)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.3...v0.5.0)
+
+**Closed issues:**
+
+- Add Support for Forked Repos in Github [\#41](https://github.com/coreyja/sleet/issues/41)
+
+**Merged pull requests:**
+
+- Support PR builds from forked repos!!! ✨ [\#77](https://github.com/coreyja/sleet/pull/77) ([smudge](https://github.com/smudge))
+- Update rugged requirement from \>= 0.26, \< 0.100 to \>= 0.26, \< 1.1 [\#76](https://github.com/coreyja/sleet/pull/76) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rugged requirement from \>= 0.26, \< 0.29 to \>= 0.26, \< 0.100 [\#75](https://github.com/coreyja/sleet/pull/75) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update thor requirement from ~\> 0.20.0 to \>= 0.20, \< 1.1 [\#70](https://github.com/coreyja/sleet/pull/70) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
+## [v0.4.3](https://github.com/coreyja/sleet/tree/v0.4.3) (2020-03-07)
 
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.2...v0.4.3)
 

data/docs/README.md

@@ -95,31 +95,31 @@ To view your current configuration use the `sleet config` command which will giv
 
 These are the options that are currently supported
 
-#### `source_dir`
+#### `--source_dir`
 
-Alias: s
+Alias: `s`
 
 This is the directory of the source git repo. If a `source_dir` is NOT given we look up from the current directory for the nearest git repo.
 
-#### `input_file`
+#### `--input_file`
 
-Alias: i
+Alias: `i`
 
 This is the name of the Rspec Circle Persistance File in CircleCI. The default is `.rspec_example_statuses`
 
 This will match if the full path on CircleCI ends in the given name.
 
-#### `output_file`
+#### `--output_file`
 
-Alias: o
+Alias: `o`
 
 This is the name for the output file, on your local system. It is relative to the `source_dir`.
 
 Will be IGNORED if `workflows` is provided.
 
-#### `workflows`
+#### `--workflows`
 
-Alias: w
+Alias: `w`
 
 If you are using workflows in CircleCI, then this is for you! You need to tell `Sleet` which build(s) to look in, and where each output should be saved.
 The input is a hash, where the key is the build name and the value is the `output_file` for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
@@ -133,7 +133,6 @@ This command will pick the `test` build and save its artifacts to the `.rspec_ex
 ```
 sleet fetch --workflows test:.rspec_example_statuses
 ```
-
 MonoRepo Demo:
 
 If you have a mono-repo that contains 3 sub-dirs. `foo`, `bar` and `baz`. And each one has an accompanying build. We can process all these sub-dirs at once with the following workflow command.
@@ -141,3 +140,21 @@ If you have a mono-repo that contains 3 sub-dirs. `foo`, `bar` and `baz`. And ea
 ```
 sleet fetch --workflows foo-test:foo/.rpsec_example_statuses bar-test:bar/.rspec_example_statuses baz-specs:baz/spec/examples.txt
 ```
+
+#### `--username`
+
+Alias: `u`
+
+This is the GitHub username that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+
+#### `--project`
+
+Alias: `p`
+
+This is the GitHub project that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+
+#### `--branch`
+
+Alias: `b`
+
+This is the remote branch that is referenced by the CircleCI build. Sleet will attempt to guess this by default, but if you are pushing to a forked repo, you may need to specify a different branch name (e.g. "pull/1234").

data/lib/sleet.rb

@@ -25,6 +25,7 @@ require 'sleet/config'
 require 'sleet/error'
 require 'sleet/fetch_command'
 require 'sleet/job_fetcher'
+require 'sleet/local_repo'
 require 'sleet/repo'
 require 'sleet/rspec_file_merger'
 require 'sleet/version'

data/lib/sleet/branch.rb

@@ -6,7 +6,7 @@ module Sleet
       @circle_ci_token = circle_ci_token
       @github_user = github_user
       @github_repo = github_repo
-      @branch = branch
+      @branch = CGI.escape(branch)
     end
 
     def builds

data/lib/sleet/cli.rb

@@ -4,6 +4,10 @@ module Sleet
   class Cli < Thor
     default_task :fetch
 
+    def self.exit_on_failure?
+      true
+    end
+
     desc 'fetch', 'Fetch and Aggregate RSpec Persistance Files from CircleCI'
     long_desc <<~LONGDESC
       `sleet fetch` will find build(s) in CircleCI for the current branch, and
@@ -20,6 +24,15 @@ module Sleet
     option :output_file, type: :string, aliases: [:o], desc: <<~DESC
       This is the name for the output file, on your local system. It is relative to the source_dir. Will be IGNORED if workflows is provided.
     DESC
+    option :username, type: :string, aliases: [:u], desc: <<~DESC
+      This is the GitHub username that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+    DESC
+    option :project, type: :string, aliases: [:p], desc: <<~DESC
+      This is the GitHub project that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+    DESC
+    option :branch, type: :string, aliases: [:b], desc: <<~DESC
+      This is the remote branch that is referenced by the CircleCI build. Sleet will attempt to guess this by default, but if you are pushing to a forked repo, you may need to specify a different branch name (e.g. "pull/1234").
+    DESC
     option :workflows, type: :hash, aliases: [:w], desc: <<~DESC
       To use Sleet with CircleCI Workflows you need to tell Sleet which build(s) to look in, and where each output should be saved. The input is a hash, where the key is the build name and the value is the output_file for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
     DESC

data/lib/sleet/config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Sleet
-  class Config
+  class Config # rubocop:disable Metrics/ClassLength
     OPTION_FILENAME = '.sleet.yml'
     HIDDEN_UNLESS_IN_CLI_OPTIONS = %w[show_sensitive print_config].freeze
     ConfigOption = Struct.new(:value, :source)
@@ -23,6 +23,18 @@ module Sleet
       options_hash[:output_file]
     end
 
+    def username
+      options_hash[:username]
+    end
+
+    def project
+      options_hash[:project]
+    end
+
+    def branch
+      options_hash[:branch]
+    end
+
     def workflows
       options_hash[:workflows]
     end

data/lib/sleet/fetch_command.rb

@@ -7,7 +7,6 @@ module Sleet
     end
 
     def do!
-      repo.validate!
       error_messages = []
       fetchers.map do |fetcher|
         begin

data/lib/sleet/job_fetcher.rb

@@ -41,10 +41,6 @@ module Sleet
       ).files
     end
 
-    def branch
-      repo.branch
-    end
-
     def build
       build_selector.build
     end

data/lib/sleet/local_repo.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Sleet
+  class LocalRepo
+    REMOTE_BRANCH_REGEX = %r{^([^\/.]+)\/(.+)}.freeze
+    CURRENT_BRANCH_REGEX = %r{^refs\/heads\/}.freeze
+    GITHUB_MATCH_REGEX = %r{github.com[:\/](.+)\/(.+)\.git}.freeze
+
+    def initialize(source_dir:)
+      @source_dir = source_dir
+    end
+
+    def username
+      validate!
+
+      github_match[1]
+    end
+
+    def project
+      validate!
+
+      github_match[2]
+    end
+
+    def branch_name
+      validate!
+
+      current_branch.upstream.name.match(REMOTE_BRANCH_REGEX)[2]
+    end
+
+    private
+
+    attr_reader :source_dir
+
+    def current_branch_name
+      @current_branch_name ||= repo.head.name.sub(CURRENT_BRANCH_REGEX, '')
+    end
+
+    def current_branch
+      @current_branch ||= repo.branches[current_branch_name]
+    end
+
+    def github_match
+      @github_match ||= GITHUB_MATCH_REGEX.match(current_branch.remote.url)
+    end
+
+    def repo
+      @repo ||= Rugged::Repository.new(source_dir)
+    end
+
+    def validate!
+      return if @validated
+
+      must_be_on_branch!
+      must_have_an_upstream_branch!
+      upstream_remote_must_be_github!
+      @validated = true
+    end
+
+    def must_be_on_branch!
+      !current_branch.nil? ||
+        raise(Error, 'Not on a branch')
+    end
+
+    def must_have_an_upstream_branch!
+      !current_branch.remote.nil? ||
+        raise(Error, "No upstream branch set for the current branch of #{repo.current_branch_name}")
+    end
+
+    def upstream_remote_must_be_github!
+      !github_match.nil? ||
+        raise(Error, 'Upstream remote is not GitHub')
+    end
+  end
+end

data/lib/sleet/repo.rb

@@ -2,87 +2,44 @@
 
 module Sleet
   class Repo
-    REMOTE_BRANCH_REGEX = %r{^([^\/.]+)\/(.+)}.freeze
-    CURRENT_BRANCH_REGEX = %r{^refs\/heads\/}.freeze
-    GITHUB_MATCH_REGEX = %r{github.com[:\/](.+)\/(.+)\.git}.freeze
-
     def self.from_config(config)
+      local_repo = Sleet::LocalRepo.new(source_dir: config.source_dir)
+
       new(
-        repo: Rugged::Repository.new(config.source_dir),
-        circle_ci_token: config.circle_ci_token
+        circle_ci_token: config.circle_ci_token,
+        username: config.username || local_repo.username,
+        project: config.project || local_repo.project,
+        branch_name: config.branch || local_repo.branch_name
       )
     end
 
-    def initialize(repo:, circle_ci_token:)
-      @repo = repo
+    def initialize(circle_ci_token:, username:, project:, branch_name:)
       @circle_ci_token = circle_ci_token
+      @github_user = username
+      @github_repo = project
+      @branch_name = branch_name
     end
 
-    def validate!
-      must_be_on_branch!
-      must_have_an_upstream_branch!
-      upstream_remote_must_be_github!
-    end
-
-    def branch
-      @branch ||= Sleet::Branch.new(
+    def build_for(build_num)
+      Sleet::Build.new(
         circle_ci_token: circle_ci_token,
         github_user: github_user,
         github_repo: github_repo,
-        branch: remote_branch
+        build_num: build_num
       )
     end
 
-    def build_for(build_num)
-      Sleet::Build.new(
+    def branch
+      @branch ||= Sleet::Branch.new(
         circle_ci_token: circle_ci_token,
         github_user: github_user,
         github_repo: github_repo,
-        build_num: build_num
+        branch: branch_name
       )
     end
 
     private
 
-    attr_reader :repo, :circle_ci_token
-
-    def remote_branch
-      current_branch.upstream.name.match(REMOTE_BRANCH_REGEX)[2]
-    end
-
-    def github_user
-      github_match[1]
-    end
-
-    def github_repo
-      github_match[2]
-    end
-
-    def current_branch_name
-      repo.head.name.sub(CURRENT_BRANCH_REGEX, '')
-    end
-
-    def current_branch
-      repo.branches[current_branch_name]
-    end
-
-    def github_match
-      @github_match ||= GITHUB_MATCH_REGEX.match(current_branch.remote.url)
-    end
-
-    def must_be_on_branch!
-      !current_branch.nil? ||
-        raise(Error, 'Not on a branch')
-    end
-
-    def must_have_an_upstream_branch!
-      !current_branch.remote.nil? ||
-        raise(Error, "No upstream branch set for the current branch of #{repo.current_branch_name}")
-    end
-
-    def upstream_remote_must_be_github!
-      !github_match.nil? ||
-        raise(Error, 'Upstream remote is not GitHub')
-    end
+    attr_reader :circle_ci_token, :github_user, :github_repo, :branch_name
   end
 end

data/lib/sleet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sleet
-  VERSION = '0.4.3'
+  VERSION = '0.5.0'
 end

data/sleet.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'colorize', '~> 0.8.1'
   spec.add_dependency 'faraday', '>= 0.13.1', '< 1.1.0'
   spec.add_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'rugged', '>= 0.26', '< 0.29'
+  spec.add_dependency 'rugged', '>= 0.26', '< 1.1'
   spec.add_dependency 'terminal-table', '~> 1.8'
-  spec.add_dependency 'thor', '~> 0.20.0'
+  spec.add_dependency 'thor', '>= 0.20', '< 1.1'
 
   spec.add_development_dependency 'gem-release', '= 2.1.1'
   spec.add_development_dependency 'github_changelog_generator', '~> 1.14'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sleet
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Corey Alexander
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-07 00:00:00.000000000 Z
+date: 2020-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -67,7 +67,7 @@ dependencies:
         version: '0.26'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ dependencies:
         version: '0.26'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.29'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -96,16 +96,22 @@ dependencies:
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.20'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -231,6 +237,7 @@ files:
 - lib/sleet/error.rb
 - lib/sleet/fetch_command.rb
 - lib/sleet/job_fetcher.rb
+- lib/sleet/local_repo.rb
 - lib/sleet/repo.rb
 - lib/sleet/rspec_file_merger.rb
 - lib/sleet/version.rb