asset 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61f0f83d52b46d60744c9087cc73e8249fa1b9f0
-  data.tar.gz: 9dbe7813be9d7a49f199eaa7c0cea9f4e836119e
+  metadata.gz: 4cd9e5084290d4157c2f2c45785bbc5813256273
+  data.tar.gz: 46b793da9b9774e454134f193036381d03e459f5
 SHA512:
-  metadata.gz: 47e2a6b246c312a6229d924379c26be8a4bd2c11f030171202f22787bbe67a2c26627e6de2f72301883c6e4146d0b1f0167ee88d0b2d85031d1ffb764fb1183e
-  data.tar.gz: cfad137ad7fb37ce1280b3534e528a19d7d35f9e7d8fd16b6ca8b34931fb7a23498731bde0cf7bb45fbb4713ec31d6ce2cdded9d667834fc62a44751f405b5ab
+  metadata.gz: bd153573b90fbc422dadf116410462db9f06b8cbab3b0a3b6d5985d54d88b93e375819593c552d73456f41393180a9344fcab1eb215eadb5d6629bbbf62c2cb9
+  data.tar.gz: b73c59885ceacc7fcc72aa4b628c76a816ff31e62112bf65227a41d9f03eec3da89c67f80dbfb55b9d474ec51bc29383ebb27390a51589f3e8bf504255ac3e76

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+Gemfile.lock
+log
+tmp

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+**Version 0.1.0** - *2017-01-05*
+
+- Fixed gemspec issues

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rerun' #, :git => 'https://github.com/fugroup/rerun'
+  gem 'rb-fsevent'
+  gem 'terminal-notifier'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Fugroup
+
+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,134 @@
+# Asset compresses and serves your CSS and JS files
+
+Compress and cache your Javascript and CSS files automatically.
+
+Set up your manifest file, install the helpers and the middleware, and you're up and running with compressed assets served lightning fast on pure in-memory Ruby Rack.
+
+### Installation
+```
+gem install asset
+```
+or add to Gemfile. In your Rack app include the line
+```ruby
+# Rack apps
+include Asset::Helpers
+
+# Sinatra
+helpers Asset::Helpers
+```
+
+### Settings
+```ruby
+Asset.mode = ENV['RACK_ENV'] || MODE rescue 'development'
+Asset.path = APP_ASSETS rescue File.join(Dir.pwd, 'app', 'assets')
+Asset.cache = File.join(Dir.pwd, 'tmp')
+Asset.debug = false
+```
+
+### Usage
+```yaml
+# Install your manifest file in APP_ROOT/app/assets/manifest.yml
+
+# Asset manifest. Only the files mentioned here will be available.
+# Options are compress: true/false, bundle: true/false
+css:
+- app.css
+- themes/themes.css
+
+js:
+- app.js
+- lib/cookie.js
+
+# Example with options:
+css:
+- app.css:
+  - compress: true
+  - bundle: false
+- themes/themes.css
+
+js:
+- app.js:
+  - bundle: false
+- lib/cookie.js
+```
+
+```ruby
+# After setting up the manifest file, use the helpers in your views
+<%= script_tag 'app.js' %>
+<%= style_tag 'app.css' %>
+
+# Multiple
+<%= script_tag 'app.js', 'lib/cookies.js' %>
+
+# Bundle all files with 'application.js'
+<%= script_tag 'application.js' %>
+
+# Bundle all files with 'application.css'
+<%= script_tag 'application.css' %>
+```
+
+In development mode, all files will be printed. In production mode, you'll get only one file.
+
+The file will also be cached and compressed. The cache auto-expires.
+
+### Middleware
+
+The Asset gem also comes with Rack middleware to handle requests for your assets.
+
+```ruby
+# Insert the asset middleware early in the stack
+use Asset::Router
+
+# Full example from the config.ru file
+
+# Set up middleware stack
+app = Rack::Builder.new do
+  use Asset::Router # Include the Asset middleware router
+
+  # Use this setup to have files served from /assets/images and /assets/fonts
+  use Rack::Static, :urls => ['/images', '/fonts'], :root => APP_ASSETS,
+    :header_rules => [
+      [:all, {'Cache-Control' => 'public, max-age=31536000'}],
+      [:fonts, {'Access-Control-Allow-Origin' => '*'}]
+    ]
+  run App # Your app goes here
+end
+
+run app
+
+# Files will be available here on your server (HTTP):
+/assets/js/app.js
+/assets/js/lib/app.js
+/assets/css/app.css
+/assets/css/themes/dark.css
+
+# You can also drop the /assets in front
+/js/app.js
+/css/app.css
+```
+
+The helpers will generate these URLs, so you don't have to worry about it.
+
+### Images and fonts
+
+To include support for other static file types likes images and fonts, use [Rack::Static](https://github.com/rack/rack/blob/master/lib/rack/static.rb)
+
+```ruby
+use Rack::Static, :urls => ['/images', '/fonts'], :root => APP_ASSETS,
+  :header_rules => [
+    [:all, {'Cache-Control' => 'public, max-age=31536000'}],
+    [:fonts, {'Access-Control-Allow-Origin' => '*'}]
+  ]
+```
+
+We've included an image tag helper too for this use:
+```erb
+# Use this in your application, will default to APP_ROOT/assets/images
+<%= image_tag 'logo.png' %>
+```
+
+### Contribute
+
+Created and maintained by [Fugroup Ltd.](https://www.fugroup.net) We are the creators of [CrowdfundHQ.](https://crowdfundhq.com)
+
+`@authors: Vidar`

data/app.rb

@@ -0,0 +1,52 @@
+class App < Sinatra::Base
+
+  # helpers Asset::Helpers
+
+  configure do
+    # Settings
+    set :app_file, __FILE__
+    set :root, APP_ROOT
+    set :views, APP_VIEWS
+
+    # Turn this on in dev to see handler
+    set :show_exceptions, MODE != 'production'
+    set :raise_errors, false
+
+    # Haml setup
+    set :haml, {:format => :html5}
+    set :haml, :layout => :'layout/layout'
+    set :sass, {:cache_location => './tmp/sass-cache'}
+
+    # Liquid setup
+    Liquid::Template.file_system = Liquid::LocalFileSystem.new(APP_VIEWS)
+
+    # Set up loggers and tmp files
+    Dir.mkdir('./tmp') unless File.exists?('./tmp')
+    Dir.mkdir('./log') unless File.exists?('./log')
+
+    # Global loggers
+    $log = Logger.new("./log/app.log")
+    $errors = Logger.new("./log/errors.log")
+  end
+
+  # Disable caching of classes when not in production
+  configure :development, :test do |c|
+    Liquid.cache_classes = false
+    Liquid::Template.error_mode = :strict
+  end
+
+  get('/') do
+    erb(:index)
+  end
+
+  # Default not found page
+  not_found do
+    "404, Not found".tap{|m| puts m}
+  end
+
+  # Default error pages
+  error(500..510) do
+    "50X, Application error".tap{|m| puts m}
+  end
+
+end

data/asset.gemspec

@@ -0,0 +1,32 @@
+Gem::Specification.new do |s|
+  s.name        = 'asset'
+  s.version     = '0.0.3'
+  s.date        = '2017-01-05'
+  s.summary     = "Compress and serve your CSS and JS automatically"
+  s.description = "The only thing you need for your assets."
+  s.authors     = ["Fugroup Limited"]
+  s.email       = 'vidar@fugroup.net'
+  s.license     = 'MIT'
+
+  s.add_runtime_dependency 'rack', '>= 0'
+  s.add_runtime_dependency 'sass', '>= 0'
+  s.add_runtime_dependency 'uglifier', '>= 0'
+
+  s.add_development_dependency 'sinatra', '>= 0'
+  s.add_development_dependency 'puma', '>= 0'
+  s.add_development_dependency 'tilt', '>= 0'
+  s.add_development_dependency 'liquid', '>= 0'
+  s.add_development_dependency 'erubis', '>= 0'
+  s.add_development_dependency 'rest-client', '>= 0'
+  s.add_development_dependency 'request_store', '>= 0'
+  s.add_development_dependency 'fuprint', '>= 0'
+  s.add_development_dependency 'futest', '>= 0'
+
+  s.homepage    = 'https://github.com/fugroup/asset'
+  s.license     = 'MIT'
+
+  s.require_paths = ['lib']
+  s.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|app|config|log|tmp)/})
+  end
+end

data/config.ru

@@ -0,0 +1,21 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+# Init the app
+require './config/boot.rb'
+require './app.rb'
+
+# Set up middleware stack
+app = Rack::Builder.new do
+  use Fuprint::Request
+  use Asset::Router
+  use Rack::Static, :urls => ['/images', '/fonts'], :root => APP_ASSETS,
+    :header_rules => [
+      [:all, {'Cache-Control' => 'public, max-age=31536000'}],
+      [:fonts, {'Access-Control-Allow-Origin' => '*'}]
+    ]
+  run App
+end
+
+run app
+

data/lib/asset.rb

@@ -1,3 +1,5 @@
+require 'rack'
+
 module Asset
 
   # # # # # #
@@ -10,10 +12,10 @@ module Asset
   class << self; attr_accessor :mode, :path, :cache, :manifest, :debug; end
 
   # Default is production
-  @mode = ENV['RACK_ENV'] || MODE rescue 'development'
-  @path = APP_ASSETS rescue File.join(Dir.pwd, 'app', 'assets')
+  @mode = ENV['RACK_ENV'] || 'development'
+  @path = File.join(Dir.pwd, 'app', 'assets')
   @cache = File.join(Dir.pwd, 'tmp')
-  @debug = true
+  @debug = false
 
 end
 
