cable_ready 4.0.6 → 4.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b121b1e33a62d1196e08b55b1a2c8a89d53e54ec1d5880264624714aaf57cdd
-  data.tar.gz: 8218ea4e5fce9728eee4b5979df81f7e4a6752f1f7dcea33746d38b460d45321
+  metadata.gz: 0e50431320c8001f455dcbc16f47eddc35752fb3e98b199861673ffc1f05d71f
+  data.tar.gz: 9b510c240c183ffe9ead18c896bd5748e8e9305223006eec8968ada79e438595
 SHA512:
-  metadata.gz: fbee1b6a0cdcadbb565441617e9c8f09bb13b915fb8858cdc3b6d13ef9bc22b79d7a9b5149d9c6f5834356cd9b884197ba92cd6a4e9b6d9b9d73b3ae903e7191
-  data.tar.gz: d407c484474ed1f3acf46adaed5c96af4067d58f75252bcf395eaa98fa7c857cc8438f68735d6b15e7852ef8d326258b09ad6a4bc4c8da2e0caac5eca371a2f6
+  metadata.gz: 354e3e6b94cb9adef0a1428d30f1e571d0893204e1bdff3317502000d2d97e2747f8cfb8fdb3d04f818cc55ac506f87e0753aa67290b82b0844b53f4edec7090
+  data.tar.gz: 267d1c79f31c10d070bdde344897ef6cfeae7e900924f1ac14d6e04eab216f969eb45f72c4faf55ad9a45ff0bfd1de4fb10d51336ee60f5d483a1f20c4589433

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at natehop@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cable_ready (4.0.6)
+    cable_ready (4.0.7)
       rails (>= 5.2)
 
 GEM

data/README.md

