bootstrap_leather 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWMyNjI5ZGY0ZjBiYTgyNGZmYmU4ZTdiYTE5ODM0OGZlZDYyYjFkZQ==
+  data.tar.gz: !binary |-
+    ZmI1OTY1NzNiYzRkZGFhMWRjYWEzOTgxZWI4NDVmNTU4NGQxNTdhMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjgwMDQwMWVkODE1MjQyY2E3NjA0MTYzNGQzMGNiZTVkOTE3YjU4NWRiNDBm
+    NDY4MjVmMjM4NDk4OTgxZTdiMWFlNjhiMGY2MTc4Zjg0NWI5ZThkNWI4NTk2
+    MTY3OWJiZTI4NjJiZDljNzE3Yzc1Njg2OTVjODIyMjVjNWNhMjQ=
+  data.tar.gz: !binary |-
+    ZTliNDMyY2FkNTVmNmJmZDEwOWIyYWUzZmEwZDEwYmFiNjgzNTdmMTZkNmRm
+    MmViOWEwYWIyZWZiMTMzMjhmZTdjMmI5M2JkNzk3MTRmZWJjYzVlMDhhZGQ4
+    NTk1NjI3YjRiOTNjNDQ5YTBjN2VkMTRjMjliYTNiYmFjOTc0NjE=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,21 @@
+source 'http://rubygems.org'
+# Add dependencies required to use your gem here.
+# Example:
+#   gem 'activesupport', '>= 2.3.5'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development, :test do
+  gem 'rspec'
+  gem 'shoulda-matchers'
+  gem 'capybara'
+  gem 'rdoc'
+  gem 'bundler'
+  gem 'jeweler'
+  gem 'puma'
+  gem 'customizable_bootstrap'
+  gem 'jquery-rails'
+end
+
+gem 'rails'
+gem 'haml'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Sour Cherry Web
+
+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.rdoc

