bower-vendor 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version

data/.ruby-gemset

@@ -0,0 +1 @@
+bower-vendor

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Fern
+
+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,181 @@
+# BowerVendor
+
+Vendor the bower assets you want for Ruby on Rails.  Inspired by [bower-installer](https://github.com/blittle/bower-installer).
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'bower-vendor'
+```
+
+And then execute:
+
+```shell
+bundle
+rails generate bower_vendor:configure
+```
+
+## Usage
+
+Add bower packages to the `bower.json` file in your Rails root as normal, then
+execute:
+
+```shell
+rails generate bower_vendor:install
+```
+
+To automatically vendor files specified by the bower package's `main` attribute
+to the appropriate vendor directory.
+
+Files are vendored based on file extension under:
+
+`vendor/assets/(javascripts|stylesheets|images|media)/[package-name]`
+
+Currently supported file extensions are:
+* `javascripts`: `.js` `.coffee`
+* `stylesheets`: `.css` `.scss` `.sass` `.less`
+* `images`: `.gif` `.png` `.jpg` `.svg`
+* `media`: `.\*` (everything else)
+
+The following generators are available:
+
+### Available Generators
+
+`rails generate bower_vendor:install [options]`
+
+    Options:
+      [--update]           # Update bower assets (ie - `bower update`)
+      [--skip-git-ignore]  # Add vendored bower asset package directories to .gitignore
+      [--force-clean]      # Clean vendored bower assets without prompting
+      [--skip-clean]       # Skip cleaning vendored bower assets
+     
+    Runtime options:
+      -f, [--force]    # Overwrite files that already exist
+      -p, [--pretend]  # Run but do not make any changes
+      -q, [--quiet]    # Suppress status output
+      -s, [--skip]     # Skip files that already exist
+     
+    Vendor bower assets based on bower.json
+
+
+`rails generate bower_vendor:clean [options]`
+
+    Options:
+      [--force]  # Delete vendored bower assets without prompting
+     
+    Runtime options:
+      -p, [--pretend]  # Run but do not make any changes
+      -q, [--quiet]    # Suppress status output
+      -s, [--skip]     # Skip files that already exist
+     
+    Cleans bower assets (CAUTION: Vendored asset directories for all bower packages will be deleted!)
+
+### Configuring installed assets
+
+Take the following example bower package:
+
+```json
+{
+  "name": "widgets",
+  "repo": "pdf/widgets",
+  "description": "Now with more widgets!",
+  "version": "0.0.1",
+  "main": [
+    "build/dir/js/widgets.js",
+    "build/dir/css/widgets.css",
+  ]
+}
+```
+
+Let's add `widgets` to our application's `bower.json`, like so:
+
+```json
+{
+  "dependencies": {
+    "widgets": "~0.0.1"
+  }
+}
+```
+
+This is a contrived example, but it exists in the real world - if we were to
+install this using bower directly, we'd end up with some pretty ugly paths to
+reference in our application.  It might look something like this:
+
+    components/widgets/build/dir/js/widgets.js
+    components/widgets/build/dir/js/widgets-super.js
+    components/widgets/build/dir/css/widgets.css
+    components/widgets/src/cruft/widgets.coffee
+    components/widgets/src/widgets.scss
+    components/widgets/.ilikedonuts
+
+However, if we instead vendor the bower package by executing
+`rails g bower_vendor:install`, we end up with just the following files added
+to our project space:
+
+    vendor/assets/javascripts/widgets/widgets.js
+    vendor/assets/stylesheets/widgets/widgets.css
+
+Much nicer.
+
+### Advanced bower.json
+(Hat-tip to [bower-installer](https://github.com/blittle/bower-installer) for the inspiration)
+
+If the bower package's `main` attribute does not include all the files you want
+to vendor (or files you want to omit from vendoring), you can override the
+vendored files using a `sources` attribute with a key of the package name,
+containing an array of source files to install, like so:
+
+```json
+{
+  "dependencies": {
+    "widgets": "~0.0.1"
+  },
+  "sources": {
+    "widgets": [
+      "build/dir/js/widgets.js",
+      "build/dir/js/widgets-super.js",
+      "build/dir/css/widgets.css"
+    ]
+  }
+}
+```
+
+Which will result in the following files being vendored:
+
+    vendor/assets/javascripts/widgets/widgets.js
+    vendor/assets/javascripts/widgets/widgets-super.js
+    vendor/assets/stylesheets/widgets/widgets.css
+
+You can also override the destination path/filename, by using a hash of source
+paths to destinations instead of an array, like so:
+
+```json
+{
+  "dependencies": {
+    "widgets": "~0.0.1"
+  },
+  "sources": {
+    "widgets": {
+      "build/dir/js/widgets.js": "widgets.js",
+      "build/dir/js/widgets-super.js": "super/widgets-super.js",
+      "build/dir/css/widgets.css": "my_widgets.css"
+    }
+  }
+}
+```
+
+Resulting in the following:
+
+    vendor/assets/javascripts/widgets/widgets.js
+    vendor/assets/javascripts/widgets/super/widgets-super.js
+    vendor/assets/stylesheets/widgets/my_widgets.css
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bower-vendor.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bower-vendor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "bower-vendor"
+  gem.version       = BowerVendor::VERSION
+  gem.authors       = ["Peter Fern"]
+  gem.email         = ["ruby@obfusc8.org"]
+  gem.description   = %q{Vendor the bower assets you want for Ruby on Rails}
+  gem.summary       = %q{Vendor the bower assets you want for Ruby on Rails}
+  gem.homepage      = "http://github.com/pdf/bower-vendor"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = '>= 1.9.2'
+
+  gem.add_dependency('ruby-bower', '~> 0.0.1')
+  gem.add_dependency('rails', '>= 3.1.0')
+end

data/lib/bower-vendor/bower_root.rb

@@ -0,0 +1,3 @@
+module BowerVendor
+  BOWER_ROOT = File.join('tmp','bower_components')
+end

data/lib/bower-vendor/railtie.rb

@@ -0,0 +1,5 @@
+require 'bower-vendor'
+require 'rails'
+class BowerVendor::Railtie < Rails::Railtie
+  railtie_name :bower_vendor
+end

data/lib/bower-vendor/utils.rb

@@ -0,0 +1,32 @@
+require 'ruby-bower'
+require 'json'
+
+class BowerVendor::Utils
+  attr_accessor :bower_paths, :bower_json
+
+  def initialize
+    bower = Bower.new
+    @bower_json = ::JSON.load(File.read('bower.json'))
+    begin
+      @bower_paths = bower.list(paths: true)
+    rescue ::ExecJS::ProgramError => e
+      err = 'failed to retrieve installed bowser components'
+      err << ': ' << e.to_s if e.to_s
+      raise RuntimeError, err
+    end
+  end
+
+  def prefixed_path(package, prefix, path)
+    File.join('vendor', 'assets', prefix, package, path)
+  end
+
+  def merged_paths
+    if bower_json.has_key? 'sources'
+      bower_json['sources'].each do |package, paths|
+        bower_paths[package] = paths
+      end
+    end
+    bower_paths
+  end
+
+end

data/lib/bower-vendor/version.rb

@@ -0,0 +1,3 @@
+module BowerVendor
+  VERSION = "0.0.1"
+end

data/lib/bower-vendor.rb

@@ -0,0 +1,4 @@
+require 'bower-vendor/version'
+require 'bower-vendor/bower_root'
+require 'bower-vendor/utils'
+require 'bower-vendor/railtie'

data/lib/generators/bower_vendor/clean_generator.rb

@@ -0,0 +1,19 @@
+class BowerVendor::CleanGenerator < Rails::Generators::Base
+  attr_accessor :utils
+
+  class_option :force, type: :boolean, desc: 'Delete vendored bower assets without prompting'
+  desc 'Cleans bower assets (CAUTION: Vendored asset directories for all bower packages will be deleted!)'
+  def clean_packages
+    @utils = BowerVendor::Utils.new
+    utils.merged_paths.keys.each do |package|
+      %w[javascripts stylesheets images].each do |prefix|
+        path = File.join('vendor', 'assets', prefix, package)
+        if Dir.exist? path
+          if options.force? or yes?("Remove #{path}?", :cyan)
+            remove_dir(path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/bower_vendor/configure_generator.rb

@@ -0,0 +1,11 @@
+class BowerVendor::ConfigureGenerator < Rails::Generators::Base
+  desc 'Creates/updates .bowerrc for use with bower-vendor'
+  def configure_bower
+    if File.exist? '.bowerrc'
+      gsub_file '.bowerrc', /"directory":\s*"[^"]*"\s*,/, "\"directory\": \"#{BowerVendor::BOWER_ROOT}\""
+    end
+    create_file '.bowerrc', {directory: BowerVendor::BOWER_ROOT}.to_json
+
+    append_file '.gitignore', "\n# Temporary bower components\n/tmp/bower_components\n"
+  end
+end

data/lib/generators/bower_vendor/install_generator.rb

@@ -0,0 +1,65 @@
+class BowerVendor::InstallGenerator < Rails::Generators::Base
+  source_root Rails.root
+
+  attr_accessor :utils
+
+  class_option :update, type: :boolean, desc: 'Update bower assets (ie - `bower update`)'
+  class_option :skip_git_ignore, type: :boolean, desc: 'Add vendored bower asset package directories to .gitignore'
+  class_option :force_clean, type: :boolean, desc: 'Clean vendored bower assets without prompting'
+  class_option :skip_clean, type: :boolean, desc: 'Skip cleaning vendored bower assets'
+  class_option :include_dev_dependencies, type: :boolean, default: false, desc: 'Include bower devDependencies'
+  desc 'Vendor bower assets based on bower.json'
+  def bower_install
+    if !options.skip_clean? and Dir.exist? BowerVendor::BOWER_ROOT
+      generate options.force_clean? ? 'bower_vendor:clean --force' : 'bower_vendor:clean'
+    end
+
+    action = options.update? ? 'update' : 'install'
+    action << ' --production' unless options.include_dev_dependencies?
+    say_status :run, "bower #{action}"
+    `bower #{action}`
+
+    @utils = BowerVendor::Utils.new
+
+    utils.merged_paths.each do |package, paths|
+      append_file '.gitignore', "\n# Vendored bower package '#{package}'\n" unless options.skip_git_ignore?
+      case paths
+      when Hash
+        paths.each do |source, dest|
+          vendor_asset(package, File.join(BowerVendor::BOWER_ROOT, package, source), dest)
+        end
+      when Array
+        paths.each do |source|
+          vendor_asset(package, File.join(BowerVendor::BOWER_ROOT, package, source))
+        end
+      when String
+        vendor_asset(package, paths)
+      else
+        raise ArgumentError, "Paths must be either Hash, Array or String, received: #{paths.class}"
+      end
+    end
+  end
+
+  private
+  def vendor_asset(package, source, dest=nil)
+    file_ext = File.extname(source)
+    case file_ext
+    when '.js', '.coffee'
+      prefix = 'javascripts'
+    when '.css', '.scss', '.sass', '.less'
+      prefix = 'stylesheets'
+    when '.gif', '.png', '.jpg', '.svg'
+      prefix = 'images'
+    else
+      prefix = 'media'
+    end
+
+    if dest
+      dest = utils.prefixed_path(package, prefix, dest)
+    else
+      dest = utils.prefixed_path(package, prefix, File.basename(source))
+    end
+    append_file '.gitignore', "/#{File.join('vendor', 'assets', prefix, package)}\n" unless options.skip_git_ignore?
+    copy_file(source, dest)
+  end
+end

data/lib/tasks/bower_vendor.rake

@@ -0,0 +1,19 @@
+require 'json'
+namespace :bower do
+  desc 'vendor bower assets'
+  task :vendor do
+    sh 'bower install'
+    BowerVendor::Utils.new().deploy_assets
+  end
+
+  desc 'update bower assets'
+  task :update do
+    sh 'bower update'
+    BowerVendor::Utils.new().deploy_assets
+  end
+
+  desc 'clean bower assets'
+  task :clean do
+    BowerVendor::Utils.new().clean_packages
+  end
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: bower-vendor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Fern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-bower
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Vendor the bower assets you want for Ruby on Rails
+email:
+- ruby@obfusc8.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bower-vendor.gemspec
+- lib/bower-vendor.rb
+- lib/bower-vendor/bower_root.rb
+- lib/bower-vendor/railtie.rb
+- lib/bower-vendor/utils.rb
+- lib/bower-vendor/version.rb
+- lib/generators/bower_vendor/clean_generator.rb
+- lib/generators/bower_vendor/configure_generator.rb
+- lib/generators/bower_vendor/install_generator.rb
+- lib/tasks/bower_vendor.rake
+homepage: http://github.com/pdf/bower-vendor
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Vendor the bower assets you want for Ruby on Rails
+test_files: []
+has_rdoc: