bower-rails-pt 0.5.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Ross Harrison
+
+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,110 @@
+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.
+
+**Requirements**
+
+* [node](http://nodejs.org) ([on github](https://github.com/joyent/node))
+* [bower](https://github.com/bower/bower) (>= 0.10.0) installed with npm
+
+**Install**
+
+in Gemfile
+
+``` Ruby
+	gem "bower-rails", "~> 0.5.0"
+```
+
+**Initialize**
+
+To add an empty bower.json file to the project root.
+
+``` Bash
+	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.
+
+**example bower.json file**
+
+``` javascript
+{
+   "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"
+    }
+  },
+  "vendor": {
+    "name": "bower-rails generated vendor assets",
+    "dependencies": {
+      "three.js"    : "https://raw.github.com/mrdoob/three.js/master/build/three.js"
+    }
+  }
+}
+```
+
+##Ruby DSL configuration
+
+The Ruby DSL configuration is a Bowerfile at the project's root with DSL syntax similar to Bundler. 
+
+**Example Bowerfile**
+
+By default assets are put to `./vendor/assets/bower_components` directory:
+
+``` ruby
+
+# Puts to ./vendor/assets/bower_components
+asset "backbone"
+asset "moment"
+```
+
+But the default value can be overridden by `assets_path` method:
+
+``` ruby
+assets_path "assets/my_javascripts"
+
+# Puts to ./vendor/assets/my_javascripts/bower_components
+asset "backbone"
+asset "moment"
+```
+
+And finally, the `assets_path` method can be overridden by an option in a `group` call:
+
+``` ruby
+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 "backbone", "1.2"
+end
+
+# Puts files under ./lib/assets/javascript/bower_components
+group :lib do
+  asset "jquery"
+  asset "backbone", "1.2"
+end
+```
+NOTE: All the assets should be stored in `/assets` subdirectory so putting it under `./vendor/js` directory is unavailable
+
+##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

data/lib/bower-rails.rb

@@ -0,0 +1,4 @@
+module BowerRails
+  require 'bower-rails/railtie' if defined?(Rails)
+  require "bower-rails/dsl"
+end

data/lib/bower-rails/dsl.rb

@@ -0,0 +1,108 @@
+require 'json'
+require 'fileutils'
+
+module BowerRails
+  class Dsl
+
+    def self.evalute(filename)
+      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
+      @assets_path ||= "assets"
+    end
+
+    def eval_file(file)
+      instance_eval(File.open(file, "rb") { |f| f.read }, file.to_s)
+    end
+
+    def directories
+      @dependencies.keys
+    end
+
+    def group(name, options = {}, &block)
+      if custom_assets_path = options[:assets_path]
+        assert_asset_path custom_assets_path
+      end
+      add_group(name, options)
+      yield if block_given?
+    end
+
+    def asset(name, version = "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 to_json(location)
+      dependencies_to_json @dependencies[normalize_location_path(location)]
+    end
+
+    def write_bower_json
+      @dependencies.each do |dir,data|
+        FileUtils.mkdir_p dir unless File.directory? dir
+        File.open(File.join(dir,"bower.json"), "w") do |f|
+          f.write(dependencies_to_json(data))
+        end
+      end
+    end
+
+    def write_dotbowerrc
+      groups.map do |g|
+        g_norm = normalize_location_path(g.first, group_assets_path(g))
+        File.open(File.join(g_norm, ".bowerrc"), "w") do |f|
+          f.write(JSON.pretty_generate({:directory => "bower_components/pt"}))
+        end
+      end
+    end
+
+    def final_assets_path
+      groups.map do |g|
+        [g.first.to_s, group_assets_path(g)]
+      end
+    end   
+
+    def group_assets_path group
+      group_options = Hash === group.last ? group.last : {:assets_path => @assets_path}
+      group_options[:assets_path]
+    end 
+
+    private
+
+    def add_group(*group)
+      @groups = (groups << group)
+    end
+
+    def groups
+      @groups ||= [[:vendor, { :assets_path => @assets_path }]]
+    end
+
+    def dependencies_to_json(data)
+      JSON.pretty_generate({
+        :name => "dsl-generated dependencies",
+        :dependencies => data
+      })
+    end
+
+    def assets_path(assets_path)
+      assert_asset_path assets_path
+      @assets_path = assets_path
+    end
+
+    def assert_asset_path(path)
+      if !path.start_with?('assets', '/assets')
+        raise ArgumentError, "Assets should be stored in /assets directory, try assets_path 'assets/#{path}' instead"
+      end
+    end
+
+    def normalize_location_path(loc, assets_path)
+      File.join(@root_path, loc.to_s, assets_path)
+    end
+  end
+end

data/lib/bower-rails/railtie.rb

@@ -0,0 +1,30 @@
+require 'bower-rails'
+require 'bower-rails/dsl'
+require 'rails'
+
+module BowerRails
+  class Railtie < Rails::Railtie
+    railtie_name :bower
+    @@bowerfile = File.join("Bowerfile")
+
+    if File.exist?(@@bowerfile)
+      config.before_initialize do |app|
+        @dsl = BowerRails::Dsl.evalute(@@bowerfile)
+
+        @dsl.final_assets_path.map do |assets_root, assets_path|
+          app.config.assets.paths << Rails.root.join(assets_root, assets_path, "bower_components")
+        end
+      end
+    else
+      config.before_initialize do |app|
+        ["lib", "vendor"].each do |dir|
+          app.config.assets.paths << Rails.root.join(dir, 'assets', 'bower_components')
+        end
+      end
+    end
+
+    rake_tasks do
+      load "tasks/bower.rake"
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module BowerRails
+  module Generators
+    class InitializeGenerator < Rails::Generators::Base
+      desc "Adds a boilerplate component.json file to root of rails project"
+
+      def self.source_root
+        @_bower_rails_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def create_initializer_file
+        template "bower.json", 'bower.json'
+      end
+    end
+  end
+end

data/lib/generators/bower_rails/initialize/templates/bower.json

@@ -0,0 +1,12 @@
+{
+  "lib": {
+    "name": "bower-rails generated lib assets",
+    "dependencies": {
+    }
+  },
+  "vendor": {
+    "name": "bower-rails generated vendor assets",
+    "dependencies": {
+    }
+  }
+}

data/lib/tasks/bower.rake

@@ -0,0 +1,123 @@
+require 'json'
+require 'pp'
+
+namespace :bower do
+  desc "Install components from bower"
+  task :install do
+    perform do
+      sh 'bower install'
+    end
+  end
+
+  namespace :install do
+    desc "Install components with -F option"
+    task :force do
+      perform do
+        sh 'bower install -F'
+      end
+    end
+  end
+
+  desc "Update bower components"
+  task :update do
+    perform do
+      sh 'bower update'
+    end
+  end
+
+  desc "List bower components"
+  task :list do
+    perform false do
+      sh 'bower list'
+    end
+  end  
+
+  namespace :update do
+    desc "Update existing components and uninstalls extraneous components"
+    task :prune do
+      perform do
+        sh 'bower update && bower prune'
+      end
+    end
+  end
+end
+
+def perform remove_components = true, &block
+  entries = Dir.entries(get_bower_root_path)
+
+  if entries.include?('Bowerfile')
+    dsl_perform_command remove_components, &block
+  elsif entries.include?('bower.json')
+    perform_command remove_components, &block
+  else
+    raise LoadError, "No Bowerfile or bower.json file found. Make sure you have it at the root of your project"
+  end
+end
+
+def get_bower_root_path
+  if defined?(Rails)
+    return Rails.root
+  else
+    return Dir.pwd
+  end
+end
+
+def dsl_perform_command remove_components = true, &block
+  dsl = BowerRails::Dsl.evalute("Bowerfile")
+
+  if remove_components
+    dsl.write_bower_json
+    dsl.write_dotbowerrc
+    puts "bower.js files generated"
+  end
+
+  if block_given?
+    dsl.directories.each do |dir|
+      Dir.chdir(dir) do
+        yield
+      end
+    end
+  end
+end
+
+#run the passed bower block in appropriate folders
+def perform_command remove_components = true, &block
+  bower_root = get_bower_root_path
+  #load in bower json file
+  txt  = File.read(File.join(bower_root, "bower.json"))
+  json = JSON.parse(txt)
+
+  ["lib", "vendor"].each do |dir|
+
+    data = json[dir]
+
+    #check folder existence and create?
+    dir = File.join(bower_root, dir, "assets")
+    FileUtils.mkdir_p dir unless File.directory? dir
+    #go in to dir to act
+    Dir.chdir(dir) do
+
+      #remove old components
+      FileUtils.rm_rf("bower_components") if remove_components
+
+      #create bower json
+      File.open("bower.json", "w") do |f|
+        f.write(data.to_json)
+      end
+
+      #create .bowerrc
+      File.open(".bowerrc", "w") do |f|
+        f.write(JSON.pretty_generate({:directory => "bower_components"}))
+      end
+
+      #run command
+      yield  if block_given?
+
+      #remove bower file
+      FileUtils.rm("bower.json")
+
+      #remove .bowerrc
+      FileUtils.rm(".bowerrc")
+    end if data && !data["dependencies"].empty?
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: bower-rails-pt
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Ross Harrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails integration for bower.
+email: rtharrison86@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/bower_rails/initialize/templates/bower.json
+- lib/generators/bower_rails/initialize/initialize_generator.rb
+- lib/bower-rails.rb
+- lib/tasks/bower.rake
+- lib/bower-rails/dsl.rb
+- lib/bower-rails/railtie.rb
+- MIT-LICENSE
+- README.md
+homepage: https://github.com/cj/bower-rails-pt
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Bower for Rails
+test_files: []
+has_rdoc: