github-username-regex-ruby 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ecaa641e240d055c758ab25a733d6960a3c9e5fe789dc25dbdc91509a5bf78c0
+  data.tar.gz: 4059af471d1cc7c0be0bef27a0aa9e5107b0241b09fda5e77ab1c909b1e09a5f
+SHA512:
+  metadata.gz: 7c616a04a2ee6dc2deae653c678be4526d8368ffe59d24a7f2ad92f16acbbd55238f1230a80ec8b51118fac01fa420fb5fc18d269572f5e3e9213b8068e83f29
+  data.tar.gz: 1c8b655fe43fa96aafe1fe10f90b569321625599fb96cdbaea7085fd12fe92668c727fb9653ea872f536c8d969140c29575ee2b4cd9217bab97064b2bb13ee83

data/.github/workflows/build.yml

@@ -0,0 +1,41 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+        with:
+          bundler-cache: true
+
+      - name: bootstrap
+        run: script/bootstrap
+
+      - name: build
+        run: |
+          GEM_NAME=$(ls | grep gemspec | cut -d. -f1)
+          echo "Attempting to build gem $GEM_NAME..."
+          gem build $GEM_NAME
+          if [ $? -eq 0 ]; then
+            echo "Gem built successfully!"
+          else
+            echo "Gem build failed!"
+            exit 1
+          fi

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,36 @@
+name: CodeQL
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+        with:
+          bundler-cache: true
+
+      - name: lint
+        run: bundle exec rubocop -c .rubocop.yml lib/ spec/

data/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: release
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - lib/version.rb
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+        with:
+          bundler-cache: true
+
+      - name: bootstrap
+        run: script/bootstrap
+
+      - name: lint
+        run: bundle exec rubocop -c .rubocop.yml lib/ spec/
+
+      - name: test
+        run: script/test
+
+      - name: set GEM_NAME from gemspec
+        run: echo "GEM_NAME=$(ls | grep gemspec | cut -d. -f1)" >> $GITHUB_ENV
+        # builds the gem and saves the version to GITHUB_ENV
+      - name: build
+        run: echo "GEM_VERSION=$(gem build ${{ env.GEM_NAME }}.gemspec 2>&1 | grep Version | cut -d':' -f 2 | tr -d " \t\n\r")" >> $GITHUB_ENV
+
+      - name: publish to GitHub packages
+        run: |
+          export OWNER=$( echo ${{ github.repository }} | cut -d "/" -f 1 )
+          GEM_HOST_API_KEY=${{ secrets.GITHUB_TOKEN }} gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} ${{ env.GEM_NAME }}-${{ env.GEM_VERSION }}.gem
+
+      - name: release
+        uses: ncipollo/release-action@a2e71bdd4e7dab70ca26a852f29600c98b33153e # pin@v1.12.0
+        with:
+          artifacts: "${{ env.GEM_NAME }}-${{ env.GEM_VERSION }}.gem"
+          tag: "v${{ env.GEM_VERSION }}"
+          generateReleaseNotes: true
+
+      - name: publish to RubyGems
+        run: |
+          mkdir -p ~/.gem
+          echo -e "---\n:rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}" > ~/.gem/credentials
+          chmod 0600 ~/.gem/credentials
+          gem push ${{ env.GEM_NAME }}-${{ env.GEM_VERSION }}.gem
+          rm ~/.gem/credentials

data/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+
+      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+        with:
+          bundler-cache: true
+
+      - name: bootstrap
+        run: script/bootstrap
+
+      - name: test
+        run: script/test -k

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+bin
+coverage
+tmp/
+vendor/gems

data/.rubocop.yml

@@ -0,0 +1,16 @@
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  DisplayCopNames: true
+  TargetRubyVersion: 3.2
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+    - ".github/**/*"
+
+Style/HashSyntax:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 3.12"
+  gem "rubocop", "~> 1.48"
+  gem "rubocop-github", "~> 0.20"
+  gem "rubocop-performance", "~> 1.16"
+  gem "rubocop-rspec", "~> 2.22"
+  gem "simplecov", "~> 0.22"
+  gem "simplecov-erb", "~> 1.0"
+end

data/Gemfile.lock

