caution_tape 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d9f212339a683ae0d697706a666604f581590b7fb3521f29b2cbe9beb5a8573
+  data.tar.gz: 589c44ac2afc6f469a2adadd2fcc277f1a8806003ea0a67f4236a0778470fe21
+SHA512:
+  metadata.gz: 9c533b126330f28dc8094032802ce57dc65ae73476acc62e7d2a32c9deceed5ef78d09a1de2e476a9d740d47c50cee0564aa6a33af020f59bb3ac952f11fe317
+  data.tar.gz: b669a924ed43453ed0d04dc25625e82646c3c6ce97f7d5c6344f6886dd1c8c67aee22bc6e0d18bd523394c68f9d6a994060317c8e47973c4a2b6eb6ad6f2a547

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-07-15
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"caution_tape" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["me@jaspermayone.com"](mailto:"me@jaspermayone.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Jasper Mayone
+
+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,82 @@
+# caution_tape 🚧
+
+Visual environment indicators for Rack and Rails apps. Wraps non-production
+environments in unmistakable chrome — a striped construction frame and warning
+banner for staging/sandbox, a solid colored frame for development — so nobody
+ever mistakes a test environment for production (or puts production data in a
+sandbox).
+
+- Zero assets, zero JavaScript — a Rack middleware injects a small inline
+  `<style>` + two `<div>`s before `</body>` on HTML responses.
+- Click-through (`pointer-events: none`) — never blocks the UI.
+- Off by default — production is safe unless you explicitly enable it.
+
+## Installation
+
+```bash
+bundle add caution_tape
+```
+
+## Usage (Rails)
+
+The Railtie installs the middleware automatically. Enable and style it per
+environment:
+
+```ruby
+# config/environments/development.rb
+CautionTape.configure do |c|
+  c.enabled = true
+  c.style   = :solid
+  c.color   = "#dc2626"
+  c.tag     = "Dev"
+end
+```
+
+```ruby
+# config/environments/production.rb — same image serves prod and sandbox
+CautionTape.configure do |c|
+  c.enabled = ENV.fetch("BASE_URL", "").include?("sandbox")
+  c.style   = :stripes
+  c.banner  = "Sandbox — test environment. Do not enter real data."
+end
+```
+
+## Usage (plain Rack)
+
+```ruby
+CautionTape.configure do |c|
+  c.enabled = true
+  c.banner  = "Staging"
+end
+
+use CautionTape::Middleware
+run MyApp
+```
+
+## Configuration
+
+| Option | Default | Notes |
+|---|---|---|
+| `enabled` | `false` | Nothing renders unless enabled |
+| `style` | `:stripes` | `:stripes` (caution stripes) or `:solid` |
+| `color` | `"#f5c518"` | Accent color; stripes pair it with near-black |
+| `banner` | `nil` | Warning pill pinned top-center |
+| `tag` | `nil` | Small label pill, shown when no banner is set |
+| `border_width` | `10` | Frame thickness in px |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/singlefeather/caution_tape. Contributors are expected to
+adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/caution_tape/configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module CautionTape
+  # Runtime configuration for the injected chrome.
+  class Configuration
+    STYLES = %i[stripes solid].freeze
+
+    # Whether any chrome is rendered at all. Defaults to off so production
+    # is safe by default — enable explicitly per environment.
+    attr_accessor :enabled
+
+    # :stripes — diagonal caution stripes (accent color + black).
+    # :solid   — a plain frame in the accent color.
+    attr_reader :style
+
+    # Accent color. Stripes pair it with near-black; solid uses it alone.
+    attr_accessor :color
+
+    # Full-width warning pill pinned top-center, e.g.
+    # "Sandbox — do not enter real data." nil renders no banner.
+    attr_accessor :banner
+
+    # Small label pill (e.g. "Dev") shown when no banner is set. nil hides it.
+    attr_accessor :tag
+
+    # Frame thickness in px.
+    attr_accessor :border_width
+
+    def initialize
+      @enabled      = false
+      @style        = :stripes
+      @color        = "#f5c518"
+      @banner       = nil
+      @tag          = nil
+      @border_width = 10
+    end
+
+    def style=(value)
+      value = value.to_sym
+      raise ArgumentError, "style must be one of #{STYLES.join(", ")}" unless STYLES.include?(value)
+
+      @style = value
+    end
+  end
+end

data/lib/caution_tape/middleware.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CautionTape
+  # Rack middleware that injects the environment chrome into HTML responses,
+  # just before </body>.
+  class Middleware
+    BODY_CLOSE = "</body>"
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, body = @app.call(env)
+      config = CautionTape.configuration
+      return [status, headers, body] unless config.enabled && html?(headers)
+
+      inject(status, headers, body, config)
+    end
+
+    private
+
+    def inject(status, headers, body, config)
+      original = read_body(body)
+      index = original.rindex(BODY_CLOSE)
+      return [status, headers, [original]] unless index
+
+      injected = original.dup
+      injected.insert(index, Renderer.html(config))
+      [status, update_content_length(headers, injected), [injected]]
+    end
+
+    def read_body(body)
+      buffer = +""
+      body.each { |chunk| buffer << chunk }
+      body.close if body.respond_to?(:close)
+      buffer
+    end
+
+    def update_content_length(headers, injected)
+      key = headers.key?("content-length") ? "content-length" : "Content-Length"
+      return headers unless headers.key?(key)
+
+      headers.merge(key => injected.bytesize.to_s)
+    end
+
+    def html?(headers)
+      content_type = headers["content-type"] || headers["Content-Type"]
+      content_type&.include?("text/html")
+    end
+  end
+end

data/lib/caution_tape/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CautionTape
+  # Auto-installs the middleware in Rails applications.
+  class Railtie < ::Rails::Railtie
+    initializer "caution_tape.middleware" do |app|
+      app.middleware.use CautionTape::Middleware
+    end
+  end
+end

data/lib/caution_tape/renderer.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module CautionTape
+  # Builds the HTML fragment (styles + frame + banner/tag) injected into pages.
+  module Renderer
+    module_function
+
+    def html(config)
+      parts = [+"<style>#{css(config)}</style>"]
+      parts << %(<div class="caution-tape-frame" aria-hidden="true"></div>)
+      if config.banner
+        parts << %(<div class="caution-tape-banner" role="status">#{escape(config.banner)}</div>)
+      elsif config.tag
+        parts << %(<div class="caution-tape-tag" aria-hidden="true">#{escape(config.tag)}</div>)
+      end
+      parts.join
+    end
+
+    def css(config)
+      [frame_css(config), pill_css(config)].join
+    end
+
+    def frame_css(config)
+      border = if config.style == :stripes
+                 "border:#{config.border_width}px solid;" \
+                 "border-image:repeating-linear-gradient(45deg,#1a1a1a 0 16px," \
+                 "#{config.color} 16px 32px) #{config.border_width};"
+               else
+                 "border:#{config.border_width}px solid #{config.color};"
+               end
+      ".caution-tape-frame{position:fixed;inset:0;pointer-events:none;z-index:2147483000;#{border}}"
+    end
+
+    def pill_css(config)
+      base = "position:fixed;top:0;left:50%;transform:translateX(-50%);z-index:2147483001;" \
+             "pointer-events:none;font:700 12px/1.4 system-ui,sans-serif;letter-spacing:.08em;" \
+             "text-transform:uppercase;padding:6px 16px;border-radius:0 0 8px 8px;"
+      banner = ".caution-tape-banner{#{base}background:#1a1a1a;color:#{config.color};" \
+               "box-shadow:0 2px 8px rgba(0,0,0,.35);}"
+      tag = ".caution-tape-tag{#{base}background:#{config.color};color:#fff;}"
+      banner + tag
+    end
+
+    def escape(text)
+      text.to_s.gsub("&", "&amp;").gsub("<", "&lt;").gsub(">", "&gt;")
+    end
+  end
+end

data/lib/caution_tape/version.rb

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

data/lib/caution_tape.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "caution_tape/version"
+require_relative "caution_tape/configuration"
+require_relative "caution_tape/renderer"
+require_relative "caution_tape/middleware"
+require_relative "caution_tape/railtie" if defined?(Rails::Railtie)
+
+# Visual environment indicators for Rack and Rails apps — a striped
+# construction frame and banner for sandboxes, a solid frame for dev.
+module CautionTape
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+      configuration
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end

data/sig/caution_tape.rbs

@@ -0,0 +1,4 @@
+module CautionTape
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: caution_tape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jasper Mayone
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Wraps non-production environments in unmistakable visual chrome — a striped
+  construction frame and warning banner for staging/sandbox, a solid colored frame
+  for development — so nobody ever mistakes a test environment for production.
+email:
+- me@jaspermayone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/caution_tape.rb
+- lib/caution_tape/configuration.rb
+- lib/caution_tape/middleware.rb
+- lib/caution_tape/railtie.rb
+- lib/caution_tape/renderer.rb
+- lib/caution_tape/version.rb
+- sig/caution_tape.rbs
+homepage: https://github.com/singlefeather/caution_tape
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/singlefeather/caution_tape
+  source_code_uri: https://github.com/singlefeather/caution_tape
+  changelog_uri: https://github.com/singlefeather/caution_tape/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Visual environment indicators for Rack and Rails apps.
+test_files: []