bower-rails 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05faebea58423491bfd583dab2eca0b0ba062724
-  data.tar.gz: e63b4071d055ccd6b8c68898311c3fa794a02871
+  metadata.gz: 6006f079a66a16246b1b202c5937c34c2a10f604
+  data.tar.gz: ff977ce0ecd9914b0da8d17035654a3cf68dd82c
 SHA512:
-  metadata.gz: 8683a3796762962d9d43030c2af460440b7cc25c45f6ef9b1f380797ba295878975346d6d076e6900d3a44737d2312e92f512e0ed774333057f25585100a0239
-  data.tar.gz: dece1f7c79ce74a344d30a56d1dd2b1e6e17336e20b07a0b69c6543f4da1e9a57051f39de3b04a2694f79b89cb0cc1040ba72cedbf6805e10ce23f631ebb5f8f
+  metadata.gz: 9b0caababbe66adb75d1978c4c2dbb38dd351d48da41fb1a441a273ce1ee3ce157addcc0e780cb3990f44f5e5891c2f1f024f666fbc2aff33b42734fde4263b0
+  data.tar.gz: 32912bcc0c5b3c9650446a7751c137d9b9e02ec179ba1853a9ed5b17a6c2004808a6c13216640d0249ee6c61bd887889da606a4c5ef29b2a570273fdb9d67796

data/README.md

@@ -1,11 +1,10 @@
-bower-rails
-===========
+# bower-rails
 
