gulp-pipeline-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8209c637cdffae16d89f3835e0527391f7d27dfd
+  data.tar.gz: c8a24828ef21f8496dada1f1b3ac21e0e1bbc930
+SHA512:
+  metadata.gz: f77ccc0980d0cb3df72cdae0beaf8843f4ad234b9b98a82baa8a7233d2a64f73ca61bc271a278e3a68da068bfddbcf531a0345f674a98f0b6c190c83f749a7d8
+  data.tar.gz: cf96500d1fb8010aab0ace5798335eed544130635ec25cdc4c94e58459afe53688435c5bb0c58e555b4388eb87131a13ce95f0382f6a94ec819a8dee01748862

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+gulp-pipeline-rails

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Kevin Ross
+
+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,73 @@
+# gulp-pipeline-rails
+
+Remove Sprockets from Rails and use [gulp-pipleline](https://github.com/alienfast/gulp-pipeline).  Simpler, faster, and integrates very well with the rest of the assets community.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gulp-pipeline-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gulp-pipeline-rails
+
+## Usage
+
+1. Remove sprockets from your `application.rb` and initialize Rails with `gulp-pipeline-rails`
+
+    ```ruby
+    # require 'rails/all' <== DELETE this line
+    require 'gulp/pipeline/rails/all'
+    ```
+    
+1. Remove unneeded gems such as: 
+   - rails-jquery
+   - rails-sass
+   - uglifier
+   
+1. Remove unneeded `config.assets.*` configurations, simply leave `config.assets.debug` per environment.
+
+1. Delete your old `public` and `tmp` folders.
+   
+1. Setup [gulp-pipleline](https://github.com/alienfast/gulp-pipeline) to generate your assets
+
+2. Startup rails and you should be serving from your new asset pipeline!
+    
+## Goals
+This gem is actually quite simple, and most of these goals are accomplished by the primary project [gulp-pipleline](https://github.com/alienfast/gulp-pipeline).  Nonetheless, if you are coming from rails, this is what to expect:
+
+### Simple 
+Ultimately this gem is simply serving static assets, we need nothing more complicated.  
+
+### Easy
+With very few configurations it is easy to understand and hard to go wrong.  The defaults should be good for almost everyone.  The only common config is `config.assets.debug` based on the environment.   
+
+### Community Friendly 
+Make it easy to use community assets, namely `npm` packages
+
+### Engine aware 
+[gulp-pipleline](https://github.com/alienfast/gulp-pipeline) and this gem should support engine configurations (at least yours).  Beware, if the engines depend on sprockets, we do not have a goal of supporting them.
+
+### Performance
+There should be no performance penalty for using [gulp-pipleline](https://github.com/alienfast/gulp-pipeline) and this gem, in fact, it should be generally faster for development.  Static file serving from external servers should be unaffected.
+
+### Remove Sprockets
+We don't want to match Sprockets in functionality, but remove it from rails and provide simple static asset serving.  We want to remain something simpler, if you want something close to sprockets then I encourage you to engage there and help them make their project better.  
+
+
+## TODO
+- Tests, primarily the `Gulp::Pipeline::Rails::Assets` class which contains asset resolution/path computation
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gulp-pipeline-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/gulp-pipeline-rails.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gulp/pipeline/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gulp-pipeline-rails'
+  spec.version       = Gulp::Pipeline::Rails::VERSION
+  spec.authors       = ['Kevin Ross']
+  spec.email         = ['kevin.ross@alienfast.com']
+  spec.summary       = %q{Rails asset pipeline replacement using gulp-pipeline assets}
+  spec.description   = %q{Remove sprockets and use gulp-pipeline.  Simpler, faster, and integrates very well with the rest of the assets community.}
+  spec.homepage      = ''
+  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'
+end

data/lib/gulp/pipeline/rails.rb

@@ -0,0 +1,9 @@
+require 'gulp/pipeline/rails/version'
+
+module Gulp
+  module Pipeline
+    module Rails
+      # Your code goes here...
+    end
+  end
+end

data/lib/gulp/pipeline/rails/all.rb

@@ -0,0 +1,18 @@
+# Use this file instead of `rails/all` in order to load the gulp pipeline instead of sprockets
+
+require 'rails'
+
+%w(
+  active_record
+  action_controller
+  action_view
+  action_mailer
+  active_job
+  rails/test_unit
+  gulp/pipeline/rails
+).each do |framework|
+  begin
+    require "#{framework}/railtie"
+  rescue LoadError
+  end
+end

data/lib/gulp/pipeline/rails/assets.rb

@@ -0,0 +1,93 @@
+module Gulp
+  module Pipeline
+    module Rails
+      class Assets
+        class << self
+
+          # Computes asset path to public directory. We override this in the Helper to resolve
+          # either debug or digest assets.
+          #
+          # source: favicon.ico
+          # options: {type: :image}
+          def compute_asset_path(source, options = {})
+            dir = type_directory_map[options[:type]] || ''
+
+            # get the relative file path without a leading slash (empty dir join adds leading slash)
+            file = if dir.eql? '' then
+                     source
+                   else
+                     File.join(dir, source)
+                   end
+            if (debug)
+              path = File.join('/', base_path, file)
+            else
+              manifested = manifest[file]
+              raise "#{source} not found in the manifest.  Perhaps you need to recreate it by running `gulp digest` or `gulp rev`" if manifested.nil?
+              path = File.join('/', base_path, manifested)
+            end
+            path
+          end
+
+          # Yield a digest path with respect to debug turned on or off
+          def base_path
+            if debug
+              "#{debug_prefix}/"
+            else
+              "#{digest_prefix}/"
+            end
+          end
+
+          def mount_path(prefix)
+            "/#{base_path}#{prefix}"
+          end
+
+          def path_matches?(path)
+            (path =~ matches_regex) == 0
+          end
+
+          def path_starts_with?(path)
+            (path =~ starts_with_regex) == 0
+          end
+
+          private
+
+          def manifest
+            return @_manifest unless @_manifest.nil?
+
+            # read manifest and cache it
+            path = ::Rails.application.root.join('public', digest_prefix, 'rev-manifest.json')
+            # if not debug, require manifest
+            raise "#{path} not found.  Run `gulp digest` or `gulp rev`." unless File.exists?(path)
+            @_manifest = JSON.parse(File.read(path))
+          end
+
+          # lazy load/cache regex
+          def matches_regex
+            @_matches_regex ||= %r{\A/#{base_path}\z}
+          end
+
+          # lazy load/cache regex
+          def starts_with_regex
+            @_starts_with_regex ||= %r{\A/#{base_path}}
+          end
+
+          def type_directory_map
+            @_type_directory_map ||= ::Rails.application.config.assets.type_directory_map
+          end
+
+          def debug
+            @_debug ||= ::Rails.application.config.assets.debug
+          end
+
+          def digest_prefix
+            @_digest_prefix ||= ::Rails.application.config.assets.digest_prefix
+          end
+
+          def debug_prefix
+            @_debug_prefix ||= ::Rails.application.config.assets.debug_prefix
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/helper.rb

@@ -0,0 +1,24 @@
+module Gulp
+  module Pipeline
+    module Rails
+      module Helper
+        # Maps asset types to public directory.
+        ASSET_PUBLIC_DIRECTORIES = {
+          audio:      '/audios',
+          font:       '/fonts',
+          image:      '/images',
+          javascript: '/javascripts',
+          stylesheet: '/stylesheets',
+          video:      '/videos'
+        }
+
+        # Computes asset path to public directory. Plugins and
+        # extensions can override this method to point to custom assets
+        # or generate digested paths or query strings.
+        def compute_asset_path(source, options = {})
+          Assets.compute_asset_path(source, options)
+        end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/patches.rb

@@ -0,0 +1,21 @@
+require 'gulp/pipeline/rails/patches/route_wrapper'
+
+module Gulp
+  module Pipeline
+    module Rails
+
+      # set our paths to be regarded as internal paths
+      ActionDispatch::Routing::RouteWrapper.class_eval do
+        prepend Patches::RouteWrapper
+      end
+
+
+      if defined?(MetaRequest::Middlewares::Headers)
+        require 'gulp/pipeline/rails/patches/metarequest_middlewares_headers'
+        MetaRequest::Middlewares::Headers.class_eval do
+          prepend Patches::MetaRequestMiddlewaresHeaders
+        end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/patches/metarequest_middlewares_headers.rb

@@ -0,0 +1,15 @@
+require 'gulp/pipeline/rails/assets'
+
+module Gulp
+  module Pipeline
+    module Rails
+      module Patches
+        module MetaRequestMiddlewaresHeaders
+          def asset?(path)
+            @app_config.respond_to?(:assets) && Assets.path_starts_with?(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/patches/route_wrapper.rb

@@ -0,0 +1,20 @@
+require 'gulp/pipeline/rails/assets'
+
+module Gulp
+  module Pipeline
+    module Rails
+      module Patches
+        module RouteWrapper
+
+          def internal_assets_path?
+            Assets.path_matches? path
+          end
+
+          def internal?
+            super || internal_assets_path?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/railtie.rb

@@ -0,0 +1,78 @@
+require 'rails'
+require 'rails/railtie'
+require 'action_controller/railtie'
+require 'active_support/core_ext/module/remove_method'
+require 'set'
+
+require 'gulp/pipeline/rails/server'
+require 'gulp/pipeline/rails/assets'
+require 'gulp/pipeline/rails/helper'
+
+module Rails
+  class Application
+    # Hack: We need to remove Rails' built in config.assets so we can do our own thing.
+    class Configuration
+      remove_possible_method :assets
+    end
+
+    # Undefine Rails' assets method before redefining it, to avoid warnings.
+    remove_possible_method :assets
+    remove_possible_method :assets=
+
+    attr_accessor :assets
+  end
+end
+
+module Gulp
+  module Pipeline
+    module Rails
+      class Railtie < ::Rails::Railtie
+
+        config.assets = ActiveSupport::OrderedOptions.new
+        config.assets.debug = false
+        config.assets.digest_prefix = 'assets/digest'
+        config.assets.debug_prefix = 'assets/debug'
+
+        # Maps asset types to public directory.  If unmapped, there will be nothing added to the path.  This must match the physical layout of the public directory under #{config.assets.digest_prefix} and #{config.assets.debug_prefix}
+        config.assets.type_directory_map = {}
+        # config.assets.type_directory_map = {
+        #   audio: 'audios',
+        #   font: 'fonts',
+        #   image: 'images',
+        #   javascript: 'javascripts',
+        #   stylesheet: 'stylesheets',
+        #   video: 'videos'
+        # }
+
+
+        # We don't use this, but rails/engine.rb `append_assets_path` blows up without presenting this as a configurable option
+        config.assets.paths = []
+
+        # rake_tasks do |app|
+        #   require 'gulp/pipeline/rails/task'
+        #   Gulp::Pipeline::Rails::Task.new(app)
+        # end
+
+        config.after_initialize do |app|
+          config = app.config
+
+          app.assets = Server.new(app)
+          app.routes.prepend do
+            # for each asset path, add a route to our server - e.g. this may be /images or /digest/images depending on `config.assets.debug`.  This means that these paths are stored and served as-is, enabling the greatest compatibility with external file serving.
+            prefixes = config.assets.type_directory_map.values || ['']
+            prefixes.each do |prefix|
+              mount app.assets => Assets.mount_path(prefix)
+            end
+          end
+
+          # now require our patches for the common items that are hard linked to '/assets'
+          require 'gulp/pipeline/rails/patches'
+
+          ActiveSupport.on_load(:action_view) do
+            include Gulp::Pipeline::Rails::Helper
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/server.rb

@@ -0,0 +1,135 @@
+require 'time'
+require 'rack/utils'
+require 'gulp/pipeline/rails/assets'
+
+module Gulp
+  module Pipeline
+    module Rails
+      # `Server` provides a Rack compatible `call` interface and url generation helpers.
+      class Server
+
+        def initialize(app, options = {})
+          config = app.config
+
+          @debug = config.assets.debug
+          @file_server = Rack::File.new(app.root.join('public', Assets.base_path).to_s)
+          @cache_duration = options[:duration] || 1
+          @duration_in_seconds = duration_in_seconds
+          @duration_in_words = duration_in_words
+        end
+
+        # A request for `"/assets/javascripts/foo/bar.js"` will search the public directory.
+        def call(env)
+          if env['REQUEST_METHOD'] != 'GET'
+            return method_not_allowed_response
+          end
+
+          msg = "Served asset #{env['PATH_INFO']} -"
+
+          # Extract the path from everything after the leading slash
+          path = Rack::Utils.unescape(env['PATH_INFO'].to_s.sub(/^\//, ''))
+
+          status, headers, body =
+            if forbidden_request?(path)
+              # URLs containing a `..` are rejected for security reasons.
+              forbidden_response
+            else
+              # # If not debug, enforce/require fingerprinted url. Do we really need this or just paranoia?
+              # if (!@debug)
+              #   fingerprint = path_fingerprint(path)
+              #   if (fingerprint.nil?)
+              #     msg += ' not a manifested file'
+              #     return not_found_response
+              #   end
+              # end
+
+              # standard file serve
+              @file_server.call(env)
+            end
+
+          # log our status
+          case status
+            when :ok
+              logger.info "#{msg} 200 OK "
+            when :not_modified
+              logger.info "#{msg} 304 Not Modified "
+            when :not_found
+              logger.info "#{msg} 404 Not Found "
+            else
+              logger.info "#{msg} #{status} Unknown status message "
+          end
+
+          # add cache headers
+          headers['Cache-Control'] ="max-age=#{@duration_in_seconds}, public"
+          headers['Expires'] = @duration_in_words
+
+          # return results
+          [status, headers, body]
+
+        rescue Exception => e
+          logger.error "Error serving asset #{path}:"
+          logger.error "#{e.class.name}: #{e.message}"
+          raise
+        end
+
+        private
+        def forbidden_request?(path)
+          # Prevent access to files elsewhere on the file system
+          #
+          #     http://example.org/assets/../../../etc/passwd
+          #
+          path.include?('..') || absolute_path?(path)
+        end
+
+        # Public: Check if path is absolute or relative.
+        #
+        # path - String path.
+        #
+        # Returns true if path is absolute, otherwise false.
+        if File::ALT_SEPARATOR
+          require 'pathname'
+
+          # On Windows, ALT_SEPARATOR is \
+          # Delegate to Pathname since the logic gets complex.
+          def absolute_path?(path)
+            Pathname.new(path).absolute?
+          end
+        else
+          def absolute_path?(path)
+            path[0] == File::SEPARATOR
+          end
+        end
+
+        # Returns a 403 Forbidden response tuple
+        def forbidden_response
+          [403, {'Content-Type' => 'text/plain', 'Content-Length' => '9'}, ['Forbidden']]
+        end
+
+        # Returns a 404 Not Found response tuple
+        def not_found_response
+          [404, {'Content-Type' => 'text/plain', 'Content-Length' => '9', 'X-Cascade' => 'pass'}, ['Not found']]
+        end
+
+        def method_not_allowed_response
+          [405, {'Content-Type' => 'text/plain', 'Content-Length' => '18'}, ['Method Not Allowed']]
+        end
+
+        def logger
+          ::Rails.logger
+        end
+
+        def duration_in_words
+          (Time.now + duration_in_seconds).strftime '%a, %d %b %Y %H:%M:%S GMT'
+        end
+
+        def duration_in_seconds
+          (60 * 60 * 24 * 365 * @cache_duration).to_i
+        end
+
+        # def path_fingerprint(path)
+        #   path[/-([0-9a-f]{7,128})\.[^.]+\z/, 1]
+        # end
+      end
+    end
+  end
+end

data/lib/gulp/pipeline/rails/version.rb

@@ -0,0 +1,7 @@
+module Gulp
+  module Pipeline
+    module Rails
+      VERSION = '0.0.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: gulp-pipeline-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kevin Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Remove sprockets and use gulp-pipeline.  Simpler, faster, and integrates
+  very well with the rest of the assets community.
+email:
+- kevin.ross@alienfast.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gulp-pipeline-rails.gemspec
+- lib/gulp/pipeline/rails.rb
+- lib/gulp/pipeline/rails/all.rb
+- lib/gulp/pipeline/rails/assets.rb
+- lib/gulp/pipeline/rails/helper.rb
+- lib/gulp/pipeline/rails/patches.rb
+- lib/gulp/pipeline/rails/patches/metarequest_middlewares_headers.rb
+- lib/gulp/pipeline/rails/patches/route_wrapper.rb
+- lib/gulp/pipeline/rails/railtie.rb
+- lib/gulp/pipeline/rails/server.rb
+- lib/gulp/pipeline/rails/version.rb
+homepage: ''
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Rails asset pipeline replacement using gulp-pipeline assets
+test_files: []