bower_vendor 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 061b206ea3ca93d61e5d78b5f8def7df7a269c6c
-  data.tar.gz: 5552fa9185b5fc7f24e833da840686f7f26922c0
+  metadata.gz: 762474c4e7c499fcf2909f643ee0ec6e799e69fc
+  data.tar.gz: 201cf15a263a2dfe38206305ca8f2665fadb0386
 SHA512:
-  metadata.gz: 7f6864277758c9ad6e1a418b2e188d78f509f2da5a5a4d074f67d4a35da4944a377a2715345d889240bae5c3ee63cdf668f5ad185826a937f0a0faa261c1213c
-  data.tar.gz: f8a1411f71ad7d39ab1c0d67ac63c64774ff30a1f15e8a5558fffdfbecd6178ffe34d462a75b31fbed382d3a6ee9d9b32a435b2887b0c9b40aa3e3d5183720c5
+  metadata.gz: d894aceae7ae02bdb74d920b773dd6b53b9c524c6b748403a60bf188534e0867b198e702b4ee369d8c7a5b9cbb0b865d57111edf5705ab277e769115d7e9b436
+  data.tar.gz: c942e7408a84f3d9d206d59abbcb271670e130bc2d07f34d27d7f0123c9cb9999989264a41b5012699d6d87275cc7db092c0ca7594da07b572e2590346362fff

data/README.md

@@ -1,8 +1,24 @@
 # BowerVendor
 
-Rake tasks to manage vendor assets for rails application
+Simple rake tasks to manage vendor assets for rails application
 using bower. This gem is inspired by bower-rails.
 
+Reason for the existence of this gem is to have improved assets control, which is lacking
+in bower-rails. This gem not only fetches assets using bower, but also contains logic to
+maintain actually used assets in "vendor/asests" so that they can be committed safely into
+repository.
+
+This has various benefits
+- Removes bower dependency from deploy
+  * Safe-guarding deplpy from unavailability of bower central repository
+  * Faster deploy
+  * no need to have node/bower/etc. installed in deployed machine
+- Versioned assets, allowing safer upgrading of them (and safe rollback to old versions)
+  * This allows that not all parts of the application (or engines) are requierd to be upgraded
+    to latest vendor asset versions at once
+- Assets are available always
+  * Just clone repository and it's ready to use
+
 # Install
 
 Gemfile
@@ -16,16 +32,53 @@ gem 'bower_vendor'
 
 vendor.yml
 ```ruby
+jquery:
+  version: 2.1.3
+  assets:
+  - dist/jquery.js
+jquery-ujs:
+  version: 1.0.3
+  assets:
+  - src/rails.js
+lodash:
+  version: 3.0.0
+  assets:
+  - lodash.js
 angular:
   version: 1.3.15
-  files:
+  assets:
   - angular.js
+bootstrap-sass:
+  version: 3.3.4
+  assets:
+  - assets/javascripts/bootstrap-sprockets.js
+  # copy into "bootstrap" subdir in destination
+  - bootstrap:
+    - assets/javascripts/*.js
+  - assets/stylesheets/_bootstrap.scss
+  - assets/stylesheets/_bootstrap-sprockets.scss
+  - bootstrap:
+    - assets/stylesheets/bootstrap/*.scss
+      # copy into "bootstrap/mixins" subdir in destination
+    - mixins:
+      - assets/stylesheets/bootstrap/mixins/*.scss
+  # "*" matches all files
+  - assets/fonts/bootstrap/*
 ```
 
 2) Install assets
 
 ```bash
+bundle exec rake vendor:clean
 bundle exec rake vendor:all
 ```
 
 Assets will be copied into vendor/assets
+
+
+# TODO
+
+- Support other more asset types
+  * curently only js and css are supported
+  * should support also fonts, etc.
+- Support more complex paths for assets

data/config/bower_vendor.yml

