ng_on_rails 0.0.1.1 → 0.0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 860ad222b095f68565829faef6dcc5916ed0fa57
-  data.tar.gz: 12a1dd002e1159b4327e3102f80bb904e3f0554a
+  metadata.gz: cf5e98c33661afb66786a5d04b5527ed082db98e
+  data.tar.gz: 77df1507938c1ccf493367b57a667fe285565d95
 SHA512:
-  metadata.gz: 80ab5b7e833861c61ccd12027808a039bbe5b4b2e3996d83fb8903bee00db3468207d2702ffd82ebc0eae29ffd61a8a175de5b367121871d9ad737e04f4ef46f
-  data.tar.gz: 7e0d0fe11149876447bdb385ffbc2911f068e7af8a6e5d818948a034bedbeaf4b4cd204df3d65a96679b3c730da23e6750a9c235070ddd602a0fc72c8eb3f73a
+  metadata.gz: 7897c440eceb597afc38d6f698d818595bc24c1cf2169e62acfc898b56688e2842377f305256a11c8761729598a330b2bdb9b84cfad53023a1e8e7d9bc5bb7e9
+  data.tar.gz: 0c2bba831949cd6c300dfd0c352a36aa86cfcd60aaab2448751a0a0143b1b5c122cd3c617dd9feb8cd5e3c7dee74ee8d47bb37d6aa4528505b0461655125ec80

data/README.md

@@ -13,9 +13,39 @@ I am just getting started but this does function *as-is*.  Some things left to d
 * Create generators for controllers/services/(views?)
 * (ViewHelper functions via shared service?)
 
-Install it!
+### Install it!
 ```
+# Gemfile
 gem 'ng_on_rails'
+
+# your_app/app/assets/javascripts/application.js
+//
+//= require angular
+//= require angular-resource
+//= require angular-animate
+//= require angular-sanitize
+//= require ng_on_rails
+//= require_tree .
+```
+
+Note: NgOnRailsApp is automatically created if it doesn't already exsit
+```javascript
+# 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
+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 
+window.NgOnRailsApp = angular.module("NgOnRailsApp", ["ngResource","ngAnimate","ngSanitize","angular-sortable-view"])
+
+# your_app/app/assets/javascripts/application.js
+//= require ...
+//= require angular_app/app.js
+//= require ng_on_rails
+//= require tree.
 ```
 
 I would love feed back (especially on convention choices) and possibly other contributers.  Send me a note!
@@ -26,7 +56,7 @@ As time goes on generators for angular controllers and services (rails-models) w
 
 It relies on two pieces of slight magic
 
-1. a "Rails" service that holds all your rails variables.  This service automatically turns rails instance variables into json that can be used by Angular. For example the rails instance variable `@pages` will get mapped to `Rails.pages` that can be used by angular
+* a "Rails" service that holds all your rails variables.  This service automatically turns rails instance variables into json that can be used by Angular. For example the rails instance variable `@pages` will get mapped to `Rails.pages` that can be used by angular
 ```
 <div ng-repeat="page in Rails.pages">...
 ```
@@ -37,7 +67,8 @@ To get this work you simply need to load the rails_service.js.erb partial
 </script>    
 ```
 "rails_service.js.erb" calls the `locals_to_json` helper method to automatically turn instance variables into json.  Here `ng_data` is a local rails variable used to customize how this is converted. This will be discussed in detail [below](#locals_to_json).
-2. Your angular views(partials) should be placed in app/views/angular_app.  This solution is discussed in a handfull of places including [here](http://stackoverflow.com/questions/12116476/rails-static-html-template-files-in-the-asset-pipeline-and-caching-in-developmen), but the key parts are:
+
+* Your angular views(partials) should be placed in app/views/angular_app.  This solution is discussed in a handfull of places including [here](http://stackoverflow.com/questions/12116476/rails-static-html-template-files-in-the-asset-pipeline-and-caching-in-developmen), but the key parts are:
 ```ruby
 # routes.rb
 scope :angular_app do
@@ -69,6 +100,8 @@ to load your angualar views in at 'app/views/angular_app'
 
 #### Conventions
 
+The 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
 ```
 |-- app/
@@ -109,7 +142,7 @@ You are going to have a service for each rails model.  I plan on adding generato
 ```coffeescript
 # app/assets/javascripts/angular_app/services/page.js.coffee
 NgOnRailsApp.factory "Page", ($resource) ->
-  PageResource = $resource "/survey_link/questions/:id.json", {id: "@id"}, {
+  PageResource = $resource "/questions/:id.json", {id: "@id"}, {
     update:{method: "PUT"}
   }
   class Page extends PageResource
@@ -246,17 +279,27 @@ As mentioned using the Rails-service you can get access to all your rails variab
   = render( partial: 'angular_app/rails_service', formats: ['js'], locals: { ng_data: ng_data} )
 </script>    
 ```
-Here, ng_data is a local rails variable that tells you have to do the conversion:
+Here, ng_data is a local rails variable that describes how to create the json:
 
 * if ng_data is nil all varibles will be converted with `.to_json` ( or if its a string/numeric with .to_s )
 * if `ng_data['BUILD'].blank?` the default will be to use `.to_json` for conversion.
 * if `ng_data['BUILD']=true` the default will be to look for a `.json` file in the app/views directory. It will guess the name and path to this file using the name of var. For instance, if we have @page it will look for the the file app/views/pages/page.json.
-* if `ng_data[var_name].blank?` the conversion will use the defaults discussed above
-* if `ng_data[var_name]={ path: 'path/to/file', as: model_name } it will use this info to try and find the build file.  For instance, suppose I have a collection of pages called `@admin_pages`. Then `ng_data['admin_pages'] = { path: "survey_link/pages/pages", as: :pages }` will look for the file app/views/pages/pages.json seting the local variable `pages = @admin_pages`.
+* if `ng_data[var_name].blank?` the conversion will use the default discussed above
+* if `ng_data[var_name]={ path: 'path/to/file', as: model_name } it will use this info to try and find the build file.  For instance, suppose I have a collection of pages called `@admin_pages`. Then `ng_data['admin_pages'] = { path: "pages/pages", as: :pages }` will look for the file app/views/pages/pages.json seting the local variable `pages = @admin_pages`.
 
 To understand it better look at [ng_on_rails_helper.rb](https://github.com/brookisme/ng_on_rails/blob/master/app/helpers/ng_on_rails_helper.rb).
 
-
+<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 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/helpers/ng_on_rails_helper.rb

@@ -2,6 +2,8 @@ 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
@@ -58,7 +60,8 @@ private
       "@controller", 
       "@request", 
       "@output_buffer", 
-      "@rendered"
+      "@rendered",
+      "@marked_for_same_origin_verification"
     ]
   end
 

data/lib/ng_on_rails/engine.rb

@@ -1,3 +1,6 @@
+require 'angularjs-rails'
+require 'angular_rails_csrf'
+
 module NgOnRails
   class Engine < ::Rails::Engine
     initializer 'ng_on_rails.load_static_assets' do |app|

data/lib/ng_on_rails/version.rb

@@ -1,3 +1,3 @@
 module NgOnRails
-  VERSION = "0.0.1.1"
+  VERSION = "0.0.1.2"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ng_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1.1
+  version: 0.0.1.2
 platform: ruby
 authors:
 - Brookie Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2014-10-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: angularjs-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.22
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.22
+- !ruby/object:Gem::Dependency
+  name: angular_rails_csrf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement