futurism 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54844ecdb7da8a4fe22cc7635a9b7eba3a5a6ffe29a68c8f5a12f9aae0f616da
-  data.tar.gz: 1b4e6c2d0ae11095ae535e1248e72af66dd030c9e3bb3b7d8fbda47cb204eccb
+  metadata.gz: 1d1c3294580dbbd5e9a52e891b639201f10e9731c7485229da9c739480d39dab
+  data.tar.gz: 91ce7571e8a406c820845f55d3bdb3eb83d905b8fd030242adfac73eba6d9f25
 SHA512:
-  metadata.gz: 47de6e6462abad9b682b01297cf3ee76ba7b4111f41afd8c8d81baa9b3d36b5be02c548e2421150437f84cbab8644d2766e976fa836490ca37a57b6497536f18
-  data.tar.gz: a1c145a00972f4ed088bfc1283a2e1bd133dc59828740be0bf6a599968a914fcbf1771d25747265166b1c193e801029490d981a7baf29e0041948402f372430b
+  metadata.gz: b6da86985c57394373be9cac152629ed42d8ff85de888e30e49f48dcffadd2dd21e67e5906e8b295c4e2d3d1c1dec90a26880f36dffc006254d347476a134743
+  data.tar.gz: 0d683568af28890339ccaea473e9b7eede53006597ccf00223be42558e4ee162db39e9e1c192ef725ceeefcbf588c667006dc2ddc294ffbf0bf8fb70e21bc38a

data/README.md

@@ -1,4 +1,7 @@
 # Futurism
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 Lazy-load Rails partials via CableReady
 
 ## Usage
@@ -8,7 +11,7 @@ with a helper in your template
 <%= futurize @posts %>
 ```
 
-custom `<futurism-elements>` (in the form of a `<div>` or a `<tr is="futurism-table-row">` are rendered. Those custom elements have an `IntersectionObserver` attached that will send a signed global id to an ActionCable channel (`FuturismChannel`) which will then replace the placeholders with the actual resource partial.
+custom `<futurism-element>`s (in the form of a `<div>` or a `<tr is="futurism-table-row">` are rendered. Those custom elements have an `IntersectionObserver` attached that will send a signed global id to an ActionCable channel (`FuturismChannel`) which will then replace the placeholders with the actual resource partial.
 
 With that method, you could lazy load every class that has to_partial_path defined (ActiveModel has by default).
 
@@ -20,6 +23,22 @@ You can pass the placeholder as a block:
 <% end %>
 ```
 
