Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BookOfGreg merged 8 commits into from
Jul 27, 2019
Merged

Enhanced turbolinks support #978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d340227
Mount components when displaying cached page
joshleblanc Feb 1, 2019
7ffade8
Cache rendered components to prevent destroying previously rendered c…
joshleblanc Feb 1, 2019
dd91f28
move cache_ids initialization to initialize
joshleblanc Feb 2, 2019
2b9a060
Added data-react-cache-id to view tests
joshleblanc Feb 2, 2019
d200040
Rearrange html attributes in test
joshleblanc Feb 2, 2019
fb51da0
Only cache data-turbolinks-permanent nodes
joshleblanc Feb 2, 2019
211f188
Be consistent
joshleblanc Feb 26, 2019
7577efe
Merge branch 'master' into enhanced-turbolinks-support
BookOfGreg Mar 31, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lib/react/rails/component_mount.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
attr_accessor :output_buffer
mattr_accessor :camelize_props_switch

def initialize
@cache_ids = []
end

# {ControllerLifecycle} calls these hooks
# You can use them in custom helper implementations
def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
data[:react_class] = name
data[:react_props] = (props.is_a?(String) ? props : props.to_json)
data[:hydrate] = 't' if prerender_options

num_components = @cache_ids.count { |c| c.start_with? name }
data[:react_cache_id] = "#{name}-#{num_components}"
end
end
html_tag = html_options[:tag] || :div
Expand Down
23 changes: 20 additions & 3 deletions react_ujs/index.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
// This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
RENDER_ATTR: 'data-hydrate',

// A unique identifier to identify a node
CACHE_ID_ATTR: "data-react-cache-id",

TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

// If jQuery is detected, save a reference to it for event handlers
jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

components: {},

// helper method for the mount and unmount methods to find the
// `data-react-class` DOM elements
findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
var propsJson = node.getAttribute(ujs.PROPS_ATTR);
var props = propsJson && JSON.parse(propsJson);
var hydrate = node.getAttribute(ujs.RENDER_ATTR);
var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

if (!constructor) {
var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
}
throw new Error(message + ". Make sure your component is available to render.")
} else {
let component = this.components[cacheId];
if(component === undefined) {
component = React.createElement(constructor, props);
if(turbolinksPermanent) {
this.components[cacheId] = component;
}
}

if (hydrate && typeof ReactDOM.hydrate === "function") {
ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
} else {
ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
}
}
}
}
},

// Within `searchSelector`, find nodes which have React components
Expand Down
8 changes: 4 additions & 4 deletions react_ujs/src/events/turbolinks.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
// Turbolinks 5+ got rid of named events (?!)
setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
},

teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
},
}
6 changes: 3 additions & 3 deletions test/react/rails/view_helper_test.rb
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
test 'view helper can be called directly' do
expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
assert_equal(expected_html, rendered_html)
end

test 'view helper accepts block usage' do
expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
'content'
end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
test 'view helper can accept block and render inner content only once' do
rendered_html = render partial: 'pages/component_with_inner_html'
expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
<div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Enhanced turbolinks support#978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BookOfGreg
merged 8 commits into

from

Jul 27, 2019
 Merged


Enhanced turbolinks support
#978
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
d340227

Mount components when displaying cached page


joshleblanc Feb 1, 2019
7ffade8

Cache rendered components to prevent destroying previously rendered c…


joshleblanc Feb 1, 2019
dd91f28

move cache_ids initialization to initialize


joshleblanc Feb 2, 2019
2b9a060

Added data-react-cache-id to view tests


joshleblanc Feb 2, 2019
d200040

Rearrange html attributes in test


joshleblanc Feb 2, 2019
fb51da0

Only cache data-turbolinks-permanent nodes


joshleblanc Feb 2, 2019
211f188

Be consistent


joshleblanc Feb 26, 2019
7577efe

Merge branch 'master' into enhanced-turbolinks-support


BookOfGreg Mar 31, 2019

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


7 changes: 7 additions & 0 deletions
lib/react/rails/component_mount.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,10 @@ class ComponentMount
 attr_accessor :output_buffer
 mattr_accessor :camelize_props_switch

 def initialize
 @cache_ids = []
 end

 # {ControllerLifecycle} calls these hooks
 # You can use them in custom helper implementations
 def setup(controller)
