mrujs_rails 0.0.6 → 0.1.0.pre.beta.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbc85edb9ee8d9b42a5af5a006a0c5a3b00e394c651779f344d83d0c06005f66
-  data.tar.gz: 8ec09f13eeadcf3b68a34d589580ab1db7c4f184b3be34f87c3828e40ef133ee
+  metadata.gz: 0d8d955fbddbe962a7033fc776c25ef83954f755847610f90cad2978cd81935d
+  data.tar.gz: 9f86695adad081d1f65a1ba8b27f0a6cc7ccc4ea025e6bc857dfcf8493334ee2
 SHA512:
-  metadata.gz: 2eb0687c751f50fad6a167a3ac6318e044b928dcef3f8ef59e904fd00835580ff204489d9fdce72578f6f53c696392550e5fc644246d9fa1c2d277d295a88b40
-  data.tar.gz: 9868bf1819031b3f54121d09c1ef6b0c5739074e275e2bbba76cebe331e37c67eeb80a9ac44f10f6ad03325ea02fa888d853acf73df6e4c6ae889b4cf1ca8729
+  metadata.gz: 017f96373ddc46c41111e8e901b85ef7f78bac687ef16f127296a44534c443ab47dea958321493227e4cfca787665550f4be4ddbc5683227e9d414f5d5842e51
+  data.tar.gz: 70b21b20741ba26aba60ef5e0332ab2373fc44698b5c270ab726790ffff70672248f8c1b58ca25bce04305383354116a5d857c7a1a40b3674df3dc8bfd390cab

data/README.md

@@ -38,7 +38,13 @@ yarn add mrujs
 // ... other stuff
 
 import mrujs from "mrujs";
-window.mrujs = mrujs.start();
+mrujs.start();
+
+// If you want it to work like Rails ujs.
+import Rails from "mrujs";
+Rails.start()
+
+// mrujs is available globally as window.Rails or window.mrujs
 ```
 
 3. Using on a form
@@ -123,7 +129,8 @@ const AJAX_EVENTS = {
 
   /**
    * After any fetch request, regardless of outcome
-   * Does not have any accessible data besides the event itself
+   * `event.detail.response`
+   * `event.detail.error` if any found
    */
   ajaxComplete: `ajax:complete`,
 
@@ -282,9 +289,25 @@ Example:
 </form>
 ```
 
+## Anchor methods
+
+Sometimes you want to add additional methods to your links. Heres how to
+do that:
+
+```html
+<a data-method="delete" href="/logout">
+```
+
+This will create a form, append it to the body, and then submit the form
+with a hidden value with the method value set to "delete" so the server
+knows to perform a delete.
+
 ## Roadmap
 
