vivus 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e91f68c5d5976fc293b0ddc92a60dee74a50ed96
-  data.tar.gz: abdb3ddeea7a3354350d403d518be53d1fb9f336
+  metadata.gz: b185bf25bd7e7ba47b047943c0456c2f82e271b3
+  data.tar.gz: 8429dc067fd83b962aed851a24cd451c3d60b626
 SHA512:
-  metadata.gz: dfad9b9bf091e40c0bb2650ec29d5d87d140a0cf06a3def21013a4c08ba7d2350ce2ac8bab6841088884a3d06698e06876af9faf5165dd4c0119611d90b25ba4
-  data.tar.gz: 5a6ae28163548adf7022ad5053bdf54c01c589b449ef58b51bd07cb3a9ed8ee2cc65469a378b74fe2daed42e3fa6e436babf5c96be84404d815d6e217ec6d72d
+  metadata.gz: fc3e6369648090da445ccbd0342e723dc9fd0d88aa3164f97acab5b9d0f9dcef0ae359742e08c07d18797484410b9ecf0c58c5988c120b46335b142509d535c7
+  data.tar.gz: b2b0d125f085af2359d257a9eb998d88bcaa518ef363e08ed4634ccea8adc042c500dabbcc6c3f1d7b664535972461039d58d8ae3ba10038dcc409c864331fa2

data/app/assets/javascripts/vivus/application.js

@@ -9,7 +9,7 @@ $(document).ready(function() {
     });
 
     $('h2.vivus-name').each(function(i, el) {
-      $(el).before("<a name='" + $(el).text().toLowerCase().replace(/ /g, '-') +"'></a>");
+      $(el).before("<a name='" + $(el).text().toLowerCase().replace(',', '').replace(/ /g, '-') +"'></a>");
     })
 
     $('.vivus-documentation *:contains("TODO:")').html(function(_, html) {

data/app/assets/stylesheets/vivus/module/component.scss

@@ -50,6 +50,11 @@ li.vivus-component {
   }
 
   .vivus-code {
+    > em.vivus-source {
+      padding: 10px;
+      color: #bbb;
+    }
+
     > pre {
       font-family: monospace;
       word-wrap: break-word;

data/app/assets/stylesheets/vivus/module/nav.scss

@@ -43,6 +43,12 @@
           margin-left: 0;
           padding-left: 15px;
           border-left: 5px solid #F3DF6C;
+
+          ul {
+            li {
+              display: block;
+            }
+          }
         }
 
         a {
@@ -51,8 +57,11 @@
 
         ul {
           margin-top: 10px;
-        }
 
+          li {
+            display: none;
+          }
+        }
 
         .h2 {
           font-size: 13px;

data/app/controllers/vivus/styles_controller.rb

@@ -11,26 +11,18 @@ class Vivus::StylesController < Vivus::ApplicationController
   private
 
   def gather_stylesheets
+
     sprockets = Rails.application.assets
 
     @css_paths = %w{application.css}
-    @css_paths += Rails.application.config.assets.precompile.select { |item|
+    @css_paths += Rails.application.config.assets.precompile.select do |item|
       item.is_a?(String) && item[-4,4] == ".css"
-    }
-
-    @stylesheets = @css_paths
-      .map{|file_path| Stylesheet.new(css: sprockets[file_path].body)}
-      .map{|stylesheet| stylesheet.parse}
-      .reject{|stylesheet| stylesheet.empty?}
-      .inject({}){ | accum, data |
-        data.each do |section, components|
-          accum[section] ||= []
-          accum[section] += components
-        end
-
-        accum
-      }
     end
+    stylesheets = @css_paths.map{|file_path| Stylesheet.new(file_path: file_path, css: sprockets[file_path].body)}
+
+    styleguide = Styleguide.new(stylesheets: stylesheets)
+    @stylesheets = styleguide.generate
+  end
 
   def is_a_file? file
     File.file?(file)

data/app/models/component.rb

@@ -1,7 +1,7 @@
 require 'rdiscount'
 
 class Component
-  attr_accessor :name, :section, :description, :example, :url
+  attr_accessor :name, :section, :description, :example, :url, :source
 
   def display_description
     RDiscount.new(self.description, :smart, :filter_html).to_html.html_safe if self.description

data/app/models/styleguide.rb

@@ -0,0 +1,21 @@
+# Takes a bunch of Stylesheets, parses them,
+# and merges them into a single styleguide.
+class Styleguide
+  def initialize(options)
+    @stylesheets = options[:stylesheets]
+  end
+
+  def generate
+    @stylesheets
+      .map{|stylesheet| stylesheet.parse}
+      .reject{|stylesheet| stylesheet.empty?}
+      .inject({}){ | accum, data |
+        data.each do |section, components|
+          accum[section] ||= []
+          accum[section] += components
+        end
+
+        accum
+      }
+  end
+end

data/app/models/stylesheet.rb

@@ -1,15 +1,13 @@
-require 'yaml'
-
-
 class Stylesheet
   def initialize(options)
+    @file_path = options[:file_path]
     @css = options[:css]
   end
 
   def parse
     documentation = []
 
-    styleguide_comment.each do |comment|
+    styleguide_comments.each do |comment|
       comment = comment[1]
 
       name = find_name_for(comment)
@@ -21,6 +19,8 @@ class Stylesheet
       if name.present? || section.present? || description.present? || example.present? || url.present?
         component = Component.new
 
+        component.source = @file_path
+
         component.name = name if name
         if section
           component.section = section
@@ -86,7 +86,7 @@ class Stylesheet
     end
   end
 
-  def styleguide_comment
+  def styleguide_comments
     regex = /\/\*\*(.*?)\*\*\//m
     scan_comment(@css, regex)
   end

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

@@ -4,7 +4,15 @@
   <title>Vivus</title>
   <%= stylesheet_link_tag    "vivus/application", :media => "all" %>
   <%= javascript_include_tag "vivus/application" %>
-  <%= stylesheet_link_tag    "application", :media => "all" %>
+
+  <% @css_paths.each do |path| %>
+    <% if path.match(/print/).nil? %>
+      <%= stylesheet_link_tag path, :media => "all" %>
+    <% else %>
+      <%= stylesheet_link_tag path, :media => "print" %>
+    <% end %>
+  <% end %>
+
   <%= csrf_meta_tags %>
 </head>
 <body id="vivus">

data/app/views/vivus/styles/_component.html.erb

@@ -16,6 +16,7 @@
     </div>
 
     <div class="vivus-code vivus-block ">
+      <em class="vivus-source">From <%= component.source %></em>
       <pre><%= component.display_example %></pre>
     </div>
   <% end %>

data/app/views/vivus/styles/_nav.html.erb

@@ -3,16 +3,16 @@
     <% @stylesheets.each do |group| %>
       <% section = group[0] %>
       <% section_slug = section.downcase.gsub(/[^a-z1-9]+/, '-').chomp('-') %>
-      <% chunks = group[1] %>
+      <% components = group[1] %>
 
       <li class="h1 <%= "active" if section.downcase.gsub(/[^a-z1-9]+/, '-').chomp('-') == params[:section] %>">
         <%= link_to section, vivus_section_path(section_slug) %>
 
-        <% if chunks.present? %>
+        <% if components.present? %>
           <ul>
-            <% chunks.each do |chunk| %>
+            <% components.each do |component| %>
               <li class="h2">
-                <%= link_to chunk.name, vivus_section_path(section_slug, anchor: chunk.slug) %>
+                <%= link_to component.name, vivus_section_path(section_slug, anchor: component.slug) %>
               </li>
             <% end %>
           </ul>

data/app/views/vivus/styles/index.html.erb

@@ -8,7 +8,7 @@
         <p>Above each block of code in your CSS, start documenting your styleguide by writing comments.</p>
         <p>Use the below example as a starting point.</p>
         <pre>
-/*
+/**
 [Name] The name of the component (e.g. Success Buttons)
 [Section] A section that groups components together (e.g. Buttons)
 [Description]
@@ -32,7 +32,7 @@ need be.
   &lt;a href="#" class="button"&gt;Some text&lt;a&gt;
 &lt;/div&gt;
 [Url] A web address pointing to further documentation / example (optional)
-*/
+**/
         </pre>
       </li>
   </ul>

data/lib/vivus/version.rb

@@ -1,3 +1,3 @@
 module Vivus
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vivus
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Mark Cipolla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-13 00:00:00.000000000 Z
+date: 2014-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '5'
@@ -57,9 +57,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -67,9 +64,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.14'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3'
 description: Styleguides can be a pain to keep as a living documentation for your
   CSS. By analysing the comments in your SASS files, and by adding markdown to your
   stylesheets, you can generate a living, breathing documentation styleguide that
@@ -95,6 +89,7 @@ files:
 - app/controllers/vivus/application_controller.rb
 - app/controllers/vivus/styles_controller.rb
 - app/models/component.rb
+- app/models/styleguide.rb
 - app/models/stylesheet.rb
 - app/views/layouts/vivus/application.html.erb
 - app/views/vivus/styles/_component.html.erb