livingstyleguide 1.4.0 → 2.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa8cf5b8726aaeabb5c0e59baf87d93f5f9ce41c
-  data.tar.gz: 8b2c367808f1abbfa267de3c1a8689e9152f3511
+  metadata.gz: a49c1cde2fda30398815711988fe1e027bce952a
+  data.tar.gz: f1dfdca1b72c4ff39fbfa139f443528d5797d524
 SHA512:
-  metadata.gz: 94a53a8a0f02df6c2da30aad6425711dd14377ab8f7b51e20ef31bca3c4d7ef628e0cb1bf50ae0c161d7b191a1e5637202760f0682c41ede6ec1da0e077566ce
-  data.tar.gz: c00e08bb24b0feb48e8cdd4ef02db957c7d7283cdacc93d880eb0d9d0785ba514c31470b31cad3a3fc6fa76922ce18dcbe27935f9a9b8c2acb96710be8af2f1d
+  metadata.gz: b7a55067c4098eb7ba738970330e3a5d250771c2836dfcfef23a005bf68b6ba17a5cec64a970a929cf7641cc4a89c8324a5875a5c906b3a59c68f5add6e393b5
+  data.tar.gz: d3774e206d621568b6ebb96cfafdbe2379ed1fe26ff6607e4feaf3db396df1bc3bda1a5e4409ee0c10bb1fa465fefe4e6ce793de057135fdd51c21a77303b10d

data/lib/livingstyleguide.rb

@@ -6,6 +6,12 @@ begin
 rescue LoadError
 end
 
+module LivingStyleGuide
+  def self.add_filter(*keys, &block)
+    Filters.add_filter(*keys, &block)
+  end
+end
+
 require 'livingstyleguide/version'
 require 'livingstyleguide/filter_hooks'
 require 'livingstyleguide/sass_extensions'
@@ -14,9 +20,6 @@ require 'livingstyleguide/markdown_extensions'
 require 'livingstyleguide/tilt_template'
 require 'livingstyleguide/code_block'
 require 'livingstyleguide/example'
+require 'livingstyleguide/document'
 require 'livingstyleguide/filters'
 require 'livingstyleguide/integration'
-
-module LivingStyleGuide
-end
-

data/lib/livingstyleguide/document.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require 'tilt'
+require 'erb'
+require 'digest'
+
+class LivingStyleGuide::Document < ::Tilt::Template
+  attr_accessor :source, :type, :filters, :template, :classes, :html
+  attr_accessor :css, :id, :locals
+  attr_accessor :title
+  attr_reader :scope
+
+  %w(scss head header footer).each do |attr|
+    define_method attr do
+      if options.has_key?(:livingstyleguide)
+        options[:livingstyleguide].send(attr)
+      else
+        instance_variable_get("@#{attr}")
+      end
+    end
+
+    define_method "#{attr}=" do |value|
+      if options.has_key?(:livingstyleguide)
+        options[:livingstyleguide].send("#{attr}=", value)
+      else
+        instance_variable_get("@#{attr}", value)
+      end
+    end
+  end
+
+  def prepare
+    @type = :markdown
+    @filters = LivingStyleGuide::Filters.new(self)
+    @template = options.has_key?(:livingstyleguide) ? :default : :layout
+    @classes = []
+    @scss = ''
+    @css = ''
+    @locals = {}
+  end
+
+  def source
+    @source ||= erb.gsub(/<%.*?%>\n?/, '')
+  end
+
+  def css
+    scss_with_lsg = "#{scss}; @import 'livingstyleguide';"
+    ::Sass::Engine.new(scss_with_lsg, syntax: :scss).render
+  end
+
+  def id
+    @id ||= generate_id
+  end
+
+  def erb
+    @erb ||= parse_filters do |name, arguments|
+      arguments = arguments.map do |argument|
+        %Q("#{argument.gsub('"', '\\"').gsub("\n", '\\n')}")
+      end
+      "<%= #{name}(#{arguments.join(', ')}) %>"
+    end
+  end
+
+  def evaluate(scope, locals, &block)
+    @scope = scope
+    depend_on file if file and options.has_key?(:livingstyleguide)
+    result = ERB.new(erb).result(@filters.get_binding)
+    @html = case @type
+    when :plain, :example
+      result
+    when :markdown
+      renderer = LivingStyleGuide::RedcarpetHTML.new(LivingStyleGuide::Engine.default_options, self)
+      redcarpet = ::Redcarpet::Markdown.new(renderer, LivingStyleGuide::REDCARPET_RENDER_OPTIONS)
+      redcarpet.render(result)
+    else
+      require "tilt/#{@type}"
+      template_class.new{ result }.render(@scope, @locals.merge(locals))
+    end
+    @classes.unshift "livingstyleguide--#{@type}-example"
+    @classes.unshift "livingstyleguide--example"
+    ERB.new(template_erb).result(binding).gsub(/\n\n+/, "\n")
+  end
+
+  def depend_on(file)
+    @scope.depend_on(File.expand_path(file)) if @scope.respond_to?(:depend_on)
+  end
+
+  private
+  def template_erb
+    File.read("#{File.dirname(__FILE__)}/templates/#{@template}.html.erb")
+  end
+
+  private
+  def parse_filters
+    (@type == :erb ? data.gsub('<%', '<%%') : data).gsub(/\G(.*?)((```.+?```)|\Z)/m) do
+      content, code_block = $1, $2
+      content.gsub(/@([\w\d_-]+)(?: ([^\{\n]+))?(?: *\{\n((?:.|\n)*?)\n\}|\n((?:  .*\n)+))?/) do
+        name, arguments, block = $1, $2 || '', $3 || $4
+        name = name.gsub('-', '_').to_sym
+        arguments = arguments.split(',').map(&:strip)
+        if block
+          arguments << block.gsub(/\A(\s*)((?:.|\n)+)\Z/){ $2.gsub(/^#{$1}/, '') }
+        end
+        yield name, arguments
+      end + code_block
+    end
+  end
+
+  private
+  def gsub_content(regexp, &block)
+    if @type == :markdown
+      data.gsub(/\G(.+?)((```.+?```)|\Z)/m) do
+        content, code_block = $1, $2
+        content.to_s.gsub(regexp, &block) + code_block
+      end
+    else
+      data.gsub(regexp, &block)
+    end
+  end
+
+  private
+  def template_name
+    @type == :markdown ? :redcarpet : @type
+  end
+
+  private
+  def template_class
+    case @type
+    when :coffee then Tilt::CoffeeScriptTemplate
+    when :erb    then Tilt::ERBTemplate
+    else Tilt.const_get(@type.to_s.capitalize + 'Template')
+    end
+  end
+
+  private
+  def generate_id
+    if @file
+      @file.sub('/_', '/').gsub(/\.\w+/, '')
+    else
+      "section-#{Digest::SHA256.hexdigest(data)[0...6]}"
+    end
+  end
+end
+
+Tilt.register 'lsg', LivingStyleGuide::Document

data/lib/livingstyleguide/engine.rb

@@ -4,7 +4,7 @@ module LivingStyleGuide
     attr_accessor :markdown, :files, :options, :variables
 
     @@default_options = {
-      default_language: 'example',
+      default_language: :example,
       title: 'Living Style Guide',
       header: '<h1 class="livingstyleguide--page-title">Living Style Guide</h1>',
       footer: '<div class="livingstyleguide--footer"><a class="livingstyleguide--logo" href="http://livingstyleguide.org">Made with the LivingStyleGuide gem.</a></div>',

data/lib/livingstyleguide/filters.rb

@@ -1,9 +1,31 @@
+class LivingStyleGuide::Filters
+  attr_reader :document
+
+  def initialize(doc)
+    @document = doc
+  end
+
+  def get_binding
+    binding
+  end
+
+  def self.add_filter(*keys, &block)
+    keys.each do |key|
+      define_method key, &block
+    end
+  end
+end
+
+require 'livingstyleguide/filters/options'
+require 'livingstyleguide/filters/import'
 require 'livingstyleguide/filters/highlights'
 require 'livingstyleguide/filters/full_width'
 require 'livingstyleguide/filters/haml'
+require 'livingstyleguide/filters/markdown'
 require 'livingstyleguide/filters/javascript'
 require 'livingstyleguide/filters/coffee_script'
 require 'livingstyleguide/filters/add_wrapper_class'
 require 'livingstyleguide/filters/font_example'
 require 'livingstyleguide/filters/colors'
-
+require 'livingstyleguide/filters/scss'
+require 'livingstyleguide/filters/data'

data/lib/livingstyleguide/filters/add_wrapper_class.rb

@@ -2,3 +2,6 @@ LivingStyleGuide::Example.add_filter :add_wrapper_class do |css_class|
   add_wrapper_class css_class
 end
 
+LivingStyleGuide.add_filter :add_wrapper_class do |css_class|
+  document.classes << css_class
+end

data/lib/livingstyleguide/filters/coffee_script.rb

@@ -16,3 +16,8 @@ LivingStyleGuide::Example.add_filter :coffee_script do
   end
 end
 
+
+LivingStyleGuide.add_filter :coffee_script, :coffee do
+  document.type = :coffee
+  nil
+end

data/lib/livingstyleguide/filters/colors.rb

@@ -21,9 +21,31 @@ LivingStyleGuide::Example.add_filter :colors do |file|
       elsif variable[0] != '$'
         variable = "$#{variable}"
       end
-      %Q(<li class="livingstyleguide--color-swatch #{css_class || variable.tr("_", "-")}">#{variable}</li>\n)
+      %Q(<li class="livingstyleguide--color-swatch #{css_class || variable}">#{variable}</li>\n)
     end.join("\n")
     %(<ul class="livingstyleguide--color-swatches -lsg-#{columns}-columns">\n#{colors_html}\n</ul>\n)
   end
 end
 
+LivingStyleGuide.add_filter :colors do |content|
+  colors = content.split(/\n+/).map{ |l| l.split(/\s+/) }
+  columns = colors.map{ |l| l.size }.max
+  colors = colors.flatten
+  document.scss << <<-SCSS
+    $livingstyleguide--variables: () !default;
+    $livingstyleguide--variables: join(
+      $livingstyleguide--variables, (#{
+        colors.reject{ |c| c == '-' }.map do |variable|
+          %Q("#{variable}": #{variable})
+        end.join(', ')
+      })
+    );
+  SCSS
+  colors_html = colors.map do |variable|
+    if variable == '-'
+      css_class = '-lsg-empty'
+    end
+    %Q(<li class="livingstyleguide--color-swatch #{css_class || variable}">#{variable}</li>\n)
+  end.join("\n")
+  %(<ul class="livingstyleguide--color-swatches -lsg-#{columns}-columns">\n#{colors_html}\n</ul>\n)
+end

data/lib/livingstyleguide/filters/data.rb

@@ -0,0 +1,3 @@
+LivingStyleGuide.add_filter :data do |data|
+  document.locals.merge! JSON.parse("{#{data}}")
+end

data/lib/livingstyleguide/filters/font_example.rb

@@ -19,3 +19,11 @@ LivingStyleGuide::Example.add_filter :font_example do |font|
   end
 end
 
+LivingStyleGuide.add_filter :font_example do |font, text = nil|
+  text ||= LivingStyleGuide::Engine.default_options[:font_example][:text]
+  text = ERB::Util.html_escape(text)
+  text.strip!
+  text.gsub!(/\n/, "<br>\n")
+  font = ERB::Util.html_escape(font)
+  ERB.new(File.read("#{File.dirname(__FILE__)}/../templates/font-example.html.erb")).result(binding)
+end

data/lib/livingstyleguide/filters/full_width.rb

@@ -2,3 +2,6 @@ LivingStyleGuide::Example.add_filter :full_width do
   add_wrapper_class '-lsg-has-full-width'
 end
 
+LivingStyleGuide.add_filter :full_width do
+  document.classes << '-lsg-has-full-width'
+end

data/lib/livingstyleguide/filters/haml.rb

@@ -14,3 +14,8 @@ LivingStyleGuide::Example.add_filter :haml do
   end
 end
 
+
+LivingStyleGuide.add_filter :haml do
+  document.type = :haml
+  nil
+end

data/lib/livingstyleguide/filters/import.rb

@@ -0,0 +1,18 @@
+require 'tilt'
+
+LivingStyleGuide.add_filter :import do |glob, data = nil|
+  glob << '.lsg' unless glob =~ /\.(\w+|\*)$/
+  glob.gsub!(/[^\/]+$/, '{_,}\\0')
+  if data
+    data = JSON.parse("{#{data}}")
+  end
+  Dir.glob(glob).map do |file|
+    if file =~ /\.s[ac]ss$/
+      document.depend_on file
+      document.scss << %Q(@import "#{file}";\n)
+      nil
+    else
+      ::Tilt.new(file, livingstyleguide: document).render(document.scope, data)
+    end
+  end.join
+end

data/lib/livingstyleguide/filters/markdown.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.add_filter :markdown do
+  document.type = :markdown
+  nil
+end

data/lib/livingstyleguide/filters/options.rb

@@ -0,0 +1,18 @@
+LivingStyleGuide.add_filter :set do |option|
+  if option =~ /^([\w\-]+):\s+(.+)$/
+    key, value = $1, $2
+    key = key.downcase.gsub('-', '_').to_sym
+    value = case value
+    when 'true'
+      true
+    when 'false'
+      false
+    when /^\d+$/
+      value.to_i
+    else
+      value
+    end
+    document.options[key] = value
+  end
+  nil
+end

data/lib/livingstyleguide/filters/scss.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.add_filter :scss do |source|
+  document.scss << "##{document.id.gsub('/', '\\/')} {\n#{source}\n}\n"
+  nil
+end

data/lib/livingstyleguide/integration.rb

@@ -1,4 +1,4 @@
 require 'livingstyleguide/integration/compass'
 require 'livingstyleguide/integration/rails'
 require 'livingstyleguide/integration/sprockets'
-
+require 'livingstyleguide/integration/sass'

data/lib/livingstyleguide/integration/rails.rb

@@ -3,9 +3,7 @@ if defined?(Rails) and defined?(Rails::Railtie)
   require 'rails'
   class LivingStyleGuideRailtie < Rails::Railtie
     initializer 'living_style_guide.assets' do
-      Rails.application.config.assets.configure do |env|
-        env.register_engine('.lsg', ::LivingStyleGuide::TiltTemplate)
-      end
+      Rails.application.assets.register_engine('.lsg', ::LivingStyleGuide::Document)
     end
   end
 

data/lib/livingstyleguide/integration/sass.rb

@@ -0,0 +1,6 @@
+sass_directory = File.join(File.dirname(__FILE__), '..', '..', '..', 'stylesheets')
+if ENV.has_key?("SASS_PATH")
+  ENV["SASS_PATH"] = ENV["SASS_PATH"] + File::PATH_SEPARATOR + sass_directory
+else
+  ENV["SASS_PATH"] = sass_directory
+end

data/lib/livingstyleguide/integration/sprockets.rb

@@ -1,6 +1,6 @@
 begin
   require 'sprockets'
-  Sprockets.register_engine('.lsg', ::LivingStyleGuide::TiltTemplate)
+  Sprockets.register_engine('.lsg', ::LivingStyleGuide::Document)
 rescue LoadError
 end
 

data/lib/livingstyleguide/markdown_extensions.rb

@@ -15,9 +15,9 @@ module LivingStyleGuide
 
   class RedcarpetHTML < ::Redcarpet::Render::HTML
 
-    def initialize(options = {}, engine)
+    def initialize(options = {}, document)
       @options = options
-      @engine = engine
+      @document = document
       super @options
     end
 
@@ -42,12 +42,12 @@ module LivingStyleGuide
     end
 
     def block_code(code, language)
-      language ||= @options[:default_language]
-      if language == 'example'
-        Example.new(code, @options, @engine).render
-      else
-        CodeBlock.new(code.strip, language.to_s.strip.to_sym).render
-      end
+      language = language.to_s.strip.to_sym
+      language = @options[:default_language] if language == :''
+      document = Document.new(livingstyleguide: @document) { code }
+      document.type = language == :example ? :plain : language
+      document.template = template_for(language)
+      document.render(@document.scope)
     end
 
     def codespan(code)
@@ -63,6 +63,9 @@ module LivingStyleGuide
       text.downcase.gsub(/[ _\.\-!\?\(\)\[\]]+/, '-').gsub(/^-|-$/, '')
     end
 
+    private
+    def template_for(language)
+      language == :example ? :example : :code
+    end
   end
 end
-

data/lib/livingstyleguide/templates/default.html.erb

@@ -0,0 +1,3 @@
+<section id="<%= id %>">
+  <%= html %>
+</section>

data/lib/livingstyleguide/templates/example.html.erb

@@ -0,0 +1,8 @@
+<section class="<%= classes.join(' ') %>">
+  <div class="livingstyleguide--html">
+    <%= html %>
+  </div>
+  <pre class="livingstyleguide--code-block"><code class="livingstyleguide--code"><%=
+    [:plain].index(type) ? source : ::MiniSyntax.highlight(source, type)
+  %></code></pre>
+</section>

data/lib/livingstyleguide/templates/font-example.html.erb

@@ -0,0 +1,3 @@
+<div class="livingstyleguide--font-example" style="font: <%= font %>">
+  <%= text %>
+</div>

data/lib/livingstyleguide/templates/layout.html.erb

@@ -4,9 +4,8 @@
 <head>
 <meta charset="utf-8">
 <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
-<meta content="width=device-width, initial-scale=1.0" name="viewport">
 <meta content="The LivingStyleGuide Gem – http://livingstyleguide.org" name="generator">
-<title><%= h(title) %></title>
+<title><%= ERB::Util.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));
@@ -26,4 +25,3 @@ for(var e,l='article aside footer header nav section time picture'.split(' ');e=
 </body>
 
 </html>
-

data/lib/livingstyleguide/templates/plain.html.erb

@@ -0,0 +1 @@
+<%= html %>

data/lib/livingstyleguide/tilt_template.rb

@@ -85,9 +85,6 @@ module LivingStyleGuide
           break
         end
         path = File.expand_path('..', path)
-        if path == "/"
-          break
-        end
       end
       path
     end
@@ -101,6 +98,3 @@ module LivingStyleGuide
     end
   end
 end
-
-Tilt.register 'lsg', LivingStyleGuide::TiltTemplate
-

data/lib/livingstyleguide/version.rb

@@ -1,3 +1,3 @@
 module LivingStyleGuide
-  VERSION = '1.4.0'
+  VERSION = '2.0.0.alpha.1'
 end

data/stylesheets/livingstyleguide/_code.scss

@@ -74,7 +74,7 @@
 .livingstyleguide--code-block {
   display: block;//none;
   line-height: $livingstyleguide--code-line-height;
-  padding: 3px 6px;
+  padding: 3px $livingstyleguide--gap-width;
   width: $livingstyleguide--width;
 
   .show-code & {

data/stylesheets/livingstyleguide/_content.scss

@@ -105,4 +105,10 @@
   &.-lsg-for-javascript {
     display: none;
   }
+
+  .livingstyleguide--code-block {
+    margin-bottom: -$livingstyleguide--gap-width;
+    margin-left: -$livingstyleguide--gap-width;
+    margin-right: -$livingstyleguide--gap-width;
+  }
 }

data/stylesheets/livingstyleguide/_variables.scss

@@ -1,9 +1,16 @@
-$livingstyleguide--variables: global-variables() !default;
+$livingstyleguide--variables: () !default;
 
 @each $variable, $value in $livingstyleguide--variables {
   $value: null !default;
   @if $value != null {
-    .\$#{$variable} {
+    $selector: $variable;
+    @if str-slice($variable, 1, 1) == "$" or str-slice($variable, 1, 1) == "#" {
+      $selector: "\\" + $selector;
+    }
+    @if str-slice($variable, -2, -1) == "()" {
+      $selector: str-slice($variable, 1, -3) + "\\(\\)";
+    }
+    .#{$selector} {
       @if type-of($value) == color {
         @if (lightness($value) < lightness($livingstyleguide--color)) {
           color: $livingstyleguide--background-color;
@@ -21,4 +28,3 @@ $livingstyleguide--variables: global-variables() !default;
     }
   }
 }
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livingstyleguide
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 2.0.0.alpha.1
 platform: ruby
 authors:
 - Nico Hagenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-18 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minisyntax
@@ -42,16 +42,16 @@ dependencies:
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.3
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +192,7 @@ files:
 - lib/livingstyleguide.rb
 - lib/livingstyleguide/code_block.rb
 - lib/livingstyleguide/command_line_interface.rb
+- lib/livingstyleguide/document.rb
 - lib/livingstyleguide/engine.rb
 - lib/livingstyleguide/example.rb
 - lib/livingstyleguide/filter_hooks.rb
@@ -199,19 +200,29 @@ files:
 - lib/livingstyleguide/filters/add_wrapper_class.rb
 - lib/livingstyleguide/filters/coffee_script.rb
 - lib/livingstyleguide/filters/colors.rb
+- lib/livingstyleguide/filters/data.rb
 - lib/livingstyleguide/filters/font_example.rb
 - lib/livingstyleguide/filters/full_width.rb
 - lib/livingstyleguide/filters/haml.rb
 - lib/livingstyleguide/filters/highlights.rb
+- lib/livingstyleguide/filters/import.rb
 - lib/livingstyleguide/filters/javascript.rb
+- lib/livingstyleguide/filters/markdown.rb
+- lib/livingstyleguide/filters/options.rb
+- lib/livingstyleguide/filters/scss.rb
 - lib/livingstyleguide/integration.rb
 - lib/livingstyleguide/integration/compass.rb
 - lib/livingstyleguide/integration/rails.rb
+- lib/livingstyleguide/integration/sass.rb
 - lib/livingstyleguide/integration/sprockets.rb
 - lib/livingstyleguide/markdown_extensions.rb
 - lib/livingstyleguide/sass_extensions.rb
 - lib/livingstyleguide/sass_extensions/functions.rb
+- lib/livingstyleguide/templates/default.html.erb
+- lib/livingstyleguide/templates/example.html.erb
+- lib/livingstyleguide/templates/font-example.html.erb
 - lib/livingstyleguide/templates/layout.html.erb
+- lib/livingstyleguide/templates/plain.html.erb
 - lib/livingstyleguide/tilt_template.rb
 - lib/livingstyleguide/version.rb
 - stylesheets/_livingstyleguide.scss
@@ -234,12 +245,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Generate beautiful front-end style guides