rails-playground 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df198165430aba4c303eda2c7ea181c913f58bfa8314b51ed3d456341746689a
+  data.tar.gz: e25a29c31228b830b9a40890e89e796741407287a9178f8cde7c266d32a1e817
+SHA512:
+  metadata.gz: 04b3f859d616b122bce51a4c624693a6b3cd784f1a398b69b524845f83ec6d01171e5905f6589e2da021b4a006d7f40f955ba21ab03c7314d8c6a1c8ccaac3b6
+  data.tar.gz: 6408f5d0f1b941ae0912fc5404cce2d6722c795990ffeb6f3300722412862fa94f75dbeea2e935d5d3c22476883bb986448c0776adeb8a2461c8e4972dbdeed0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Alexandre Barret
+
+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,67 @@
+# Playground
+
+Back-and-forths from your editor and your rails console is a thing of the past!
+
+![CleanShot 2022-03-12 at 23 41 03](https://user-images.githubusercontent.com/7149034/158014859-47625c95-aa59-489a-9681-eb36e378dcba.gif)
+
+Inspired by the Go playground and SQL Server Management Studio (SSMS) Query Editor, `playground` is a rails engine that makes it really easy to experiment with your application domain.
+
+In addition to a web console, `playground` comes with a script management feature to help your personal and team development. It allows you to:
+* use and save gitignored scripts for personal use. 
+* use and save version-controller scripts with your team. 
+
+This way, shared scripts stay close to the code and more maintainable while your personal script do not pollute the git history.
+
+## Usage
+
+There are three ways to run ruby code in the console:
+
+* Select your code in the editor and press cmd+Enter
+* Put your cursor on any line (no selection) and press cmd+Enter
+* Type your code straight in the terminal box just like in a rails console
+
+## Installation
+
+Playground is built on top of `web-console` gem. Just like `web-console`, `playground` is only meant to be used in development. Every `web-console` information still holds true for `playground`. Check `web-console` [repository for more information](https://github.com/rails/web-console)
+
+
+You can require `playground` after `web-console` in your Gemfile if you already use it. 
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem "playground"
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Then mount `playground` in your routes file and access the playground at `http://localhost:{PORT}/playground` on your local machine.
+```ruby
+Rails.application.routes.draw do
+  mount Playground::Engine => "/playground"
+  # ...
+end
+```
+
+## Troubleshouting
+
+### Session :id is no longer available in memory.
+
+Example:
+```
+Session e96248aec85b3006488c276b9468a4d8 is no longer available in memory.
+
+If you happen to run on a multi-process server (like Unicorn or Puma) the process
+this request hit doesn't store e96248aec85b3006488c276b9468a4d8 in memory. Consider turning the number of
+processes/workers to one (1) or using a different server in development.
+```
+
+This is a known `web-console` error which happened when you run a multi threaded server locally.
+To solve this problem make sure to set the number of processes/worker to 1 on your local server.
+
+## License
+The gem is available as open source under the terms of 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/assets/javascripts/playground/application.js

@@ -0,0 +1,17 @@
+import "@hotwired/turbo-rails"
+import "@rails/request.js"
+import { Application } from "@hotwired/stimulus"
+
+import HelloController from "./controllers/hello_controller"
+import PlaygroundController from "./controllers/playground_controller"
+import SearchScriptsController from "./controllers/search_scripts_controller"
+import SelectScriptController from "./controllers/select_script_controller"
+import CodemirrorController from "./controllers/codemirror_controller"
+
+window.Stimulus = Application.start()
+
+Stimulus.register("hello", HelloController)
+Stimulus.register("playground", PlaygroundController)
+Stimulus.register("search-scripts", SearchScriptsController)
+Stimulus.register("select-script", SelectScriptController)
+Stimulus.register("codemirror", CodemirrorController)

data/app/assets/javascripts/playground/controllers/codemirror_controller.js

@@ -0,0 +1,49 @@
+import { Controller } from "@hotwired/stimulus"
+import { EditorView, keymap } from "@codemirror/view"
+import { EditorState, Prec } from "@codemirror/state"
+import { basicSetup } from "@codemirror/basic-setup"
+import { indentWithTab } from "@codemirror/commands"
+import { StreamLanguage } from "@codemirror/stream-parser"
+import { ruby } from "@codemirror/legacy-modes/mode/ruby"
+
+export default class extends Controller {
+  static values = { script: String }
+
+  connect() {
+    this.editor = new EditorView({
+      parent: this.element,
+      state: EditorState.create({
+        doc: this.scriptValue,
+        extensions: [
+          basicSetup,
+          StreamLanguage.define(ruby),
+          Prec.high(keymap.of([{key: "Mod-Enter", run: () => this.submitCodeSelected}])),
+          keymap.of([indentWithTab])
+        ]
+      })
+    })
+  }
+
+  get submitCodeSelected() {
+    const event = new CustomEvent('codeSubmission', { detail: { selection: this.selectedBlock } });
+    this.element.dispatchEvent(event);
+    return true
+  }
+
+  get selection() {
+    return this.editor.state.selection.main
+  }
+
+  get doc() {
+    return this.editor.state.doc
+  }
+
+  get selectedBlock() {
+    const { from, to } = this.selection
+    if (from != to) {
+      return this.doc.toString().slice(from, to)
+    } else {
+      return this.doc.lineAt(from).text
+    }
+  }
+}

data/app/assets/javascripts/playground/controllers/hello_controller.js

@@ -0,0 +1,7 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    console.log("Hello World!", this.element)
+  }
+}

