rang 0.1.1

data/lib/rang.rb

@@ -0,0 +1,18 @@
+require "rang/version"
+require "rang/util"
+require "rang/helpers"
+require "rang/config"
+require "rang/patcher"
+
+if defined? Rails
+  require "rang/engine/railtie"
+  require "ngannotate/rails"
+  require "angular_rails_csrf"
+end
+
+module Rang
+  def self.configure
+    yield Config
+    Patcher.patch!
+  end
+end

data/lib/rang/config.rb

@@ -0,0 +1,12 @@
+module Rang
+  module Config
+    class << self
+
+      attr_accessor :patch_sprockets_to_use_html_extension
+      attr_accessor :disable_html_precompilation
+      attr_accessor :frontend_assets_directory
+      attr_accessor :remove_angular_delims_from_slim
+
+    end
+  end
+end

data/lib/rang/engine/railtie.rb

@@ -0,0 +1,5 @@
+module Rang
+  class Engine < ::Rails::Engine
+    isolate_namespace Rang
+  end
+end

data/lib/rang/helpers.rb

@@ -0,0 +1,35 @@
+module Rang
+  module Helpers
+    class << self
+      include ActionView::Helpers::JavaScriptHelper
+
+      # Using `context` here is very un-ruby, but it is the cleanest way of accessing
+      # the peculiar scope that assets are compiled in.
+      def templates(context)
+        template_paths(context).each do |path|
+          transformed_path = path.sub(/\..*$/, ".html")
+          context.depend_on_asset(transformed_path)
+          asset = context.environment.find_asset(transformed_path.sub(/\..*$/, ".html"))
+          yield transformed_path.sub(/\..*$/, ".html"), escape_javascript(asset.to_s)
+        end
+      end
+
+      private
+
+      def template_paths(context)
+        # @todo: this #include? should be made more robust
+        logical_paths(context).select {|path| path.include? '.htm' }
+      end
+
+      def logical_paths(context)
+        if defined? context.assets.logical_paths
+          context.assets.logical_paths
+        else
+          paths = []
+          context.assets.each_logical_path {|path| paths << path }
+          paths
+        end
+      end
+    end
+  end
+end

data/lib/rang/patcher.rb

@@ -0,0 +1,50 @@
+module Rang
+  module Patcher
+    def self.patch!
+      patch_sprockets_to_use_html_extension! if Config.patch_sprockets_to_use_html_extension
+      disable_html_precompilation! if Config.disable_html_precompilation
+      add_frontend_assets_directory!(Config.frontend_assets_directory) if Config.frontend_assets_directory
+      register_slim_as_assets_engine! if Util.gem_present? 'slim'
+      remove_angular_delims_from_slim! if Util.gem_present?('slim') && Config.remove_angular_delims_from_slim
+    end
+
+    private
+
+    def self.patch_sprockets_to_use_html_extension!
+      Rails.application.assets.send(:trail).alias_extension('.slim', '.html')
+
+      Kernel::silence_warnings do
+        Rails.application.assets.instance_eval do
+          if {}.respond_to?(:key)
+            def extension_for_mime_type(type)
+              @mime_types.key(type) || mime_types.key(type)
+            end
+          else
+            def extension_for_mime_type(type)
+              @mime_types.index(type) || mime_types.index(type)
+            end
+          end
+        end
+      end
+
+      Rails.application.assets.register_mime_type 'text/html', '.html'
+    end
+
+    def self.disable_html_precompilation!
+      # Ammend precompile selector to exclude html files
+      Rails.application.config.assets.precompile = [ Proc.new { |path, fn| fn =~ /app\/assets/ && !%w(.js .css .htm .html).include?(File.extname(path)) }, /application.(css|js)$/ ]
+    end
+
+    def self.add_frontend_assets_directory!(directory)
+      Rails.application.config.assets.paths << "#{Rails.root}/app/assets/#{directory}"
+    end
+
+    def self.register_slim_as_assets_engine!
+      Rails.application.assets.register_engine '.slim', ::Slim::Template
+    end
+
+    def self.remove_angular_delims_from_slim!
+      Slim::Engine.set_default_options({attr_delims: {'(' => ')', '[' => ']'}})
+    end
+  end
+end

data/lib/rang/util.rb

@@ -0,0 +1,11 @@
+module Rang
+  module Util
+    def self.gem_present?(name)
+      Gem::Specification::find_all_by_name(name).any?
+    end
+
+    def self.application_name
+      Rails.application.class.parent_name
+    end
+  end
+end

data/lib/rang/version.rb

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

data/rang.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rang/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rang"
+  spec.version       = Rang::VERSION
+  spec.authors       = ["Caden Lovelace"]
+  spec.email         = ["caden@herostrat.us"]
+  spec.summary       = %q{Helpful adjustments to make Rails and Angular play nice together.}
+  spec.description   = %q{Provides a suite of generators and adjustments that make Rails
+                          a seamless AngularJS development environment to rival Grunt and Gulp.}
+  spec.homepage      = "http://github.com/cultivatehq/rang"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "slim", "~> 2.0"
+  spec.add_dependency "rails", "~> 4.0"
+  spec.add_dependency "ngannotate-rails", "~> 0.9"
+  spec.add_dependency "angular_rails_csrf", "~> 1.0"
+end

data/spec/controllers/root_controller_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Rang::RootController do
+  let(:controller) { Rang::RootController.new }
+
+  describe '#display' do
+    it 'returns an ng-view element' do
+      expect(controller).to receive(:render).with({text: '<div ng-view></div>', layout: 'application'})
+      controller.display
+    end
+  end
+end

data/spec/generators/add_root_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'rails/generators'
+require_relative '../../lib/rails/generators/rang/add_root/add_root_generator.rb'
+
+describe Rang::Generators::AddRootGenerator do
+  let(:klass) { Rang::Generators::AddRootGenerator }
+  let(:generator) { klass.new }
+
+  it "has a description" do
+    expect(klass.desc.empty?).to be_falsey
+  end
+
+  describe "#add_root" do
+    it 'adds a root route' do
+      expect(generator).to receive(:route).with("mount Rang::Engine => \"/\"\n")
+      generator.add_route
+    end
+  end
+
+
+end

data/spec/generators/api_configure_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'rails/generators'
+require_relative '../../lib/rails/generators/rang/api/configure/configure_generator.rb'
+
+describe Rang::Api::Generators::ConfigureGenerator do
+  let(:klass) { Rang::Api::Generators::ConfigureGenerator }
+  let(:generator) { klass.new }
+
+  it "has a description" do
+    expect(klass.desc.empty?).to be_falsey
+  end
+
+  describe "#add_to_application_js" do
+    before do
+      allow(Rails.application.assets).to receive_message_chain(:find_asset, :pathname).and_return 'app.js'
+      allow(generator).to receive(:inject_into_file)
+      allow(generator).to receive(:no?).and_return false
+    end
+
+    it "should insert require into application.js" do
+      expect(generator).to receive(:inject_into_file) do |path, matcher, &block|
+        expect(path).to eq 'app.js'
+        expect(block.call).to eq "\n//= require angular-restmod/angular-restmod-bundle"
+      end
+      generator.add_to_application_js
+    end
+
+    it "should insert require after angular" do
+      expect(generator).to receive(:inject_into_file) do |path, matcher, &block|
+        expect("\n//= require angular" =~ matcher[:after]).to be_truthy
+      end
+      generator.add_to_application_js
+    end
+
+    it "shouldn't insert require after similar requires" do
+      expect(generator).to receive(:inject_into_file) do |path, matcher, &block|
+        expect("\n//= require angular-route" =~ matcher[:after]).to be_falsey
+      end
+      generator.add_to_application_js
+    end
+  end
+
+
+end

data/spec/generators/assets_init_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'rails/generators'
+require_relative '../../lib/rails/generators/rang/assets/init/init_generator.rb'
+
+describe Rang::Assets::Generators::InitGenerator do
+  let(:klass) { Rang::Assets::Generators::InitGenerator }
+  let(:generator) { klass.new }
+
+  before { allow(generator).to receive(:say_status) }
+
+  it "has a description" do
+    expect(klass.desc.empty?).to be_falsey
+  end
+
+  describe "#deprecate_old_assets!" do
+    before do
+      allow(File).to receive(:exist?).and_return(true)
+      allow(generator).to receive(:empty_directory)
+      allow(generator).to receive(:run)
+      allow(generator).to receive(:remove_dir)
+    end
+
+    it 'copies assets to holding dirs' do
+      expect(generator).to receive(:run).with("mv app/assets/javascripts app/assets.removed/javascripts", anything)
+      expect(generator).to receive(:run).with("mv app/assets/stylesheets app/assets.removed/stylesheets", anything)
+      generator.deprecate_old_assets!
+    end
+
+    it 'removes asset dirs' do
+      expect(generator).to receive(:remove_dir).with("app/assets/javascripts")
+      expect(generator).to receive(:remove_dir).with("app/assets/stylesheets")
+      generator.deprecate_old_assets!
+    end
+  end
+
+  describe "#add_html_attributes" do
+    before do
+      allow(Rang::Util).to receive(:application_name).and_return 'dogs'
+      allow(generator).to receive(:gsub_file)
+      allow(generator).to receive(:no?).and_return false
+    end
+
+    context "when layout is an ERB file" do
+      before do
+        allow(generator).to receive(:layout_file).and_return "fake.html.erb"
+        allow(generator).to receive(:layout_handler).and_return "ActionView::Template::Handlers::ERB"
+      end
+
+      it "inserts ng-app" do
+        expect(generator).to receive(:gsub_file).with("fake.html.erb", "<html>", "<html ng-app='dogs'>")
+        generator.add_html_attribute
+      end
+    end
+
+    context "when layout is a Slim file" do
+      before do
+        allow(generator).to receive(:layout_file).and_return "fake.slim"
+        allow(generator).to receive(:layout_handler).and_return "Slim::RailsTemplate"
+      end
+
+      it "inserts ng-app" do
+        expect(generator).to receive(:gsub_file).with("fake.slim", /^html$/, "html ng-app='dogs'")
+        generator.add_html_attribute
+      end
+    end
+
+    it "hasn't been broken by ActionController changes" do
+      expect(ApplicationController.new.send(:_layout).identifier).to be_a String
+      expect(ApplicationController.new.send(:_layout).handler).to respond_to :call
+      expect(generator.send(:layout_file)).to eq ApplicationController.new.send(:_layout).identifier
+      expect(generator.send(:layout_handler)).to eq ApplicationController.new.send(:_layout).handler.class.to_s
+    end
+  end
+
+  describe "#create_assets!" do
+    before do
+      allow(generator).to receive(:template)
+    end
+
+    it 'creates all assets' do
+      expect(generator).to receive(:template).with('application.js', 'app/assets/frontend/application.js')
+      expect(generator).to receive(:template).with('application.scss', 'app/assets/frontend/application.scss')
+      expect(generator).to receive(:template).with('_base.scss', 'app/assets/frontend/style/_base.scss')
+      expect(generator).to receive(:template).with('components.js', 'app/assets/frontend/components/components.js')
+      generator.create_assets!
+    end
+
+  end
+
+
+end

