jumper_cable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6112e1031f8116804382223287d083df7eeaeb5d18139b7502beb82f305784b
+  data.tar.gz: e1c442b0a56876a8a0915980f090f37c58856d1e12064d56ccd8444c2bd284ec
+SHA512:
+  metadata.gz: d93af9140f7181fb867dc0770feb39f113f1459214bd2ba7ebb232cb7dc18327a7731dd7660740e743939cf8863aed993f3fdce8dbb0733159a7aa1d191ac9f8
+  data.tar.gz: 85f51888453cecf935740adcea517345227206b261fb1b59d7598d0de0aebcf12e67143fa4f876fea1ca88b788dccd49fc51a2b5e8affbd9c604553e86388e79

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-05-08
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"jumper_cable" 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 ["info.spencer.burke@gmail.com"](mailto:"info.spencer.burke@gmail.com").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Spencer Burke
+
+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,81 @@
+# JumperCable
+
+Hotwire and MVC is a powerful combination for building maintainable, accessible Rails applications.
+But as your app grows, the presentation layer gets scattered across different controllers:
+- login form in `sessions#new`
+- signup in `registrations#new`
+- profiles in `users#show`
+
+Finding which controller renders which page becomes ambiguous.
+
+JumperCable solves this by codifying a "page controller" pattern. 
+Every page in your app gets a single canonical home, making your application's structure immediately navigable.
+
+Think of your resource controllers as an **engine**... it handles the business logic and data.
+Pages are the presentation layer, and turbo frames are the **jumper cables**... wires that connect your engine to presentation of your app.
+
+## Installation
+
+Add to your Gemfile:
+
+```bash
+bundle add jumper_cable
+```
+
+## Usage
+
+### Routing DSL
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  page :login                    # GET /login -> pages/login_page#page
+  page :profile, params: [:id]   # GET /profile/:id -> pages/profile_page#page
+
+  namespace :about do
+    page :team                   # GET /about/team -> pages/about/team_page#page
+  end
+end
+```
+
+### Generator
+
+```bash
+rails generate jumper_cable:page Login
+# creates app/controllers/pages/login_page_controller.rb
+# creates app/views/pages/login_page/page.html.erb
+
+rails generate jumper_cable:page About::Team
+# creates app/controllers/pages/about/team_page_controller.rb
+# creates app/views/pages/about/team_page/page.html.erb
+```
+
+### Page Controllers
+
+Page controllers inherit from `JumperCable::PageController` and define a single `page` action:
+
+```ruby
+class Pages::LoginPageController < JumperCable::PageController
+  def page
+    # optionally fetch data for the page
+  end
+end
+```
+
+### Page Views
+
+Pages are shells for Turbo Frames. Resource controllers power the frames — pages just wire them together:
+
+```erb
+<%# app/views/pages/login_page/page.html.erb %>
+<%= turbo_frame_tag "login-form" %>
+<%= turbo_frame_tag "login-errors" %>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/spencer-burke/jumper_cable.
+
+## License
+
+MIT

data/Rakefile

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

data/lib/generators/jumper_cable/page/page_generator.rb

@@ -0,0 +1,21 @@
+module JumperCable
+  module Generators
+    class PageGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_controller
+        template "controller.rb.tt", "app/controllers/pages/#{namespaced_path}_page_controller.rb"
+      end
+
+      def create_view
+        template "view.html.erb.tt", "app/views/pages/#{namespaced_path}_page/page.html.erb"
+      end
+
+      private
+
+      def namespaced_path
+        (class_path + [file_name]).join("/")
+      end
+    end
+  end
+end

data/lib/generators/jumper_cable/page/templates/controller.rb.tt

@@ -0,0 +1,4 @@
+class Pages::<%= class_name %>PageController < JumperCable::PageController
+    def page
+    end
+end

data/lib/generators/jumper_cable/page/templates/view.html.erb.tt

@@ -0,0 +1 @@
+<h1><%= class_name %> Page</h1>

data/lib/jumper_cable/page_controller.rb

@@ -0,0 +1,6 @@
+module JumperCable
+  class PageController < ActionController::Base
+    def page
+    end
+  end
+end

data/lib/jumper_cable/railtie.rb

@@ -0,0 +1,7 @@
+module JumperCable
+  class Railtie < Rails::Railtie
+    initializer "jumper_cable.routing" do
+      ActionDispatch::Routing::Mapper.include(JumperCable::Routing)
+    end
+  end
+end

data/lib/jumper_cable/routing.rb

@@ -0,0 +1,40 @@
+module JumperCable
+  module Routing
+    def page(name, params: [], &block)
+      controller = resolve_controller(name)
+      path = resolve_path(name, params)
+
+      get path, to: "#{controller}#page"
+    end
+
+    def namespace(name, &block)
+      scope "/#{name}" do
+        with_namespace(name) { yield }
+      end
+    end
+
+    private
+
+    def with_namespace(name, &block)
+      @_jc_namespace = name
+
+      yield
+
+      @_jc_namespace = nil
+    end
+
+    def resolve_controller(name)
+      if @_jc_namespace
+        return "pages/#{@_jc_namespace}/#{name}_page"
+      end
+
+      return "pages/#{name}_page"
+    end
+
+    def resolve_path(name, params)
+      segments = [name.to_s] + params.map {|p| ":#{p}"}
+
+      return("/#{segments.join("/")}")
+    end
+  end
+end

data/lib/jumper_cable/version.rb

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

data/lib/jumper_cable.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "jumper_cable/version"
+require_relative "jumper_cable/routing"
+require_relative "jumper_cable/railtie" if defined?(Rails)
+require_relative "jumper_cable/page_controller" if defined?(Rails)
+
+module JumperCable
+  class Error < StandardError; end
+end

data/sig/jumper_cable.rbs

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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jumper_cable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- spencer burke
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  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: Extends the routing dsl, and adds a generator to automatically "page
+  controllers"
+email:
+- info.spencer.burke@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/jumper_cable/page/page_generator.rb
+- lib/generators/jumper_cable/page/templates/controller.rb.tt
+- lib/generators/jumper_cable/page/templates/view.html.erb.tt
+- lib/jumper_cable.rb
+- lib/jumper_cable/page_controller.rb
+- lib/jumper_cable/railtie.rb
+- lib/jumper_cable/routing.rb
+- lib/jumper_cable/version.rb
+- sig/jumper_cable.rbs
+homepage: https://github.com/spencer-burke/jumper_cable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/spencer-burke/jumper_cable
+  source_code_uri: https://github.com/spencer-burke/jumper_cable/tree/main
+  changelog_uri: https://github.com/spencer-burke/jumper_cable/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: 4.0.3
+specification_version: 4
+summary: Organizes hotwire apps by creating pages
+test_files: []