mrujs_rails 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cbc85edb9ee8d9b42a5af5a006a0c5a3b00e394c651779f344d83d0c06005f66
+  data.tar.gz: 8ec09f13eeadcf3b68a34d589580ab1db7c4f184b3be34f87c3828e40ef133ee
+SHA512:
+  metadata.gz: 2eb0687c751f50fad6a167a3ac6318e044b928dcef3f8ef59e904fd00835580ff204489d9fdce72578f6f53c696392550e5fc644246d9fa1c2d277d295a88b40
+  data.tar.gz: 9868bf1819031b3f54121d09c1ef6b0c5739074e275e2bbba76cebe331e37c67eeb80a9ac44f10f6ad03325ea02fa888d853acf73df6e4c6ae889b4cf1ca8729

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 TODO: Write your name
+
+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,351 @@
+# Purpose
+
+To provide a Rails-UJS alternative since Rails UJS is currently
+deprecated. Uses modern javascript instead of coffeescript.
+
+
+## What does mrujs mean?
+
+Modern Rails UJS.
+
+## Does this support `.js.erb`
+
+No. Rails 6.1+ requires a change in the content-security policy in relation to running
+arbitrary javascript scripts which means `.js.erb` is not supported.
+`.js.erb` is a security concern, and also requires a lot of `nonce` code generation and checks to work properly.
+
+## What can it do right now?
+
+In it's current state, Mrujs is a native fetch wrapper and
+a form wrapper that can marshal an HTML / JSON / XML / any response
+you want and can be listened for via event listeners. For
+a list of things to be implemented in the future, checkout
+the [Roadmap](#roadmap) below.
+
+## Getting Started
+
+1. Install `mrujs`
+
+```bash
+yarn add mrujs
+```
+
+2. Go to your Webpacker entrypoint and import `mrujs` and start it up.
+
+```js
+// app/javascript/packs/application.js
+
+// ... other stuff
+
+import mrujs from "mrujs";
+window.mrujs = mrujs.start();
+```
+
+3. Using on a form
+
+If using Turbo, make sure to set Turbo to false.
+
+```erb
+<%= form_with scope: Model, data: {remote: "true", turbo: "false"} do |form| %>
+  <%= form.label :name %>
+  <%= form.text_field :name %>
+
+  <%= form.submit "Submit", data-disable-with: "Submitting..." %>
+<%= end %>
+
+<form action="/" method="post" data-remote="true" data-turbo="false">
+  <input id="foo" name="foo">
+  <input type="submit" value="Submit">
+</form>
+```
+
+4. Stopping Mrujs
+
+If you would like to stop Mrujs, feel free to do the following:
+
+```js
+window.mrujs.stop();
+```
+
+This will remove all mutation observers and event listeners.
+
+## Ajax
+
+### Events
+
+All events bubble and are cancellable by default.
+
+Bubbling means they will always start from the form that submits it and
+continue upwards all the way to the top of the DOM. Bubbling can be
+stopped via `event.stopImmediatePropagation()`. I also allowed events to
+be preventable. IE: `event.preventDefault()` on an ajax event will cause
+it to stop running.
+
+A `fetch` request or `data-remote="true"` form will emit the following events:
+
+<details>
+<summary>List of AJAX events</summary>
+
+```js
+const AJAX_EVENTS = {
+  /**
+   * Before the ajax event gets sent.
+   * You can view what data will be sent via: `event.detail.request`
+   */
+  ajaxBefore: `ajax:before`,
+
+  /**
+   * When the fetch request is sent. You can view whats being sent via:
+   * `event.detail.request`
+   */
+  ajaxSend: `ajax:send`,
+
+  /**
+   * When a response error occurs. IE: 400, 404, 422, 500, etc (any status code not between 200 - 299)
+   * The response error can be viewed via: `event.detail.response`
+   */
+  ajaxResponseError: `ajax:response:error`,
+
+   /**
+    * When a >= 200 and <= 299 response is returned
+    * You can view the full response via: `event.detail.response`
+    */
+  ajaxSuccess: `ajax:success`,
+
+  /**
+   * When an actual error is raised. This doesnt include 404, 500,
+   * errors, just like native fetch.
+   * You can view the error via: `event.detail.error`
+   * This will also generate an error in your console.log
+   */
+  ajaxError: `ajax:error`,
+
+
+  /**
+   * After any fetch request, regardless of outcome
+   * Does not have any accessible data besides the event itself
+   */
+  ajaxComplete: `ajax:complete`,
+
+  // NOT CURRENTLY IMPLEMENTED from ujs
+  `ajax:aborted:required`
+  `ajax:aborted:file`
+}
+```
+
+</details>
+
+#### Cancelling Events
+
+<details>
+<summary> How to cancel AJAX events </summary>
+
+You can cancel events at anytime simply by calling `event.preventDefault()` or
+`event.stopImmediatePropagation()`:
+
+Example:
+
+```js
+document.querySelector("form").addEventListener("ajax:before", (event) => {
+  event.preventDefault();
+})
+
+
+document.querySelector("form").addEventListener("ajax:before", (event) => {
+  event.stopImmediatePropagation();
+})
+
+// For extra certainty
+document.querySelector("form").addEventListener("ajax:before", (event) => {
+  event.preventDefault();
+  event.stopImmediatePropagation();
+})
+
+```
+
+`ajax:send` is a special case and must be aborted with an abort
+controller.
+</details>
+
+### Fetch
+
+Fetch is called like you would expect. Except it will also prefill the
+`X-CSRF-TOKEN` for you. The difference between
+`window.fetch` and `mrujs.fetch` is that the first argument for the url
+is positional in `window.fetch`, but in `mrujs.fetch` it is required as part of the object.
+
+`mrujs.fetch` can also leverage the events listed above for Ajax and
+fire the `ajax:<lifecycle>` events if `dispatchEvents === true`. When
+called this way, `mrujs.fetch` will not return a promise. Instead you
+should listen for `ajax:success` and then parse the response from
+`event.detail.response`.
+
+```js
+document.addEventListener("ajax:success", (event) => {
+  // equivalent to fetch().then((response) => response)
+  event.detail.response
+})
+```
+
+#### Examples
+
+```js
+// Native Fetch
+window.fetch("/url", { ... })
+  .then((response) => ...)
+  .catch((error) => ...)
+
+// mrujs fetch
+window.mrujs.fetch({url: "/url", ...})
+  .then((response) => ...)
+  .catch((error) => ...)
+
+// If you would prefer, you can also listen to the above ajax events.
+// `mrujs.fetch({url: "/url", dispatchEvents: true})` fires all the above listed ajax events, `ajax:before`, `ajax:send`, etc
+
+// mrujs fetch with events
+
+window.mrujs.fetch({url: "url", method: "POST", dispatchEvents: true})
+window.addEventListener("ajax:success", (event) => doStuff(event.detail.response))
+```
+
+To *receive* a `json` response, make sure to set the `Accept` header to
+`"application/json"` like so:
+
+```js
+window.mrujs.fetch({
+  url: "/url",
+  "Accept": "application/json"
+}).then(response => {}).catch(error => {})
+```
+
+To *send* a `json` payload, make sure to set the `Content-Type` header to
+`"application/json"` like so:
+
+```js
+window.mrujs.fetch({
+  url: "/url",
+  "Content-Type": "application/json"
+}).then(response => {}).catch(error => {})
+```
+
+#### Using native fetch
+
+Maybe you dont like my fetch wrapper, thats fine! To use native fetch
+heres all you have to do to include the CSRF-Token.
+
+```js
+import mrujs from "mrujs"
+
+window.mrujs =  mrujs.start()
+window.fetch("url", {
+  headers: {
+    "X-CSRF-TOKEN": window.mrujs.csrfToken
+  }
+})
+```
+
+### Remote forms
+
+Remote forms can also negotiate the proper `Accept` headers. To do so,
+set the `data-response='json'` to tell the server you can only accept
+json.
+
+<details>
+<summary> List of predefined `data-response` values </summary>
+
+```js
+  '*': '*/*',
+  any: '*/*',
+  text: 'text/plain',
+  html: 'text/html',
+  xml: 'application/xml, text/xml',
+  json: 'application/json, text/javascript',
+```
+
+The above are all predefined for you
+</details>
+
+Example:
+
+```html
+<!-- Sends a `application/json` and `text/javascript` accept header. -->
+<form data-remote="true" data-response="json">
+</form>
+
+<!-- Sends an XML accept header -->
+<form data-remote="true" data-response="application/xml">
+</form>
+
+<!-- Sends a default '*/*' Accept header. -->
+<form data-remote="true">
+</form>
+```
+
+## Roadmap
+
+- [ ] - Alias `window.Rails` to `window.mrujs` (Allows drop in
+replacement)
+- [ ] - Allow the use of `data-confirm=""`
+- [ ] - Provide a confirm dialog for `data-confirm`
+- [ ] - Allow users to provide their own confirm function to `data-confirm`
+- [ ] - Allow `ajax:send` to be cancelled via abort controllers.
+
+<details>
+<summary> Example of `data-confirm` </summary>
+
+```html
+<!-- Uses user provided HTML -->
+<a href="blah" data-method="delete" data-confirm="<p>Are you
+sure?</p>">
+  Logout
+</a>
+
+<!-- Uses a web component modal -->
+<a href="/blah" data-method="delete" data-confirm="Are you
+sure you want to logout?">
+  Logout
+</a>
+
+<!-- Uses a regular alert -->
+<a href="/blah" data-method="delete" data-confirm="Are you
+sure you want to logout?" data-use-alert="true">
+  Logout
+</a>
+```
+
+</details>
+
+- [ ] - add support for `data-method="<REQUEST_TYPE>"` for non-forms
+- [ ] - Asset pipeline, if someone would like to add support im open to
+it.
+- [x] - `data-response='type'` for forms.
+- [ ] - Other UJS features deemed necessary.
+
+## Developing locally
+
+1. Clone the repo
+
+```bash
+git clone https://github.com/ParamagicDev/mrujs
+cd mrujs
+```
+
+2. Install packages
+
+```bash
+yarn install
+```
+
+### View Dev Server
+
+```bash
+yarn start
+```
+
+### Run tests
+
+```bash
+yarn test
+```
+

data/Rakefile

@@ -0,0 +1,20 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/ruby/dummy/Rakefile", __dir__)
+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/ruby"
+  t.pattern = "test/ruby/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test
+
+require "standard/rake"

data/lib/mrujs_rails.rb

@@ -0,0 +1,6 @@
+require "mrujs_rails/version"
+require "mrujs_rails/engine"
+
+module MrujsRails
+  # Your code goes here...
+end

data/lib/mrujs_rails/engine.rb

@@ -0,0 +1,5 @@
+module MrujsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace MrujsRails
+  end
+end

data/lib/mrujs_rails/version.rb

@@ -0,0 +1,3 @@
+module MrujsRails
+  VERSION = "0.0.6"
+end

data/lib/tasks/mrujs_rails_tasks.rake

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: mrujs_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- ParamagicDev
+- Leastbad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.2
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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: 
+email:
+- konnor5456@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mrujs_rails.rb
+- lib/mrujs_rails/engine.rb
+- lib/mrujs_rails/version.rb
+- lib/tasks/mrujs_rails_tasks.rake
+homepage: https://github.com/paramagicdev/mrujs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/paramagicdev/mrujs
+  source_code_uri: https://github.com/paramagicdev/mrujs
+  changelog_uri: https://github.com/paramagicdev/mrujs/tree/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A rails plugin for mrujs to make Turbolinks work.
+test_files: []