git-semaphore 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d581bd5005d05232ba4b5a48c550869e5b0899a
-  data.tar.gz: 11ebd99ca6deace07ea9bae7e99e8616316f78e0
+  metadata.gz: 59236af413fec5cad9c165b9450fdb9817be6379
+  data.tar.gz: 3a94ad7ec8bd108fc641fc8d046616459aa4737c
 SHA512:
-  metadata.gz: 3dfe7c3bf1f6492b35649130e1dc6467841bcc6279172d0b8b7fb90bf2b8c27374a77594b66e5bd71261d650360511a3403f42baa0c0843a5bca5af1a338dfb6
-  data.tar.gz: e8559616dbab2c11fcc95f8d61cce38a148c1225b3af54e0989d4cbbe8df7c4dd786e02256bd77cbbe073b87c734af3ae82a5822b9fde3609bb60dc6b84353c2
+  metadata.gz: a1116948c842d29d2f84197a8d3ba6c987f0f36ac08f95c72403b9b32d00107c34f9ee3c5939cd8c244e65c49a20ab2bcd5e18247dd06c1481306a8ab9131de9
+  data.tar.gz: e9b6969e61247975e23149de4ac36f335cffb5c1acef1fb5f25993a8e2d1ce640dbdbdfb2071b32e194b23c04d978e05eb1328e882c753a14107fadc67003694

data/.pryrc

@@ -2,5 +2,9 @@
 load "exe/git-semaphore" unless Kernel.const_defined? 'Git::Semaphore'
 
 # utility function to set pry context
-# to an instance of <Git::Semaphore::App>
-def app() pry Git::Semaphore::App.new(Git::Semaphore.auth_token, Git::Semaphore.git_repo, ENV) ; end
+# to an instance of <Rugged::Repository>
+def repository() pry Git::Semaphore.git_repo ; end
+
+# utility function to set pry context
+# to an instance of <Git::Semaphore::Project>
+def project() pry Git::Semaphore::Project.from_repo(Git::Semaphore.git_repo) ; end

data/README.md

