hotwire-debug 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f94c65f6c5769077e4d8d7961e3f2ba2e81aaf6f1da72e424b8bfae12832d763
+  data.tar.gz: f84644d64c5edfee0e97f0cfad7f554780d8931f129885a953bca1447380c472
+SHA512:
+  metadata.gz: 528b98024db5acbdc1e934fe13bcc34cf8e22f07e56e4914d17bb51f7a6e0b57819f93883426facad76b40d1c8fa48a87a4fe0cd3b393cae2f43c1509ac14ae0
+  data.tar.gz: 98df50002c62a9c42781650c6c14f0989faba3fe7c58bf4ef7ed04eb9fe4edebc6f9a2a72c5e9220e7cfb1c1d391fea7be77ae8b8d3a01d566916e25aa49e3b8

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jim@beflagrant.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in hotwire-debug.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    hotwire-debug (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  hotwire-debug!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.2.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jim Remsik
+
+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,58 @@
+# Hotwire::Debug
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hotwire-debug'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hotwire-debug
+
+## Usage
+
+This gem adds assets into your applications vendor assets javascripts/stylesheets directories.
+
+Update your `application.js`
+```js
+//= require hotwire-debug
+```
+
+Update your `application.css`
+```css
+/*
+*= require hotwire-debug
+*/
+```
+
+If your application does not already include stylesheets and javascripts in the layout, add them.
+
+```erb
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+    <%= javascript_include_tag 'application', media: 'all' %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 tags, 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/beflagrant/hotwire-debug. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Hotwire::Debug project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/beflagrant/hotwire-debug/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hotwire/debug"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hotwire-debug.gemspec

@@ -0,0 +1,20 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hotwire/debug/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hotwire-debug"
+  spec.version       = Hotwire::Debug::VERSION
+  spec.authors       = ["Jim Remsik", "Jonathan Greenberg"]
+  spec.email         = ["jim@beflagrant.com", "jonathan@beflagrant.com"]
+
+  spec.summary       = %q{Hotwire-debug highlights changes that occur via turbo-rails.}
+  spec.homepage      = "http://www.github.com/beflagrant/hotwire-debug"
+  spec.license       = "MIT"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  
+  spec.files      = `git ls-files`.split("\n")
+end

data/lib/hotwire/debug.rb

@@ -0,0 +1,5 @@
+require "hotwire/debug/version"
+
+module Hotwire::Debug
+  class Engine < ::Rails::Engine; end
+end

data/lib/hotwire/debug/version.rb

@@ -0,0 +1,5 @@
+module Hotwire
+  module Debug
+    VERSION = "0.1.0"
+  end
+end

data/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@beflagrant/hotwire-debug",
+  "version": "0.1.0",
+  "description": "Hotwire-debug highlights changes that occur via turbo.",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/beflagrant/hotwire-debug.git"
+  },
+  "author": "Jim Remsik <jim@beflagrant.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/beflagrant/hotwire-debug/issues"
+  },
+  "homepage": "https://github.com/beflagrant/hotwire-debug#readme",
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "hotwire",
+    "rails",
+    "debug"
+  ]
+}

data/vendor/assets/javascripts/hotwire-debug.js

@@ -0,0 +1,45 @@
+var turboEvents = [
+  "turbo:before-cache",
+  "turbo:before-render",
+  "turbo:before-visit",
+  "turbo:click",
+  "turbo:load",
+  "turbo:render",
+  "turbo:submit-end",
+  "turbo:submit-start",
+]
+
+turboEvents.forEach(function(turboEvent) {
+  document.addEventListener(turboEvent, function() {
+    if (showChanges()) {
+      console.log(turboEvent);
+      handleChange();
+    }
+  });
+})
+
+function showChanges () {
+  return document.documentElement.hasAttribute('data-hotwire-debug')
+}
+
+function handleChange() {
+  document.querySelectorAll('turbo-frame > div, turbo-frame > form').forEach(function(target) { 
+    target.setAttribute('data-turbo-frame-id', target.closest('turbo-frame').id);
+  });
+}
+
+window.addEventListener("turbo:load", () => {
+  let hotwireToggle = document.getElementById('hotwire-toggle');
+
+  if (hotwireToggle == null) {
+    hotwireToggle = document.createElement("div");
+    hotwireToggle.innerHTML = '<svg viewBox="0 0 196 196" xmlns="http://www.w3.org/2000/svg"> <style> path { fill: #000000; } @media (prefers-color-scheme: dark) { path { fill: #ffffff; } } </style> <path d="m16.38 184.8 109.46-44.72-35.27-3.31 76.73-66.59-44.33-4.16 53.9-55.53-136.52 70.03 54.89 6.44-67.32 54.38 30.07 2.97z"/> </svg>';
+    hotwireToggle.id = "hotwire-toggle";
+    document.body.append(hotwireToggle);
+
+    hotwireToggle.addEventListener("click", function() {
+      document.documentElement.toggleAttribute("data-hotwire-debug");
+      handleChange();
+    });
+  }
+});

data/vendor/assets/stylesheets/hotwire-debug.scss

@@ -0,0 +1,79 @@
+:root {
+  --color-teal: rgba(95, 206, 214, 1);
+  --color-teal-trans: rgba(95, 206, 214, 0.4);
+  --color-pink: rgba(223, 116, 168, 1);
+  --color-pink-trans: rgba(223, 116, 168, 0.4);
+  --color-yellow: rgba(255, 224, 0, 1);
+}
+body > #hotwire-toggle {
+  position: fixed;
+  top: 1rem;
+  right: 2rem;
+  height: 2rem;
+  width: 2rem;
+  z-index: 20;
+  
+  svg path {
+    fill: var(--color-black) !important;
+    transition: fill ease-in-out 0.3s;
+  }
+  &:hover svg path {
+    fill: var(--color-pink) !important;
+  }
+}
+html[data-hotwire-debug] #hotwire-toggle {
+  svg path {
+    fill: var(--color-yellow) !important;
+    stroke: var(--color-pink);
+  }
+
+  &:hover {
+    svg path {
+      stroke-width: 4px;
+    }
+  }
+}
+[data-hotwire-debug] {
+  turbo-frame {
+    display: block;
+    transition: all ease-in-out 0.3s;
+
+    &:hover {
+      display: block;
+      position: relative;
+      box-shadow: inset 0 0 3rem var(--color-teal-trans);
+
+      &:after {
+        color: rgb(30, 120, 120) !important;
+        content: attr(id);
+        font-weight: bold;
+        position: absolute;
+        display: block;
+        top: 49%;
+        right: 1rem;
+        -webkit-transform: translateY(-50%);
+        -moz-transform: translateY(-50%);
+        -ms-transform: translateY(-50%);
+        transform: translateY(-50%);
+        z-index: 10;
+      }
+    }
+
+    & > :not(turbo-frame) {
+      animation-name: highlight-frame-change;
+      animation-duration: 0.25s;
+      border-radius: 0 1rem 1rem 0;
+    }
+  }
+  @keyframes highlight-frame-change {
+    0% {
+      box-shadow: unset;
+    }
+    50% {
+      box-shadow:inset 0 0 4rem var(--color-teal);
+    }
+    100% {
+      box-shadow: unset;
+    }
+  }
+}

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: hotwire-debug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Remsik
+- Jonathan Greenberg
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description:
+email:
+- jim@beflagrant.com
+- jonathan@beflagrant.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hotwire-debug.gemspec
+- lib/hotwire/debug.rb
+- lib/hotwire/debug/version.rb
+- package.json
+- vendor/assets/javascripts/hotwire-debug.js
+- vendor/assets/stylesheets/hotwire-debug.scss
+homepage: http://www.github.com/beflagrant/hotwire-debug
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Hotwire-debug highlights changes that occur via turbo-rails.
+test_files: []