stylin 0.1.0

data/app/controllers/stylin/application_controller.rb

@@ -0,0 +1,11 @@
+module Stylin
+  class ApplicationController < ActionController::Base
+
+    private
+
+    helper_method :styleguide
+    def styleguide
+      @styleguide ||= Styleguide.new
+    end
+  end
+end

data/app/controllers/stylin/styleguides_controller.rb

@@ -0,0 +1,13 @@
+require_dependency "stylin/application_controller"
+
+module Stylin
+  class StyleguidesController < ApplicationController
+    def index
+    end
+
+    def show
+      section_name = Styleguide.desluggify(params[:id])
+      @section = styleguide.find(section: section_name)
+    end
+  end
+end

data/app/helpers/stylin/application_helper.rb

@@ -0,0 +1,4 @@
+module Stylin
+  module ApplicationHelper
+  end
+end

data/app/helpers/stylin/navigation_helper.rb

@@ -0,0 +1,50 @@
+module Stylin
+  module NavigationHelper
+    def styleguide_navigation
+      content_for :styleguide_navigation do
+        if APP_CONFIG[:section_groupings]
+          custom_section_navigation
+        else
+          generic_section_navigation
+        end
+      end
+    end
+
+    def generic_section_navigation
+      elements = []
+
+      Styleguide.new.section_names.each do |section_name|
+        elements << section_link(section_name)
+      end
+
+      content_tag(:ul, elements.join("\n").html_safe)
+    end
+
+    def custom_section_navigation
+      elements = []
+
+      APP_CONFIG[:section_groupings].each do |section, description|
+        sections = Styleguide.new.find(section_group: section)
+
+        section_links = sections.map do |section|
+          section_link(section.section)
+        end
+
+        elements << content_tag(:li) do
+          "#{section} #{description}".html_safe +
+          content_tag(:ul, section_links.join("\n").html_safe)
+        end
+      end
+
+      content_tag(:ul, elements.join("\n").html_safe)
+    end
+
+    private
+
+    def section_link(section_name)
+      content_tag(:li,
+                  link_to(section_name, styleguide_path(Styleguide.sluggify(section_name)) )
+                 )
+    end
+  end
+end

data/app/helpers/stylin/styleguides_helper.rb

@@ -0,0 +1,29 @@
+module Stylin
+  module StyleguidesHelper
+    def example_html(section)
+      return @example_html if @example_html
+
+      if File.exists? example_html_path(section.filename)
+        @example_html = File.read( example_html_path(section.filename) ).html_safe
+      else
+        @example_html = ""
+      end
+    end
+
+    def escaped_html(section)
+      # to_str below causes html_safe? => false
+      ERB::Util.html_escape example_html(section).to_str
+    end
+
+    private
+
+    def example_html_base_path
+      Stylin::APP_CONFIG[:html_styleguides_path]
+    end
+
+    def example_html_path(filename)
+      filename = filename.split(/(.*?)\.(.*)/).reject(&:blank?).first
+      File.join(example_html_base_path, "#{filename}.html")
+    end
+  end
+end

data/app/models/styleguide.rb

@@ -0,0 +1,69 @@
+class Styleguide
+  attr_reader :section_names, :styleguide
+
+  def initialize
+    @styleguide ||= Kss::Parser.new( Stylin::APP_CONFIG[:stylesheets_path] )
+    @section_names ||= styleguide.sections.map{|s| s[1].section}.sort
+  end
+
+
+  def find(conditions)
+    section = conditions.delete(:section)
+    section_group = conditions.delete(:section_group)
+
+    if section_group.present?
+      find_grouped_sections(section_group)
+    elsif section.present?
+      find_by_section(section)
+    end
+  end
+
+  def build_section_hierarchy
+
+  end
+
+  def self.sluggify(section)
+    numbers = section.split(' ')[0].split('.')
+    strings = section.split(' ')[1..-1]
+
+    "#{numbers.join('-')}-#{strings.join('-')}"
+  end
+
+  def self.desluggify(slug)
+    slug_parts = slug.split('-')
+    numbers = []
+    strings = []
+
+    slug_parts.each do |slug_part|
+      if is_integer?(slug_part)
+        numbers << slug_part
+      else
+        strings << slug_part
+      end
+    end
+
+    "#{numbers.join('.')} #{strings.join(' ')}"
+  end
+
+  private
+
+  def find_by_section(section)
+    styleguide.section(section)
+  end
+
+  def find_grouped_sections(section_group)
+    grouped_sections.select{|k,v| k.to_i == section_group}.values.flatten.map do |section_name|
+      find_by_section(section_name)
+    end
+  end
+
+  def grouped_sections
+    @grouped_sections ||= section_names.group_by do |x|
+      x.split('.')[0]
+    end
+  end
+
+  def self.is_integer?(string)
+    /\A[-+]?[0-9]+\Z/ === string
+  end
+end

