bootstrap_leather 0.9.4 → 0.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7f36e23966b028cb88a16cc8f840671072ed11e
-  data.tar.gz: ba564ac05908bb49822c7cd8fb68f80a16013100
+  metadata.gz: 335cfc7ce18e6d988f758473bd419de3570a9bcb
+  data.tar.gz: fa6f427d35a840643596e2a42182b3b4314564cb
 SHA512:
-  metadata.gz: a484565a2600f908edb51a1e4887210c1c2fd6d04649233111bef14c8f669ea662b7cb2676b1729fb350fc492d2028adefbb5f3cb46b114acc5289acf8edea42
-  data.tar.gz: 1b1c28b4f7b1b4c099690eac9af774b1a9965c6f21ee9d5150d206794d89e4e1256bc5b80e54656df437b544b176ec124c050c06c849e831bbd53e64bcf3264b
+  metadata.gz: f0a4b2b9cf185d0f5909716edb93304934054711a8395cf7cbe67f63215952b74dcf58a9a9ae94531e807b697aaad70d33c34777758ce113b56d40da2bcb6a82
+  data.tar.gz: d8e3ccc4c471eb7096c906316b5d21806a627d3350e0a97a75e871a1970a0a8fa26fee9c18b778b4aa47d511ffd89c16c9bb6a8e13498a505df665b4405524b1

data/.rspec

@@ -1 +1,2 @@
 --color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,23 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 2.3.1
+  DisplayCopNames: true
+  Exclude:
+    - bootstrap_leather.gemspec
+    - spec/dummy/db/schema.rb
+    - spec/dummy/db/migrate/*
+
+Metrics/BlockLength:
+  Exclude:
+    - config/routes.rb
+    - spec/*
+    - spec/*/*
+    - spec/*/*/*
+    - spec/dummy/db/seeds/*
+
+Metrics/ModuleLength:
+  Exclude:
+    - spec/*
+    - spec/*/*
+    - spec/*/*/*

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-04-06 19:45:20 -0600 using RuboCop version 0.48.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 302

data/.ruby-gemset

@@ -1 +1 @@
-bootstrap_leather
+bootstrap_leather

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.4.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.1
+  - 2.4.0
+  - 2.4.1

data/Gemfile

@@ -1,9 +1,42 @@
-source 'http://rubygems.org'
-# Add dependencies required to use your gem here.
-# Example:
-#   gem 'activesupport', '>= 2.3.5'
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
-gem 'bootstrap-sass', '>= 3.1', '< 4'
 gem 'rails', '>= 4', '< 6'
