twitter-bootswatch-rails 2.3.1.2

data/README.md

@@ -0,0 +1,259 @@
+# Twitter Bootswatch Rails gem
+  
+  - Integrates Twitter Bootstrap CSS & Font Awesome toolkit into the Rails 3.1+ Asset Pipeline
+  - Easy control over which javascript and less modules are loaded by default. Not every app needs a carousel
+  - Simple default less files for custom application themes ("[theme_name]/variables.less" and "[theme_name]/bootswatch.less")
+  - Easily apply different custom themes or bootswatches from a site like [bootswatch.com](http://bootswatch.com/)
+  - Create several themed swatches for your project with theme_names, (e.g. an admin theme and a storefront theme using namespaced theme_names)
+  - Gem version semantics extend Twitter Bootstrap version semantics, making it simple to know what version of bootstrap the gem is using
+
+## Includes Twitter Bootstrap for Rails 3.1+ Asset Pipeline
+[Twitter Bootstrap](http://twitter.github.com/bootstrap/index.html) is a toolkit from Twitter designed to kickstart development of webapps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.
+
+## Includes Font Awesome for Rails 3.1+ Asset Pipeline
+[Font Awesome](http://fortawesome.github.io/Font-Awesome) is a toolkit with iconic fonts designed for use with Twitter Bootstrap.
+
+
+```css
+/*
+ *= require_self
+ *= require [theme_name]/loader
+ *= require font-awesome/font-awesome
+*/
+```
+
+If you need the ie7 fix:
+
+```css
+/*
+ *= require_self
+ *= require [theme_name]/loader
+ *= require font-awesome/font-awesome-ie7
+*/
+```
+
+## Demo
+
+The [demo](https://github.com/scottvrosenthal/twitter-bootswatch-rails-demo) will show you how this gem can be used in a rails 3.1+ application.
+
+![Demo Screen Shot](https://github.com/scottvrosenthal/twitter-bootswatch-rails-demo/raw/master/demo.png)
+
+## View Helpers
+The gem [twitter-bootswatch-rails-helpers](https://github.com/scottvrosenthal/twitter-bootswatch-rails-helpers) provides rails view helpers for twitter bootstrap's breadcrumbs and alerts components.
+
+
+## Install
+
+Include the [Twitter Bootswatch Rails gem](http://rubygems.org/gems/twitter-bootswatch-rails) in Gemfile to install it from [RubyGems.org](http://rubygems.org):
+
+```ruby
+group :assets do
+  # rails default gems
+  ...
+
+  # just put after rails asset defaults
+  gem 'twitter-bootswatch-rails', '~= 2.3.1.1'
+
+end
+
+# View Helpers Gem can go outside the assets group
+gem 'twitter-bootswatch-rails-helpers', '>= 2.3.1'
+```
+
+or you can install from latest build;
+
+```ruby
+gem 'twitter-bootswatch-rails', :git => 'git://github.com/scottvrosenthal/twitter-bootswatch-rails.git'
+```
+
+Run bundle from command line
+
+    bundle
+
+
+## Installing to App (using Generators)
+
+You can run the following generators to get started with Twitter Bootstrap & Font Awesome quickly.
+
+
+If you don't provide a [theme_name] the value defaults to **bootswatch** and adds directives to your application.css and application.js files.
+
+
+Usage:
+
+
+    rails g bootswatch:install [theme_name]
+
+Example:
+
+
+    rails g bootswatch:install admin
+    rails g bootswatch:install storefront
+
+***
+
+Layout (generates a basic Twitter Bootstrap compatible layout) - ([haml-rails](https://github.com/indirect/haml-rails) gem supported)
+
+
+Usage:
+
+
+    rails g bootswatch:layout [theme_name]
+
+
+Example:
+
+
+    rails g bootswatch:layout admin
+    rails g bootswatch:layout storefront
+
+***
+
+Themed (generates Twitter Bootstrap compatible scaffold views.) - ([simple_form](https://github.com/plataformatec/simple_form) and [haml-rails](https://github.com/indirect/haml-rails) gems supported)
+
+
+Usage (model and table must already exist):
+
+
+    rails g bootswatch:themed [RESOURCE_NAME]
+
+
+Example:
+
+
+    rails g scaffold Post title:string description:text
+    rake db:migrate
+    rails g bootswatch:themed Posts
+
+## Import a free [bootswatch.com](http://bootswatch.com/) theme
+
+### Just follow these three steps in the following order :)
+
+    rails g bootswatch:install cyborg
+    rails g bootswatch:import cyborg
+    rails g bootswatch:layout cyborg
+
+The above creates a namespaced theme under assets/javascript/cyborg assets/stylesheets/cyborg and a new layout file.
+
+The import generator pulls directly from the [bootswatch.com](http://bootswatch.com/) git repo [cyborg](https://github.com/thomaspark/bootswatch/tree/gh-pages/cyborg) directory.
+
+* bootswatch.less
+* variables.less
+
+In your rails controllers just tell it to use the cyborg layout.
+
+    layout: 'cyborg'
+
+You can also create an admin namespaced theme and import the cyborg bootswatch.less and variable.less files:
+
+    rails g bootswatch:install admin
+    rails g bootswatch:import admin/cyborg
+    rails g bootswatch:layout admin
+
+Need more examples? Check out the [demo](https://github.com/scottvrosenthal/twitter-bootswatch-rails-demo)
+
+## Using stylesheets with the [less-rails](https://github.com/metaskills/less-rails/) gem
+
+You have to require "[theme_name]/loader.css.less" in your application.css
+
+```css
+/*
+ *= require_self
+ *= require [theme_name]/loader
+ *= require font-awesome/font-awesome
+*/
+```
+
+"[theme_name]/loader.css.less" allows you to easily comment out less modules you don't need in your application.
+
+For instance, as per the [Twitter Bootstrap](http://twitter.github.io/bootstrap/scaffolding.html#responsive) project we don't include the responsive styles by default. Uncomment `@import "twitter/bootstrap/responsive";` in "[theme_name]/loader.css.less" to enable it.
+
+"[theme_name]/variables.less" customize Twitter Bootstrap "variables.less" defaults in this file.
+
+"[theme_name]/bootswatch.less" customize the style of Twitter Bootstrap base css and component style here.
+
+Check out some of the swatches at [bootswatch.com](http://bootswatch.com/)
+
+Read up on the [less-rails](https://github.com/metaskills/less-rails/) gem.
+
+***
+
+#### base.less
+
+When importing a custom bootswatch.less file manually you'll need to include the following import directive at the top of the file:
+
+```css
+@import "base";
+```
+
+The import base.less directive allows the importing less file to access and override inherited less variables.
+
+Example:
+
+```css
+@import "base";
+// Cyborg 2.3.1
+// bootswatch.less
+```
+
+## Using Javascripts
+
+You have to require the coffeescript file "[theme_name]/loader.coffee" in your application.js:
+
+```javascript
+//= require jquery
+//= require jquery_ujs
+//= require [theme_name]/loader
+```
+
+"[theme_name]/loader.coffee" allows you to easily comment out modules you don't need in your application:
+
+```coffee
+# [theme_name]/loader.coffee
+
+#= require twitter/bootstrap/bootstrap-transition
+#= require twitter/bootstrap/bootstrap-alert
+#= require twitter/bootstrap/bootstrap-button
+#= require twitter/bootstrap/bootstrap-carousel
+#= require twitter/bootstrap/bootstrap-collapse
+#= require twitter/bootstrap/bootstrap-dropdown
+#= require twitter/bootstrap/bootstrap-modal
+#= require twitter/bootstrap/bootstrap-tooltip
+#= require twitter/bootstrap/bootstrap-popover
+#= require twitter/bootstrap/bootstrap-scrollspy
+#= require twitter/bootstrap/bootstrap-tab
+#= require twitter/bootstrap/bootstrap-typeahead
+#= require twitter/bootstrap/bootstrap-affix
+
+
+#= require [theme_name]/bootswatch
+```
+
+"[theme_name]/bootswatch.coffee" allows you to easily add swatch customization to javascript modules loaded:
+
+Check out some of the swatches at [bootswatch.com](http://bootswatch.com/)
+
+### Responsive styling?
+As per the [Twitter Bootstrap](http://twitter.github.io/bootstrap/scaffolding.html#responsive) project we don't include the responsive styles by default. Uncomment `@import "twitter/bootstrap/responsive";` in "[theme_name]/loader.css.less" to enable it.
+
+### Local rails development assets not updating?
+
+```sh
+RAILS_ENV=development rake assets:clean
+```
+
+## Versioning
+Bootstrap [claims](https://github.com/twitter/bootstrap#versioning) to use SemVer, although this is for values of public API that don't seem to include selectively requiring CSS components (see breaking change 2.0.4 -> 2.1.0). Since many people using bootstrap-swatch-rails *do* selectively require CSS components and I consider it part of the public API we can't really follow SemVer without becoming wildly out of sync with the Bootstrap version number, which is confusing for everyone involved. Further releases to bootstrap-swatch-rails will therefore have version numbers of the form `2.x.x.y`, where `2.x.x` is the release of Bootstrap we should be compatible with, and `y` is the patch version.
+
+## Changelog
+  - v2.3.1.0
+    * Updated to bootstrap 2.3.1
+  - v2.3.1.1
+    * Added theme_name functionality, if a theme_name isn't passed in you get the default install, i.e, uses bootswatch as theme_name
+    * Included bootstrap version number at the top of each asset file created by generators
+    * Added Font Awesome to the asset pipeline as an opt in using an asset directive
+    * Added import generator to dynamically pull in free bootswatch.com themes and add correct import directives
+  - v2.3.1.2
+    * Updated gemspec docs
+    * Updated import generator to allow importing bootswatch.com themes under existing namespaced themes
+      * rails g bootswatch:import admin/cyborg

data/Rakefile

@@ -0,0 +1,57 @@
+#!/usr/bin/env rake
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Configure then bundle the gem"
+task :bundle do
+
+  sh 'bundle install'
+
+  ## begin bootstrap config ##
+
+  sh 'rm -f vendor/assets/images/twitter/bootstrap/*.png'
+  sh 'cp -f bootstrap/img/*.png vendor/assets/images/twitter/bootstrap'
+
+  sh 'rm -f vendor/assets/javascripts/twitter/bootstrap/*.js'
+  sh 'cp -f bootstrap/js/bootstrap-*.js vendor/assets/javascripts/twitter/bootstrap'
+
+  sh 'rm -f vendor/toolkit/twitter/bootstrap/*.less'
+  sh 'cp -f bootstrap/less/*.less vendor/toolkit/twitter/bootstrap'
+
+  sh 'thor setup:bootstrap_update_less_files_for_asset_pipeline'
+  sh 'thor setup:bootstrap_update_js_files_compilation_order'
+
+  sh 'cp -f vendor/toolkit/twitter/bootstrap/bootstrap.less lib/generators/bootswatch/install/templates/bootstrap.less'
+  sh 'cp -f vendor/toolkit/twitter/bootstrap/variables.less lib/generators/bootswatch/install/templates/variables.less.tt'
+  sh 'cp -f vendor/toolkit/twitter/bootstrap/mixins.less lib/generators/bootswatch/install/templates/mixins.less.tt'
+
+  sh 'thor setup:bootstrap_update_less_files_with_theme_info'
+
+  ## end bootstrap config ##
+
+  ## begin font-awesome config ##
+
+  sh 'rm -f vendor/assets/fonts/font-awesome/*.*'
+  sh 'cp -f font-awesome/font/*.* vendor/assets/fonts/font-awesome'
+
+  sh 'rm -f vendor/toolkit/font-awesome/*.less'
+  sh 'cp -f font-awesome/less/*.less vendor/toolkit/font-awesome'
+
+  sh 'thor setup:fontawesome_update_less_files_for_asset_pipeline'
+
+  ## end font-awesome config ##
+
+  sh 'gem build *.gemspec'
+  sh 'gem install *.gem'
+
+end
+
+task(:default).clear
+task :default => :bundle
+
+desc "Clean up files"
+task :clean do
+
+  sh 'rm *.gem'
+
+end

data/lib/generators/bootswatch/import/import_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators'
+
+module Bootswatch
+  module Generators
+    class ImportGenerator < ::Rails::Generators::NamedBase
+
+      def theme_name
+        file_name
+      end
+
+      def theme_directory
+        if class_path.empty?
+          theme_name
+        else
+          class_path.first
+        end
+      end
+
+      def theme_repo_url
+       "https://raw.github.com/thomaspark/bootswatch/gh-pages/#{theme_name}"
+      end
+
+      def import_less
+
+        stylesheets_dest_path = "app/assets/stylesheets/#{theme_directory}"
+        empty_directory stylesheets_dest_path
+
+        # let's auto backup if a custom variables.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'variables.less'))
+          File.rename(File.join(stylesheets_dest_path,'variables.less'), File.join(stylesheets_dest_path,'variables.less_bak'))
+        end
+
+        get File.join(theme_repo_url,'variables.less'), File.join(stylesheets_dest_path,'variables.less')
+
+        # let's auto backup if a custom bootswatch.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'bootswatch.less'))
+          File.rename(File.join(stylesheets_dest_path,'bootswatch.less'), File.join(stylesheets_dest_path,'bootswatch.less_bak'))
+        end
+
+        get File.join(theme_repo_url,'bootswatch.less'), File.join(stylesheets_dest_path,'bootswatch.less')
+
+        prepend_to_file File.join(stylesheets_dest_path,'bootswatch.less') do
+          "@import \"base\";\n"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/generators/bootswatch/install/install_generator.rb

@@ -0,0 +1,120 @@
+require 'rails/generators'
+
+module Bootswatch
+  module Generators
+    class InstallGenerator < ::Rails::Generators::NamedBase
+
+      DEFAULT_THEME_NAME='bootswatch'
+
+      argument :name, type: :string, default: DEFAULT_THEME_NAME,
+               desc: 'The theme name for this bootswatch'
+
+      # needed for thor templates
+      source_root File.expand_path("../templates", __FILE__)
+
+      def theme_name
+        file_name
+      end
+
+      def use_default_theme_name?
+        theme_name === DEFAULT_THEME_NAME
+      end
+
+      def theme_info
+        "#{use_default_theme_name? ? 'bootstrap'.capitalize : theme_name.capitalize} #{Twitter::Bootswatch::Rails::VERSION.chop.chop}"
+      end
+
+      def add_assets
+
+        if use_default_theme_name?
+          if File.exist?('app/assets/javascripts/application.js')
+            unless File.read('app/assets/javascripts/application.js').include?(theme_name)
+              insert_into_file "app/assets/javascripts/application.js",
+                             "//= require #{theme_name}/loader\n",
+                             :after => "jquery_ujs\n"
+            end
+          else
+            template 'application.js.tt', 'app/assets/stylesheets/application.js', {theme_name: theme_name, theme_info: theme_info}
+          end
+
+          if File.exist?('app/assets/stylesheets/application.css')
+            unless File.read('app/assets/stylesheets/application.css').include?(theme_name)
+              insert_into_file "app/assets/stylesheets/application.css",
+                             " *= require #{theme_name}/loader\n",
+                             :after => "require_self\n"
+            end
+
+            unless File.read('app/assets/stylesheets/application.css').include?('font-awesome')
+              insert_into_file "app/assets/stylesheets/application.css",
+                             " *= require font-awesome/font-awesome\n",
+                             :after => "*= require #{theme_name}/loader\n"
+            end
+
+          else
+            template 'application.css.tt', 'app/assets/stylesheets/application.css', {theme_name: theme_name, theme_info: theme_info}
+          end
+        else
+          template 'application.js.tt', "app/assets/javascripts/#{theme_name}.js", {theme_name: theme_name, theme_info: theme_info}
+          template 'application.css.tt', "app/assets/stylesheets/#{theme_name}.css", {theme_name: theme_name, theme_info: theme_info}
+        end
+
+      end
+
+      def add_javascripts
+
+        javascripts_dest_path = "app/assets/javascripts/#{theme_name}"
+        empty_directory javascripts_dest_path
+
+        template 'loader.coffee.tt', File.join(javascripts_dest_path,'loader.coffee'), {theme_name: theme_name, theme_info: theme_info}
+
+         # let's auto backup if a custom bootswatch.coffee already exists
+        if File.exist?(File.join(javascripts_dest_path,'bootswatch.coffee'))
+          File.rename(File.join(javascripts_dest_path,'bootswatch.coffee'), File.join(javascripts_dest_path,'bootswatch.coffee_bak'))
+        end
+
+        template 'bootswatch.coffee.tt', File.join(javascripts_dest_path,'bootswatch.coffee'), {theme_name: theme_name, theme_info: theme_info}
+
+      end
+
+      def add_stylesheets
+
+        stylesheets_dest_path = "app/assets/stylesheets/#{theme_name}"
+        empty_directory stylesheets_dest_path
+
+        less_imports = File.read(find_in_source_paths('bootstrap.less')).scan(Less::Rails::ImportProcessor::IMPORT_SCANNER).flatten.compact.uniq
+
+        # let's auto backup if a custom loader.css.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'loader.css.less'))
+          File.rename(File.join(stylesheets_dest_path,'loader.css.less'), File.join(stylesheets_dest_path,'loader.css.less_bak'))
+        end
+        template 'loader.css.less.tt', File.join(stylesheets_dest_path,'loader.css.less'), {less_imports: less_imports, theme_name: theme_name, theme_info: theme_info}
+
+        # let's auto backup if a custom variables.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'variables.less'))
+          File.rename(File.join(stylesheets_dest_path,'variables.less'), File.join(stylesheets_dest_path,'variables.less_bak'))
+        end
+        template 'variables.less.tt', File.join(stylesheets_dest_path,'variables.less'), {theme_name: theme_name, theme_info: theme_info}
+
+        # let's auto backup if a custom mixins.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'mixins.less'))
+          File.rename(File.join(stylesheets_dest_path,'mixins.less'), File.join(stylesheets_dest_path,'mixins.less_bak'))
+        end
+        template 'mixins.less.tt', File.join(stylesheets_dest_path,'mixins.less'), {theme_name: theme_name, theme_info: theme_info}
+
+        # let's auto backup if a custom bootswatch.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'bootswatch.less'))
+          File.rename(File.join(stylesheets_dest_path,'bootswatch.less'), File.join(stylesheets_dest_path,'bootswatch.less_bak'))
+        end
+        template 'bootswatch.less.tt', File.join(stylesheets_dest_path,'bootswatch.less'), {theme_name: theme_name, theme_info: theme_info}
+
+        # let's auto backup if a custom base.less already exists
+        if File.exist?(File.join(stylesheets_dest_path,'base.less'))
+          File.rename(File.join(stylesheets_dest_path,'base.less'), File.join(stylesheets_dest_path,'base.less_bak'))
+        end
+        template 'base.less.tt', File.join(stylesheets_dest_path,'base.less'), {theme_name: theme_name, theme_info: theme_info}
+
+      end
+
+    end
+  end
+end