livingstyleguide 0.6.0.alpha.1 → 0.6.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d11d94de9e3e3effd2978cf825fa788d8b1c580
-  data.tar.gz: 1c229b285f7e026f7eec53f85c039d561740ee85
+  metadata.gz: c33ece860e06225991997ea016a1bb63296bcc80
+  data.tar.gz: 5ce8ad16bad308ed0b874b27e7e2dd8de467f55f
 SHA512:
-  metadata.gz: 995f18281ce94a1eb31f3b711025cc104d3fa4faf8fb23e01443ca57f4069bbea6a63d755315413705e06a5d204dfcec8934791c126f3fe661db8577016fa473
-  data.tar.gz: 95cd6a320e6055b2ef931c2d56f388fbb0f173b596fc57a59df264b3c0271f28b542c4b9bddbf66a6bd8bd6b71f29792c19254cbfaf52769aa055fe20df0dfda
+  metadata.gz: 473fcd6e4a359e8f3246113a8b5c832408b1dde659038d55444c4fdf82da4d3cd32fc1943dc02b03a92885683a2d75e19b5328f0bd873add7c0dbb22c0e7077f
+  data.tar.gz: de49cd6ffa45fd89f67d9e8c2f396237ba92f9091b352ee9eae3587e3e2ed57d86b7c6423385919f65d0311ee680ec4a9cd8d375974557865bfbe37f103d660e

data/CHANGELOG.md

@@ -32,3 +32,8 @@
 * Removed globbing
 * Set .html.lsg as default file extension
 
+## 0.6.0.alpha.2
+
+* Better support for load paths in Rails
+* Fix for colors
+

data/lib/livingstyleguide/renderer.rb

@@ -3,12 +3,33 @@ require 'erb'
 module LivingStyleGuide::Renderer
 
   def render_living_style_guide
-    @css     = self.render
-    template = File.read(File.join(File.dirname(__FILE__), '..', '..', 'templates', 'layouts', 'default.html.erb'))
-    markdown = LivingStyleGuide.markdown || ""
-    @html    = LivingStyleGuide::RedcarpetTemplate.new{ markdown }.render
+    data = Class.new do
+      attr_accessor :css, :html, :title, :head, :header, :footer
+      include ERB::Util
+      def get_binding; binding end
+    end.new
+    data.css    = self.render
+    markdown    = LivingStyleGuide.markdown || ''
+    data.html   = LivingStyleGuide::RedcarpetTemplate.new{ markdown }.render
+    data.title  = @options[:living_style_guide][:title]
+
+    head        = (@options[:living_style_guide][:javascript_before] || []).map do |src|
+      %Q(<script src="#{src}"></script>)
+    end
+    data.head   = head.join("\n")
+
+    header      = [@options[:living_style_guide][:header]]
+    data.header = header.join("\n")
+
+    footer = [@options[:living_style_guide][:footer]]
+    footer << (@options[:living_style_guide][:javascript_after] || []).map do |src|
+      %Q(<script src="#{src}"></script>)
+    end
+    data.footer = footer.join("\n")
+
     LivingStyleGuide.reset
-    ERB.new(template).result(binding)
+    template   = File.read(File.join(File.dirname(__FILE__), '..', '..', 'templates', 'layouts', 'default.html.erb'))
+    ERB.new(template).result(data.get_binding)
   end
 
 end

data/lib/livingstyleguide/tilt_template.rb

@@ -1,6 +1,7 @@
 require 'tilt'
 require 'erb'
 require 'compass'
+require 'yaml'
 
 module ::Tilt
   class LivingStyleGuideTemplate < Template
@@ -10,26 +11,59 @@ module ::Tilt
     end
 
     def evaluate(scope, locals, &block)
-      engine = ::Sass::Engine.new(data, sass_options)
-      engine.render_living_style_guide
+      parse_options(data)
+      generate_sass
+      render_living_style_guide
     end
 
     private
     def sass_options
       options = Compass.configuration.to_sass_plugin_options
+      if defined?(Rails)
+        options[:load_paths] = options[:load_paths] | Rails.application.config.assets.paths
+      end
       options[:template_location].each do |path, short|
         options[:load_paths] << ::LivingStyleGuide::Importer.new(path)
       end
-      options[:filename] = eval_file
-      options[:line]     = line
-      options[:syntax]   = detect_syntax
-      options[:importer] = LivingStyleGuide::Importer.new('.')
+      options[:filename]           = eval_file
+      options[:line]               = line
+      options[:syntax]             = @options[:syntax]
+      options[:importer]           = LivingStyleGuide::Importer.new('.')
+      options[:living_style_guide] = @options
       options
     end
 
     private
