dev_toolbar 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1aef5cd3c0aa26e81bb29134d3700bbafe9addc215bc03a8baaf844ca0de43c6
-  data.tar.gz: 471568a19e42b41835ccb82016d618f699dba0f9aa86be361ddc93b360b4e621
+  metadata.gz: 8b5f82f64e412b3c84ead79dd80b612f52af3e45bb590fba94f24aafd148b1ef
+  data.tar.gz: f6ad406e103b96573194853a79cb89f5b3dc4ed78e48bfd692112c8203168d7b
 SHA512:
-  metadata.gz: 7db6621b788076edaa4772437fe4e9820716fed9693aac4b93db45683435a8c7c9b8bbcc138396a3ea6803eb45d4790d0259ff815a4f37f913fdf1eb50b9f576
-  data.tar.gz: f138d77ff57066f90a5a1095b2e36d32b9e9d68ab7526a1ccb6396c95e3b3998782d133f549ce4fa7727e79ca227816ac8fce202312863cb4f9682b33fcfe03f
+  metadata.gz: 0f4289abfef772cad1b0ef858dfa760a77e3071e8fad8aa42e8ce348477fabb0575cd52d710388808e7ccfc3d24d504d43d21baee46fc540265aaa50e2de8c4d
+  data.tar.gz: 70cbbfce13c9fa7c67edd150e4b429ef0d9a03477a47979553e2eabe48518181549888d234feb7d38c0ac2047fcf81b7000328a42fc3e96a0cf1f915791f0729

data/lib/dev_toolbar/configuration.rb

@@ -0,0 +1,9 @@
+module DevToolbar
+  class Configuration
+    attr_accessor :links
+
+    def initialize
+      @links = []
+    end
+  end
+end

data/lib/dev_toolbar/middleware.rb

@@ -5,37 +5,84 @@ module DevToolbar
     end
 
     def call(env)
-      request = Rack::Request.new(env)
-      @ip = request.ip
-      @app.call(env)
-    rescue Exception => ex
-      if pass_through?
-        @app.call(env)
-      else
-        [200, {"Content-Type" => "text/html"}, [error_message]]
-      end
-    end
+      status, headers, response = @app.call(env)
 
-    def pass_through?
-      path = Rails.root.join('whitelist.yml')
-      if File.exist?(path)
-        whitelisted_ips = YAML.load_file(path)
-        whitelisted_ips.include?(@ip)
-      else
-        true
-      end
-    end
+      if Rails.env.development? && headers["Content-Type"]&.include?("text/html")
+        response_body = response.body
+        toolbar_html = <<-HTML
+          <div id="dev-toolbar">
+            <div id="dev-toolbar-button">
+              <a id="dev-toolbar-toggle">🛠️</a>
+            </div>
+            <div id="dev-toolbar-links" class="hidden">
+              #{toolbar_links}
+            </div>
+          </div>
+          <style>
+            #dev-toolbar {
+              position: fixed;
+              right: 0;
+              top: 50vh;
+              transform: translateY(-50%);
+              background-color: #f0f0f0;
+              border: 1px solid #ccc;
+              z-index: 1000;
+              display: flex;
+              flex-direction: column;
+              align-items: center;
+              font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif;
+              color: #808080;
+            }
+        
+            #dev-toolbar-toggle {
+              font-size: 2em;
+              border: none;
+              cursor: pointer;
+              line-height: 1.5;
+              padding: 0 10px;
+              text-decoration: none;
+            }
+        
+            #dev-toolbar-links {
+              display: flex;
+              flex-direction: column;
+            }
 
-    def error_message
-      <<-HTML
-        <h1>Uh oh! You've got an error in your code.</h1>
+            .dev-toolbar-link {
+              padding: 5px 10px;
+              border-bottom: 1px #f0f0f0 solid;
+              color: #808080;
+              text-decoration: none;
+              background-color: white;
+            }
+        
+            #dev-toolbar-links.hidden {
+              display: none;
+            }
+          </style>
+          <script>
+            document.getElementById('dev-toolbar-toggle').addEventListener('click', function() {
+              var links = document.getElementById('dev-toolbar-links');
+              links.classList.toggle('hidden');
+            });
+          </script>
+        HTML
 
