frenerator 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf185ff7acf00d990c9888c601057da85f2418e4
-  data.tar.gz: a8481e52903c0227eccf7b48b88a06eb02442a7f
+  metadata.gz: db1c4c0dd27671d815b1f18d697be30f35416a44
+  data.tar.gz: 8fc80fdb30ba1a37475628df1283b2acecd3f61a
 SHA512:
-  metadata.gz: c22bc762fcf0fe4aa22581b2374db0b4069dad335ef54892ddf9a8f77c1c2425bb5fac3f21e42c23de879f0ec88eeff66e044cd2faad6bf563cb622c55fbb8db
-  data.tar.gz: 393ac733939facf3c5f6f86324c564ecd4b8ef708afe03044c0258e019f0fcd483c2b1be593b5a10467f56eb6757cb79290253beb35a7576b1f56394208a40f7
+  metadata.gz: edc25362185a0e41dcbabd099d98c6a8277ab5e901b17ee78e454ef9f290d35c9730303b550909cd9fbd83a8d05be07de185f4a024eff7be9d308ead8b4d66ae
+  data.tar.gz: ce6053b646e3141ca8e92ea469ed905bf458eb4e746c19c01d13b4eab9659733b74e7c5ad9a09a6665c95016efbbeaab55fca5e129a2243095a7aeb24cbc4f57

data/README.md

@@ -31,17 +31,19 @@ configured with `bundleExec: true` to make sure everyone is on the same page.
 
 Main javascript file is `application.js` (the one that gets included via a `script` tag)
 
+#### Dependencies
+
 Sprockets for dependency management: `application.js` includes app parts:
 
-    1. `dependencies` Place to include all libs, frameworks, etc.
-    2. `namespace` Gives common top level structure and defines `App`
-    3. `templates` Handlebars templates
-    4. `base` Define base coffee classes here
-    5. `collections` -||- collections
-    6. `models` -||- models
-    7. `views` -||- views
-    8. `components` All the top level backbone views live here
-    9. `main` - the init code
+  1. `dependencies` Place to include all libs, frameworks, etc.
+  2. `namespace` Gives common top level structure and defines `App`
+  3. `templates` Handlebars templates
+  4. `base` Define base coffee classes here
+  5. `collections` -||- collections
+  6. `models` -||- models
+  7. `views` -||- views
+  8. `components` All the top level backbone views live here
+  9. `main` - the init code
 
 _You HAVE to manually include all the components you want to use inside `components.coffee`
 or your component code will not be compiled in `application.js`_
@@ -62,6 +64,35 @@ on something else, you can wait until `app:ready` to do your work. It will be mo
 likely that the component you are depending on will be available at the time this
 event is fired, rather than in your `@initialize` method
 
+##### Intercomponent communication conventions (events and stuff)
+
+For controlling components from other components and triggering events you would like
+other components to be able to hook into, use the global events channel - `App.Dispatch`.
+As far as naming convention goes, events that a component is listening and responding to
+should start with `tell:`. The common form is `tell:{component}:to_{do_something}`.
+Events that are emmited in the global channel should be in the form `{component}:{event}`
+
+Example:
+
+```coffeescript
+App.Components.Mothership extends App.View
+
+  initialize: =>
+    @listenTo App.Dispatch, 'tell:mothership:to_takeoff', @takeoff
+  
+  takeoff: =>
+    while @speed <= @V2
+      @speed += 1
+    App.Dispatch.trigger 'mothership:is_airborne'
+    
+```
+
+You might find that you have a view that is reused within several components (e.g. you have
+more than one instance of that view in memory) and there is no way for other things to tell
+which instance is emmiting the event, so they can't hook into the correct event. In these
+cases try to find something unique about each instance and put it in the event name after
+the `component` name. For example: `tell:drone:#{id}:to_patrol`. I usually use a DOM id.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/frenerator/version.rb

@@ -1,3 +1,3 @@
 module Frenerator
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/generators/frenerator/frontend/templates/Gruntfile.js

@@ -75,7 +75,8 @@ module.exports = function (grunt) {
         files: [
           'app/assets/javascripts/templates/*.hbs',
           'app/components/**/*.hbs'
-        ]
+        ],
+        tasks: ['handlebars']
       },
       coffee: {
         files: [

data/lib/generators/frenerator/frontend/templates/Guardfile

@@ -18,5 +18,7 @@ guard 'livereload' do
   # Templates
   watch('app/assets/javascripts/templates.js')
   watch(%r{app/assets/stylesheets/(.+\.scss).*$}) { |m| "assets/#{m[1]}" }
+  watch(%r{app/assets/javascripts/(.+\.coffee).*$}) { |m| "assets/#{m[1]}" }
+  watch(%r{app/components/(.+\.coffee).*$}) { |m| "assets/#{m[1]}" }
   watch(%r{app/components/(.+\.scss).*$}) { |m| "assets/#{m[1]}" }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frenerator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Anthony Karasavov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-07 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties