trailblazer-pro-rails 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bb335727395a5d68805e4f858838d849e90cfb893f0706b5643402c7e085ece
+  data.tar.gz: 415bcfac3c4d618c773b5b8d1d54ae403598e472d36ca6a807845066031701a3
+SHA512:
+  metadata.gz: f11b6219da35f9f97a6ff33f32eeb3fb5104bdb2cf1697986cc0731221e680ec979810021f52490611b27376456123d644365a0a83c52540c80ba910ed70c8fb
+  data.tar.gz: 856c418262916245973db47aa02f45b6c30f1df50ede906fd5a6c48fe5ff058cc0ceba746f69f750e2e9c8e4d1e2bca700d380830edb7dd1d73595e7bf674a28

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.0.2]
+
+- Initial release
+
+## [0.0.1]
+
+- Unreleased

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in trailblazer-pro-rails.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/README.md

@@ -0,0 +1,50 @@
+# Trailblazer::Pro::Rails
+
+## Installation
+
+In your Rails' `Gemfile`.
+
+```ruby
+gem "trailblazer-pro-rails"
+```
+
+## Usage
+
+1. Get your API key from https://pro.trailblazer.to/settings
+2. Run our generator and enter your API key.
+    ```
+    $ rails g trailblazer:pro:install
+
+    ```
+3. Run your operation via `#WTF?`.
+    ```ruby
+    result = API::V1::Diagram::Operation::Update.WTF?(params: params)
+    ```
+
+4. Click the `[TRB PRO]` link in your terminal and start debugging.
+
+![Our web debugger in action.](docs/debugger-ide-screenshot-august.png)
+
+Note: we're currently playing with various invocation styles and at some point you might not even have to use `Operation.wtf?` anymore.
+
+
+
+## Testing
+
+Currently, from the top directory, you need to run
+
+```ruby
+$ rake test_1
+```
+This will test the generator on a new Rails app in isolation.
+
+```ruby
+$ rake test_2
+```
+
+Tests if `wtf?` works without any PRO configuration, but PRO is added.
+
+
+### Architecture
+
+* One `Gemfile` for all scenarios on `test/dummies`

data/Rakefile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test
+
+
+# test_uninitialized_generator
+Rake::TestTask.new(:test_1) do |t|
+  t.test_files = FileList["test/dummies/uninitialized/test/generator_test.rb"]
+end
+
+# test wtf? in different scenarios
+Rake::TestTask.new(:test_2) do |t|
+  t.test_files = FileList["test/dummies/uninitialized/test/railtie_test.rb"]
+end

data/lib/trailblazer/pro/rails/generator.rb

@@ -0,0 +1,26 @@
+module Trailblazer
+
+  module Pro
+    class Install < ::Rails::Generators::Base
+      # source_root File.expand_path("templates", __dir__)
+
+      def prompt_for_api_key
+        input = ask %(Your Trailblazer PRO API key:)
+        # TODO: blank
+        return if input.blank?
+
+        @api_key = input.chomp
+      end
+
+      def create_session_file
+        return if @api_key.nil? # FIXME: use Trailblazer instead of thor's basic control flow.
+
+        create_file Rails::SESSION_PATH do
+          uninitialized_session = Trailblazer::Pro::Session::Uninitialized.new(api_key: @api_key, trailblazer_pro_host: "https://pro.trailblazer.to")
+
+          Trailblazer::Pro::Session.serialize(uninitialized_session)
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/pro/rails/railtie.rb

@@ -0,0 +1,42 @@
+module Trailblazer
+  module Pro
+    module Rails
+      class Railtie < ::Rails::Railtie
+        config.trailblazer = ActiveSupport::OrderedOptions.new # TODO: test me with trailblazer-rails
+        config.trailblazer.pro = ActiveSupport::OrderedOptions.new
+        config.trailblazer.pro.render_wtf = true
+
+        # load session and set Pro::Session.session
+        initializer "trailblazer-pro-rails.load_session_and_extend_operation" do
+          Trailblazer::Operation.extend(Pro::Operation::WTF)  # TODO: only apply to selected OPs or make at least configurable?
+
+          config_options = {
+            render_wtf: config.trailblazer.pro.render_wtf,
+          }
+
+          if File.exist?(Rails::SESSION_PATH)
+            # TODO: warn if file not present etc.
+            json = File.read(Rails::SESSION_PATH)
+
+            Pro.initialize!(**Session.deserialize(json), **config_options)
+
+            trace_operations = config.trailblazer.pro.trace_operations
+
+            if trace_operations
+              # constants can be passed as strings to avoid autoloading issues.
+              trace_operations = trace_operations.collect { |klass, config| [klass.constantize, config] }.to_h
+
+              Pro.trace_operations!(trace_operations)
+            end
+
+            # TODO: add {Activity.invoke} here, too!
+            # Trailblazer::Activity.extend(Pro::Call::Activity) # FIXME: only if allowed! # TODO: only apply to selected OPs.
+          else # no configuration happend, yet.
+            Pro.initialize!(api_key: "")
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/trailblazer/pro/rails/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Trailblazer
+  module Pro
+    module Rails
+      VERSION = "0.0.2"
+    end
+  end
+end

data/lib/trailblazer/pro/rails/wtf.rb

@@ -0,0 +1,26 @@
+module Trailblazer
+  module Pro
+    module Rails
+      # Save the session in tmp/ if it changed after invocation.
+      module Wtf
+        extend Pro::Trace::Wtf
+        module_function
+
+        def call(*args, present_options: {}, **options)
+          returned = super(*args, present_options: present_options, **options)
+
+          (session, trace_id, debugger_url, _trace_envelope, session_updated) = returned[-1]
+
+          if session_updated
+            File.write(Rails::SESSION_PATH, Session.serialize(session)) # DISCUSS: redundant
+          end
+
+          returned
+        end
+
+        # alias invoke call
+        singleton_class.alias_method :invoke, :call
+      end
+    end
+  end
+end

data/lib/trailblazer/pro/rails.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "rails/version"
+
+module Trailblazer
+  module Pro
+    module Rails
+      SESSION_PATH = "tmp/trb-pro/session"
+    end
+  end
+end
+
+require "rails/generators"
+require "trailblazer/pro"
+require "trailblazer/pro/rails/railtie"
+require "trailblazer/pro/rails/generator"
+require "trailblazer/pro/rails/wtf"

data/lib/trailblazer-pro-rails.rb

@@ -0,0 +1 @@
+require_relative "trailblazer/pro/rails"

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: trailblazer-pro-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nick Sutterer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: trailblazer-pro
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: 
+email:
+- apotonick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- docs/debugger-ide-screenshot-august.png
+- lib/trailblazer-pro-rails.rb
+- lib/trailblazer/pro/rails.rb
+- lib/trailblazer/pro/rails/generator.rb
+- lib/trailblazer/pro/rails/railtie.rb
+- lib/trailblazer/pro/rails/version.rb
+- lib/trailblazer/pro/rails/wtf.rb
+homepage: https://trailblazer.to/2.1/pro
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Rails support for Trailblazer PRO.
+test_files: []