callstacking-rails 0.1.19 → 0.1.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 122755f46a3f89ee6c310aed0ede48453bf7ff7f92c50f9809fe7466ad49159b
-  data.tar.gz: adfdbd3892e3c6cc5b1e869ce8a1d63185610347b3079a1de8cf6ebb8009eff3
+  metadata.gz: bf64a69817d5a94e205db95cd79dbff2c15d1190ed001bb49d1113aa0ada96b4
+  data.tar.gz: 4a37b31f1d9faac2de735ea799fd7fda9151ff2300de7401ad23d9dc8c21fd5e
 SHA512:
-  metadata.gz: baa19130df5d47f45d0df4d2a0055edb1d5a2bbb74bdff1919a20de8bd6e6fa5fe6ad8224dddf8a6b973128301f007b76f094d076e0753c1b5257f3b5852c9ac
-  data.tar.gz: 22e7fc256542ea2f13de0f400b350a74a2e115c96610734f0db0e492d416b48d6dd19f26ea68b40a4ffac6ef3a515f27a21604b3a0fe0dca2e43f6017bf1693f
+  metadata.gz: 2739c75f8347b76baa6f509f4f5c31c87e3de649490d3c1d3f4c9237062b44e90cb8a0cf47cf4d025b1e9b0539834b0e8641cd6ef6a2302854f0610bf0a3775e
+  data.tar.gz: acecb1df5835c9b3992501e506042c1693364c326545e36d6b0fd6549b48afba0af43808a4a730135ea988bbd4f6a38c14c361d4467361456f668e5bda7fba1e

data/README.md

@@ -1,4 +1,5 @@
 # Callstacking::Rails
