phone_preview 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc78569a84670e434020eb9ce555cd7e21c00228025ceb52e18d9420adc8f8c2
+  data.tar.gz: e8e46b0e1f29452f1e90a012f4089cfeb190f7ae64fd5d11af0d1ac4dc6220cb
+SHA512:
+  metadata.gz: 2768cd8b0e3058463d1839358c3d0693ac95cbe87aba06126de22176f0c67ea2c0e62dc971e332ba38ca8995b6270d2c6e668c3207a502010d81a3e50e484ca3
+  data.tar.gz: 97b463e508fc83fa547a938a5a3336ee2c416f1d0e9974213446cc3ec355bc2d6ea866cb890f852fe920f06270c9d6368d542c4afa851728829de2fb43a332d8

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+
+- `phone_preview` starts the app's server and an ngrok tunnel on one port, and prints the public address and a QR code of it.
+- With no `PORT` set, `phone_preview` starts on port 3000.
+- In development, emailed links use `PUBLIC_BASE_URL` over https with no port when it is set.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DYB
+
+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,49 @@
+# phone_preview
+
+Opens a Rails app running on your Mac on a phone, through an ngrok tunnel at a
+fixed public address.
+
+`phone_preview` starts the app's server and an ngrok tunnel on one port, prints
+the public address and a QR code of it to scan with the phone's camera, and in
+development makes emailed links use that address so they open on the phone.
+
+## Requirements
+
+- An ngrok account with a reserved domain for the app, such as
+  `app-dev.ngrok.app`, and the `ngrok` command signed in to that account.
+- `overmind`, which runs the server and the tunnel together.
+
+## Installing
+
+Add the gem to the app's development group:
+
+```ruby
+group :development do
+  gem "phone_preview"
+end
+```
+
+Give the app a `bin/phone` that names its public address and runs the gem's
+command:
+
+```sh
+#!/usr/bin/env sh
+
+export PUBLIC_BASE_URL="${PUBLIC_BASE_URL:-https://app-dev.ngrok.app}"
+
+exec bundle exec phone_preview "$@"
+```
+
+## Using it
+
+Run `bin/phone`, or `up phone` from symphony, which picks the first free port.
+Open the printed address on the phone, or scan the QR code.
+
+With no `PORT` set, the server starts on port 3000.
+
+When `PUBLIC_BASE_URL` is set in development, emailed links use it over https
+with no port. With it unset, or outside development, emailed links keep the
+app's own `action_mailer.default_url_options`.
+
+Live connections through Action Cable need no setting, because Rails accepts a
+connection whose origin matches the address the request arrives on.

data/exe/phone_preview

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require "rqrcode"
+
+address = ENV.fetch("PUBLIC_BASE_URL")
+ENV["PORT"] ||= "3000"
+
+puts RQRCode::QRCode.new(address).as_ansi
+puts "Open #{address} on your phone"
+
+procfile = File.expand_path("../lib/phone_preview/Procfile", __dir__)
+$stdout.flush
+exec "overmind", "start", "-T", "--no-port", "-f", procfile, "-d", Dir.pwd

data/lib/phone_preview/Procfile

@@ -0,0 +1,2 @@
+web: bin/rails server -p $PORT
+tunnel: ngrok http --url=$PUBLIC_BASE_URL $PORT --log=stdout

data/lib/phone_preview/railtie.rb

@@ -0,0 +1,14 @@
+require "uri"
+
+module PhonePreview
+  class Railtie < Rails::Railtie
+    initializer "phone_preview.emailed_links", before: "action_mailer.set_configs" do |app|
+      address = ENV["PUBLIC_BASE_URL"].presence
+
+      if Rails.env.development? && address
+        public_uri = URI.parse(address)
+        app.config.action_mailer.default_url_options = { host: public_uri.host, protocol: public_uri.scheme }
+      end
+    end
+  end
+end

data/lib/phone_preview/version.rb

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

data/lib/phone_preview.rb

@@ -0,0 +1,6 @@
+require "phone_preview/version"
+
+module PhonePreview
+end
+
+require "phone_preview/railtie" if defined?(Rails::Railtie)

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: phone_preview
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Schneider
+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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: rqrcode
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Starts a Rails app in development with an ngrok tunnel on one port, prints
+  its public address and a QR code of it, and makes emailed links use that address.
+email:
+- tylercschneider@gmail.com
+executables:
+- phone_preview
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- exe/phone_preview
+- lib/phone_preview.rb
+- lib/phone_preview/Procfile
+- lib/phone_preview/railtie.rb
+- lib/phone_preview/version.rb
+homepage: https://github.com/DYB-Development/phone_preview
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/phone_preview
+  source_code_uri: https://github.com/DYB-Development/phone_preview
+  changelog_uri: https://github.com/DYB-Development/phone_preview/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/DYB-Development/phone_preview/issues
+  documentation_uri: https://github.com/DYB-Development/phone_preview#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Opens a locally running Rails app on a phone through an ngrok tunnel.
+test_files: []