style-guide 0.0.1 → 0.1.0

data/.gitignore

@@ -9,3 +9,4 @@ spec/dummy/.sass-cache
 spec/dummy/app/assets/.DS_Store
 
 spec/dummy/app/assets/stylesheets/.DS_Store
+/tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=nested

data/.travis.yml

@@ -0,0 +1,16 @@
+rvm:
+  - 1.9.3
+script: script/ci.sh
+env:
+  global:
+    secure: "Qwe5ArAGqbJeTk//8mwd5GSHazoJ+3L5B/MxhI7Ixx7Oe+Jmr54xU2T+q8c1\nQaxYKuACVjtUF/1Os8AiYeNL4OMVG4b+Zg285NkgHf7ouhg+y6PFTEUerSyi\nzJWK/h7Jqsj392BU6Anr5mf+SmySp3kphjGxe9TsR/2DPJC4OoQ="
+after_script:
+  - gem install heroku
+  - git remote add heroku git@heroku.com:swivel.git
+  - echo "Host heroku.com" >> ~/.ssh/config
+  - echo "   StrictHostKeyChecking no" >> ~/.ssh/config
+  - echo "   CheckHostIP no" >> ~/.ssh/config
+  - echo "   UserKnownHostsFile=/dev/null" >> ~/.ssh/config
+  - heroku keys:clear
+  - yes | heroku keys:add
+  - yes | git push heroku master

data/Gemfile

@@ -1,5 +1,3 @@
 source "http://rubygems.org"
 
-gem "gem-release", :group => :development
-
 gemspec

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     style-guide (0.0.1)
+      jquery-rails
       rails
 
 GEM
@@ -44,7 +45,8 @@ GEM
       eventmachine (>= 0.12.9)
     erubis (2.7.0)
     eventmachine (1.0.0)
-    gem-release (0.4.1)
+    foreman (0.60.2)
+      thor (>= 0.13.6)
     guard (1.5.4)
       listen (>= 0.4.2)
       lumberjack (>= 1.0.2)
@@ -57,6 +59,9 @@ GEM
       em-websocket (>= 0.2.0)
       guard (>= 1.5.0)
       multi_json (~> 1.0)
+    guard-rspec (2.3.0)
+      guard (>= 1.1)
+      rspec (~> 2.11)
     hike (1.2.1)
     i18n (0.6.1)
     journey (1.0.4)
@@ -73,7 +78,7 @@ GEM
       treetop (~> 1.4.8)
     method_source (0.8.1)
     mime-types (1.19)
-    multi_json (1.3.7)
+    multi_json (1.4.0)
     polyglot (0.3.3)
     pry (0.9.10)
       coderay (~> 1.0.5)
@@ -109,12 +114,19 @@ GEM
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
       rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.0)
+    rspec-core (2.12.1)
     rspec-expectations (2.12.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.12.0)
+    rspec-rails (2.12.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
     slop (3.3.3)
-    sprockets (2.2.1)
+    sprockets (2.2.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
@@ -133,12 +145,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  gem-release
+  foreman
   guard-bundler
   guard-livereload
-  jquery-rails
+  guard-rspec
   rb-fsevent
-  rspec
+  rspec-rails
   style-guide!
   terminal-notifier-guard
   therubyracer

data/Guardfile

@@ -12,3 +12,15 @@ guard 'livereload' do
   watch(%r{config/locales/.+\.yml})
   watch(%r{(app|vendor|spec/dummy/app)/assets/\w+/(.+\.(css|js|html)).*})  { |m| "/assets/#{m[2]}" }
 end
+
+guard 'rspec', :cli => '--fail-fast --tag ~@slow:true' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+end

data/Procfile

@@ -0,0 +1 @@
+web: bundle exec bash -lc "cd spec/dummy && rails server --port $PORT"

data/README.md

@@ -1,6 +1,31 @@
 # StyleGuide
 
-Quickly see the bootstrap output of your application.
+[![Build Status](https://secure.travis-ci.org/pivotalexperimental/style-guide.png?branch=master)](https://travis-ci.org/pivotalexperimental/style-guide)
+
+Quickly see the styled output of your application.
+
+## Example
+
+The canonical deployed instance is located at [http://swivel.herokuapp.com](http://swivel.herokuapp.com)
+
+## Usage
+
+First, require the StyleGuide gem in your application.rb file:
+
+    Bundler.require
+    require "style_guide"
+
+Next, mount the StyleGuide application in your `routes.rb` file:
+
+    mount StyleGuide::Engine => "/style-guide"
+
+By default, StyleGuide will attempt to load directories full of partials and render them at its mounted path.  Here's how to add your own directory full of partials:
+
+    config.style_guide.partial_paths << Rails.root.join("app/views/styles")
+
+You could, however, just display only your partials (note the assignment):
+
+    config.style_guide.partial_paths = [Rails.root.join("app/views/styles")]
 
 ## License
 

data/app/controllers/style_guide/application_controller.rb

@@ -1,4 +1,10 @@
 module StyleGuide
   class ApplicationController < ActionController::Base
+    def load_sections
+      @sections =
+        StyleGuide::Engine.config.style_guide.partial_paths.map do |path|
+          StyleGuide::Section.new(path)
+        end
+    end
   end
 end

data/app/controllers/style_guide/style_controller.rb

@@ -1,12 +1,9 @@
 module StyleGuide
   class StyleController < StyleGuide::ApplicationController
+    before_filter :load_sections
+
     def index
-      @partials = []
-      StyleGuide::Engine.config.style_guide.partial_paths.each do |path|
-        Dir.glob(File.expand_path("_*.erb", path)) do |partial|
-          @partials << partial
-        end
-      end
+      @active = @sections.first
     end
   end
 end

data/app/views/layouts/style_guide/application.html.erb

@@ -27,9 +27,11 @@
           <a class="brand" href="/">Bootstrap</a>
           <div class="nav-collapse collapse">
             <ul class="nav">
-              <li class="index active">
-                <a href="/style-guide">Base CSS</a>
+            <% @sections.each_with_index do |section, index| %>
+              <li<%= (section == @active) ? ' class="active"'.html_safe : '' %>>
+                <a href="<%= root_path %>"><%= section.title %></a>
               </li>
+            <% end %>
             </ul>
           </div>
         </div>

data/app/views/style_guide/style/_sidebar.erb

@@ -0,0 +1,5 @@
+<ul class="nav nav-list bs-docs-sidenav">
+<% @active.partials.each do |partial| %>
+  <li><a href="#<%= partial.id %>"><i class="icon-chevron-right"></i> <%= partial.title %></a></li>
+<% end %>
+</ul>

data/app/views/style_guide/style/index.html.erb

@@ -2,30 +2,21 @@
 ================================================== -->
 <header class="jumbotron subhead" id="overview">
   <div class="container">
-    <h1>Base CSS</h1>
-    <p class="lead">Fundamental HTML elements styled and enhanced with extensible classes.</p>
+    <h1><%= @active.title %></h1>
   </div>
 </header>
 
-
 <div class="container">
   <!-- Docs nav
   ================================================== -->
   <div class="row">
     <div class="span3 bs-docs-sidebar">
-      <ul class="nav nav-list bs-docs-sidenav">
-        <li><a href="#typography"><i class="icon-chevron-right"></i> Typography</a></li>
-        <li><a href="#code"><i class="icon-chevron-right"></i> Code</a></li>
-        <li><a href="#tables"><i class="icon-chevron-right"></i> Tables</a></li>
-        <li><a href="#forms"><i class="icon-chevron-right"></i> Forms</a></li>
-        <li><a href="#buttons"><i class="icon-chevron-right"></i> Buttons</a></li>
-        <li><a href="#images"><i class="icon-chevron-right"></i> Images</a></li>
-        <li><a href="#icons"><i class="icon-chevron-right"></i> Icons by Glyphicons</a></li>
-      </ul>
+      <%= render :partial => "sidebar" %>
     </div>
+
     <div class="span9">
-      <% @partials.each do |partial| %>
-        <%= render :file => partial %>
+      <% @active.partials.each do |partial| %>
+        <%= render :file => partial.path %>
       <% end %>
     </div>
   </div>

data/config/routes.rb

@@ -1,3 +1,4 @@
 StyleGuide::Engine.routes.draw do
   root :to => "style#index"
+  resource :style, :path => '', :only => [:index]
 end

data/lib/style_guide.rb

@@ -1,4 +1,2 @@
+require "style_guide/version"
 require "style_guide/engine"
-
-module StyleGuide
-end

data/lib/style_guide/config.rb

@@ -0,0 +1,9 @@
+module StyleGuide
+  class Config
+    attr_accessor :partial_paths
+
+    def initialize(options = {})
+      @partial_paths = options[:partial_paths] || [StyleGuide::Engine.root.join("app/views/style_guide/partials")]
+    end
+  end
+end

data/lib/style_guide/engine.rb

@@ -1,12 +1,10 @@
+require "rails/engine"
+require "style_guide/config"
+require "style_guide/section"
+
 module StyleGuide
   class Engine < ::Rails::Engine
     isolate_namespace StyleGuide
-    class StyleGuideConfig < Struct.new(:partial_paths); end
-
-    config.style_guide = StyleGuideConfig.new([])
-
-    initializer "style_guide.set_up_variables", :before => :load_config_initializers do |app|
-      app.config.style_guide.partial_paths << StyleGuide::Engine.root.join("app/views/style_guide/partials")
-    end
+    config.style_guide = StyleGuide::Config.new
   end
 end

data/lib/style_guide/partial.rb

@@ -0,0 +1,21 @@
+module StyleGuide
+  class Partial
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def id
+      @id ||= title.downcase.gsub(/[^a-zA-Z0-9]+/, "_")
+    end
+
+    def title
+      @title ||= File.basename(path, ".erb").titleize.strip
+    end
+
+    def content
+      @content || File.read(path)
+    end
+  end
+end

data/lib/style_guide/section.rb

@@ -0,0 +1,29 @@
+require "style_guide/partial"
+
+module StyleGuide
+  class Section
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def id
+      @id ||= path.gsub(/[^a-zA-Z0-9]/, " ").strip.gsub(/\s+/, "_")
+    end
+
+    def title
+      @title ||= File.basename(path).titleize
+    end
+
+    def partials
+      partial_paths.map { |path| StyleGuide::Partial.new(path) }
+    end
+
+    private
+
+    def partial_paths
+      @partial_paths ||= Dir.glob(File.expand_path("**/_*.erb", path))
+    end
+  end
+end

data/lib/style_guide/version.rb

@@ -1,3 +1,3 @@
 module StyleGuide
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/script/ci.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rspec

data/spec/controllers/style_guide/style_controller_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+describe StyleGuide::StyleController do
+  describe "#index" do
+    it "assigns sections" do
+      get :index, use_route: :styles
+      assigns(:sections).should be
+      assigns(:sections).first.should be_a StyleGuide::Section
+    end
+
+    it "sets the active section to the first one" do
+      get :index, use_route: :styles
+      assigns(:active).should == assigns(:sections).first
+    end
+  end
+end

data/spec/dummy/app/assets/stylesheets/application.css

@@ -11,5 +11,4 @@
  *= require_self
  *= require bootstrap
  *= require bootstrap-responsive
- *= require pivotal-bootstrap
  */

data/spec/dummy/config/boot.rb

@@ -1,3 +1,6 @@
+$stdout.sync = true
+$stderr.sync = true
+
 require 'rubygems'
 gemfile = File.expand_path('../../../../Gemfile', __FILE__)
 
@@ -7,4 +10,4 @@ if File.exist?(gemfile)
   Bundler.setup
 end
 
-$:.unshift File.expand_path('../../../../lib', __FILE__)
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
-  root :to => "home#index"
+  root :to => redirect("/style-guide")
   mount StyleGuide::Engine => "/style-guide"
 end

data/spec/lib/style_guide/config_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe StyleGuide::Config do
+  describe "#partial_paths" do
+    context "when no paths have been added" do
+      it { should have(1).partial_path }
+      its(:partial_paths) { should == [StyleGuide::Engine.root.join("app/views/style_guide/partials")] }
+    end
+
+    context "after a path has been added" do
+      before { subject.partial_paths << "partials-and-magic-beans" }
+
+      it { should have(2).partial_paths }
+      its(:partial_paths) { should include "partials-and-magic-beans" }
+    end
+  end
+end

data/spec/lib/style_guide/partial_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe StyleGuide::Partial do
+  let(:path) { "/hygenic/_gargling.erb" }
+  let(:partial) { StyleGuide::Partial.new(path) }
+
+  describe "#title" do
+    subject { partial.title }
+
+    context "with a simple path" do
+      it { should == "Gargling" }
+    end
+
+    context "with a path activerecord would be good at" do
+      let(:path) { "/tasty/_tree-leather.erb" }
+
+      it { should == "Tree Leather" }
+    end
+
+    context "with a path containing extra stuff" do
+      let(:path) { "/help/_a!dog%has-m1y=keyb^oaard.erb" }
+
+      it { should == "A!Dog%Has M1y=Keyb^Oaard" }
+    end
+  end
+
+  describe "#id" do
+    subject { partial.id }
+
+    context "with a simple path" do
+      it { should == "gargling" }
+    end
+
+    context "with a good activerecord path" do
+      let(:path) { "/tasty/_thumb_tacks.erb" }
+
+      it { should == "thumb_tacks" }
+    end
+
+    context "with a path containing extra stuff" do
+      let(:path) { "/help/mugabe%has-m1y=keyb^oaard" }
+
+      it { should == "mugabe_has_m1y_keyb_oaard" }
+    end
+  end
+
+  describe "#content" do
+    before { File.stub(:read => "reading is for chumps") }
+
+    subject { partial.content }
+
+    it { should == "reading is for chumps" }
+  end
+end