rang 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b5157225917f1c648bc3240a8f378ec8f0a8a1a
+  data.tar.gz: fc62c25421d25039674ddabb1bdb01ad9a0c2269
+SHA512:
+  metadata.gz: fb2196731bec62126ca4ac17cc99f0afbff3e3b8b4ef3afc7b2d8c59d7e15f075f61366a5a8e58e89915da2e9304cbfbf6fc09b9e31ca344ccb4c871e5f485ee
+  data.tar.gz: 8ecd855626c6e2661a5cf6eccf80020ec802d345a116cabb581d49b5e2af2af5f2d674db54251eeebf0b14d0e90dc082d08ef5c43e08f9cdb81d97a6b79a35ff

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails-meet-angular.gemspec
+gemspec
+
+gem 'byebug'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Caden Lovelace
+
+MIT License
+
+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,195 @@
+# Rang
+
+__VERY EARLY DAYS — much of this is imagined__
+
+This is a gem that makes Rails and Angular play nicely together.
+
+It should replace all the strange initializers and bag of angular_* gems you've
+got in your Rails & Angular project.
+
+Where existing solutions are effective and well-maintained, they are included.
+Otherwise, we've included our own.
+
+## Installation
+
+Add this to your Gemfile:
+
+`gem 'rang'`
+
+Then:
+
+```bash
+$ bundle install
+```
+
+## Quickstart
+
+```bash
+# Prompts you to run each of the generators below.
+$ rails g rang:install
+```
+
+## Features
+
+This gem collects quite a few things. Summary:
+
+* Facilitates the Angular best practice structure.
+* Serves and precompiles Angular templates.
+* Precompiles Angular with DI annotations.
+* Uses [rails-assets](http://rails-assets.org) to manage Bower dependencies.
+* Gets Angular + Rails working together on CSRF protection.
+* Provides an `ng-view` root route.
+* Provides a generator to install and configure [Teaspoon](https://github.com/modeset/teaspoon) for Angular.
+* Configures slim, if available, to ignore `{` and `}`.
+
+### Frontend structure
+
+Instead of using `/assets/javascripts`, `/assets/stylesheets`, etc, this gem
+supports following the best practice structure [recommended by Google](https://docs.google.com/a/cultivatehq.com/document/d/1XXMvReO8-Awi1EZXAXS4PzDzdNvV6pGcuaF4Q9821Es/pub).
+[This very readable post](https://github.com/yeoman/generator-angular/issues/109)
+sets out the rationale and walks through the recommended structure.
+
+What this means in practice is that assets in `assets/frontend` are served and
+compiled just like `assets/javascripts` and `assets/stylesheets` would be.
+
+To get started:
+
+```bash
+# This should be non-destructive, but it's your assets on the line.
+$ rails g rang:assets:init
+```
+
+This moves your existing `/app/assets` to `/app/assets.removed` and sets up a
+fresh assets directory following the best practice structure.
+
+Caveats:
+
+* CSS might still need some special treatment.
+* The structure is still under active refinement. However, this gem is flexible
+  enough to accept most changes.
+
+### Templates
+
+In line with the structure above, Rang also compiles templates into
+Angular's `$templateCache`. You should load them in your routes like this:
+
+```javascript
+angular
+  .module('blog.posts', ['ngRoute'])
+  .config(function($routeProvider) {
+    $routeProvider
+      .when('/posts', {
+        templateUrl: '/assets/posts/posts.html', // Use .html, not .slim, etc
+        controller: 'PostsController'
+      });
+  });
+```
+
+And then in your `application.js`, follow this structure:
+
+```javascript
+//= require angular
+//= require angular-route
+//= require posts/posts
+//= require angular-templates
+
+angular.module('blog', ['blog.posts', 'ngRoute'])
+  .config(function($routeProvider){
+    $routeProvider.otherwise({
+      redirectTo: '/posts'
+    });
+  })
+  .run(AngularTemplates.load);
+```
+
+`AngularTemplates.load` is DI'd with `$templateCache` and includes all the templates
+in your directory tree.
+
+[Slim](https://github.com/slim-template/slim-rails) is automatically supported
+for assets if it's in your `Gemfile`.
+
+### Annotation (minification)
+
+Rang employs [ng-annotate](https://github.com/olov/ng-annotate) (via
+[ngannotiate-rails](https://github.com/kikonen/ngannotate-rails)) to make sure
+your Angular code is minified properly.
+
+### Bower dependencies
+
+Rang uses [rails-assets.org](http://rails-assets.org/) to include
+bower packages. While a little slow sometimes, it's still a better solution than
+requiring npm and bower / having a load of useless stuff in source control. For now.
+
+It manages the rails-assets dependencies in an auxilliary gemfile called
+`Gemfile.bower`. This can be created and managed with generators.
+
+Usage:
+
+```bash
+# Not strictly necessary, but take a look at what it generates.
+$ rails g rang:bower:init
+
+# Adds angular-cookies gem to Gemfile.bower.
+$ rails g rang:bower:add angular-cookies '~ 1.2.0'
+
+# As above, but runs bundler after.
+$ rails g rang:bower:add angular@ '~ 1.2.0'
+```
+
+### Teaspoon
+
+```bash
+$ rails g rang:teaspoon:install
+```
+
+This does the following:
+
+* Adds `teaspoon` & `phantomjs` to your Gemfile.
+* Runs the normal `teaspoon:install` generator.
+* Adds `angular-mocks` to your `Gemfile.bower` and includes it in `spec_helper.js`.
+* Preconfigures Teaspoon to fix some issues ([#120](https://github.com/modeset/teaspoon/issues/120), [#197](https://github.com/modeset/teaspoon/issues/197)).
+* Configures Teaspoon to enable putting specs alongside your code (optional).
+
+### API Configuration
+
+```bash
+$ rails g rang:api:configure
+```
+
+This does the following:
+
+* Installs and confgures [active_model_serializers](https://github.com/rails-api/active_model_serializers/tree/0-9-stable)
+  to serve Angular-appropriate JSON out of the box.
+* Installs and requires [angular-restmod](https://github.com/platanus/angular-restmod),
+  a Rails-inspired ORM for Angular.
+* Sets up an `api/` route and controller scope for your API controllers.
+
+### CSRF
+
+Rang uses [angular_rails_csrf](https://github.com/jsanders/angular_rails_csrf)
+to join up Rails + Angular's CSRF protection.
+
+So you don't need to feel bad turning it off anymore!
+
+### Root route
+
+To avoid having a controller just to serve 'ng-view' there's a convenience
+action for you to wire your root to.
+
+```bash
+$ rails g rang:add_root
+```
+
+Adds this to `config/routes.rb`:
+
+```ruby
+mount Rang::Engine => "/"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails-meet-angular/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,43 @@
+## Angular-rails Gem
+
+### Requirements
+
+#### Examples
+
+#### Other
+* Breakout bundle!
+
+
+### Done
+* ~~Docs for teaspoon installer.~~
+* ~~Convenience root route to ng-view.~~
+* ~~Consider where to put Gemfile.bower include.~~
+* ~~Refactor bower:init generator to use bower:add~~
+* ~~Support inline JS tests.~~
+* ~~Neaten up generator when executed multiple times.~~
+* ~~CSRF protection with [angular_rails_csrf](https://github.com/jsanders/angular_rails_csrf)~~
+* ~~Get Asset precompilation working.~~
+* ~~Check if asset precompilation is working.~~
+* ~~Minification using ng-min/ng-annotate~~
+* ~~Support modern structure for AngularJS assets.~~
+* ~~Bower stuff thru [rails-assets](https://rails-assets.org/).~~
+* ~~Rename it to something shorter.~~
+* ~~Stop templates precompiling individually.~~
+* ~~Add initializer for:~~
+    * ~~Disabling-disabling precompilation of htm files.~~
+    * ~~That one weird trick that sprockets developers don't want you to know!~~
+* ~~Document weird trick.~~
+* ~~Support for angular templates using ERB, Slim~~.
+* ~~Add optional ng-app adjustments.~~
+* ~~__??__ Provide structure for Angular JS assets thru generators.~~
+* ~~Scope API routes~~
+* ~~Smooth out API calls between Rails + Angular~~
+  - ~~[Angular restmod](https://github.com/platanus/angular-restmod)~~
+  - ~~Active model serializers?~~
+* ~~Check if we can find out whether we're precompiling and stop injecting templates
+  in 'development' env.~~
+* ~~Change docs/defaults for template precompilation.~~
+* ~~Add minimal example/starter data.~~
+* ~~Make assets.removed more obvious.~~
+* ~~Add test example.~~
+* ~~Add FDL for wikipedia content.~~

data/app/controllers/rang/application_controller.rb

@@ -0,0 +1,4 @@
+module Rang
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/rang/root_controller.rb

@@ -0,0 +1,7 @@
+module Rang
+  class RootController < ApplicationController
+    def display
+      render text: '<div ng-view></div>', layout: 'application'
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rang::Engine.routes.draw do
+  get '/' => 'root#display'
+end

data/lib/rails/generators/rang/add_root/add_root_generator.rb

@@ -0,0 +1,12 @@
+module Rang
+  module Generators
+    class AddRootGenerator < Rails::Generators::Base
+      desc "Adds a root route that is just ng-view."
+
+      def add_route
+        route "mount Rang::Engine => \"/\"\n"
+      end
+
+    end
+  end
+end

data/lib/rails/generators/rang/api/configure/configure_generator.rb

@@ -0,0 +1,70 @@
+module Rang
+  module Api
+    module Generators
+      class ConfigureGenerator < Rails::Generators::Base
+        desc "Configures a sensible default API interface using active_model_serializers and angular-restmod."
+        source_root File.expand_path("../templates", __FILE__)
+
+        def add_angular_restmod_to_gemfile
+          generate "rang:bower:add", "angular-restmod '~> 0.16' quiet"
+        end
+
+        def add_active_model_serializers_to_gemfile
+          gem "active_model_serializers", "~> 0.9.0"
+        end
+
+        def bundle_install
+          bundle!
+        end
+
+        def add_ams_initializer
+          template "active_model_serializer.rb", "config/initializers/active_model_serializer.rb"
+        end
+
+        def add_route_api_scope
+          route "scope 'api(/:version)', :module => :api, :version => /v\d+?/, :defaults => {format: :json} do\n    # API routes go here\n  end\n"
+        end
+
+        def add_controller_api_namespace
+          empty_directory "app/controllers/api"
+        end
+
+        def add_example_serializer
+          generate "serializer", "example title:string body:string"
+        end
+
+        def add_to_application_js
+          application_js_path = Rails.application.assets.find_asset("application.js").pathname.to_s
+
+          if !no? "\n\nAdd angular-restmod to application.js? [Yn]", :cyan
+            inject_into_file application_js_path, after: /^\/\/= require angular$/ do
+              "\n//= require angular-restmod/angular-restmod-bundle"
+            end
+          end
+        rescue
+          say "Application.js not found, not adding require for angular-restmod.", :red
+        end
+
+        def inform_of_actions
+          say "\n\n      ******      \n\n"
+          say "\nAPI Configured, using:\n\n", :green
+          say "## Active_model_serializers", :bold
+          say "An example serializer has been written in app/serializers/example_serializer.rb", :cyan
+          say "You can (and should) read the full docs here: https://github.com/rails-api/active_model_serializers/tree/0-9-stable\n\n", :cyan
+          say "## Angular-restmod", :bold
+          say "A Rails-inspired ORM for Angular.", :cyan
+          say "Full docs here: https://github.com/platanus/angular-restmod", :cyan
+          say "You will need to include 'restmod' in the angular.module calls where you want to use it.\n\n", :cyan
+        end
+
+        private
+
+        def bundle!
+          Bundler.with_clean_env do
+            run "bundle install"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/rang/api/configure/templates/active_model_serializer.rb

@@ -0,0 +1,5 @@
+# Disable for all serializers (except ArraySerializer)
+ActiveModel::Serializer.root = false
+
+# Disable for ArraySerializer
+ActiveModel::ArraySerializer.root = false

data/lib/rails/generators/rang/assets/init/init_generator.rb

@@ -0,0 +1,52 @@
+module Rang
+  module Assets
+    module Generators
+      class InitGenerator < Rails::Generators::Base
+        desc "Sets up assets for recommended Angular structure."
+        source_root File.expand_path("../templates", __FILE__)
+
+        def deprecate_old_assets!
+          empty_directory 'app/assets.removed'
+
+          ["javascripts", "stylesheets"].each do |dir|
+            if File.exist? "app/assets/#{dir}"
+              say_status :move, "app/assets/#{dir} -> app/assets.removed/#{dir}"
+              run "mv app/assets/#{dir} app/assets.removed/#{dir}", verbose: false
+            end
+            remove_dir "app/assets/#{dir}"
+          end
+        end
+
+        def create_assets!
+          template 'application.js', 'app/assets/frontend/application.js'
+          template 'application.scss', 'app/assets/frontend/application.scss'
+          template '_base.scss', 'app/assets/frontend/style/_base.scss'
+          template 'components.js', 'app/assets/frontend/components/components.js'
+        end
+
+        def add_html_attribute
+          if !no? "\n\nAdd ng-app='#{Rang::Util.application_name}' to application.html? [Yn]", :cyan
+            in_root do
+              if layout_handler == "ActionView::Template::Handlers::ERB"
+                gsub_file layout_file, "<html>", "<html ng-app='#{Rang::Util.application_name}'>"
+              elsif layout_handler == "Slim::RailsTemplate"
+                gsub_file layout_file, /^html$/, "html ng-app='#{Rang::Util.application_name}'"
+              end
+            end
+          end
+        end
+
+        private
+
+        def layout_file
+          ::ApplicationController.new.send(:_layout).identifier
+        end
+
+        def layout_handler
+          ::ApplicationController.new.send(:_layout).handler.class.to_s
+        end
+
+      end
+    end
+  end
+end