rails-playground 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b917e43620b4e703b4b826f87f5be69b7c541d79be6d47637d95e8375e31017c
-  data.tar.gz: c45d1fb0ce17fd85cc8151d57a27139caa51f902e2fb513afe53e8c9cd3d6b9f
+  metadata.gz: 6d3e5a3ae8b3a38899b61d42c37b61b13f1820c612c57198a3f2641b7d8aea2c
+  data.tar.gz: c970296e4765132b69025b20219ee1139602b55f592e228fd05ad3b94ca4848c
 SHA512:
-  metadata.gz: dd51b76541ea6d549d3dfa0df68b575e07e2f57f0e6010fc3239c87597d8ba5dba5302d193905ca3a95fe077732c016227d4ce1ea05b26e6afa849f7db226411
-  data.tar.gz: 5820201bf6cb9220511d7ffa66a4048b535c14cc908648037f063cf278db2ff07653d8e202f572f8e0feb9434153ae79b8c77541eb1d4338f242c13617e9c865
+  metadata.gz: 10aa1fb4f1ad7bd86133ead919c4fe1a437b02437f4bb732ade6de3d27239066c494aaea6a6b553566590fa1e5ec592656885bec52062016a9d46e15644216ff
+  data.tar.gz: f2feb2be90d401bf5d02133e13022dece8f6fad2256093470ae47d192c57380cb49eb78b363b09f2189751589ce85cbfac1c9a0babe3d6e4920f1c7448a1c59a

data/README.md

@@ -1,53 +1,110 @@
-# Playground
+# (Rails) 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)
+![playground-demo](https://user-images.githubusercontent.com/7149034/158045230-3129bf4e-8eeb-4096-9293-04a8c6003bed.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.
+## Features
 
-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. 
+### Query Editor
 
-This way, shared scripts stay close to the code and more maintainable while your personal script do not pollute the git history.
+Inspired by the Go playground and SQL Server Management Studio (SSMS) Query Editor, `rails-playground` is a rails engine that eases experiments with your application domain.
+
+### Script Management
+
+The gem also comes with a script management tool to help share useful scripts with your teammates. Shared scripts stay close to the code and become more maintainable while personal scripts are git ignored and don't pollute the git history.
 
 ## Usage
 
+### Query Editor
+
 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
 
+### Script Management
+
+Any files under `lib/playground` folder will appear in the sidebar. You can filter them by name from the search input.
+
+See [Ignoring personal scripts](#ignoring-personal-scripts) to share scripts with your team while ignoring personal scripts.
+
 ## 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)
+### Query Editor
 
+Playground is built on top of `web-console` gem. Just like `web-console`, it's only meant to be used in development. Every `web-console` information still holds for `rails-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:
+Add this line to your application's Gemfile under the development group:
 
 ```ruby
 group :development do
-  gem "playground"
+  gem "rails-playground", require: "playground"
 end
 ```
 
+_**Naming issue:** The gem was originally called `playground` but it already exists in RubyGems... Thus the gem is now called `rails-playground` but the functionality remains under the `playground` namespace for now._
+
 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.
+Finally, mount the engine in your routes file and access the web playground at `/playground` on your localhost.
+
 ```ruby
 Rails.application.routes.draw do
-  mount Playground::Engine => "/playground"
+  mount Playground::Engine => "/playground" if Rails.env.development?
   # ...
 end
 ```
 
-## Troubleshouting
+_Nothing stops you from choosing any relative path. For example, you could switch from `/playground` to `/rails/play`._
+
+### Ignoring personal scripts
+
+Any changes made to ignored scripts won't be recorded in your git history.
+Adding a folder from lib/playground in `.gitignore` will, however, still show in the sidebar.
+**Decide on a convention** with your teammates and commit the path to your `.gitignore`.
+
+**Example**
+
+Here is an example of file structure
+
+* scripts version controlled
+  * lib/playground/shared_script_a.rb
+  * lib/playground/shared_script_b.rb
+  * lib/playground/namespace/shared_script_c.rb
+* scripts ignored
+  * lib/playground/my_scripts/my_script_a.rb
+  * lib/playground/my_scripts/my_script_b.rb
+
+```
+.gitignore
+
+/lib/playground/my_scripts/
+```
+
+```
+my_app/
+├─ app/
+├─ bin/
+├─ config/
+├─ db/
+├─ lib/
+│  ├─ playground/
+│  │  ├─ namespace/
+│  │  │  ├─ shared_script_c.rb
+│  │  ├─ my_scripts/
+│  │  │  ├─ my_script_a.rb
+│  │  │  ├─ my_script_b.rb
+│  │  ├─ shared_script_a.rb
+│  │  ├─ shared_script_b.rb
+├─ .gitignore
+```
+
+## Troubleshooting
 
 ### Session :id is no longer available in memory.
 
@@ -60,7 +117,7 @@ this request hit doesn't store e96248aec85b3006488c276b9468a4d8 in memory. Consi
 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.
+This is a known `web-console` error that happens 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

data/lib/playground/version.rb

@@ -1,3 +1,3 @@
 module Playground
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-playground
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Alexandre Barret
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: web-console
@@ -48,13 +48,13 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/javascripts/playground/application.js
-- app/assets/javascripts/playground/controllers/codemirror_controller.js
-- app/assets/javascripts/playground/controllers/hello_controller.js
-- app/assets/javascripts/playground/controllers/playground_controller.js
-- app/assets/javascripts/playground/controllers/search_scripts_controller.js
-- app/assets/javascripts/playground/controllers/select_script_controller.js
-- app/assets/stylesheets/playground/application.scss
+- app/assets/javascripts/application.js
+- app/assets/javascripts/controllers/codemirror_controller.js
+- app/assets/javascripts/controllers/hello_controller.js
+- app/assets/javascripts/controllers/playground_controller.js
+- app/assets/javascripts/controllers/search_scripts_controller.js
+- app/assets/javascripts/controllers/select_script_controller.js
+- app/assets/stylesheets/application.scss
 - app/controllers/playground/application_controller.rb
 - app/controllers/playground/consoles_controller.rb
 - app/controllers/playground/scripts_controller.rb
@@ -81,12 +81,12 @@ files:
 - vendor/javascripts/playground/application.js
 - vendor/stylesheets/playground/application.css
 - vendor/stylesheets/playground/application.css.map
-homepage: https://github.com/AlexB52/playground
+homepage: https://github.com/AlexB52/rails-playground
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/AlexB52/playground
-  source_code_uri: https://github.com/AlexB52/playground
+  homepage_uri: https://github.com/AlexB52/rails-playground
+  source_code_uri: https://github.com/AlexB52/rails-playground
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -105,5 +105,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: A playground web console for Rails applications.
+summary: A local playground for Rails applications.
 test_files: []