frenerator 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12c52b60d56c1cd6a61cecb89c91f495b358d6b2
-  data.tar.gz: a65d725e5f3e7a7110c866a9d70380bdca78223f
+  metadata.gz: 453115bf5b73b64cda1f0bf57cd0ed7b11fb014e
+  data.tar.gz: e31f3988625807c9b774db5013e7f3c226483501
 SHA512:
-  metadata.gz: 5a535851fdda99063bcdbb76d4b27b0040cd613cc2e6b34ac151dc540d918f08c8d5b59e032ad04c88fe3b82cf471f258fac80775e50961b40a95c4914cd1e99
-  data.tar.gz: fa5dfa53da0db44ea83ef9c04dae8daef6ee7afce4e33266d760a95dfa700fdde6bd0c34cce64c454bd40cf937cde40093693410f06eb7f92befc6b5fc7489f1
+  metadata.gz: ccd87c21ebe4ec9293dfde742aa5f24f2d95cc18addf876fca46bee1e60a4b35c45c11a93e388e95c3931937416178cd34aa14d20835d9b0bb76c2ef06c511b0
+  data.tar.gz: ec79018705cdecad737b7f5cb05e87c8d98b487915f2ccd0fed96db9d43f27c18b175e8ea909545ca544c2bbb8022039021bbe1a877fd02f1b80063e77dd0ffa

data/README.md

@@ -2,7 +2,7 @@
 
 Rails generator for a common web front-end
 
-## Installation and usage
+## Installation
 
 On a *FRESH* Rails app in Gemfile:
 
@@ -18,6 +18,49 @@ You now have the frenerator. Run with:
 
     $ rails g frenerator:frontend
 
+## Usage
+
+1. `npm install && bower install`
+2. `bundle exec guard` (if you want livereload, else `bundle exec rails s`)
+3. `grunt`
+
+The grunt linter uses the 'sass-lint' ruby gem to lint stylesheets and it is
+configured with `bundleExec: true` to make sure everyone is on the same page.
+
+### Javascript structure overview
+
+Main javascript file is `application.js` (the one that gets included via a `script` tag)
+
+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
+
+_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`_
+
+Components are basically top level views and they live in the `components` dir
+along with their associated `scss` styles, `.hbs` templates and `.erb` partials.
+Every component _must_ have an associated `el`, which is a valid dom selector.
+If it doesn't `main` will not initialize this component. This is handy, because
+you can have components that are initialized only on certain pages. If you want
+a component to be initialized everywhere, you can simply set it's `el` to `body`
+
+##### App.Dispatch and app:ready
+
+`App.Dispatch` is a plain old backbone events mixin and is globally available to
+components to comunicate with each other. When all components have initialized
+`App.Dispatch` triggers an `app:ready` event, so that if your component is depending
+on something else, you can wait until `app:ready` to do your work. It will be more
+likely that the component you are depending on will be available at the time this
+event is fired, rather than in your `@initialize` method
 
 ## Development
 

data/lib/frenerator/version.rb

@@ -1,3 +1,3 @@
 module Frenerator
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/generators/frenerator/frontend/templates/bower.json

@@ -16,6 +16,7 @@
     "breakpoint-sass": "~2.6.1",
     "compass-mixins": "~1.0.2",
     "jquery-ujs": "~1.0.4",
-    "normalize-scss": "~3.0.3"
+    "normalize-scss": "~3.0.3",
+    "jquery.cookie": "~1.4.1"
   }
 }

data/lib/generators/frenerator/frontend/templates/javascripts/application.js

@@ -1,19 +1,6 @@
-// Require all external lib dependencies
-// Sprockets reads bower.json, so you can
-// only require component directory and
-// it will load the main js file, e.g.:
-// {
-//   ...
-//   main: 'lib/whatever.js'
-//   ...
-// }
-// --------------------------------------
-//= require jquery
-//= require jquery-ujs
-//= require lodash
-//= require backbone
-//= require handlebars/handlebars.runtime
-//= require fastclick
+// App Dependencies
+// ----------------
+//= require dependencies
 //
 // App Entry point
 // ---------------

data/lib/generators/frenerator/frontend/templates/javascripts/dependencies.coffee

@@ -0,0 +1,18 @@
+# Require all external lib dependencies
+# Sprockets reads bower.json, so you can
+# only require component directory and
+# it will load the main js file, e.g.:
+# {
+#   ...
+#   main: 'lib/whatever.js'
+#   ...
+# }
+#
+# ------------------------
+#= require jquery
+#= require jquery.cookie
+#= require jquery-ujs
+#= require lodash
+#= require backbone
+#= require handlebars/handlebars.runtime
+#= require fastclick

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: frenerator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Anthony Karasavov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -83,6 +83,7 @@ files:
 - lib/generators/frenerator/frontend/templates/javascripts/base/view.coffee
 - lib/generators/frenerator/frontend/templates/javascripts/collections/.keep
 - lib/generators/frenerator/frontend/templates/javascripts/components.coffee
+- lib/generators/frenerator/frontend/templates/javascripts/dependencies.coffee
 - lib/generators/frenerator/frontend/templates/javascripts/main.coffee
 - lib/generators/frenerator/frontend/templates/javascripts/models/.keep
 - lib/generators/frenerator/frontend/templates/javascripts/namespace.js