@@ -1,5 +1,7 @@
 [![Lines of Code](http://img.shields.io/badge/lines_of_code-268-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)
+![Prettier-Standard](https://github.com/hopsoft/cable_ready/workflows/Prettier-Standard/badge.svg)
+![StandardRB](https://github.com/hopsoft/cable_ready/workflows/StandardRB/badge.svg)
 
 # CableReady
 
@@ -11,361 +13,22 @@ from the server via [ActionCable](http://guides.rubyonrails.org/action_cable_ove
 Please read the official [ActionCable docs](http://guides.rubyonrails.org/action_cable_overview.html)
 to learn more about ActionCable before proceeding.
 
-## Setup
+## Docs
 
-### JavaScript
+- [Official Documentation](https://cableready.stimulusreflex.com)
+- [Documentation Source Code](https://github.com/hopsoft/cable_ready/tree/master/docs)
 
-```
-yarn install cable_ready
-```
-
-### Gemfile
-
-```ruby
-gem "cable_ready"
-```
-
-## Usage
-
-### app/assets/javascripts/channels/user.js
-
-```javascript
-import CableReady from 'cable_ready';
-
-App.cable.subscriptions.create({ channel: "UserChannel" }, {
-  received: function (data) {
-    if (data.cableReady) {
-      CableReady.perform(data.operations);
-    }
-  }
-});
-```
-
-### app/models/user.rb
-
-```ruby
-class User < ApplicationRecord
-  include CableReady::Broadcaster
-
-  def broadcast_name_change
-    cable_ready["UserChannel"].text_content selector: "#user-name", text: name
-    cable_ready.broadcast
-  end
-end
-```
-
-## Supported DOM Operations
-
-- [dispatchEvent](#dispatchevent)
-- [morph](#morph)
-- [innerHTML](#innerhtml)
-- [outerHTML](#outerhtml)
-- [insertAdjacentHTML](#insertAdjacentHTML)
-- [insertAdjacentText](#insertadjacenttext)
-- [remove](#remove)
-- [setValue](#setvalue)
-- [setAttribute](#setattribute)
-- [removeAttribute](#removeattribute)
-- [addCssClass](#addcssclass)
-- [removeCssClass](#removecssclass)
-- [setDatasetProperty](#setdatasetproperty)
-
-> 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 `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
-
-#### [dispatchEvent](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent)
-
-Dispatches a DOM event in the browser.
-
-```ruby
-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 a CSS selector or XPath expression
-)
-```
-
-### Element Mutations
-
-#### [morph](https://github.com/patrick-steele-idem/morphdom)
-
-[Fast lightweight DOM diffing/patching](https://github.com/patrick-steele-idem/morphdom) without a virtual DOM.
-
-```ruby
-cable_ready["MyChannel"].morph(
-  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
-  permanent_attribute_name: "string", # [null]   - an attribute name that prevents elements from being updated i.e. "data-permanent"
-  focus_selector: "string",           # [null]   - string containing a CSS selector
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-morph`
-- `cable-ready:after-morph`
-
-##### Stimulus Gotchas
-
-For some reason [Stimulus](https://github.com/stimulusjs/stimulus) controllers don't reconnect after DOM mutations triggered by [Morphdom](https://github.com/patrick-steele-idem/morphdom).
-You can force your controllers to reconnect with the following code.
-
-```javascript
-import { Controller } from "stimulus"
-
-export default class extends Controller {
-  connect() {
-    this.name = this.element.dataset.controller;
-    document.addEventListener('cable-ready:after-morph', this.reconnect.bind(this));
-    );
-  }
-
-  reconnect() {
-    setTimeout(() => this.element.setAttribute('data-controller', this.name), 1);
-    this.element.setAttribute('data-controller', '');
-  }
-}
-```
-
-#### [innerHTML](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML)
-
-Sets the innerHTML of a DOM element.
-
-```ruby
-cable_ready["MyChannel"].inner_html(
-  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
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-inner-html`
-- `cable-ready:after-inner-html`
-
-#### [outerHTML](https://developer.mozilla.org/en-US/docs/Web/API/Element/outerHTML)
-
-Replaces a DOM element with new HTML.
-
-```ruby
-cable_ready["MyChannel"].outerHTML(
-  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
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-outer-html`
-- `cable-ready:after-outer-html`
-
-#### [textContent](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)
-
-Sets the text content of a DOM element.
-
-```ruby
-cable_ready["MyChannel"].text_content(
-  selector: "string", # required - string containing a CSS selector or XPath expression
-  text:     "string"  # [null]   - the text to assign
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-text-content`
-- `cable-ready:after-text-content`
-
-#### [insertAdjacentHTML](https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentHTML)
-
-Inserts HTML into the DOM relative to an element.
-Supports behavior akin to prepend & append.
-
-```ruby
-cable_ready["MyChannel"].insert_adjacent_html(
-  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
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-insert-adjacent-html`
-- `cable-ready:after-insert-adjacent-html`
-
-#### [insertAdjacentText](https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentText)
-
-Inserts text into the DOM relative to an element.
-Supports behavior akin to prepend & append.
-
-```ruby
-cable_ready["MyChannel"].insert_adjacent_text(
-  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
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-insert-adjacent-text`
-- `cable-ready:after-insert-adjacent-text`
-
-#### [remove](https://developer.mozilla.org/en-US/docs/Web/API/ChildNode/remove)
-
-Removes an element from the DOM.
-
-```ruby
-cable_ready["MyChannel"].remove(
-  selector:       "string", # required - string containing a CSS selector or XPath expression
-  focus_selector: "string"  # [null]   - string containing a CSS selector
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-remove`
-- `cable-ready:after-remove`
-
-#### [setValue](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement)
-
-Sets the value of an element.
-
-```ruby
-cable_ready["MyChannel"].set_value(
-  selector: "string", # required - string containing a CSS selector or XPath expression
-  value:    "string"  # [null]   - the value to assign to the attribute
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-set-value`
-- `cable-ready:after-set-value`
-
-### Attribute Mutations
-
-#### [setAttribute](https://developer.mozilla.org/en-US/docs/Web/API/Element/setAttribute)
-
-Sets an attribute on an element.
-
-```ruby
-cable_ready["MyChannel"].set_attribute(
-  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
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-set-attribute`
-- `cable-ready:after-set-attribute`
-
-#### [removeAttribute](https://developer.mozilla.org/en-US/docs/Web/API/Element/removeAttribute)
-
-Removes an attribute from an element.
-
-```ruby
-cable_ready["MyChannel"].remove_attribute(
-  selector: "string", # required - string containing a CSS selector or XPath expression
-  name:     "string"  # required - the attribute to remove
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-remove-attribute`
-- `cable-ready:after-remove-attribute`
-
-### CSS Class Mutations
-
-#### [addCssClass](https://developer.mozilla.org/en-US/docs/Web/API/Element/classList)
-
-Adds a css class to an element.
-This is a `noop` if the css class is already assigned.
-
-```ruby
-cable_ready["MyChannel"].add_css_class(
-  selector: "string", # required - string containing a CSS selector or XPath expression
-  name:     "string"  # [null]   - the CSS class to add
-)
-
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-add-css-class`
-- `cable-ready:after-add-css-class`
-
-#### [removeCssClass](https://developer.mozilla.org/en-US/docs/Web/API/Element/classList)
-
-Removes a css class from an element.
-
-```ruby
-cable_ready["MyChannel"].add_css_class(
-  selector: "string", # required - string containing a CSS selector or XPath expression
-  name:     "string"  # [null]   - the CSS class to remove
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-remove-css-class`
-- `cable-ready:after-remove-css-class`
-
-### Dataset Mutations
-
-#### [setDatasetProperty](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset)
-
-Sets an dataset property (data-* attribute) on an element.
-
-```ruby
-cable_ready["MyChannel"].set_dataset_property(
-  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
-)
-```
-
-##### JavaScript Events
-
-- `cable-ready:before-set-dataset-property`
-- `cable-ready:after-set-dataset-property`
+## Contributing
 
-## JavaScript Development
+### Code of Conduct
 
-Please run `bin/standardize` on your codebase before submitting commits.
+Everyone interacting with CableReady is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md)
 
-## Contributing
+### Coding Standards
 
 This project uses [Standard](https://github.com/testdouble/standard)
-and [Prettier](https://github.com/prettier/prettier) to minimize bike shedding related to code formatting.
+and [prettier-standard](https://github.com/sheerun/prettier-standard) to minimize bike shedding related to code formatting.
+
 Please run `./bin/standardize` prior submitting pull requests.
 
 ### Releasing

data/lib/cable_ready/version.rb

@@ -1,3 +1,3 @@
 module CableReady
-  VERSION = "4.0.6"
+  VERSION = "4.0.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cable_ready
 version: !ruby/object:Gem::Version
-  version: 4.0.6
+  version: 4.0.7
 platform: ruby
 authors:
 - Nathan Hopkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-03 00:00:00.000000000 Z
+date: 2019-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt