chrome_devtools_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c60e34e0904582d3e8c0531e9324d9bb6f8e6224fc58d3589b5f78cee5b4b596
+  data.tar.gz: 912ac8c111b3383eb7389397945069a4d7b070ab573936f2e3648cad5a841d1c
+SHA512:
+  metadata.gz: 1380a9d09a80ee92e2743e012ee465513cea02daf18ad01edf6a4d881acb562dad539bdb4998f6da28759a43f726045318fd98676f2d445b82ecd54e6e5ec44a
+  data.tar.gz: 51de32faa41e403cb1cab7f6a666145f870c5adfdb8b6fd8cba01148f0dff8171974ad024e2bd53e5bd61062953dcad2a936d992f22072232a4dfbc847f99768

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2023-05-19
+
+### Added
+- Initial release
+- Automatic workspace mapping for Chrome DevTools
+- Serves JSON file at `/.well-known/appspecific/com.chrome.devtools.json`
+- UUID persistence in `tmp/chrome_devtools_uuid`

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Daniel Lopez 👾
+
+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,64 @@
+# ChromeDevtoolsRails
+
+This gem provides a minimal Rails engine that automatically serves the Chrome DevTools workspace mapping file at:
+
+```text
+/.well-known/appspecific/com.chrome.devtools.json
+```
+
+When Chrome accesses this file from your local development server, it enables **automatic workspace folder mapping**, allowing you to edit and save source files (JS, CSS, etc.) directly from Chrome DevTools into your local Rails project.
+
+This engine is **automatically mounted** and only active in **development mode**.
+
+---
+
+## 🚀 Usage
+
+1. Visit your Rails app on `localhost`.
+2. Open Chrome DevTools → **Sources** tab.
+3. Chrome will auto-detect the `.well-known` file and prompt to map your local project.
+4. Approve the mapping — changes made in DevTools will now be saved directly to disk.
+
+---
+
+## 🔧 Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "chrome_devtools_rails"
+```
+
+Then run:
+
+```bash
+bundle install
+```
+
+No route configuration is needed — the engine mounts itself automatically in development.
+
+---
+
+## ✅ Requirements
+
+- Ruby ≥ 3.1
+- Rails ≥ 8.0.2
+- Google Chrome v89+ (with DevTools workspace support)
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome on GitHub at [https://github.com/6temes/chrome_devtools_rails](https://github.com/6temes/chrome_devtools_rails).
+
+Ideas for improvement:
+
+- Add support for regenerating the UUID
+- Configurable root path
+- Rake task or generator to inspect the current workspace config
+
+---
+
+## 📄 License
+
+This gem is open source and released under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/controllers/chrome_devtools_rails/devtools_controller.rb

@@ -0,0 +1,25 @@
+module ChromeDevtoolsRails
+  class DevtoolsController < ActionController::Base
+    def show
+      render json: {
+        workspace: {
+          root: Rails.root.to_s,
+          uuid: uuid
+        }
+      }
+    end
+
+    private
+
+    def uuid
+      path = Rails.root.join("tmp", "chrome_devtools_uuid")
+      File.exist?(path) ? File.read(path).strip : persist_uuid(path)
+    end
+
+    def persist_uuid(path)
+      uuid = SecureRandom.uuid
+      File.write(path, uuid)
+      uuid
+    end
+  end
+end

data/lib/chrome_devtools_rails/engine.rb

@@ -0,0 +1,15 @@
+module ChromeDevtoolsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ChromeDevtoolsRails
+
+    initializer "chrome_devtools_rails.append_route" do |app|
+      if Rails.env.development? || Rails.env.test?
+        app.routes.append do
+          get "/.well-known/appspecific/com.chrome.devtools.json",
+              to: "chrome_devtools_rails/devtools#show",
+              as: :chrome_devtools_json
+        end
+      end
+    end
+  end
+end

data/lib/chrome_devtools_rails/version.rb

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

data/lib/chrome_devtools_rails.rb

@@ -0,0 +1,2 @@
+require "chrome_devtools_rails/version"
+require "chrome_devtools_rails/engine"

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: chrome_devtools_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- "Daniel Lopez \U0001F47E"
+bindir: bin
+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: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 8.0.2
+description: A Rails engine that automatically provides the /.well-known/appspecific/com.chrome.devtools.json
+  endpoint for enabling Chrome DevTools automatic workspace mapping in development
+  mode.
+email:
+- daniel@6temes.cat
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/chrome_devtools_rails/devtools_controller.rb
+- lib/chrome_devtools_rails.rb
+- lib/chrome_devtools_rails/engine.rb
+- lib/chrome_devtools_rails/version.rb
+homepage: https://github.com/6temes/chrome_devtools_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/6temes/chrome_devtools_rails
+  source_code_uri: https://github.com/6temes/chrome_devtools_rails/tree/main
+  documentation_uri: https://github.com/6temes/chrome_devtools_rails/blob/main/README.md
+  changelog_uri: https://github.com/6temes/chrome_devtools_rails/blob/main/CHANGELOG.md
+  allowed_push_host: https://rubygems.org
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Serve com.chrome.devtools.json for Chrome automatic workspace setup
+test_files: []