half-pipe 0.0.1

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Joe Fiorini
+
+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,103 @@
+# Half Pipe
+
+Gem to replace the Rails asset pipeline with a Grunt.js-based workflow, providing dependencies via Bower.
+
+## Who is this For?
+
+This initial release assumes you have been using [Grunt.js](http://www.gruntjs.com) in non-Rails apps and would like to start using it in Rails as well. It uses [Bower](http://bower.io) for dependency management, [RequireJS](http://www.requirejs.org) for Javascript modules and Sass for CSS. If you use alternatives to these tools, we'd love to hear from you.
+
+## Getting Started
+
+### Directory Structure
+
+We believe that the directory structured imposed by the Rails asset pipeline was a step in the right direction, but did not go far enough in making client code a first-class part of your application. Given that, we have put assets at the same level as the rest of your Ruby code:
+
+- `app/scripts` - Javascript files (currently all RequireJS modules)
+- `app/styles` - Sass templates
+
+#### Rails Generator
+
+In a Rails app, use `rails g half_pipe:install` to get started. This will generate the directory structure and any files necessary for your Grunt workflow.
+
+<table>
+<thead>
+<tr>
+  <th>
+    Generated
+  </th>
+  <th>
+    Purpose
+  </th>
+</tr>
+</thead>
+<tbody>
+<tr>
+  <td>Gruntfile.js</td>
+  <td>
+    Main configuration for your Grunt tasks
+  </td>
+</tr>
+<tr>
+  <td>bower.json</td>
+  <td>
+    3rd-party asset dependencies (includes normalize-css, requirejs, and html5shiv by default)
+  </td>
+</tr>
+<tr>
+  <td>package.json</td>
+  <td>
+    NPM dependencies (ie. Bower, Grunt, any Grunt tasks)
+  </td>
+</tr>
+<tr>
+  <td>.jshintrc</td>
+  <td>
+    Linting configuration for Javascript
+  </td>
+</tr>
+<tr>
+  <td>app/scripts/application.js</td>
+  <td>
+    Entry point for requirejs; includes requirejs configuration, main module require and bootstraps page
+  </td>
+</tr>
+<tr>
+  <td>app/scripts/main.js</td>
+  <td>
+    Main module for your app; includes page initialization and requires any modules necessary for initialization
+  </td>
+</tr>
+<tr>
+  <td>config/initializers/sass.rb</td>
+  <td>
+    Bootstraps Sass with bower importer
+  </td>
+</tr>
+</table>
+
+Beyond these files, the generator also removes sprockets from `config/application.rb` and replaces `javascript_include_tag "application"` in your application layout with `requirejs_include_tag "/scripts/application.js"`.
+
+#### Post-generator Tasks
+
+If you're in an app with existing assets, the generator **DOES NOT** touch them. It is up to you to move them into their new homes and incorporate any existing Javascript files into `requirejs` modules.
+
+### Building Assets
+
+Build assets by running `grunt build`. This will compile Javascripts to `public/scripts` and stylesheets to `public/styles`.
+
+### Configuration
+
+In this early release if you want to configure anything, you'll have to manually change `Gruntfile.js`. We'd like to make this more invisible in the future; please post any use cases for configuration as Github issues.
+
+## Roadmap
+
+- Asset fingerprinting
+- Precompilation of client-side templates
+- Javascript module generator
+- Configurable asset directories
+- Configurable build directories
+- Better support for images
+- Better support for non-Rails Ruby frameworks
+- Support for most popular [AltJS](http://www.altjs.com) languages
+- BYO support for less common languages
+- Automatic symlinking of CSS files within bower to SCSS partials within `app/styles`

data/Rakefile

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

data/app/helpers/half_pipe_helper.rb

@@ -0,0 +1,8 @@
+module HalfPipeHelper
+
+  def requirejs_include_tag(script, options={})
+    root = if Rails.env.production? then "scripts" else "components/requirejs" end
+    javascript_include_tag "/#{root}/require.js", { data: { main: script } }
+  end
+
+end

data/half-pipe.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'half-pipe/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "half-pipe"
+  gem.version       = Half::Pipe::VERSION
+  gem.authors       = ["Joe Fiorini"]
+  gem.email         = ["joe@joefiorini.com"]
+  gem.description   = %q{Grunt-based workflow for your Rails assets}
+  gem.summary       = %q{Gem to replace the Rails asset pipeline with a Grunt.js-based workflow, providing dependencies via Bower.}
+  gem.homepage      = ""
+
+  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.require_paths = ["lib"]
+
+  gem.add_dependency "rack-asset-compiler"
+end

data/lib/generators/half_pipe/install_generator.rb

@@ -0,0 +1,63 @@
+module HalfPipe
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      desc "Installs basic Grunt/Bower setup with Sass & requirejs to your Rails project"
+
+      def self.source_root
+        @_half_pipe_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_initializer_file
+        template "package.json", "package.json"
+        template "_bowerrc", ".bowerrc"
+        template "bower.json", "bower.json"
+        template "_jshintrc", ".jshintrc"
+        template "Gruntfile.js", "Gruntfile.js"
+
+        comment_lines "config/application.rb", %r{sprockets/railtie}
+
+        railties_requires = File.read(File.join(self.class.source_root, "railties.rb"))
+        gsub_file "config/application.rb", %r{require 'rails/all'}, railties_requires
+
+        gsub_file "app/views/layouts/application.html.erb", %r{\s*<%= javascript_include_tag "application" %>$}, ''
+        insert_into_file "app/views/layouts/application.html.erb", %Q{  <%= requirejs_include_tag "/scripts/application.js" %>\n  }, before: "</body>"
+
+        directory "app"
+
+        empty_directory "app/scripts"
+
+        inside "app/scripts" do
+          template "main.js", force: true
+          template "application.js", force: true
+        end
+
+        initializer "sass.rb" do
+          %Q{
+          require 'sass/importers/bower_importer'
+          Sass.load_paths << Sass::Importers::BowerImporter.new("components")
+          }
+        end
+
+        run "npm install"
+
+        ENV["PATH"] = "./node_modules/.bin:#{ENV["PATH"]}"
+
+        run "bower install"
+        run "grunt build"
+
+        say "You may now safely migrate your assets to app/scripts and/or app/styles. Feel free to delete app/assets/javascripts and app/assets/stylesheets when you're done."
+      end
+
+      def main_module_name
+        app_name.underscore.dasherize
+      end
+
+      def app_name
+        Rails.application.class.parent_name
+      end
+
+    end
+
+  end
+end

data/lib/generators/half_pipe/templates/Gruntfile.js

@@ -0,0 +1,67 @@
+/*global module:false*/
+module.exports = function(grunt) {
+
+
+  // Project configuration.
+  grunt.initConfig({
+    // Metadata.
+    pkg: grunt.file.readJSON('package.json'),
+
+    jshint: {
+      options: {
+        jshintrc: '.jshintrc'
+      },
+      gruntfile: {
+        src: 'Gruntfile.js'
+      }
+    },
+
+    sass: {
+      options: {
+        style: 'expanded',
+        require: ['./config/initializers/sass']
+      },
+      'tmp/styles/main.css': [
+        'app/styles/main.scss'
+      ]
+    },
+
+    cssmin: {
+      'public/styles/main.css': 'tmp/styles/main.css'
+    },
+
+    requirejs: {
+      options: {
+        baseUrl: "app/scripts",
+        mainConfigFile: "app/scripts/application.js",
+        name: "main",
+        out: "public/scripts/application.js"
+      },
+      scripts: {
+      }
+    },
+
+    copy: {
+      'public/scripts/require.js': 'components/requirejs/require.js'
+    },
+
+    clean: ['public/assets/', 'tmp/']
+
+  });
+
+  // These plugins provide necessary tasks.
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-sass');
+  grunt.loadNpmTasks('grunt-contrib-cssmin');
+  grunt.loadNpmTasks('grunt-contrib-copy');
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-requirejs');
+
+  // Default task.
+  grunt.registerTask('default', 'build');
+
+  // Build task.
+  grunt.registerTask('build', ['jshint', 'sass', 'cssmin', 'copy', 'requirejs']);
+
+};
+

data/lib/generators/half_pipe/templates/_bowerrc

@@ -0,0 +1,3 @@
+{
+  "json": "bower.json"
+}

data/lib/generators/half_pipe/templates/_jshintrc

@@ -0,0 +1,34 @@
+{
+  "camelcase": true,
+  "indent": 2,
+  "white": false,
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": false,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "boss": true,
+  "eqnull": true,
+  "browser": true,
+  "globals": {
+    "test": true,
+    "asyncTest": true,
+    "start": true,
+    "expect": true,
+    "module": true,
+    "define": true,
+    "sinon": true,
+    "require": true,
+    "console": true,
+    "Class": true,
+    "Events": true,
+    "Options": true,
+    "Element": true,
+    "$": true,
+    "$$": true
+  }
+}
+

data/lib/generators/half_pipe/templates/app/scripts/application.js

@@ -0,0 +1,17 @@
+require.config({
+  baseUrl: '/scripts',
+  paths: {
+    '<%= main_module_name %>': 'main'
+  }
+});
+
+require(
+  [
+    // Add your dependencies here
+    '<%= main_module_name %>'
+  ],
+
+  function(initialize/*, modules */){
+    initialize();
+  }
+);

data/lib/generators/half_pipe/templates/app/scripts/main.js

@@ -0,0 +1,17 @@
+'use strict';
+
+define('<%= main_module_name %>',
+  [
+    // Add your dependencies here
+  ],
+
+  function(/* modules */){
+
+    function initialize(){
+      // Add your initialization code here
+    }
+
+    return initialize;
+
+  }
+);

data/lib/generators/half_pipe/templates/app/styles/main.scss

@@ -0,0 +1 @@
+@import "bower!normalize-css/normalize";

data/lib/generators/half_pipe/templates/bower.json

@@ -0,0 +1,8 @@
+{
+  "dependencies": {
+    "html5shiv": "latest",
+    "requirejs": "latest",
+    "normalize-css": "latest"
+  }
+}
+

data/lib/generators/half_pipe/templates/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "<%= app_name %>",
+  "devDependencies": {
+    "grunt-cli": "~0.1.7",
+    "grunt": "~0.4.1",
+    "bower": "~0.9.2",
+    "grunt-contrib-sass": "~0.3.0",
+    "grunt-contrib-copy": "~0.4.1",
+    "grunt-contrib-clean": "~0.4.1",
+    "grunt-contrib-jshint": "~0.4.3",
+    "grunt-contrib-cssmin": "~0.6.0",
+    "grunt-contrib-requirejs": "~0.4.0"
+  }
+}
+

data/lib/generators/half_pipe/templates/railties.rb

@@ -0,0 +1,7 @@
+require "active_record/railtie"
+# require "sprockets/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "rails/test_unit/railtie"
+

data/lib/half-pipe.rb

@@ -0,0 +1,13 @@
+require "half-pipe/version"
+
+if defined?(Rails)
+  require "half-pipe/rails"
+end
+
+require "rack/half-pipe"
+
+module Half
+  module Pipe
+    # Your code goes here...
+  end
+end

data/lib/half-pipe/rails.rb

@@ -0,0 +1,4 @@
+module HalfPipe
+  class Engine < Rails::Engine
+  end
+end

data/lib/half-pipe/version.rb

@@ -0,0 +1,5 @@
+module Half
+  module Pipe
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/half-pipe.rb

@@ -0,0 +1,99 @@
+require "rack/asset_compiler"
+require "rack/sass_compiler"
+
+module Rack
+  class HalfPipe
+
+    def initialize(app)
+      @compilers = []
+
+      @compilers << Rack::AssetCompiler.new(app, scripts_config)
+      @compilers << Rack::AssetCompiler.new(app, bower_js_config)
+      @compilers << Rack::AssetCompiler.new(app, bower_css_config)
+      @compilers << Rack::SassCompiler.new(app, sass_config)
+
+      @app = app
+    end
+
+    def call(env)
+      res = @compilers[0].call(env)
+
+      if res[0] != 404
+        return res
+      end
+
+      res = @compilers[1].call(env)
+
+      if res[0] != 404
+        return res
+      end
+
+      res = @compilers[2].call(env)
+
+      if res[0] != 404
+        return res
+      end
+
+      res = @compilers[3].call(env)
+
+      if res[0] != 404
+        return res
+      end
+
+      @app.call(env)
+
+
+        # @compilers.reduce(nil) do |response,compiler|
+        #   response.tap{ |u| puts "response: #{response.inspect}" } || compiler.call(env).tap { |u| puts "call returned: #{u.inspect}" }
+        # end
+
+      # res || @app.call(env)
+
+    end
+
+    private
+
+    def scripts_config
+      {
+        source_dir: 'app/scripts',
+        url: '/scripts',
+        source_extension: 'js',
+        content_type: 'application/javascript',
+        compiler: pass_thru_compiler
+      }
+    end
+
+    def bower_js_config
+      {
+        source_dir: 'components',
+        url: '/components',
+        source_extension: 'js',
+        content_type: 'application/javascript',
+        compiler: pass_thru_compiler
+      }
+    end
+
+    def bower_css_config
+      {
+        source_dir: 'components',
+        url: '/components/css',
+        source_extension: 'css',
+        content_type: 'text/css',
+        compiler: pass_thru_compiler
+      }
+    end
+
+    def sass_config
+      {
+        :source_dir => 'app/styles',
+        :url => '/styles'
+      }
+    end
+
+    def pass_thru_compiler
+      ->(source_file){
+        ::File.read(source_file)
+      }
+    end
+  end
+end

data/lib/sass/importers/bower_importer.rb

@@ -0,0 +1,32 @@
+module Sass
+  module Importers
+    class BowerImporter < Sass::Importers::Filesystem
+
+      SUPPORTED_EXTNAMES = ["css", "scss", "sass"]
+
+      protected
+
+      def extensions
+        super.merge('css' => :scss)
+      end
+
+      def possible_files(name)
+        if name.start_with? "bower!"
+          name.sub!(/^bower!/, "")
+
+          path = File.join(@root, name)
+          SUPPORTED_EXTNAMES.each do |extname|
+            lookup = "#{path}.#{extname}"
+            if File.exist? lookup
+              return [[lookup, extensions[extname]]]
+            end
+          end
+        else
+          super
+        end
+      end
+
+    end
+  end
+end
+

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: half-pipe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joe Fiorini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-asset-compiler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Grunt-based workflow for your Rails assets
+email:
+- joe@joefiorini.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/half_pipe_helper.rb
+- half-pipe.gemspec
+- lib/generators/half_pipe/install_generator.rb
+- lib/generators/half_pipe/templates/Gruntfile.js
+- lib/generators/half_pipe/templates/_bowerrc
+- lib/generators/half_pipe/templates/_jshintrc
+- lib/generators/half_pipe/templates/app/scripts/application.js
+- lib/generators/half_pipe/templates/app/scripts/main.js
+- lib/generators/half_pipe/templates/app/styles/main.scss
+- lib/generators/half_pipe/templates/bower.json
+- lib/generators/half_pipe/templates/package.json
+- lib/generators/half_pipe/templates/railties.rb
+- lib/half-pipe.rb
+- lib/half-pipe/rails.rb
+- lib/half-pipe/version.rb
+- lib/rack/half-pipe.rb
+- lib/sass/importers/bower_importer.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gem to replace the Rails asset pipeline with a Grunt.js-based workflow, providing
+  dependencies via Bower.
+test_files: []