lux_assets 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf0499416784b64eb2a3fc814ee2d8fc41a44695c053343a731f15ddcb44e682
+  data.tar.gz: ec17806130acc118a8401efaa522cb423ebef09727768343eec92214debf28b3
+SHA512:
+  metadata.gz: c887341980224009f77a1261fbcdac1805d370082fc3808f3de564a2d5dabfc75ef3cfd9ee6028a55268695bd65bd5b4134eaa5f51554e959b00bdb882e39d47
+  data.tar.gz: e3af40781f0d76e3f005bbf1fa10fd487ae4801d56078157205518e98f73a5205c24d1047eacbfa93a30eeb57d403157ef0a76a94544b2fa70f53dab9408f97c

data/README.md

@@ -0,0 +1,140 @@
+# Web assets
+
+Lightweight web assets packer that loves simplicity.
+
+* framework agnostic, use anywhere
+* compiles js, coffee, typescript, css, sass "out of the box"
+* keeps manifest in a single file
+* plugable to handle any other extension
+* update manifest file for production
+* autoprefixer, minify, gzip the output
+* add rake tasks
+
+## Instalation
+
+Add `lux_assets` gem to `Gemfile` and then `bundle install`
+```
+gem 'lux_assets'
+```
+
+## Using
+
+To use the gem we have bin file in a path (build with Thor gem) named `lux_assets`.
+
+```
+~/dev/app $ lux_assets
+Commands:
+  lux_assets clear           # Clear all caches
+  lux_assets compile         # Compile assets for production
+  lux_assets help [COMMAND]  # Describe available commands or one specific command
+  lux_assets install         # Install all needed packages via yarn
+  lux_assets show            # Show all files/data in manifest
+```
+
+1. Start with `lux_assets install`
+2. Modify ./config/assets.rb
+3. Compile with `lux_assets compile`
+4. Inspect added files with `lux_assets show`
+
+### To compile
+
+```
+~/dev/app $ lux_assets compile
+~/dev/app $ rake assets:compile
+Compile js/admin -> /assets/js-admin-d1b55490e6327ba81e60b24539c6086ee1fe5d48.js
+Compile js/main -> /assets/js-main-a72368758567e466aa01643b1e7426120dbca65b.js
+Compile css/admin -> /assets/css-admin-f486d0d464932a9da584289007d170695dce23ce.css
+Compile css/main -> /assets/css-main-1b6d66a32ad6af5fd34edbe4369585be351790cd.css
+```
+
+### To get list of all added files
+
+`lux_assets show`
+
+or
+
+```
+require 'lux_assets'
+
+ap LuxAssets.to_h
+```
+
+
+## Example ./config/assets.rb
+
+```
+# relative_root './app/assets'
+
+asset :admin do
+  js do
+    add 'js/admin/js_vendor/*' # will add all files from a folder
+    add 'js/shared/**'         # will add all files from a folder + subfolders
+    add '/Used/foo/app/bar/asssets/admin.js'
+    add ['list', 'of', 'files']
+    add proc { 'js string' }
+    plugin :foo
+  end
+
+  css do
+    add 'css/admin/index.scss'
+    add proc { 'css string' }
+  end
+end
+
+asset :main do
+  js do
+    # ...
+  end
+
+  css do
+    # ...
+  end
+end
+```
+
+### What can you add
+
+* relative file
+* absolute file
+* list of files
+* proc
+
+If you add proc, proc retun must be a string, not a file
+
+
+## Extending
+
+### Adding processor for new file type
+
+This is all that is needed to add support for TypeScript compilation.
+
+```
+class LuxAssets::Element
+  def compile_ts
+    LuxAssets.run "node_modules/typescript/.bin/tsc --outFile '#{@cache}' '#{@source}'"
+  end
+end
+```
+
+### Added new plugin for file adder
+
+You need to extend `LuxAssets` class and call method `add` with list of files or a proc.
+
+```
+module LuxAssets
+  # include files from a plugin
+  def plugin name
+    plugin = Lux.plugin.get name
+    add '%s/**' % plugin[:folder]
+  end
+end
+```
+
+## Rakefile
+
+If you want to use `Rake` tasks and not `lux_assets` bin, there is a wrapper.
+
+In `Rakefile` just add `require 'lux_assets'` and tasks will automaticly be added to your list of tasks.
+
+Rake taks will call :env task to set up environment.
+

data/bin/lux_assets

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'colorize'
+require 'awesome_print'
+
+require_relative '../lib/lux_assets'
+
+###
+
+module Cli
+  extend self
+
+  def run what
+    puts what.green
+    system what
+  end
+
+  def die text
+    puts text.red
+    exit
+  end
+
+  def info text
+    puts '* %s' % text.magenta
+  end
+end
+
+###
+
+class AssetsCli < Thor
+
+  desc :install, 'Install all needed packages via yarn'
+  def install
+    packages  = ["coffee-script", "minifier", "node-sass", "typescript", "babel-cli", "autoprefixer-cli"]
+
+    if `which yarn`.empty?
+      Cli.die('yarn not found -> install with "npm install yarn -g"')
+    end
+
+    for pkg in packages
+      Cli.run 'yarn add %s' % pkg
+    end
+
+    puts '* Installed: %s' % packages.map(&:green).join(', ')
+
+    unless LuxAssets::CONFIG_PATH.exist?
+      source = Pathname.new(__FILE__).join("../../misc/assets.rb")
+      LuxAssets::CONFIG_PATH.write source.read
+      puts '* Added template %s' % LuxAssets::CONFIG_PATH.to_s.green
+    end
+
+    puts "* To include LuxAssets rake tasks in Rakefile, just require 'lux_assets'".green
+  end
+
+  desc :show, 'Show all files/data in manifest'
+  def show
+    ap LuxAssets.to_h
+  end
+
+  desc :compile, 'Compile assets for production'
+  def compile
+    LuxAssets.compile_all do |name, path|
+      puts "Compile #{name.green} -> #{path}"
+    end
+  end
+
+  desc :clear, 'Clear all caches'
+  def clear
+    Cli.run 'rm -rf ./tmp/assets'
+    Cli.run 'rm -rf ./public/assets'
+    Cli.run 'rm ./public/manifest.json'
+  end
+
+end
+
+AssetsCli.start ARGV

data/lib/lux_assets/asset.rb

@@ -0,0 +1,74 @@
+# Asset group, single asset that produces target css or js
+
+class LuxAssets::Asset
+  PUBLIC_ASSETS = './public/assets'
+
+  def initialize ext, name
+    @ext    = ext == :js ? :js : :css
+    @name   = name
+    @files  = LuxAssets.to_h[ext][name]
+    @target = "#{@ext}/#{@name}"
+  end
+
+  def js?
+    @ext == :js
+  end
+
+  def css?
+    @ext == :css
+  end
+
+  def compile
+    @data = []
+
+    die "No files found for [#{@ext}/#{@name}]" unless @files[0]
+
+    for file in @files
+      if file.is_a?(Proc)
+        @data.push file.call
+      else
+        @data.push LuxAssets::Element.new(file, production: true).compile
+      end
+    end
+
+    send 'compile_%s' % @ext
+
+    @asset_file
+  end
+
+  def files
+    @files
+  end
+
+  ###
+
+  private
+
+  def save_data data
+    @asset_file = '/assets/%s' % (@target.sub('/', '-') + '-' + Digest::SHA1.hexdigest(data) + '.' + @ext.to_s)
+    @asset_path = "./public#{@asset_file}"
+
+    File.write(@asset_path, data)
+
+    if LuxAssets::Manifest.add(@target, @asset_file)
+      yield
+
+      LuxAssets.run 'touch -t 201001010101 %s' % @asset_path
+      LuxAssets.run 'gzip -k %s' % @asset_path
+    end
+  end
+
+  def compile_js
+    save_data @data.join(";\n") do
+      # minify
+      LuxAssets.run './node_modules/minifier/index.js --no-comments -o "%{file}" "%{file}"' % { file: @asset_path }
+    end
+  end
+
+  def compile_css
+    save_data @data.join($/) do
+      #autoprefixer
+      LuxAssets.run './node_modules/.bin/autoprefixer-cli %s' % @asset_path
+    end
+  end
+end

data/lib/lux_assets/base.rb

