ng_on_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 112566d25c565d9a8f6354967833d96c630284f4
+  data.tar.gz: 509e0df4fb071e2fbdae781ba2f255ae266b33f4
+SHA512:
+  metadata.gz: 39650330a0379e048903523177fd690a09275481d715426b67c4c05ddf7bc43d350389c76696a88c22a965753f26f5c67f037e5dfa4672af3d6f09c3e2ab3e8b
+  data.tar.gz: 16f22ef0f8319ed9c2298f16f82512b6c19931904002764729ee21471a6c9d192cab13c42371f82d67c5ef759ad2173f0e65bd9cfccc34f3e75b73dce91d20aa

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,259 @@
+##### *This project is still in developement and uses MIT-LICENSE.*
+
+-----------------------------------------------------------
+
+### NgOnRails
+
+*A Rails inspired framework for using AngularJS with Rails*
+
+The main motivations behind this gem is to standardize and simplify how AngularJS is integrated in a rails  application.  
+
+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?)
+* (ViewHelper functions via shared service?)
+
+I would love feed back (especially on convention choices) and possibly other contributers.  Send me a note!
+
+#### Overview
+
+As time goes on generators for angular controllers and services (rails-models) will be added, as well as some view helpers and directives.  For the time being however the the gem is rather simple.
+
+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
+```
+<div ng-repeat="page in Rails.pages">...
+```
+To get this work you simply need to load the rails_service.js.erb partial
+```html.erb
+<script>
+  = render( partial: 'angular_app/rails_service', formats: ['js'], locals: { ng_data: ng_data} )
+</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:
+```ruby
+# routes.rb
+scope :angular_app do
+    get ':path.html' => 'ng_on_rails#template', constraints: { path: /.+/ }
+end
+
+# ng_on_rails_controller.rb
+def template
+  @path = params[:path]
+  render template: '/angular_app/' + @path, layout: nil
+end
+```
+You can then use the angular directive 'render'
+```javascript
+NgOnRailsApp.directive(
+  "render", 
+  function(){
+    return {
+      restrict: "AE",
+      transclude: true,
+      template: function(el,attrs){
+        return '<div ng_include="\'/angular_app/'+attrs.url+'.html\'"></div>'
+      }
+    }
+  }
+)
+```
+to load your angualar views in at 'app/views/angular_app'
+
+#### Conventions
+
+* 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/
+  |-- assests/
+    |-- javascripts/
+      |-- angular_app/
+       |-- controllers/
+       |-- directives/
+       |-- services/
+       |- app.js
+  |-- views/
+    |-- angular_app/
+
+```
+Files should be named/put in folders in the same maner that you would in Rails.  For instance, if you have a Page model, you would have a pages_controller.js and a service page.js. Then under views you would have pages/{show.html,index.html,...}.  *The way these views are handled makes them more like partials that views but for now at least I am not prefixing the name with and underscore  "\_"*
+
+* As for views, I try to have as little AngularJS outside of my angular_app folder.  I will load the "Rails" service and set `ng-app="NgOnRailsApp"` in the application layout.  Additionally I will usuallly have an angular `AppController` that is very limited in behavior that is part of the application layout.  Again assuming I have a "Page" model I will handle the views like this
+
+```html
+# app/views/pages/index.html
+<!-- Apart from this render directive don't put any other angular in this file -->
+<div render="true" url="pages/index" ng-init="pages=ctrl.rails.pages"></div>
+
+
+# app/views/angular_app/pages/show.html
+<div ng_controller="PagesController as ctrl">
+  <div ng-repeat="page in pages">
+    <div ng-show="ctrl.is_editing(page)">... 
+```
+*In the above, `ctrl.rails` has been set to the Rails service in the AppController*
+
+* This brings up another point.  Use the Controller-As syntax!  I know there are people who aren't a fan.  However in most apps where I am using angular there is a complicated Model structure.   I necessarly want to edit all these things on a single page, though spread out through many partials. Controller-As really really helps keep the logic clear.
+
+
+#### 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
+
+```coffeescript
+# app/assets/javascripts/angular_app/services/page.js.coffee
+NgOnRailsApp.factory "Page", ($resource) ->
+  PageResource = $resource "/survey_link/questions/:id.json", {id: "@id"}, {
+    update:{method: "PUT"}
+  }
+  class Page extends PageResource
+    # place class and instance methods here if you want them.
+```
+
+
+#### 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.
+
+```coffeescript
+NgOnRailsApp.controller 'PagesController', ($scope,Page,Bridge) ->
+  # setup
+  ctrl = this
+  ctrl.bridge = Bridge
+  ctrl.data = {}
+
+  # initializers
+  ctrl.setPage = (page)->
+    ctrl.bridge.data.page = page
+  ctrl.setPages = (pages)->
+    ctrl.bridge.data.pages = pages
+
+  # rest methods
+  ctrl.rest =
+    index: ->
+      params = {}
+      Page.query(params).$promise.then (pages) ->
+        ctrl.bridge.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.clear()
+      ctrl.data.activePage = {}
+      ctrl.data.activePage.doc_id = doc_id
+      ctrl.data.creating_new_page = true
+
+    create: ->
+      if !(ctrl.locked || ctrl.page_form.$error.required)
+        ctrl.locked = true
+        working_page = angular.copy(ctrl.data.activePage)
+        Page.save(
+          working_page,
+          (page)->
+            ctrl.bridge.data.pages ||= []
+            ctrl.bridge.data.pages.push(page)
+            ctrl.clear()
+            ctrl.locked = false
+          ,
+          (error)->
+            console.log("create_error:",error)
+            ctrl.clear()
+            ctrl.locked = false
+        )
+
+    edit: (page,doc_id) ->
+      ctrl.clear()
+      page.show_details = false
+      ctrl.data.activePage = page
+      ctrl.data.activePage.doc_id = doc_id
+      ctrl.data.editing_page = true
+
+    update: (page)->
+      if !(ctrl.locked || ctrl.page_form.$error.required)
+        ctrl.locked = true
+        page = ctrl.data.activePage unless !!page
+        working_page = angular.extend(angular.copy(page),ctrl.data.activePage)
+        Page.update(
+          working_page,
+          (page)->
+            # success handler
+            ctrl.locked = false
+          ,
+          (error)->
+            console.log("update_error:",error)
+            ctrl.locked = false
+        )
+        ctrl.clear()
+
+    delete: (index,page,pages)->
+      Page.delete(
+        page, 
+        (page)->
+          pages ||= ctrl.bridge.data.pages
+          pages.splice(index,1)
+        ,
+        (error)->
+          console.log("delete_error:",error)
+      )
+      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)
+        )
+
+  ctrl.clear = ->
+    ctrl.data.activePage = null
+    ctrl.data.creating_new_page = false
+    ctrl.data.editing_page = false
+
+  ctrl.is_editing = (page)->
+    (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') 
+  
+  return
+```
+<a name="locals_to_json"></a>
+#### Rails variables to Angular-able json.
+
+As mentioned using the Rails-service you can get access to all your rails variables in angular.  
+```html.erb
+<script>
+  = 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:
+
+* 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`.
+
+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).
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NgOnRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/app.js

@@ -0,0 +1,3 @@
+if (!window.NgOnRailsApp){
+  window.NgOnRailsApp = angular.module("NgOnRailsApp", ["ngResource","ngAnimate","ngSanitize"])
+}

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

@@ -0,0 +1,12 @@
+NgOnRailsApp.directive(
+  "render", 
+  function(){
+    return {
+      restrict: "AE",
+      transclude: true,
+      template: function(el,attrs){
+        return '<div ng_include="\'/angular_app/'+attrs.url+'.html\'"></div>'
+      }
+    }
+  }
+)

data/app/assets/javascripts/ng_on_rails.js

@@ -0,0 +1,3 @@
+//
+//= require_tree .
+//

data/app/controllers/ng_on_rails_controller.rb

@@ -0,0 +1,6 @@
+class NgOnRailsController < ApplicationController
+  def template
+    @path = params[:path]
+    render template: '/angular_app/' + @path, layout: nil
+  end
+end

data/app/helpers/ng_on_rails_helper.rb

@@ -0,0 +1,77 @@
+module NgOnRailsHelper
+  def locals_to_json ng_data
+    j = ActiveSupport::JSON
+    locals_hash = {}
+    instance_variable_names.each do |var_name|
+      unless !!var_name.match(/^@_/)
+        unless ignorables.include? var_name
+          name = var_name.gsub("@","")
+          instance_var = instance_variable_get(var_name)
+          unless instance_var.blank?
+            if ng_data.blank?
+              rv = instance_var
+            else
+              unless ng_data[name] == "IGNORE"
+                if !ng_data[name]
+                  if !!ng_data["BUILD"] 
+                    rv = build(name,instance_var)
+                  else
+                    rv = instance_var
+                  end
+                elsif ng_data[name]=="BUILD"
+                  rv = build(name,instance_var)
+                elsif ng_data[name].class==Hash
+                  path = ng_data[name][:path]
+                  model_name = ng_data[name][:as] || name
+                  rv = build(model_name,instance_var,path)
+                end
+              end        
+            end
+            unless !defined?(rv) || rv.blank?
+              if (rv.is_a?(String) && !is_json?(rv)) || rv.is_a?(Numeric)
+                locals_hash[name] = rv
+              elsif is_json?(rv)
+                locals_hash[name] = j.decode(rv)
+              else
+                locals_hash[name] = j.decode(rv.to_json)
+              end
+            end  
+          end
+        end
+      end
+    end
+    return locals_hash.to_json
+  end
+
+private
+  
+  def ignorables
+    [
+      "@view_renderer",
+      "@view_flow",
+      "@output_buffer",
+      "@virtual_path",
+      "@fixture_connections",
+      "@example", 
+      "@fixture_cache", 
+      "@loaded_fixtures", 
+      "@controller", 
+      "@request", 
+      "@output_buffer", 
+      "@rendered"
+    ]
+  end
+
+  def is_json? string
+    begin
+      !!JSON.parse(string)
+    rescue
+      false
+    end
+  end
+
+  def build name, var, path=nil
+    path = name unless !!path
+    render(path.to_s+'.json',  name.to_sym => var)
+  end
+end

data/app/views/angular_app/_rails_service.js.erb

@@ -0,0 +1,3 @@
+NgOnRailsApp.service('Rails', function(){
+  return JSON.parse('<%= raw(locals_to_json(ng_data)) %>')
+});

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  # AngularJS Templates
+  scope :angular_app do
+    get ':path.html' => 'ng_on_rails#template', constraints: { path: /.+/ }
+  end
+end

data/lib/ng_on_rails.rb

@@ -0,0 +1,3 @@
+require "ng_on_rails/engine"
+module NgOnRails
+end

data/lib/ng_on_rails/engine.rb

@@ -0,0 +1,11 @@
+module NgOnRails
+  class Engine < ::Rails::Engine
+    initializer 'ng_on_rails.load_static_assets' do |app|
+      app.middleware.use ::ActionDispatch::Static, "#{root}/app"
+    end
+
+    initializer "ng_on_rails.view_helpers" do
+      ActionView::Base.send :include, NgOnRailsHelper
+    end
+  end
+end

data/lib/ng_on_rails/version.rb

@@ -0,0 +1,3 @@
+module NgOnRails
+  VERSION = "0.0.1"
+end

data/lib/tasks/ng_on_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ng_on_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ng_on_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brookie Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails inspired framework for using AngularJS with Rails
+email:
+- brookwilliams@laborvoices.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/app.js
+- app/assets/javascripts/directives/shared.js.erb
+- app/assets/javascripts/ng_on_rails.js
+- app/controllers/ng_on_rails_controller.rb
+- app/helpers/ng_on_rails_helper.rb
+- app/views/angular_app/_rails_service.js.erb
+- config/routes.rb
+- lib/ng_on_rails.rb
+- lib/ng_on_rails/engine.rb
+- lib/ng_on_rails/version.rb
+- lib/tasks/ng_on_rails_tasks.rake
+homepage: http://www.laborvoices.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Rails inspired framework for using AngularJS with Rails
+test_files: []