bower-rails 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16fcf55d5a780de4c4ae812c3f56174cdc3db86b
-  data.tar.gz: 874ce01615f934ea561b4c6eb5c8209b2c59205b
+  metadata.gz: 98d9ed52d0507bd2dcc3e78fefa66982aae28f3e
+  data.tar.gz: c483f89a0b7509543f31ba6d4922c86dcc8d560a
 SHA512:
-  metadata.gz: 852c5924db1d15a70a3bf45cd90cab5a700180efa52c6257acc8e36ae924e58e29d8b9bc7a7ebb256f872b129ffc3f325934b85b1f1cd002ae96188335cde921
-  data.tar.gz: db064ec965fbe7fa76069997576a763ed3d91a16754efe02c4533201a1b6f61bce21533dc24eb59568f9073de0b69341bcbad3b1b922c642252fd29ccea21415
+  metadata.gz: c2cf8e667c67755b5ff2f3694896f454c0286a56b4f84e7ba84dc9ae454f73d1bb482ea8e59b688c5ed455ad6b754736b4edf87a2df55f0a77faba097b688d32
+  data.tar.gz: 120b78bc07539c8616b09843473b23807f8b97abaa7193227fd26f173c273f398110c0f7d6fc68504f695b737a13cce0fe26002f5d3c1b714a8283f140ac2224

data/README.md

@@ -1,6 +1,12 @@
 bower-rails
 ===========
 