-[![Gem Version](http://img.shields.io/gem/v/bower-rails.svg)][gem]
-[![Code Climate](http://img.shields.io/codeclimate/github/42dev/bower-rails.svg)][codeclimate]
-[![Dependency Status](http://img.shields.io/gemnasium/SergeyKishenin/bower-rails.svg)][gemnasium]
+[![Gem Version](https://badge.fury.io/rb/bower-rails.svg)](http://badge.fury.io/rb/bower-rails)
+[![Code Climate](https://codeclimate.com/github/rharriso/bower-rails/badges/gpa.svg)](https://codeclimate.com/github/rharriso/bower-rails)
+[![Dependency Status](https://img.shields.io/gemnasium/SergeyKishenin/bower-rails.svg)][gemnasium]
 [![Build Status](https://travis-ci.org/rharriso/bower-rails.svg?branch=master)][travis]
-[![Coverage Status](https://coveralls.io/repos/42dev/bower-rails/badge.png)][coveralls]
+[![Coverage Status](https://coveralls.io/repos/rharriso/bower-rails/badge.svg?branch=master&service=github)](https://coveralls.io/github/rharriso/bower-rails?branch=master)
 
 [gem]: https://rubygems.org/gems/bower-rails
 [travis]: https://travis-ci.org/rharriso/bower-rails
@@ -29,17 +28,17 @@ NOTE: If you install `node` via package manager with `sudo apt-get install nodej
 
 in Gemfile
 
-``` Ruby
+```ruby
   gem "bower-rails", "~> 0.10.0"
 ```
 
-##JSON configuration
+## JSON configuration
 
-Bower-rails now supports the standard [bower package](https://github.com/bower/bower#defining-a-package) format out-of-the-box. Simply place your bower.json file the Rails root directory to start. Using the standard format will default all bower components to be installed under the `vendor` directory.
+Bower-rails now supports the standard [bower package](http://bower.io/docs/creating-packages/#specification) format out-of-the-box. Simply place your bower.json file the Rails root directory to start. Using the standard format will default all bower components to be installed under the `vendor` directory.
 
 To install dependencies into both `lib` and `vendor` directories, run the initializer to generate a custom bower.json:
 
-``` Bash
+```bash
   rails g bower_rails:initialize json
 ```
 
@@ -47,31 +46,40 @@ This will generate a `config/initializers/bower_rails.rb` config file and a spec
 
 **example bower.json file**
 
-``` javascript
+```json
 {
    "lib": {
     "name": "bower-rails generated lib assets",
     "dependencies": {
-      "threex"      : "git@github.com:rharriso/threex.git",
-      "gsvpano.js"  : "https://github.com/rharriso/GSVPano.js/blob/master/src/GSVPano.js"
+      "threex": "git@github.com:rharriso/threex.git",
+      "gsvpano.js": "https://github.com/rharriso/GSVPano.js/blob/master/src/GSVPano.js"
     }
   },
   "vendor": {
     "name": "bower-rails generated vendor assets",
     "dependencies": {
-      "three.js"    : "https://raw.github.com/mrdoob/three.js/master/build/three.js"
+      "three.js": "https://raw.github.com/mrdoob/three.js/master/build/three.js"
     }
   }
 }
 ```
 
-##Ruby DSL configuration
+## Include in Asset Pipeline
+
+```javascript
+// Bower packages
+//= require d3/d3
+//= require underscore/underscore
+//
+```
+
+## Ruby DSL configuration
 
 The Ruby DSL configuration is a Bowerfile at the project's root with DSL syntax similar to Bundler.
 
 Run the initializer to generate a sample Bowerfile inside the Rails root and a `config/initializers/bower_rails.rb` config file:
 
-``` Bash
+```bash
   rails g bower_rails:initialize
 ```
 
@@ -79,7 +87,7 @@ Run the initializer to generate a sample Bowerfile inside the Rails root and a `
 
 By default assets are put to `./vendor/assets/bower_components` directory:
 
-``` ruby
+```ruby
 
 # Puts to ./vendor/assets/bower_components
 asset "backbone"
@@ -101,7 +109,7 @@ asset "three.js", "https://raw.github.com/mrdoob/three.js/master/build/three.js"
 
 But the default value can be overridden by `assets_path` method:
 
-``` ruby
+```ruby
 assets_path "assets/my_javascripts"
 
 # Puts to ./vendor/assets/my_javascripts/bower_components
@@ -111,7 +119,7 @@ asset "moment"
 
 The `assets_path` method can be overridden by an option in a `group` call:
 
-``` ruby
+```ruby
 assets_path "assets/javascript"
 
 # Puts files under ./vendor/assets/js/bower_components
@@ -129,10 +137,10 @@ end
 NOTE: Available groups are `:lib` and `:vendor`. Others are not allowed according to the Rails convention.
 NOTE: All the assets should be stored in `/assets` subdirectory so putting it under `./vendor/js` directory is unavailable
 
-You can extend `main` directive to include some missing files using `main_files` 
+You can extend `main` directive to include some missing files using `main_files`
 option as parameter or in a block:
 
-``` ruby
+```ruby
 # via argument
 asset "moment", "2.10.1", main_files: ["./locale/en-gb.js"]
 
@@ -148,7 +156,7 @@ end
 
 And finally, you can specify the assets to be in the devDependencies block:
 
-``` ruby
+```ruby
 asset "backbone", "1.1.1"
 
 # Adds jasmine-sinon and jasmine-matchers to devDependencies
@@ -164,11 +172,11 @@ end
 ```
 results in the following bower.json file:
 
-```
+```json
 {
-  "name": "dsl-generated dependencies",
+  "name": "dsl-generated-dependencies",
   "dependencies": {
-    "backbone": "1.1.1"
+    "backbone": "1.1.1",
     "angular": "1.2.18",
   },
   "devDependencies": {
@@ -189,11 +197,11 @@ resolution "angular", "1.2.22"
 
 That will produce `bower.json` like:
 
-``` javascript
+```json
 {
-  "name" : "dsl-generated dependencies",
-  "dependencies" : {
-    "angular" : "1.2.22"
+  "name" : "dsl-generated-dependencies",
+  "dependencies": {
+    "angular": "1.2.22"
   },
   "resolutions": {
     "angular": "1.2.22"
@@ -207,7 +215,7 @@ That will produce `bower.json` like:
 
 Change options in your `config/initializers/bower_rails.rb`:
 
-``` ruby
+```ruby
 BowerRails.configure do |bower_rails|
   # Tell bower-rails what path should be considered as root. Defaults to Dir.pwd
   bower_rails.root_path = Dir.pwd
@@ -221,11 +229,21 @@ BowerRails.configure do |bower_rails|
   # Invokes rake bower:clean before precompilation. Defaults to false
   bower_rails.clean_before_precompile = true
 
-  # Invokes rake bower:install:deployment instead rake bower:install. Defaults to false
+  # Excludes specific bower components from clean. Defaults to nil
+  bower_rails.exclude_from_clean = ['moment']
+
+  # Invokes rake bower:install:deployment instead of rake bower:install. Defaults to false
   bower_rails.use_bower_install_deployment = true
 
+  # rake bower:install will search for gem dependencies and in each gem it will search for Bowerfile
+  # and then concatenate all Bowerfile for evaluation
+  bower_rails.use_gem_deps_for_bowerfile = true
+
   # Passes the -F option to rake bower:install or rake bower:install:deployment. Defaults to false.
   bower_rails.force_install = true
+
+  # Change the default directory name
+  bower_rails.bower_components_directory = 'bower_components'
 end
 ```
 
@@ -242,7 +260,7 @@ end
 
 By default this line is added while running the generator.
 
-##Rake tasks
+## Rake tasks
 
 Once you are done with `bower.json` or `Bowerfile` you can run
 
@@ -253,7 +271,7 @@ Once you are done with `bower.json` or `Bowerfile` you can run
 * `rake bower:list` to list all packages
 * `rake bower:clean` to remove all files not listed as [main files](#bower-main-files) (if specified)
 * `rake bower:resolve` to resolve [relative asset paths](#relative-asset-paths) in components
-* `rake bower:cache:clean` to clear the bower cache. This is useful when you know a component has been updated. 
+* `rake bower:cache:clean` to clear the bower cache. This is useful when you know a component has been updated.
 
 If you'd like to pass any bower CLI options to a rake task, like `-f`, `-j`, you can simply do:
 
@@ -261,17 +279,19 @@ If you'd like to pass any bower CLI options to a rake task, like `-f`, `-j`, you
 rake bower:install['-f']
 ```
 
-##Capistrano 3 Configuration
+## Capistrano 3 Configuration
 
 While using Capistrano 3 and Capistrano Rails gem, it's needed to run bower install before assets compile. Add the following code to your deploy.rb, it will run `rake bower:install` before compiling the assets. CI=true flag is used not to ask for the analytics at the first bower install.
 
-```
+```ruby
 namespace :bower do
   desc 'Install bower'
   task :install do
     on roles(:web) do
       within release_path do
-        execute :rake, 'bower:install CI=true'
+        with rails_env: fetch(:rails_env) do
+          execute :rake, 'bower:install CI=true'
+        end
       end
     end
   end
@@ -279,29 +299,29 @@ end
 before 'deploy:compile_assets', 'bower:install'
 ```
 
-##Bower Configuration
+## Bower Configuration
 
 If you provide a `.bowerrc` in the rails project root, bower-rails will use it for bower configuration.
 Some .bowerrc options are not supported: `directory`, `cwd`, and `interactive`. Bower-rails
 will ignore the `directory` property and instead will use the automatically generated asset path.
 
-###Bower Installation
+### Bower Installation
 
 [Bower](https://github.com/bower/bower) should be installed using npm. Bower can be installed globally (with `$ npm install -g bower`) or in `node_modules` in the root directory of your project.
 
-##Relative asset paths
+## Relative asset paths
 
 Some bower components (eg. [Bootstrap](https://github.com/twbs/bootstrap/blob/0016c17f9307bc71fc96d8d4680a9c861f137cae/dist/css/bootstrap.css#L2263)) have relative urls in the CSS files for imports, images, etc. Rails prefers using [helper methods](http://guides.rubyonrails.org/asset_pipeline.html#coding-links-to-assets) for linking to assets within CSS. Relative paths can cause issues when assets are precompiled for production.
 
 Remember that you should have [bower installed](#bower-installation) either locally in your project or on a remote server.
 
-##Bower Main Files
+## Bower Main Files
 
-Each bower component should follow the [bower.json spec](https://github.com/bower/bower.json-spec) 
-which designates a recommended `main` directive that lists the primary files of 
-that component. You may choose to reference these files if you are using the asset 
-pipeline, in which case other extraneous includes of the bower component are not needed. 
-The `rake bower:clean` task removes every file that isn't listed in the `main` directive, 
+Each bower component should follow the [bower.json spec](https://github.com/bower/bower.json-spec)
+which designates a recommended `main` directive that lists the primary files of
+that component. You may choose to reference these files if you are using the asset
+pipeline, in which case other extraneous includes of the bower component are not needed.
+The `rake bower:clean` task removes every file that isn't listed in the `main` directive,
 if the component specifies a `main` directive. Remember that you can extend the `main` directive
-in [ruby DSL configuration](#ruby-dsl-configuration). Otherwise, the library will remain as bower installed it. It supports wildcards 
+in [ruby DSL configuration](#ruby-dsl-configuration). Otherwise, the library will remain as bower installed it. It supports wildcards
 in files listed in `main` directive.

data/lib/bower-rails.rb

@@ -22,14 +22,26 @@ module BowerRails
     # are invoked before assets precompilation
     attr_accessor :clean_before_precompile
 
+    # If containing a list of bower component names, those components
+    # will be excluded from the bower:clean
+    attr_accessor :exclude_from_clean
+
     # If set to true then rake bower:install:deployment will be invoked
     # instead of rake bower:install before assets precompilation
     attr_accessor :use_bower_install_deployment
 
+    # If set to true then rake bower:install will search for gem dependencies
+    # and in each gem it will search for Bowerfile and then concatenate all Bowerfile
+    # for evaluation
+    attr_accessor :use_gem_deps_for_bowerfile
+
     # If set to true then rake bower:install[-f] will be invoked
     # instead of rake bower:install before assets precompilation
     attr_accessor :force_install
 
+    # Where to store the bower components
+    attr_accessor :bower_components_directory
+
     def configure &block
       yield self if block_given?
       collect_tasks
@@ -58,5 +70,7 @@ module BowerRails
   @resolve_before_precompile    = false
   @clean_before_precompile      = false
   @use_bower_install_deployment = false
+  @use_gem_deps_for_bowerfile   = false
   @force_install = false
+  @bower_components_directory = "bower_components"
 end

data/lib/bower-rails/dsl.rb

@@ -7,7 +7,13 @@ module BowerRails
     DEFAULT_DEPENDENCY_GROUP = :dependencies
 
     def self.evalute(root_path, filename)
-      new(root_path).tap { |dsl| dsl.eval_file(File.join(root_path, filename)) }
+      new(root_path).tap do |dsl|
+        dsl.send(eval_file_method, File.join(root_path, filename))
+      end
+    end
+
+    def self.eval_file_method
+      BowerRails.use_gem_deps_for_bowerfile ? :eval_file_with_deps : :eval_file
     end
 
     attr_reader :dependencies, :root_path
@@ -20,6 +26,7 @@ module BowerRails
       @resolutions = {}
       @assets_path ||= "assets"
       @main_files = {}
+      @current_group = nil
     end
 
     def asset(name, *args, &block)
@@ -67,7 +74,15 @@ module BowerRails
     end
 
     def eval_file(file)
-      instance_eval(File.open(file, "rb") { |f| f.read }, file.to_s)
+      instance_eval(File.open(file, 'rb') { |f| f.read }, file.to_s)
+    end
+
+    def eval_file_with_deps(file)
+      Gem::Specification.map do |dep|
+        bowerfile_in_dep = File.join(dep.gem_dir, 'Bowerfile')
+        eval_file(bowerfile_in_dep) if bowerfile_in_dep != file && File.exist?(bowerfile_in_dep)
+      end
+      eval_file(file)
     end
 
     def final_assets_path
@@ -120,6 +135,7 @@ module BowerRails
         normalized_group_path = normalize_location_path(group.first, group_assets_path(group))
         File.open(File.join(normalized_group_path, ".bowerrc"), "w") do |f|
           f.write(generate_dotbowerrc)
+          f.write("\n")
         end
       end
     end
@@ -187,7 +203,7 @@ module BowerRails
     #
     def dependencies_to_json(data)
       JSON.pretty_generate({
-        :name => "dsl-generated dependencies"
+        :name => "dsl-generated-dependencies"
       }.merge(data))
     end
 

data/lib/bower-rails/performer.rb

@@ -15,8 +15,6 @@ module BowerRails
     end
 
     def perform(remove_components = true, &block)
-      entries = Dir.entries(root_path)
-
       npm_path = File.join(root_path, 'node_modules', '.bin')
       bower = find_command('bower', [npm_path])
 
@@ -24,7 +22,7 @@ module BowerRails
         $stderr.puts ["Bower not found! You can install Bower using Node and npm:",
         "$ npm install bower -g",
         "For more info see http://bower.io/"].join("\n")
-        return
+        exit 127
       end
 
       if entries.include?('Bowerfile')
@@ -69,9 +67,9 @@ module BowerRails
 
       # Load and merge root .bowerrc
       dot_bowerrc = JSON.parse(File.read(File.join(root_path, '.bowerrc'))) rescue {}
-      dot_bowerrc["directory"] = "bower_components"
+      dot_bowerrc["directory"] = components_directory
 
-      if json.except('lib', 'vendor').empty?
+      if json.reject{ |key| ['lib', 'vendor'].include? key }.empty?
         folders = json.keys
       else
         raise "Assuming a standard bower package but cannot find the required 'name' key" unless !!json['name']
@@ -91,7 +89,7 @@ module BowerRails
         Dir.chdir(dir) do
 
           # Remove old components
-          FileUtils.rm_rf("bower_components") if remove_components
+          FileUtils.rm_rf("#{components_directory}/*") if remove_components
 
           # Create bower.json
           File.open("bower.json", "w") do |f|
@@ -115,25 +113,26 @@ module BowerRails
       end
     end
 
-    def resolve_asset_paths
+    def resolve_asset_paths(root_directory = components_directory)
       # Resolve relative paths in CSS
-      Dir['bower_components/**/*.css'].each do |filename|
+      Dir["#{components_directory}/**/*.css"].each do |filename|
         contents = File.read(filename) if FileTest.file?(filename)
         # http://www.w3.org/TR/CSS2/syndata.html#uri
-        url_regex = /url\((?!\#)\s*['"]?(?![a-z]+:)([^'"\)]*)['"]?\s*\)/
+        url_regex = /url\((?!\#)\s*['"]?((?![a-z]+:)([^'"\)]*?)([?#][^'"\)]*)?)['"]?\s*\)/
 
         # Resolve paths in CSS file if it contains a url
         if contents =~ url_regex
           directory_path = Pathname.new(File.dirname(filename))
-          .relative_path_from(Pathname.new('bower_components'))
+          .relative_path_from(Pathname.new(root_directory))
 
           # Replace relative paths in URLs with Rails asset_path helper
           new_contents = contents.gsub(url_regex) do |match|
-            relative_path = $1
+            relative_path = $2
+            params = $3
             image_path = directory_path.join(relative_path).cleanpath
-            puts "#{match} => #{image_path}"
+            puts "#{match} => #{image_path} #{params}"
 
-            "url(<%= asset_path '#{image_path}' %>)"
+            "url(<%= asset_path '#{image_path}' %>#{params})"
           end
 
           # Replace CSS with ERB CSS file with resolved asset paths
@@ -146,7 +145,10 @@ module BowerRails
     def remove_extra_files
       puts "\nAttempting to remove all but main files as specified by bower\n"
 
-      Dir['bower_components/*'].each do |component_dir|
+      Dir["#{components_directory}/*"].each do |component_dir|
+        component_name = component_dir.split('/').last
+        next if clean_should_skip_component? component_name
+
         if File.exists?(File.join(component_dir, 'bower.json'))
           bower_file = File.read(File.join(component_dir, 'bower.json'))
         elsif File.exists?(File.join(component_dir, '.bower.json'))
@@ -157,7 +159,6 @@ module BowerRails
 
         # Parse bower.json
         bower_json = JSON.parse(bower_file)
-        component_name = component_dir.split('/').last
         main_files = Array(bower_json['main']) + main_files_for_component(component_name)
         next if main_files.empty?
 
@@ -186,7 +187,9 @@ module BowerRails
       paths.each do |path|
         exts.each do |ext|
           exe = File.join(path, "#{cmd}#{ext}")
-          return exe if (File.executable?(exe) && File.file?(exe))
+          if (File.executable?(exe) && File.file?(exe))
+            return Shellwords.escape exe
+          end
         end
       end
       nil
@@ -195,7 +198,21 @@ module BowerRails
     private
 
     def main_files_for_component(name)
+      return [] unless entries.include?('Bowerfile')
       Array(dsl.main_files[name])
     end
+
+    def entries
+      @entries ||= Dir.entries(root_path)
+    end
+
+    def clean_should_skip_component?(name)
+      BowerRails.exclude_from_clean.respond_to?(:include?) &&
+        BowerRails.exclude_from_clean.include?(name)
+    end
+
+    def components_directory
+      BowerRails.bower_components_directory
+    end
   end
 end

data/lib/bower-rails/railtie.rb

@@ -1,6 +1,4 @@
-require 'bower-rails'
 require 'bower-rails/dsl'
-require 'rails'
 
 module BowerRails
   class Railtie < Rails::Railtie
@@ -11,13 +9,15 @@ module BowerRails
       config.before_initialize do |app|
         @dsl = BowerRails::Dsl.evalute(BowerRails.root_path, @@bowerfile)
         @dsl.final_assets_path.map do |assets_root, assets_path|
-          app.config.assets.paths << Rails.root.join(assets_root, assets_path, "bower_components")
+          app.config.assets.paths <<
+            Rails.root.join(assets_root, assets_path, BowerRails.bower_components_directory)
         end
       end
     else
       config.before_initialize do |app|
         ["lib", "vendor"].each do |dir|
-          app.config.assets.paths << Rails.root.join(dir, 'assets', 'bower_components')
+          app.config.assets.paths <<
+            Rails.root.join(dir, 'assets', BowerRails.bower_components_directory)
         end
       end
     end

data/lib/bower-rails/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module BowerRails
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/generators/bower_rails/initialize/initialize_generator.rb

@@ -1,6 +1,8 @@
 module BowerRails
   module Generators
     class InitializeGenerator < Rails::Generators::Base
+      INITIALIZE_FILE_PATH = 'config/initializers/bower_rails.rb'
+
       desc 'Adds a boilerplate bower.json or Bowerfile to the root of Rails project and an empty initializer'
       source_root File.expand_path('../templates', __FILE__)
       argument :config_file, :type => :string, :default => 'bowerfile'
@@ -16,14 +18,14 @@ module BowerRails
       end
 
       def copy_initializer_file
-        copy_file 'bower_rails.rb', 'config/initializers/bower_rails.rb'
+        copy_file 'bower_rails.rb', INITIALIZE_FILE_PATH
       end
 
       def require_initializer_in_application_rb
         if Rails.version < "4.0.0"
-          environment { "require \"#{Rails.root}/config/initializers/bower_rails.rb\"" }
+          environment { "require Rails.root.join(\"#{INITIALIZE_FILE_PATH}\").to_s" }
         end
       end
     end
   end
-end
+end

data/lib/generators/bower_rails/initialize/templates/bower_rails.rb

@@ -11,9 +11,12 @@ BowerRails.configure do |bower_rails|
   # Invokes rake bower:clean before precompilation. Defaults to false
   # bower_rails.clean_before_precompile = true
 
-  # Invokes rake bower:install:deployment instead rake bower:install. Defaults to false
+  # Invokes rake bower:install:deployment instead of rake bower:install. Defaults to false
   # bower_rails.use_bower_install_deployment = true
   #
   # Invokes rake bower:install and rake bower:install:deployment with -F (force) flag. Defaults to false
   # bower_rails.force_install = true
+
+  # Change the default directory name
+  # bower_rails.bower_components_directory = 'bower_components'
 end

data/lib/tasks/bower.rake

@@ -62,9 +62,10 @@ namespace :bower do
   end
 
   desc "Resolve assets paths in bower components"
-  task :resolve do
+  task :resolve, :relative_directory do |_, args|
     BowerRails::Performer.perform false do
-      resolve_asset_paths
+      resolve_asset_paths(
+        args[:relative_directory] || BowerRails.bower_components_directory)
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bower-rails
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Ross Harrison
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Bower for Rails