@@ -0,0 +1,170 @@
+# LuxAssets.configure do
+#   asset :admin do
+#     js do
+#       add 'js/admin/js_vendor/*'
+#       add 'js/admin/js/*'
+#       add 'js/shared/*'
+#       add 'js/admin/index.coffee'
+#     end
+#     css do
+#       add 'css/admin/index.scss'
+#     end
+#   end
+# end
+# ...
+
+# LuxAssets.css('admin').files
+# LuxAssets.css(:admin).compile
+
+# LuxAssets.css(:admin).compile_all do |name, path|
+#   puts "Compile #{name} -> #{path}"
+# end
+
+module LuxAssets
+  extend self
+
+  CONFIG_PATH = Pathname.new ENV.fetch('ASSET_CONFIG') { './config/assets.rb' }
+
+  ASSET_TYPES ||= {
+    js:  ['js', 'coffee', 'ts'],
+    css: ['css', 'scss']
+  }
+
+  @assets  ||= { js: {}, css: {} }
+
+  @relative_root = './app/assets'
+  def relative_root name=nil
+    @relative_root = name if name
+    @relative_root
+  end
+
+  def die text
+    puts text
+    exit
+  end
+
+  def asset name
+    @name = name.to_s
+    yield
+  end
+
+  def configure &block
+    class_eval &block
+  end
+
+  def run what, cache_file=nil
+    puts what.yellow
+
+    stdin, stdout, stderr, wait_thread = Open3.popen3(what)
+
+    error = stderr.gets
+    while line = stderr.gets do
+      error += line
+    end
+
+    # node-sass prints to stderror on complete
+    error = nil if error && error.index('Rendering Complete, saving .css file...')
+
+    if error
+      cache_file.unlink if cache_file && cache_file.exist?
+
+      puts error.red
+    end
+  end
+
+  def js name=nil, &block
+    add_files :js, name, block
+  end
+
+  def css name=nil, &block
+    add_files :css, name, block
+  end
+
+  # adds file or list of files
+  # add 'plugin:js_widgets/*'
+  # add 'js/vendor/*'
+  # add 'index.coffee'
+  # add proc { ... }
+  def add added
+    case added
+    when Array
+      add_local_files added
+      return
+    when Proc
+      @files += [added]
+    else
+      files =
+      if added[0,1] == '/' || added[0,2] == './'
+        added
+      else
+        "#{@relative_root}/#{added}"
+      end
+
+      files =
+      if files.include?('*')
+        files += '/*' if files =~ %r{\/\*\*$}
+        Dir[files].sort
+      else
+        [files]
+      end
+
+      files = files.select { |it| File.file?(it) }
+
+      if files[0]
+        add_local_files files
+      else
+        die 'No files found in "%s -> :%s" (%s)'.red % [@ext, @name, added]
+      end
+    end
+  end
+
+  # get list of files in the resource
+  def files name
+    parts = name.split('/', 2)
+    to_h[parts.first.to_sym][parts[1]]
+  end
+
+  def compile_all
+    for ext in [:js, :css]
+      for name in to_h[ext].keys
+        path = LuxAssets.send(ext, name).compile
+
+        yield "#{ext}/#{name}", path if block_given?
+      end
+    end
+  end
+
+  def to_h
+    unless @assets_loaded
+      die 'Assets file not found in %s' % CONFIG_PATH unless CONFIG_PATH.exist?
+      @assets_loaded = true
+      eval CONFIG_PATH.read
+    end
+
+    @assets
+  end
+
+  private
+
+  def add_local_files files
+    files = files.select { |it| ASSET_TYPES[@ext].include?(it.split('.').last) }
+
+    files = files.select do |f|
+      name = f.split('/').last
+      name.include?('.') && !name[0, 1] != '!'
+    end
+
+    @files += files
+    files
+  end
+
+  def add_files ext, name, block
+    @name = name.to_s if name
+    return Asset.new ext, @name unless block
+
+    @files = []
+    @ext   = ext
+    class_eval &block
+    @assets[ext][@name] = @files
+  end
+end

data/lib/lux_assets/element.rb

@@ -0,0 +1,69 @@
+# One file that can be scss, js, coffee, ts, etc...
+class LuxAssets::Element
+  TMP_ASSETS = './tmp/assets'
+
+  def initialize source, opts={}
+    @source = Pathname.new source
+    @opts   = opts
+    @cache = Pathname.new './tmp/assets/%s' % source.gsub('/','-')
+  end
+
+  def compile
+    method_name = 'compile_%s' % @source.to_s.split('.').last.downcase
+
+    if respond_to?(method_name, true)
+      cached || send(method_name)
+    else
+      @source.read
+    end
+  end
+
+  def content_type
+    @ext ||= @source.to_s.split('.').last.to_sym
+
+    [:css, :scss].include?(@ext) ? 'text/css' : 'text/javascript'
+  end
+
+  ###
+
+  private
+
+  def production?
+    defined?(Rake)
+  end
+
+  def cached
+    @cache.exist? && (@cache.ctime > @source.ctime) ? @cache.read : false
+  end
+
+  def compile_coffee
+    coffee_path = './node_modules/coffee-script/bin/coffee'
+    coffee_opts = production? ? '-cp' : '-Mcp --no-header'
+
+    LuxAssets.run "#{coffee_path} #{coffee_opts} '#{@source}' > '#{@cache}'", @cache
+
+    data = @cache.read
+    data = data.gsub(%r{//#\ssourceURL=[\w\-\.\/]+/app/assets/}, '//# sourceURL=/raw_asset/')
+
+    @cache.write data
+
+    data
+  end
+
+  def compile_scss
+    node_sass = './node_modules/node-sass/bin/node-sass'
+    node_opts = production? ? '--output-style compressed' : '--source-comments'
+    LuxAssets.run "#{node_sass} #{node_opts} '#{@source}' '#{@cache}'", @cache
+    @cache.read
+  end
+  alias :compile_sass :compile_scss
+
+  def compile_js
+    ";\n%s\n;" % @source.read
+  end
+
+  def compile_ts
+    LuxAssets.run "node_modules/typescript/.bin/tsc --outFile '#{@cache}' '#{@source}'"
+  end
+
+end

data/lib/lux_assets/manifest.rb

@@ -0,0 +1,30 @@
+# manifest file
+
+module LuxAssets::Manifest
+  MANIFEST = Pathname.new('./public/manifest.json')
+
+  extend self
+
+  def add name, path
+    json = JSON.load MANIFEST.read
+
+    return false if json['files'][name] == path
+
+    json['files'][name] = path
+
+    MANIFEST.write JSON.pretty_generate(json)
+
+    true
+  end
+
+  def get name
+    json = JSON.load MANIFEST.read
+    json['files'][name]
+  end
+
+  ###
+
+  MANIFEST.write '{"files":{}}' unless MANIFEST.exist?
+end
+
+

data/lib/lux_assets.rb

@@ -0,0 +1,29 @@
+# libs
+require 'digest/sha1'
+require 'json'
+require 'pathname'
+require 'open3'
+
+# gem files
+require_relative './lux_assets/base'
+require_relative './lux_assets/asset'
+require_relative './lux_assets/element'
+require_relative './lux_assets/manifest'
+
+# lux framework bindings
+if defined?(Lux)
+  require_relative './vendor/lux/assets_helper'
+  require_relative './vendor/lux/assets_plugin'
+  require_relative './vendor/lux/assets_routes'
+end
+
+# rake bindings
+if defined?(Rake)
+  require_relative './vendor/tasks.rb'
+end
+
+# create needed dirs unless found
+for dir in ['./tmp/', './tmp/assets', './public', './public/assets']
+  Dir.mkdir(dir) unless Dir.exist?(dir)
+end
+

data/lib/vendor/lux/assets_helper.rb

@@ -0,0 +1,61 @@
+# export to all templates
+# = asset 'www/index.scss'
+# = asset 'www/index.coffee'
+module HtmlHelper
+  def asset_include path, opts={}
+    raise ArgumentError.new("Asset path can't be empty") if path.empty?
+
+    ext  = path.split('?').first.split('.').last
+    type = ['css', 'sass', 'scss'].include?(ext) ? :style : :script
+    type = :style if path.include?('fonts.googleapis.com')
+
+    current.response.early_hints path, type
+
+    if type == :style
+      %[<link rel="stylesheet" href="#{path}" />]
+    else
+      %[<script src="#{path}"></script>]
+    end
+  end
+
+  # builds full asset path based on resource extension
+  # asset('js/main')
+  # will render 'app/assets/js/main/index.coffee' as http://aset.path/assets/main-index-md5hash.js
+  def asset file, opts={}
+    opts = { dev_file: opts } unless opts.class == Hash
+
+    # return joined assets if symbol given
+    # = asset :main -> asset("css/main") + asset("js/main")
+    return [asset("css/#{file}"), asset("js/#{file}")].join($/) if
+      file.is_a?(Symbol)
+
+    # return second link if it is defined and we are in dev mode
+    return asset_include opts[:dev_file] if opts[:dev_file] && Lux.config(:compile_assets)
+
+    # return internet links
+    return asset_include file if file.starts_with?('/') || file.starts_with?('http')
+
+    # return asset link in production or fail unless able
+    unless Lux.config(:compile_assets)
+      manifest = Lux.ram_cache('asset-manifest') { JSON.load Lux.root.join('public/manifest.json').read }
+      mfile    = manifest['files'][file]
+
+      raise 'Compiled asset link for "%s" not found in manifest.json' % file if mfile.empty?
+
+      return asset_include(Lux.config.assets_root.to_s + mfile, opts)
+    end
+
+    # try to create list of incuded files and show every one of them
+    data = LuxAssets.files(file).inject([]) do |total, asset|
+      if asset.is_a?(Proc)
+        tag_name = file.include?('css') ? :style : :script
+        total.push({}.tag tag_name, asset.call)
+      else
+        total.push asset_include '/compiled_asset/' + asset
+      end
+    end
+
+    data.map{ |it| it.sub(/^\s\s/,'') }.join("\n")
+  end
+
+end

data/lib/vendor/lux/assets_plugin.rb

@@ -0,0 +1,13 @@
+module LuxAssets
+
+  # include files from a plugin
+  def plugin name
+    # load pluigin if needed
+    Lux.plugin name
+
+    plugin = Lux.plugin.get name
+    add '%s/**' % plugin[:folder]
+  end
+
+end
+

data/lib/vendor/lux/assets_routes.rb

@@ -0,0 +1,34 @@
+# /compiled_asset/www/js/pjax.coffee
+# /raw_asset/www/js/pjax.coffee
+Lux.app.before do
+  # skip /favicon.ico that forces refresh
+  next unless nav.path[1]
+  next unless Lux.config(:compile_assets)
+
+  # only allow clear in dev
+  # clear assets every 4 seconds max
+  if Lux.current.no_cache?
+    Lux.cache.fetch('lux-clear-assets', ttl: 4, log: false, force: false) do
+      puts '* Clearing assets from ./tmp/assets'.yellow
+      `rm -rf ./tmp/assets && mkdir ./tmp/assets`
+      true
+    end
+  end
+
+  case nav.root
+  when 'compiled_asset'
+    path = nav.reset.drop(1).join('/')
+
+    asset = LuxAssets::Element.new path
+    current.response.content_type asset.content_type
+    current.response.body asset.compile
+
+  when 'raw_asset'
+    path = nav.reset.drop(1).join('/')
+
+    Lux.error "You can watch raw files only in development" unless Lux.dev?
+
+    file = Pathname.new path
+    body file.exist? ? file.read : "error: File not found"
+  end
+end

data/lib/vendor/tasks.rb

@@ -0,0 +1,36 @@
+require 'colorize'
+
+$lux_assets_bin ||= proc do |command|
+  bin     = Pathname.new(__dir__).join('../../bin/lux_assets').to_s
+  system '%s %s' % [bin, command]
+end
+
+namespace :assets do
+  desc 'Clear all assets'
+  task :clear do
+    $lux_assets_bin.call :clear
+  end
+
+  desc 'Install all needed packages via yarn'
+  task :install do
+    $lux_assets_bin.call :install
+  end
+
+  desc 'Compile assets to public/assets and generate mainifest.json'
+  task compile: :env do
+    LuxAssets.compile_all do |name, path|
+      puts "Compile #{name.green} -> #{path}"
+    end
+  end
+
+  desc 'Show all files/data in manifest'
+  task show: :env do
+    ap LuxAssets.to_h
+  end
+
+  desc 'Upload assets to S3'
+  task :s3_upload do
+    puts 'aws s3 sync ./public s3://bucket.location --cache-control "max-age=31536000, public"'
+  end
+end
+

data/misc/assets.rb

@@ -0,0 +1,25 @@
+# relative_root './app/assets' # default root for relative assets
+
+asset :admin do
+  js do
+    # add 'js/admin/js_vendor/*'
+    # add '/Used/foo/app/bar/asssets/admin.js'
+    # add ['list', 'of', 'files']
+    # add proc { 'js string' }
+  end
+
+  css do
+    # add 'css/admin/index.scss'
+    # add proc { 'css string' }
+  end
+end
+
+asset :main do
+  js do
+
+  end
+
+  css do
+
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: lux_assets
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Dino Reic
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+description: Web assets packer, convenience over configuration, simplified webpack
+  or sprockets with cleaner configuration
+email: rejotl@gmail.com
+executables:
+- lux_assets
+extensions: []
+extra_rdoc_files: []
+files:
+- "./README.md"
+- "./bin/lux_assets"
+- "./lib/lux_assets.rb"
+- "./lib/lux_assets/asset.rb"
+- "./lib/lux_assets/base.rb"
+- "./lib/lux_assets/element.rb"
+- "./lib/lux_assets/manifest.rb"
+- "./lib/vendor/lux/assets_helper.rb"
+- "./lib/vendor/lux/assets_plugin.rb"
+- "./lib/vendor/lux/assets_routes.rb"
+- "./lib/vendor/tasks.rb"
+- "./misc/assets.rb"
+- bin/lux_assets
+homepage: https://github.com/dux/lux_assets
+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.7.5
+signing_key: 
+specification_version: 4
+summary: Web assets
+test_files: []