data/spec/generators/bower_add_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'rails/generators'
+require_relative '../../lib/rails/generators/rang/bower/add/add_generator.rb'
+
+describe Rang::Bower::Generators::AddGenerator do
+
+  let(:klass) { Rang::Bower::Generators::AddGenerator }
+  let(:generator) { klass.new(['angular', '~> 2.0']) }
+
+  it "has a description" do
+    expect(klass.desc.empty?).to be_falsey
+  end
+
+  describe '#run_init' do
+    context 'when a Gemfile.bower is absent' do
+      it 'runs the init task' do
+        expect(generator).to receive(:generate).with("rang:bower:init")
+        generator.run_init
+      end
+    end
+
+    context 'when a Gemfile.bower exists' do
+      before do
+        allow(File).to receive(:exist?).and_return(true)
+      end
+
+      it 'doesn’t run the init task' do
+        expect(generator).to_not receive(:generate)
+        generator.run_init
+      end
+    end
+  end
+
+  describe '#add_gem_to_bower_gemfile' do
+    # Silence messages
+    before { allow(generator).to receive(:append_file) }
+
+    it 'adds the gem to Gemfile.bower' do
+      expect(generator).to receive(:append_file).with("Gemfile.bower",
+        "gem 'rails-assets-angular', '~> 2.0'\n")
+      generator.add_gem_to_bower_gemfile
+    end
+
+    context 'if dependency_name doesn’t end with a @' do
+      it 'doesn’t run bundler' do
+        expect(generator).to_not receive(:run).with('bundle install')
+        generator.add_gem_to_bower_gemfile
+      end
+    end
+
+    context 'if dependency_name ends with a @' do
+      let(:generator) { klass.new(['angular@', '~> 2.0']) }
+
+      it 'runs bundler' do
+        expect(generator).to receive(:run).with('bundle install')
+        generator.add_gem_to_bower_gemfile
+      end
+    end
+  end
+
+end

data/spec/generators/bower_init_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'rails/generators'
+require_relative '../../lib/rails/generators/rang/bower/init/init_generator.rb'
+
+describe Rang::Bower::Generators::InitGenerator do
+
+  let(:klass) { Rang::Bower::Generators::InitGenerator }
+  let(:generator) { klass.new }
+
+  it "has a description" do
+    expect(klass.desc.empty?).to be_falsey
+  end
+
+  describe "#create_bower_gemfile" do
+    it 'creates Gemfile.bower' do
+      expect(generator).to receive(:create_file).with("Gemfile.bower", "source 'https://rails-assets.org'\n")
+      generator.create_bower_gemfile
+    end
+  end
+
+  describe "#include_bower_gemfile_into_gemfile" do
+    it 'includes Gemfile.bower into Gemfile' do
+      expect(generator).to receive(:inject_into_file) do |filename, regex, &block|
+        expect(filename).to eq "Gemfile"
+        expect(block.call).to include "\neval(IO.read('Gemfile.bower'), binding) if File.exist? 'Gemfile.bower'"
+      end
+      generator.include_bower_gemfile_into_gemfile
+    end
+
+    it 'includes Gemfile.bower into Gemfile at the right point' do
+      expect(generator).to receive(:inject_into_file) do |filename, regex, &block|
+        regex = regex[:after]
+        expect("source 'https://rubygems.org'\n" =~ regex).to be_truthy
+      end
+      generator.include_bower_gemfile_into_gemfile
+    end
+  end
+
+  describe "#add_angular_gems" do
+    before do
+      allow(generator).to receive(:generate)
+      allow(generator).to receive(:run)
+    end
+
+    it 'adds essential angular gems' do
+      expect(generator).to receive(:generate).with("rang:bower:add", "angular '~> 1.2.0' quiet")
+      expect(generator).to receive(:generate).with("rang:bower:add", "angular-route '~> 1.2.0' quiet")
+      generator.add_angular_gems
+    end
+
+    it 'runs bundler' do
+      expect(generator).to receive(:run).with("bundle install")
+      generator.add_angular_gems
+    end
+  end
+
+end