cable_ready 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3ee79d7ceb554a3266d00a314664dd6b4013b31bee26c2ffe9eea1731d8902
-  data.tar.gz: e4a2e91f8d7a5ebc075f4b6779fe0596d8d818771d2c982573dd732a984df799
+  metadata.gz: f7dceb4cb5c1a5f1768435818fe3c0605de13b81be36cb6fafea38a3124dc08b
+  data.tar.gz: 573b35e97838527b2f8342a5e09ac62a0a9c211a8c6f6d4cdac2929e08a77780
 SHA512:
-  metadata.gz: 663d675621ad4a81f8c3c5ce37c246c19106a1712bc0969258bd44f0283c562ffd07792ff7d4191eba29eb943697617063b0d93d7b07dc2ee585445ec1d1ec0a
-  data.tar.gz: 71c5ecc3737f9528c6aa9ebbbc5f1ae85470fca5d8e5a56bef7b4beca7b1d251a681338c93314b06ddcdc3c71c529a7bc5b7e1cd2da3b4176b51378b218c78ca
+  metadata.gz: 6683fbb458ee7733cfaa6cc0daa7b030b1d2ee1e3e8573e80f6c7839ee90c644957ee5bee9aebc42d261e544bf04eb0af3988c142c6a331e91d8adf05a761837
+  data.tar.gz: ce2624613f73527d02e8a978747ac3c1386db77a2a8dacdb84178940be617a2da00906add1b28844a61975716fdb4811749afb26d9f2e3ca76fa38e201d828e2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (4.0.3)
+    cable_ready (4.0.4)
       rails (>= 5.2)
 
 GEM
@@ -85,7 +85,7 @@ GEM
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
-    nio4r (2.4.0)
+    nio4r (2.5.1)
     nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
