jets-git 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adfdc0534b83b46a4302ac4680ed364768af3307a445ebdc40adfc76d9aa9c14
+  data.tar.gz: 7dd52b79322e598fca76fc3eb700ca4c670c32f14c4b7d7b51990141b5d137f7
+SHA512:
+  metadata.gz: 664548444a428ba36a4ef6ea944c3006c7f59a0bb5d093cd3dbd0afb2b6078e4dd0b6ba970c2eb0b2c9e790c6cae53a5e1bce4e97528b7686624c8cdacdf8730
+  data.tar.gz: 46d9794e787d10da0457012ac43991511af8eb76713b9d13bdfca91fe52de0b0b9b171d8513bdb5a6c231592a8a6a84f60e2eb0fa5273d22caae09cb0f781a01

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/).
+
+## [0.2.0] - 2023-12-11
+- rename git_message attribute
+
+## [0.1.0]
+- Initial Release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Tung Nguyen
+
+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/README.md

@@ -0,0 +1,38 @@
+# Jets Git
+
+[![Gem Version](https://badge.fury.io/rb/jets-git.svg)](http://badge.fury.io/rb/jets-git)
+
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
+[![BoltOps Learn Badge](https://img.boltops.com/boltops-learn/boltops-learn.png)](https://learn.boltops.com)
+
+Gathers git information for Jets.
+
+This library gathers information from your local git repo or the build system [jets](https://rubyonjets.com) runs on. It supports:
+
+* **azure**: Azure Pipelines.
+* **bitbucket**: BitBucket Pipelines.
+* **circleci**: CircleCI.
+* **codebuild**: AWS CodeBuild
+* **custom**: Custom control.
+* **github**: Github Actions.
+* **gitlab**: Gitlab Pipelines.
+* **local**: Local git repo.
+
+## Custom Control
+
+You can set these variables if you have a custom build system and need more control over what is set. Example:
+
+    JETS_GIT_CUSTOM=1
+    JETS_GIT_CUSTOM_BRANCH=main
+    JETS_GIT_CUSTOM_SHA=abcdefgh
+    JETS_GIT_CUSTOM_URL=https://github.com/owner/repo
+    JETS_GIT_CUSTOM_MESSAGE="commit message"
+
+The `JETS_GIT_CUSTOM=1` tells the library to use the Custom information.
+
+## Disabling
+
+If you need to turn off the gathering of any git information, you can set it.
+
+    JETS_GIT_DISABLED=1

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+Bundler.setup
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new

data/lib/jets/git/autoloader.rb

@@ -0,0 +1,25 @@
+require "zeitwerk"
+
+module Jets
+  module Git
+    class Autoloader
+      class Inflector < Zeitwerk::Inflector
+        def camelize(basename, _abspath)
+          map = { version: "VERSION" }
+          map[basename.to_sym] || super
+        end
+      end
+
+      class << self
+        def setup
+          loader = Zeitwerk::Loader.new
+          loader.inflector = Inflector.new
+          lib = File.expand_path("../..", __dir__)
+          loader.push_dir(lib)
+          loader.ignore("#{lib}/jets-git.rb")
+          loader.setup
+        end
+      end
+    end
+  end
+end

data/lib/jets/git/azure.rb

@@ -0,0 +1,64 @@
+module Jets::Git
+  class Azure
+    def params
+      params = {
+        git_system: 'azure',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        # git_message: nil,
+        # git_version: nil,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      if pr_number
+        message = ENV['BUILD_SOURCEVERSIONMESSAGE']
+        md = message.match(/Merge pull request \d+ from (.*) into (.*)/)
+        if md
+          # IE: BUILD_SOURCEVERSIONMESSAGE=Merge pull request 2 from feature into main
+          # Its a bit weird but with azure repos with check policy trigger
+          md[1]
+        else # GitHub and Bitbucket PR has actual branch though
+          # IE: SYSTEM_PULLREQUEST_SOURCEBRANCH=feature
+          message
+        end
+      else # push
+        ENV['BUILD_SOURCEBRANCHNAME']
+      end
+    end
+
+    def git_sha
+      ENV['BUILD_SOURCEVERSION']
+    end
+
+    def git_url
+      "#{host}/#{full_repo}"
+    end
+
+    # IE: BUILD_REPOSITORY_URI=https://tongueroo@dev.azure.com/tongueroo/infra-project/_git/infra-ci
+    def host
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      "#{uri.scheme}://#{uri.host}"
+    end
+
+    # IE: BUILD_REPOSITORY_URI=https://tongueroo@dev.azure.com/tongueroo/infra-project/_git/infra-ci
+    def full_repo
+      uri = URI(ENV['BUILD_REPOSITORY_URI'])
+      org = uri.path.split('/')[1] # since there's a leading /
+      repo = ENV['BUILD_REPOSITORY_NAME'] # tongueroo
+      "#{org}/#{repo}"
+    end
+
+    # IE: SYSTEM_PULLREQUEST_PULLREQUESTID=2
+    def pr_number
+      ENV['SYSTEM_PULLREQUEST_PULLREQUESTID']
+    end
+
+    def build_type
+      ENV['SYSTEM_PULLREQUEST_PULLREQUESTID'] ? 'pull_request' : 'push'
+    end
+  end
+end

data/lib/jets/git/bitbucket.rb

@@ -0,0 +1,30 @@
+module Jets::Git
+  class Bitbucket
+    def params
+      params = {
+        git_system: 'bitbucket',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        # git_message: nil,
+        # git_version: nil,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      ENV['BITBUCKET_BRANCH']
+    end
+
+    def git_sha
+      ENV['BITBUCKET_COMMIT']
+    end
+
+    def git_url
+      host = ENV['BITBUCKET_HOST'] || 'https://bitbucket.org'
+      full_repo = ENV['BITBUCKET_REPO_FULL_NAME']
+      "#{host}/#{full_repo}"
+    end
+  end
+end

data/lib/jets/git/circleci.rb

@@ -0,0 +1,24 @@
+module Jets::Git
+  class Circleci
+    def params
+      params = {
+        git_system: 'circleci',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        # git_message: nil,
+        # git_version: nil,
+      }
+      # params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      ENV['CIRCLE_BRANCH']
+    end
+
+    def git_sha
+      ENV['CIRCLE_SHA1']
+    end
+  end
+end

data/lib/jets/git/codebuild.rb

@@ -0,0 +1,45 @@
+module Jets::Git
+  class Codebuild
+    def params
+      params = {
+        git_system: 'codebuild',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        # git_message: nil,
+        # git_version: nil,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      ENV['CODEBUILD_SOURCE_VERSION']
+    end
+
+    def git_sha
+      ENV['CODEBUILD_RESOLVED_SOURCE_VERSION']
+    end
+
+    def git_url
+      "#{host}/#{full_repo}"
+    end
+
+    def host
+      uri = URI(ENV['CODEBUILD_SOURCE_REPO_URL']) # https://github.com/ORG/REPO
+      "#{uri.scheme}://#{uri.host}"
+    end
+
+    # ORG/REPO
+    def full_repo
+      uri = URI(repo_url)
+      uri.path.sub(/^\//,'')
+    end
+
+    # https://github.com/ORG/REPO
+    def repo_url
+      # https://github.com/ORG/REPO.git
+      ENV['CODEBUILD_SOURCE_REPO_URL'].sub('.git','')
+    end
+  end
+end

data/lib/jets/git/custom.rb

@@ -0,0 +1,32 @@
+module Jets::Git
+  class Custom
+    def params
+      params = {
+        git_system: 'custom',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        git_message: git_message,
+        # git_version: nil,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      ENV['JETS_GIT_CUSTOM_BRANCH']
+    end
+
+    def git_sha
+      ENV['JETS_GIT_CUSTOM_SHA']
+    end
+
+    def git_url
+      ENV['JETS_GIT_CUSTOM_URL']
+    end
+
+    def git_message
+      ENV['JETS_GIT_CUSTOM_MESSAGE']
+    end
+  end
+end

data/lib/jets/git/git_cli.rb

@@ -0,0 +1,28 @@
+module Jets::Git
+  module GitCli
+    def git?
+      git_folder? && git_installed?
+    end
+
+    def git_folder?
+      File.exist?(".git")
+    end
+
+    def git_installed?
+      system "type git > /dev/null 2>&1"
+    end
+
+    def git(args, on_error: :nil)
+      out = `git #{args}`.strip
+      unless $?.success?
+        case on_error
+        when :raise
+          raise Jets::Git::Error, "ERROR: git #{args} failed".color(:red)
+        when :nil
+          return
+        end
+      end
+      out
+    end
+  end
+end

data/lib/jets/git/github.rb

@@ -0,0 +1,48 @@
+module Jets::Git
+  class Github
+    def params
+      params = {
+        git_system: 'github',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        # git_message: nil,
+        # git_version: nil,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      if build_type == "pull_request"
+        pr.dig('pull_request','head','ref')
+      else # push
+        ENV['GITHUB_REF_NAME']
+      end
+    end
+
+    def git_sha
+      if build_type == "pull_request"
+        pr.dig('pull_request','head','sha')
+      else # push
+        ENV['GITHUB_SHA']
+      end
+    end
+
+    def git_url
+      host = ENV['GITHUB_SERVER_URL'] || 'https://github.com'
+      full_repo = ENV['GITHUB_REPOSITORY']
+      "#{host}/#{full_repo}"
+    end
+
+    # GitHub webhook JSON payload in file and path is set in GITHUB_EVENT_PATH
+    def pr
+      return {} unless ENV['GITHUB_EVENT_PATH']
+      JSON.load(IO.read(ENV['GITHUB_EVENT_PATH']))
+    end
+
+    def build_type
+      ENV['GITHUB_EVENT_NAME']
+    end
+  end
+end

data/lib/jets/git/gitlab.rb

@@ -0,0 +1,30 @@
+module Jets::Git
+  class Gitlab
+    def params
+      params = {
+        git_system: 'gitlab',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: false,
+        # git_message: nil,
+        # git_version: nil,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_branch
+      ENV['CI_COMMIT_REF_NAME']
+    end
+
+    def git_sha
+      ENV['CI_COMMIT_SHA']
+    end
+
+    def git_url
+      host = ENV['CI_SERVER_URL'] || 'https://gitlab.com'
+      full_repo = ENV['CI_PROJECT_PATH']
+      "#{host}/#{full_repo}"
+    end
+  end
+end

data/lib/jets/git/info.rb

@@ -0,0 +1,37 @@
+module Jets::Git
+  class Info
+    extend Memoist
+    # Not using options but trying to future proof initialize
+    def initialize(options={})
+      @options = options
+    end
+
+    def user
+      User.new
+    end
+    memoize :user
+
+    # Best effort to get git info
+    def params
+      return {} if ENV['JETS_GIT_DISABLED']
+      strategy_class.new.params
+    end
+
+    def strategy_class
+      env_map = {
+        BITBUCKET_COMMIT: Bitbucket,
+        CIRCLECI: Circleci,
+        CODEBUILD_CI: Codebuild,
+        GITHUB_ACTIONS: Github,
+        GITLAB_CI: Gitlab,
+        JETS_GIT_CUSTOM: Custom,
+        SYSTEM_TEAMFOUNDATIONSERVERURI: Azure,
+      }
+      found = env_map.find do |env_key, strategy_class|
+        ENV[env_key.to_s]
+      end
+      found ? found[1] : Local
+    end
+    memoize :strategy_class
+  end
+end

data/lib/jets/git/local.rb

@@ -0,0 +1,55 @@
+module Jets::Git
+  class Local
+    include GitCli
+    extend Memoist
+
+    def params
+      return {} unless git? && git_branch
+      params = {
+        git_system: 'local',
+        git_branch: git_branch,
+        git_sha: git_sha,
+        git_dirty: git_dirty?,
+        git_message: git_message,
+        git_version: git_version,
+      }
+      params[:git_url] = git_url if git_url
+      params
+    end
+
+    def git_message
+      git "log -1 --pretty=%B"
+    end
+
+    def git_branch
+      git "rev-parse --abbrev-ref HEAD"
+    end
+
+    def git_sha
+      git "rev-parse HEAD"
+    end
+
+    def git_url
+      # IE: git "config --get remote.origin.url"
+      git "config --get remote.#{git_remote}.url"
+    end
+
+    def git_dirty?
+      !git("status --porcelain").empty?
+    end
+
+    def git_version
+      git "--version", on_error: :raise
+    end
+
+    # discover git remote name. in case it's not origin
+    def git_remote
+      # 2>&1 to suppress error message
+      #   "fatal: not a git repository (or any parent up to mount point /path)\nStopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).\n"
+      `git remote 2>&1`
+      return unless $?.success?
+      `git remote`.strip # IE: origin or blank string
+    end
+    memoize :git_remote
+  end
+end

data/lib/jets/git/user.rb

@@ -0,0 +1,30 @@
+module Jets::Git
+  class User
+    extend Memoist
+    include GitCli
+
+    def first_name
+      name.split(" ").first
+    end
+
+    def name
+      git_config["user.name"]
+    end
+
+    def email
+      git_config["user.email"]
+    end
+
+    def git_config
+      return {} if ENV['JETS_GIT_DISABLED']
+      return {} unless git?
+      list = git("config --list")
+      lines = list.split("\n")
+      # Other values in the git config are not needed.
+      # And can cause .to_h to bomb and throw an error.
+      lines.select! { |l| l =~ /^user\./ }
+      lines.map { |l| l.split("=") }.to_h
+    end
+    memoize :git_config
+  end
+end

data/lib/jets/git/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jets
+  module Git
+    VERSION = "0.2.0"
+  end
+end

data/lib/jets/git.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "json"
+require "memoist"
+
+require_relative "git/autoloader"
+Jets::Git::Autoloader.setup
+
+module Jets
+  module Git
+    class Error < StandardError; end
+  end
+end

data/lib/jets-git.rb

@@ -0,0 +1 @@
+require_relative "jets/git"

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: jets-git
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gathers git information for Jets.
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/jets-git.rb
+- lib/jets/git.rb
+- lib/jets/git/autoloader.rb
+- lib/jets/git/azure.rb
+- lib/jets/git/bitbucket.rb
+- lib/jets/git/circleci.rb
+- lib/jets/git/codebuild.rb
+- lib/jets/git/custom.rb
+- lib/jets/git/git_cli.rb
+- lib/jets/git/github.rb
+- lib/jets/git/gitlab.rb
+- lib/jets/git/info.rb
+- lib/jets/git/local.rb
+- lib/jets/git/user.rb
+- lib/jets/git/version.rb
+homepage: https://github.com/rubyonjets/jets-git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rubyonjets/jets-git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key: 
+specification_version: 4
+summary: Jets Git Library
+test_files: []