effective_style_guide 1.0.0

data/app/views/effective/style_guide/_form_vertical.html.haml

@@ -0,0 +1,36 @@
+= simple_form_for Effective::StyleGuide.new(), :url => '/' do |f|
+  = f.input :title, :hint => 'please enter a title (this is a standard text field)'
+  = f.input :email, :hint => 'please enter an email address (this is an email field)'
+  = f.input :password, :hint => 'please enter a password (this is a password field)'
+  - if defined?(EffectiveOrders)
+    = f.input :price, :as => :price, :hint => 'please enter a price (this is a price field from EffectiveOrders)'
+  = f.input :number, :hint => 'please enter a number (this is a number field)'
+  = f.input :range, :as => :range, :hint => 'please enter a number range (this is a range field)'
+  = f.input :category, :as => :select, :collection => 10.times.map { |x| "Category #{x}"}, :hint => 'please select a category (this is a select field)'
+  = f.input :drink, :as => :check_boxes, :wrapper => :vertical_inline_radio_and_checkboxes, :collection => ['Water', 'Tea', 'Coffee', 'Soda'], :hint => 'please select one or more drinks (this is a check_boxes :wrapper => :vertical_inline_radio_and_checkboxes field)'
+  = f.input :food, :as => :radio_buttons, :wrapper => :vertical_inline_radio_and_checkboxes, :collection => ['Pasta', 'Rice', 'Potato', 'Couscous'], :hint => 'please select one food (this is a radio_buttons :wrapper => :vertical_inline_radio_and_checkboxes field)'
+  = f.input :content, :hint => 'please enter a whole bunch of content (this is a textarea)'
+  = f.input :archived, :hint => 'please select true or false (this is a boolean field)'
+  = f.input :drink, :as => :check_boxes, :collection => ['Water', 'Tea', 'Coffee', 'Soda'], :hint => 'please select one or more drinks (this is a check_boxes field)'
+  = f.input :food, :as => :radio_buttons, :collection => ['Pasta', 'Rice', 'Potato', 'Couscous'], :hint => 'please select one food (this is a radio_buttons field)'
+  = f.button :submit
+
+%hr
+.inline-example Form Vertical Invalid State
+
+= simple_form_for Effective::StyleGuide.new().tap { |s| s.valid? }, :url => '/' do |f|
+  = f.input :title, :hint => 'please enter a title (this is a standard text field)'
+  = f.input :email, :hint => 'please enter an email address (this is an email field)'
+  = f.input :password, :hint => 'please enter a password (this is a password field)'
+  - if defined?(EffectiveOrders)
+    = f.input :price, :as => :price, :hint => 'please enter a price (this is a price field from EffectiveOrders)'
+  = f.input :number, :hint => 'please enter a number (this is a number field)'
+  = f.input :range, :as => :range, :hint => 'please enter a number range (this is a range field)'
+  = f.input :category, :as => :select, :collection => 10.times.map { |x| "Category #{x}"}, :hint => 'please select a category (this is a select field)'
+  = f.input :drink, :as => :check_boxes, :wrapper => :vertical_inline_radio_and_checkboxes, :collection => ['Water', 'Tea', 'Coffee', 'Soda'], :hint => 'please select one or more drinks (this is a check_boxes :wrapper => :vertical_inline_radio_and_checkboxes field)'
+  = f.input :food, :as => :radio_buttons, :wrapper => :vertical_inline_radio_and_checkboxes, :collection => ['Pasta', 'Rice', 'Potato', 'Couscous'], :hint => 'please select one food (this is a radio_buttons :wrapper => :vertical_inline_radio_and_checkboxes field)'
+  = f.input :content, :hint => 'please enter a whole bunch of content (this is a textarea)'
+  = f.input :archived, :hint => 'please select true or false (this is a boolean field)'
+  = f.input :drink, :as => :check_boxes, :collection => ['Water', 'Tea', 'Coffee', 'Soda'], :hint => 'please select one or more drinks (this is a check_boxes field)'
+  = f.input :food, :as => :radio_buttons, :collection => ['Pasta', 'Rice', 'Potato', 'Couscous'], :hint => 'please select one food (this is a radio_buttons field)'
+  = f.button :submit

data/app/views/effective/style_guide/_jumbotron.html.haml

@@ -0,0 +1,5 @@
+.jumbotron
+  %h1 Hello, world!
+  %p= Faker::Lorem.paragraph(3)
+  %p
+    %a.btn.btn-primary.btn-lg Learn More

data/app/views/effective/style_guide/_labels.html.haml

@@ -0,0 +1,37 @@
+- variations = ['Default', 'Primary', 'Success', 'Info', 'Warning', 'Danger']
+
+%h1
+  Example heading
+  %span.label.label-default New
+
+%h2
+  Example heading
+  %span.label.label-default New
+
+%h3
+  Example heading
+  %span.label.label-default New
+
+%h4
+  Example heading
+  %span.label.label-default New
+
+%h5
+  Example heading
+  %span.label.label-default New
+
+%h6
+  Example heading
+  %span.label.label-default New
+
+%br
+
+- variations.each do |variation|
+  %span.label{:class => "label-#{variation.downcase}"}= variation
+
+%br
+%br
+
+%a{:href => '#'}
+  Inbox
+  %span.badge 42

data/app/views/effective/style_guide/_list_groups.html.haml

@@ -0,0 +1,23 @@
+%ul.list-group
+  - 4.times do
+    %li.list-group-item= Faker::Lorem.sentence(1)
+
+%ul.list-group
+  - 4.times do
+    %li.list-group-item
+      %span.badge= [*1..20].sample
+      = Faker::Lorem.sentence(1)
+
+%ul.list-group
+  - 4.times do |x|
+    %a.list-group-item{:href => '#', :class => ('active' if x == 0)}= Faker::Lorem.sentence(1)
+
+%ul.list-group
+  - 4.times do |x|
+    %a.list-group-item{:href => '#', :class => ('disabled' if x == 0)}= Faker::Lorem.sentence(1)
+
+.list-group
+  - 4.times do |x|
+    %a.list-group-item{:href => '#', :class => ('active' if x == 1)}
+      %h4.list-group-item-heading= Faker::Lorem.sentence(1)
+      %p.list-group-item-text= Faker::Lorem.sentence(3)

data/app/views/effective/style_guide/_modals.html.haml

@@ -0,0 +1,69 @@
+%button.btn.btn-primary{'data-toggle' => 'modal', 'data-target' => '#modalStandard'} Open Standard Modal
+
+#modalStandard.modal.fade{:tabindex => -1, :role => 'dialog', 'aria-hidden' => true, 'arai-labelledby' => 'modalStandardLabel'}
+  .modal-dialog
+    .modal-content
+      .modal-header
+        %button.close{'data-dismiss' => 'modal'}
+          %span{'aria-hidden' => true} ×
+          %span.sr-only Close
+        %h4.modal-title{:id => 'modalStandardLabel'} Standard Modal Title
+      .modal-body
+        %h4 Text in a modal
+        %p= Faker::Lorem.paragraph(3)
+        %br
+
+        %h4 Tooltips in a standard modal
+        %p
+          This is a
+          %a{:href => '#', 'data-toggle' => 'tooltip', 'title' => 'This is a tooltip'} Link with Tooltip
+        %br
+
+        %h4 Overflowing text to show scroll behaviour
+        - 15.times do
+          %p= Faker::Lorem.paragraph(3)
+        %br
+
+      .modal-footer
+        %button.btn.btn-primary{:type => 'button'} Save Changes
+        %button.btn.btn-default{'data-dismiss' => 'modal'} Close
+
+
+%button.btn.btn-primary{'data-toggle' => 'modal', 'data-target' => '#modalLarge'} Open Large Modal
+
+#modalLarge.modal.fade{:tabindex => -1, :role => 'dialog', 'aria-hidden' => true, 'arai-labelledby' => 'modalLargeLabel'}
+  .modal-dialog.modal-lg
+    .modal-content
+      .modal-header
+        %button.close{'data-dismiss' => 'modal'}
+          %span{'aria-hidden' => true} ×
+          %span.sr-only Close
+        %h4.modal-title{:id => 'modalLargeLabel'} Large Modal Title
+      .modal-body
+        %h4 Text in a large modal
+        %p= Faker::Lorem.paragraph(3)
+        %br
+
+      .modal-footer
+        %button.btn.btn-primary{:type => 'button'} Save Changes
+        %button.btn.btn-default{'data-dismiss' => 'modal'} Close
+
+%button.btn.btn-primary{'data-toggle' => 'modal', 'data-target' => '#modalSmall'} Open Small Modal
+
+#modalSmall.modal.fade{:tabindex => -1, :role => 'dialog', 'aria-hidden' => true, 'arai-labelledby' => 'modalSmallLabel'}
+  .modal-dialog.modal-sm
+    .modal-content
+      .modal-header
+        %button.close{'data-dismiss' => 'modal'}
+          %span{'aria-hidden' => true} ×
+          %span.sr-only Close
+        %h4.modal-title{:id => 'modalSmallLabel'} Small Modal Title
+      .modal-body
+        %h4 Text in a small modal
+        %p= Faker::Lorem.paragraph(3)
+        %br
+
+      .modal-footer
+        %button.btn.btn-primary{:type => 'button'} Save Changes
+        %button.btn.btn-default{'data-dismiss' => 'modal'} Close
+

data/app/views/effective/style_guide/_navs.html.haml

@@ -0,0 +1,33 @@
+%p
+  %ul.nav.nav-tabs
+    %li.active= link_to 'First Item', '#'
+    %li= link_to 'Second Item', '#'
+    %li= link_to 'Third Item', '#'
+    %li.dropdown
+      %a.dropdown-toggle{'data-toggle' => 'dropdown', :href => '#'}
+        Dropdown
+        %span.caret
+      %ul.dropdown-menu{:role => 'menu'}
+        %li= link_to 'First', '#'
+        %li= link_to 'Second', '#'
+        %li= link_to 'Third', '#'
+        %li.divider
+        %li= link_to 'Separated', '#'
+
+%br
+
+%p
+  %ul.nav.nav-pills
+    %li= link_to 'First Item', '#'
+    %li= link_to 'Second Item', '#'
+    %li.active= link_to 'Third Item', '#'
+    %li.dropdown
+      %a.dropdown-toggle{'data-toggle' => 'dropdown', :href => '#'}
+        Dropdown
+        %span.caret
+      %ul.dropdown-menu{:role => 'menu'}
+        %li= link_to 'First', '#'
+        %li= link_to 'Second', '#'
+        %li= link_to 'Third', '#'
+        %li.divider
+        %li= link_to 'Separated', '#'

data/app/views/effective/style_guide/_pagination.html.haml

@@ -0,0 +1,38 @@
+%ul.pagination
+  %li.disabled
+    %a{:href => '#'} «
+  - 1.upto(10).each do |x|
+    %li{:class => ('active' if x == 1)}
+      %a{:href => '#'}= x
+  %li
+    %a{:href => '#'} »
+
+%ul.pagination.pagination-lg
+  %li
+    %a{:href => '#'} «
+  - 1.upto(10).each do |x|
+    %li
+      %a{:href => '#'}= x
+  %li
+    %a{:href => '#'} »
+
+%ul.pagination.pagination-sm
+  %li
+    %a{:href => '#'} «
+  - 1.upto(10).each do |x|
+    %li
+      %a{:href => '#'}= x
+  %li
+    %a{:href => '#'} »
+
+%ul.pager
+  %li
+    %a{:href => '#'} Previous
+  %li
+    %a{:href => '#'} Next
+
+%ul.pager
+  %li.previous
+    %a{:href => '#'} ← Older
+  %li.next
+    %a{:href => '#'} Newer →

data/app/views/effective/style_guide/_panels.html.haml

@@ -0,0 +1,36 @@
+- variations = ['Default', 'Primary', 'Success', 'Info', 'Warning', 'Danger']
+
+.panel.panel-default
+  .panel-body= Faker::Lorem.sentence(3)
+
+- variations.each do |variation|
+  .panel{:class => "panel-#{variation.downcase}"}
+    .panel-heading= "#{variation} Panel"
+    .panel-body= Faker::Lorem.sentence(3)
+
+.panel.panel-default
+  .panel-heading
+    %h3= Faker::Lorem.sentence(1)
+  .panel-body= Faker::Lorem.sentence(3)
+
+.panel.panel-default
+  .panel-body= Faker::Lorem.sentence(3)
+  .panel-footer= Faker::Lorem.sentence(1)
+
+
+.panel.panel-default
+  .panel-heading Table Panel (any non-bordered table will work here)
+  %table.table
+    %thead
+      %tr
+        %th #
+        %th First Name
+        %th Last Name
+        %th Email
+    %tbody
+      - 5.times do
+        %tr
+          %td= [*1..100].sample
+          %td= Faker::Name.first_name
+          %td= Faker::Name.last_name
+          %td= Faker::Internet.email

data/app/views/effective/style_guide/_progress_bars.html.haml

@@ -0,0 +1,30 @@
+- variations = ['Default', 'Primary', 'Success', 'Info', 'Warning', 'Danger']
+
+.progress
+  .progress-bar{:role => 'progressbar', 'aria-valuenow' => 40, 'aria-valuemin' => 0, 'aria-valuemax' => 100, :style => 'width: 40%'}
+    %span.sr-only 40% Complete
+
+.progress
+  .progress-bar{:role => 'progressbar', 'aria-valuenow' => 60, 'aria-valuemin' => 0, 'aria-valuemax' => 100, :style => 'width: 60%'}
+    60%
+
+.progress
+  .progress-bar{:role => 'progressbar', 'aria-valuenow' => 0, 'aria-valuemin' => 0, 'aria-valuemax' => 100}
+    0%
+
+.progress
+  .progress-bar{:role => 'progressbar', 'aria-valuenow' => 2, 'aria-valuemin' => 0, 'aria-valuemax' => 100, :style => 'width: 2%'}
+    2%
+
+- variations.last(4).each_with_index do |variation, index|
+  .progress
+    .progress-bar{:class => "progress-bar-#{variation.downcase}", :role => 'progressbar', 'aria-valuenow' => (index+2)*20, 'aria-valuemin' => 0, 'aria-valuemax' => 100, :style => "width: #{(index+2)*20}%"}
+      = "#{(index+2)*20}%"
+
+.progress
+  .progress-bar.progress-bar-striped.active{:role => 'progressbar', 'aria-valuenow' => 95, 'aria-valuemin' => 0, 'aria-valuemax' => 100, :style => "width: 95%"}
+
+.progress
+  - variations.last(4).each_with_index do |variation, index|
+    .progress-bar{:class => "progress-bar-#{variation.downcase}", :role => 'progressbar', 'aria-valuenow' => (index+1)*20, 'aria-valuemin' => 0, 'aria-valuemax' => 100, :style => "width: 22%"}
+

data/app/views/effective/style_guide/_tables.html.haml

@@ -0,0 +1,15 @@
+- [nil, 'table-hover', 'table-striped', 'table-bordered', 'table-condensed'].each do |variation|
+  %table.table{:class => variation}
+    %thead
+      %tr
+        %th #
+        %th First Name
+        %th Last Name
+        %th Email
+    %tbody
+      - 5.times do
+        %tr
+          %td= [*1..100].sample
+          %td= Faker::Name.first_name
+          %td= Faker::Name.last_name
+          %td= Faker::Internet.email

data/app/views/effective/style_guide/_thumbnails.html.haml

@@ -0,0 +1,17 @@
+.row
+  - 4.times do
+    .col-sm-3
+      %a.thumbnail{:href => '#'}
+        %img{:src => 'http://placekitten.com/171/180', :height => 180, :width => 171}
+
+.row
+  - 3.times do
+    .col-sm-4
+      .thumbnail
+        %img{:src => 'http://placekitten.com/242/200', :height => 200, :width => 242}
+        .caption
+          %h3 Thumbnail Label
+          %p Cumque iste repellat rerum asperiores libero. Omnis quia et illo. Dignissimos ut quod debitis.
+          %p
+            %a.btn.btn-primary Save
+            %a.btn.btn-default Cancel

data/app/views/effective/style_guide/_typography.html.haml

@@ -0,0 +1,20 @@
+%h1 Heading 1
+%h2 Heading 2
+%h3 Heading 3
+%h4 Heading 4
+%h5 Heading 5
+%h6 Heading 6
+%p
+  = 'Paragraph text. '
+  = Faker::Lorem.paragraph(8)
+%blockquote Blockquote text.
+%p
+  %strong Strong
+  = '-'
+  %em Emphasis
+  = '-'
+  %u Underline
+  = '-'
+  %small Small
+  = '-'
+  %a{:href => '#'} Link

data/app/views/effective/style_guide/_wells.html.haml

@@ -0,0 +1,3 @@
+.well Look, I'm in a well!
+.well.well-lg Look, I'm in a large well!
+.well.well-sm Look, I'm in a small well!

data/app/views/effective/style_guide/show.html.haml

@@ -0,0 +1,88 @@
+.row.effective-style-guide
+  .col-sm-3
+    %nav
+      %ul.nav.nav-pills.nav-stacked
+        - @partials.each_with_index do |partial, index|
+          %li{:class => ('active' if index == 0)}
+            %a{:href => "##{partial.parameterize}"}= partial.titleize
+
+  .col-sm-9
+    - @partials.each do |partial|
+      %div.example{:id => "#{partial.parameterize}"}
+        %span.example= partial.titleize
+        = render :partial => partial
+
+    - 10.times do
+      %br
+
+:javascript
+  var initStyleGuide = function() {
+    $('.effective-style-guide > div > nav').affix({
+      offset: { top: $('.effective-style-guide > div > nav').offset().top - 20 }
+    });
+
+    $('body').scrollspy({ target: '.effective-style-guide > div > nav', offset: 100 });
+
+    $('.effective-style-guide > div > nav > ul a').on('click', function(event) {
+      event.preventDefault();
+      target = $(event.currentTarget).attr('href')
+      if(target.length > 0) { $('html, body').scrollTop($(target).offset().top); }
+    });
+  };
+
+  $(document).ready(function() { initStyleGuide(); });
+  $(document).on('page:change', function() { initStyleGuide(); });
+
+:css
+  .effective-style-guide nav {
+    display: inline-block;
+  }
+
+  .effective-style-guide .nav > li > a {
+    padding: 5px 10px;
+  }
+
+  .effective-style-guide .affix {
+    position: fixed;
+    top: 20px;
+  }
+
+  .effective-style-guide div.example {
+    background-color: #fff;
+    border-color: #ddd;
+    border-radius: 4px 4px 0 0;
+    border-width: 1px;
+    box-shadow: none;
+    margin-left: 0;
+    margin-right: 0;
+    margin-bottom: 30px;
+    border-style: solid;
+    padding: 45px 15px 15px;
+    position: relative;
+  }
+
+  .effective-style-guide span.example {
+    color: #959595;
+    font-size: 12px;
+    font-weight: 700;
+    left: 15px;
+    letter-spacing: 1px;
+    position: absolute;
+    text-transform: uppercase;
+    top: 15px;
+  }
+
+  .effective-style-guide .inline-example {
+    color: #959595;
+    font-size: 12px;
+    font-weight: 700;
+    letter-spacing: 1px;
+    text-transform: uppercase;
+    margin-bottom: 20px;
+  }
+
+  / .effective-style-guide .inline-radio-or-checkboxes > span {
+  /   display: inline-block;
+  /   margin: 0px 10px 0px 0px;
+  / }
+

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  mount EffectiveStyleGuide::Engine => '/', :as => 'effective_style_guide'
+end
+
+EffectiveStyleGuide::Engine.routes.draw do
+  scope :module => 'effective' do
+    match '/styleguide', :to => 'style_guide#show', :via => [:get], :as => 'style_guide'
+    match '/style-guide', :to => 'style_guide#show', :via => [:get]
+    match '/style_guide', :to => 'style_guide#show', :via => [:get]
+  end
+end

data/lib/effective_style_guide/engine.rb

@@ -0,0 +1,11 @@
+module EffectiveStyleGuide
+  class Engine < ::Rails::Engine
+    engine_name 'effective_style_guide'
+
+    # Set up our default configuration options.
+    initializer "effective_style_guide.defaults", :before => :load_config_initializers do |app|
+      eval File.read("#{config.root}/lib/generators/templates/effective_style_guide.rb")
+    end
+
+  end
+end

data/lib/effective_style_guide/version.rb

@@ -0,0 +1,3 @@
+module EffectiveStyleGuide
+  VERSION = '1.0.0'.freeze
+end

data/lib/effective_style_guide.rb

@@ -0,0 +1,20 @@
+require "effective_style_guide/engine"
+require "effective_style_guide/version"
+
+module EffectiveStyleGuide
+  # The following are all valid config keys
+  mattr_accessor :authorization_method
+  mattr_accessor :layout
+
+  def self.setup
+    yield self
+  end
+
+  def self.authorized?(controller, action, resource)
+    if authorization_method.respond_to?(:call) || authorization_method.kind_of?(Symbol)
+      raise Effective::AccessDenied.new() unless (controller || self).instance_exec(controller, action, resource, &authorization_method)
+    end
+    true
+  end
+
+end

data/lib/generators/effective_style_guide/install_generator.rb

@@ -0,0 +1,16 @@
+module EffectiveStyleGuide
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Creates an EffectiveStyleGuide initializer in your application."
+      source_root File.expand_path("../../templates", __FILE__)
+
+      def copy_initializer
+        template "effective_style_guide.rb", "config/initializers/effective_style_guide.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1 @@
+Thanks for using EffectiveStyleGuide

data/lib/generators/templates/effective_style_guide.rb

@@ -0,0 +1,26 @@
+EffectiveStyleGuide.setup do |config|
+  # Authorization Method
+  #
+  # This method is called by all controller actions with the appropriate action and resource
+  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
+  #
+  # Use via Proc (and with CanCan):
+  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
+  #
+  # Use via custom method:
+  # config.authorization_method = :my_authorization_method
+  #
+  # And then in your application_controller.rb:
+  #
+  # def my_authorization_method(action, resource)
+  #   current_user.is?(:admin)
+  # end
+  #
+  # Or disable the check completely:
+  # config.authorization_method = false
+  config.authorization_method = Proc.new { |controller, action, resource| true }  # All users can see every screen
+
+  # Admin Screens Layout Settings
+  config.layout = 'application'   # All EffectiveStyleGuide controllers will use this layout
+
+end