-gem 'haml', '~> 4'
-gem 'jeweler', '~> 2'
+gem 'rails-i18n', '>= 4', '< 6'
+
+gem 'haml-rails', '~> 0.9'
+gem 'jquery-rails', '~> 4'
+
+gem 'bootstrap_form', '~> 2'
+
+group :development do
+  gem 'bundler', '~> 1.0'
+  gem 'juwelier', '~> 2'
+  gem 'rspec', '~> 3.5.0'
+  gem 'rubocop', '>= 0.48', require: false
+end
+
+group :development, :test do
+  gem 'bootstrap-sass', '~> 3.3'
+  gem 'byebug', '~> 9'
+  gem 'factory_girl_rails', '~> 4.5'
+  gem 'faker', '~> 1.4'
+  gem 'high_voltage', '~> 3'
+  gem 'rspec-its', '>= 1'
+  gem 'rspec-rails', '~> 3.5'
+  gem 'seedbank', '~> 0.3'
+  gem 'sqlite3', '~> 1.3'
+end
+
+group :test do
+  gem 'capybara', '~> 2.4'
+  gem 'coveralls', '~> 0.8', require: false
+  gem 'database_cleaner', '~> 1.4'
+  gem 'launchy', '~> 2', require: false
+  gem 'poltergeist', '~> 1.14'
+  gem 'rails-controller-testing', '~> 1.0'
+  gem 'rspec-collection_matchers', '>= 1'
+  gem 'rspec-html-matchers', '~> 0.7'
+  gem 'shoulda-matchers', '>= 2.8', '< 3.2'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2015 Gem Vein
+Copyright (c) 2017 Karen Lundgren
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,260 @@
+# BootstrapLeather
+Updated for Rails 5
+
+[![Gem Version](https://badge.fury.io/rb/bootstrap_leather.svg)](https://badge.fury.io/rb/bootstrap_leather)
+[![Build Status](https://travis-ci.org/gemvein/bootstrap_leather.svg?branch=master)](https://travis-ci.org/gemvein/bootstrap_leather)
+[![Coverage Status](https://coveralls.io/repos/github/gemvein/bootstrap_leather/badge.svg)](https://coveralls.io/github/gemvein/bootstrap_leather)
+
+BootstrapLeather is a collection of view helpers that makes it easier to create apps using Twitter Bootstrap.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bootstrap_leather'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bootstrap_leather
+```
+You will need to install bootstrap as a separate gem or include the css yourself.
+
+To install a default initializer:
+
+```bash
+$ rails g bootstrap_leather:install
+```
+
+## Usage
+
+Give your views access to the helpers with:
+
+```ruby
+class ApplicationController < ActionController::Base
+  helper BootstrapLeather::ApplicationHelper
+end
+```
+
+### SEO tools for head and body: Title, Keywords, Description
+
+In your view, assuming your model implements the given methods on the Item model (otherwise, omit):
+
+```haml
+- 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:
+```haml
+%html
+  %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_page_header         # For the h1 tag containing the title and subtitle
+      = yield
+  
+      <...>
+  
+    %footer
+    = render_footer_javascript
+```
+
+### Hero Units
+
+To tell a view to add a hero unit, do:
+
+```haml
+- 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:
+
+```haml
+= render_hero_unit
+```
+
+### Alerts
+
+To get all alerts, do:
+
+```haml
+= alert_flash_messages
+``` 
+
+To create one alert, do:
+
+```haml
+= alert 'info', 'The message you want to alert with goes here.'
+```
+
+### Widgets
+
+To add a widget in any of your views:
+
+```haml
+- 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:
+```haml
+= render_widgets 'md', 3
+```
+
+### Modals
+```haml
+= modal 'css-id', 'Title of the modal here.' do
+  %p Lorem ipsum, baby.
+```
+
+### Badges and Labels
+```haml
+= badge '25'
+= label 'unread'
+```
+
+### Icons
+```haml
+= icon 'check'
+= icon_link_to 'check', 'Link Text', link_path
+= icon_button_to 'success', 'check', 'Link Text', link_path
+```
+
+### Navbars
+
+:container_mode is optional and defaults to :none.  Can be one of: [:none, :inside, :outside]
+
+For a wide navbar, try this:
+
+```haml
+= navbar :container_mode => :outside, :class => '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 => 'navbar-right' do
+    = nav_item 'Amet', '#', :data => {:toggle => 'modal', :target => '#modal'}
+```
+    
+
+### Nav List
+```haml
+= nav_list :class => 'nav-pills' do
+  = nav_item 'Ipsum', '#'
+  = nav_item 'Dolor', '#'
+  = nav_item 'Sit', '#'
+```
+
+### Tabs
+
+First, add them all:
+
+```haml
+- add_tab 'First Tab', 'first-tab' do
+  %p Tab contents go inside.
+- add_tab 'Second Tab', 'second-tab' do
+  %p Tab contents go inside here too.
+- add_tab 'Third Tab', 'third-tab' do
+  %p Yep, tab contents go inside.
+```
+      
+Then render them.
+
+```haml
+= render_tabs 'left'
+```
+
+### Carousel
+
+Pass in an id string, items and a block for each slide:
+
+```haml
+= carousel 'css-id-for-carousel', @items do |item|
+  .carousel-caption
+    %h3= item.title
+    %p= item.description
+  = image_tag item.image.url(:large)
+```
+
+### Carousel with Thumbnails
+
+Pass in an id string, items and a block for each slide:
+```haml
+= carousel_with_thumbnails 'css-id-for-carousel', @items do |item|
+  .carousel-caption
+    %h3= item.title
+    %p= item.description
+  = image_tag item.image.url(:large), data: { thumbnail: item.image.url(:thumb) }
+```
+
+### Thumbnail
+
+```haml
+= thumbnail link_to image_tag(image_url), path
+```
+
+### Definition Lists
+
+```haml
+= dl hash_of_terms_and_definitions_or_definition_arrays
+```
+
+## 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 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_form)
+* Breadcrumb generation (try breadcrumbs_on_rails)
+
+## Contributing
+* 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.
+
+
+## License
+
+Copyright (c) 2013-2017 [Gem Vein](https://www.gemvein.com/). The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). See LICENSE.txt for further details.

data/Rakefile

@@ -1,26 +1,41 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-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
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 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://www.gemvein.com/museum/cases/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 = "karen.e.lundgren@gmail.com"
-  gem.authors = ["Karen Lundgren"]
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+# load 'rails/tasks/engine.rake'
+#
+# load 'rails/tasks/statistics.rake'
+#
+# require 'bundler/gem_tasks'
+
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification...
+  # see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = 'bootstrap_leather'
+  gem.homepage = 'http://www.gemvein.com/museum/cases/bootstrap_leather'
+  gem.license = 'MIT'
+  gem.summary = %(BootstrapLeather helps create apps using Twitter Bootstrap)
+  gem.description = 'BootstrapLeather is a collection of view helpers and '\
+    'scaffold generators that makes it easier to create apps using Twitter '\
+    'Bootstrap'
+  gem.email = 'karen.e.lundgren@gmail.com'
+  gem.authors = ['Karen Lundgren']
+  # gem.version = BootstrapLeather::VERSION
   # dependencies defined in Gemfile
 end
-Jeweler::RubygemsDotOrgTasks.new
+Juwelier::RubygemsDotOrgTasks.new
+
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/VERSION

@@ -1 +1 @@
-0.9.4
+0.10.4

data/app/helpers/bootstrap_leather/alerts_helper.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Alerts, i.e. messages at the top of the page, usually from flash
+  # or form errors
+  module AlertsHelper
+    def flash_class(level)
+      case level
+      when :notice then
+        'info'
+      when :error then
+        'danger'
+      when :alert then
+        'warning'
+      end
+    end
+
+    def alert(css_class, title, message = nil)
+      render(
+        partial: 'bootstrap_leather/alerts/alert',
+        locals: {
+          css_class: css_class,
+          title: title,
+          message: message
+        }
+      )
+    end
+
+    def alert_flash_messages(html_options = {})
+      render(
+        partial: 'bootstrap_leather/alerts/alert_flash_messages',
+        locals: { html_options: html_options }
+      )
+    end
+  end
+end

data/app/helpers/bootstrap_leather/application_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Main helper for BootstrapLeather
+  module ApplicationHelper
+    include HeadHelper
+    include FootHelper
+    include GridHelper
+    include NavigationHelper
+    include AlertsHelper
+    include WidgetsHelper
+    include ModalsHelper
+    include HeroUnitHelper
+    include TabsHelper
+    include BadgesHelper
+    include ThumbnailsHelper
+    include TypographyHelper
+    include IconsHelper
+    include CarouselsHelper
+  end
+end

data/app/helpers/bootstrap_leather/badges_helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Badges, i.e. tiny counts in a pill shape
+  module BadgesHelper
+    def badge_to(text, value, link, html_options = {})
+      html_options[:href] = url_for link
+      render(
+        partial: 'bootstrap_leather/badges/badge_to',
+        locals: { text: text, value: value, html_options: html_options }
+      )
+    end
+
+    def badge(content, type = nil)
+      render(
+        partial: 'bootstrap_leather/badges/badge',
+        locals: { content: content, type: type }
+      )
+    end
+  end
+end

data/app/helpers/bootstrap_leather/carousels_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Carousels, i.e. slideshows
+  module CarouselsHelper
+    def carousel(id, items, html_options = {}, &block)
+      html_options[:id] = id
+      html_options[:data] ||= {}
+      html_options[:data][:ride] = 'carousel'
+      render(
+        partial: 'bootstrap_leather/carousels/carousel',
+        locals: {
+          id: id, html_options: html_options,
+          slides: items.collect { |item| capture(item, &block) }
+        }
+      )
+    end
+
+    def carousel_with_thumbnails(id, items, html_options = {}, &block)
+      html_options[:id] = id
+      html_options[:data] ||= {}
+      html_options[:data][:ride] = 'carousel'
+      render(
+        partial: 'bootstrap_leather/carousels/carousel_with_thumbnails',
+        locals: {
+          id: id, html_options: html_options,
+          slides: items.collect { |item| capture(item, &block) }
+        }
+      )
+    end
+  end
+end

data/app/helpers/bootstrap_leather/foot_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Helpers to add things to the head (and foot) of the html document
+  module FootHelper
+    def add_footer_javascript(&block)
+      content_for :footer_javascript, &block
+    end
+
+    def render_footer_javascript
+      render(partial: 'bootstrap_leather/foot/footer_javascript')
+    end
+  end
+end

data/app/helpers/bootstrap_leather/grid_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Helpers to interact with the grid
+  module GridHelper
+    def column_class(device_class, column_width)
+      'col-' + device_class + '-' + column_width.to_s
+    end
+  end
+end

data/app/helpers/bootstrap_leather/head_helper.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Helpers to add things to the head (and foot) of the html document
+  module HeadHelper
+    def responsive_meta_tag
+      tag(
+        :meta,
+        name: :viewport,
+        content: 'width=device-width, initial-scale=1.0'
+      )
+    end
+
+    def add_title(title)
+      content_for :title, title
+    end
+
+    def add_subtitle(subtitle)
+      content_for :subtitle, subtitle
+    end
+
+    def render_title
+      page_title = []
+      page_title << content_for(:title)
+      page_title << content_for(:subtitle)
+      page_title << BootstrapLeather.configuration.application_title
+      page_title << content_for(:keywords)
+      content_tag :title, CGI.unescapeHTML(page_title.compact.join(': '))
+    end
+
+    def add_description(description)
+      content_for :description, description
+    end
+
+    def render_description
+      description = content_for(:description)
+      description ||= BootstrapLeather.configuration.application_description
+      tag(
+        :meta,
+        name: :description,
+        content: description
+      )
+    end
+
+    def add_keywords(keywords)
+      content_for :keywords, keywords
+    end
+
+    def render_keywords
+      keywords = content_for(:keywords)
+      keywords ||= BootstrapLeather.configuration.application_keywords
+      tag(
+        :meta,
+        name: :keywords,
+        content: keywords
+      )
+    end
+
+    def add_head_css(&block)
+      content_for :head_css, &block
+    end
+
+    def render_head_css
+      render(partial: 'bootstrap_leather/head/head_css')
+    end
+  end
+end

data/app/helpers/bootstrap_leather/hero_unit_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module BootstrapLeather
+  # Hero Unit, i.e. Jumbotron
+  module HeroUnitHelper
+    def add_hero_unit(&block)
+      content_for :hero_unit, &block
+    end
+
+    def render_hero_unit
+      render(partial: 'bootstrap_leather/hero_unit/hero_unit')
+    end
+  end
+end