@@ -0,0 +1,175 @@
+= BootstrapLeather
+
+BootstrapLeather is a collection of view helpers that makes it easier to create apps using Twitter Bootstrap.
+
+== Installation
+
+Install the gem
+    gem 'bootstrap_leather'
+    bundle install
+
+You will need to install bootstrap as a separate gem.  I recommend my own customizable_bootstrap gem, which makes use of boostrap-sass as a backend, but provides a set of files to make modifying it easier.
+
+== Usage Examples
+
+=== SEO tools for head and body alike: Title, Keywords, Description, Oh My!
+
+In your view, assuming your model implements the given methods on the Item model (otherwise, omit):
+
+    - add_title @item.title
+
+    - add_keywords @item.keywords
+
+    - add_description @item.description
+
+    - add_head_css do
+      = @item.css
+
+    - add_footer_javascript do
+      = @item.javascript
+
+In your layout:
+    %head
+      = render_title          # For the title tag, including SEO content
+      = render_keywords       # Defaults to what you put in the config file
+      = render_description    # Can be hooked up within a mountable rails engine, too.
+      = responsive_meta_tag   # If you're using the responsive features, you need this in your head
+
+      <...>
+
+      = render_head_css
+
+    %body
+      <...>
+
+      .container
+        = render_h1         # For the h1 tag containing the title alone
+
+      <...>
+
+      %footer
+        = render_footer_javascript
+
+=== Hero Units
+
+To tell a view to add a hero unit, do:
+    - add_hero_unit do
+      %h1 This is a Hero Unit.
+      %p This is its description paragraph, which isn't very clever but at least it's not lorem ipsum.
+
+Then put one of these somewhere in your layout:
+    = render_hero_unit
+
+=== Alerts
+
+To get all alerts, do:
+    = alert_flash_messages
+
+To create one alert, do:
+    = alert 'alert-info', 'The message you want to alert with goes here.'
+
+=== Widgets
+
+To add a widget in any of your views:
+    - add_widget do
+      %h3 A widget is...
+      %p  Not a bootstrap concept, but useful all the same.
+
+To render the ones you have saved up:
+    = render_widgets
+
+=== Modals
+    = modal 'Title of the modal here.' do
+      %p Lorem ipsum, baby.
+
+=== Badges and Labels
+    = badge '25'
+    = label 'unread'
+
+=== Icons
+    = icon 'check'
+
+=== Navbars
+For a wide navbar, try this:
+
+    = navbar_with_container :class => 'navbar-static-top navbar-inverse' do
+      = nav_list do
+        = dropdown_nav_item 'Lorem', '#' do
+          = nav_item 'Ipsum', '#'
+          = nav_item 'Dolor', '#'
+          = nav_item 'Sit', '#'
+        = nav_item 'Ipsum', '#'
+        = nav_item 'Dolor', '#'
+        = nav_item 'Sit', '#'
+      = nav_list :class => 'pull-right' do
+        = nav_item 'Amet', '#', :data => {:toggle => 'modal', :target => '#modal'}
+
+or for a narrow one:
+
+    = navbar_in_container :class => 'navbar-static-top navbar-inverse' do
+      = nav_list do
+        = dropdown_nav_item 'Lorem', '#' do
+          = nav_item 'Ipsum', '#'
+          = nav_item 'Dolor', '#'
+          = nav_item 'Sit', '#'
+        = nav_item 'Ipsum', '#'
+        = nav_item 'Dolor', '#'
+        = nav_item 'Sit', '#'
+      = nav_list :class => 'pull-right' do
+        = nav_item 'Amet', '#'
+
+=== Nav List
+    = nav_list :class => 'nav-pills' do
+        = nav_item 'Ipsum', '#'
+        = nav_item 'Dolor', '#'
+        = nav_item 'Sit', '#'
+
+=== Tabs
+
+First, add them all, then render them.
+    - add_tab 'First Tab' do
+      %p Tab contents go inside.
+    - add_tab 'Second Tab' do
+      %p Tab contents go inside here too.
+    - add_tab 'Third Tab' do
+      %p Yep, tab contents go inside.
+    = render_tabs 'left'
+
+=== Thumbnail
+
+    = thumbnail link_to image_tag(image_url), path
+
+== Great Bootstrap functionality outside the scope of this gem
+
+The following are not covered because there are already so many wonderful resources providing this functionality.
+
+* Bootstrap itself (I use my customizable_bootstrap, which is powered by bootstrap-sass, but you can use anything)
+    * Consider the possibilities:
+        * Any form of Bootstrap for Rails you want.
+            * Less
+            * Sass
+        * A themed bootstrap replacement:
+            * Kickstrap
+            * Bootswatch
+        * A theme generated on the fly:
+            * Bootstrap ThemeRoller
+            * Bootstrap Magic
+* Jquery UI theme for bootstrap (I use jquery-ui-bootstrap-rails-asset)
+* Forms (I recommend bootstrap_forms)
+* Breadcrumb generation (try breadcrumbs_on_rails)
+* Pagination (Try my bootstrap_pager)
+
+== Contributing to BootstrapLeather
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Sour Cherry Web. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "bootstrap_leather"
+  gem.homepage = "http://github.com/nerakdon/bootstrap_leather"
+  gem.license = "MIT"
+  gem.summary = %Q{BootstrapLeather makes it easier to create apps using Twitter Bootstrap}
+  gem.description = %Q{BootstrapLeather is a collection of view helpers that makes it easier to create apps using Twitter Bootstrap}
+  gem.email = "webmaster@sourcherryweb.com"
+  gem.authors = ["Karen Lundgren"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bootstrap_leather #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/helpers/bootstrap_leather_helper.rb

@@ -0,0 +1,158 @@
+module BootstrapLeatherHelper
+
+  def add_title(title)
+    @title = title
+  end
+
+  def add_description(description)
+    @description = description
+  end
+
+  def add_keywords(keywords)
+    @keywords = keywords
+  end
+
+  def add_head_css(&block)
+    content_for :head_css, &block
+  end
+
+  def add_footer_javascript(&block)
+    content_for :footer_javascript, &block
+  end
+
+  def render_keywords
+    tag :meta, :name => :keywords, :content => @keywords || BootstrapLeather.configuration.application_keywords
+  end
+
+  def render_description
+    tag :meta, :name => :description, :content => @description || BootstrapLeather.configuration.application_keywords
+  end
+
+  def render_title
+    page_title = []
+    page_title << @title
+    page_title << BootstrapLeather.configuration.application_title
+    page_title << @keywords
+    content_tag :title, page_title.compact.join(': ')
+  end
+
+  def render_h1(html_options = {})
+    content_tag :h1, @title, html_options
+  end
+
+  def responsive_meta_tag
+    tag :meta, :name => :viewport, :content => 'width=device-width, initial-scale=1.0'
+  end
+
+  def flash_class(level)
+    case level
+      when :notice then 'alert-info'
+      when :error then 'alert-error'
+      when :alert then 'alert-warning'
+    end
+  end
+
+  def alert_flash_messages(html_options = {})
+    render(:partial => 'bootstrap_leather/alert_flash_messages', :locals => {:html_options => html_options})
+  end
+
+  def modal(title = '', close_text = 'Close', html_options = {}, &block)
+    render(:partial => 'bootstrap_leather/modal', :locals => {:close_text => close_text, :title => title, :block => capture(&block), :html_options => html_options})
+  end
+
+  def nav_item(text, href, options = {})
+    render(:partial => 'bootstrap_leather/nav_item', :locals => {:text => text, :href => href, :options => options})
+  end
+
+  def nav_list(html_options = {}, &block)
+    render(:partial => 'bootstrap_leather/nav_list', :locals => {:block => capture(&block), :html_options => html_options})
+  end
+
+  def navbar(html_options = {}, &block)
+    render(:partial => 'bootstrap_leather/navbar', :locals => {:block => capture(&block), :html_options => html_options})
+  end
+
+  def navbar_with_container(html_options = {}, &block)
+    render(:partial => 'bootstrap_leather/navbar_with_container', :locals => {:block => capture(&block), :html_options => html_options})
+  end
+
+  def navbar_in_container(html_options = {}, &block)
+    render(:partial => 'bootstrap_leather/navbar_in_container', :locals => {:block => capture(&block), :html_options => html_options})
+  end
+
+  def add_widget(html_options = {}, &block)
+    content_for :widgets do
+      render(:partial => 'bootstrap_leather/widget', :locals => {:block => capture(&block), :html_options => html_options})
+    end
+  end
+
+  def add_hero_unit(&block)
+    content_for :hero_unit, &block
+  end
+
+  def dropdown_nav_item(text, href, active = false, &block)
+    render(:partial => 'bootstrap_leather/dropdown_nav_item', :locals => {:block => capture(&block), :text => text, :href => href, :active => active})
+  end
+
+  def add_tab(label, id, args = {}, &block)
+    active = false
+    if @tabs.nil?
+      @tabs = []
+      active = true
+    end
+    before_link = args[:before_link] ? args[:before_link] : ''
+    @tabs << {:id => id, :label => label, :active => active, :before_link =>before_link, :content => capture(&block)}
+  end
+
+  def render_tabs(orientation = 'top')
+    html = render(:partial => 'bootstrap_leather/tabs', :locals => {:tabs => @tabs, :orientation => orientation})
+    @tabs = nil
+    html.html_safe
+  end
+
+  def badge(content, type)
+    render(:partial => 'bootstrap_leather/badge', :locals => {:content => content, :type => type})
+  end
+
+  def thumbnail(content = '', &block)
+    render(:partial => 'bootstrap_leather/thumbnail', :locals => {:content => content ? content : capture(&block)})
+  end
+
+  def icon(type)
+    render(:partial => 'bootstrap_leather/icon', :locals => {:type => type})
+  end
+
+  def alert(css_class, title, message = nil)
+    render(:partial => 'bootstrap_leather/alert', :locals => {:css_class => css_class, :title => title, :message => message})
+  end
+
+  def error_messages(object)
+    if object.try(:errors) and object.errors.full_messages.any?
+      title = I18n.t('bootstrap_forms.errors.header', :model => object.class.model_name.human.downcase)
+      message = render(:partial => 'layouts/list', :locals => {:items => object.errors.full_messages.map})
+      alert('alert-error', title, message).html_safe
+    else
+      '' # return empty string
+    end
+  end
+
+  def render_widgets
+    render(:partial => 'bootstrap_leather/widgets')
+  end
+
+  def render_hero_unit
+    render(:partial => 'bootstrap_leather/hero_unit')
+  end
+
+  def render_head_css
+    render(:partial => 'bootstrap_leather/head_css')
+  end
+
+  def render_footer_javascript
+    render(:partial => 'bootstrap_leather/footer_javascript')
+  end
+
+  alias_method :nav_bar, :navbar
+  alias_method :nav_bar_in_container, :navbar_in_container
+  alias_method :nav_bar_with_container, :navbar_with_container
+end