@@ -157,7 +157,7 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
-    zeitwerk (2.1.9)
+    zeitwerk (2.1.10)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,4 +1,4 @@
-[![Lines of Code](http://img.shields.io/badge/lines_of_code-239-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
+[![Lines of Code](http://img.shields.io/badge/lines_of_code-236-brightgreen.svg?style=flat)](http://blog.codinghorror.com/the-best-code-is-no-code-at-all/)
 [![Maintainability](https://api.codeclimate.com/v1/badges/83ddf1fee4af7e51a681/maintainability)](https://codeclimate.com/github/hopsoft/cable_ready/maintainability)
 
 # CableReady
@@ -70,12 +70,27 @@ end
 - [removeCssClass](#removecssclass)
 - [setDatasetProperty](#setdatasetproperty)
 
-> The `selector` options use [Document.querySelector()](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector) to find elements.
+> The `selector` options use [document.querySelector()](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector) to find an element by default. [XPath](https://developer.mozilla.org/en-US/docs/Web/XPath) expressions can also be used if the `xpath` option is set to `true`. As with CSS selectors, the XPath expression must resolve to a single element and not a collection.
 
 > It's possible to invoke multiple DOM operations with a single ActionCable broadcast.
 
 > All DOM mutations have corresponding `before/after` events triggered on `document`.
-> These events expose `detail.config` set to the arguments from the server.
+> These events expose `event.detail` set to the arguments from the server.
+
+## Xpath Example
+
+### app/models/user.rb
+
+```ruby
+class User < ApplicationRecord
+  include CableReady::Broadcaster
+
+  def broadcast_name_change
+    cable_ready["UserChannel"].text_content selector: "/html/body/div[1]/form/input[1]", text: name, xpath: true
+    cable_ready.broadcast
+  end
+end
+```
 
 ### DOM Events
 
@@ -87,7 +102,7 @@ Dispatches a DOM event in the browser.
 cable_ready["MyChannel"].dispatch_event(
   name:     "string", # required - the name of the DOM event to dispatch (can be custom)
   detail:   "object", # [null]   - assigned to event.detail
-  selector: "string"  # [window] - string containing one or more CSS selectors separated by commas
+  selector: "string"  # [window] - string containing a CSS selector or XPath expression
 )
 ```
 
@@ -99,10 +114,10 @@ cable_ready["MyChannel"].dispatch_event(
 
 ```ruby
 cable_ready["MyChannel"].morph(
-  selector:       "string",  # required - string containing one or more CSS selectors separated by commas
+  selector:       "string",  # required - string containing a CSS selector or XPath expression
   html:           "string"   # [null]   - the HTML to assign
   children_only:  true|false # [null]   - indicates if only child nodes should be morphed... skipping the parent element
-  focus_selector: "string",  # [null]   - string containing one or more CSS selectors separated by commas
+  focus_selector: "string",  # [null]   - string containing a CSS selector
 )
 ```
 
@@ -139,8 +154,8 @@ Sets the innerHTML of a DOM element.
 
 ```ruby
 cable_ready["MyChannel"].inner_html(
-  selector:       "string", # required - string containing one or more CSS selectors separated by commas
-  focus_selector: "string", # [null]   - string containing one or more CSS selectors separated by commas
+  selector:       "string", # required - string containing a CSS selector or XPath expression
+  focus_selector: "string", # [null]   - string containing a CSS selector
   html:           "string"  # [null]   - the HTML to assign
 )
 ```
@@ -156,8 +171,8 @@ Replaces a DOM element with new HTML.
 
 ```ruby
 cable_ready["MyChannel"].outerHTML(
-  selector:       "string", # required - string containing one or more CSS selectors separated by commas
-  focus_selector: "string", # [null]   - string containing one or more CSS selectors separated by commas
+  selector:       "string", # required - string containing a CSS selector or XPath expression
+  focus_selector: "string", # [null]   - string containing a CSS selector
   html:           "string"  # [null]   - the HTML to use as replacement
 )
 ```
@@ -173,7 +188,7 @@ Sets the text content of a DOM element.
 
 ```ruby
 cable_ready["MyChannel"].text_content(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   text:     "string"  # [null]   - the text to assign
 )
 ```
@@ -190,8 +205,8 @@ Supports behavior akin to prepend & append.
 
 ```ruby
 cable_ready["MyChannel"].insert_adjacent_html(
-  selector:       "string", # required    - string containing one or more CSS selectors separated by commas
-  focus_selector: "string", # [null]      - string containing one or more CSS selectors separated by commas
+  selector:       "string", # required    - string containing a CSS selector or XPath expression
+  focus_selector: "string", # [null]      - string containing a CSS selector
   position:       "string", # [beforeend] - the relative position to the DOM element (beforebegin, afterbegin, beforeend, afterend)
   html:           "string"  # [null]      - the HTML to insert
 )
@@ -209,7 +224,7 @@ Supports behavior akin to prepend & append.
 
 ```ruby
 cable_ready["MyChannel"].insert_adjacent_text(
-  selector: "string", # required    - string containing one or more CSS selectors separated by commas
+  selector: "string", # required    - string containing a CSS selector or XPath expression
   position: "string", # [beforeend] - the relative position to the DOM element (beforebegin, afterbegin, beforeend, afterend)
   text:     "string"  # [null]      - the text to insert
 )
@@ -226,8 +241,8 @@ Removes an element from the DOM.
 
 ```ruby
 cable_ready["MyChannel"].remove(
-  selector:       "string", # required - string containing one or more CSS selectors separated by commas
-  focus_selector: "string"  # [null]   - string containing one or more CSS selectors separated by commas
+  selector:       "string", # required - string containing a CSS selector or XPath expression
+  focus_selector: "string"  # [null]   - string containing a CSS selector
 )
 ```
 
@@ -242,7 +257,7 @@ Sets the value of an element.
 
 ```ruby
 cable_ready["MyChannel"].set_value(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   value:    "string"  # [null]   - the value to assign to the attribute
 )
 ```
@@ -260,7 +275,7 @@ Sets an attribute on an element.
 
 ```ruby
 cable_ready["MyChannel"].set_attribute(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   name:     "string", # required - the attribute to set
   value:    "string"  # [null]   - the value to assign to the attribute
 )
@@ -277,7 +292,7 @@ Removes an attribute from an element.
 
 ```ruby
 cable_ready["MyChannel"].remove_attribute(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   name:     "string"  # required - the attribute to remove
 )
 ```
@@ -296,7 +311,7 @@ This is a `noop` if the css class is already assigned.
 
 ```ruby
 cable_ready["MyChannel"].add_css_class(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   name:     "string"  # [null]   - the CSS class to add
 )
 
@@ -313,7 +328,7 @@ Removes a css class from an element.
 
 ```ruby
 cable_ready["MyChannel"].add_css_class(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   name:     "string"  # [null]   - the CSS class to remove
 )
 ```
@@ -331,7 +346,7 @@ Sets an dataset property (data-* attribute) on an element.
 
 ```ruby
 cable_ready["MyChannel"].set_dataset_property(
-  selector: "string", # required - string containing one or more CSS selectors separated by commas
+  selector: "string", # required - string containing a CSS selector or XPath expression
   name:     "string", # required - the property to set
   value:    "string"  # [null]   - the value to assign to the dataset
 )
@@ -344,8 +359,22 @@ cable_ready["MyChannel"].set_dataset_property(
 
 ## JavaScript Development
 
-```sh
-cd /path/to/cable_ready/javascript
-vim ./cable_ready.js
-yarn publish
-```
+Please run `bin/standardize` on your codebase before submitting commits.
+
+## Contributing
+
+This project uses [Standard](https://github.com/testdouble/standard)
+and [Prettier](https://github.com/prettier/prettier) to minimize bike shedding related to code formatting.
+Please run `./bin/standardize` prior submitting pull requests.
+
+### Releasing
+
+1. Bump version number at `lib/cable_ready/version.rb`
+1. Run `rake build`
+1. Run `rake release`
+1. Change directories `cd ./javascript`
+1. Run `yarn publish` - NOTE: this will throw a fatal error because the tag already exists but the package will still publish
+
+## License
+
+CableReady is released under the [MIT License](LICENSE.txt).

data/Rakefile

@@ -3,5 +3,5 @@ require "bundler/gem_tasks"
 task default: [:test]
 
 task :test do
-  exec "bundle exec pry-test --disable-pry"
+  puts "Please write some tests..."
 end

data/bin/standardize

@@ -1,3 +1,4 @@
 #!/bin/bash
 
 bundle exec standardrb --fix
+cd ./javascript && yarn run prettier --write cable_ready.js

data/lib/cable_ready/version.rb

@@ -1,3 +1,3 @@
 module CableReady
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-17 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails