refs-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8561ce93112916b2afc63ffc4bc5b27ee0ff1a3c8dd7d08a4277514622c29318
+  data.tar.gz: e21a8bc89a8eca3242110babd0c5adfc24722ead44dcc7af4020e3b2e4ba36fb
+SHA512:
+  metadata.gz: 4a3efb4ced8683972ac8dc3dd0efe003d0cf686dd52da1c390fd80c4f1f6bdd1bb2baee40da4392e9848c9e6826b243618d10fe479307526787ff4daa7ec7496
+  data.tar.gz: 8914ddd01fc6b789ff9023fab2647a8a5bb82c808f95149454d3c9ac01e7135a162c87c351ce755d45254616cc048f1609d9d1e833889aaf9d39f0933674144b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-17
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 James Kerr
+
+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,90 @@
+# Refs (for Rails)
+
+A Rails gem for managing string identifiers in a centralized, type-safe way. Good for form IDs, CSS classes, data attributes, and any other string constants you want to keep organized.
+
+## Why Refs?
+
+Instead of scattering magic strings throughout your Rails application:
+
+```erb
+<!-- Scattered magic strings -->
+<form id="user-settings-form"></form>
+```
+
+```rb
+turbo_stream.replace "user-settings-form"
+```
+
+Define them once and reference them everywhere:
+
+```ruby
+# config/refs.rb
+Refs.define do
+  ref :user_settings_form
+  ref :user_settings_panel
+  ref :user_settings_email_input
+end
+```
+
+```erb
+<form id="<%= ref.user_settings_form %>"></form>
+```
+
+```rb
+turbo_stream.replace ref.user_settings_form
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "refs-rails"
+```
+
+## Usage
+
+### 1. Define Your References
+
+Create a file at `config/refs.rb` in your Rails application:
+
+```ruby
+# config/refs.rb
+Refs.define do
+  # Form identifiers
+  ref :login_form
+  ref :signup_form
+  ref :user_settings_form
+end
+```
+
+### 2. Use in Views
+
+Each ref you define is turned into a method on the `ref` object and automatically available in your views and controllers:
+
+```erb
+<form id="<%= ref.login_form %>"></form>
+```
+
+```rb
+render turbo_stream: turbo_stream.replace ref.login_form
+```
+
+## Benefits
+
+This library helps centralize all your DOM ids, which are frequently needed in a default Rails app with a hotwire frontend. It will help you find your bugs faster with method errors when the template renders, rather than JavaScript errors when you are click-testing.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jameskerr/refs-rails.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/refs/railtie.rb

@@ -0,0 +1,22 @@
+require "rails/railtie"
+require "refs/view_helper"
+
+class Refs
+  class Railtie < Rails::Railtie
+    config.refs = ActiveSupport::OrderedOptions.new
+    config.refs.config_path = "config/refs.rb"
+
+    initializer "refs-rails.setup" do |app|
+      file = Rails.root.join(config.refs.config_path)
+      app.config.to_prepare do
+        load file
+      end
+    end
+
+    initializer "refs-rails.action_controller" do
+      ActiveSupport.on_load :action_controller do
+        include Refs::ViewHelper
+      end
+    end
+  end
+end

data/lib/refs/version.rb

@@ -0,0 +1,3 @@
+class Refs
+  VERSION = "0.1.0"
+end

data/lib/refs/view_helper.rb

@@ -0,0 +1,9 @@
+class Refs
+  module ViewHelper
+    def ref = Refs.instance
+
+    def self.included(base)
+      base.helper_method :ref
+    end
+  end
+end

data/lib/refs-rails.rb

@@ -0,0 +1,3 @@
+require "refs"
+require "refs/railtie"
+require "refs/version"

data/lib/refs.rb

@@ -0,0 +1,17 @@
+class Refs
+  def self.ref(name)
+    define_method(name) { name.to_s }
+  end
+
+  def self.define(&block)
+    class_eval(&block) if block_given?
+  end
+
+  def self.instance
+    @instance ||= new
+  end
+
+  def self.reset!
+    @instance = nil
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: refs-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Kerr
+bindir: exe
+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: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+email:
+- kerr@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/refs-rails.rb
+- lib/refs.rb
+- lib/refs/railtie.rb
+- lib/refs/version.rb
+- lib/refs/view_helper.rb
+homepage: https://github.com/jameskerr/refs-rails
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/jameskerr/refs-rails/blob/main/CHANGELOG.md
+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: 3.7.1
+specification_version: 4
+summary: A simple way to manage string references in a Rails application.
+test_files: []