-    def detect_syntax
-      data =~ %r(^//\s*@syntax\s*:\s*sass\s*$) ? :sass : :scss
+    def parse_options(data)
+      @options = YAML.load(data)
+      @options.keys.each do |key|
+        @options[key.gsub('-', '_').to_sym] = @options.delete(key)
+      end
+      @options[:syntax] = @options.has_key?(:styleguide_sass) ? :sass : :scss
+    end
+
+    private
+    def generate_sass
+      @sass = [
+        %Q(@import "#{@options[:source]}"),
+        style_variables,
+        %Q(@import "livingstyleguide"),
+        @options[:styleguide_sass] || @options[:styleguide_scss]
+      ].flatten.join(@options[:syntax] == :sass ? "\n" : ';')
+    end
+
+    private
+    def style_variables
+      return unless @options.has_key?(:style)
+      @options[:style].map do |key, value|
+        "$livingstyleguide--#{key}: #{value}"
+      end
+    end
+
+    private
+    def render_living_style_guide
+      engine = ::Sass::Engine.new(@sass, sass_options)
+      engine.render_living_style_guide
     end
   end
 

data/lib/livingstyleguide/version.rb

@@ -1,3 +1,3 @@
 module LivingStyleGuide
-  VERSION = "0.6.0.alpha.1"
+  VERSION = "0.6.0.alpha.2"
 end

data/stylesheets/livingstyleguide/_content.scss

@@ -2,6 +2,7 @@
 .livingstyleguide--code-block,
 .livingstyleguide--unordered-list,
 .livingstyleguide--ordered-list {
+  color: $livingstyleguide--color;
   display: block;
   font-family: $livingstyleguide--base-font;
   font-size: $livingstyleguide--base-font-size;
@@ -24,6 +25,7 @@
 .livingstyleguide--headline,
 .livingstyleguide--sub-headline,
 .livingstyleguide--sub-sub-headline {
+  color: $livingstyleguide--color;
   display: block;
   font-family: $livingstyleguide--headline-font;
   font-size: $livingstyleguide--headline-font-size;

data/stylesheets/livingstyleguide/_layout.scss

@@ -1,5 +1,4 @@
 .livingstyleguide {
   background: $livingstyleguide--background-color;
-  color: $livingstyleguide--color;
   display: block;
 }

data/templates/layouts/default.html.erb

@@ -5,7 +5,7 @@
 <meta charset="utf-8">
 <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
 <meta content="The LivingStyleGuide Gem – http://livingstyleguide.org" name="generator">
-<title>Living Style Guide</title>
+<title><%= h(@title) %></title>
 <script>
 // see: http://www.hagenburger.net/BLOG/Simple-HTML5-Fix-for-IE.html
 for(var e,l='article aside footer header nav section time picture'.split(' ');e=l.pop();document.createElement(e));
@@ -13,10 +13,13 @@ for(var e,l='article aside footer header nav section time picture'.split(' ');e=
 <style>
 <%= @css %>
 </style>
+<%= @head %>
 </head>
 
 <body class="livingstyleguide">
+<%= @header %>
 <%= @html %>
+<%= @footer %>
 </body>
 
 </html>

data/test/fixtures/standalone/style.scss

@@ -1,2 +1,5 @@
+$my-base-color: green;
+
+@import "compass";
 @import "modules/buttons";
 

data/test/fixtures/standalone/styleguide-with-header-footer.html.lsg

@@ -0,0 +1,7 @@
+source: "style.scss"
+title: "My Nice & Beautiful Living Style Guide"
+header: |
+  <h1>Super Style Guide</h1>
+footer: |
+  <p>Made by me</p>
+

data/test/fixtures/standalone/styleguide-with-javascript.html.lsg

@@ -0,0 +1,8 @@
+source: "style.scss"
+title: "My Nice & Beautiful Living Style Guide"
+javascript-before:
+  - modernizr.js
+javascript-after:
+  - http://code.jquery.com/jquery-2.0.3.js
+  - application.js
+

data/test/fixtures/standalone/styleguide-with-sass.html.lsg

@@ -0,0 +1,6 @@
+source: "style.scss"
+title: "My Nice & Beautiful Living Style Guide"
+styleguide-sass: |
+  #test
+    color: green
+

data/test/fixtures/standalone/styleguide-with-scss.html.lsg

@@ -0,0 +1,7 @@
+source: "style.scss"
+title: "My Nice & Beautiful Living Style Guide"
+styleguide-scss: |
+  #test {
+    color: red;
+  }
+

data/test/fixtures/standalone/styleguide-with-style.html.lsg

@@ -0,0 +1,7 @@
+source: "style.scss"
+title: "My Nice & Beautiful Living Style Guide"
+style:
+  color: red
+  border-radius: 3px
+  code-color: darken($my-base-color, 10%)
+

data/test/fixtures/standalone/styleguide.html.lsg

@@ -1,4 +1,3 @@
-@import "compass";
-@import "style";
-@import "livingstyleguide";
+source: "style.scss"
+title: "My Nice & Beautiful Living Style Guide"
 

data/test/integration/standalone_test.rb

@@ -4,9 +4,44 @@ require 'tilt'
 class MarkdownTest < Test::Unit::TestCase
 
   def test_standalone_project
-    html = Tilt.new('test/fixtures/standalone/styleguide.html.lsg').render
+    html = render('test/fixtures/standalone/styleguide.html.lsg')
     assert_match %r(background: red), html
     assert_match %r(<button class="button">), html
+    assert_match %r(<title>My Nice &amp; Beautiful Living Style Guide</title>), html
+  end
+
+  def test_custom_styles
+    html = render('test/fixtures/standalone/styleguide-with-style.html.lsg')
+    assert_match %r(.livingstyleguide--ordered-list { color: red;), html
+    assert_match %r(border-radius: 3px), html
+    assert_match %r(em { color: green;), html
+  end
+
+  def test_javascript_includes
+    html = render('test/fixtures/standalone/styleguide-with-javascript.html.lsg')
+    assert_match %r(<script src="modernizr.js"></script>.*</head>), html
+    assert_match %r(<script src="http://code.jquery.com/jquery-2.0.3.js"></script> <script src="application.js"></script> </body>), html
+  end
+
+  def test_additional_scss_code
+    html = render('test/fixtures/standalone/styleguide-with-scss.html.lsg')
+    assert_match %r(#test { color: red; }), html
+  end
+
+  def test_additional_sass_code
+    html = render('test/fixtures/standalone/styleguide-with-sass.html.lsg')
+    assert_match %r(#test { color: green; }), html
+  end
+
+  def test_header_footer
+    html = render('test/fixtures/standalone/styleguide-with-header-footer.html.lsg')
+    assert_match %r(<h1>Super Style Guide</h1>), html
+    assert_match %r(<p>Made by me</p>), html
+  end
+
+  private
+  def render(file)
+    Tilt.new(file).render.gsub(/\s+/, ' ')
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livingstyleguide
 version: !ruby/object:Gem::Version
-  version: 0.6.0.alpha.1
+  version: 0.6.0.alpha.2
 platform: ruby
 authors:
 - Nico Hagenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minisyntax
@@ -190,6 +190,11 @@ files:
 - test/fixtures/standalone/modules/_buttons.md
 - test/fixtures/standalone/modules/_buttons.scss
 - test/fixtures/standalone/style.scss
+- test/fixtures/standalone/styleguide-with-header-footer.html.lsg
+- test/fixtures/standalone/styleguide-with-javascript.html.lsg
+- test/fixtures/standalone/styleguide-with-sass.html.lsg
+- test/fixtures/standalone/styleguide-with-scss.html.lsg
+- test/fixtures/standalone/styleguide-with-style.html.lsg
 - test/fixtures/standalone/styleguide.html.lsg
 - test/fixtures/stylesheets/variables/_more-other-colors.sass
 - test/fixtures/stylesheets/variables/colors.scss
@@ -239,6 +244,11 @@ test_files:
 - test/fixtures/standalone/modules/_buttons.md
 - test/fixtures/standalone/modules/_buttons.scss
 - test/fixtures/standalone/style.scss
+- test/fixtures/standalone/styleguide-with-header-footer.html.lsg
+- test/fixtures/standalone/styleguide-with-javascript.html.lsg
+- test/fixtures/standalone/styleguide-with-sass.html.lsg
+- test/fixtures/standalone/styleguide-with-scss.html.lsg
+- test/fixtures/standalone/styleguide-with-style.html.lsg
 - test/fixtures/standalone/styleguide.html.lsg
 - test/fixtures/stylesheets/variables/_more-other-colors.sass
 - test/fixtures/stylesheets/variables/colors.scss