-        <h2>To get a more helpful error page, please run this command at a terminal prompt:</h2>
+        response_body.sub!('</body>', "#{toolbar_html}</body>")
+        headers["Content-Length"] = response_body.bytesize.to_s
+
+        response = [response_body]
+      end
+
+      [status, headers, response]
+    end
 
-        <pre style="font-size: 4em;"><code>bin/whitelist #{@ip}</code></pre>
+    private
 
-        <h2>and then restart your server.</h2>
-      HTML
+    def toolbar_links
+      DevToolbar.configuration.links.map do |link|
+        "<a href='#{link[:path]}' target='_blank' class='dev-toolbar-link'>#{link[:name]}</a>"
+      end.join(' ')
     end
   end
 end

data/lib/dev_toolbar/railtie.rb

@@ -0,0 +1,7 @@
+module DevToolbar
+  class Railtie < Rails::Railtie
+    initializer "dev_toolbar.middleware" do |app|
+      app.middleware.use DevToolbar::Middleware if Rails.env.development?
+    end
+  end
+end

data/lib/dev_toolbar/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DevToolbar
-  VERSION = '0.1.0'
+  VERSION = "1.1.0"
 end

data/lib/dev_toolbar.rb

@@ -1,6 +1,19 @@
-require "dev_toolbar/engine"
-require "dev_toolbar/middleware"
-require "dev_toolbar/debug_helper"
+# frozen_string_literal: true
+
+require_relative "dev_toolbar/version"
+require_relative "dev_toolbar/railtie"
+require_relative "dev_toolbar/middleware"
+require_relative "dev_toolbar/configuration"
+
 module DevToolbar
-  # Your code goes here...
+  class Error < StandardError; end
+  
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
 end

metadata

@@ -1,65 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: dev_toolbar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
-- Murugan
-autorequire: 
-bindir: bin
+- Ben Purinton
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2024-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: better_errors
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        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: '13.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Firstdraft Dev Toolbar
+        version: '13.0'
+description: A sticky toolbar for Rails applications in development mode
 email:
-- murugan@firstdraft.com
+- ben@firstdraft.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
-- README.md
-- Rakefile
-- app/assets/stylesheets/dev_toolbar/dev_toolbar.scss
-- app/views/shared/_dev_tools.html.erb
 - lib/dev_toolbar.rb
-- lib/dev_toolbar/debug_helper.rb
-- lib/dev_toolbar/engine.rb
+- lib/dev_toolbar/configuration.rb
 - lib/dev_toolbar/middleware.rb
+- lib/dev_toolbar/railtie.rb
 - lib/dev_toolbar/version.rb
 homepage: https://github.com/firstdraft
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/firstdraft
+  source_code_uri: https://github.com/firstdraft/dev_toolbar
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -67,16 +78,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
-summary: Debug helper
+summary: A development toolbar for Rails applications.
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2017 Firstdraft
-
-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

@@ -1,16 +0,0 @@
-# DevToolbar
-Firstdraft Dev Toolbar for cloud9 integration with better errors and web-console..etc..,
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-group :development do
-  gem 'dev_toolbar', git: 'https://github.com/firstdraft/dev_toolbar.git'
-end
-```
-
-And then execute:
-```bash
-$ bundle
-```

data/Rakefile

@@ -1,36 +0,0 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'DevToolbar'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
-load 'rails/tasks/engine.rake'
-
-
-load 'rails/tasks/statistics.rake'
-
-
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task default: :test

data/app/assets/stylesheets/dev_toolbar/dev_toolbar.scss

@@ -1,76 +0,0 @@
-.dev_toolbar {
-  box-sizing: border-box;
-  position:fixed;
-  height: 40px;
-  right:-40px;
-  top:45%;
-  transform:rotate(-90deg);
-  -webkit-transform:rotate(-90deg);
-  -ms-transform:rotate(-90deg);
-  -moz-transform:rotate(-90deg);
-  z-index:999;
-
-  .btn {
-    font-family: Georgia;
-    text-decoration: none;
-    display: inline-block;
-    font-weight: normal;
-    text-align: center;
-    white-space: nowrap;
-    vertical-align: middle;
-    -webkit-user-select: none;
-       -moz-user-select: none;
-        -ms-user-select: none;
-            user-select: none;
-    border: 1px solid transparent;
-    padding: 0.5rem 0.75rem;
-    font-size: 1rem;
-    line-height: 1.25;
-    border-radius: 0.25rem;
-    transition: all 0.15s ease-in-out;
-  }
-
-  .btn:focus, .btn.focus {
-    outline: 0;
-    box-shadow: 0 0 0 3px rgba(0, 123, 255, 0.25);
-  }
-
-  .btn-outline-secondary {
-    color: #868e96;
-    background-color: transparent;
-    background-image: none;
-    border-color: #868e96;
-  }
-
-  .btn-outline-secondary:hover {
-    color: #fff;
-    background-color: #868e96;
-    border-color: #868e96;
-  }
-
-  .btn-outline-secondary:focus, .btn-outline-secondary.focus {
-    box-shadow: 0 0 0 3px rgba(134, 142, 150, 0.5);
-  }
-
-  .btn-outline-secondary:active {
-    color: #fff;
-    background-color: #868e96;
-    border-color: #868e96;
-  }
-}
-
-.footer {
-  position: absolute;
-  right: 0;
-  bottom: 0;
-  left: 0;
-  padding: 1rem;
-  text-align: center;
-}
-
-.alert-info {
-  color: #31708f;
-  background-color: #d9edf7;
-  border-color: #bce8f1;
-}
-

data/app/views/shared/_dev_tools.html.erb

@@ -1,11 +0,0 @@
-<%= stylesheet_link_tag "dev_toolbar" %>
-<div class="dev_toolbar">
-  <% if defined?(WebGit) %>
-    <%= link_to "Git", "/git", class: "dev_tools_button btn btn-outline-secondary" %>
-  <% end %>
-
-  <% if defined?(ActiveAdmin) %>
-    <%= link_to "Admin", "/admin", class: "dev_tools_button btn btn-outline-secondary" %>
-  <% end %>
-  <%= link_to "Routes", "/rails/info", class: "dev_tools_button btn btn-outline-secondary" %>
-</div>

data/lib/dev_toolbar/debug_helper.rb

@@ -1,10 +0,0 @@
-module DevToolbar
-  module DebugHelper
-
-    def dev_tools
-      if Rails.env.development?
-        render "shared/dev_tools"
-      end
-    end
-  end
-end

data/lib/dev_toolbar/engine.rb

@@ -1,49 +0,0 @@
-module DevToolbar
-  class Engine < ::Rails::Engine
-    isolate_namespace DevToolbar
-
-    initializer "dev_toolbar.configure_rails_initialization" do |app|
-      if enable?
-        insert_middleware
-      end
-    end
-
-    initializer "dev_toolbar.assets" do |app|
-      Rails.application.config.assets.precompile += %w{ dev_toolbar }
-      Rails.application.config.assets.paths << root.join("app", "assets", "stylesheets", "dev_toolbar")
-    end
-
-    initializer 'dev_toolbar.action_controller' do |app|
-      ActiveSupport.on_load :action_controller do
-        helper DevToolbar::DebugHelper
-      end
-    end
-
-    config.after_initialize do
-      path = Rails.root.join('whitelist.yml')
-      if File.exist?(path)
-        whitelisted_ips = YAML.load_file(path)
-        whitelisted_ips.each do |ip|
-          BetterErrors::Middleware.allow_ip!(ip)
-        end
-      end
-    end
-
-    def insert_middleware
-      if defined? BetterErrors::Middleware
-        app.middleware.insert_after BetterErrors::Middleware, DevToolbar::Middleware
-      else
-        app.middleware.use DevToolbar::Middleware
-      end
-    end
-
-
-    def enable?
-      !Rails.env.production? and app.config.consider_all_requests_local
-    end
-
-    def app
-      Rails.application
-    end
-  end
-end