@@ -0,0 +1,103 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rack (3.0.8)
+    rainbow (3.1.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.53.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-github (0.20.0)
+      rubocop (>= 1.37)
+      rubocop-performance (>= 1.15)
+      rubocop-rails (>= 2.17)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.20.2)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-erb (1.0.1)
+      simplecov (< 1.0)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  rspec (~> 3.12)
+  rubocop (~> 1.48)
+  rubocop-github (~> 0.20)
+  rubocop-performance (~> 1.16)
+  rubocop-rspec (~> 2.22)
+  simplecov (~> 0.22)
+  simplecov-erb (~> 1.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Grant Birkinbine
+
+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,5 @@
+# github-username-regex-ruby
+
+[![test](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/test.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/test.yml) [![lint](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/lint.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/lint.yml) [![build](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/build.yml) [![release](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/release.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/release.yml) [![CodeQL](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/GrantBirki/github-username-regex-ruby/actions/workflows/codeql-analysis.yml)
+
+A lightweight Ruby Gem to check if a GitHub username / handle is valid

data/github-username-regex-ruby.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "github-username-regex-ruby"
+  spec.version       = GitHubUsernameRegex::Version::VERSION
+  spec.authors       = ["Grant Birkinbine"]
+  spec.email         = "grant.birkinbine@gmail.com"
+  spec.license       = "MIT"
+
+  spec.summary       = "A lightweight Ruby Gem to check if a GitHub username / handle is valid"
+  spec.description   = <<~SPEC_DESC
+    A lightweight Ruby Gem to check if a GitHub username / handle is valid using regex
+  SPEC_DESC
+
+  spec.homepage = "https://github.com/grantbirki/github-username-regex-ruby"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/lib/github_username_regex_ruby.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module GitHubUsernameRegex
+
+  # check if a GitHub username is valid
+  # :param username: the username to check (String)
+  # :return: true if the username is valid, false if it is invalid (Boolean)
+  def self.check(username)
+    # if the username is valid, return true
+    if username.match(/^[a-z\d](?:[a-z\d]|-(?=[a-z\d])){0,38}$/i)
+      return true
+    # if the username is invalid, return false
+    else
+      return false
+    end
+  # if an error occurs, return false
+  rescue StandardError => _e
+    return false
+  end
+end

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GitHubUsernameRegex
+  module Version
+    VERSION = "0.0.5"
+  end
+end

data/script/bootstrap

@@ -0,0 +1,32 @@
+#! /usr/bin/env bash
+
+# COLORS
+OFF='\033[0m'
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+
+set -e # Prevent any kind of script failures
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )"
+[ -z "$RBENV_VERSION" ] && export RBENV_VERSION=$(cat "$DIR/.ruby-version")
+[ -z "$APP_ENV" ] && export APP_ENV="development"
+[ -d "/usr/share/rbenv/shims" ] && export PATH=/usr/share/rbenv/shims:$PATH
+
+TRASHDIR=$(mktemp -d /tmp/bootstrap.XXXXXXXXXXXXXXXXX)
+cleanup() {
+  rm -rf "$TRASHDIR"
+  # Remove empty directory
+  rmdir "$DIR/vendor/cache" 2>/dev/null || true
+}
+trap cleanup EXIT
+
+# Bootstrap gem dependencies.
+echo -e "💎 ${BLUE}Installing Gems...${OFF}"
+if [ "$APP_ENV" == "production" ]; then
+  bundle install --path vendor/gems --local --without development
+  bundle binstubs --all
+else
+  bundle install --path vendor/gems --local --with development
+  bundle binstubs --all
+fi

data/script/test

@@ -0,0 +1,90 @@
+#! /usr/bin/env bash
+
+# run script/test -h for help
+
+# COLORS
+OFF='\033[0m'
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+
+set -e
+
+function usage()
+{
+    echo -e "\t ================== script/test usage =================="
+    echo -e "\t-h --help               : displays help message"
+    echo -e "\t-k --no-linter          : disables linting tests"
+    echo -e "\n\t Suggested flags for development: script/test"
+}
+
+while [ "$1" != "" ]; do
+    PARAM=`echo $1 | awk -F= '{print $1}'`
+    VALUE=`echo $1 | awk -F= '{print $2}'`
+    case $PARAM in
+      -h | --help)
+        usage
+        exit
+        ;;
+      -k | --no-linter)
+        no_linter=1
+        ;;
+      *)
+      echo "ERROR: unknown parameter \"$PARAM\""
+      usage
+      exit 1
+      ;;
+    esac
+    shift
+done
+
+# setup
+export DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )"
+[ -z "$RBENV_VERSION" ] && export RBENV_VERSION=$(cat "$DIR/.ruby-version")
+
+# Run Rubocop
+if [[ -z $no_linter ]]; then
+  echo -e "\n🤖 ${BLUE}Running Rubocop: $(date "+%H:%M:%S")${OFF}\n"
+  bundle exec bin/rubocop
+else
+  echo -e "\n⏩ ${BLUE}Skipping Rubocop${OFF}"
+fi
+
+# run tests
+echo -e "\n🧪 ${BLUE}Running tests: $(date "+%H:%M:%S")${OFF}\n"
+cd "$(dirname $0)/.."
+
+bundle exec bin/rspec spec && rspec_exit=$? || rspec_exit=$?
+
+total_coverage=$(cat "$DIR/coverage/total-coverage.txt")
+
+if grep -q "100.0" "$DIR/coverage/total-coverage.txt"; then
+  cov_exit=0
+  echo -e "\n✅ Total Coverage: ${GREEN}$total_coverage${OFF}"
+else
+  cov_exit=1
+  echo -e "\n❌ Total Coverage: ${RED}$total_coverage${OFF}"
+fi
+
+echo ""
+echo "---------------------------------------"
+echo "📊 Summary Results"
+echo "---------------------------------------"
+echo ""
+
+if [[ $rspec_exit == 0 ]]; then
+  echo -e "✅ ${GREEN}rspec:    exitcode=${rspec_exit}${OFF}"
+else
+  echo -e "❌ ${RED}rspec:    exitcode=${rspec_exit}${OFF}"
+fi
+
+if [[ $cov_exit == 0 ]]; then
+  echo -e "✅ \033[0;32mcoverage: exitcode=${cov_exit}\033[0m"
+else
+  echo -e "❌ \033[0;31mcoverage: exitcode=${cov_exit}\033[0m"
+fi
+
+[ $rspec_exit -gt 0 ] && exit 1
+[ $cov_exit -gt 0 ] && exit 1
+
+exit 0

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: github-username-regex-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Grant Birkinbine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-25 00:00:00.000000000 Z
+dependencies: []
+description: 'A lightweight Ruby Gem to check if a GitHub username / handle is valid
+  using regex
+
+  '
+email: grant.birkinbine@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/build.yml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/lint.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- github-username-regex-ruby.gemspec
+- lib/github_username_regex_ruby.rb
+- lib/version.rb
+- script/bootstrap
+- script/test
+- vendor/cache/activesupport-7.0.5.gem
+- vendor/cache/ast-2.4.2.gem
+- vendor/cache/concurrent-ruby-1.2.2.gem
+- vendor/cache/diff-lcs-1.5.0.gem
+- vendor/cache/docile-1.4.0.gem
+- vendor/cache/i18n-1.14.1.gem
+- vendor/cache/json-2.6.3.gem
+- vendor/cache/language_server-protocol-3.17.0.3.gem
+- vendor/cache/minitest-5.18.1.gem
+- vendor/cache/parallel-1.23.0.gem
+- vendor/cache/parser-3.2.2.3.gem
+- vendor/cache/racc-1.7.1.gem
+- vendor/cache/rack-3.0.8.gem
+- vendor/cache/rainbow-3.1.1.gem
+- vendor/cache/regexp_parser-2.8.1.gem
+- vendor/cache/rexml-3.2.5.gem
+- vendor/cache/rspec-3.12.0.gem
+- vendor/cache/rspec-core-3.12.2.gem
+- vendor/cache/rspec-expectations-3.12.3.gem
+- vendor/cache/rspec-mocks-3.12.5.gem
+- vendor/cache/rspec-support-3.12.0.gem
+- vendor/cache/rubocop-1.53.0.gem
+- vendor/cache/rubocop-ast-1.29.0.gem
+- vendor/cache/rubocop-capybara-2.18.0.gem
+- vendor/cache/rubocop-factory_bot-2.23.1.gem
+- vendor/cache/rubocop-github-0.20.0.gem
+- vendor/cache/rubocop-performance-1.18.0.gem
+- vendor/cache/rubocop-rails-2.20.2.gem
+- vendor/cache/rubocop-rspec-2.22.0.gem
+- vendor/cache/ruby-progressbar-1.13.0.gem
+- vendor/cache/simplecov-0.22.0.gem
+- vendor/cache/simplecov-erb-1.0.1.gem
+- vendor/cache/simplecov-html-0.12.3.gem
+- vendor/cache/simplecov_json_formatter-0.1.4.gem
+- vendor/cache/tzinfo-2.0.6.gem
+- vendor/cache/unicode-display_width-2.4.2.gem
+homepage: https://github.com/grantbirki/github-username-regex-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: A lightweight Ruby Gem to check if a GitHub username / handle is valid
+test_files: []