data/app/views/layouts/stylin/_navigation.html.erb

@@ -0,0 +1,3 @@
+<div class="col-md-2 navigation">
+  <%= yield(:styleguide_navigation) %>
+</div>

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

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Stylin</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <%= stylesheet_link_tag    asset_path("stylin/application"), media: "all" %>
+  <%= javascript_include_tag asset_path("stylin/application") %>
+
+  <%= stylesheet_link_tag    asset_path("application"), media: "all" %>
+
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="header">
+    <h1><%= Styleguide %></h1>
+  </div>
+
+  <div class="container">
+    <div class="row">
+      <%= render partial: "layouts/stylin/navigation" %>
+      <%= yield %>
+    </div>
+  </div>
+</body>
+</html>

data/app/views/stylin/styleguides/_section.html.erb

@@ -0,0 +1,31 @@
+<div class="col-md-10">
+  <div class="styleguide-example">
+    <h3><%= section.section %> <em><%= section.filename %></em></h3>
+    <div class="styleguide-description">
+      <p><%= simple_format(section.description) %></p>
+      <% if section.modifiers.any? %>
+        <ul class="styleguide-modifier">
+          <% section.modifiers.each do |modifier| %>
+            <li><strong><%= modifier.name %></strong> - <%= modifier.description %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    </div>
+    <div class="styleguide-element styleguide-modifier">
+      <span class="styleguide-modifier-name">No modifier</span>
+      <%= example_html(section) %>
+    </div>
+    <% section.modifiers.each do |modifier| %>
+      <div class="styleguide-element styleguide-modifier">
+        <span class="styleguide-modifier-name"><%= modifier.name %></span>
+        <%= example_html(section).gsub('$modifier_class', " #{modifier.class_name}").html_safe %>
+      </div>
+    <% end %>
+    <div class="styleguide-html">
+      <pre class="styleguide-code"><code>
+        <%= escaped_html(section) %>
+      </code></pre>
+    </div>
+
+  </div>
+</div>

data/app/views/stylin/styleguides/index.html.erb

@@ -0,0 +1,5 @@
+<%= styleguide_navigation %>
+
+<div class="col-md-8">
+  Welcome to the styleguide.
+</div>

data/app/views/stylin/styleguides/show.html.erb

@@ -0,0 +1,3 @@
+<%= styleguide_navigation %>
+
+<%= render partial: "section", locals: {section: @section} %>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Stylin::Engine.routes.draw do
+  resources :styleguides, only: [:index, :show]
+
+  root to: "styleguides#index"
+end

data/lib/generators/stylin/install_generator.rb

@@ -0,0 +1,12 @@
+module Stylin
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Installs Stylin ready for use."
+    def install
+      copy_file "stylin.yml", "config/stylin.yml"
+      empty_directory "app/styleguides"
+      route "mount Stylin::Engine => '/styleguides' if Rails.env.development?"
+    end
+  end
+end

data/lib/generators/stylin/views_generator.rb

@@ -0,0 +1,10 @@
+module Stylin
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path("../../templates", __FILE__)
+
+    desc "Installs Stylin views for customization."
+    def views
+      directory "views", "app/views"
+    end
+  end
+end

data/lib/generators/templates/stylin.yml

@@ -0,0 +1,7 @@
+#see README at http:github.com/criticaljuncture/stylin for configuration details
+
+#stylesheets_path: app/assets/stylesheets
+#html_styleguides_path: app/styleguides
+#section_groupings:
+#  1: Generic Elements
+#  2: Forms

data/lib/generators/templates/views/layouts/stylin/_navigation.html.erb

@@ -0,0 +1,3 @@
+<div class="col-md-4 navigation">
+  <%= yield(:styleguide_navigation) %>
+</div>

data/lib/generators/templates/views/layouts/stylin/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Stylin</title>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <%= stylesheet_link_tag    "stylin/application", media: "all" %>
+  <%= javascript_include_tag "stylin/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <div class="header">
+    <h1><%= Styleguide %></h1>
+  </div>
+
+  <div class="container">
+    <div class="row">
+      <%= render partial: "layouts/stylin/navigation" %>
+      <%= yield %>
+    </div>
+  </div>
+</body>
+</html>

data/lib/generators/templates/views/stylin/styleguides/_section.html.erb

@@ -0,0 +1,30 @@
+<div class="col-md-8">
+  <div class="styleguide-example">
+    <h3><%= section.section %> <em><%= section.filename %></em></h3>
+    <div class="styleguide-description">
+      <p><%= section.description %></p>
+      <% if section.modifiers.any? %>
+        <ul class="styleguide-modifier">
+          <% section.modifiers.each do |modifier| %>
+            <li><strong><%= modifier.name %></strong> - <%= modifier.description %></li>
+          <% end %>
+        </ul>
+      <% end %>
+    </div>
+    <div class="styleguide-element">
+      <%= example_html(section) %>
+    </div>
+    <% section.modifiers.each do |modifier| %>
+      <div class="styleguide-element styleguide-modifier">
+        <span class="styleguide-modifier-name"><%= modifier.name %></span>
+        <%= example_html(section).sub('$modifier_class', " #{modifier.class_name}").html_safe %>
+      </div>
+    <% end %>
+    <div class="styleguide-html">
+      <pre class="styleguide-code"><code>
+        <%= escaped_html(section) %>
+      </code></pre>
+    </div>
+
+  </div>
+</div>

data/lib/generators/templates/views/stylin/styleguides/index.html.erb

@@ -0,0 +1,5 @@
+<%= styleguide_navigation(styleguide.section_names) %>
+
+<div class="col-md-8">
+  Welcome to the styleguide.
+</div>

data/lib/generators/templates/views/stylin/styleguides/show.html.erb

@@ -0,0 +1,3 @@
+<%= styleguide_navigation %>
+
+<%= render partial: "section", locals: {section: @section} %>

data/lib/stylin.rb

@@ -0,0 +1,8 @@
+require 'jquery-rails'
+require 'sass-rails'
+require 'bootstrap-sass'
+require 'kss'
+require "stylin/engine"
+
+module Stylin
+end

data/lib/stylin/engine.rb

@@ -0,0 +1,37 @@
+module Stylin
+  class Engine < ::Rails::Engine
+    isolate_namespace Stylin
+
+    initializer "my_engine.load_app_root" do |app|
+      config = {
+        stylesheets_path: File.join('app', 'assets', 'stylesheets'),
+        html_styleguides_path: File.join('app', 'styleguides'),
+        section_groupings: nil
+      }
+
+      if File.exists?( File.expand_path(File.join('config', 'stylin.yml'), app.root) )
+        user_config = HashWithIndifferentAccess.new(
+          YAML.load(
+            File.read( File.expand_path(File.join('config', 'stylin.yml'), app.root) )
+          )
+        ).symbolize_keys
+      else
+        user_config = {}
+      end
+
+      Stylin::APP_CONFIG = config.merge( user_config )
+
+      Stylin::APP_CONFIG[:stylesheets_path] = File.expand_path(APP_CONFIG[:stylesheets_path], app.root)
+      Stylin::APP_CONFIG[:html_styleguides_path] = File.expand_path(APP_CONFIG[:html_styleguides_path], app.root)
+    end
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    config.autoload_paths << File.expand_path("../lib/tasks/stylin_tasks.rake", __FILE__)
+  end
+end

data/lib/stylin/version.rb

@@ -0,0 +1,3 @@
+module Stylin
+  VERSION = "0.1.0"
+end

data/lib/tasks/stylin_tasks.rake

@@ -0,0 +1,12 @@
+namespace :stylin do
+  namespace :development do
+    desc "Copy templates from view directories into template directory"
+    task :copy_templates_for_generator do
+      view_path = File.expand_path("../../../app/views", __FILE__)
+      template_path = File.expand_path("../../generators/templates/views", __FILE__)
+
+      FileUtils.rm_r(template_path)
+      FileUtils.cp_r(view_path, template_path)
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.