bower-rails 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d18d9ca48d1438cf86e7d8effff84410300bb0f8
-  data.tar.gz: 77bdfb89794820ff714e879006daa84ec7cb8002
+  metadata.gz: 73ea0764f11696a1dde32c69b4bfed873bf3c93b
+  data.tar.gz: 314587a37f67499acd1638c3698997db6fe1d9d0
 SHA512:
-  metadata.gz: 7664df0469ff3e0d3e5b97327f0a6e99b3c7c790dbbe244262b625394c4e8ebc52660db962dde90888e227ef2edea3b52e3c70b42e71efdd2e13430aa6fb356c
-  data.tar.gz: 7a87fe21e8d47e61d5a08fd5ebb53e73155ffbc2095d32494281678907939b16b75ab9ea4db69db645efa4cdbf7e040c6a8cb08a5ab52ea3bc2028298cb8acc6
+  metadata.gz: 23ab1f087a70761a17840ca4f98ecf351d5de2d78aba5d57d58dde0f89da53a8853041dc97a757c4a54c6017499c4d2858da48774becb32993092ad1444f321f
+  data.tar.gz: 690d0aeebc8295c770bed50965679f7a6d055760b5f4ac43d2584575cca81b455cf2d092862d2f9f9a42cfc214a58caac1c90e28a1ae5e54d18750bebf38ff32

data/README.md

@@ -22,7 +22,7 @@ Check out [changelog][] for the latest changes and releases.
 in Gemfile
 
 ``` Ruby
-  gem "bower-rails", "~> 0.7.1"
+  gem "bower-rails", "~> 0.7.2"
 ```
 
 ##JSON configuration
@@ -75,7 +75,14 @@ By default assets are put to `./vendor/assets/bower_components` directory:
 
 # Puts to ./vendor/assets/bower_components
 asset "backbone"
-asset "moment"
+asset "moment", "2.0.0" # get exactly version 2.0.0
+asset "secret_styles", "git@github.com:initech/secret_styles" # get from a git repo
+
+# get from a git repo using the tag 1.0.0
+asset "secret_logic", "1.0.0", git: "git@github.com:initech/secret_logic"
+
+# get from a github repo
+asset "secret_logic", "1.0.0", github: "initech/secret_logic"
 ```
 
 But the default value can be overridden by `assets_path` method:
@@ -95,7 +102,7 @@ assets_path "assets/javascript"
 
 # Puts files under ./vendor/assets/js/bower_components
 group :vendor, :assets_path => "assets/js"  do
-  asset "jquery"            # Assummes it's latests
+  asset "jquery"            # Defaults to 'latest'
   asset "backbone", "1.1.1"
 end
 
@@ -108,17 +115,48 @@ 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
 
+##Configuration
+
+Change options in your `config/initializers/bower_rails.rb`:
+
+``` ruby
+BowerRails.configure do |bower_rails|
+  # By default options are false
+  bower_rails.resolve_before_precompile = true # invokes rake bower:resolve before precompilation
+  bower_rails.clean_before_precompile = true   # invokes rake bower:clean before precompilation
+end
+```
+
+If you are using Rails version < 4.0.0 then you are to require `bower_rails.rb` initializer manually in `application.rb`:
+
+```ruby
+module YourAppName
+  class Application < Rails::Application
+    require "#{Rails.root}/config/initializers/bower_rails.rb"
+    ...
+  end
+end
+```
+
+By default this line is added while running the generator.
+
 ##Rake tasks
 
 Once you are done with `bower.json` or `Bowerfile` you can run
 
 * `rake bower:install` to install js components
-* `rake bower:install:force` to install with force option
 * `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: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
 
+If you'd like to pass any bower CLI options to a rake task, like `-f`, `-j`, you can simply do:
+
+```bash
+rake bower:install['-f']
+```
+
 ##Bower Configuration
 
 If you provide a `.bowerrc` in the rails project root, bower-rails will use it for bower configuration.
@@ -133,12 +171,8 @@ will ignore the `directory` property and instead will use the automatically gene
 
 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.
 