+[![Build Status](https://github.com/callstacking/callstacking-rails/actions/workflows/ci.yml/badge.svg)](https://github.com/callstacking/callstacking-rails/actions/workflows/ci.yml)
 
 Call Stacking is a rolling, checkpoint debugger for Rails.  It records all of the critical method calls within your app, along with their important context (param/argument/return/local variable values).  
 

data/exe/callstacking-rails

@@ -1,33 +1,15 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "callstacking/rails/setup"
-require "callstacking/rails/settings"
+require "callstacking/rails"
 
-include Callstacking::Rails::Settings
-
-action = ARGV[0]&.downcase&.strip
+action = Callstacking::Rails::Cli.action(ARGV)
+settings = Callstacking::Rails::Settings.new
 
 if action.nil?
   Callstacking::Rails::Setup.instructions
   exit!(1)
 end
 
-read_settings
-
-case action
-  when 'register'
-    puts "Open the following URL to register:\n\n"
-    puts "  #{settings[:url]}/users/sign_up\n\n"
-
-  when 'setup'
-    Callstacking::Rails::Setup.new.start
-
-  when 'enable'
-    Callstacking::Rails::Setup.new.enable_disable
-    puts "Call Stacking tracing enabled (#{Callstacking::Rails::Env.environment})"
-
-  when 'disable'
-    Callstacking::Rails::Setup.new.enable_disable(enabled: false)
-    puts "Call Stacking tracing disabled (#{Callstacking::Rails::Env.environment})"
-end
+cli = Callstacking::Rails::Cli.new(action, settings)
+cli.run

data/lib/callstacking/rails/cli.rb

@@ -0,0 +1,50 @@
+module Callstacking
+  module Rails
+    class Cli
+      REGISTER = 'register'
+      SETUP = 'setup'
+      ENABLE = 'enable'
+      DISABLE = 'disable'
+
+      attr_reader :action, :settings
+
+      def initialize(action, settings)
+        @action = action
+        @settings = settings
+      end
+
+      def run
+        parse_options
+      end
+
+      def self.action(args)
+        args[0]&.downcase&.strip
+      end
+
+      private
+
+      def parse_options
+        case action
+        when REGISTER
+          puts "Open the following URL to register:\n\n"
+          puts "  #{settings.url}/users/sign_up\n\n"
+          REGISTER
+
+        when SETUP
+          Callstacking::Rails::Setup.new.start
+          SETUP
+
+        when ENABLE
+          settings.enable_disable
+          puts "Call Stacking tracing enabled (#{Callstacking::Rails::Env.environment})"
+          ENABLE
+
+        when DISABLE
+          settings.enable_disable(enabled: false)
+          puts "Call Stacking tracing disabled (#{Callstacking::Rails::Env.environment})"
+          DISABLE
+        end
+      end
+    end
+  end
+end

data/lib/callstacking/rails/client/authenticate.rb

@@ -1,5 +1,4 @@
 require 'json'
-require "callstacking/rails/client/base"
 
 module Callstacking
   module Rails

data/lib/callstacking/rails/client/base.rb

@@ -1,6 +1,5 @@
 require 'faraday'
 require 'faraday/follow_redirects'
-require "callstacking/rails/settings"
 
 module Callstacking
   module Rails
@@ -8,12 +7,12 @@ module Callstacking
       class Error < StandardError; end
 
       class Base
-        include Callstacking::Rails::Settings
+        attr_reader :url, :auth_token
 
-        def initialize
-          read_settings
+        def initialize(url, auth_token)
+          @url = url
+          @auth_token = auth_token
         end
-
         def connection
           # https://github.com/lostisland/awesome-faraday
           @connection ||= Faraday.new(url) do |c|
@@ -25,7 +24,7 @@ module Callstacking
             c.request :json # This will set the "Content-Type" header to application/json and call .to_json on the body
             c.adapter Faraday.default_adapter
 
-            if auth_token?
+            if auth_token.present?
               c.request :authorization, :Bearer, auth_token
             end
           end

data/lib/callstacking/rails/engine.rb

@@ -1,4 +1,6 @@
 require "rails"
+require "active_support/cache"
+require "callstacking/rails/env"
 require "callstacking/rails/trace"
 require "callstacking/rails/instrument"
 require 'callstacking/rails/spans'
@@ -8,18 +10,17 @@ require "callstacking/rails/loader"
 require "callstacking/rails/client/base"
 require "callstacking/rails/client/authenticate"
 require "callstacking/rails/client/trace"
+require "callstacking/rails/cli"
 require "callstacking/rails/traces_helper"
 
 module Callstacking
   module Rails
     class Engine < ::Rails::Engine
-      cattr_accessor :spans, :trace
+      cattr_accessor :spans, :trace, :settings
 
-      include Settings
       isolate_namespace Callstacking::Rails
 
-      read_settings
-
+      @@settings||=Callstacking::Rails::Settings.new
       @@spans||=Spans.new
       @@trace||=Trace.new(@@spans)
 
@@ -31,19 +32,22 @@ module Callstacking
         ActiveSupport.on_load :action_controller do
           include Callstacking::Rails::TracesHelper
         end
-
-        Callstacking::Rails::Loader.new.on_load(@@spans) if enabled?
       end
 
-      initializer :append_before_action do
-        ActionController::Base.send :after_action, :inject_hud
-      end
+      config.after_initialize do
+        if @@settings.enabled?
+          puts "Call Stacking enabled (#{Callstacking::Rails::Env.environment})"
 
-      if enabled?
-        puts "Call Stacking enabled (#{Callstacking::Rails::Env.environment})"
-        trace.tracing
-      else
-        puts "Call Stacking disabled (#{Callstacking::Rails::Env.environment})"
+          ActionController::Base.send :after_action do
+            inject_hud(@@settings)
+          end
+
+          Callstacking::Rails::Loader.new.on_load(@@spans)
+
+          @@trace.tracing
+        else
+          puts "Call Stacking disabled (#{Callstacking::Rails::Env.environment})"
+        end
       end
     end
   end

data/lib/callstacking/rails/settings.rb

@@ -1,18 +1,22 @@
+require "active_support/cache"
 require "active_support/concern"
 require "active_support/core_ext/class/attribute_accessors"
-require "callstacking/rails/env"
 
 module Callstacking
   module Rails
-    module Settings
-      extend ActiveSupport::Concern
-
-      included do |base|
-        attr_accessor :settings
-      end
+    class Settings
+      attr_accessor :settings
+      attr_reader :client
 
       SETTINGS_FILE = "#{Dir.home}/.callstacking"
       PRODUCTION_URL = "https://callstacking.com"
+      ENV_KEY        = 'CALLSTACKING_ENABLED'
+      CACHE_KEY      = :callstacking_enabled
+
+      def initialize
+        read_settings
+        @client = Callstacking::Rails::Client::Authenticate.new(url, auth_token)
+      end
 
       def url
         settings[:url] || PRODUCTION_URL
@@ -30,9 +34,19 @@ module Callstacking
         File.write(SETTINGS_FILE, new_settings.to_yaml)
       end
 
+      def enable!
+        ::Rails.cache.write(CACHE_KEY, true)
+      end
+
+      def disable!
+        ::Rails.cache.write(CACHE_KEY, false)
+      end
+
       def enabled?
+        return ::Rails.cache.read(CACHE_KEY) unless ::Rails.cache.read(CACHE_KEY).nil?
+        return false if ENV[ENV_KEY] == 'false'
         return false if settings.nil?
-        return false if ENV['CALLSTACKING_ENABLED'] == 'false'
+        
         settings[:enabled]
       end
 
@@ -40,8 +54,43 @@ module Callstacking
         !enabled?
       end
 
+      def save(email, password, url)
+        props = { auth_token: '',
+                  url: url,
+                  enabled: true
+        }
+
+        props = { Callstacking::Rails::Env.environment => {
+          settings: props
+        } }
+
+        write_settings(complete_settings.merge(props))
+
+        props[Callstacking::Rails::Env.environment][:settings][:auth_token] = token(email, password)
+
+        write_settings(complete_settings.merge(props))
+
+        read_settings
+      end
+
+      def enable_disable(enabled: true)
+        settings[:enabled] = enabled
+
+        props = { Callstacking::Rails::Env.environment => {
+          settings: settings
+        } }
+
+        write_settings(complete_settings.merge(props))
+      end
+
+      private
+
+      def token(email, password)
+        client.login(email, password)
+      end
+
       def read_settings
-        @@settings = @settings = complete_settings.dig(::Callstacking::Rails::Env.environment, :settings) || {}
+        @settings = complete_settings.dig(::Callstacking::Rails::Env.environment, :settings) || {}
       rescue StandardError => e
         puts e.full_message
         puts e.backtrace.join("\n")

data/lib/callstacking/rails/setup.rb

@@ -1,53 +1,33 @@
 require 'yaml'
-require "callstacking/rails/settings"
-require "callstacking/rails/client/authenticate"
-require "callstacking/rails/env"
 require 'io/console'
 
 module Callstacking
   module Rails
     class Setup
-      include ::Callstacking::Rails::Settings
-      extend ::Callstacking::Rails::Settings
-
-      attr_accessor :client
+      attr_accessor :settings
 
       def initialize
-        read_settings
-      end
-
-      def client
-        @client = Callstacking::Rails::Client::Authenticate.new
+        @settings = Callstacking::Rails::Settings.new
       end
 
       def start
         puts "Login to callstacking.com"
         puts
         
-        email      = prompt("Enter email:")
+        email      = prompt("Enter email:", echo: true)
         password   = prompt("Enter password:", echo: false)
 
-        save(email, password, url)
+        settings.save(email, password, url)
 
         puts "Authentication successful."
-        puts "Settings saved to #{SETTINGS_FILE}"
+        puts "Settings saved to #{Callstacking::Rails::Settings::SETTINGS_FILE}"
         true
       rescue StandardError => e
-        puts "Problem authenticating: #{e.message}"
+        puts "Error authenticating: #{e.message}"
         puts e.backtrace.join("\n")
         false
       end
 
-      def enable_disable(enabled: true)
-        settings[:enabled] = enabled
-
-        props = { Callstacking::Rails::Env.environment => {
-          settings: settings
-        } }
-
-        write_settings(complete_settings.merge(props))
-      end
-
       def prompt(label, echo: true)
         puts label
 
@@ -58,31 +38,7 @@ module Callstacking
         value
       end
 
-      def token(email, password)
-        client.login(email, password)
-      end
-
-      def save(email, password, url)
-        props = { auth_token: '',
-                  url: url,
-                  enabled: true
-        }
-
-        props = { Callstacking::Rails::Env.environment => {
-          settings: props
-        } }
-
-        write_settings(complete_settings.merge(props))
-
-        props[Callstacking::Rails::Env.environment][:settings][:auth_token] = token(email, password)
-
-        write_settings(complete_settings.merge(props))
-
-        read_settings
-      end
-
       def self.instructions
-        read_settings
         puts "loading environment #{Callstacking::Rails::Env.environment}"
         puts
         puts "Usage: "
@@ -94,7 +50,7 @@ module Callstacking
         puts "  > callstacking-rails setup"
         puts
         puts "    Interactively prompts you for your callstacking.com username/password."
-        puts "    Stores auth details in #{SETTINGS_FILE}"
+        puts "    Stores auth details in #{Callstacking::Rails::Settings::SETTINGS_FILE}"
         puts
         puts "  > callstacking-rails enable"
         puts
@@ -107,19 +63,23 @@ module Callstacking
         puts " You can have multiple environments."
         puts " The default is #{Callstacking::Rails::Env::DEFAULT_ENVIRONMENT}."
         puts
-        puts " The #{Callstacking::Rails::Env.environment}: section in the #{SETTINGS_FILE} contains your credentials."
+        puts " The #{Callstacking::Rails::Env.environment}: section in the #{Callstacking::Rails::Settings::SETTINGS_FILE} contains your credentials."
         puts " By setting the RAILS_ENV environment you can maintain multiple settings."
         puts
         puts "Questions? Create an issue: https://github.com/callstacking/callstacking-rails/issues"
+        
+        :instructions
       end
 
       private
 
       def url
-        if Callstacking::Rails::Env.production? && ENV['CALLSTACKING_RAILS_LOCAL_TEST'].nil?
-          PRODUCTION_URL
+        if (Callstacking::Rails::Env.production? || ::Rails.env.test?) &&
+          ENV['CALLSTACKING_RAILS_LOCAL_TEST'].nil?
+          Callstacking::Rails::Settings::PRODUCTION_URL
         else
-          prompt("Enter URL for #{Callstacking::Rails::Env.environment} API calls [#{PRODUCTION_URL}]:") || PRODUCTION_URL
+          prompt("Enter URL for #{Callstacking::Rails::Env.environment} API calls [#{Callstacking::Rails::Settings::PRODUCTION_URL}]:") ||
+              Callstacking::Rails::Settings::PRODUCTION_URL
         end
       end
     end

data/lib/callstacking/rails/trace.rb

@@ -1,29 +1,25 @@
 require "rails"
 require "active_support/concern"
-require "callstacking/rails/client/base"
-require "callstacking/rails/client/authenticate"
-require "callstacking/rails/client/trace"
-require "callstacking/rails/settings"
 
 module Callstacking
   module Rails
     class Trace
-      include Callstacking::Rails::Settings
-
       attr_accessor :spans, :client, :lock
+      attr_reader :settings
       cattr_accessor :current_request_id
 
+      ICON = '💥'
+
       def initialize(spans)
         @traces = []
         @spans  = spans
+        @settings = Callstacking::Rails::Settings.new
 
         @lock   = Mutex.new
-        @client = Callstacking::Rails::Client::Trace.new
+        @client = Callstacking::Rails::Client::Trace.new(settings.url, settings.auth_token)
       end
 
       def tracing
-        read_settings
-
         trace_id = nil
         max_trace_entries = nil
 
@@ -141,7 +137,7 @@ module Callstacking
       end
 
       def print_trace_url(trace_id)
-        url = "#{settings[:url]}/traces/#{trace_id}"
+        url = "#{settings.url}/traces/#{trace_id}"
         
         puts "*" * url.size
         puts url

data/lib/callstacking/rails/traces_helper.rb

@@ -7,11 +7,8 @@ module Callstacking
       include ActionView::Helpers::TagHelper
       include ActionView::Helpers::JavaScriptHelper
       include ActionView::Context
-      include Callstacking::Rails::Settings
-
-      def hud
-        read_settings
 
+      def hud(url)
         frame_url = "#{url || Callstacking::Rails::Settings::PRODUCTION_URL}/traces/#{Callstacking::Rails::Trace.current_request_id}/print"
 
         body = []
@@ -20,7 +17,7 @@ module Callstacking
                             padding: 0px; position: fixed; height: 50px; width: 40px; cursor: pointer;',
                     onclick: 'document.getElementById("callstacking-debugger").style.display = "unset";
                               document.getElementById("callstacking-close").style.display = "unset";') do
-          "<span title='ctrl-d'><center>💥</center></span>".html_safe
+          "<span title='ctrl-d'><center>#{Callstacking::Rails::Trace::ICON}</center></span>".html_safe
         end)
         
         body << (content_tag(:iframe, src: frame_url, id: 'callstacking-debugger', data: { turbo:false },
@@ -45,11 +42,8 @@ module Callstacking
         body.join
       end
 
-      def inject_hud
-        read_settings
-        return unless enabled?
-        
-        response.body = response.body.sub(/<\/body>/i, "#{hud}</body>")
+      def inject_hud(settings)
+        response.body = response.body.sub(/<\/body>/i, "#{hud(settings.url)}</body>")
       end
     end
   end

data/lib/callstacking/rails/version.rb

@@ -1,5 +1,5 @@
 module Callstacking
   module Rails
-    VERSION = "0.1.19"
+    VERSION = "0.1.20"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: callstacking-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.20
 platform: ruby
 authors:
 - Jim Jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-silence
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Quickly visualize which methods call which, their parameters, and return
   values.
 email:
@@ -74,6 +102,7 @@ files:
 - config/routes.rb
 - exe/callstacking-rails
 - lib/callstacking/rails.rb
+- lib/callstacking/rails/cli.rb
 - lib/callstacking/rails/client/authenticate.rb
 - lib/callstacking/rails/client/base.rb
 - lib/callstacking/rails/client/trace.rb