-- [ ] - Alias `window.Rails` to `window.mrujs` (Allows drop in
+- [x] - add support for `data-method="<REQUEST_TYPE>"` for non-forms
+it.
+- [x] - `data-response='type'` for forms.
+- [x] - Alias `window.Rails` to `window.mrujs` (Allows drop in
 replacement)
 - [ ] - Allow the use of `data-confirm=""`
 - [ ] - Provide a confirm dialog for `data-confirm`
@@ -316,11 +339,8 @@ sure you want to logout?" data-use-alert="true">
 
 </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.
+- [ ] - Asset pipeline, if someone would like to add support im open to
 
 ## Developing locally
 
@@ -349,3 +369,28 @@ yarn start
 yarn test
 ```
 
+## Rails
+
+There is also a Rails gem / dummy server attached.
+
+### Installation
+
+Top level:
+
+`bundle install`
+
+### Starting
+
+Must be run within the `test/ruby/dummy` directory.
+
+`cd test/ruby/dummy && bundle exec rails server`
+
+### Tests
+
+From any where _outside_ of the `test/ruby/dummy` directory:
+
+`bundle exec rake test`
+
+## Gem usage
+
+...Coming soon

data/Rakefile

@@ -18,3 +18,7 @@ end
 task default: :test
 
 require "standard/rake"
+
+task :test_precompile => :environment do
+  system("cd test/ruby/dummy && bundle exec rails assets:precompile")
+end

data/lib/mrujs_rails.rb

@@ -4,3 +4,4 @@ require "mrujs_rails/engine"
 module MrujsRails
   # Your code goes here...
 end
+

data/lib/mrujs_rails/assertions.rb

@@ -0,0 +1,45 @@
+module MrujsRails
+  module Assertions
+    def assert_redirected_to(options = {}, message = nil)
+      if turbolinks_request?
+        assert_turbolinks_visited(options, message)
+      else
+        super
+      end
+    end
+
+    def assert_turbolinks_visited(options = {}, message = nil)
+      assert_response :ok, message
+      assert_equal Mime[:turbolinks], response.media_type
+
+      visit_location = turbolinks_visit_location_and_action[:location]
+
+      redirect_is = normalize_argument_to_redirection(visit_location)
+      redirect_expected = normalize_argument_to_redirection(options)
+
+      message ||= "Expected response to be a Turbolinks visit to <#{redirect_expected}> but was a visit to <#{redirect_is}>"
+      assert_operator redirect_expected, :===, redirect_is, message
+    end
+
+    # Rough heuristic to detect whether this was a Turbolinks request:
+    # non-GET request with a text/javascript response.
+    #
+    # Technically we'd check that Turbolinks-Referrer request header is
+    # also set, but that'd require us to pass the header from post/patch/etc
+    # test methods by overriding them to provide a `turbolinks:` option.
+    #
+    # We can't check `request.xhr?` here, either, since the X-Requested-With
+    # header is cleared after controller action processing to prevent it
+    # from leaking into subsequent requests.
+    def turbolinks_request?
+      !request.get? && response.media_type == Mime[:turbolinks]
+    end
+
+    def turbolinks_visit_location_and_action
+      {
+        location: response.headers["TURBOLINKS-REDIRECT-LOCATION"],
+        action: response.headers["TURBOLINKS-REDIRECT-ACTION"]
+      }
+    end
+  end
+end

data/lib/mrujs_rails/controller.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "mrujs_rails/redirection"
+
+module MrujsRails
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      include Redirection
+    end
+  end
+end

data/lib/mrujs_rails/engine.rb

@@ -1,5 +1,27 @@
+require "mrujs_rails/version"
+require "mrujs_rails/controller"
+require "mrujs_rails/assertions"
+
 module MrujsRails
   class Engine < ::Rails::Engine
-    isolate_namespace MrujsRails
+    config.turbolinks = ActiveSupport::OrderedOptions.new
+    config.turbolinks.auto_include = true
+
+    # allows us to use a turbolinks mimetype, perhaps this should be mrujs?
+    initializer "turbolinks.mimetype" do
+      Mime::Type.register "text/turbolinks", :turbolinks
+    end
+
+    initializer "mrujs_rails.test_assertions" do
+      ActiveSupport.on_load(:active_support_test_case) do
+        include ::MrujsRails::Assertions
+      end
+    end
+
+    initializer "mrujs_rails" do |app|
+      ActiveSupport.on_load(:action_controller) do
+        include ::MrujsRails::Controller if app.config.turbolinks.auto_include
+      end
+    end
   end
 end

data/lib/mrujs_rails/redirection.rb

@@ -0,0 +1,43 @@
+module MrujsRails
+  module Redirection
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :set_turbolinks_location_header_from_session if respond_to?(:before_action)
+    end
+
+    def redirect_to(url = {}, options = {})
+      # turbolinks = options.delete(:turbolinks)
+
+      super.tap do
+        if request.xhr? && !request.get?
+          visit_location_with_turbolinks(location, turbolinks)
+        elsif request.headers["Turbolinks-Referrer"]
+          store_turbolinks_location_in_session(location)
+        end
+      end
+    end
+
+    private
+
+    def visit_location_with_turbolinks(location, action)
+      action = action.to_s
+      visit_action = action == "advance" ? action : "replace"
+
+      response.content_type = Mime[:turbolinks]
+      response.headers["X-Xhr-Redirect"] = location
+      response.headers["TURBOLINKS-REDIRECT-ACTION"] = visit_action
+      response.headers["TURBOLINKS-REDIRECT-LOCATION"] = location
+    end
+
+    def store_turbolinks_location_in_session(location)
+      session[:_turbolinks_location] = location if session
+    end
+
+    def set_turbolinks_location_header_from_session
+      if session && session[:_turbolinks_location]
+        response.headers["Turbolinks-Location"] = session.delete(:_turbolinks_location)
+      end
+    end
+  end
+end

data/lib/mrujs_rails/version.rb

@@ -1,3 +1,3 @@
 module MrujsRails
-  VERSION = "0.0.6"
+  VERSION = "0.1.0-beta.14"
 end

data/lib/tasks/mrujs_rails_tasks.rake

@@ -1,4 +1,6 @@
-# desc "Explaining what the task does"
-# task :mrujs_rails do
-#   # Task goes here
-# end
+desc "Used for internal testing, do not touch this."
+namespace :mrujs do
+  task test_precompile: :environment do
+    system("cd test/ruby/dummy && bundle exec rails assets:precompile")
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mrujs_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0.pre.beta.14
 platform: ruby
 authors:
 - ParamagicDev
@@ -9,28 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-06 00:00:00.000000000 Z
+date: 2021-05-23 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
+        version: '5.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7'
   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
+        version: '5.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: standardrb
   requirement: !ruby/object:Gem::Requirement
@@ -56,7 +56,10 @@ files:
 - README.md
 - Rakefile
 - lib/mrujs_rails.rb
+- lib/mrujs_rails/assertions.rb
+- lib/mrujs_rails/controller.rb
 - lib/mrujs_rails/engine.rb
+- lib/mrujs_rails/redirection.rb
 - lib/mrujs_rails/version.rb
 - lib/tasks/mrujs_rails_tasks.rake
 homepage: https://github.com/paramagicdev/mrujs
@@ -77,11 +80,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: A rails plugin for mrujs to make Turbolinks work.