+[![Gem Version](https://badge.fury.io/rb/bower-rails.png)](http://badge.fury.io/rb/bower-rails)
+[![Code Climate](https://codeclimate.com/github/42dev/bower-rails.png)](https://codeclimate.com/github/42dev/bower-rails)
+[![Dependency Status](https://gemnasium.com/SergeyKishenin/bower-rails.png)](https://gemnasium.com/SergeyKishenin/bower-rails)
+[![Build Status](https://travis-ci.org/42dev/bower-rails.png?branch=master)](https://travis-ci.org/42dev/bower-rails)
+[![Coverage Status](https://coveralls.io/repos/42dev/bower-rails/badge.png)](https://coveralls.io/r/42dev/bower-rails)
+
 Bower support for Rails projects. Dependency file is bower.json in Rails root dir or Bowerfile if you use DSL.
 Check out Changelog.md for the latest changes and releases.
 
@@ -14,20 +20,20 @@ Check out Changelog.md for the latest changes and releases.
 in Gemfile
 
 ``` Ruby
-	gem "bower-rails", "~> 0.4.4"
+  gem "bower-rails", "~> 0.5.0"
 ```
 
-**Initialize**
+##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.
 
-To add an empty bower.json file to the project root.
+To install dependencies into both `lib` and `vendor` directories, run the initializer to generate a custom bower.json:
 
 ``` Bash
-	rails g bower_rails:initialize
+  rails g bower_rails:initialize
 ```
 
-##JSON configuration
-
-The bower.json file is two seperate bower [component.js](https://github.com/twitter/bower#defining-a-package) files. Defining a package in lib and vendor will install those packages to the corresponding directories.
+This will generate a special bower.json that combines two standard bower packages into one. Simply specify your dependencies under each folder name to install them into the corresponding directories.
 
 **example bower.json file**
 
@@ -91,6 +97,7 @@ group :lib do
   asset "backbone", "1.2"
 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
 
 ##Rake tasks
@@ -102,3 +109,16 @@ Once you are done with `bower.json` or `Bowerfile` you can run
 * `rake bower:update` to update js components
 * `rake bower:update:prune` to update components and uninstall extraneous packages
 * `rake bower:list` to list all packages
+* `rake bower:resolve` to resolve [relative asset paths](#relative-asset-paths) in components
+
+##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.
+
+##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.
+
+Before the `rake assets:precompile` task is run, the bower assets will be reinstalled with the relative paths replaced with calls to `asset_path` so that all asset links work in production.

data/lib/bower-rails/dsl.rb

@@ -3,19 +3,17 @@ require 'fileutils'
 
 module BowerRails
   class Dsl
+
     def self.evalute(filename)
-      instance = new
-      instance.eval_file(File.join(instance.root_path, filename))
-      instance
+      new.tap { |dsl| dsl.eval_file(File.join(dsl.root_path, filename)) }
     end
 
     attr_reader :dependencies, :root_path
 
     def initialize
       @dependencies = {}
-      @root_path ||= defined?(Rails) ? Rails.root : Dir.pwd
+      @root_path ||= Dir.pwd
       @assets_path ||= "assets"
-      @groups ||= [[:vendor, { assets_path: @assets_path }]]
     end
 
     def eval_file(file)
@@ -26,64 +24,72 @@ module BowerRails
       @dependencies.keys
     end
 
-    def group(*args, &block)
-      if args[1]
-        custom_assets_path = args[1][:assets_path]
-        raise ArgumentError, "Assets should be stored in /assets directory, try :assets_path => 'assets/#{custom_assets_path}' instead" unless custom_assets_path.start_with?('assets', '/assets')
-        new_group = [args[0], args[1]]
-      else
-        new_group = [args[0]]
-      end
-        
-      @groups << new_group
-
+    def group(name, options = {}, &block)
+      options[:assets_path] ||= @assets_path
+      
+      assert_asset_path options[:assets_path]
+      assert_group_name name
+      
+      @current_group = add_group name, options
       yield if block_given?
     end
 
-    def asset(name, *args)
-      version = args.first || "latest"
-
-      @groups.each do |g|
-        g_norm = normalize_location_path(g.first, group_assets_path(g))
-        @dependencies[g_norm] ||= {}
-        @dependencies[g_norm][name] = version
-      end
-    end
+    def asset(name, version = "latest")
+      group = @current_group ? @current_group : default_group
 
-    def to_json(location)
-      dependencies_to_json @dependencies[normalize_location_path(location)]
+      normalized_group_path = normalize_location_path(group.first, group_assets_path(group))
+      @dependencies[normalized_group_path] ||= {}
+      @dependencies[normalized_group_path][name] = version
     end
 
     def write_bower_json
-      @dependencies.each do |dir,data|
+      @dependencies.each do |dir, data|
         FileUtils.mkdir_p dir unless File.directory? dir
-        File.open(File.join(dir,"bower.json"), "w") do |f|
+        File.open(File.join(dir, "bower.json"), "w") do |f|
           f.write(dependencies_to_json(data))
         end
       end
     end
 
+    def generate_dotbowerrc
+      contents = JSON.parse(File.read(File.join(@root_path, '.bowerrc'))) rescue {}
+      contents["directory"] = "bower_components"
+      JSON.pretty_generate(contents)
+    end
+
     def write_dotbowerrc
-      @groups.map do |g|
-        File.open(File.join(g.first.to_s, group_assets_path(g), ".bowerrc"), "w") do |f|
-          f.write(JSON.pretty_generate({:directory => "bower_components"}))
+      groups.map do |group|
+        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)
         end
       end
     end
 
     def final_assets_path
-      @groups.map do |g|
-        [g.first.to_s, group_assets_path(g)]
+      groups.map do |group|
+        [group.first.to_s, group_assets_path(group)]
       end
     end   
 
     def group_assets_path group
-      group_options = Hash === group.last ? group.last : {:assets_path => @assets_path}
-      group_options[:assets_path]
-    end 
+      group.last[:assets_path]
+    end
 
     private
 
+    def add_group(*group)
+      @groups = (groups << group) and return group
+    end
+
+    def groups
+      @groups ||= [default_group]
+    end
+
+    def default_group
+      [:vendor, { :assets_path => @assets_path }]
+    end
+
     def dependencies_to_json(data)
       JSON.pretty_generate({
         :name => "dsl-generated dependencies",
@@ -92,10 +98,20 @@ module BowerRails
     end
 
     def assets_path(assets_path)
-      raise ArgumentError, "Assets should be stored in /assets directory, try assets_path 'assets/#{assets_path}' instead" unless assets_path.start_with?('assets', '/assets')
+      assert_asset_path assets_path
       @assets_path = assets_path
     end
 
+    def assert_asset_path(path)
+      unless path.start_with?('assets', '/assets')
+        raise ArgumentError, "Assets should be stored in /assets directory, try assets_path 'assets/#{path}' instead"
+      end
+    end
+
+    def assert_group_name name
+      raise ArgumentError, "Group name should be :lib or :vendor only" unless [:lib, :vendor].include?(name)
+    end
+
     def normalize_location_path(loc, assets_path)
       File.join(@root_path, loc.to_s, assets_path)
     end

data/lib/tasks/bower.rake

@@ -30,7 +30,7 @@ namespace :bower do
     perform false do
       sh 'bower list'
     end
-  end  
+  end
 
   namespace :update do
     desc "Update existing components and uninstalls extraneous components"
@@ -40,8 +40,18 @@ namespace :bower do
       end
     end
   end
+
+  desc "Resolve assets paths in bower components"
+  task :resolve do
+    perform false do
+      resolve_asset_paths
+    end
+  end
 end
 
+# Install bower assets before precompile
+Rake::Task['assets:precompile'].enhance ['bower:install', 'bower:resolve']
+
 def perform remove_components = true, &block
   entries = Dir.entries(get_bower_root_path)
 
@@ -55,11 +65,7 @@ def perform remove_components = true, &block
 end
 
 def get_bower_root_path
-  if defined?(Rails)
-    return Rails.root
-  else
-    return Dir.pwd
-  end
+  Dir.pwd
 end
 
 def dsl_perform_command remove_components = true, &block
@@ -87,10 +93,26 @@ def perform_command remove_components = true, &block
   txt  = File.read(File.join(bower_root, "bower.json"))
   json = JSON.parse(txt)
 
-  ["lib", "vendor"].each do |dir|
+
+  #load and merge root .bowerrc
+  dot_bowerrc = JSON.parse(File.read(File.join(bower_root, '.bowerrc'))) rescue {}
+  dot_bowerrc["directory"] = "bower_components"
+
+  if json.except('lib', 'vendor').empty?
+    folders = json.keys
+  else
+    raise "Assuming a standard bower package but cannot find the required 'name' key" unless !!json['name']
+    folders = ['vendor']
+  end
+
+  folders.each do |dir|
+    puts "\nInstalling dependencies into #{dir}"
 
     data = json[dir]
 
+    # assume using standard bower.json if folder name is not found
+    data = json if data.nil?
+
     #check folder existence and create?
     dir = File.join(bower_root, dir, "assets")
     FileUtils.mkdir_p dir unless File.directory? dir
@@ -107,7 +129,7 @@ def perform_command remove_components = true, &block
 
       #create .bowerrc
       File.open(".bowerrc", "w") do |f|
-        f.write(JSON.pretty_generate({:directory => "bower_components"}))
+        f.write(JSON.pretty_generate(dot_bowerrc))
       end
 
       #run command
@@ -121,3 +143,31 @@ def perform_command remove_components = true, &block
     end if data && !data["dependencies"].empty?
   end
 end
+
+def resolve_asset_paths
+  # Resolve relative paths in CSS
+  Dir['bower_components/**/*.css'].each do |filename|
+    contents = File.read(filename)
+    # http://www.w3.org/TR/CSS2/syndata.html#uri
+    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'))
+
+      # Replace relative paths in URLs with Rails asset_path helper
+      new_contents = contents.gsub(url_regex) do |match|
+        relative_path = $1
+        image_path = directory_path.join(relative_path).cleanpath
+        puts "#{match} => #{image_path}"
+
+        "url(<%= asset_path '#{image_path}' %>)"
+      end
+
+      # Replace CSS with ERB CSS file with resolved asset paths
+      FileUtils.rm(filename)
+      File.write(filename + '.erb', new_contents)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bower-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ross Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -44,12 +44,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/tasks/bower.rake
 - lib/bower-rails/railtie.rb
 - lib/bower-rails/dsl.rb
 - lib/bower-rails.rb
 - lib/generators/bower_rails/initialize/templates/bower.json
 - lib/generators/bower_rails/initialize/initialize_generator.rb
-- lib/tasks/bower.rake
 - MIT-LICENSE
 - README.md
 homepage: https://github.com/rharriso/bower-rails
@@ -72,9 +72,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
 summary: Bower for Rails
 test_files: []
-has_rdoc: