half-pipe 0.2.4 → 0.3.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8de0d62c5278708aaa208e8d957285b14381ee0
-  data.tar.gz: 4fd47d8a8a85efeb9ce775288932f548e74380ab
+  metadata.gz: e25db15e868e377f593f10acc4d469b234b8e6a8
+  data.tar.gz: 6a79cc94c56035c15fb9a43a64c3af950283fc38
 SHA512:
-  metadata.gz: 091ac0239e741cbffd1b7f3ba27b0f1386d817f2ee46260b1fd951aab2f6d2b1bad16adc8ff686d133de7bca37c4d2859644944225e6622eb53efc391e2f57d5
-  data.tar.gz: 16592964d9521c786a6b71fee1dac16e42120e7822439baffd233e5d4d947897c8b8be05a01d2e8f4468c41a53b2c8f4ecc2faa0d6ec9c1058ec479d8df31406
+  metadata.gz: 4e2c8314902a381dd4fa1e81a94c3d5a3a8b16d211ce171913e008cebabaa8c171d2e597b2f8543ca22317faada95aa6fd358363f45dca20abffddcdf3bb2d76
+  data.tar.gz: f54a68b26199cbe600a8b0056253eedc79fc68baae72b021204e09c1856fc84aeb8acd0b087ce5a783e48ee483d05635059393ea52f563e6f3257b7b48efeb03

data/README.md

@@ -112,7 +112,7 @@ In this early release if you want to configure anything, you'll have to manually
 
 ## Roadmap
 
-- v0.2 - Asset fingerprinting
+We're currently undergoing some pretty major changes in the Half Pipe workflow. See our [milestones](/d-i/half-pipe/issues/milestones) for what's coming in the near future.
 
 ## Future Features
 

data/ROADMAP.md

@@ -0,0 +1 @@
+Half Pipe currently undergoing some pretty major workflow changes. See our [milestones](/d-i/half-pipe/issues/milestones) for what's coming in the near future.

data/app/helpers/half_pipe_helper.rb

@@ -1,10 +1,10 @@
 module HalfPipeHelper
 
   def requirejs_include_tag(script, options={})
-    script, options = if Rails.application.config.half_pipe.serve_assets
-               ["/components/requirejs/require.js", { data: { main: "/scripts/application.js" } }]
+    script, options = if Rails.application.config.half_pipe.env.debug?
+               ["/components/requirejs/require.js", { data: { main: "/assets/scripts/application.js" } }]
              else
-               ["/scripts/application.js", {}]
+               ["/assets/scripts/application.js", {}]
              end
     javascript_include_tag script, options
   end

data/half-pipe.gemspec

@@ -18,4 +18,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_dependency "sass"
+  gem.add_dependency "rails", "~> 4.0.0"
 end

data/lib/generators/half_pipe/install_generator.rb

@@ -8,13 +8,33 @@ module HalfPipe
         @_half_pipe_source_root ||= File.expand_path("../templates", __FILE__)
       end
 
-      def create_initializer_file
+      def welcome
+        say "*" * 120
+        say
+        say "Welcome to Half Pipe!"
+        say "I'm going to take some preliminary setup steps to get you going."
+        say
+        say "*" * 120
+      end
+
+      def create_config_files
+        say
+        say "First I need to generate config files for NPM & Bower. This is where you'll put your asset building and browser dependencies in the future."
+        say
+        sleep 3
         template "package.json", "package.json"
         template "_bowerrc", ".bowerrc"
         template "bower.json", "bower.json"
         template "_jshintrc", ".jshintrc"
         template "Gruntfile.js", "Gruntfile.js"
+        template "config/half-pipe.json"
+      end
 
+      def remove_sprockets
+        say
+        say "Half Pipe uses app/scripts and app/styles for your JavaScript and Stylesheet templates. I need to update your application layout to point to those, plus remove any traces of sprockets."
+        say
+        sleep 3
         comment_lines "config/application.rb", %r{sprockets/railtie}
 
         railties_requires = File.read(File.join(self.class.source_root, "railties.rb"))
@@ -22,46 +42,92 @@ module HalfPipe
 
         gsub_file "app/views/layouts/application.html.erb", %r{\s*<%= stylesheet_link_tag\s+"application".*%>$}, ''
         gsub_file "app/views/layouts/application.html.erb", %r{\s*<%= javascript_include_tag\s+"application".*%>$}, ''
+      end
+
+      def insert_includes_into_layout
         insert_into_file "app/views/layouts/application.html.erb", %Q{  <%= requirejs_include_tag "/scripts/application.js" %>\n  }, before: "</body>"
         insert_into_file "app/views/layouts/application.html.erb", %Q{  <%= stylesheet_link_tag "/styles/main.css" %>\n  }, before: "</head>"
+      end
 
-        gsub_file "config/environments/development.rb", "config.assets.debug = true", "config.middleware.use Rack::HalfPipe"
+      def generate_scripts
+        say
+        say "Now I can generate some starter templates for your requirejs configuration and Sass imports"
+        say
+        sleep 3
+        empty_directory "app/scripts"
 
-        append_to_file ".gitignore", %w(node_modules bower_components public/scripts public/styles public/images).join("\n"), force: true
+        template "app/scripts/main.js"
+        template "app/scripts/application.js"
+      end
 
-        directory "app"
+      def generate_stylesheets
+        template "app/styles/main.scss"
+      end
 
-        empty_directory "app/scripts"
+      def insert_ignores
+        append_to_file ".gitignore", %w(node_modules bower_components public/assets).join("\n"), force: true
+      end
 
-        inside "app/scripts" do
-          template "main.js", force: true
-          template "application.js", force: true
+      def generate_task_config_files
+        say
+        say "All of your Grunt tasks will be configured by files in #{Rails.root.join("tasks/options")}. After I'm done, have a look there to see if you need to customize anything."
+        say
+        sleep 3
+        empty_directory "tasks/options"
+
+        inside "tasks/options" do
+          task_options_files.each do |f|
+            template File.basename(f), force: true
+          end
         end
+      end
 
-        initializer "sass.rb" do
-          %Q{
-          require 'sass/importers/bower_importer'
-          require 'sass/half_pipe_functions'
-          Sass.load_paths << Sass::Importers::BowerImporter.new("bower_components")
-          }
-        end
+      def patch_sass_imports
+        # TODO: Remove this once https://github.com/chriseppstein/sass-css-importer/pull/6 is accepted and released
+        gem "sass-css-importer", github: "joefiorini/sass-css-importer", branch: "load-paths"
+      end
+
+      def install_dependencies
+        say_status :run, "bundle install"
 
+        bundle_path = Gem.bin_path("bundler", "bundle")
+        Bundler.with_clean_env do
+          `"#{Gem.ruby}" "#{bundle_path}" install`
+        end
         run "npm install"
+      end
 
+      def build_project
         ENV["PATH"] = "./node_modules/.bin:#{ENV["PATH"]}"
 
         run "bower install"
-        run "grunt build"
+        run "grunt build:public"
+      end
+
+
+      def finalize
+
+        say
+        say "Congratulations!".upcase
+        say
 
         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."
+        say
+        say "To start developing, fire up a development server with 'grunt server:debug'. You can continue to use 'http://localhost:3000' in your browser to access your app. I will take care of rebuilding your assets and restarting your Rails server as you work. Enjoy!"
       end
 
+      protected
+
       def main_module_name
         app_name.underscore.dasherize
       end
 
       def app_name
