frontin 0.1.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,10 @@
+gemfiles:
+  - Gemfile
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+language: node_js
+node_js:
+  - 0.6
+  - 0.7

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in frontin.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Collin Schaafsma
+
+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,98 @@
+# Frontin
+
+Give your frontend code some respect in Rails. Don't even front.
+
+Frontin adds middleware to allow you to develop your frontend code in `Rails/root/frontend` and serve it in development mode.
+Frontin takes any request for `assets/**js, assets/**css` or `app/**js` and maps those requests to `Rails/root/frontend` in development mode.
+It also provides generators to easily setup the backbone-boilerplate using grunt so that you can easily build to `public/assets/` for production. Keeping your frontend source out of `public/`.
+
+**Frontin is NOT designed to work with the asset pipeline.**
+If that sounds pretty awesome to you, and you don't want your frontend code to get all mixed up in the Rails framework then frontin might be the kitties pj's for you.
+
+Learn more about grunt https://github.com/cowboy/grunt, and the backbone-boilerplate https://github.com/backbone-boilerplate/grunt-bbb
+
+[![Build Status](https://secure.travis-ci.org/collinschaafsma/frontin.png)](http://travis-ci.org/collinschaafsma/frontin)
+
+Testing against: node 0.6, 0.7 / Ruby MRI 1.9.2, 1.9.3
+
+## Why
+
+Frontin was developed out of frustration with the asset pipeline. Instead it uses grunt to compile frontend code to the `public/` directory where a web server like
+nginx can make quick work out of it. Grunt gives you all the controll in the world over building your frontend code.  We feel it's the right tool for the job and prefer to
+use the Rails framework for what it's best at.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'frontin', :group => :development
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install frontin
+
+## Dependencies
+
+* Ruby ~> 1.9.2
+* Node ~> 0.6
+
+## Usage
+
+Frontin provides several generators to make life easy.
+
+    rails g frontin:install
+
+This adds the `frontend/` directory to the root of your Rails project where you can start writing your frontend code.
+In addition the node npm package grunt will be installed for building your assets with a sensible config.
+
+Frontin also makes it easy to install the backbone-boilerplate into your `frontend` directory using
+the node npm package bbb. If your looking to build your frontend using Backbone we highly suggest you give the backbone-boilerplate a spin.
+
+    rails g frontin:bbb
+
+## Disabling the asset pipeline
+
+It's highly recommended that if you use frontin to disable the asset pipeline to avoid
+any conflicts. Besides, at this point you don't need it anymore.
+
+### Greenfield project
+
+    rails new my_project -S
+
+### Existing project
+
+    config/application.rb
+
+    # comment out
+    require "sprockets/railtie"
+
+    # disable the asset pipeline
+    config.assets.enabled = false
+
+    # optionally disable the generators
+    config.generators.stylesheets = false
+    config.generators.javascripts = false
+
+## Example Rails app
+
+https://github.com/collinschaafsma/frontin_rails_example
+
+## Thanks
+
+* cowboy (Ben Alman) for writing grunt. https://github.com/cowboy/grunt
+* tbranyen (Tim Branyen) for writing backbone-boilerplate. https://github.com/backbone-boilerplate/grunt-bbb
+* wookiehangover (Sam Breed) and nicovalencia (Nico Valencia) for their inspiration and smarts
+* All the other contributers to the projects that make frontin possible
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/frontin.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/frontin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Collin Schaafsma"]
+  gem.email         = ["collin@quickleft.com"]
+  gem.description   = %q{Give your frontend code some respect in Rails! Don't even front.}
+  gem.summary       = %q{Frontin adds middleware to allow you to develop your frontend code in Rails/root/frontend. It also provides generators to easily setup the backbone boilerplate using Grunt so that you can easily build to public/ for production.}
+  gem.homepage      = "https://github.com/collinschaafsma/frontin"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "frontin"
+  gem.require_paths = ["lib"]
+  gem.version       = Frontin::VERSION
+  gem.rubyforge_project = "frontin"
+
+  gem.add_dependency("rails", "~> 3.2.0")
+end

data/lib/frontin.rb

@@ -0,0 +1,2 @@
+require "frontin/version"
+require "frontin/middleware"

data/lib/frontin/middleware.rb

@@ -0,0 +1,24 @@
+module Frontin
+  class Middleware
+    def initialize(app, options={})
+      @app = app
+      @paths = options[:paths]
+      root = options[:root]  || "frontend"
+      @file_server = Rack::File.new(root)
+    end
+
+    def routable?(path)
+      @paths.kind_of?(Array) && @paths.any? { |p| path.index(p) == 0 }
+    end
+
+    def call(env)
+      path = env["PATH_INFO"]
+
+      if routable?(path)
+        @file_server.call(env)
+      else
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/frontin/util.rb

@@ -0,0 +1,29 @@
+module Frontin
+  module Util
+    def run_command(cmd)
+      output = nil
+      IO.popen(cmd) { |f| output = f.read }
+      output
+    end
+
+    def binary_installed?(binary)
+      if File.executable? binary
+        true
+      else
+        # Look through their $PATH env variable to see if we can find it
+        path = ENV['PATH'].split(File::PATH_SEPARATOR).find do |p|
+          full_path = File.join(p, binary)
+          File.executable?(full_path) && File.file?(full_path)
+        end
+        path && File.expand_path(binary, path)
+      end
+    end
+
+    def directory_trees
+      %w(frontend frontend/app frontend/assets frontend/assets/css
+           frontend/assets/js frontend/assets/js/libs frontend/test
+           public/assets public/assets/js/debug public/assets/js/release
+           public/assets/js/libs public/assets/css/release public/assets/img)
+    end
+  end
+end

data/lib/frontin/version.rb

@@ -0,0 +1,3 @@
+module Frontin
+  VERSION = "0.1.0"
+end

data/lib/generators/base.rb

@@ -0,0 +1,51 @@
+require 'rails'
+require 'frontin/util'
+
+module Frontin
+  module Generators
+    class Base < Rails::Generators::Base
+      include Frontin::Util
+
+      def build_directories
+        say("Setting up a sensible directory structure in frontend/ and public/ to work with grunt config")
+
+        directory_trees.each do |path|
+          empty_directory path
+        end
+      end
+
+      # We could do this easily with a railtie using
+      # initializer "frontin.insert_middleware", however this gives the
+      # developer the ability to change the Middleware paramaters
+      def add_middleware_to_development_env
+        application(nil, :env => "development") do
+          "config.middleware.use(Frontin::Middleware, :paths => ['/assets', '/app'], :root => 'frontend')"
+        end
+      end
+
+      def install_grunt
+        if binary_installed?('npm')
+          if binary_installed?('grunt')
+            say("grunt detected on your system")
+          else
+            say("Invoking: npm install -g grunt")
+            run_command('npm install -g grunt')
+          end
+        else
+          say("We couldn't find npm on your system. Skipping grunt install.")
+          say("Install npm with: curl http://npmjs.org/install.sh | sh")
+        end
+      end
+
+      private
+        def install_grunt_config
+          if Rails.env.test?
+            create_file("frontend/grunt.js")
+          else
+            say("Installing sensible grunt configuration for your environment in frontend/ directory.")
+            get("https://raw.github.com/gist/2348189/3aa8f76e2f2d2aa47a803314b14c99396baf0321/rails-grunt.js", "frontend/grunt.js")
+          end
+        end
+    end
+  end
+end

data/lib/generators/frontin/bbb_generator.rb

@@ -0,0 +1,49 @@
+require 'pty'
+require 'expect'
+require 'generators/base'
+
+module Frontin
+  module Generators
+    class BbbGenerator < Frontin::Generators::Base
+
+      desc "Creates the frontend directory in the root of your Rails \n
+            app and installs grunt with the bbb plugin and a sensible config and directory structure."
+
+      def install_bbb
+        if binary_installed?('npm')
+          if binary_installed?('bbb')
+            say("bbb detected on your system")
+          else
+            say("Invoking: npm install -g bbb")
+            run_command('npm install -g bbb')
+          end
+        else
+          say("We couldn't find npm on your system. Skipping bbb install.")
+          say("Install npm with: curl http://npmjs.org/install.sh | sh")
+        end
+      end
+
+      def bbb_init
+        if binary_installed?('bbb')
+          say("Invoking: bbb init")
+          # Make sure this can run in test mode
+          bbb_namespace = Rails.env.test? ? 'myapp' : ask("Backbone project namespace?")
+          cmd = Rails.env.test? ? "cd test/generators/tmp/frontend; bbb init" : 'cd frontend; bbb init'
+
+          STDOUT.sync     = true
+          STDERR.sync     = true
+          $expect_verbose = false
+          PTY.spawn(cmd) do |output,input,pid|
+            input.sync = true
+            output.expect(/Project namespace/) { input.puts bbb_namespace }
+            output.expect(/Do you need to make any changes to the above before continuing/) { input.puts "N" }
+          end
+        end
+      end
+
+      def install_grunt_config
+        super
+      end
+    end
+  end
+end

data/lib/generators/frontin/install_generator.rb

@@ -0,0 +1,15 @@
+require 'generators/base'
+
+module Frontin
+  module Generators
+    class InstallGenerator < Frontin::Generators::Base
+
+      desc "Creates the frontend directory in the root of your Rails \n
+            app and installs grunt with a sensible config and directory structure."
+
+      def install_grunt_config
+        super
+      end
+    end
+  end
+end

data/test/assets/test.js

@@ -0,0 +1 @@
+var fancy = "fancy";

data/test/generators/frontin/bbb_generator_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+require 'rails/generators/test_case'
+require 'generators/frontin/bbb_generator'
+
+class BbbGeneratorTest < Rails::Generators::TestCase
+  include Frontin::Util
+
+  tests Frontin::Generators::BbbGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+
+  setup do
+    prepare_destination
+    stage_development_env
+  end
+
+  def stage_development_env
+    FileUtils.mkdir_p File.dirname(development_env)
+    File.open(development_env, 'w') {|f| f.write("FrontinTest::Application.configure do\n\nend") }
+  end
+
+  def development_env
+    @development_env ||= File.expand_path("config/environments/development.rb", destination_root)
+  end
+
+  def test_bbb_generator
+    run_generator
+
+    # This feels bad man, but we need to wait for the bbb init to finsh in the other
+    # process before we start looking for stuff it generated.  At this point we don't
+    # mock this out because we want to know if things thange in bbb init.
+    sleep 1
+
+    directory_trees.each do |path|
+      assert_directory path
+    end
+
+    %w(frontend/grunt.js frontend/app/myapp.js frontend/app/main.js
+       frontend/app/config.js frontend/app/modules/example.js
+       frontend/app/templates/example.html).each do |file|
+      assert_file file
+    end
+
+    contents = File.read(development_env)
+    assert_match(/config.middleware.use\(Frontin::Middleware, :paths => \['\/assets', '\/app'\], :root => 'frontend'\)/m, contents)
+  end
+end
+

data/test/generators/frontin/install_generator_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+require 'rails/generators/test_case'
+require 'generators/frontin/install_generator'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  include Frontin::Util
+
+  tests Frontin::Generators::InstallGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+
+  setup do
+    prepare_destination
+    stage_development_env
+  end
+
+  def stage_development_env
+    FileUtils.mkdir_p File.dirname(development_env)
+    File.open(development_env, 'w') {|f| f.write("FrontinTest::Application.configure do\n\nend") }
+  end
+
+  def development_env
+    @development_env ||= File.expand_path("config/environments/development.rb", destination_root)
+  end
+
+  def test_install_generator
+    run_generator
+
+    directory_trees.each do |path|
+      assert_directory path
+    end
+
+    assert_file 'frontend/grunt.js'
+
+    contents = File.read(development_env)
+    assert_match(/config.middleware.use\(Frontin::Middleware, :paths => \['\/assets', '\/app'\], :root => 'frontend'\)/m, contents)
+  end
+end

data/test/middleware_test.rb

@@ -0,0 +1,35 @@
+require 'rack/test'
+require 'rack/mock'
+require 'frontin'
+
+class MiddlewareTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def default_app
+    lambda { |env|
+      headers = {'Content-Type' => "text/html"}
+      [200, headers, ["I'm the default app"]]
+    }
+  end
+
+  def app
+    @app ||= Frontin::Middleware.new(default_app, { :paths => ['/assets'], :root => File.expand_path(File.dirname(__FILE__)) })
+  end
+
+  def test_files_in_the_path_are_served
+    response = get("/assets/test.js")
+    assert_equal response.status, 200
+    assert_match /fancy/, response.body
+  end
+
+  def test_missing_files_in_the_path
+    response = get("/assets/not-here.js")
+    assert_equal response.status, 404
+  end
+
+  def test_request_without_the_path_falls_out
+    response = get("/not-assets/test.js")
+    assert_equal response.status, 200
+    assert_match /I'm the default app/, response.body
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+ENV["RAILS_ENV"] = "test"
+require 'test/unit'

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: frontin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Collin Schaafsma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70360032997540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70360032997540
+description: Give your frontend code some respect in Rails! Don't even front.
+email:
+- collin@quickleft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- frontin.gemspec
+- lib/frontin.rb
+- lib/frontin/middleware.rb
+- lib/frontin/util.rb
+- lib/frontin/version.rb
+- lib/generators/base.rb
+- lib/generators/frontin/bbb_generator.rb
+- lib/generators/frontin/install_generator.rb
+- test/assets/test.js
+- test/generators/frontin/bbb_generator_test.rb
+- test/generators/frontin/install_generator_test.rb
+- test/middleware_test.rb
+- test/test_helper.rb
+homepage: https://github.com/collinschaafsma/frontin
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: frontin
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Frontin adds middleware to allow you to develop your frontend code in Rails/root/frontend.
+  It also provides generators to easily setup the backbone boilerplate using Grunt
+  so that you can easily build to public/ for production.
+test_files:
+- test/assets/test.js
+- test/generators/frontin/bbb_generator_test.rb
+- test/generators/frontin/install_generator_test.rb
+- test/middleware_test.rb
+- test/test_helper.rb