@@ -4,7 +4,7 @@
 
 [![Travis CI](https://travis-ci.org/pvdb/git-semaphore.svg?branch=v0.0.6)](https://travis-ci.org/pvdb/git-semaphore)
 
-Integrate git repositories with their corresponding project on [semaphoreci.com][] _(via the semaphore API)_
+Integrate git repositories with their corresponding project on [semaphoreci.com][] _(via the Semaphore API)_
 
 ## Features
 
@@ -108,27 +108,62 @@ When used inside a git repository, `git semaphore` uses [convention over configu
 
 | setting      | inside git repo    | pseudo-code                     | override                        |
 |--------------|--------------------|---------------------------------|---------------------------------|
-| project name | derived from pwd   | `File.basename(Dir.pwd)`        | `ENV['SEMAPHORE_PROJECT_NAME']` |
+| owner & name | based on `${PWD}`  | `Dir.pwd.split('/').last(2)`    | `ENV['SEMAPHORE_PROJECT_NAME']` |
 | branch name  | current git branch | `git symbolic-ref --short HEAD` | `ENV['SEMAPHORE_BRANCH_NAME']`  |
 | commit SHA   | current git head   | `git rev-parse HEAD`            | `ENV['SEMAPHORE_COMMIT_SHA']`   |
 | build number | last branch build  | `N/A`                           | `ENV['SEMAPHORE_BUILD_NUMBER']` |
 
 However, each of these defaults can be overridden by setting the corresponding environment variable, as documented in the above table.  The same `ENV`-based override mechanism can be leveraged to use `git semaphore` outside of a git repository.
 
-The `git semaphore --settings` command can be used to print out the values for these various settings:
+## Using the "full name" convention
+
+On your local filesystem, git repositories need to use paths that follow the "full name" convention in use on `github.com` and `semaphoreci.com`, ie. the last two path components for the `pvdb/git-semaphore` repository should be `pvdb` and `git-semaphore` respectively, as illustrated on this table:
+
+|           | full name            | owner  | name            | URL / path                                   |
+|-----------|----------------------|--------|-----------------|----------------------------------------------|
+|           | `pvdb/git-semaphore` | `pvdb` | `git-semaphore` |                                              |
+| GitHub    |                      |        |                 | `https://github.com/pvdb/git-semaphore`      |
+| Semaphore |                      |        |                 | `https://semaphoreci.com/pvdb/git-semaphore` |
+| filesytem |                      |        |                 | `${HOME}/Projects/pvdb/git-semaphore`        |
+
+Put differently: if you typically create your git repositories in `${HOME}/Projects`, and you have the following three git repos...
+
+    pvdb/git-meta
+    pvdb/git-semaphore
+    pvdb/git-switcher
+
+... then the directory tree should be as follows:
+
+    ${HOME}/Projects
+    └── pvdb
+        ├── git-meta
+        │   └── .git
+        ├── git-semaphore
+        │   └── .git
+        └── git-switcher
+            └── .git
+
+So first you have a directory corresponding to the repository owner (`pvdb`) and one level down you have a directory corresponding to the repository name (`git-meta`, `git-semaphore` and `git-switcher` respectively).
+
+## A look behind the scences
+
+The `git semaphore --settings` command can be used to print out the values for the most relevant settings:
 
     $ git semaphore --settings | jq '.'
     {
-      "semaphore_auth_token": "Yds3w6o26FLfJTnVK2y9",
-      "semaphore_project_name": "git-semaphore",
-      "semaphore_branch_name": "master",
-      "semaphore_commit_sha": "4b59c3e41ca4592dfb01f77f2163154f3d3532fe"
+      "auth_token": "Yds3w6o26FLfJTnVK2y9",
+      "project_name": "pvdb/git-semaphore",
+      "branch_name": "master",
+      "commit_sha": "4b59c3e41ca4592dfb01f77f2163154f3d3532fe",
+      "build_number": "35"
     }
     $ _
 
+The `git semaphore --internals` command adds all internal settings to the above settings hash.
+
 ## Available commands
 
-> ⚠️ all of the below examples need to be run from within a git repository ⚠️
+> ⚠️ all of the below examples need to be run from within a git repository that follows the "full name" convention documented above ⚠️
 
 ### list the Semaphore settings
 
@@ -189,6 +224,9 @@ After installing [the indispensable jq utility][jq] (`brew install jq`), the raw
     # pretty-print the git semaphore settings
     git semaphore --settings | jq '.'
 
+    # pretty-print the git semaphore internals
+    git semaphore --internals | jq '.'
+
     # list the full name of all Semaphore projects
     git semaphore --projects | jq -r '.[] | .full_name'
 

data/exe/git-semaphore

@@ -17,7 +17,9 @@ if __FILE__ == $0
 
     banner Git::Semaphore::BANNER
 
-    on :settings, 'Display the relevants settings'
+    on :settings,  'Display most relevant settings'
+    on :internals, 'Display all internal settings'
+
     on :browse,   'Open the project on https://semaphoreci.com/'
 
     on :clean,    'Deletes the cached API query results'
@@ -32,55 +34,64 @@ if __FILE__ == $0
 
   end
 
-  app = Git::Semaphore::App.new(Git::Semaphore.auth_token, Git::Semaphore.git_repo, ENV)
+  if options.clean?
+    Git::Semaphore.empty_cache_dir
+    exit 0
+  end
 
-  if options.settings?
-    puts app.to_json
+  if options.projects?
+    puts Git::Semaphore::Project.all.to_json
     exit 0
   end
 
-  if options.browse?
-    `open #{app.branch_url}`
+  project = if (git_repo = Git::Semaphore.git_repo)
+    Git::Semaphore::Project.from_repo(git_repo)
+  else
+    Git::Semaphore::Project.from_config(ENV)
+  end
+
+  if options.settings?
+    puts project.settings.to_json
     exit 0
   end
 
-  if options.clean?
-    Git::Semaphore.empty_cache_dir
+  if options.internals?
+    puts project.internals.to_json
     exit 0
   end
 
-  if options.projects?
-    puts app.projects.to_json
+  if options.browse?
+    `open #{project.branch_url}`
     exit 0
   end
 
   if options.branches?
-    puts app.branches.to_json
+    puts project.branches.to_json
     exit 0
   end
 
   if options.status?
-    puts app.status.to_json
+    puts project.status.to_json
     exit 0
   end
 
   if options.history?
-    puts app.history.to_json
+    puts project.history.to_json
     exit 0
   end
 
   if options.information?
-    puts app.information.to_json
+    puts project.information.to_json
     exit 0
   end
 
   if options.log?
-    puts app.log.to_json
+    puts project.log.to_json
     exit 0
   end
 
   if options.rebuild?
-    puts app.rebuild
+    puts project.rebuild
     exit 0
   end
 

data/git-semaphore.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "slop", "~> 3.0"
-  spec.add_dependency "grit", "~> 2.0"
+  spec.add_dependency "rugged" , "~> 0.24"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/git/semaphore.rb

@@ -1,10 +1,17 @@
 require 'uri'
+require 'date'
 require 'json'
 require 'openssl'
 require 'net/http'
 require 'fileutils'
 
-require 'grit'
+require 'rugged'
+
+class Rugged::Repository
+  def owner()     File.basename(File.dirname(workdir)) ; end
+  def name()      File.basename(workdir) ;               end
+  def full_name() "#{owner}/#{name}" ;                   end
+end
 
 module Git
   module Semaphore
@@ -44,9 +51,9 @@ module Git
     end
 
     def self.git_repo
-      @git_repo ||= begin
-        Grit::Repo.new(Dir.pwd)
-      rescue Grit::InvalidGitRepositoryError
+      begin
+        Rugged::Repository.new(Dir.pwd)
+      rescue Rugged::RepositoryError
         nil
       end
     end
@@ -74,4 +81,4 @@ require 'git/semaphore/api'
 require 'git/semaphore/api_cache'
 require 'git/semaphore/api_enrich'
 
-require 'git/semaphore/app'
+require 'git/semaphore/project'

data/lib/git/semaphore/project.rb

@@ -0,0 +1,176 @@
+class Git::Semaphore::Project
+
+  def self.env_overrides
+    ENV.to_h.select { |key, _| key.start_with? 'SEMAPHORE_' }
+  end
+
+  def self.from_repo git_repo
+    self.from_config({
+      'SEMAPHORE_PROJECT_NAME' => git_repo.full_name,
+      'SEMAPHORE_BRANCH_NAME'  => git_repo.head.name.split('/').last,
+      'SEMAPHORE_COMMIT_SHA'   => git_repo.head.target.oid,
+      'SEMAPHORE_BUILD_NUMBER' => nil
+    }.merge(env_overrides))
+  end
+
+  def self.from_config config
+    self.new(
+      full_name:      config['SEMAPHORE_PROJECT_NAME'],
+      branch_name:    config['SEMAPHORE_BRANCH_NAME'],
+      options: {
+        commit_sha:   config['SEMAPHORE_COMMIT_SHA'],
+        build_number: config['SEMAPHORE_BUILD_NUMBER'],
+      }
+    )
+  end
+
+  def initialize full_name:, branch_name:, options:
+    @auth_token   = Git::Semaphore.auth_token
+    @full_name    = full_name
+    @owner, @name = full_name.split('/')
+    @branch_name  = branch_name || 'master'
+    @commit_sha   = options[:commit_sha]
+    @build_number = options[:build_number]
+  end
+
+  def settings
+    {
+      auth_token:   @auth_token,
+      project_name: @full_name,
+      branch_name:  @branch_name,
+      commit_sha:   @commit_sha,
+      build_number: @build_number,
+    }
+  end
+
+  def internals
+    settings.merge({
+      project: {
+        owner:      @owner,
+        name:       @name,
+        full_name:  @full_name,
+        hash_id:    project_hash_id,
+        url:        project_url,
+      },
+      branch: {
+        name:       @branch_name,
+        id:         branch_id,
+        url:        branch_url,
+      },
+      build: {
+        number:     build_number,
+        result:     build_result,
+        url:        build_url,
+      },
+    })
+  end
+
+  #
+  # build-related queries: default to latest one...
+  #
+
+  def build_number
+    @build_number ||= history['builds'].first['build_number'].to_s
+  end
+
+  def build_result
+    @build_result ||= history['builds'].first['result']
+  end
+
+  #
+  # direct links to semaphore.ci
+  #
+
+  def project_url
+    project_hash['html_url']
+  end
+
+  def branch_url
+    branch_hash = project_hash['branches'].find { |hash|
+      hash['branch_name'] == @branch_name
+    }
+    branch_hash['branch_url']
+  end
+
+  def build_url
+    build_hash = history['builds'].find { |hash|
+      hash['build_number'].to_s == @build_number
+    }
+    build_hash['build_url']
+  end
+
+  #
+  # API related queries
+  #
+
+  def self.all
+    Git::Semaphore::API::Cache.projects(Git::Semaphore.auth_token)
+  end
+
+  class << self
+    alias_method :projects, :all
+  end
+
+  def branches
+    Git::Semaphore::API::Cache.branches(project_hash_id, @auth_token)
+  end
+
+  def status
+    Git::Semaphore::API::Cache.status(project_hash_id, branch_id, @auth_token)
+  end
+
+  def history
+    Git::Semaphore::API::Cache.history(project_hash_id, branch_id, @auth_token)
+  end
+
+  def information
+    Git::Semaphore::API::Cache.information(project_hash_id, branch_id, build_number, @auth_token,)
+  end
+
+  def log
+    Git::Semaphore::API::Cache.log(project_hash_id, branch_id, build_number, @auth_token,)
+  end
+
+  def rebuild
+    Git::Semaphore::API.rebuild(project_hash_id, branch_id, @auth_token)
+  end
+
+  private
+
+  def project_hash_for owner, name
+    self.class.projects.find { |project_hash|
+      project_hash['owner'] == owner && project_hash['name'] == name
+    }
+  end
+
+  def project_hash
+    project_hash_for(@owner, @name)
+  end
+
+  def project_hash_id_for owner, name
+    project_hash_for(owner, name)['hash_id']
+  end
+
+  def project_hash_id
+    project_hash_id_for(@owner, @name)
+  end
+
+  def branch_hash_for branch_name
+    branches.find { |branch_hash|
+      branch_hash['name'] == branch_name
+    }
+  end
+
+  def branch_hash
+    branch_hash_for(@branch_name)
+  end
+
+  def branch_id_for branch_name
+    branch_hash_for(branch_name)['id'].to_s
+  end
+
+  def branch_id
+    branch_id_for(@branch_name)
+  end
+
+end

data/lib/git/semaphore/version.rb

@@ -1,5 +1,5 @@
 module Git
   module Semaphore
-    VERSION = "1.2.0"
+    VERSION = "2.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-semaphore
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Vandenberk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slop
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: grit
+  name: rugged
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.24'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.24'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -134,9 +134,9 @@ files:
 - lib/git/semaphore/api.rb
 - lib/git/semaphore/api_cache.rb
 - lib/git/semaphore/api_enrich.rb
-- lib/git/semaphore/app.rb
 - lib/git/semaphore/banner.rb
 - lib/git/semaphore/copyright.rb
+- lib/git/semaphore/project.rb
 - lib/git/semaphore/version.rb
 homepage: https://github.com/pvdb/git-semaphore
 licenses:

data/lib/git/semaphore/app.rb

@@ -1,133 +0,0 @@
-class Git::Semaphore::App
-
-  attr_writer :project_name
-  attr_writer :branch_name
-  attr_writer :commit_sha
-  attr_writer :build_number
-
-  attr_reader :branch_url
-
-  def initialize auth_token, git_repo, config = ENV
-    @auth_token = auth_token
-    @git_repo   = git_repo
-
-    self.project_name = config['SEMAPHORE_PROJECT_NAME']
-    self.branch_name  = config['SEMAPHORE_BRANCH_NAME']
-    self.commit_sha   = config['SEMAPHORE_COMMIT_SHA']
-    self.build_number = config['SEMAPHORE_BUILD_NUMBER']
-  end
-
-  def to_json
-    {
-      semaphore_auth_token:   @auth_token,
-      semaphore_project_name: self.project_name,
-      semaphore_branch_name:  self.branch_name,
-      semaphore_commit_sha:   self.commit_sha,
-      semaphore_build_number: self.build_number,
-    }.to_json
-  end
-
-  def project_name
-    return @project_name unless @project_name.nil?
-    File.basename @git_repo.git.work_tree if @git_repo
-  end
-
-  def branch_name
-    return @branch_name unless @branch_name.nil?
-    @git_repo.head.name if @git_repo
-  end
-
-  def commit_sha
-    return @commit_sha unless @commit_sha.nil?
-    @git_repo.head.commit.id if @git_repo
-  end
-
-  def build_number
-    return @build_number unless @build_number.nil?
-    history['builds'].first['build_number'].to_s
-  end
-
-  def projects
-    Git::Semaphore::API::Cache.projects(@auth_token)
-  end
-
-  def branches
-    Git::Semaphore::API::Cache.branches(project_hash_id, @auth_token)
-  end
-
-  def status
-    Git::Semaphore::API::Cache.status(project_hash_id, branch_id, @auth_token)
-  end
-
-  def history
-    Git::Semaphore::API::Cache.history(project_hash_id, branch_id, @auth_token)
-  end
-
-  def information
-    Git::Semaphore::API::Cache.information(project_hash_id, branch_id, build_number, @auth_token,)
-  end
-
-  def log
-    Git::Semaphore::API::Cache.log(project_hash_id, branch_id, build_number, @auth_token,)
-  end
-
-  def rebuild
-    Git::Semaphore::API.rebuild(project_hash_id, branch_id, @auth_token)
-  end
-
-  def branch_url
-    branch_hash = project_hash['branches'].find { |hash|
-      hash['branch_name'] == branch_name
-    }
-    branch_hash['branch_url']
-  end
-
-  private
-
-  def project_hash_for project_name
-    projects.find { |project_hash|
-      project_hash['name'] == project_name
-    }
-  end
-
-  def project_hash
-    project_hash_for(project_name)
-  end
-
-  def project_hash_id_for project_name
-    project_hash_for(project_name)['hash_id']
-  end
-
-  def project_hash_id
-    project_hash_id_for(project_name)
-  end
-
-  def branch_hash_for branch_name
-    branches.find { |branch_hash|
-      branch_hash['name'] == branch_name
-    }
-  end
-
-  def branch_hash
-    branch_hash_for(branch_name)
-  end
-
-  def branch_id_for branch_name
-    branch_hash_for(branch_name)['id'].to_s
-  end
-
-  def branch_id
-    branch_id_for(branch_name)
-  end
-
-  def build_status_for commit_sha
-    history['builds'].find { |build_status|
-      build_status['commit']['id'] == commit_sha
-    }
-  end
-
-  def build_status
-    build_status_for(commit_sha)
-  end
-
-end