ng_on_rails 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7057e26bdca810363ede7c7321dfa6c488b205
-  data.tar.gz: 074bf7d73e00c03becd410f63c1605546c63ae3e
+  metadata.gz: 4f212d2b4cb8e37f88d4c87d993abfaeadafc60e
+  data.tar.gz: 0703fa143da3d32eabfcafdfddba2651b4bd746a
 SHA512:
-  metadata.gz: cd18e125548c1a9190d5c69544d9e3fe31a835b4b9bc72af4e6390019589436557208a69dea9d2fe7dbbc89d5f2d62c34f5e81fa316aaa134feda85f9d8a81b6
-  data.tar.gz: d46407676a418af219fd147e511feae0d3dc6933b6b0a1b2d9e71e677178004411ee6ea6645224f1bd92eef0fc502826a731aa9dc686c295d8f86a2baddadd6b
+  metadata.gz: c7e067cfaf1f72ae1e6dba5a1c8962051641c54970517ec4d18c644e184902333648f05a18f05212b17e6ba07c9ce706dc33b49b467e92bbbc4271ed82ba6ad6
+  data.tar.gz: a74e9a03945024bc090581f3ed9e7a00f571447f9d78bc55c7294fd5e287c4a3c1f2fda190b3ffe537af8dbc883d25abbf8b690ca169714a9fcc611126aceddc

data/README.md

@@ -10,7 +10,7 @@ The main motivations behind this gem is to standardize and simplify how AngularJ
 
 I am just getting started but this does function *as-is*.  Some things left to do:
 * Write more specs!!!
-* Create generators for controllers/services/(views?)
+* (Create generators for views?)
 * (ViewHelper functions via shared service?)
 
 ### Install it!
@@ -36,7 +36,7 @@ Finally, in your layout below the `javascript_include_tag "application"` load th
 </script>    
 ```
 
-Here, ng_data is a rails varible discuss [below](#locals_to_json).  A typical application layout (in Slim) might look like...
+Here, ng_data is a rails varible discussed [below](#locals_to_json).  A typical application layout (in Slim) might look like...
 ```slim
 - ng_data = {}
 - ng_data['BUILD'] = true
@@ -61,21 +61,28 @@ html
     == yield :javascripts
 ```
 
+You are now up and running! To generate controllers and resource-services use NgOnRails generators:
+```
+# Assuming the Rails app has a "Page" model:
+$ bundle exec rails g ng_on_rails:controller Page
+$ bundle exec rails g ng_on_rails:resource Page
+```
+
 ##### Service: Rails 
-As will be discussed in detail [below](#locals_to_json) NgOnRails will now provide you with a Rails-service that can be injected into your Angular Controllers.  This service has all your rails variables contained in json.  So @page and @pages will get mapped to Rails.page and Rails.pages to be used by your angular app.
+As will be discussed in detail [below](#locals_to_json), NgOnRails provides a Rails-service that can be injected into your Angular Controllers.  This service has all your rails variables contained in json.  So @page and @pages will get mapped to Rails.page and Rails.pages to be used by your angular app.
 
 ##### Directives: render and render\_view
 NgOnRails provides you with two directives, `render` for displapying angular partials and `render_view` for displaying angular views. More details [here](#render_directives).
 
 ##### Note: NgOnRailsApp
-A AngularApp, NgOnRailsApp, is automatically created if it doesn't already exsit
+An angular-app, NgOnRailsApp, is automatically created if it doesn't already exsit
 ```javascript
 # ng_on_rails/app/assets/javascripts/app.js
 if (!window.NgOnRailsApp){
   window.NgOnRailsApp = angular.module("NgOnRailsApp", ["ngResource","ngAnimate","ngSanitize"])
 }
 ```
-If you want to overide NgOnRailsApp - so you can inject your own providers
+If you want to overide NgOnRailsApp, so you can inject your own providers,
 Just incldue a app.js file that defines NgOnRailsApp in your own app and load it **before** ng\_on\_rails
 ```javascript
 # your_app/app/assets/javascripts/angular_app/app.js 
@@ -127,7 +134,7 @@ Now you can then use the ng\_on\_rails directives 'render' and 'render\_view' to
 
 #### Conventions
 
-The test_app serves as an example of the conventions discussed below, but before looking it over read [this](#test_app).
+The [test_app](https://github.com/brookisme/ng_on_rails/tree/master/spec/test_app) serves as an example of the conventions discussed below, but before looking it over read [this](#test_app).
 
 * Put Angular controllers/directives/... in a folder "angular\_app" in the assets directory.  Similarly, as discussed above, the angular views(partials) are placed in a folder "angular\_app" in the views directory
 ```
@@ -188,10 +195,13 @@ Note that using distinguishing characterisic of loading the controller via `ng_c
 
 
 #### Angular Services for Rails Models
-You are going to have a service for each rails model.  I plan on adding generators but for now this is what my services look like
-
+You are going to have a resource-service for each rails model.  You can create these with the NgOnRails generator
+```
+$ bundle exec rails g ng_on_rails:resource Page
+```
+Which creates the following file:
 ```coffeescript
-# app/assets/javascripts/angular_app/services/page.js.coffee
+# your_app/app/assets/javascripts/angular_app/services/page.js.coffee
 NgOnRailsApp.factory "Page", ($resource) ->
   PageResource = $resource "/questions/:id.json", {id: "@id"}, {
     update:{method: "PUT"}
@@ -202,37 +212,48 @@ NgOnRailsApp.factory "Page", ($resource) ->
 
 
 #### Angular Controllers for Rails Models
-Simalarly you are going to have an angular controller for each rails model.  Again, I plan on adding generators but for now an example is below.  Note that I place all the REST methods in a rest object.  Bridge is a service I use to pass data from one controller to another.
+Simalarly you are going to have an angular controller for each rails model. A controller that uses the Rails-service and pre-defined REST methods can be generated with 
+```
+$ bundle exec rails g ng_on_rails:controller Page
+```
+The output is below (*Note that I place all the REST methods in a rest object*):
 
 ```coffeescript
-NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
-  # setup
+# your_app/app/assets/javascripts/angular_app/controllers/pages_controller.js.coffee
+NgOnRailsApp.controller 'PagesController', ($scope,Page,Rails) ->
+  #
+  # CONTROLLER SETUP
+  #
   ctrl = this
-  ctrl.bridge = Bridge
+  ctrl.rails = Rails
   ctrl.data = {}
 
-  # initializers
+
+  #
+  # INITIALIZERS
+  #
   ctrl.setPage = (page)->
-    ctrl.bridge.data.page = page
+    ctrl.data.page = page
   ctrl.setPages = (pages)->
-    ctrl.bridge.data.pages = pages
+    ctrl.data.pages = pages
+
 
-  # rest methods
+  #  
+  # REST METHODS
+  #
   ctrl.rest =
     index: ->
       params = {}
       Page.query(params).$promise.then (pages) ->
-        ctrl.bridge.data.pages = pages
+        ctrl.data.pages = pages
 
     show: (page_id)->
       Page.get({id: page_id}).$promise.then (page) ->
-        ctrl.bridge.data.page = page
-        ctrl.bridge.data.page_versions = page.page_versions
-
-    new: (doc_id)->
+        ctrl.data.page = page
+        
+    new: ()->
       ctrl.clear()
       ctrl.data.activePage = {}
-      ctrl.data.activePage.doc_id = doc_id
       ctrl.data.creating_new_page = true
 
     create: ->
@@ -242,8 +263,8 @@ NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
         Page.save(
           working_page,
           (page)->
-            ctrl.bridge.data.pages ||= []
-            ctrl.bridge.data.pages.push(page)
+            ctrl.data.pages ||= []
+            ctrl.data.pages.push(page)
             ctrl.clear()
             ctrl.locked = false
           ,
@@ -253,11 +274,9 @@ NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
             ctrl.locked = false
         )
 
-    edit: (page,doc_id) ->
+    edit: (page) ->
       ctrl.clear()
-      page.show_details = false
       ctrl.data.activePage = page
-      ctrl.data.activePage.doc_id = doc_id
       ctrl.data.editing_page = true
 
     update: (page)->
@@ -281,7 +300,7 @@ NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
       Page.delete(
         page, 
         (page)->
-          pages ||= ctrl.bridge.data.pages
+          pages ||= ctrl.data.pages
           pages.splice(index,1)
         ,
         (error)->
@@ -290,22 +309,9 @@ NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
       ctrl.clear()
 
 
-  # scope methods 
-  ctrl.toggleDetails = (page)->
-    page.show_details = !page.show_details
-
-  ctrl.resort = (pages) ->
-    for page, index in pages
-      page.order_index = index + 1
-      Page.update(
-        page,
-       (page)->
-          # success handler
-        ,
-        (error)->
-          console.log("update_error:",error)
-        )
-
+  #    
+  # SCOPE METHODS
+  #
   ctrl.clear = ->
     ctrl.data.activePage = null
     ctrl.data.creating_new_page = false
@@ -315,10 +321,17 @@ NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
     (ctrl.data.editing_page && !!page && page.id == ctrl.data.activePage.id) ||
     (ctrl.data.creating_new_page && !page)
 
-  # private methods
-  some_private_method = ->
-    console.log('nobody knows i exist') 
-  
+
+  #  
+  # PRIVATE METHODS
+  #   
+  # => add methods here, not attached to the ctrl object to be used internally
+  #   
+
+
+  #
+  # END
+  #
   return
 ```
 <a name="locals_to_json"></a>
@@ -342,13 +355,12 @@ To understand it better look at [ng_on_rails_helper.rb](https://github.com/brook
 
 <a name="test_app"></a>
 #### Test App
-The [test_app](https://github.com/brookisme/ng_on_rails/blob/master/app/spec/test_app) can be used as an example application.  A some details to mention:
+The [test_app](https://github.com/brookisme/ng_on_rails/tree/master/spec/test_app) can be used as an example application.  A some details to mention:
 
 * The DB is Postgres
 * The (Angular) Views use Slim
 * The JS uses CoffeeScript (except for _rails_service.js.erb -- where I need access to Rails)
 * Much of app/views/angular_app & app/assests/javascripts/angular_app has been cut and pasted in from a different project and the models have been generated with Rails scaffolding.  This leads to a few oddities:
-  * There is a mixture of both erb and slim
   * The full scaffolding has been left in but the Angular views are contained solely withing the docs-index and doc-show pages.
   * Though there is limited CSS but I use both bootstrap and font-awesome 
 

data/app/assets/javascripts/directives/shared.js.erb

@@ -6,7 +6,6 @@ NgOnRailsApp.directive(
       transclude: true,
       template: function(el,attrs){
         format = attrs.format || "html"
-        console.log(attrs.url,format)
         return '<div ng_include="\'/angular_app/'+attrs.url+'.'+format+'\'"></div>'
       }
     }

data/app/helpers/ng_on_rails_helper.rb

@@ -2,8 +2,6 @@ module NgOnRailsHelper
   def locals_to_json ng_data
     j = ActiveSupport::JSON
     locals_hash = {}
-    puts "***********"
-    puts "#{instance_variable_names}"
     instance_variable_names.each do |var_name|
       unless !!var_name.match(/^@_/)
         unless ignorables.include? var_name

data/lib/generators/ng_on_rails/controller_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+module NgOnRails
+  class ControllerGenerator < Rails::Generators::NamedBase
+    desc "Creates NgOnRails-style AngularJS Controller"
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def generate_layout
+      template "#{ControllerGenerator.source_root}/controller_template.js.erb", "app/assets/javascripts/angular_app/controllers/#{plural_name}_controller.js.coffee"
+    end
+  end
+end

data/lib/generators/ng_on_rails/resource_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+module NgOnRails
+  class ResourceGenerator < Rails::Generators::NamedBase
+    desc "Creates NgOnRails-style AngularJS Resource Service"
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def generate_layout
+      template "#{ResourceGenerator.source_root}/resource_template.js.erb", "app/assets/javascripts/angular_app/services/#{file_name}.js.coffee"
+    end
+  end
+end

data/lib/generators/ng_on_rails/templates/controller_template.js.erb

@@ -0,0 +1,113 @@
+NgOnRailsApp.controller '<%="#{class_name.pluralize}"%>Controller', ($scope,<%="#{class_name}"%>,Rails) ->
+  #
+  # CONTROLLER SETUP
+  #
+  ctrl = this
+  ctrl.rails = Rails
+  ctrl.data = {}
+
+
+  #
+  # INITIALIZERS
+  #
+  ctrl.set<%="#{class_name}"%> = (<%="#{file_name}"%>)->
+    ctrl.data.<%="#{file_name}"%> = <%="#{file_name}"%>
+  ctrl.set<%="#{class_name.pluralize}"%> = (<%="#{plural_name}"%>)->
+    ctrl.data.<%="#{plural_name}"%> = <%="#{plural_name}"%>
+
+
+  #  
+  # REST METHODS
+  #
+  ctrl.rest =
+    index: ->
+      params = {}
+      <%="#{class_name}"%>.query(params).$promise.then (<%="#{plural_name}"%>) ->
+        ctrl.data.<%="#{plural_name}"%> = <%="#{plural_name}"%>
+
+    show: (<%="#{file_name}"%>_id)->
+      <%="#{class_name}"%>.get({id: <%="#{file_name}"%>_id}).$promise.then (<%="#{file_name}"%>) ->
+        ctrl.data.<%="#{file_name}"%> = <%="#{file_name}"%>
+        
+    new: ()->
+      ctrl.clear()
+      ctrl.data.active<%="#{class_name}"%> = {}
+      ctrl.data.creating_new_<%="#{file_name}"%> = true
+
+    create: ->
+      if !(ctrl.locked || ctrl.<%="#{file_name}"%>_form.$error.required)
+        ctrl.locked = true
+        working_<%="#{file_name}"%> = angular.copy(ctrl.data.active<%="#{class_name}"%>)
+        <%="#{class_name}"%>.save(
+          working_<%="#{file_name}"%>,
+          (<%="#{file_name}"%>)->
+            ctrl.data.<%="#{plural_name}"%> ||= []
+            ctrl.data.<%="#{plural_name}"%>.push(<%="#{file_name}"%>)
+            ctrl.clear()
+            ctrl.locked = false
+          ,
+          (error)->
+            console.log("create_error:",error)
+            ctrl.clear()
+            ctrl.locked = false
+        )
+
+    edit: (<%="#{file_name}"%>) ->
+      ctrl.clear()
+      ctrl.data.active<%="#{class_name}"%> = <%="#{file_name}"%>
+      ctrl.data.editing_<%="#{file_name}"%> = true
+
+    update: (<%="#{file_name}"%>)->
+      if !(ctrl.locked || ctrl.<%="#{file_name}"%>_form.$error.required)
+        ctrl.locked = true
+        <%="#{file_name}"%> = ctrl.data.active<%="#{class_name}"%> unless !!<%="#{file_name}"%>
+        working_<%="#{file_name}"%> = angular.extend(angular.copy(<%="#{file_name}"%>),ctrl.data.active<%="#{class_name}"%>)
+        <%="#{class_name}"%>.update(
+          working_<%="#{file_name}"%>,
+          (<%="#{file_name}"%>)->
+            # success handler
+            ctrl.locked = false
+          ,
+          (error)->
+            console.log("update_error:",error)
+            ctrl.locked = false
+        )
+        ctrl.clear()
+
+    delete: (index,<%="#{file_name}"%>,<%="#{plural_name}"%>)->
+      <%="#{class_name}"%>.delete(
+        <%="#{file_name}"%>, 
+        (<%="#{file_name}"%>)->
+          <%="#{plural_name}"%> ||= ctrl.data.<%="#{plural_name}"%>
+          <%="#{plural_name}"%>.splice(index,1)
+        ,
+        (error)->
+          console.log("delete_error:",error)
+      )
+      ctrl.clear()
+
+
+  #    
+  # SCOPE METHODS
+  #
+  ctrl.clear = ->
+    ctrl.data.active<%="#{class_name}"%> = null
+    ctrl.data.creating_new_<%="#{file_name}"%> = false
+    ctrl.data.editing_<%="#{file_name}"%> = false
+
+  ctrl.is_editing = (<%="#{file_name}"%>)->
+    (ctrl.data.editing_<%="#{file_name}"%> && !!<%="#{file_name}"%> && <%="#{file_name}"%>.id == ctrl.data.active<%="#{class_name}"%>.id) ||
+    (ctrl.data.creating_new_<%="#{file_name}"%> && !<%="#{file_name}"%>)
+
+
+  #  
+  # PRIVATE METHODS
+  #   
+  # => add methods here, not attached to the ctrl object to be used internally
+  #   
+
+
+  #
+  # END
+  #
+  return

data/lib/generators/ng_on_rails/templates/resource_template.js.erb

@@ -0,0 +1,6 @@
+NgOnRailsApp.factory '<%="#{class_name}"%>', ($resource) ->
+  <%="#{class_name}"%>Resource = $resource '/<%="#{plural_name}"%>/:id.json', {id: '@id'}, {
+    update:{method: "PUT"}
+  }
+  class <%="#{class_name}"%> extends <%="#{class_name}"%>Resource
+    # place class and instance methods here

data/lib/ng_on_rails/version.rb

@@ -1,3 +1,3 @@
 module NgOnRails
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ng_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brookie Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-04 00:00:00.000000000 Z
+date: 2014-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: angularjs-rails
@@ -97,6 +97,10 @@ files:
 - app/helpers/ng_on_rails_helper.rb
 - app/views/angular_app/_rails_service.js.erb
 - config/routes.rb
+- lib/generators/ng_on_rails/controller_generator.rb
+- lib/generators/ng_on_rails/resource_generator.rb
+- lib/generators/ng_on_rails/templates/controller_template.js.erb
+- lib/generators/ng_on_rails/templates/resource_template.js.erb
 - lib/ng_on_rails.rb
 - lib/ng_on_rails/engine.rb
 - lib/ng_on_rails/version.rb