brightguide 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 852e65dd848322bb0b21c7fc3dd8a6055b54bcd3
+  data.tar.gz: f078001bb09ee168cf38dc57c2c953d89e219604
+SHA512:
+  metadata.gz: 5f8ac0c6495ddded9b83b990e6e44feef97dc5d2cab5c9c8a04ff312bad0fc710fc29fed60d990255387274d151a7ce729012596877f2a3118d84edb5db0d765
+  data.tar.gz: ef105de512f753d8aa06c8e38b8a920e9b0dc3530424cb38675913d89ed25ddbbba9c0f2ccaeae8b186e8c6a8d85bd52227b323af6ab20fbed94b264362dd1f2

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

@@ -0,0 +1 @@
+

data/app/assets/stylesheets/brightguide/application.scss

@@ -0,0 +1,116 @@
+$font: -apple-system, BlinkMacSystemFont, sans-serif;
+
+.styleguide-body {
+  background: #f3f5f7;
+  color: #444;
+}
+
+.styleguide-content {
+  max-width: 700px;
+  margin: auto;
+}
+
+.styleguide-heading {
+  font-size: 36px;
+  margin-top: 30px;
+  margin-bottom: 40px;
+  font-weight: 600;
+  color: #111;
+  font-family: $font;
+}
+
+h1 {
+  font-size: 28px;
+  font-weight: 600;
+  color: #111;
+  font-family: $font;
+}
+
+h2 {
+  font-size: 18px;
+  font-weight: 600;
+  margin-bottom: 0.5em;
+  color: #111;
+  font-family: $font;
+}
+
+p {
+  font-family: $font;
+  margin-bottom: 1em;
+  &:last-child {
+    margin-bottom: 0;
+  }
+}
+
+.styleguide-card {
+  background: #fff;
+  border-radius: 5px;
+  margin-bottom: 30px;
+}
+
+.styleguide-card-heading {
+  padding: 30px;
+  border-bottom: 2px solid #f3f5f7;
+}
+
+.styleguide-card-section {
+  padding: 30px;
+  & + & {
+    border-top: 2px solid #f3f5f7;
+  }
+}
+
+
+hr {
+  margin: 1em 0;
+  height: 1px;
+  border: 0;
+  background: #f3f5f7;
+}
+
+.styleguide-example {
+  border: 3px solid #f3f5f7;
+  margin-bottom: 1em;
+
+  > div {
+    padding: 20px;
+    overflow: hidden;
+  }
+
+  > pre {
+    padding: 20px;
+    background: #f3f5f7;
+    font: 14px / 18px Menlo, Monaco, monospace;
+    overflow-y: auto;
+  }
+  &:last-child {
+    margin-bottom: 0;
+  }
+}
+
+.styleguide-card-folder {
+  font-family: $font;
+  color: #97a3a9;
+  float: right;
+}
+
+code {
+  font: 14px / 14px Menlo, Monaco, monospace;
+  background: #f3f5f7;
+  color: #096eda;
+  display: inline-block;
+  padding: 4px;
+}
+
+.example-square {
+  background: #24b198;
+  width: 50px;
+  height: 50px;
+  line-height: 50px;
+}
+
+.example-square-2 {
+  width: 100%;
+  height: 100%;
+  background: #154eb5;
+}

data/app/controllers/brightguide/application_controller.rb

@@ -0,0 +1,5 @@
+module Brightguide
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/brightguide/cards_controller.rb

@@ -0,0 +1,10 @@
+require_dependency "brightguide/application_controller"
+require_dependency "brightguide/markdown_helper"
+
+module Brightguide
+  class CardsController < ApplicationController
+    def index
+      @cards = Card.all
+    end
+  end
+end

data/app/helpers/brightguide/markdown_helper.rb

@@ -0,0 +1,24 @@
+module Brightguide
+  module MarkdownHelper
+    def render_markdown(str)
+      markdown_renderer.render(str).html_safe
+    end
+
+    private
+
+    def markdown_renderer
+      @markdown_renderer = Redcarpet::Markdown.new(StyleguideRenderer)
+    end
+
+    class StyleguideRenderer < Redcarpet::Render::HTML
+      def block_code(code, _language)
+        <<EOS
+<div class="styleguide-example">
+  <div>#{code}</div>
+  <pre>#{CGI.escapeHTML(code).gsub("\n", '&#x000A;')}</pre>
+</div>
+EOS
+      end
+    end
+  end
+end

data/app/models/brightguide/card.rb

@@ -0,0 +1,20 @@
+module Brightguide
+  class Card
+    attr_reader :name, :sections, :folder_name
+    delegate :present?, to: :sections
+
+    def self.all
+      Brightguide::Parser.all.map { |item| new(item) }.select(&:present?)
+    end
+
+    def initialize(name:, sections:, folder_name:)
+      @name = name
+      @sections = sections
+      @folder_name = folder_name
+    end
+
+    def to_partial_path
+      "brightguide/cards/card"
+    end
+  end
+end

data/app/views/brightguide/cards/_card.html.erb

@@ -0,0 +1,11 @@
+<div class="styleguide-card">
+  <div class="styleguide-card-heading">
+    <div class="styleguide-card-folder"><%= card.folder_name %></div>
+    <h1><%= card.name %></h1>
+  </div>
+  <% card.sections.each do |section| %>
+    <div class="styleguide-card-section">
+      <%= render_markdown(section) %>
+    </div>
+  <% end %>
+</div>

data/app/views/brightguide/cards/index.html.erb

@@ -0,0 +1 @@
+<%= render @cards %>

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

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <meta content='width=device-width, initial-scale=1, maximum-scale=1.0' name='viewport'>
+    <title>Styleguide</title>
+    <%= csrf_meta_tags %>
+    <%= stylesheet_link_tag Brightguide.stylesheet_location %>
+
+    <%= stylesheet_link_tag 'brightguide/application' %>
+    <%= javascript_include_tag 'brightguide/application' %>
+  </head>
+  <body class="styleguide-body">
+    <div class="styleguide-content">
+      <h1 class="styleguide-heading">Styleguide</h1>
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Brightguide::Engine.routes.draw do
+  root 'cards#index'
+end

data/lib/brightguide.rb

@@ -0,0 +1,15 @@
+require "redcarpet"
+require "brightguide/engine"
+require "brightguide/parser"
+
+module Brightguide
+  mattr_accessor :stylesheet_location
+  @@stylesheet_location = "application"
+
+  mattr_accessor :stylesheets_path
+  @@stylesheets_path = "app/assets/stylesheets"
+
+  def self.setup
+    yield self
+  end
+end

data/lib/brightguide/engine.rb

@@ -0,0 +1,9 @@
+module Brightguide
+  class Engine < ::Rails::Engine
+    isolate_namespace Brightguide
+
+    initializer "Precompile hook", group: :all do |app|
+      app.config.assets.precompile += ["brightguide/application.css", "brightguide/application.js"]
+    end
+  end
+end

data/lib/brightguide/parser.rb

@@ -0,0 +1,39 @@
+module Brightguide
+  module Parser
+    def self.all
+      file_paths.map do |file_path|
+        {
+          name: File.basename(file_path, ".*"),
+          sections: parse_file(file_path),
+          folder_name: folder_name(file_path)
+        }
+      end
+    end
+
+    def self.file_paths
+      Dir.glob(Rails.root.join(Brightguide.stylesheets_path, "**", "*")).select do |path|
+        File.file?(path)
+      end
+    end
+
+    def self.folder_name(file_path)
+      File.dirname(file_path).remove("#{Rails.root.join(Brightguide.stylesheets_path)}/")
+    end
+
+    def self.parse_file(file_path)
+      [].tap do |result|
+        File.open(file_path, "r") do |file|
+          documentation = false
+          file.each_line do |line|
+            documentation = false if line.starts_with?("*/")
+            result.last << line if documentation
+            if line.starts_with?("/* doc")
+              documentation = true
+              result << ""
+            end
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: brightguide
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brightin developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.4
+description: Parses your styleguides and automatically creates styleguides.
+email:
+- hello@brightin.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/javascripts/brightguide/application.js
+- app/assets/stylesheets/brightguide/application.scss
+- app/controllers/brightguide/application_controller.rb
+- app/controllers/brightguide/cards_controller.rb
+- app/helpers/brightguide/markdown_helper.rb
+- app/models/brightguide/card.rb
+- app/views/brightguide/cards/_card.html.erb
+- app/views/brightguide/cards/index.html.erb
+- app/views/layouts/brightguide/application.html.erb
+- config/routes.rb
+- lib/brightguide.rb
+- lib/brightguide/engine.rb
+- lib/brightguide/parser.rb
+homepage: http://www.brightin.nl
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Automatically created CSS styleguide.
+test_files: []