shalala 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ca88e78836e4744c0c07f92c5dce712b346f3667d892ecd3dbf9764d4cff1ec
+  data.tar.gz: 97957e540122129c3e200f840b5eb269b4577d58daec08a540d584a1568191bc
+SHA512:
+  metadata.gz: af34805ae8b66e2183dcc8f582950fda18ba1fc96e318d4f0e2d2094ff19f0522ad40846ec742e07a72cfbf1a0c4d7d8d804507a0a2b1d42e3fb8b48dfe4c28b
+  data.tar.gz: e67655ec1ac7627196ff8fbea71881db4ce8e2cd5a1646e6cb9eb9c99bd77992d0423468e2fa3cf2e691cc390dd83fd6dbd9f88b50ab059c5fdde66fb77e1b41

data/README.md

@@ -0,0 +1,67 @@
+# Shalala
+
+Shalala is a Rails engine that exposes the current git commit SHA and branch name at `/commit`.
+
+## What it does
+
+When you request `GET /commit`:
+
+- If `GIT_COMMIT` is set, it returns that value.
+- If `GIT_BRANCH` is set, it returns that value for the branch.
+- If `GIT_COMMIT` is not set and the Rails environment is development, it runs `git rev-parse HEAD` and returns the current SHA.
+- If `GIT_BRANCH` is not set, it derives the branch from git (`git branch --show-current`, with `git rev-parse --abbrev-ref HEAD` as fallback).
+- If `GIT_COMMIT` is not set and the environment is not development, it returns `404 Not Found`.
+
+This is useful for surfacing deployment version information in environments like staging and production.
+
+## Installation
+
+Add this line to your application Gemfile:
+
+```ruby
+gem "shalala"
+```
+
+Then install:
+
+```sh
+bundle install
+```
+
+## Mounting
+
+The engine mounts itself at `/commit` via an initializer, so no manual route declaration is required.
+
+## Usage examples
+
+Set the commit explicitly (recommended for CI/CD and production):
+
+```sh
+export GIT_COMMIT=$(git rev-parse HEAD)
+export GIT_BRANCH=$(git branch --show-current)
+```
+
+Then request:
+
+```sh
+curl http://localhost:3000/commit
+```
+
+Example response:
+
+```text
+commit: f2e9b8d4a3c11f2f9c2fd6f5b76f6f3cf1a1d9e2
+branch: main
+```
+
+## Testing
+
+Run the test suite with:
+
+```sh
+bundle exec rspec
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/shalala/commits_controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Shalala
+  class CommitsController < ActionController::Base
+    def show
+      commit = resolved_commit
+      branch = resolved_branch
+
+      if commit.present?
+        render plain: "commit: #{commit}\nbranch: #{branch}"
+      else
+        head :not_found
+      end
+    end
+
+    private
+
+    def resolved_commit
+      env_commit = ENV["GIT_COMMIT"]
+      return env_commit if env_commit.present?
+      return current_git_commit if development_environment?
+
+      nil
+    end
+
+    def resolved_branch
+      env_branch = ENV["GIT_BRANCH"]
+      return env_branch if env_branch.present?
+
+      current_git_branch
+    end
+
+    def development_environment?
+      Rails.env.development?
+    end
+
+    def current_git_commit
+      Dir.chdir(Rails.root) do
+        sha = `git rev-parse HEAD`.strip
+        $?.success? ? sha : nil
+      end
+    rescue StandardError
+      nil
+    end
+
+    def current_git_branch
+      Dir.chdir(Rails.root) do
+        branch = `git branch --show-current`.strip
+        return branch if $?.success? && branch.present?
+
+        fallback_branch = `git rev-parse --abbrev-ref HEAD`.strip
+        $?.success? ? fallback_branch : nil
+      end
+    rescue StandardError
+      nil
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Shalala::Engine.routes.draw do
+  root to: "commits#show"
+end

data/lib/shalala/engine.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Shalala
+  class Engine < ::Rails::Engine
+    isolate_namespace Shalala
+
+    initializer "shalala.mount_route" do |app|
+      app.config.to_prepare do
+        next if app.routes.named_routes.key?(:shalala)
+
+        app.routes.append do
+          mount Shalala::Engine, at: "/commit", as: :shalala
+        end
+      end
+    end
+  end
+end

data/lib/shalala/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Shalala
+  VERSION = "1.0.0"
+end

data/lib/shalala.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "rails"
+require "shalala/engine"
+
+module Shalala
+end

data/shalala.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'shalala/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "shalala"
+  spec.version = Shalala::VERSION
+  spec.authors = ["Ryan Bigg"]
+  spec.email = ["ryan@example.com"]
+
+  spec.summary = "Rails engine exposing current git commit"
+  spec.description = "Mounts /commit and returns a git commit SHA based on environment rules."
+  spec.homepage = "https://github.com/radar/shalala"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.files = Dir[
+    "app/**/*",
+    "config/**/*",
+    "lib/**/*",
+    "*.md",
+    "*.gemspec",
+    "Rakefile"
+  ]
+
+  spec.add_dependency "rails", ">= 7.0"
+
+  spec.add_development_dependency "rspec-rails", ">= 6.0"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: shalala
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Bigg
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Mounts /commit and returns a git commit SHA based on environment rules.
+email:
+- ryan@example.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- app/controllers/shalala/commits_controller.rb
+- config/routes.rb
+- lib/shalala.rb
+- lib/shalala/engine.rb
+- lib/shalala/version.rb
+- shalala.gemspec
+homepage: https://github.com/radar/shalala
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Rails engine exposing current git commit
+test_files: []