data/app/assets/javascripts/playground/controllers/playground_controller.js

@@ -0,0 +1,12 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  connect() {
+    this.console = REPLConsole.installInto('console')
+  }
+
+  runCode(event) {
+    this.console.setInput(event.detail.selection)
+    this.console.onEnterKey()
+  }
+}

data/app/assets/javascripts/playground/controllers/search_scripts_controller.js

@@ -0,0 +1,20 @@
+import { Controller } from "@hotwired/stimulus"
+import { get } from "@rails/request.js"
+
+export default class extends Controller {
+  static targets = ['input']
+  static values = { url: String }
+
+  debounce(callback, time) {
+    window.clearTimeout(this.debounceTimer);
+    this.debounceTimer = window.setTimeout(callback, time);
+  }
+
+  getScripts(event) {
+    let callback = () => get(this.urlValue, {
+      query: { name: event.target.value }
+    })
+
+    this.debounce(callback, 500)
+  }
+}

data/app/assets/javascripts/playground/controllers/select_script_controller.js

@@ -0,0 +1,8 @@
+import { Controller } from "@hotwired/stimulus"
+import { get } from "@rails/request.js"
+
+export default class extends Controller {
+  getScript(event) {
+    get(event.target.value)
+  }
+}

data/app/assets/stylesheets/playground/application.scss

@@ -0,0 +1,28 @@
+body#playground { max-width:900px; margin:auto; padding:0 1rem;
+  .console { margin-top:1rem;
+    position: relative; border: .5rem solid black;
+    .console-outer {
+      position:unset;
+    }
+  }
+
+  .console-actions { display: none;}
+
+  .code { flex-grow:1; height:550px; position: relative; }
+  .sidebar { margin-right:1rem;}
+
+  input, select, .console {
+    -webkit-box-sizing:border-box;
+       -moz-box-sizing:border-box;
+            box-sizing:border-box;
+  }
+
+  select { font-size:0.7em; padding:1rem; height:100%; max-height:500px; }
+  input { margin-bottom:0.5rem; padding:0.5rem;}
+  select, input { width:200px; }
+
+  [data-controller="codemirror"] { height:100%;
+    .cm-scroller { overflow: auto }
+    .cm-editor { position:absolute !important; top:0; right:0; bottom:0; left:0; }
+  }
+}

data/app/controllers/playground/application_controller.rb

@@ -0,0 +1,4 @@
+module Playground
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/playground/consoles_controller.rb

@@ -0,0 +1,7 @@
+module Playground
+  class ConsolesController < ApplicationController
+    def show
+      console
+    end
+  end
+end

data/app/controllers/playground/scripts_controller.rb

@@ -0,0 +1,49 @@
+module Playground
+  class ScriptsController < ApplicationController
+    def index
+      @scripts = script_paths
+
+      if params[:name]
+        @scripts = @scripts.select { |script| script.downcase.match? params[:name].downcase }
+      end
+    end
+
+    def show
+      @_script = File.read script_path(params[:name])
+    end
+
+    def new
+      @_script = <<~SCRIPT
+      # Access your application domain as if you were in a rails console.
+      # There are three ways to run code in the console:
+
+      # 1 - Select all the code from line 5 to 11 and press cmd+Enter
+      module HelloWorld
+        module_function
+
+        def hello
+          "Hello, World!"
+        end
+      end
+
+      # 2 - Put your cursor on line 14 (no selection) and press cmd+Enter
+      HelloWorld.hello
+
+      # 3 - Type "HelloWorld.hello" in the terminal box below and press cmd+Enter
+      SCRIPT
+
+      render :show
+    end
+
+    private
+
+    def script_path(name)
+      script_paths.find { |path| path == name }
+    end
+
+    def script_paths
+      Dir[Rails.root.join("lib", "playground", "**", "*")]
+        .reject {|fn| File.directory?(fn) }
+    end
+  end
+end

data/app/helpers/playground/application_helper.rb

@@ -0,0 +1,4 @@
+module Playground
+  module ApplicationHelper
+  end
+end

data/app/helpers/playground/consoles_helper.rb

@@ -0,0 +1,4 @@
+module Playground
+  module ConsolesHelper
+  end
+end

data/app/helpers/playground/scripts_helper.rb