-        Rails.application.class.parent_name
+        Rails.application.class.parent_name || "myapp"
+      end
+
+      def task_options_files
+        Dir[File.join(%W(#{File.dirname(__FILE__)} templates tasks options *.js))]
       end
 
     end

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

@@ -1,65 +1,38 @@
 /*global module:false*/
 module.exports = function(grunt) {
 
+  require("load-grunt-tasks")(grunt);
+  grunt.loadNpmTasks('grunt-connect-proxy');
+
+  function config(name){
+    return require("./tasks/options/" + name);
+  }
 
   // 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: {
-      scripts: {
-        options: {
-          almond: true,
-          baseUrl: "app/scripts",
-          mainConfigFile: "app/scripts/application.js",
-          name: "<%= main_module_name %>",
-          out: "public/scripts/application.js",
-          wrap: true
-        }
-      }
-    },
-
-    clean: ['public/scripts/', 'public/styles', 'tmp/']
-
+    dirs: grunt.file.readJSON('config/half-pipe.json'),
+    bowerOpts: grunt.file.readJSON('.bowerrc'),
+    jshint: config("jshint"),
+    sass: config("sass"),
+    cssmin: config("cssmin"),
+    requirejs: config("requirejs"),
+    connect: config("connect"),
+    copy: config("copy"),
+    watch: config("watch"),
+    rails: config("rails"),
+    clean: ['<%%= dirs.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-requirejs');
-
   // Default task.
-  grunt.registerTask('default', 'build');
+  grunt.registerTask('default', 'build:debug');
+
+  grunt.registerTask('build:debug', ['copy:prepare', 'sass:debug', 'copy:stage']);
+  grunt.registerTask('build:public', ['copy:prepare', 'sass:public', 'copy:stage', 'requirejs:public', 'copy:public']);
 
-  // Build task.
-  grunt.registerTask('build', ['jshint', 'sass', 'cssmin', 'requirejs']);
+  grunt.registerTask('server:debug', ['build:debug', 'configureProxies', 'connect:debug', 'rails:server:start', 'watch']);
+  grunt.registerTask('server:public', ['build:public', 'configureProxies', 'connect:public:keepalive']);
 
 };
 

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

@@ -1 +1 @@
-@import "bower!normalize-css/normalize";
+@import "CSS:normalize-css/normalize";

data/lib/generators/half_pipe/templates/config/half-pipe.json

@@ -0,0 +1,3 @@
+{
+  "tmp": "tmp/half-pipe"
+}

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

@@ -1,15 +1,22 @@
 {
   "name": "<%= app_name %>",
+  "dependencies": {
+    "bower": "~1.2.0"
+  },
   "devDependencies": {
     "grunt-cli": "~0.1.7",
     "grunt": "~0.4.1",
-    "bower": "~1.0.0",
     "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-requirejs": "~0.3.5"
+    "grunt-contrib-requirejs": "~0.4.1",
+    "grunt-contrib-connect": "~0.5.0",
+    "grunt-contrib-watch": "~0.5.3",
+    "grunt-connect-proxy": "~0.1.5",
+    "grunt-rails-server": "git://github.com/joefiorini/grunt-rails-server.git",
+    "load-grunt-tasks": "~0.1.0",
+    "almond": "~0.2.6"
   }
 }
-

data/lib/generators/half_pipe/templates/tasks/options/connect.js

@@ -0,0 +1,63 @@
+var proxy = require('grunt-connect-proxy/lib/utils').proxyRequest;
+
+module.exports = {
+  options: {
+    port: process.env.PORT || "3000",
+    middleware: middlewareChooser,
+    debug: true
+  },
+  debug: {
+    options: {
+      base: ["<%%= dirs.tmp %>/public", "<%%= bowerOpts.directory %>"]
+    }
+  },
+  "public": {
+    options: {
+      base: ["public/"]
+    }
+  },
+  proxies: [{
+    context: '/',
+    host: 'localhost',
+    port: 3001,
+    https: false,
+    changeOrigin: false
+  }],
+  options: {
+    debounceDelay: 200
+  }
+};
+
+function middlewareChooser(connect, options) {
+  var assetServer = connect['static'](options.base[0]);
+  var bowerServer;
+
+  if(options.base[1]) {
+    bowerServer = connect['static'](options.base[1]);
+  }
+
+  return [
+    runMiddleware(function(request) {
+      if(request.url.match(/^\/assets/)) {
+        return assetServer;
+      } else if(bowerServer && request.url.match(/^\/components/)) {
+        request.url = request.url.replace(/^\/components/, "");
+        return bowerServer;
+      } else {
+        return proxy;
+      }
+    })
+  ];
+}
+
+function runMiddleware(chooser) {
+  return function(request, response, next) {
+    var middleware = chooser(request);
+
+    if(middleware) {
+      middleware.apply(this, arguments);
+    } else {
+      next();
+    }
+  }
+}

data/lib/generators/half_pipe/templates/tasks/options/copy.js

@@ -0,0 +1,31 @@
+module.exports = {
+  prepare: {
+    files: [{
+      expand: true,
+      cwd: 'app/scripts',
+      src: '**/*.js',
+      dest: '<%%= dirs.tmp %>/prepare/assets/scripts'
+    }, {
+      expand: true,
+      cwd: 'app/images',
+      src: '**/*',
+      dest: '<%%= dirs.tmp %>/prepare/assets/images'
+    }]
+  },
+  stage: {
+    files: [{
+      expand: true,
+      cwd: '<%%= dirs.tmp %>/prepare',
+      src: '**/*',
+      dest: '<%%= dirs.tmp %>/public'
+    }]
+  },
+  "public": {
+    files: [{
+      expand: true,
+      cwd: '<%%= dirs.tmp %>/prepare',
+      src: ['**/*', '!**/*.js'],
+      dest: 'public/'
+    }]
+  }
+};

data/lib/generators/half_pipe/templates/tasks/options/cssmin.js

@@ -0,0 +1,3 @@
+module.exports = {
+  'public/styles/main.css': 'tmp/styles/main.css'
+};

data/lib/generators/half_pipe/templates/tasks/options/jshint.js

@@ -0,0 +1,8 @@
+module.exports = {
+  options: {
+    jshintrc: '.jshintrc'
+  },
+  gruntfile: {
+    src: 'Gruntfile.js'
+  }
+};

data/lib/generators/half_pipe/templates/tasks/options/rails.js

@@ -0,0 +1,5 @@
+module.exports = {
+  options: {
+    port: 3001
+  }
+};

data/lib/generators/half_pipe/templates/tasks/options/requirejs.js

@@ -0,0 +1,45 @@
+module.exports = {
+  "public": {
+    options: {
+      name: "../../../../../node_modules/almond/almond",
+      baseUrl: "<%%= dirs.tmp %>/public/assets/scripts",
+      out: "public/assets/scripts/application.js",
+      wrap: true,
+      insertRequire: ['<%= main_module_name %>'],
+      deps: ['<%= main_module_name %>'],
+      shim: {
+        'jquery': { exports: '$' },
+        'jquery.textareaAutogrow': {
+          deps: ['jquery']
+        },
+        'pickadate/picker.date': {
+          deps: ['pickadate/picker'],
+          exports: 'Picker'
+        },
+        'pickadate/picker.time': {
+          deps: ['pickadate/picker'],
+          exports: 'Picker'
+        },
+        'pickadate/picker': {
+          deps: ['jquery'],
+          exports: 'Picker'
+        }
+      },
+      paths: {
+        '<%= main_module_name %>': 'main',
+        'flight': '../../../../../bower_components/flight',
+        'jquery': '../../../../../bower_components/jquery/jquery',
+        'lodash': '../../../../../bower_components/lodash/lodash',
+        'jquery-ujs': '../../../../../bower_components/jquery-ujs/src/rails',
+        'jquery.fileupload': '../../../../../bower_components/jquery-file-upload/js/jquery.fileupload',
+        'jquery.ui.widget': '../../../../../bower_components/jquery-file-upload/js/vendor/jquery.ui.widget',
+        'jquery.textareaAutogrow': '../../../../../bower_components/jquery.textareaAutogrow/jquery.textareaAutogrow',
+        'bacon': '../../../../../bower_components/bacon/dist/Bacon',
+        'bacon.jquery': '../../../../../bower_components/bacon.jquery/dist/bacon.jquery',
+        'zeroclipboard': '../../../../../bower_components/zeroclipboard/ZeroClipboard',
+        'pickadate': '../../../../../bower_components/pickadate/lib'
+
+      }
+    }
+  }
+};

data/lib/generators/half_pipe/templates/tasks/options/sass.js

@@ -0,0 +1,19 @@
+module.exports = {
+  options: {
+    style: 'expanded',
+    require: ['sass-css-importer'],
+    loadPath: ['<%%= bowerOpts.directory || "bower_components" %>'],
+    bundleExec: true
+  },
+  debug: {
+    src: 'app/styles/main.scss',
+    dest: '<%%= dirs.tmp %>/prepare/assets/styles/main.css'
+  },
+  "public": {
+    options: {
+      style: 'compressed'
+    },
+    src: 'app/styles/main.scss',
+    dest: '<%%= dirs.tmp %>/prepare/assets/styles/main.css'
+  }
+};

data/lib/generators/half_pipe/templates/tasks/options/watch.js

@@ -0,0 +1,13 @@
+module.exports = {
+  debug: {
+    files: ['app/scripts/**/*', 'app/styles/**/*'],
+    tasks: ['build:debug']
+  },
+  rails: {
+    files: ['config/**/*.rb', 'lib/**/*.rb', 'Gemfile.lock'],
+    tasks: ['rails:server:restart'],
+    options: {
+      interrupt: true
+    }
+  }
+};

data/lib/half-pipe/rails.rb

@@ -3,31 +3,7 @@ module HalfPipe
 
     config.before_configuration do
       config.half_pipe = ActiveSupport::OrderedOptions.new
-      config.half_pipe.serve_assets = false
-      config.half_pipe.quiet_assets = false
-    end
-
-    initializer "half_pipe.middleware", after: "build_middleware_stack" do |app|
-      app.config.middleware.use Rack::HalfPipe if config.half_pipe.serve_assets
-    end
-
-    initializer "half_pipe.quiet_assets", after: "build_middleware_stack" do |app|
-      next unless app.config.half_pipe.quiet_assets
-
-      ASSETS_PREFIX = %r{\/(?:images|scripts|styles|components)}
-
-      Rails::Rack::Logger.class_eval do
-        def call_with_quiet_assets(env)
-          old_logger_level, level = Rails.logger.level, Logger::ERROR
-          # Increase log level because of messages that have a low level should not be displayed
-          Rails.logger.level = level if env['PATH_INFO'] =~ ASSETS_PREFIX
-          call_without_quiet_assets(env)
-        ensure
-          Rails.logger.level = old_logger_level
-        end
-        alias_method_chain :call, :quiet_assets
-      end
-
+      config.half_pipe.env = ActiveSupport::StringInquirer.new(ENV['HALF_PIPE_ENV'] || 'debug')
     end
 
   end

data/lib/half-pipe/version.rb

@@ -1,5 +1,5 @@
 module Half
   module Pipe
-    VERSION = "0.2.4"
+    VERSION = "0.3.0.alpha.1"
   end
 end

data/lib/rack/half-pipe.rb

@@ -79,6 +79,7 @@ module Rack
         :source_dir => 'app/styles',
         :url => '/styles',
         sass_options: {
+          debug_info: true,
           line_comments: false,
           style: :expanded
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: half-pipe
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0.alpha.1
 platform: ruby
 authors:
 - Joe Fiorini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-27 00:00:00.000000000 Z
+date: 2013-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 description: Grunt-based workflow for your Rails assets
 email:
 - joe@joefiorini.com
@@ -35,6 +49,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
 - app/helpers/half_pipe_helper.rb
 - examples/rails/.bowerrc
@@ -101,8 +116,17 @@ files:
 - 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/config/half-pipe.json
 - lib/generators/half_pipe/templates/package.json
 - lib/generators/half_pipe/templates/railties.rb
+- lib/generators/half_pipe/templates/tasks/options/connect.js
+- lib/generators/half_pipe/templates/tasks/options/copy.js
+- lib/generators/half_pipe/templates/tasks/options/cssmin.js
+- lib/generators/half_pipe/templates/tasks/options/jshint.js
+- lib/generators/half_pipe/templates/tasks/options/rails.js
+- lib/generators/half_pipe/templates/tasks/options/requirejs.js
+- lib/generators/half_pipe/templates/tasks/options/sass.js
+- lib/generators/half_pipe/templates/tasks/options/watch.js
 - lib/half-pipe.rb
 - lib/half-pipe/rails.rb
 - lib/half-pipe/version.rb
@@ -127,9 +151,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.2