style-guide 0.6.2 → 0.7.0

data/Gemfile

@@ -1,3 +1,5 @@
 source "http://rubygems.org"
 
 gemspec
+
+gem "guard"

data/README.md

@@ -1,85 +1,97 @@
-# Style Guide
+Style Guide [![Build Status](https://secure.travis-ci.org/pivotalexperimental/style-guide.png?branch=master)](https://travis-ci.org/pivotalexperimental/style-guide) [![Dependency Status](https://gemnasium.com/pivotalexperimental/style-guide.png)](https://gemnasium.com/pivotalexperimental/style-guide) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/pivotalexperimental/style-guide)
+===
 
-[![Build Status](https://secure.travis-ci.org/pivotalexperimental/style-guide.png?branch=master)](https://travis-ci.org/pivotalexperimental/style-guide) [![Dependency Status](https://gemnasium.com/pivotalexperimental/style-guide.png)](https://gemnasium.com/pivotalexperimental/style-guide) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/pivotalexperimental/style-guide)
+Style Guide is a mountable Rails engine where you curate and view your site's visual elements.
 
-Style Guide was born out of a need to quickly audit the CSS applied to
-visual elements and iterate on them in a controlled environment.  It is
-implemented as a Rails engine in order to stay close to the application being
-styled.
+Tutorials on important topics, such as creating your own Style Guide sections, writing documentation for visual elements and more can be found in the [Style Guide wiki](https://github.com/pivotalexperimental/style-guide/wiki).
 
-When used with [guard-livereload](https://github.com/guard/guard-livereload),
-Style Guide automatically reloads itself when you make changes to the CSS,
-Javascript or HTML in your site.
 
+Features
+--------
 
-## Usage
+* Simple: just directories of partials
+* Responsive: see how everything looks on a mobile device
+* Live: file changes are presented immediately when using [LiveReload](http://livereload.com)
+* Documentation-aware: each partial can be documented with an i18n scope
 
-First, require the StyleGuide gem in `application.rb`:
 
-    require "style_guide"
+Anti-Features
+-------------
 
+* Not a Layout Guide: visual elements should not be composed
+* Not a linting tool: no warnings or errors are displayed
+* Curated, not magic: providing fake data for partials is not covered
 
-Then, append a directory of partials in `application.rb`:
 
-    config.style_guide.partial_paths << Rails.root.join("app/views/styles")
+Example
+-------
 
+You can see an example of Style Guide at swivel's automatically-deployed
+testing instance: [http://swivel.herokuapp.com](http://swivel.herokuapp.com)
 
-Next, mount the StyleGuide application in `routes.rb`:
-
-    mount StyleGuide::Engine => "/style-guide" unless Rails.env.production?
 
+Installation
+------------
 
-Finally, add `Rack::LiveReload` to `environments/development.rb`:
+The simplest way to install Style Guide is to use [Bundler](http://gembundler.com).
 
-    config.middleware.insert_before(::Rack::Lock, ::Rack::LiveReload)
+Add Style Guide to your `Gemfile`:
 
+```ruby
+group :development do
+  gem 'style-guide'
+end
+```
 
-## Enhancing Your Experience
+Then, use Bundler to install the gem and its dependencies:
 
-Running [Guard](https://github.com/guard/guard) is highly recommended:
+```bash
+$ bundle install
+```
 
-    $ guard init
-    INFO - livereload guard added to Guardfile, feel free to edit it
-    $ guard
-    INFO - LiveReload is waiting for a browser to connect.
+Last, run the Rails generator to configure your app:
 
-Using [Foreman](https://github.com/ddollar/foreman) to manage the startup of
-both your Rails app and Guard is an excellent idea.
+```bash
+$ rails g style_guide:install
+```
 
-First, turn off the Guard interactor so that it doesn't try to block output.
-Add this line to the top of your `Guardfile`:
+The generator will install [guard-livereload](https://github.com/guard/guard-livereload) and [rack-livereload](https://github.com/johnbintz/rack-livereload).
 
-    interactor :off
+Consult the [Style Guide wiki](https://github.com/pivotalexperimental/style-guide/wiki) for more information about what the generator does.
 
-Then add the following lines to `Procfile`, located in the root of your app:
 
-    web: bundle exec rails s
-    guard: bundle exec guard
+Contributing
+------------
 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important because breaking your feature in a future version unintentionally is sad.
+* Issue a pull request. Bonus points for topic branches.
 
-## Best Practices
 
-* Do not attempt to do layout in the Style Guide.  Attempting to make it lay
-  out your pages will lead you down the road of madness.
+Authors
+-------
 
-* The canonical installation of Style Guide pulls in all of the
-  directories under `app/views/style_guide`, like so:
+* Doc Ritezel
+* Ofri Afek
 
-      config.style_guide.partial_paths << Rails.root.join("app/views/style_guide/*")
 
-* From here, the Style Guide is broken down into sections,
-  like "Buttons", "Forms" and "Typography".
+Contributors
+------------
 
-* You should only use static content in the partials you render
-  to the Style Guide.
+* Rob Head
+* Can Berk Güder
+* Dennis Schmidt
 
 
-## Example
+Special Thanks
+--------------
 
-You can see an example of Style Guide at swivel's automatically-deployed
-testing instance: [http://swivel.herokuapp.com](http://swivel.herokuapp.com)
+* [@tildewill](https://twitter.com/TildeWill), [@emstar](https://twitter.com/emstar) and [@ajmurmann](https://twitter.com/ajmurmann) for fantastic input during the initial development process
+* Dmitriy Kalinin for being himself
 
 
-## License
+License
+-------
 
 See `LICENSE` for more information.

data/app/assets/javascripts/style_guide/docs.js

@@ -3,6 +3,16 @@
     $(".style-guide-partial [href^=#], .style-guide-partial-source").click(function(e) {
       e.preventDefault();
     });
+    
+    $(".style-guide-partial-identifiers code").mouseover(function() {
+      var identifier = $(this).text();
+      $(this).closest(".style-guide-partial")
+             .find(identifier)
+             .addClass("style-guide-identifier-highlight");
+    }).mouseout(function() {
+      $(".style-guide-identifier-highlight").removeClass("style-guide-identifier-highlight");
+    });
+    
     window.prettyPrint && prettyPrint();
   });
 })(window.jQuery);

data/app/assets/stylesheets/style_guide/partial.css

@@ -16,23 +16,40 @@
 }
 
 .style-guide-partial-description {
+  font-size: 14px;
   margin-bottom: 15px;
   color: #5D5C5C;
 }
 
+.style-guide-partial-source,
+.style-guide-partial-identifiers code,
+.style-guide-partial-description code {
+  font-size: 12px;
+  font-family: Monaco, Menlo, Consolas, "Courier New", monospace;
+}
+
 .style-guide-partial-identifiers code,
 .style-guide-partial-description code {
   color: #d14;
   background-color: #f5f5f5;
   padding: 0 4px;
   border: 1px solid #ddd;
-  font-family: Monaco, Menlo, Consolas, "Courier New", monospace;
   white-space: nowrap;
   -webkit-border-radius: 0;
      -moz-border-radius: 0;
           border-radius: 0;
 }
 
+.style-guide-partial-identifiers code {
+  cursor: pointer;
+}
+
+.style-guide-identifier-highlight {
+  -webkit-box-shadow: 0 1px 1px rgba(255, 0, 0, 1), 1px 0 1px rgba(255, 0, 0, 1), 0 -1px 1px rgba(255, 0, 0, 1), -1px 0 1px rgba(255, 0, 0, 1);
+     -moz-box-shadow: 0 1px 1px rgba(255, 0, 0, 1), 1px 0 1px rgba(255, 0, 0, 1), 0 -1px 1px rgba(255, 0, 0, 1), -1px 0 1px rgba(255, 0, 0, 1);
+          box-shadow: 0 1px 1px rgba(255, 0, 0, 1), 1px 0 1px rgba(255, 0, 0, 1), 0 -1px 1px rgba(255, 0, 0, 1), -1px 0 1px rgba(255, 0, 0, 1);
+}
+
 .style-guide-partial-rendered,
 .style-guide-partial-identifiers {
   position: relative;

data/app/assets/stylesheets/style_guide/prettify.css

@@ -6,21 +6,20 @@
 .kwd, .prettyprint .tag { color: navy; }
 .typ, .atn, .dec, .var { color: teal; }
 
-.prettyprint {
-  padding: 8px;
-}
-.prettyprint.linenums {
-  -webkit-box-shadow: inset 40px 0 0 #ECECEC, inset 41px 0 0 #ddd;
-     -moz-box-shadow: inset 40px 0 0 #ECECEC, inset 41px 0 0 #ddd;
-          box-shadow: inset 40px 0 0 #ECECEC, inset 41px 0 0 #ddd;
+.style-guide-partial-source {
+  -webkit-box-shadow: inset 40px 0 0 #f5f5f5, inset 41px 0 0 #ddd;
+     -moz-box-shadow: inset 40px 0 0 #f5f5f5, inset 41px 0 0 #ddd;
+          box-shadow: inset 40px 0 0 #f5f5f5, inset 41px 0 0 #ddd;
 }
 
-ol.linenums {
+.style-guide-partial-source ol {
+  padding: 0;
   margin: 0 0 0 33px; /* IE indents via margin-left */
 }
-ol.linenums li {
+.style-guide-partial-source li {
   font-size: 12px;
-  padding-left: 12px;
+  margin: 0;
+  padding: 0 0 0 5px;
   color: #888;
   line-height: 20px;
   text-shadow: 0 1px 0 #fff;

data/app/controllers/style_guide/application_controller.rb

@@ -1,10 +1,7 @@
 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
+      @sections = StyleGuide::Engine.config.style_guide.sections
     end
   end
 end

data/config/routes.rb

@@ -1,4 +1,4 @@
 StyleGuide::Engine.routes.draw do
   root :to => "style#index"
-  match "/style/:id" => "style#show", :as => :style
+  match "/:id" => "style#show", :as => :style
 end

data/lib/generators/style_guide/install_generator.rb

@@ -0,0 +1,107 @@
+require "rails/generators"
+
+module StyleGuide
+  class InstallGenerator < ::Rails::Generators::Base
+    desc "Style Guide installation generator"
+    def install
+      should_bundle = ensure_rack_livereload.nil?
+      should_bundle = ensure_guard_livereload.nil? || should_bundle
+      bundle_command("install") if should_bundle
+
+      configure_guard_livereload
+      configure_application
+      configure_development
+      mount_style_guide
+    end
+
+    no_tasks do
+      def guardfile
+        @guardfile ||= if File.exists?(guardfile_path)
+          File.open(guardfile_path).read
+        end
+      end
+
+      def application_rb
+        @application_rb ||= File.open(application_rb_path).read
+      end
+
+      def development_rb
+        @development_rb ||= File.open(development_rb_path).read
+      end
+
+      def routes_rb
+        @routes_rb ||= File.open(routes_rb_path).read
+      end
+
+      def default_partial_path
+        'Rails.root.join("app/views/style-guide/**/*")'
+      end
+    end
+
+    private
+    def guardfile_path
+      Rails.root.join("Guardfile")
+    end
+
+    def application_rb_path
+      Rails.root.join("config", "application.rb")
+    end
+
+    def development_rb_path
+      Rails.root.join("config", "environments", "development.rb")
+    end
+
+    def routes_rb_path
+      Rails.root.join("config", "routes.rb")
+    end
+
+    def ensure_rack_livereload
+      Rack.const_get("LiveReload")
+    rescue NameError
+      gem "rack-livereload", :group => "development"
+      nil
+    end
+
+    def ensure_guard_livereload
+      Guard.const_get("LiveReload")
+    rescue NameError
+      gem "guard-livereload", :group => "development"
+      nil
+    end
+
+    def bundle_command(command)
+      say_status :run, "bundle #{command}"
+
+      Dir.chdir(Rails.root) do
+        oldrubyopt = ENV["RUBYOPT"]
+        ENV["RUBYOPT"] = nil
+        system("#{Gem.bin_path('bundler', 'bundle')} #{command}")
+        ENV["RUBYOPT"] = oldrubyopt
+      end
+    end
+
+    def configure_guard_livereload
+      unless guardfile && guardfile.include?("guard 'livereload'")
+        bundle_command("exec guard init livereload")
+      end
+    end
+
+    def configure_application
+      unless application_rb && application_rb.include?("config.style_guide.paths")
+        application("config.style_guide.paths << #{default_partial_path}")
+      end
+    end
+
+    def configure_development
+      unless development_rb && development_rb.include?("Rack::LiveReload")
+        application("config.middleware.insert_before(::Rack::Lock, ::Rack::LiveReload, :min_delay => 500) if defined?(Rack::LiveReload)", :env => "development")
+      end
+    end
+
+    def mount_style_guide
+      unless routes_rb && routes_rb.include?("mount StyleGuide::Engine")
+        route(%(mount StyleGuide::Engine => "/style-guide"))
+      end
+    end
+  end
+end

data/lib/style-guide.rb

@@ -0,0 +1 @@
+require "style_guide"

data/lib/style_guide/config.rb

@@ -1,25 +1,35 @@
 module StyleGuide
   class Config
-    attr_reader :partial_paths
+    attr_reader :paths
 
-    def self.style_guide_views_path
-      StyleGuide::Engine.root.join("app", "views", "style_guide")
-    end
-
-    def self.style_guide_views_directories
-      style_guide_views_path.children.select(&:directory?).reject { |d| d.basename.to_s == "style" }
+    def self.bootstrap_glob
+      StyleGuide::Engine.root.join("app", "views", "bootstrap", "*")
     end
 
     def initialize(options = {})
-      @partial_paths = options[:partial_paths] || self.class.style_guide_views_directories
+      @paths = options[:paths] || [self.class.bootstrap_glob]
     end
 
-    def partial_paths=(paths)
+    def paths=(paths)
       if paths.is_a?(Array)
-        @partial_paths = paths
+        @paths = paths
       else
-        @partial_paths = [paths]
+        @paths = [paths]
       end
     end
+
+    def sections
+      StyleGuide::Section.from_paths(expanded_paths)
+    end
+
+    private
+
+    def expanded_paths
+      globbed_paths.flatten.uniq.select(&:directory?)
+    end
+
+    def globbed_paths
+      paths.map { |path| Pathname.glob(path) }
+    end
   end
 end

data/lib/style_guide/section.rb

@@ -2,14 +2,24 @@ require "style_guide/partial"
 
 module StyleGuide
   class Section
-    attr_reader :path
+    attr_reader :path, :id
 
-    def initialize(path)
-      @path = path
+    def self.id_from_path(path)
+      File.basename(path).downcase.gsub(/[^a-zA-Z0-9]/, " ").strip.gsub(/\s+/, "_")
+    end
+
+    def self.from_paths(paths)
+      [*paths].reduce({}) do |sections, path|
+        id = id_from_path(path)
+        section = sections[id] ||= []
+        section << new("#{id}#{section.empty? ? '' : section.count}", path)
+        sections
+      end.values.flatten
     end
 
-    def id
-      @id ||= File.basename(path).downcase.gsub(/[^a-zA-Z0-9]/, " ").strip.gsub(/\s+/, "_")
+    def initialize(id, path)
+      @id = id
+      @path = path
     end
 
     def title
@@ -23,7 +33,7 @@ module StyleGuide
     private
 
     def partial_paths
-      @partial_paths ||= Dir.glob(File.expand_path("**/_*.erb", path))
+      @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.6.2"
+  VERSION = "0.7.0"
 end

data/spec/controllers/style_guide/style_controller_spec.rb

@@ -6,7 +6,7 @@ describe StyleGuide::StyleController do
 
   before do
     FileUtils.mkdir_p(partial_path)
-    StyleGuide::Engine.config.style_guide.stub(:partial_paths => [partial_path])
+    StyleGuide::Engine.config.style_guide.paths = "#{temp_path}/*"
   end
 
   describe "#index" do
@@ -25,17 +25,15 @@ describe StyleGuide::StyleController do
   end
 
   describe "#show" do
-    let(:fake_section) { StyleGuide::Section.new(partial_path) }
-
     it "assigns sections" do
-      get :show, id: fake_section.id, use_route: :styles
+      get :show, id: "monkey_hammer", use_route: :styles
       assigns(:sections).should be
       assigns(:sections).should have(1).section
       assigns(:sections).first.should be_a StyleGuide::Section
     end
 
     it "assigns the section" do
-      get :show, id: fake_section.id, use_route: :styles
+      get :show, id: "monkey_hammer", use_route: :styles
       assigns(:current_section).should be_a StyleGuide::Section
       assigns(:current_section).title.should == "Monkey Hammer"
     end

data/spec/dummy/config/application.rb

@@ -26,7 +26,7 @@ module Dummy
     # Version of your assets, change this if you want to expire all your assets
     config.assets.version = '1.0'
 
-    config.style_guide.partial_paths << Rails.root.join("app/views/styles")
+    config.style_guide.paths << Rails.root.join("app/views/style-guide/**/*")
   end
 end
 

data/spec/lib/generators/style_guide/install_generator_spec.rb

@@ -0,0 +1,150 @@
+require "spec_helper"
+
+describe StyleGuide::InstallGenerator do
+  describe "#install" do
+    before do
+      subject.stub(:gem)
+      subject.stub(:route)
+      subject.stub(:bundle_command)
+      subject.stub(:application)
+      Rack.stub(:const_get).and_return("constant")
+      Guard.stub(:const_get).and_return("constant")
+      subject.stub(:routes_rb).and_return("mount StyleGuide::Engine")
+      subject.stub(:guardfile).and_return("guard 'livereload'")
+      subject.stub(:application_rb).and_return("config.style_guide.paths")
+      subject.stub(:development_rb).and_return("Rack::LiveReload")
+    end
+
+    describe "rack livereload dependency" do
+      context "when rack-livereload is installed" do
+        it "does not add rack-livereload to the Gemfile" do
+          subject.should_not_receive(:gem).with("rack-livereload", anything)
+          subject.install
+        end
+      end
+
+      context "when rack-livereload is not installed" do
+        before { Rack.stub(:const_get).and_raise(NameError) }
+
+        it "adds rack-livereload to the Gemfile" do
+          subject.should_receive(:gem).with("rack-livereload", anything)
+          subject.install
+        end
+
+        it "runs bundle install" do
+          subject.should_receive(:bundle_command).with("install")
+          subject.install
+        end
+      end
+    end
+
+    describe "guard livereload dependency" do
+      context "when guard-livereload is installed" do
+        it "does not add guard-livereload to the Gemfile" do
+          subject.should_not_receive(:gem).with("guard-livereload", anything)
+          subject.install
+        end
+      end
+
+      context "when guard-livereload is not installed" do
+        before { Guard.stub(:const_get).and_raise(NameError) }
+
+        it "adds guard-livereload to the Gemfile" do
+          subject.should_receive(:gem).with("guard-livereload", anything)
+          subject.install
+        end
+
+        it "runs bundle install" do
+          subject.should_receive(:bundle_command).with("install")
+          subject.install
+        end
+      end
+    end
+
+    describe "guard livereload configuration" do
+      context "when guard-livereload is in the Guardfile" do
+        it "does not add guard-livereload to the Guardfile" do
+          subject.should_not_receive(:bundle_command)
+          subject.install
+        end
+      end
+
+      context "when guard-livereload is not in the Guardfile" do
+        before { subject.stub(:guardfile).and_return("meat") }
+
+        it "adds guard-livereload to the Guardfile" do
+          subject.should_receive(:bundle_command).with("exec guard init livereload")
+          subject.install
+        end
+      end
+    end
+
+    describe "rails configuration" do
+      context "when style guide is not configured in application.rb" do
+        before { subject.stub(:application_rb).and_return("") }
+
+        it "adds an entry for style guide partial paths" do
+          subject.should_receive(:application).once do |config, options|
+            options.should == nil
+            config.should include "config.style_guide.paths"
+            config.should include subject.default_partial_path
+          end
+          subject.install
+        end
+      end
+
+      context "when style guide is configured in application.rb" do
+        before { subject.stub(:application_rb).and_return("config.style_guide.paths") }
+
+        it "does not modify application.rb" do
+          subject.should_not_receive(:application)
+          subject.install
+        end
+      end
+    end
+
+    describe "development configuration" do
+      context "when livereload is not configured in development.rb" do
+        before { subject.stub(:development_rb).and_return("") }
+
+        it "adds an entry for livereload" do
+          subject.should_receive(:application).once do |config, options|
+            options.should == {:env => "development"}
+            config.should include "config.middleware.insert_before"
+            config.should include "Rack::LiveReload"
+          end
+          subject.install
+        end
+      end
+
+      context "when livereload is already configured in development.rb" do
+        before { subject.stub(:development_rb).and_return("Rack::LiveReload") }
+
+        it "does not modify development.rb" do
+          subject.should_not_receive(:application)
+          subject.install
+        end
+      end
+    end
+
+    describe "mounting" do
+      context "when style guide is not mounted" do
+        before { subject.stub(:routes_rb).and_return("") }
+
+        it "mounts the style guide" do
+          subject.should_receive(:route).with('mount StyleGuide::Engine => "/style-guide"')
+          subject.install
+        end
+      end
+
+      context "when style guide is not mounted" do
+        before { subject.stub(:routes_rb).and_return("mount StyleGuide::Engine") }
+
+        it "does not mount the style guide" do
+          subject.should_not_receive(:route)
+          subject.install
+        end
+      end
+    end
+  end
+end

data/spec/lib/style_guide/config_spec.rb

@@ -1,32 +1,76 @@
 require "spec_helper"
 
 describe StyleGuide::Config do
-  describe "#partial_paths" do
+  describe "#paths" do
     context "when no paths have been added" do
-      it { should have_at_least(1).partial_path }
-      its(:partial_paths) { should_not include StyleGuide::Engine.root.join("app/views/style_guide/style") }
+      it { should have_at_least(1).path }
     end
 
     context "when adding a path" do
       it "modifies the partial paths" do
         expect do
-          subject.partial_paths << "disappointment"
-        end.to change{ subject.partial_paths.count }.by(1)
+          subject.paths << "disappointment"
+        end.to change{ subject.paths.count }.by(1)
       end
     end
 
     context "when setting the paths" do
       it "sets the partial paths" do
         expect do
-          subject.partial_paths = "loathing"
-        end.to change { subject.partial_paths }.to(["loathing"])
+          subject.paths = "loathing"
+        end.to change { subject.paths }.to(["loathing"])
       end
     end
 
     context "after a path has been added" do
-      before { subject.partial_paths << "partials-and-magic-beans" }
+      before { subject.paths << "partials-and-magic-beans" }
 
-      its(:partial_paths) { should include "partials-and-magic-beans" }
+      its(:paths) { should include "partials-and-magic-beans" }
+    end
+  end
+
+  describe "#sections" do
+    context "when no paths have been added" do
+      it { should have_at_least(1).section }
+      its(:'sections.first') { should be_a StyleGuide::Section }
+    end
+
+    context "when adding a nonexistent path" do
+      it "has no impact on the sections" do
+        expect do
+          subject.paths << "disappointment"
+        end.not_to change{ subject.sections.count }
+      end
+    end
+
+    context "when adding a non-globbed path" do
+      let(:path) { StyleGuide::Engine.root.join("app", "views") }
+
+      it "only adds that base path" do
+        expect do
+          subject.paths << path
+        end.to change { subject.sections.count }.by(1)
+      end
+    end
+
+    context "when adding a globbed path" do
+      let(:path) { StyleGuide::Engine.root.join("app", "views", "layouts", "*") }
+
+      it "obeys globbing" do
+        expect do
+          subject.paths << path
+        end.to change { subject.sections.count }.by(1)
+      end
+    end
+
+    context "when adding existing paths" do
+      let(:path) { StyleGuide::Engine.root.join("app", "views", "bootstrap", "**", "*") }
+
+      it "deduplicates existing paths" do
+        expect do
+          subject.paths << path
+        end.not_to change { subject.sections.count }
+      end
     end
   end
 end

data/spec/lib/style_guide/partial_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe StyleGuide::Partial do
   let(:path) { "/hygenic/_gargling.erb" }
-  let(:section) { StyleGuide::Section.new("/flaky/gangrene") }
+  let(:section) { StyleGuide::Section.from_paths("/flaky/gangrene").first }
   let(:partial) { StyleGuide::Partial.new(path, section) }
 
   describe "#title" do

data/spec/lib/style_guide/section_spec.rb

@@ -2,45 +2,66 @@ require "spec_helper"
 
 describe StyleGuide::Section do
   let(:path) { "/magnetic/sputum" }
-  let(:section) { StyleGuide::Section.new(path) }
+  let(:section) { StyleGuide::Section.new("sputum", path) }
 
-  describe "#title" do
-    subject { section.title }
+  describe ".id_from_path" do
+    subject { StyleGuide::Section.id_from_path(path) }
 
     context "with a simple path" do
-      it { should == "Sputum" }
+      it { should == "sputum" }
     end
 
-    context "with a path activerecord would be good at" do
+    context "with a good activerecord path" do
       let(:path) { "/tasty/bicycle_tires" }
 
-      it { should == "Bicycle Tires" }
+      it { should == "bicycle_tires" }
     end
 
     context "with a path containing extra stuff" do
       let(:path) { "/help/kocher%has-m1y=keyb^oaard" }
 
-      it { should == "Kocher%Has M1y=Keyb^Oaard" }
+      it { should == "kocher_has_m1y_keyb_oaard" }
     end
   end
 
-  describe "#id" do
-    subject { section.id }
+  describe ".from_paths" do
+    let(:paths) { path }
+    subject { StyleGuide::Section.from_paths(paths).map(&:id) }
+
+    context "with a single path" do
+      it { should =~ ["sputum"] }
+    end
+
+    context "with multiple paths" do
+      let(:paths) { ["/bat/wings", "/thinning/hair"] }
+
+      it { should =~ ["wings", "hair"] }
+    end
+
+    context "with multiple paths having the same basename" do
+      let(:paths) { ["/neck/wattle", "/underarm/wattle"] }
+      
+      it { should =~ ["wattle", "wattle1"] }
+    end
+  end
+
+  describe "#title" do
+    subject { section.title }
 
     context "with a simple path" do
-      it { should == "sputum" }
+      it { should == "Sputum" }
     end
 
-    context "with a good activerecord path" do
+    context "with a path activerecord would be good at" do
       let(:path) { "/tasty/bicycle_tires" }
 
-      it { should == "bicycle_tires" }
+      it { should == "Bicycle Tires" }
     end
 
     context "with a path containing extra stuff" do
       let(:path) { "/help/kocher%has-m1y=keyb^oaard" }
 
-      it { should == "kocher_has_m1y_keyb_oaard" }
+      it { should == "Kocher%Has M1y=Keyb^Oaard" }
     end
   end
 

data/spec/spec_helper.rb

@@ -3,5 +3,6 @@ require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 
 require "tmpdir"
 require "rspec/rails"
-# ENGINE_RAILS_ROOT = File.expand_path("../..", __FILE__)
+require "generators/style_guide/install_generator"
+
 Dir.glob(File.expand_path("../support/**/*.rb")).each {|f| require f }

data/style-guide.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Doc Ritezel"]
   s.email       = ["doc@pivotallabs.com"]
   s.homepage    = "https://github.com/pivotal/style-guide"
-  s.summary     = "A live style guide for your Rails application."
-  s.description = "Inspired by the Bootstrap guide, style-guide is a Rails engine that lets you see all your styles applied in front of your eyes."
+  s.summary     = "A style guide for your Rails application."
+  s.description = "A mountable Rails engine where you curate and view your site's visual elements."
 
   s.files         = `git ls-files`.split( "\n" ) - %w(Gemfile.lock)
   s.test_files    = `git ls-files -- spec/*`.split( "\n" )
@@ -19,12 +19,14 @@ Gem::Specification.new do |s|
   s.add_dependency "nokogiri", "~> 1.5"
   s.add_dependency "github-markdown", "~> 0.5"
 
+  # super-relevant in development, but super-irrelevant in staging
+  s.add_development_dependency "rack-livereload"
+  s.add_development_dependency "guard-livereload"
+
   s.add_development_dependency "foreman"
   s.add_development_dependency "rb-fsevent"
   s.add_development_dependency "rspec-rails"
   s.add_development_dependency "guard-rspec"
   s.add_development_dependency "guard-bundler"
-  s.add_development_dependency "rack-livereload"
-  s.add_development_dependency "guard-livereload"
   s.add_development_dependency "terminal-notifier-guard"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: style-guide
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-21 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: foreman
+  name: rack-livereload
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -92,7 +92,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: guard-livereload
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: foreman
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -124,7 +124,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -140,7 +140,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -156,7 +156,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-livereload
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -172,7 +172,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-livereload
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -203,8 +203,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Inspired by the Bootstrap guide, style-guide is a Rails engine that lets
-  you see all your styles applied in front of your eyes.
+description: A mountable Rails engine where you curate and view your site's visual
+  elements.
 email:
 - doc@pivotallabs.com
 executables: []
@@ -295,48 +295,50 @@ files:
 - app/controllers/style_guide/application_controller.rb
 - app/controllers/style_guide/style_controller.rb
 - app/helpers/style_guide/application_helper.rb
+- app/views/bootstrap/buttons/_disabled_anchor.erb
+- app/views/bootstrap/buttons/_disabled_element.erb
+- app/views/bootstrap/buttons/_sizes.erb
+- app/views/bootstrap/buttons/_types.erb
+- app/views/bootstrap/forms/_controls:_checkbox_and_radio.erb
+- app/views/bootstrap/forms/_controls:_input.erb
+- app/views/bootstrap/forms/_controls:_select.erb
+- app/views/bootstrap/forms/_controls:_textarea.erb
+- app/views/bootstrap/forms/_default_styles.erb
+- app/views/bootstrap/forms/_horizontal.erb
+- app/views/bootstrap/forms/_inline.erb
+- app/views/bootstrap/forms/_search.erb
+- app/views/bootstrap/images/_dropdown_icons.erb
+- app/views/bootstrap/images/_form_fields.erb
+- app/views/bootstrap/images/_icon_buttons.erb
+- app/views/bootstrap/images/_navigation.erb
+- app/views/bootstrap/images/_placeholders.erb
+- app/views/bootstrap/images/_small_button.erb
+- app/views/bootstrap/tables/_bordered.erb
+- app/views/bootstrap/tables/_condensed.erb
+- app/views/bootstrap/tables/_default_style.erb
+- app/views/bootstrap/tables/_hover.erb
+- app/views/bootstrap/tables/_row_classes.erb
+- app/views/bootstrap/tables/_striped.erb
+- app/views/bootstrap/typography/_abbreviation.erb
+- app/views/bootstrap/typography/_address.erb
+- app/views/bootstrap/typography/_blockquote.erb
+- app/views/bootstrap/typography/_body_copy.erb
+- app/views/bootstrap/typography/_code.erb
+- app/views/bootstrap/typography/_description_list.erb
+- app/views/bootstrap/typography/_emphasis.erb
+- app/views/bootstrap/typography/_emphasis_classes.erb
+- app/views/bootstrap/typography/_headings.erb
+- app/views/bootstrap/typography/_ordered_list.erb
+- app/views/bootstrap/typography/_unordered_list.erb
 - app/views/layouts/style_guide/application.html.erb
-- app/views/style_guide/buttons/_disabled_anchor.erb
-- app/views/style_guide/buttons/_disabled_element.erb
-- app/views/style_guide/buttons/_sizes.erb
-- app/views/style_guide/buttons/_types.erb
-- app/views/style_guide/forms/_controls:_checkbox_and_radio.erb
-- app/views/style_guide/forms/_controls:_input.erb
-- app/views/style_guide/forms/_controls:_select.erb
-- app/views/style_guide/forms/_controls:_textarea.erb
-- app/views/style_guide/forms/_default_styles.erb
-- app/views/style_guide/forms/_horizontal.erb
-- app/views/style_guide/forms/_inline.erb
-- app/views/style_guide/forms/_search.erb
-- app/views/style_guide/images/_dropdown_icons.erb
-- app/views/style_guide/images/_form_fields.erb
-- app/views/style_guide/images/_icon_buttons.erb
-- app/views/style_guide/images/_navigation.erb
-- app/views/style_guide/images/_placeholders.erb
-- app/views/style_guide/images/_small_button.erb
 - app/views/style_guide/style/_header.erb
 - app/views/style_guide/style/_partial.erb
 - app/views/style_guide/style/_sidebar.erb
 - app/views/style_guide/style/show.html.erb
-- app/views/style_guide/tables/_bordered.erb
-- app/views/style_guide/tables/_condensed.erb
-- app/views/style_guide/tables/_default_style.erb
-- app/views/style_guide/tables/_hover.erb
-- app/views/style_guide/tables/_row_classes.erb
-- app/views/style_guide/tables/_striped.erb
-- app/views/style_guide/typography/_abbreviation.erb
-- app/views/style_guide/typography/_address.erb
-- app/views/style_guide/typography/_blockquote.erb
-- app/views/style_guide/typography/_body_copy.erb
-- app/views/style_guide/typography/_code.erb
-- app/views/style_guide/typography/_description_list.erb
-- app/views/style_guide/typography/_emphasis.erb
-- app/views/style_guide/typography/_emphasis_classes.erb
-- app/views/style_guide/typography/_headings.erb
-- app/views/style_guide/typography/_ordered_list.erb
-- app/views/style_guide/typography/_unordered_list.erb
 - config/locales/en.yml
 - config/routes.rb
+- lib/generators/style_guide/install_generator.rb
+- lib/style-guide.rb
 - lib/style_guide.rb
 - lib/style_guide/config.rb
 - lib/style_guide/engine.rb
@@ -383,8 +385,8 @@ files:
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/styles/_00swatches.erb
-- spec/dummy/app/views/styles/_three_dee.erb
+- spec/dummy/app/views/style-guide/styles/_00swatches.erb
+- spec/dummy/app/views/style-guide/styles/_three_dee.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -417,6 +419,7 @@ files:
 - spec/dummy/public/img/glyphicons/glyphicons_214_resize_small.png
 - spec/dummy/public/img/glyphicons/glyphicons_266_book_open.png
 - spec/dummy/script/rails
+- spec/lib/generators/style_guide/install_generator_spec.rb
 - spec/lib/style_guide/config_spec.rb
 - spec/lib/style_guide/partial_spec.rb
 - spec/lib/style_guide/section_spec.rb
@@ -445,7 +448,7 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: A live style guide for your Rails application.
+summary: A style guide for your Rails application.
 test_files:
 - spec/controllers/style_guide/style_controller_spec.rb
 - spec/dummy/README.rdoc
@@ -485,8 +488,8 @@ test_files:
 - spec/dummy/app/mailers/.gitkeep
 - spec/dummy/app/models/.gitkeep
 - spec/dummy/app/views/layouts/application.html.erb
-- spec/dummy/app/views/styles/_00swatches.erb
-- spec/dummy/app/views/styles/_three_dee.erb
+- spec/dummy/app/views/style-guide/styles/_00swatches.erb
+- spec/dummy/app/views/style-guide/styles/_three_dee.erb
 - spec/dummy/config.ru
 - spec/dummy/config/application.rb
 - spec/dummy/config/boot.rb
@@ -519,6 +522,7 @@ test_files:
 - spec/dummy/public/img/glyphicons/glyphicons_214_resize_small.png
 - spec/dummy/public/img/glyphicons/glyphicons_266_book_open.png
 - spec/dummy/script/rails
+- spec/lib/generators/style_guide/install_generator_spec.rb
 - spec/lib/style_guide/config_spec.rb
 - spec/lib/style_guide/partial_spec.rb
 - spec/lib/style_guide/section_spec.rb