Expand DownExpand Up@@ -40,6 +44,9 @@ def react_component(name, props = {}, options = {}, &block)
 data[:react_class] = name
 data[:react_props] = (props.is_a?(String) ? props : props.to_json)
 data[:hydrate] = 't' if prerender_options

 num_components = @cache_ids.count { |c| c.start_with? name }
 data[:react_cache_id] = "#{name}-#{num_components}"
 end
 end
 html_tag = html_options[:tag] || :div
Expand Down

23 changes: 20 additions & 3 deletions
react_ujs/index.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,9 +18,16 @@ var ReactRailsUJS = {
 // This attribute holds which method to use between: ReactDOM.hydrate, ReactDOM.render
 RENDER_ATTR: 'data-hydrate',

 // A unique identifier to identify a node
 CACHE_ID_ATTR: "data-react-cache-id",

 TURBOLINKS_PERMANENT_ATTR: "data-turbolinks-permanent",

 // If jQuery is detected, save a reference to it for event handlers
 jQuery: (typeof window !== 'undefined') && (typeof window.jQuery !== 'undefined') && window.jQuery,

 components: {},

 // helper method for the mount and unmount methods to find the
 // `data-react-class` DOM elements
 findDOMNodes: function(searchSelector) {
Expand DownExpand Up@@ -86,6 +93,8 @@ var ReactRailsUJS = {
 var propsJson = node.getAttribute(ujs.PROPS_ATTR);
 var props = propsJson && JSON.parse(propsJson);
 var hydrate = node.getAttribute(ujs.RENDER_ATTR);
 var cacheId = node.getAttribute(ujs.CACHE_ID_ATTR);
 var turbolinksPermanent = node.hasAttribute(ujs.TURBOLINKS_PERMANENT_ATTR);

 if (!constructor) {
 var message = "Cannot find component: '" + className + "'"
Expand All@@ -94,13 +103,21 @@ var ReactRailsUJS = {
 }
 throw new Error(message + ". Make sure your component is available to render.")
 } else {
 let component = this.components[cacheId];
 if(component === undefined) {
 component = React.createElement(constructor, props);
 if(turbolinksPermanent) {
 this.components[cacheId] = component;
 }
 }

 if (hydrate && typeof ReactDOM.hydrate === "function") {
 ReactDOM.hydrate(React.createElement(constructor, props), node);
component = ReactDOM.hydrate(component, node);
 } else {
 ReactDOM.render(React.createElement(constructor, props), node);
component = ReactDOM.render(component, node);
 }
 }
 }
 }
 },

 // Within `searchSelector`, find nodes which have React components
Expand Down

8 changes: 4 additions & 4 deletions
react_ujs/src/events/turbolinks.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
module.exports = {
 // Turbolinks 5+ got rid of named events (?!)
 setup: function(ujs) {
ujs.handleEvent('turbolinks:load', ujs.handleMount)
 ujs.handleEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.handleEvent('turbolinks:load', ujs.handleMount);
 ujs.handleEvent('turbolinks:before-render', ujs.handleMount);
 },

 teardown: function(ujs) {
ujs.removeEvent('turbolinks:load', ujs.handleMount)
 ujs.removeEvent('turbolinks:before-render', ujs.handleUnmount)
ujs.removeEvent('turbolinks:load', ujs.handleMount);
 ujs.removeEvent('turbolinks:before-render', ujs.handleMount);
 },
}

6 changes: 3 additions & 3 deletions
test/react/rails/view_helper_test.rb

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,13 +10,13 @@ class ViewHelperHelper

class ViewHelperTest < ActionView::TestCase
 test 'view helper can be called directly' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}"></div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0"></div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' })
 assert_equal(expected_html, rendered_html)
 end

 test 'view helper accepts block usage' do
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}">content</div>}
 expected_html = %{<div data-react-class="Component" data-react-props="{&quot;a&quot;:&quot;b&quot;}" data-react-cache-id="Component-0">content</div>}
 rendered_html = ViewHelperHelper.react_component('Component', { a: 'b' }) do
 'content'
 end
Expand All@@ -32,7 +32,7 @@ class ViewHelperTest < ActionView::TestCase
 test 'view helper can accept block and render inner content only once' do
 rendered_html = render partial: 'pages/component_with_inner_html'
 expected_html = <<HTML
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" id=\"component\">
<div data-react-class=\"GreetingMessage\" data-react-props=\"{&quot;name&quot;:&quot;Name&quot;}\" data-react-cache-id=\"GreetingMessage-0\" id=\"component\">
 <div id=\"unique-nested-id\">NestedContent</div>
</div>
HTML
Expand Down