-If you would like the bower assets to be reinstalled with the relative paths on every deploy, provide an option for `bower-rails` so it do it automatically before the `rake assets:precompile` task is run:
-
-``` ruby
-BowerRails.configure do |bower_rails|
-  # By default this option is false
-  bower_rails.resolve_before_precompile = true
-end
-```
 Remember that you should have [bower installed](#bower-installation) either locally in your project or on a remote server.
+
+##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, if the component specifies a `main` directive. Otherwise, the library will remain as bower installed it.

data/lib/bower-rails.rb

@@ -2,16 +2,39 @@ module BowerRails
   require 'bower-rails/railtie' if defined?(Rails)
   require 'bower-rails/dsl'
 
+  extend self
+
   class << self
+    # An array of tasks to enhance `rake assets:precompile`
+    attr_reader :tasks
+    
     # If set to true then rake bower:install && rake bower:resolve tasks
     # are invoked before assets precompilation
     attr_accessor :resolve_before_precompile
 
+    # If set to true then rake bower:install && rake bower:clean && rake bower:resolve tasks
+    # are invoked before assets precompilation
+    attr_accessor :clean_before_precompile
+
     def configure &block
       yield self if block_given?
+      collect_tasks
     end
+
+    private
+
+      def collect_tasks
+        @tasks << ['bower:install', 'bower:resolve'] if @resolve_before_precompile
+        @tasks << ['bower:install', 'bower:clean']   if @clean_before_precompile
+        @tasks.flatten!
+        @tasks.uniq!
+      end
   end
 
+  # By default tasks are empty
+  @tasks = []
+
   # Set default values for options
   @resolve_before_precompile = false
+  @clean_before_precompile = false
 end

data/lib/bower-rails/dsl.rb

@@ -26,16 +26,29 @@ module BowerRails
 
     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, version = "latest")
-      group = @current_group ? @current_group : default_group
+    def asset(name, *args)
+      group = @current_group || default_group
+
+      options = Hash === args.last ? args.pop.dup : {}
+      version = args.last || "latest"
+
+      options[:git] = "git://github.com/#{options[:github]}" if options[:github]
+
+      if options[:git]
+        version = if version == 'latest'
+                    options[:git]
+                  else
+                    options[:git] + "#" + version
+                  end
+      end
 
       normalized_group_path = normalize_location_path(group.first, group_assets_path(group))
       @dependencies[normalized_group_path] ||= {}
@@ -70,7 +83,7 @@ module BowerRails
       groups.map do |group|
         [group.first.to_s, group_assets_path(group)]
       end
-    end   
+    end
 
     def group_assets_path group
       group.last[:assets_path]

data/lib/bower-rails/railtie.rb

@@ -24,6 +24,7 @@ module BowerRails
     end
 
     rake_tasks do
+      require "tasks/helpers/before_hook.rb"
       load "tasks/bower.rake"
     end
   end

data/lib/bower-rails/version.rb

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

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

@@ -18,6 +18,12 @@ module BowerRails
       def copy_initializer_file
         copy_file 'bower_rails.rb', 'config/initializers/bower_rails.rb'
       end
+
+      def require_initializer_in_application_rb
+        if Rails.version < "4.0.0"
+          environment { "require \"#{Rails.root}/config/initializers/bower_rails.rb\"" }
+        end
+      end
     end
   end
 end

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

@@ -1,6 +1,7 @@
 BowerRails.configure do |bower_rails|
-  # Uncomment this line if you want `rake bower:resolve` task to be run
-  # automatically before the `rake assets:precompile` task.
-
+  # Invoke `rake bower:resolve` automatically before the `rake assets:precompile` task.
   # bower_rails.resolve_before_precompile = true
+  
+  # Invoke `rake bower:clean` automatically before the `rake assets:precompile` task.
+  # bower_rails.resolve_before_precompile = true  
 end

data/lib/tasks/bower.rake

@@ -1,27 +1,23 @@
 require 'json'
 require 'pp'
+require 'find'
+
+include BeforeHook
 
 namespace :bower do
   desc "Install components from bower"
-  task :install do
+  task :install, :options do |_, args|
+    args.with_defaults(:options => '')
     perform do |bower|
-      sh "#{bower} install"
-    end
-  end
-
-  namespace :install do
-    desc "Install components with -F option"
-    task :force do
-      perform do |bower|
-        sh "#{bower} install -F"
-      end
+      sh "#{bower} install #{args[:options]}"
     end
   end
 
   desc "Update bower components"
-  task :update do
+  task :update, :options do |_, args|
+    args.with_defaults(:options => '')
     perform do |bower|
-      sh "#{bower} update"
+      sh "#{bower} update #{args[:options]}"
     end
   end
 
@@ -34,9 +30,10 @@ namespace :bower do
 
   namespace :update do
     desc "Update existing components and uninstalls extraneous components"
-    task :prune do
+    task :prune, :options do |_, args|
+      args.with_defaults(:options => '')
       perform do |bower|
-        sh "#{bower} update && #{bower} prune"
+        sh "#{bower} update #{args[:options]} && #{bower} prune #{args[:options]}"
       end
     end
   end
@@ -47,10 +44,20 @@ namespace :bower do
       resolve_asset_paths
     end
   end
+
+  desc "Attempt to keep only files listed in 'main' of each component's bower.json"
+  task :clean do
+    perform false do
+      remove_extra_files
+    end
+  end
 end
 
-# Install bower assets before precompile if an corresponding option provided
-Rake::Task['assets:precompile'].enhance ['bower:install', 'bower:resolve'] if BowerRails.resolve_before_precompile
+before 'assets:precompile' do
+  BowerRails.tasks.map do |task|
+    Rake::Task[task].invoke
+  end
+end
 
 def perform remove_components = true, &block
   entries = Dir.entries(get_bower_root_path)
@@ -62,7 +69,7 @@ def perform remove_components = true, &block
     $stderr.puts <<EOS
 Bower not found! You can install Bower using Node and npm:
 $ npm install bower -g
-For more info see http://twitter.github.com/bower/
+For more info see http://bower.io/
 EOS
     return
   end
@@ -122,8 +129,6 @@ def perform_command remove_components = true, &block
   end
 
   folders.each do |dir|
-    puts "\nInstalling dependencies into #{dir}"
-
     data = json[dir]
 
     # assume using standard bower.json if folder name is not found
@@ -188,6 +193,41 @@ def resolve_asset_paths
   end
 end
 
+def remove_extra_files
+  puts "\nAttempting to remove all but main files as specified by bower\n"
+
+  Dir['bower_components/*'].each do |component_dir|
+    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'))
+      bower_file = File.read(File.join(component_dir, '.bower.json'))
+    else
+      next
+    end
+
+    # parse bower.json
+    bower_json = JSON.parse(bower_file)
+    main_files = bower_json['main']
+    next unless main_files
+
+    # handle singular or multiple files
+    main_files = [main_files] unless main_files.is_a?(Array)
+
+    # Remove "./" relative path from main file strings
+    main_files.map! { |file| File.join(component_dir, file.gsub(/^\.\//, '')) }
+
+    # delete all files that are not in main
+    Find.find(component_dir).reverse_each do |file_or_dir|
+      next if main_files.include?(file_or_dir)
+      if File.directory?(file_or_dir)
+        Dir.rmdir(file_or_dir) if (Dir.entries(file_or_dir) - %w[ . .. ]).empty?
+      else
+        FileUtils.rm(file_or_dir)
+      end
+    end
+  end
+end
+
 # http://stackoverflow.com/questions/2108727/which-in-ruby-checking-if-program-exists-in-path-from-ruby
 def find_command(cmd, paths = [])
   exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
@@ -195,7 +235,7 @@ def find_command(cmd, paths = [])
   paths.each do |path|
     exts.each do |ext|
       exe = File.join(path, "#{cmd}#{ext}")
-      return exe if File.executable? exe
+      return exe if (File.executable?(exe) && File.file?(exe))
     end
   end
   nil

data/lib/tasks/helpers/before_hook.rb

@@ -0,0 +1,14 @@
+module BeforeHook
+  # The `before` hook for rake tasks. 
+  # The code was taken from https://github.com/guillermo/rake-hooks/blob/master/lib/rake/hooks.rb#L2
+  def before(*task_names, &new_task)
+    task_names.each do |task_name|
+      old_task = Rake.application.instance_variable_get('@tasks').delete(task_name.to_s)
+      desc old_task.full_comment
+      task task_name => old_task.prerequisites do
+        new_task.call
+        old_task.invoke
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bower-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ross Harrison
@@ -63,11 +63,13 @@ files:
 - lib/bower-rails.rb
 - lib/bower-rails/dsl.rb
 - lib/bower-rails/railtie.rb
+- lib/bower-rails/version.rb
 - lib/generators/bower_rails/initialize/initialize_generator.rb
 - lib/generators/bower_rails/initialize/templates/Bowerfile
 - lib/generators/bower_rails/initialize/templates/bower.json
 - lib/generators/bower_rails/initialize/templates/bower_rails.rb
 - lib/tasks/bower.rake
+- lib/tasks/helpers/before_hook.rb
 homepage: https://github.com/rharriso/bower-rails
 licenses:
 - MIT
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Bower for Rails