@@ -0,0 +1,20 @@
+---
+base_dir: vendor/assets
+dst_dirs:
+  # javascripts
+  js: javascripts
+  es6: javascripts
+  next: javascripts
+  # stylesheets
+  css: stylesheets
+  scss: stylesheets
+  # fonts
+  eot: fonts
+  ttf: fonts
+  woff: fonts
+  woff2: fonts
+  # images
+  jpg: images
+  jpeg: images
+  png: images
+  svg: images

data/lib/bower_vendor.rb

@@ -4,6 +4,7 @@ require 'json'
 
 require "bower_vendor/version"
 require "bower_vendor/base"
+require "bower_vendor/clean"
 require "bower_vendor/copy"
 require "bower_vendor/fetch"
 require "bower_vendor/setup"
@@ -19,6 +20,6 @@ module BowerVendor
 
   def self.load_tasks
     dir = File.join(root_dir, 'lib/tasks')
-    load "#{dir}/vendor.rake"
+    load "#{dir}/bower_vendor.rake"
   end
 end

data/lib/bower_vendor/base.rb

@@ -8,14 +8,16 @@ module BowerVendor
     end
 
     def config
-#      @config ||= YAML.load_file('vendor_config.yml')
-      @config ||= {
-        base_dir: 'vendor/assets',
-        dst_dirs: {
-          'css' => 'stylesheets',
-          'js' => 'javascripts',
-        }
-      }
+      @config ||= load_config('config/bower_vendor.yml')
+      @config ||= load_config(File.join(BowerVendor.root_dir, 'config/bower_vendor.yml'))
+    end
+
+    def load_config(file)
+      if File.exist?(file)
+        YAML.load_file(file)
+      else
+        nil
+      end
     end
 
     def base_src_dir

data/lib/bower_vendor/clean.rb

@@ -0,0 +1,11 @@
+module BowerVendor
+  class Clean < Base
+    def initialize
+    end
+
+    def execute
+      FileUtils.rm_rf "#{work_dir}/bower_components"
+      FileUtils.rm_f "#{work_dir}/bower.json"
+    end
+  end
+end

data/lib/bower_vendor/copy.rb

@@ -5,20 +5,20 @@ module BowerVendor
 
       vendors.each do |asset_key, asset_data|
         src_dir = "#{base_src_dir}/#{asset_key}"
-        puts "processing: #{src_dir}"
+        msg 0, "processing: #{src_dir}"
 
-        run_scripts(asset_key, asset_data)
-        copy_files(asset_key, asset_data)
+        run_scripts(asset_key, asset_data, 1)
+        copy_assets(asset_key, asset_data, 1)
       end
     end
 
-    def run_scripts(asset_key, asset_data)
+    def run_scripts(asset_key, asset_data, level)
       scripts = (asset_data['build'] || [])
       if !scripts.empty?
-        puts "  building..."
+        msg level, "building..."
         scripts.each do |cmd|
           full_cmd ="cd #{src_dir} && #{cmd}"
-          puts "    #{full_cmd}"
+          msg level + 1, full_cmd
           pid = fork do
             exec full_cmd
           end
@@ -27,47 +27,70 @@ module BowerVendor
       end
     end
 
-    def copy_files(asset_key, asset_data)
-      puts "  copying..."
-      version = asset_data['version']
-      asset_data['files'].each do |orig_path|
-        src_path = orig_path.gsub("{{VERSION}}", version)
-        has_version = orig_path != src_path
-        src_file = src_path.split('/').last
-        ext = src_file.split('.').last
-        dst_file = src_file
-        unless has_version
-#          dst_file = src_file.gsub("\.#{ext}", "-#{version}.#{ext}")
-        end
+    def copy_assets(asset_key, asset_data, level)
+      msg level, "copying: #{asset_key}..."
+      copy_asset(asset_key, asset_data, asset_data['assets'], '', level + 1)
+    end
 
-        src_dir = "#{work_dir}/bower_components/#{asset_key}"
+    def copy_asset(asset_key, asset_data, assets, target_path = '', level)
+      assets.each do |asset|
+        if asset.is_a? Hash
+          sub_asset = asset.keys.first
+          sub_target_path = target_path.empty? ? sub_asset : target_path + '/' + sub_asset
+          copy_asset(asset_key, asset_data, asset[sub_asset], sub_target_path, level + 1)
+        else
+          msg level, asset
 
-        base_dst_dir = dst_dirs[ext]
-        dst_dir = "#{base_dst_dir}/#{asset_key}-#{version}"
+          version = asset_data['version']
+          src_path = asset.gsub("{{VERSION}}", version)
 
-        full_src_file = "#{src_dir}/#{src_path}"
-        full_dst_file = "#{dst_dir}/#{dst_file}"
+          base_src_dir = "#{work_dir}/bower_components"
+          src = "#{base_src_dir}/#{asset_key}/#{src_path}"
 
-        puts "    #{full_src_file} => #{full_dst_file}"
-        if !File.exist? full_src_file
-          raise "NOT_FOUND: #{full_src_file}"
-        end
-        if !Dir.exist? dst_dir
-          FileUtils.mkdir_p dst_dir
+          Dir[src].sort!.each do |src_path|
+            copy_src_file asset_key, asset_data, asset, src_path, target_path, level + 1
+          end
         end
-        FileUtils.cp full_src_file, full_dst_file
       end
     end
 
+    def copy_src_file(asset_key, asset_data, orig_path, full_src_file, target_path, level)
+      if !File.exist? full_src_file
+        raise "NOT_FOUND: #{full_src_file}"
+      end
+
+      version = asset_data['version']
+      src_file = full_src_file.split('/').last
+      ext = src_file.split('.').last
+      dst_file = src_file
+
+      base_dst_dir = dst_dirs[ext]
+      raise "NOT_FOUND_EXT: #{ext}" unless base_dst_dir
+
+      dst_dir = "#{base_dst_dir}/#{asset_key}-#{version}"
+      dst_dir = "#{dst_dir}/#{target_path}" unless target_path.empty?
+      full_dst_file = "#{dst_dir}/#{dst_file}"
+
+      msg level, "#{full_src_file} => #{full_dst_file}"
+      if !Dir.exist? dst_dir
+        FileUtils.mkdir_p dst_dir
+      end
+      FileUtils.cp full_src_file, full_dst_file
+    end
+
     def dst_dirs
       @dst_dirs ||= setup_dst_dirs
     end
 
     def setup_dst_dirs
-      base_dir = config[:base_dir]
-      config[:dst_dirs].map do |k, v|
+      base_dir = config['base_dir']
+      config['dst_dirs'].map do |k, v|
         [k, "#{base_dir}/#{v}"]
       end.to_h
     end
+
+    def msg(level, msg)
+      puts "#{'  ' * level}#{msg}"
+    end
   end
 end

data/lib/bower_vendor/version.rb

@@ -1,3 +1,3 @@
 module BowerVendor
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/tasks/{vendor.rake → bower_vendor.rake}

@@ -1,5 +1,5 @@
 namespace :vendor do
-  desc 'Do all'
+  desc 'Do everything except clean'
   task :all => [:setup, :fetch, :copy] do
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bower_vendor
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - kari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -81,15 +81,17 @@ files:
 - README.md
 - Rakefile
 - bower_vendor.gemspec
+- config/bower_vendor.yml
 - lib/bower_vendor.rb
 - lib/bower_vendor/base.rb
+- lib/bower_vendor/clean.rb
 - lib/bower_vendor/copy.rb
 - lib/bower_vendor/fetch.rb
 - lib/bower_vendor/railtie.rb
 - lib/bower_vendor/setup.rb
 - lib/bower_vendor/version.rb
+- lib/tasks/bower_vendor.rake
 - lib/tasks/console.rake
-- lib/tasks/vendor.rake
 homepage: https://github.com/kikonen/bower_vendor
 licenses:
 - MIT