@@ -23,6 +25,5 @@ require_relative 'assets/item'
 # Load the manifest
 ::Asset.manifest = ::Asset::Util.load_manifest
 
-
 require_relative 'assets/helpers'
 require_relative 'assets/router'

data/lib/assets/helpers.rb

@@ -0,0 +1,40 @@
+module Asset
+  module Helpers
+
+    # Script tags
+    def script_tag(*paths)
+      tag('js', *paths) do |src|
+        %{<script src="#{src}"></script>}
+      end
+    end
+
+    # Style tags
+    def style_tag(*paths)
+      tag('css', *paths) do |src|
+        %{<link href="#{src}" media="all" rel="stylesheet" type="text/css">}
+      end
+    end
+
+    # Image tags
+    def image_tag(path)
+      b = ::Asset::Util.mtime("images/#{path}")
+      %{<img src="/assets/images/#{CGI.escapeHTML(path)}#{b ? "?#{b.to_i}" : ''}">} rescue path
+    end
+
+    private
+
+    # Build the tags
+    def tag(type, *paths, &block)
+      paths.map do |path|
+
+        # Yield the source back to the tag builder
+        item = ::Asset.manifest.find{|i| i.path == path}
+
+        # Src is same as path if item not found
+        item ? item.files.map{|src| yield(%{/assets/#{type}/#{src}})} : yield(path)
+
+      end.flatten.join("\n")
+    end
+
+  end
+end

data/lib/assets/item.rb

@@ -0,0 +1,67 @@
+module Asset
+  class Item
+
+    attr_accessor :path, :type, :key, :modified, :compress, :bundle, :name
+
+    # Init
+    def initialize(*args)
+      @path, @type, @key, @modified, @compress, @bundle = args
+      @name = @path.rpartition('.')[0]
+    end
+
+    # File? Or bundle?
+    def file?
+      @path !~ /^application\.(js|css)$/
+    end
+
+    # Get the files. Pass keyed = false to get the path instead of the file
+    def files(keyed = true)
+      if file? or (keyed and ::Asset.mode == 'production')
+        [keyed ? file : path]
+      else
+        ::Asset.manifest.select{|i| i.type == @type and i.file?}.map{|i| keyed ? i.file : i.path}
+      end
+    end
+
+    # Get the file, meaning the full path with key
+    def file
+      ::Asset.mode == 'development' ? @path : %{#{file? ? @name : 'application'}-#{@key}.#{@type}}
+    end
+
+    # Get the content. Pass cache = false to fetch from disk instead of the cache.
+    def content(cache = (::Asset.mode = 'production'))
+      return joined unless cache
+
+      File.read(File.join(::Asset.cache, %{#{@key}.#{@type}})).tap{|f| return f if f} rescue nil
+
+      # Compress the files
+      compressed.tap{|r| write_cache(r)}
+    end
+
+    # Store in cache
+    def write_cache(r)
+      File.open(File.join(::Asset.cache, %{#{@key}.#{@type}}), 'w'){|f| f.write(r)}
+    end
+
+    # Compressed joined files
+    def compressed
+      case @type
+      when 'css'
+        Tilt.new('scss', :style => :compressed){ joined }.render rescue joined
+      when 'js'
+        Uglifier.compile(joined, {}) rescue joined
+      end
+    end
+
+    # All files joined
+    def joined
+      @joined ||= files(false).map{|f| File.read(File.join(::Asset.path, @type, f))}.join
+    end
+
+    # Print data
+    def print
+      [:path, :type, :key, :name, :modified, :files, :content].each{|r| puts "#{r.upcase}: #{send(r).inspect}"}
+    end
+
+  end
+end

data/lib/assets/router.rb

@@ -0,0 +1,76 @@
+module Asset
+  class Router
+
+    # Mime types
+    MIME = {
+      'js' => 'application/javascript; charset=UTF-8',
+      'css' => 'text/css; charset=UTF-8',
+      'txt' => 'text/plain; charset=UTF-8'
+    }
+
+    # Init
+    def initialize(app)
+      @app = app
+    end
+
+    # Call
+    def call(env)
+      # Setting up request
+      @request = Rack::Request.new(env)
+
+      # The routes
+      case @request.path_info
+
+      # Match /assets?/:type/path
+      when /^(\/assets)?\/(js|css)\/(.+)/
+        type, path = $2, $3
+
+        path =~ /(-[a-f0-9]{1,32})/
+        path = path.gsub($1, '') if $1
+
+        item = ::Asset.manifest.find{|i| i.path == path and i.type == type}
+
+        # Not found if no item, wrong key or no content
+        return not_found if !item or ($1 and $1 != item.key) or !item.content(!!$1)
+
+        found(item)
+
+      # Bounce favicon requests
+      when /^\/favicon\.ico$/
+        not_found
+
+      # Return a standard robots.txt
+      when /^\/robots\.txt$/
+        robots
+
+      else
+        # No routes found, pass down the middleware stack
+        @app.call(env)
+      end
+    end
+
+    private
+
+    # Found
+    def found(item)
+      [ 200, {'Content-Type' => MIME[item.type],
+        'Content-Length' => item.content.size,
+        'Cache-Control' => 'max-age=86400, public',
+        'Expires' => (Time.now + 86400*30).utc.rfc2822,
+        'Last-Modified' => item.modified.utc.rfc2822
+        }, [item.content]]
+    end
+
+    # Not found
+    def not_found(path = '@')
+      [404, {'Content-Type' => MIME['txt'], 'Content-Length' => 0}, []]
+    end
+
+    # Robots
+    def robots
+      s = %{Sitemap: #{@request.scheme}://#{@request.host}/sitemap.xml}
+      [200, {'Content-Type' => MIME['txt'],'Content-Length' => s.size}, [s]]
+    end
+
+  end
+end

data/lib/assets/util.rb

@@ -0,0 +1,55 @@
+module Asset
+  class Util
+
+    # Get timestamp
+    def self.mtime(path)
+      File.mtime(asset_path(path))
+    end
+
+    # Asset path
+    def self.asset_path(path)
+      File.join(::Asset.path, File.split(path))
+    end
+
+    # Digest
+    def self.digest(path, time)
+      Digest::MD5.hexdigest(%{#{path}#{time.to_i}})
+    end
+
+    # Load manifest
+    def self.load_manifest
+      list = YAML.load_file(File.join(::Asset.path, 'manifest.yml'))
+      manifest = []
+
+      list.each do |type, files|
+        max = Time.new(0).utc
+        files.each do |name|
+
+          # Depending on the options, the name can be a string or a Hash
+          h = name.is_a?(Hash)
+
+          # Path looks like app.js or similar
+          path = h ? name.keys[0] : name
+
+          # Get the modified time of the asset
+          modified = mtime("#{type}/#{path}").utc
+
+          # Record max to know the latest change
+          max = modified if modified > max
+
+          # Loading manifest with items
+          manifest << ::Asset::Item.new(
+            path, type, digest(path, modified), modified,
+            (h ? name['compress'] : true), (h ? name['bundle'] : true))
+        end
+
+        # Insert the application bundle
+        manifest.insert(0, ::Asset::Item.new(
+          "application.#{type}", type,
+          digest("application.#{type}", max), max))
+      end
+      manifest
+    end
+
+  end
+end

metadata

@@ -1,22 +1,202 @@
 --- !ruby/object:Gem::Specification
 name: asset
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Fugroup Limited
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-02 00:00:00.000000000 Z
-dependencies: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uglifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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'
+- !ruby/object:Gem::Dependency
+  name: puma
+  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'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  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'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  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'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  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'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  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'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  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'
+- !ruby/object:Gem::Dependency
+  name: fuprint
+  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'
+- !ruby/object:Gem::Dependency
+  name: futest
+  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: The only thing you need for your assets.
 email: vidar@fugroup.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- app.rb
+- asset.gemspec
+- config.ru
 - lib/asset.rb
+- lib/assets/helpers.rb
+- lib/assets/item.rb
+- lib/assets/router.rb
+- lib/assets/util.rb
 homepage: https://github.com/fugroup/asset
 licenses:
 - MIT
@@ -37,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Compress and serve your CSS and JS automatically