@@ -0,0 +1,34 @@
+module Playground
+  module ScriptsHelper
+    MAX_SELECT_BOX_SIZE = 15
+
+    def script_size(scripts)
+      [MAX_SELECT_BOX_SIZE, scripts.length + 1].min
+    end
+
+    def script_options(scripts)
+      options = scripts
+        .map { |path| [script_label(path), url(path)] }
+        .unshift(["New script", new_script_path(format: :turbo_stream)])
+
+      options_for_select options
+    end
+
+    private
+
+    def script_label(path)
+      Pathname(path)
+        .basename
+        .to_s
+        .truncate(30)
+    end
+
+    def script_pathname
+      Rails.root.join("lib").to_s
+    end
+
+    def url(path)
+      script_scripts_path(name: path, format: :turbo_stream)
+    end
+  end
+end

data/app/jobs/playground/application_job.rb

@@ -0,0 +1,4 @@
+module Playground
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/playground/application_mailer.rb

@@ -0,0 +1,6 @@
+module Playground
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/playground/application_record.rb

@@ -0,0 +1,5 @@
+module Playground
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/playground/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Playground</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= javascript_include_tag "playground/application", skip_pipeline: true, nonce: true, media: "all" %>
+  <%= stylesheet_link_tag "/stylesheets/playground/application", media: "all" %>
+</head>
+  <body id="playground">
+    <%= yield %>
+  </body>
+</html>

data/app/views/playground/consoles/show.html.erb

@@ -0,0 +1,20 @@
+<h1 data-controller="hello">Playground</h1>
+
+<div style="display:flex;">
+  <div class="sidebar">
+    <div
+      data-controller="search-scripts"
+      data-search-scripts-url-value="<%= scripts_path(format: :turbo_stream) %>">
+      <%= text_field_tag :search, "",
+        placeholder: 'search for scripts',
+        data: { action: 'input->search-scripts#getScripts' }
+      %>
+    </div>
+
+    <%= turbo_frame_tag :scripts, src: scripts_path(format: :turbo_stream) %>
+  </div>
+
+  <div class="code" data-controller="playground">
+    <%= turbo_frame_tag :script, src: new_script_path(format: :turbo_stream) %>
+  </div>
+</div>

data/app/views/playground/scripts/_script.html.erb

@@ -0,0 +1,5 @@
+<div
+  data-controller="codemirror"
+  data-codemirror-script-value="<%= @_script %>"
+  data-action="codeSubmission->playground#runCode">
+</div>

data/app/views/playground/scripts/_script_select_box.html.erb

@@ -0,0 +1,3 @@
+  <div id="scripts" data-controller="select-script">
+    <%= select_tag :scripts, script_options(scripts) , size: script_size(scripts), data: {action: 'change->select-script#getScript'} %>
+  </div>

data/app/views/playground/scripts/index.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'script_select_box', locals: { scripts: @scripts } %>

data/app/views/playground/scripts/index.turbo_stream.erb

@@ -0,0 +1 @@
+<%= turbo_stream.update :scripts, partial: 'script_select_box', locals: { scripts: @scripts } %>

data/app/views/playground/scripts/show.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'script', locals: { script: @_script } %>

data/app/views/playground/scripts/show.turbo_stream.erb

@@ -0,0 +1 @@
+<%= turbo_stream.update :script, partial: 'script', locals: { script: @_script } %>

data/config/routes.rb

@@ -0,0 +1,6 @@
+Playground::Engine.routes.draw do
+  root 'consoles#show'
+  resources :scripts, only: [:index, :new] do
+    get :script, on: :collection, to: "scripts#show"
+  end
+end

data/lib/playground/engine.rb

@@ -0,0 +1,14 @@
+module Playground
+  class Engine < ::Rails::Engine
+    isolate_namespace Playground
+
+    initializer "playground.web_console_templates" do |app|
+      template_paths =  File.expand_path("../templates", __FILE__)
+      WebConsole::Template.template_paths.unshift(*Array(template_paths))
+    end
+
+    initializer "playground.assets" do |app|
+      app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/vendor")
+    end
+  end
+end

data/lib/playground/templates/index.html.erb

@@ -0,0 +1,22 @@
+<% if playground_page? %>
+
+  <%= render 'markup' %>
+
+  <%= render_javascript 'console' %>
+
+<% else %>
+
+  <%= render 'markup' %>
+
+  <%= render_javascript 'console' %>
+  <%= render_javascript 'main' %>
+
+  <% only_on_error_page do %>
+    <%= render_javascript 'error_page' %>
+  <% end %>
+
+  <% only_on_regular_page do %>
+    <%= render_javascript 'regular_page' %>
+  <% end %>
+
+<% end %>

data/lib/playground/version.rb

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

data/lib/playground.rb

@@ -0,0 +1,20 @@
+require "web-console"
+
+WebConsole::View.class_eval do
+  def playground_page?
+    @playground_page ||= begin
+      # {:controller=>"playground/consoles", :action=>"show"}
+      path_parameters = @env["action_dispatch.request.path_parameters"]
+      path_parameters[:controller] == "playground/consoles" &&
+      path_parameters[:action] == "show"
+    end
+  end
+end
+
+require "turbo-rails"
+require "playground/version"
+require "playground/engine"
+
+module Playground
+
+end

data/lib/tasks/playground_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :playground do
+#   # Task goes here
+# end