railbar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 632ac5aca394d7c9addafb8836fdccc465f20e813535c7d36ed9a4e94848b4fe
+  data.tar.gz: f323837e55c0ed0a9ce3f07752385a7de45bbb8c58f67933a2074cdb1f5a8090
+SHA512:
+  metadata.gz: b5989fd1cb1d436ca320a6847c477cf171795a0f80c5bdd845ca25783ebded55b8c7723210ea7f95f728500a23f37a280746be2fca73d5a0d805d9d944b5c5e8
+  data.tar.gz: f11b9897fcc8d29743ce08d0dca2298771961658a519b13364091ef459a61097bc3827f55f102cc3d040c14fc776246a18df96a16d5a78799b3dad6a80765d98

data/README.md

@@ -0,0 +1,29 @@
+# Railbar
+
+in the past it happend quite often to me that I confused any staging/test or even production system with my local development system because they look usually pretty the same. Luckily not a lot of harm done except for some lost time and confusion so far. 
+That's why I came up with the idea of **Railbar** for Ruby on Rails, a HTML rendered bar that makes it obvious which system you are currently working on. And when creating such a bar, why not adding some status checks like for Turbo or Stimulus with it?
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'railbar'
+```
+
+Optionally only in your development group.
+
+```bash
+$ bundle install
+```
+
+finally add the bar to your layout file, e.g. `app/views/layouts/application.html.erb`
+
+```erb
+...
+<%= railbar %>
+```
+
+## Configuration
+
+coming ...

data/app/controllers/railbar/turbo_frame_status_controller.rb

@@ -0,0 +1,7 @@
+module Railbar
+  class TurboFrameStatusController < TurboStatusBaseController
+    def show
+      render partial: "railbar/turbo_frame_status_ok"
+    end
+  end
+end

data/app/controllers/railbar/turbo_status_base_controller.rb

@@ -0,0 +1,16 @@
+module Railbar
+  class TurboStatusBaseController < ActionController::Base
+    before_action :turbo_only!
+
+    private
+    def turbo_only!
+      unless turbo_frame_request? || turbo_stream_request?
+        raise ActionController::RoutingError, "This endpoint is only accessible via Turbo"
+      end
+    end
+
+    def turbo_stream_request?
+      request.format.turbo_stream?
+    end
+  end
+end

data/app/controllers/railbar/turbo_stream_form_status_controller.rb

@@ -0,0 +1,8 @@
+module Railbar
+  class TurboStreamFormStatusController < TurboStatusBaseController
+    skip_before_action :verify_authenticity_token
+    def update
+      render turbo_stream: turbo_stream.replace("railbar-turbo-stream-post-status", partial: "railbar/turbo_stream_form_status_ok")
+    end
+  end
+end

data/app/helpers/railbar/application_helper.rb

@@ -0,0 +1,11 @@
+module Railbar::ApplicationHelper
+  def railbar
+    rails_env = Rails.env
+    rails_version = Rails.version
+    rails_host = request.host
+    locals = { rails_env: rails_env,
+               rails_host: rails_host,
+               rails_version: rails_version }
+    render partial: "railbar/railbar", locals: locals
+  end
+end

data/app/views/railbar/_js_status.html.erb

@@ -0,0 +1,10 @@
+<script>
+  var items = document.querySelectorAll('railbar item');
+
+  items.forEach((item) => {
+    if (item.textContent.trim() === 'JS') {
+      item.className = 'ok';
+    }
+  });
+
+</script>

data/app/views/railbar/_railbar.html.erb

@@ -0,0 +1,22 @@
+<railbar>
+  <brand>🛤️ <a href="https://github.com/mtnstar/railbar" target="_blank">Railbar</a></brand>
+  <item class="primary"><%= rails_host %></item>
+  <item class="primary"><span class="railbar-rails-env"><%= rails_env %></item>
+  <item>Rails <%= rails_version %></item>
+  <item>Ruby <%= RUBY_VERSION %></item>
+  <item class="nok">JS</item>
+  <%= turbo_frame_tag "railbar-turbo-frame-status", src: "/railbar/turbo_frame_status" do %>
+    <item class="nok">Turbo Frames</item>
+  <% end %>
+  <item class="primary">Turbo Streams:</item>
+  <item id="railbar-turbo-stream-post-status" class="nok">Form (POST)</item>
+  <%= form_with url: "/railbar/turbo_stream_form_status" do |form| %>
+    <%= form.submit "", style: "display: none;", id: "railbar-turbo-stream-post-status-submit" %>
+  <% end %>
+
+  <%# <item class="nok">Stimulus</item> %>
+  <%= render "railbar/styling" %>
+  <%= render "railbar/js_status" %>
+  <%= render "railbar/turbo_stream_load_js" %>
+  <%#<%= render "railbar/stimulus_status" %>
+</railbar>

data/app/views/railbar/_stimulus_status.html.erb

@@ -0,0 +1,29 @@
+<script>
+  document.addEventListener("DOMContentLoaded", function () {
+    let retryCount = 0;
+    const maxRetries = 20;
+    const checkStimulus = setInterval(function () {
+      if (typeof Stimulus !== "undefined") {
+        console.log("Stimulus is loaded and available!");
+        clearInterval(checkStimulus);
+        const application = Stimulus.start();
+        console.log("Stimulus application started.");
+
+        application.register("railbar_stimulus_status", class extends Stimulus.Controller {
+          connect() {
+            const items = this.element.querySelectorAll("railbar item");
+            items.forEach((item) => {
+              if (item.textContent.trim() === "Stimulus") {
+                item.className = "ok";
+              }
+            });
+          }
+        });
+      } else if (retryCount >= maxRetries) {
+        console.error("Stimulus could not be loaded after multiple attempts.");
+        clearInterval(checkStimulus); // Stop checking
+      }
+      retryCount++;
+    }, 100); // Check every 100ms
+  });
+</script>

data/app/views/railbar/_styling.html.erb

@@ -0,0 +1,47 @@
+<style>
+  railbar {
+    padding: 10px;
+    width: 100%;
+    font-size: 14px;
+    font-family: Arial, sans-serif;
+    border-bottom: 0.75px solid grey;
+    display: block;
+  }
+
+  railbar brand a {
+    font-weight: bold;
+    text-decoration: none;
+    color: #212529;
+  }
+
+  .railbar-rails-env {
+    text-transform: uppercase;
+  }
+
+  railbar item {
+    background-color: #f8f9fa;
+    display: inline-block;
+    padding: .35em .65em;
+    font-weight: 700;
+    color: #212529;
+    text-align: center;
+    white-space: nowrap;
+    vertical-align: baseline;
+    border-radius: .25rem;
+  }
+
+  railbar item.primary {
+    background-color: #6c757d;
+    color: #fff;
+  }
+
+  railbar item.nok {
+    background-color: #dc3545;
+    color: #fff;
+  }
+
+  railbar item.ok {
+    background-color: #28a745;
+    color: #fff;
+  }
+</style>

data/app/views/railbar/_turbo_frame_status_ok.html.erb

@@ -0,0 +1,3 @@
+<%= turbo_frame_tag "railbar-turbo-frame-status" do %>
+  <item class="ok">Turbo Frames</item>
+<% end %>

data/app/views/railbar/_turbo_stream_form_status_ok.html.erb

@@ -0,0 +1 @@
+<item id="railbar-turbo-stream-form-status" class="ok">Form (POST)</item>

data/app/views/railbar/_turbo_stream_load_js.html.erb

@@ -0,0 +1,24 @@
+<script>
+  if (!window.RailbarTurboStreamStatus) {
+    const RailbarTurboStreamStatus = (() => {
+      function submitTurboStreamStatusForm() {
+        document.getElementById("railbar-turbo-stream-post-status-submit").click();
+      }
+
+      function init() {
+        submitTurboStreamStatusForm();
+        document.addEventListener("turbo:load", () => {
+          submitTurboStreamStatusForm();
+        })
+      }
+
+      return {
+        init
+      };
+    })();
+
+    window.addEventListener("load", RailbarTurboStreamStatus.init);
+  }
+
+</script>
+

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  namespace "railbar" do
+    get "turbo_frame_status", to: "turbo_frame_status#show"
+    post "turbo_stream_form_status", to: "turbo_stream_form_status#update"
+  end
+end

data/lib/railbar/engine.rb

@@ -0,0 +1,11 @@
+module Railbar
+  class Engine < ::Rails::Engine
+    isolate_namespace Railbar
+
+    initializer "railbar.helpers" do
+      ActiveSupport.on_load(:action_controller) do
+        helper Railbar::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/railbar/version.rb

@@ -0,0 +1,3 @@
+module Railbar
+  VERSION = "0.1.0"
+end

data/lib/railbar.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "railbar/version"
+require "railbar/engine"
+
+module Railbar
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: railbar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mountain Star
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-06 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'
+description: A status bar for development and testing rails environments to distinguish
+  between development, staging, and production environments and show status of turbo/hotwire
+email:
+- github@mtnstar.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- app/controllers/railbar/turbo_frame_status_controller.rb
+- app/controllers/railbar/turbo_status_base_controller.rb
+- app/controllers/railbar/turbo_stream_form_status_controller.rb
+- app/helpers/railbar/application_helper.rb
+- app/views/railbar/_js_status.html.erb
+- app/views/railbar/_railbar.html.erb
+- app/views/railbar/_stimulus_status.html.erb
+- app/views/railbar/_styling.html.erb
+- app/views/railbar/_turbo_frame_status_ok.html.erb
+- app/views/railbar/_turbo_stream_form_status_ok.html.erb
+- app/views/railbar/_turbo_stream_load_js.html.erb
+- config/routes.rb
+- lib/railbar.rb
+- lib/railbar/engine.rb
+- lib/railbar/version.rb
+homepage: https://github.com/mtnstar/railbar
+licenses: []
+metadata:
+  homepage_uri: https://github.com/mtnstar/railbar
+  source_code_uri: https://github.com/mtnstar/railbar
+  changelog_uri: https://github.com/mtnstar/railbar/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A status bar for Rails development.
+test_files: []