punchbox 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 663d8f696f1b9b5f4c317b27e15325efd2e7be6b
-  data.tar.gz: c79a9152bb2c34821b3be762a1c40c798d0d6a3c
+  metadata.gz: 3fff45d81bf026c8f5e9b9c556ae6903d99a0d62
+  data.tar.gz: 8b1a8bb998aca2812cb40955834abf971283306f
 SHA512:
-  metadata.gz: 1f23c149e2b9996bdbd215de7a6094dc9487fc87be5ffb3ff9c69b39d3a9cdfbf628cf2f8c1bae66adbe58a6b8eb6c75ab99b35cca7d5e8c6bbde66d9281d335
-  data.tar.gz: 2cc7537e9b24cc05864f62b43afb0364ab80764281416ffc84d8ad39e29ec309cc3267fc4b3f1041acc9dd2f6dbd34b862a9cca2fc09d4865ae27299ccfbace4
+  metadata.gz: 39ceeb71abaa224bed0fd11e4b3230fd06754feb7522335e271afd6475a389cf2753ae13ecfdace59fc45f8f0126106253d02379018da41e4bf45a8a3b31d527
+  data.tar.gz: b8bc6c59f9abf51ab8b3829036f42f88ca88473a2d519a894856a1974ef76058f012f31725b8ab46a8a329e986c1d603b751f31649d1a1e538e301a2fbfbaf94

data/README.md

@@ -65,7 +65,7 @@ Punchbox automatically runs your code after your document is ready, negating the
 
 `controller` should be a string or a function that returns a string.  It should be the exact name of the controller (plus namespace) that you want your code to run on.  It should be ClassCase (PascalCase) only.
 
-For example, if your controller is `PostsController`, you'd enter 'Posts'.  If your controller is `AdminPanelsController`, you'd enter `AdminPanels`.
+For example, if your controller is `PostsController`, you'd enter `Posts`.  If your controller is `AdminPanelsController`, you'd enter `AdminPanels`.
 
 #### Namespacing
 
@@ -83,7 +83,7 @@ Functions should be named after the actions on which they should run.  A functio
 
 The exception is `controller`.  Punchbox treats functions named `controller` in a special way and runs them on every action in a given Rails controller.
 
-#### Examples
+### Examples
 
 In all examples I'll be targeting the `Posts` controller. *Remember that the name of your `callable` or your JS filepath don't have anything to do with Punchbox's functionality. However, I'll be naming the callables after the controllers to keep up with the preferred convention.*
 
@@ -152,6 +152,30 @@ class Posts
 Punchbox.on('Posts', Posts) # Notice that you don't instantiate the class
 ```
 
+### Events
+
+Every time a controller or action function is run, some events on `document` fire.
+
+These events are `punchbox:<controller>:run` and `punchbox:<controller>:<action>:run`.  These both run when their respective functions would run.
+
+Keep in mind that the events are `snake_case` with slashes preserved.
+
+For example, you would listen to the `Posts` controller trigger like so:
+
+```javascript
+document.addEventListener('punchbox:posts:run', () => {
+  console.log('Posts controller ran!');
+})
+```
+
+and you'd listen to the `Posts` `index` trigger like so:
+
+```javascript
+document.addEventListener('punchbox:posts:index:run', () => {
+  console.log('Posts index ran!');
+})
+```
+
 ## Contributing
 
 If you want to contribute, don't hesitate to create an issue or PR!  Since this project is in it's infancy, your input could help shape the project as a whole!

data/lib/punchbox/version.rb

@@ -1,3 +1,3 @@
 module Punchbox
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: punchbox
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Kieran Eglin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails