hsc-twitter-bootstrap-rails 0.2.0

data/README.rdoc

@@ -0,0 +1,131 @@
+= Twitter Bootstrap for Rails 3.1 Asset Pipeline using Haml/Sass/Coffeescript
+
+{Twitter Bootstrap}[http://twitter.github.com/bootstrap/] is a design toolkit
+to kickstart the graphical part of webapps.
+
+hsc-twitter-bootstrap-rails integrates the toolkit with 
+{Ruby on Rails}[http://rubyonrails.org/]
+{Haml}[http://haml-lang.com/], {Sass}[http://sass-lang.com/] and
+{Coffeescript}[http://coffeescript.org/] and adds some generators.
+
+{<img src="https://secure.travis-ci.org/tvw/hsc-twitter-bootstrap-rails.png?branch=master" alt="Build Status" />}[http://travis-ci.org/tvw/hsc-twitter-bootstrap-rails]
+
+
+== Usage in your Ruby on Rails app
+
+
+=== Installing Gem
+
+Include Bootstrap in Gemfile:
+
+  gem "hsc-twitter-bootstrap-rails"
+
+Bundle it:
+
+  bundle install
+
+
+=== Select your preferred Sass style
+
+Select the your preferred sass-style in config/application.rb:
+
+  config.sass.preferred_syntax = :sass
+
+or 
+
+  config.sass.preferred_syntax = :scss
+
+where the last one is the default.
+
+
+=== Config Haml
+
+Add an initializer "config/initializers/haml.rb":
+
+  Haml::Template.options[:format] = :html5
+  Haml::Template.options[:attr_wrapper] = '"'
+
+
+=== Install the assets
+
+Remove the following files:
+
+   app/assets/javascripts/application.js
+   app/assets/stylesheets/application.css
+
+Install application.js.coffee and application.css.sass (or .scss):
+
+  rails g bootstrap:install
+
+
+== The Generators
+
+=== Layout
+
+To create a new haml layout:
+
+  rails g bootstrap:layout [LAYOUT_NAME] [*fixed or fluid]
+
+'LAYOUT_NAME' is the name of the layout. 'fixed' and 'fluid' is the style of
+the layout.
+
+Example:
+
+  rails g bootstrap:layout application fixed
+
+Make sure, that you do not have erb-versions of your layouts like
+'app/views/layouts/application.html.erb' since they will be preferred by
+rails.
+
+=== Themed
+
+Themed generates Twitter Bootstrap compatible scaffold views:
+
+  rails g bootstrap:themed [RESOURCE_NAME]
+
+Example:
+
+  rails g scaffold post title:string description:text
+  rake db:migrate
+  rails g bootstrap:themed posts
+
+
+If you want to modify the themed templates, you can install
+them into you local app directory:
+
+  rails g bootstrap:templates
+
+You will find them in 'lib/generators/bootstrap/themed/templates'.
+
+
+== Credits
+
+The main part of bringing Twitter Bootstrap to Sass is done by Christopher
+Cocchi-Perrier: {sass-twitter-bootstrap-rails}[https://github.com/ccocchi/sass-twitter-bootstrap-rails]
+
+hsc-twitter-bootstrap-rails depends on the sass-twitter-bootstrap-rails gem.
+
+
+== Author
+
+Thomas Volkmar Worm <mailto:tvw@s4r.de>
+
+
+== License
+
+Copyright (c) 2012 Thomas Volkmar Worm <mailto:tvw@s4r.de>
+
+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/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default do
+  sh %{bundle install}
+  sh %{rake build}
+  sh %{rake install}
+  rm_rf "pkg"
+end

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

@@ -0,0 +1,37 @@
+require 'rails/generators'
+
+module Bootstrap
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator installs Twitter Bootstrap to Asset Pipeline"
+
+      def add_stylesheets
+        ext = Rails.application.config.sass.preferred_syntax.to_s
+        if File.exist?("app/assets/stylesheets/application.css.#{ext}")
+          insert_into_file "app/assets/stylesheets/application.css.#{ext}", %Q{@import "twitter/bootstrap"\n}, :before => "@import"
+        else
+          copy_file "application.css.#{ext}", "app/assets/stylesheets/application.css.#{ext}"
+        end
+
+        if File.exist?("app/assets/stylesheets/application.css")
+          log "Please remove 'app/assets/stylesheets/application.css' to make #{ext}-file work."
+        end
+      end
+
+      def add_coffeescripts
+        if File.exist?("app/assets/javascripts/application.js.coffee")
+          insert_into_file "app/assets/javascripts/application.js.coffee", "//= require twitter/bootstrap\n", :after => "jquery_ujs\n"
+        else
+          copy_file "application.js.coffee", "app/assets/javascripts/application.js.coffee"
+        end
+
+        if File.exist?("app/assets/javascripts/application.js")
+          log "Please remove 'app/assets/javascripts/application.js' to make coffee-file work."
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/bootstrap/install/templates/application.css.sass

@@ -0,0 +1 @@
+@import "twitter/bootstrap"

data/lib/generators/bootstrap/install/templates/application.css.scss

@@ -0,0 +1 @@
+@import "twitter/bootstrap";

data/lib/generators/bootstrap/install/templates/application.js.coffee

@@ -0,0 +1,10 @@
+# This is a manifest file that'll be compiled into including all the files listed below.
+# Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+# be included in the compiled file accessible from http:##example.com/assets/application.js
+# It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+# the compiled file.
+#
+#= require jquery
+#= require jquery_ujs
+#= require twitter/bootstrap
+#= require_tree .

data/lib/generators/bootstrap/layout/layout_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module Bootstrap
+  module Generators
+    class LayoutGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator generates layout file with navigation."
+      argument :layout_name, :type => :string, :default => "application"
+      argument :layout_type, :type => :string, :default => "fixed",
+               :banner => "*fixed or fluid"
+
+      attr_reader :app_name, :container_class
+
+      def generate_layout
+        app = ::Rails.application
+        @app_name = app.class.to_s.split("::").first
+        @container_class = layout_type == "fluid" ? "container-fluid" : "container"
+        template "layout.html.haml", "app/views/layouts/#{layout_name}.html.haml"
+        if File.exists?("app/views/layouts/#{layout_name}.html.erb")
+          puts "Remove app/views/layouts/#{layout_name}.html.erb to make haml-layout work."
+        end
+      end
+    end
+  end
+end

data/lib/generators/bootstrap/layout/templates/layout.html.haml

@@ -0,0 +1,76 @@
+!!! 5
+%html{:lang => "en"}
+  %head
+    %meta{:charset => "utf-8"}/
+    %title= content_for?(:title) ? yield(:title) : "<%= app_name %>"
+    = csrf_meta_tags
+    / Le HTML5 shim, for IE6-8 support of HTML elements
+    /[if lt IE 9]
+      = javascript_include_tag "http://html5shim.googlecode.com/svn/trunk/html5.js"
+    / Le styles
+    :css
+      body {
+        padding-top: 60px; /* 60px to make the container go all the way to the bottom of the topbar */
+      }
+    = stylesheet_link_tag "application", :media => "all"
+    / Le fav and touch icons
+    %link{:href => "images/favicon.ico", :rel => "shortcut icon"}/
+    %link{:href => "images/apple-touch-icon.png", :rel => "apple-touch-icon"}/
+    %link{:href => "images/apple-touch-icon-72x72.png", :rel => "apple-touch-icon", :sizes => "72x72"}/
+    %link{:href => "images/apple-touch-icon-114x114.png", :rel => "apple-touch-icon", :sizes => "114x114"}/
+
+
+  %body
+    .navbar.navbar-fixed-top
+      .navbar-inner
+        <%- if layout_type == "fluid" -%>
+        .container-fluid
+        <%- else -%>
+        .container
+        <%- end -%>
+          %a.btn.btn-navbar{"data-target" => ".nav-collapse", "data-toggle" => "collapse"}
+            %span.icon-bar
+            %span.icon-bar
+            %span.icon-bar
+          %a.brand{:href => "#"}<%= app_name %>
+          .<%=container_class%>.nav-collapse
+            %ul.nav
+              %li= link_to "Link 1", "/path1"
+              %li= link_to "Link 2", "/path2"
+              %li= link_to "Link 3", "/path3"
+
+    .<%= container_class %>
+    <%- if layout_type == "fluid" -%>
+
+      .row-fluid
+        .span3
+          .well.sidebar-nav
+            %ul.nav.nav-list
+              %li.nav-header Sidebar
+              %li= link_to "Link 1", "/path1"
+              %li= link_to "Link 2", "/path2"
+              %li= link_to "Link 3", "/path3"
+        .span9
+          = yield
+    <% else %>
+      .content
+        .row
+          .span9
+            = yield
+          .span1 &nbsp;
+          .span3
+            .well.sidebar-nav
+              %h3 Sidebar
+              %ul.nav.nav-list
+                %li.nav-header Sidebar
+                %li= link_to "Link 1", "/path1"
+                %li= link_to "Link 2", "/path2"
+                %li= link_to "Link 3", "/path3"
+    <% end %>
+      %footer
+        %p &copy; Company 2012
+    /
+      Le javascript
+      \==================================================
+    / Placed at the end of the document so the pages load faster
+    = javascript_include_tag "application"

data/lib/generators/bootstrap/templates/templates_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+
+module Bootstrap
+  module Generators
+    class TemplatesGenerator < ::Rails::Generators::Base
+
+      def self.user_source_root
+        Rails.root.join("lib", "generators", "bootstrap", "themed", "templates")
+      end
+
+      source_root File.expand_path('../../themed/templates', __FILE__)
+      desc "This generator installs Twitter Bootstrap Themed templates to #{user_source_root}."
+
+      def add_templates
+
+        views = {
+          "index.html.haml"   => File.join(self.class.user_source_root, "index.html.haml"),
+          "new.html.haml"     => File.join(self.class.user_source_root, "new.html.haml"),
+          "edit.html.haml"    => File.join(self.class.user_source_root, "edit.html.haml"),
+          "_form.html.haml"   => File.join(self.class.user_source_root, "_form.html.haml"),
+          "show.html.haml"    => File.join(self.class.user_source_root, "show.html.haml")}
+
+        views.each do |template_name, output_path|
+          copy_file template_name, output_path
+        end
+      end
+
+    end
+  end
+end

data/lib/generators/bootstrap/themed/templates/_form.html.haml

@@ -0,0 +1,11 @@
+<%- columns.each do |column| -%>
+.clearfix
+  = f.label :<%= column.name %>, t("activerecord.attributes.<%= model_name.underscore %>.<%= column.name %>", :default => "<%= column.name.humanize %>"), :class => :label
+  .input
+    = f.<%= column.field_type %> :<%= column.name %>, :class => '<%= column.field_type %>'
+<%- end -%>
+
+.form-actions
+  %button{:class => "btn primary", :type => "submit"} Save
+  or
+  = link_to "Cancel", <%= controller_routing_path %>_path

data/lib/generators/bootstrap/themed/templates/edit.html.haml

@@ -0,0 +1,3 @@
+= form_for @<%= model_name.underscore  %>, :url => <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :html => { :class => "edit_<%= model_name.underscore  %>", :id => "edit_<%= model_name.underscore %>" } do |f|
+  %input{:name => "_method", :type => "hidden", :value =>"put"}
+  = render :partial => "form", :locals => {:f => f}

data/lib/generators/bootstrap/themed/templates/index.html.haml

@@ -0,0 +1,25 @@
+%h1 <%= resource_name.titleize %>s
+%table{:class => "table table-striped"}
+  %thead
+    %tr
+      %th ID
+      <%- unless columns.empty? -%>
+      %th
+        = t("activerecord.attributes.<%= singular_controller_routing_path %>.<%= columns.first.name %>", :default => t("activerecord.labels.<%= columns.first.name %>", :default => "<%= columns.first.name.capitalize %>"))
+      <%- end -%>
+      %th Created at
+      %th Actions
+  %tbody
+    - @<%= plural_resource_name %>.each do |<%= resource_name %>|
+      %tr
+        %td= <%= resource_name %>.id
+        <%- unless columns.empty? -%>
+        %td= link_to <%= resource_name %>.<%= columns.first.name %>, <%= singular_controller_routing_path %>_path(<%= resource_name %>)
+        <%- end -%>
+        %td= <%= resource_name %>.created_at
+        %td
+          = link_to "Show", <%= singular_controller_routing_path %>_path(<%= resource_name %>)
+          = link_to "Edit", edit_<%= singular_controller_routing_path %>_path(<%= resource_name %>)
+          = link_to "Destroy", <%= singular_controller_routing_path %>_path(<%= resource_name %>), :method => :delete, :confirm => "#{t("web-app-theme.confirm", :default => "Are you sure?")}"
+
+= link_to "New", new_<%= singular_controller_routing_path %>_path, :class => 'btn btn-primary'

data/lib/generators/bootstrap/themed/templates/new.html.haml

@@ -0,0 +1,2 @@
+= form_for @<%= model_name.underscore  %>, :url => <%= controller_routing_path %>_path, :html => { :class => :form } do |f|
+  = render :partial => "form", :locals => {:f => f}

data/lib/generators/bootstrap/themed/templates/show.html.haml

@@ -0,0 +1,9 @@
+<%- columns.each do |column| -%>
+%label{:class => "label"}= t("activerecord.attributes.<%= singular_controller_routing_path %>.<%= column.name %>", :default => t("activerecord.labels.<%= column.name %>", :default => "<%= column.name.humanize %>")) + ":"
+%p= @<%= resource_name %>.<%= column.name %>
+<%- end -%>
+
+.form-actions
+  = link_to "Back", <%= controller_routing_path %>_path, :class => 'btn'
+  = link_to "Edit", edit_<%= singular_controller_routing_path %>_path(@<%= resource_name %>), :class => 'btn'
+  = link_to "Delete", <%= singular_controller_routing_path %>_path(@<%= resource_name %>), :method => "delete", :confirm => "#{t("web-app-theme.confirm", :default => "Are you sure?")}", :class => 'btn'

data/lib/generators/bootstrap/themed/themed_generator.rb

@@ -0,0 +1,99 @@
+require 'rails/generators'
+require 'rails/generators/generated_attribute'
+
+module Bootstrap
+  module Generators
+    class ThemedGenerator < ::Rails::Generators::Base
+
+      user_source_root = Rails.root.join("lib", "generators", "bootstrap", "themed", "templates")
+      if File.exists?(user_source_root)
+        source_root user_source_root
+      else
+        source_root File.expand_path('../templates', __FILE__)
+      end
+
+      argument :controller_path,    :type => :string
+      argument :model_name,         :type => :string, :required => false
+      argument :layout,             :type => :string, :default => "application",
+                                    :banner => "Specify application layout"
+
+      def initialize(args, *options)
+        super(args, *options)
+        initialize_views_variables
+      end
+
+      def copy_views
+        generate_views
+      end
+
+      protected
+
+      def initialize_views_variables
+        @base_name, @controller_class_path, @controller_file_path, @controller_class_nesting, @controller_class_nesting_depth = extract_modules(controller_path)
+        @controller_routing_path = @controller_file_path.gsub(/\//, '_')
+        @model_name = @base_name.singularize unless @model_name
+        @model_name = @model_name.camelize
+      end
+
+      def controller_routing_path
+        @controller_routing_path
+      end
+
+      def singular_controller_routing_path
+        @controller_routing_path.singularize
+      end
+
+      def model_name
+        @model_name
+      end
+
+      def plural_model_name
+        @model_name.pluralize
+      end
+
+      def resource_name
+        @model_name.underscore
+      end
+
+      def plural_resource_name
+        resource_name.pluralize
+      end
+
+      def columns
+        begin
+          excluded_column_names = %w[id created_at updated_at]
+          Kernel.const_get(@model_name).columns.reject{|c| excluded_column_names.include?(c.name) }.collect{|c| ::Rails::Generators::GeneratedAttribute.new(c.name, c.type)}
+        rescue NoMethodError
+          Kernel.const_get(@model_name).fields.collect{|c| c[1]}.reject{|c| excluded_column_names.include?(c.name) }.collect{|c| ::Rails::Generators::GeneratedAttribute.new(c.name, c.type.to_s)}
+        end
+      end
+
+      def extract_modules(name)
+        modules = name.include?('/') ? name.split('/') : name.split('::')
+        name    = modules.pop
+        path    = modules.map { |m| m.underscore }
+        file_path = (path + [name.underscore]).join('/')
+        nesting = modules.map { |m| m.camelize }.join('::')
+        [name, path, file_path, nesting, modules.size]
+      end
+
+      def generate_views
+        views = {
+          "index.html.haml"   => File.join('app/views', @controller_file_path, "index.html.haml"),
+          "new.html.haml"     => File.join('app/views', @controller_file_path, "new.html.haml"),
+          "edit.html.haml"    => File.join('app/views', @controller_file_path, "edit.html.haml"),
+          "_form.html.haml"   => File.join('app/views', @controller_file_path, "_form.html.haml"),
+          "show.html.haml"    => File.join('app/views', @controller_file_path, "show.html.haml")}
+        selected_views = views
+        options.engine == generate_erb(selected_views)
+      end
+
+      def generate_erb(views)
+        views.each do |template_name, output_path|
+          template template_name, output_path
+        end
+      end
+
+    end
+  end
+end

data/lib/hsc-twitter-bootstrap-rails.rb

@@ -0,0 +1,3 @@
+require "haml-rails"
+require "sass-twitter-bootstrap-rails"
+require "hsc-twitter-bootstrap/rails"

data/lib/hsc-twitter-bootstrap/rails.rb

@@ -0,0 +1,6 @@
+module HSCTwitterBootstrap
+  module Rails
+    require 'hsc-twitter-bootstrap/rails/version'
+    require 'hsc-twitter-bootstrap/rails/engine'
+  end
+end

data/lib/hsc-twitter-bootstrap/rails/engine.rb

@@ -0,0 +1,6 @@
+module HSCTwitterBootstrap
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/hsc-twitter-bootstrap/rails/version.rb

@@ -0,0 +1,13 @@
+module HSCTwitterBootstrap
+  module Rails
+
+    module VERSION #:nodoc:
+      MAJOR = 0
+      MINOR = 2
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: hsc-twitter-bootstrap-rails
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Volkmar Worm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &9865680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9865680
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &9863600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9863600
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: &9862620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *9862620
+- !ruby/object:Gem::Dependency
+  name: sass-twitter-bootstrap-rails
+  requirement: &9861440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *9861440
+description: hsc-twitter-bootstrap-rails project integrates Bootstrap CSS toolkit
+  for Rails 3.1 Asset Pipeline using Haml, Sass and Coffeescript
+email:
+- tvw@s4r.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hsc-twitter-bootstrap/rails.rb
+- lib/hsc-twitter-bootstrap/rails/engine.rb
+- lib/hsc-twitter-bootstrap/rails/version.rb
+- lib/generators/bootstrap/install/install_generator.rb
+- lib/generators/bootstrap/install/templates/application.js.coffee
+- lib/generators/bootstrap/install/templates/application.css.scss
+- lib/generators/bootstrap/install/templates/application.css.sass
+- lib/generators/bootstrap/layout/templates/layout.html.haml
+- lib/generators/bootstrap/layout/layout_generator.rb
+- lib/generators/bootstrap/templates/templates_generator.rb
+- lib/generators/bootstrap/themed/templates/edit.html.haml
+- lib/generators/bootstrap/themed/templates/index.html.haml
+- lib/generators/bootstrap/themed/templates/show.html.haml
+- lib/generators/bootstrap/themed/templates/_form.html.haml
+- lib/generators/bootstrap/themed/templates/new.html.haml
+- lib/generators/bootstrap/themed/themed_generator.rb
+- lib/hsc-twitter-bootstrap-rails.rb
+- Rakefile
+- README.rdoc
+homepage: https://github.com/tvw/hsc-twitter-bootstrap-rails
+licenses: []
+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: hsc-twitter-bootstrap-rails
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Bootstrap CSS toolkit for Rails 3.1 Asset Pipeline using Haml, Sass and Coffeescript
+test_files: []