rg 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b2243ffb907e6ebf5a68178636e7fd29b9c0135
+  data.tar.gz: d177c4be42867e7bcae9af1e2ade9775abda21ef
+SHA512:
+  metadata.gz: 2ffd7eb0568e088dd9f4ae794dcf36cfd5d46664047bd3f8a101a17b4704f2323c1f4eb759541f8905d8ca417daca3f34ac4befa740a2df08fff72e72fa74345
+  data.tar.gz: 64684d74676a0f1025767baa445c24e8f2190a8ffdf23161bb32efe130a0b770db055e4548c88dcc4c911e0c9925924754f1a4b566e48aa167c3bf0f0e1d3f57

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.1.1
+
+- Re-release to fix errors in 0.1.0 rubygems version
+
+## 0.1.0
+
+- Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Jan Lelis
+
+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,70 @@
+# Regular: Rails + Angular
+
+Opinionated way to use [AngularJS](http://angularjs.org) in a [Rails](http://rubyonrails.org)/[Rails-API](https://github.com/rails-api/rails-api) app using
+
+- [CoffeeScript](http://coffeescript.org/) for code, because it looks good.
+- [Bower](http://bower.io) for managing frontend libraries, because it's simple.
+- [angularjs-rails-resource](https://github.com/FineLinePrototyping/angularjs-rails-resource), because why not use it?
+
+By using this gem, you will
+- Be able to use Angular + Rails
+- Adopt a convention about your Angular directory structure and
+- Get some basic, but handy generators!
+- Delegate Angular/frontend library management to Bower
+- Still live in Ruby land (i.e. you can do E2E testing using Capybara)
+
+You are invited to read [this blog post](http://ruby.janlelis.de/69-the-carb-stack-coffee-angular-rails-bower) for background information on this mindset (*CARB*).
+
+## Setup
+
+Make sure [you have bower installed](http://bower.io/#installing-bower). Then add this to your Gemfile:
+
+    gem 'rg'
+
+Run `bundle` on the command-line and setup your angular project:
+
+    # Set up a new .bowerrc file and bower.json file
+    rails g rg:bower
+    # Use bower to install latest angulars
+    bower install angular angularjs-rails-resource --save
+    # Set up the angular app directory and add to sprocket manifest
+    rails g rg:install --manifests=application.js
+
+Alternatively, you can run all the previous commands via rake:
+
+    rake rg:setup
+
+## Views
+
+This gem does not mandate how you should organize your views. Don't forget to:
+
+- include the JavaScript manifest file (once) in your HTML
+- include the `ng-app` directive in your HTML
+- turn off turbolinks (remove from manifest file, HTML, Gemfile)
+
+## Generators
+
+You have the following generators to create new Angular files for you:
+
+- rg:service <name>
+- rg:resource <name>
+- rg:controller <name>
+- rg:filter <name>
+- rg:directive <name>
+- rg:app <name>
+
+The generators only generate very basic file content. While this is intended, there might be --options for power users in the future.
+
+## Todo
+
+This gem is not finished, yet. Feel free to contribute:
+
+- Turbolink support
+- Add scaffold generator
+- Add serializer generator + directory
+- Add capabilities to rg:app to optionally create routing
+- Generate JS Tests
+
+## Credits
+
+(c) 2013 Jan Lelis <janlelis.de>, MIT LICENSE

data/Rakefile

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new

data/lib/generators/rg/app_generator.rb

@@ -0,0 +1,11 @@
+module Rg
+  class AppGenerator < ::Rails::Generators::NamedBase
+    desc "Creates a new angular app config"
+    include Helper
+
+
+    def create_app_config
+      template 'app/config.coffee.erb', APP_PATH + "/app/#{file_name}.coffee"
+    end
+  end
+end

data/lib/generators/rg/bower_generator.rb

@@ -0,0 +1,32 @@
+require 'json'
+
+module Rg
+  class BowerGenerator < ::Rails::Generators::Base
+    desc "Generates a new .bowerrc and an iniatial bower.json"
+
+
+    class_option :name,      type: :string, default: Rg::Helper.railsName,
+      desc: "Name for the new angular project (will be used as angular app name)"
+    class_option :directory, type: :string, default: "vendor/assets/bower",
+      desc: 'Directory to install your bower components for your .bowerrc'
+    class_option :version,   type: :string, default: "0.0.0",
+      desc: 'Semantic vesion'
+    class_option :license,   type: :string,
+      desc: "License to use"
+    class_option :authors,   type: :array,
+      desc: "Authors"
+
+
+    def bower_rc(directory = nil)
+      create_file '.bowerrc', JSON.pretty_generate(
+        directory: options[:directory],
+      )
+    end
+
+    def bower_json
+      output = options.to_hash
+      output.delete "directory"
+      create_file 'bower.json', JSON.pretty_generate(output)
+    end
+  end
+end

data/lib/generators/rg/controller_generator.rb

@@ -0,0 +1,11 @@
+module Rg
+  class ControllerGenerator < ::Rails::Generators::NamedBase
+    desc "Creates a new angular controller"
+    include Helper
+
+
+    def create_controller
+      template 'controller.coffee.erb', APP_PATH + "/controllers/#{file_name}_controller.coffee"
+    end
+  end
+end

data/lib/generators/rg/directive_generator.rb

@@ -0,0 +1,11 @@
+module Rg
+  class DirectiveGenerator < ::Rails::Generators::NamedBase
+    desc "Creates a new angular directive"
+    include Helper
+
+
+    def create_directive
+      template 'directive.coffee.erb', APP_PATH + "/directives/#{file_name}.coffee"
+    end
+  end
+end

data/lib/generators/rg/filter_generator.rb

@@ -0,0 +1,11 @@
+module Rg
+  class FilterGenerator < ::Rails::Generators::NamedBase
+    desc "Creates a new angular filter"
+    include Helper
+
+
+    def create_filter
+      template 'filter.coffee.erb', APP_PATH + "/filters/#{file_name}.coffee"
+    end
+  end
+end

data/lib/generators/rg/install_generator.rb

@@ -0,0 +1,91 @@
+module Rg
+  class InstallGenerator < ::Rails::Generators::Base
+    desc "Creates a new angular project structure"
+    include Helper
+
+
+    class_option :manifests, type: :array, default: [],
+      desc: "List sprocket manifests in which angular should be included"
+    class_option :libraries, type: :array, default: %w[
+        angular
+        angularjs-rails-resource
+        ./angular/app/main
+      ],
+      desc: "JavaScript libraries/files to add to manifests"
+    class_option :'csrf-token', type: :boolean, default: true,
+      desc: "Create Rails CSRF-Token configuration"
+    class_option :'backend-url', type: :string, default: '',
+      desc: "Path to your Rails-API backend"
+
+    def create_directories
+      say 'Creating new angular directory structure'
+      %w[
+        app
+        services
+        resources
+        controllers
+        filters
+        directives
+      ].each{ |directory|
+        create_file APP_PATH + '/' + directory + '/.keep'
+      }
+    end
+
+    def create_main_coffee
+      say "Creating app/main.coffee file"
+      template 'app/main.coffee.erb', APP_PATH + '/app/main.coffee'
+    end
+
+    def create_settings_coffee
+      say "Creating app/settings.coffee file"
+      @backend_url = options[:'backend-url']
+      template 'app/settings.coffee.erb', APP_PATH + '/app/settings.coffee'
+    end
+
+    def create_csrf_token_coffee
+      return unless options[:"csrf-token"]
+      say "Creating app/csrf_token.coffee file"
+      template 'app/csrf_token.coffee.erb', APP_PATH + '/app/csrf_token.coffee'
+    end
+
+    def inject_into_sprockets
+      options[:manifests].each{ |manifest_file|
+        manifest_path = JS_PATH + '/' + manifest_file
+        if File.exists?(manifest_path)
+          manifest_data = File.read(manifest_path)
+          options[:libraries].reverse.each{ |library|
+            unless manifest_data =~ /require #{library}( |$)/
+              prepend_to_manifest manifest_path, library
+            end
+          }
+        else
+          create_manifest manifest_path, options[:libraries]
+        end
+      }
+    end
+
+    private
+
+    def manifest_content(config = {})
+      Array(config[:libraries]).map{ |library|
+        "#{ config[:ext] == '.coffee' ? '#' : '//' }= require #{library}\n"
+      }.join
+    end
+
+    def prepend_to_manifest(manifest_path, libraries)
+      say "Injecting #{libraries} into manifest at #{manifest_path}"
+      prepend_to_file manifest_path, "\n" + manifest_content(
+        libraries: libraries,
+        ext: File.extname(manifest_path),
+      )
+    end
+
+    def create_manifest(manifest_path, libraries)
+      say "Creating new manifest at #{manifest_path}"
+      create_file manifest_path, manifest_content(
+        libraries: libraries,
+        ext: File.extname(manifest_path),
+      )
+    end
+  end
+end

data/lib/generators/rg/resource_generator.rb

@@ -0,0 +1,11 @@
+module Rg
+  class ResourceGenerator < ::Rails::Generators::NamedBase
+    desc "Creates a new angular rails resource"
+    include Helper
+
+
+    def create_resource
+      template 'resource.coffee.erb', APP_PATH + "/resources/#{file_name}.coffee"
+    end
+  end
+end

data/lib/generators/rg/service_generator.rb

@@ -0,0 +1,11 @@
+module Rg
+  class ServiceGenerator < ::Rails::Generators::NamedBase
+    desc "Creates a new angular service"
+    include Helper
+
+
+    def create_service
+      template 'service.coffee.erb', APP_PATH + "/services/#{file_name}.coffee"
+    end
+  end
+end

data/lib/generators/rg/templates/app/config.coffee.erb

@@ -0,0 +1,2 @@
+@<%= appName %>
+

data/lib/generators/rg/templates/app/csrf_token.coffee.erb

@@ -0,0 +1,6 @@
+if csrfTokenTag = document.querySelector('meta[name=csrf-token]')
+  @<%= appName %>.config ["$httpProvider", ($httpProvider) ->
+    angular.forEach ['post', 'put', 'patch', 'delete'], (verb)->
+      $httpProvider.defaults.headers[verb] ||= {}
+      $httpProvider.defaults.headers[verb]['X-CSRF-Token'] = csrfTokenTag.content
+  ]

data/lib/generators/rg/templates/app/main.coffee.erb

@@ -0,0 +1,19 @@
+# Initialize App w/ Dependencies
+#= require_self
+
+# Load Settings
+#= require ./settings
+
+# Load Other App Config
+#= require_tree .
+
+# Load Complete App
+#= require_tree ../services
+#= require_tree ../resources
+#= require_tree ../controllers
+#= require_tree ../filters
+#= require_tree ../directives
+
+@<%= appName %> = angular.module '<%= app_name %>', [
+  'rails'
+]

data/lib/generators/rg/templates/app/settings.coffee.erb

@@ -0,0 +1,3 @@
+@<%= appName %>.settings ||= {}
+
+@<%= appName %>.settings.backend_url = '<%= @backend_url %>'

data/lib/generators/rg/templates/controller.coffee.erb

@@ -0,0 +1,3 @@
+@<%= appName %>.controller '<%= file_name.pluralize.camelize %>Controller', ['$scope', ($scope) ->
+  
+]

data/lib/generators/rg/templates/directive.coffee.erb

@@ -0,0 +1,9 @@
+@<%= appName %>.directive "<%= camelizeLower(file_name) %>", ->
+  # restrict: E A C M
+  # replace: true false
+  # template: ''
+  # templateUrl: ''
+  # priority: 0
+  # scope: true false {}
+  link: (scope, element, attrs) ->
+    

data/lib/generators/rg/templates/filter.coffee.erb

@@ -0,0 +1,2 @@
+@<%= appName %>.filter '<%= file_name %>', ->
+  

data/lib/generators/rg/templates/resource.coffee.erb

@@ -0,0 +1,6 @@
+@<%= appName %>.factory '<%= file_name.camelize %>',
+['railsResourceFactory', (railsResourceFactory) ->
+  railsResourceFactory
+    url: angular.module('<%= app_name %>').settings.backend_url + '/<%= file_name.pluralize %>'
+    name: '<%= file_name %>'
+]

data/lib/generators/rg/templates/service.coffee.erb

@@ -0,0 +1,3 @@
+@<%= appName %>.factory '<%= camelizeLower(file_name) %>',[ () ->
+  
+]

data/lib/rg.rb

@@ -0,0 +1,6 @@
+require 'rg/version'
+require 'rails'
+require 'coffee-rails'
+require 'sprockets/bower'
+require 'rg/railtie'
+require 'rg/helper'

data/lib/rg/helper.rb

@@ -0,0 +1,40 @@
+module Rg
+  module Helper
+    extend self
+
+
+    JS_PATH  = 'app/assets/javascripts'
+    APP_PATH = JS_PATH + '/angular'
+
+
+    def camelizeLower(name)
+      name.camelize.sub(/./){ |c| c.downcase }
+    end
+
+    def app_name
+      @app_name ||= appName.underscore
+    end
+
+    def appName
+      @appName ||= bowerName || railsName
+    end
+
+    def railsName
+      camelizeLower(Rails.application.class.parent_name)
+    end
+
+    def bowerName
+      JSON.parse(
+        File.read(
+          Rails.root + 'bower.json'
+        )
+      )["name"]
+    rescue
+      nil
+    end
+
+    def self.included(base)
+      base.source_root File.dirname(__FILE__) + '/../generators/rg/templates'
+    end
+  end
+end

data/lib/rg/railtie.rb

@@ -0,0 +1,7 @@
+module Rg
+  class Railtie < ::Rails::Railtie
+    rake_tasks do
+      load File.dirname(__FILE__) + '/../tasks/rg.rake'
+    end
+  end
+end

data/lib/rg/version.rb

@@ -0,0 +1,3 @@
+module Rg
+  VERSION = "0.1.1"
+end

data/lib/tasks/rg.rake

@@ -0,0 +1,8 @@
+namespace :rg do
+  desc 'Setup bower and angular'
+  task :setup do
+    sh "rails g rg:bower"
+    sh "bower install angular angularjs-rails-resource --save"
+    sh "rails g rg:install --manifests=application.js"
+  end
+end

data/rg.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/rg/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "rg"
+  gem.version       = Rg::VERSION
+  gem.summary       = 'rg: rails + angular'
+  gem.summary       = 'A way to integrate AngularJS into a Rails project using CoffeeScript and Bower.'
+  gem.license       = "MIT"
+  gem.authors       = ["Jan Lelis"]
+  gem.email         = "mail@janlelis.de"
+  gem.homepage      = "https://github.com/janlelis/rg"
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+
+  gem.add_dependency 'rails'
+  gem.add_dependency 'coffee-rails'
+  gem.add_dependency 'sprockets-bower'
+  gem.add_dependency 'rake'
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: rg
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets-bower
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: mail@janlelis.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .rspec
+- .document
+- .gitignore
+- CHANGELOG.md
+- pkg/rg-0.1.0.gem
+- Gemfile.lock
+- Gemfile
+- lib/rg/version.rb
+- lib/rg/helper.rb
+- lib/rg/railtie.rb
+- lib/rg.rb
+- lib/tasks/rg.rake
+- lib/generators/rg/resource_generator.rb
+- lib/generators/rg/install_generator.rb
+- lib/generators/rg/controller_generator.rb
+- lib/generators/rg/filter_generator.rb
+- lib/generators/rg/directive_generator.rb
+- lib/generators/rg/bower_generator.rb
+- lib/generators/rg/service_generator.rb
+- lib/generators/rg/app_generator.rb
+- lib/generators/rg/templates/service.coffee.erb
+- lib/generators/rg/templates/filter.coffee.erb
+- lib/generators/rg/templates/resource.coffee.erb
+- lib/generators/rg/templates/controller.coffee.erb
+- lib/generators/rg/templates/app/config.coffee.erb
+- lib/generators/rg/templates/app/csrf_token.coffee.erb
+- lib/generators/rg/templates/app/main.coffee.erb
+- lib/generators/rg/templates/app/settings.coffee.erb
+- lib/generators/rg/templates/directive.coffee.erb
+- README.md
+- LICENSE.txt
+- Rakefile
+- rg.gemspec
+homepage: https://github.com/janlelis/rg
+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.1.9
+signing_key: 
+specification_version: 4
+summary: A way to integrate AngularJS into a Rails project using CoffeeScript and
+  Bower.
+test_files: []