+![aa601dec1930151f71dbf0d6b02b61c9](https://user-images.githubusercontent.com/4352208/87131629-f768a480-c294-11ea-89a9-ea0a76ee06ef.gif)
+
+### Partial Path
+
+Remember that you can override the partial path in you models, like so:
+
+```rb
+class Post < ApplicationRecord
+  def to_partial_path
+    "home/post"
+  end
+end
+```
+
+That way you get maximal flexibility when just specifying a single resource.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -43,3 +62,24 @@ $ bin/rails futurism:install
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="http://www.julianrubisch.at"><img src="https://avatars0.githubusercontent.com/u/4352208?v=4" width="100px;" alt=""/><br /><sub><b>Julian Rubisch</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=julianrubisch" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/darkrubyist"><img src="https://avatars2.githubusercontent.com/u/11207292?v=4" width="100px;" alt=""/><br /><sub><b>darkrubyist</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=darkrubyist" title="Code">💻</a> <a href="https://github.com/julianrubisch/futurism/commits?author=darkrubyist" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://ParamagicDev.github.io/portfolio"><img src="https://avatars2.githubusercontent.com/u/26425882?v=4" width="100px;" alt=""/><br /><sub><b>Konnor Rogers</b></sub></a><br /><a href="https://github.com/julianrubisch/futurism/commits?author=ParamagicDev" title="Code">💻</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

data/lib/futurism/version.rb

@@ -1,3 +1,3 @@
 module Futurism
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/templates/elements/futurism_element.js

@@ -1,39 +1,9 @@
-class FuturismElement extends HTMLElement {
-  connectedCallback () {
-    const options = {}
-
-    this.observer = new IntersectionObserver((entries, observer) => {
-      entries.forEach(
-        (entry => {
-          if (entry.isIntersecting) {
-            this.dispatchAppearEvent(entry, observer)
-          }
-        }).bind(this)
-      )
-    }, options)
+/* global HTMLElement */
 
-    this.observer.observe(this)
-  }
+import { extendElementWithIntersectionObserver } from './futurism_utils'
 
-  dispatchAppearEvent (entry, observer) {
-    if (window.Futurism) {
-      const evt = new CustomEvent('futurism:appear', {
-        bubbles: true,
-        detail: {
-          target: entry.target,
-          observer
-        }
-      })
-      this.dispatchEvent(evt)
-    } else {
-      setTimeout(
-        (() => {
-          this.dispatchAppearEvent(entry, observer)
-        }).bind(this),
-        1
-      )
-    }
+export default class FuturismElement extends HTMLElement {
+  connectedCallback () {
+    extendElementWithIntersectionObserver(this)
   }
 }
-
-customElements.define('futurism-element', FuturismElement)

data/lib/templates/elements/futurism_table_row.js

@@ -1,41 +1,9 @@
-class FuturismTableRow extends HTMLTableRowElement {
-  connectedCallback () {
-    const options = {}
-
-    this.observer = new IntersectionObserver((entries, observer) => {
-      entries.forEach(
-        (entry => {
-          if (entry.isIntersecting) {
-            this.dispatchAppearEvent(entry, observer)
-          }
-        }).bind(this)
-      )
-    }, options)
+/* global HTMLTableRowElement */
 
-    this.observer.observe(this)
-  }
+import { extendElementWithIntersectionObserver } from './futurism_utils'
 
-  dispatchAppearEvent (entry, observer) {
-    if (window.Futurism) {
-      const evt = new CustomEvent('futurism:appear', {
-        bubbles: true,
-        detail: {
-          target: entry.target,
-          observer
-        }
-      })
-      this.dispatchEvent(evt)
-    } else {
-      setTimeout(
-        (() => {
-          this.dispatchAppearEvent(entry, observer)
-        }).bind(this),
-        1
-      )
-    }
+export default class FuturismTableRow extends HTMLTableRowElement {
+  connectedCallback () {
+    extendElementWithIntersectionObserver(this)
   }
 }
-
-customElements.define('futurism-table-row', FuturismTableRow, {
-  extends: 'tr'
-})

data/lib/templates/elements/futurism_utils.js

@@ -0,0 +1,33 @@
+/* global IntersectionObserver, CustomEvent, setTimeout */
+
+const dispatchAppearEvent = (entry, observer) => {
+  if (!window.Futurism) {
+    setTimeout(() => dispatchAppearEvent(entry, observer), 1)
+    return
+  }
+
+  const evt = new CustomEvent('futurism:appear', {
+    bubbles: true,
+    detail: {
+      target: entry.target,
+      observer
+    }
+  })
+
+  entry.target.dispatchEvent(evt)
+}
+
+const observerCallback = (entries, observer) => {
+  entries.forEach(entry => {
+    if (!entry.isIntersecting) return
+    dispatchAppearEvent(entry, observer)
+  })
+}
+
+export const extendElementWithIntersectionObserver = element => {
+  Object.assign(element, {
+    observer: new IntersectionObserver(observerCallback.bind(element), {})
+  })
+
+  element.observer.observe(element)
+}

data/lib/templates/elements/index.js

@@ -1,4 +1,7 @@
+/* global customElements */
+
 import FuturismElement from './futurism_element'
 import FuturismTableRow from './futurism_table_row'
 
-export { FuturismElement, FuturismTableRow }
+customElements.define('futurism-element', FuturismElement)
+customElements.define('futurism-table-row', FuturismTableRow, { extends: 'tr' })

data/lib/templates/futurism_channel.js

@@ -20,11 +20,9 @@ consumer.subscriptions.create('Futurism::Channel', {
     window.Futurism = this
     document.addEventListener(
       'futurism:appear',
-      debounceEvents(
-        (events => {
-          this.send({ sgids: events.map(e => e.target.dataset.sgid) })
-        }).bind(this)
-      )
+      debounceEvents(events => {
+        this.send({ sgids: events.map(e => e.target.dataset.sgid) })
+      })
     )
   },
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: futurism
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Julian Rubisch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2020-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: spy
+  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'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -84,9 +112,6 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
@@ -94,9 +119,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: '6'
@@ -139,6 +161,7 @@ files:
 - lib/tasks/futurism_tasks.rake~
 - lib/templates/elements/futurism_element.js
 - lib/templates/elements/futurism_table_row.js
+- lib/templates/elements/futurism_utils.js
 - lib/templates/elements/index.js
 - lib/templates/futurism_channel.js
 - lib/templates/futurism_element.js~