livingstyleguide 2.0.0.pre.3 → 2.0.0.pre.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a121cfdb20c0610f7812247a4566ae7143f97ca4
-  data.tar.gz: 83af58f208d28380bfb9e38546c6c1612313e407
+  metadata.gz: 25ce8afc33ae405fcf54ef052d1a3faa6e25b20b
+  data.tar.gz: f285f19dcea8ef29dcc9044ad9ecc21b7dc476e2
 SHA512:
-  metadata.gz: c41a5dd16192b78f8c42e2ceb2753d8e83ef9e32e767495bd68fa0f22ce0a6674f4eb82d8aa63a0dd2f208a75e03265cb175b8152d2b55f986c7b53ce1e467cb
-  data.tar.gz: 399f81fd8d0a3e4d358d65294790e8cf21ed8713c8d3bc721d2fc671d8609ef149f355b75f363933cb983a27fb31477ed31937ecc35d4961db93f955e5887c32
+  metadata.gz: 651a10ac4ce32ced56f0b1a99c01347bd2c96ef5687db65ad2e3e947855ed595257e97edbae6a7225bf6cbd1fe8f77678c2ecfe4acb7cbcd907011969730fec2
+  data.tar.gz: 34d1320a6adf0fe9ea7bad92d885c44873149661ef1827bd1fd07d69b2f24ca8b4d1d00d5062a14cfe3bd0e4cc18f7a2d659c038f72f77f679486295ce232444

data/bin/livingstyleguide

@@ -2,7 +2,7 @@
 
 require "rubygems"
 begin
-require "bundler/setup"
+  require "bundler/setup"
 rescue LoadError
 end
 

data/lib/livingstyleguide/command_line_interface.rb

@@ -3,8 +3,8 @@ require "tilt"
 
 module LivingStyleGuide
   class CommandLineInterface < Thor
-
-    desc "compile input_file output_file", "Compiles the living style guide to HTML."
+    desc "compile input_file output_file",
+         "Compiles the living style guide to HTML."
     def compile(input_file = nil, output_file = nil)
       doc = LivingStyleGuide::Document.new(input_file) do
         input(input_file)
@@ -12,34 +12,37 @@ module LivingStyleGuide
       output doc.render, input_file, output_file
     end
 
-    desc "version", "Shows the current version of the Gem"
+    desc "version",
+         "Shows the current version of the Gem"
     def version
       puts "LivingStyleGuide #{LivingStyleGuide::VERSION}"
     end
 
     private
+
     def input(input_file = nil)
       @input ||= if input_file.nil?
-        $stdin.read
-      else
-        File.read(input_file)
-      end
+                   $stdin.read
+                 else
+                   File.read(input_file)
+                 end
     end
 
-    private
     def output(html, input_file = nil, output_file = nil)
       if input_file.nil?
         puts html
       else
-        output_file = input_file.sub(/(\.html)?\.lsg$/, ".html") if output_file.nil?
+        if output_file.nil?
+          output_file = input_file.sub(/(\.html)?\.lsg$/, ".html")
+        end
         if defined?(Compass)
           Compass.add_project_configuration
-          output_file = output_file.sub(/^#{Compass.configuration.sass_dir}/, Compass.configuration.css_dir)
+          output_file = output_file.sub(/^#{Compass.configuration.sass_dir}/,
+                                        Compass.configuration.css_dir)
         end
         File.write output_file, html
         puts "Successfully generated a living style guide at #{output_file}."
       end
     end
-
   end
 end

data/lib/livingstyleguide/commands/colors.rb

@@ -1,35 +1,35 @@
 require "digest/sha1"
 
 LivingStyleGuide.command :colors do |arguments, options, content|
-  colors = content.split(/\n+/).map{ |l| l.strip.split(/(?<![,\(])\s+(?!\))/) }
-  columns = colors.map{ |l| l.size }.max
+  colors = content.split(/\n+/).map { |l| l.strip.split(/(?<![,\(])\s+(?!\))/) }
+  columns = colors.map(&:size).max
   colors = colors.flatten
 
   def color_class(color)
-    "lsg--color-" + Digest::SHA1.hexdigest(color)[0..7]
+    "lsg-color-" + Digest::SHA1.hexdigest(color)[0..7]
   end
 
+  colors_as_sass_map = colors.reject { |c| c == "-" }.uniq.map do |color|
+    %Q("#{color_class(color)}": #{color})
+  end.join(", ")
   document.scss << <<-SCSS
-    $lsg--colors: () !default;
-    $lsg--colors: join(
-      $lsg--colors, (#{
-        colors.reject{ |c| c == '-' }.map do |color|
-          %Q("#{color_class(color)}": #{color})
-        end.join(', ')
-      })
-    );
+    $lsg-colors: () !default;
+    $lsg-colors: join($lsg-colors, (#{colors_as_sass_map}));
   SCSS
 
   colors_html = colors.map do |color|
     if color == "-"
-      %Q(<li class="lsg--color-swatch -lsg-empty"></li>\n)
+      %(<li class="lsg-color-swatch lsg-empty"></li>\n)
     else
       unless color =~ /^(#[0-9a-f]{3,6}|[a-z]+)$/
-        source = %Q(<span class="lsg--color-swatch-source">#{color}</span>)
+        source = %(<span class="lsg-color-swatch-source">#{color}</span>)
       end
-      value = %Q(<span class="lsg--color-swatch-value #{color_class(color)}"></span>)
-      %Q(<li class="lsg--color-swatch #{color_class(color)}">#{source}#{value}</li>\n)
+      class_name = "lsg-color-swatch-value #{color_class(color)}"
+      value = %(<span class="#{class_name}"></span>)
+      class_name = "lsg-color-swatch #{color_class(color)}"
+      %(<li class="#{class_name}">#{source}#{value}</li>\n)
     end
   end.join("\n")
-  %(<ul class="lsg--color-swatches -lsg-#{columns}-columns">\n#{colors_html}\n</ul>\n)
+  class_name = "lsg-color-swatches lsg-#{columns}-columns"
+  %(<ul class="#{class_name}">\n#{colors_html}\n</ul>\n)
 end

data/lib/livingstyleguide/commands/default.rb

@@ -1,5 +1,5 @@
 LivingStyleGuide.command :default do |arguments, options, block|
-  key = arguments.first ? arguments.first.gsub("-", "_").to_sym : :global
+  key = arguments.first ? arguments.first.tr("-", "_").to_sym : :global
   document.defaults[key] ||= {}
   document.defaults[key].merge!(options)
   nil

data/lib/livingstyleguide/commands/font_example.rb

@@ -1,4 +1,5 @@
-LivingStyleGuide.default_options[:font_example] = { text: <<-TEXT }
+LivingStyleGuide.default_options[:font_example] ||= {}
+LivingStyleGuide.default_options[:font_example][:text] ||= <<-TEXT
   Aa
   ABCDEFGHIJKLMNOPQRSTUVWXYZ
   abcdefghijklmnopqrstuvwxyz

data/lib/livingstyleguide/commands/full_width.rb

@@ -1,4 +1,4 @@
 LivingStyleGuide.command :full_width do |arguments, options, block|
-  document.classes << '-lsg-has-full-width'
+  document.classes << "lsg-has-full-width"
   nil
 end

data/lib/livingstyleguide/commands/import_and_use.rb

@@ -1,11 +1,19 @@
 require "tilt"
 
-def map_files(glob, &block)
+def map_files(glob)
   glob << ".lsg" unless glob =~ /\.(\w+|\*)$/
   glob.gsub!(/[^\/]+$/, "{_,}\\0")
   glob = File.join(document.path, glob)
 
-  Dir.glob(glob).map do |file|
+  files = Dir.glob(glob)
+  if glob.index("*")
+    files.uniq!
+    files.reject! { |f| document.files.include?(f) }
+  else
+    raise Errno::ENOENT if files.empty?
+  end
+
+  files.map do |file|
     document.depend_on file
     yield(file)
   end.join
@@ -14,13 +22,17 @@ end
 LivingStyleGuide.command :import do |arguments, options, data|
   glob = arguments.first
   if glob =~ /\.s[ac]ss$/
-    raise "Error: Please use `@css #{glob}` instead of `@import #{glob}` for importing Sass."
+    raise <<-ERROR.strip.squeeze
+      Error: Please use `@css #{glob}` instead of `@import #{glob}`
+      for importing Sass.
+    ERROR
   end
 
   data = LivingStyleGuide.parse_data(data)
 
   map_files glob do |file|
-    html = ::Tilt.new(file, livingstyleguide: document).render(document.scope, data)
+    template = ::Tilt.new(file, livingstyleguide: document)
+    html = template.render(document.scope, data)
     html.gsub!("\n", "\n  ")
     "\n<div>\n#{html}\n</div>\n"
   end

data/lib/livingstyleguide/commands/layout.rb

@@ -3,30 +3,32 @@ LivingStyleGuide.command :title do |arguments, options, block|
   nil
 end
 
-{ :before => :head, :after => :footer }.each do |name, destination|
-  eval <<-RUBY
-    LivingStyleGuide.command :javascript_#{name} do |arguments, options, block|
-      if src = arguments.first
-        document.#{destination} << %Q(<script src="\#{src}"></script>)
-      else
-        if options[:transpiler] == "coffee-script"
-          block = Tilt["coffee"].new{ block }.render
-        end
-        document.#{destination} << %Q(<script>\\n\#{block}\\n</script>)
+{ before: :head, after: :footer }.each do |name, destination|
+  LivingStyleGuide.command :"javascript_#{name}" do |arguments, options, block|
+    content = document.send(:"#{destination}")
+    if src = arguments.first
+      content << %Q(<script src="#{src}"></script>)
+    else
+      if options[:transpiler] == "coffee-script"
+        block = Tilt["coffee"].new { block }.render
       end
-      nil
+      content << %Q(<script>\n#{block}\n</script>)
     end
-  RUBY
+    document.send(:"#{destination}=", content)
+    nil
+  end
 end
 
-%w(head header footer before after).each do |part|
-  eval <<-RUBY
-    LivingStyleGuide.command :#{part} do |arguments, options, block|
-      html = LivingStyleGuide::Document.new(livingstyleguide: document) { block }
-      html.type = options[:type]
-      document.#{part} << html.render + "\n"
-      nil
+%w(head header footer before after).each do |destination|
+  LivingStyleGuide.command :"#{destination}" do |arguments, options, block|
+    content = document.send(:"#{destination}")
+    html = LivingStyleGuide::Document.new(livingstyleguide: document) do
+      block
     end
-  RUBY
+    html.type = options[:type]
+    content << html.render + "\n"
+    document.send(:"#{destination}=", content)
+    nil
+  end
   nil
 end

data/lib/livingstyleguide/commands/options.rb

@@ -1,15 +1,15 @@
 LivingStyleGuide.command :set do |arguments, options, block|
   options.each do |key, value|
     document.options[key] = case value
-    when "true"
-      true
-    when "false"
-      false
-    when /^\d+$/
-      value.to_i
-    else
-      value
-    end
+                            when "true"
+                              true
+                            when "false"
+                              false
+                            when /^\d+$/
+                              value.to_i
+                            else
+                              value
+                            end
   end
   nil
 end

data/lib/livingstyleguide/commands/sass.rb

@@ -2,14 +2,14 @@ require "sass"
 
 LivingStyleGuide.command :scss do |arguments, options, scss|
   file = arguments.first
-  if file
+  if options[:scope] == "global" || file == "!global"
+    document.scss << scss
+  elsif file
     if document.file
       file = File.join(File.dirname(document.file), file)
     end
     document.depend_on file
     document.scss << %Q(@import "#{file}";\n)
-  elsif options[:scope] == "global"
-    document.scss << scss
   else
     id = document.id.gsub(/[\/\.]/, '\\\\\0')
     document.scss << "##{id} {\n#{scss}\n}\n"
@@ -18,12 +18,6 @@ LivingStyleGuide.command :scss do |arguments, options, scss|
 end
 
 LivingStyleGuide.command :sass do |arguments, options, sass|
-  file = arguments.first
-  if file
-    scss(arguments, options, nil)
-  else
-    converted = Sass::Engine.new(sass).to_tree.to_scss
-    scss(arguments, options, converted)
-  end
-  nil
+  converted = Sass::Engine.new(sass).to_tree.to_scss unless sass.nil?
+  scss(arguments, options, converted)
 end

data/lib/livingstyleguide/commands/search_box.rb

@@ -3,8 +3,11 @@ LivingStyleGuide.default_options[:search_box] = {
 }
 
 LivingStyleGuide.command :search_box do |arguments, options, content|
-  placeholder = options[:placeholder] || LivingStyleGuide.default_options[:search_box][:placeholder]
-  document.before << LivingStyleGuide.template("search-box.html.erb", binding)
-  document.javascript << LivingStyleGuide.template("scripts/search.js.erb", binding)
+  placeholder = options[:placeholder]
+  placeholder ||= LivingStyleGuide.default_options[:search_box][:placeholder]
+  document.before <<
+    LivingStyleGuide.template("search-box.html.erb", binding)
+  document.javascript <<
+    LivingStyleGuide.template("scripts/search.js.erb", binding)
   nil
 end

data/lib/livingstyleguide/commands/style.rb

@@ -1,7 +1,7 @@
 LivingStyleGuide.command :style do |arguments, options, block|
   options.delete :block_type
   options.each do |key, value|
-    document.scss << %Q($lsg--#{key.to_s.gsub("_", "-")}: #{value};\n)
+    document.scss << %Q($lsg-#{key.to_s.tr('_', '-')}: #{value};\n)
   end
   nil
 end

data/lib/livingstyleguide/document.rb

@@ -12,7 +12,9 @@ class LivingStyleGuide::Document < ::Tilt::Template
   attr_accessor :syntax
   attr_reader :scope
 
-  %w(scss head header footer defaults javascript before after).each do |attr|
+  %w(
+    scss head header footer defaults javascript before after files
+  ).each do |attr|
     define_method attr do
       if options.has_key?(:livingstyleguide)
         options[:livingstyleguide].send(attr)
@@ -25,7 +27,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
       if options.has_key?(:livingstyleguide)
         options[:livingstyleguide].send("#{attr}=", value)
       else
-        instance_variable_get("@#{attr}", value)
+        instance_variable_set("@#{attr}", value)
       end
     end
   end
@@ -35,9 +37,14 @@ class LivingStyleGuide::Document < ::Tilt::Template
   end
 
   def prepare
+    if options.has_key?(:livingstyleguide)
+      @template = :default
+    else
+      @template = :layout
+      @files = []
+    end
     @type = :lsg
     @commands = LivingStyleGuide::Commands.new(self)
-    @template = options.has_key?(:livingstyleguide) ? :default : :layout
     @classes = []
     @scss = ""
     @css = ""
@@ -82,7 +89,10 @@ class LivingStyleGuide::Document < ::Tilt::Template
 
   def erb
     @erb ||= parse_commands do |name, arguments, options, block|
-      options = %Q(document.defaults[:global].merge(document.defaults[:@#{name}] || {}).merge(#{options.inspect}))
+      global = "document.defaults[:global]"
+      scoped = "document.defaults[:@#{name}] || {}"
+      local = options.inspect
+      options = "#{global}.merge(#{scoped}).merge(#{local})"
       "<%= #{name}(#{arguments.inspect}, #{options}, #{block.inspect}) %>\n"
     end
   end
@@ -91,7 +101,8 @@ class LivingStyleGuide::Document < ::Tilt::Template
     @head = ""
     @javascript = ""
     %w(copy copy_code copy_colors toggle_code).each do |partial|
-      @javascript << LivingStyleGuide.template("scripts/#{partial}.js.erb", binding)
+      file = "scripts/#{partial}.js.erb"
+      @javascript << LivingStyleGuide.template(file, binding)
     end
     @header = ""
     @before = ""
@@ -101,27 +112,31 @@ class LivingStyleGuide::Document < ::Tilt::Template
     result = ERB.new(erb).result(@commands.get_binding)
     @source = result
     @html = render_html(result, locals)
-    @classes.unshift "lsg--#{@type}-example"
-    @classes.unshift "lsg--example"
+    @classes.unshift "lsg-#{@type}-example"
+    @classes.unshift "lsg-example"
     ERB.new(template_erb).result(binding).gsub(/\n\n+/, "\n")
   end
 
   def depend_on(file)
+    files << file
     @scope.depend_on(File.expand_path(file)) if @scope.respond_to?(:depend_on)
   end
 
   private
+
   def render_html(result, locals)
     if @type == :lsg
-      renderer = LivingStyleGuide::RedcarpetHTML.new(LivingStyleGuide.default_options, self)
-      redcarpet = ::Redcarpet::Markdown.new(renderer, LivingStyleGuide::REDCARPET_RENDER_OPTIONS)
+      renderer_options = LivingStyleGuide.default_options
+      renderer = LivingStyleGuide::RedcarpetHTML.new(self, renderer_options)
+      redcarpet_options = LivingStyleGuide::REDCARPET_RENDER_OPTIONS
+      redcarpet = ::Redcarpet::Markdown.new(renderer, redcarpet_options)
       redcarpet.render(result)
     elsif engine = Tilt[@type]
       begin
         require "tilt/#{template_name}"
       rescue LoadError
       end
-      template = engine.new{ remove_highlights(result) }
+      template = engine.new { remove_highlights(result) }
       (@locals.is_a?(Array) ? @locals : [@locals]).map do |current_locals|
         template.render(@scope || Object.new, current_locals.merge(locals))
       end.join("\n")
@@ -132,14 +147,12 @@ class LivingStyleGuide::Document < ::Tilt::Template
     end
   end
 
-  private
-  def set_highlights(code, &block)
+  def set_highlights(code)
     code, positions = remove_highlight_marker_and_save_positions(code)
     html = yield(code)
     insert_html_highlight_marker(html, positions)
   end
 
-  private
   def remove_highlight_marker_and_save_positions(code)
     positions = []
     index = 0
@@ -150,7 +163,6 @@ class LivingStyleGuide::Document < ::Tilt::Template
     [code_without_highlights, positions]
   end
 
-  private
   def insert_html_highlight_marker(html, positions)
     code_with_highlights = ""
     index = 0
@@ -169,14 +181,14 @@ class LivingStyleGuide::Document < ::Tilt::Template
             code_with_highlights << %Q(</strong>)
             inside_highlight = false
           else
-            code_with_highlights << %Q(<strong class="lsg--code-highlight">)
+            code_with_highlights << %Q(<strong class="lsg-code-highlight">)
             inside_highlight = true
           end
           next_position = positions.shift
         end
         if char == "&"
           inside_character = true
-        elsif inside_character and char == ";"
+        elsif inside_character && char == ";"
           inside_character = false
           index += 1
         elsif not inside_character
@@ -189,30 +201,24 @@ class LivingStyleGuide::Document < ::Tilt::Template
     code_with_highlights
   end
 
-  private
   def remove_highlights(code)
     code.gsub(/\*\*\*/, "")
   end
 
-  private
   def template_erb
     File.read("#{File.dirname(__FILE__)}/templates/#{@template}.html.erb")
   end
 
-  private
   def parse_commands
-    data.gsub("<%", "<%%").gsub(/\G(.*?)((```.+?```)|\Z)/m) do
-      content, code_block = $1, $2
-      content.gsub!(/^@([\w\d_-]+)(?: ([^\n]*[^\{\n:]))?(?: *\{\n((?:.|\n)*?)\n\}|((?:\n+  .*)+(?=\n|\Z))| *:\n((?:.|\n)*?)(?:\n\n|\Z))?/) do
-        name, arguments_string, block = $1, $2 || "", $3 || $4 || $5
-        options = {
-          block_type: $3 ? :braces : $4 ? :indented : $5 ? :block : :none
-        }
-        name = name.gsub("-", "_").to_sym
-        arguments = parse_arguments(arguments_string, options)
-        if options[:block_type] == :indented
-          block.gsub!(/\A\n(\s*)((?:.|\n)+)\Z/){ $2.gsub(/^#{$1}/, "") }
-        end
+    doc = (data || "").gsub("<%", "<%%")
+    doc.gsub(/\G(?<content>.*?)(?<code_block>(?:```.+?```)|\Z)/m) do
+      content = $~[:content]
+      code_block = $~[:code_block]
+      content.gsub!(LivingStyleGuide::COMMANDS_REGEXP) do
+        name = $~[:name].tr("-", "_").to_sym
+        options = {}
+        arguments = parse_arguments($~[:arguments], options)
+        block = parse_block($~[:braces], $~[:indented], $~[:colon], options)
         yield name, arguments, options, block
       end
       content.gsub!(/^\\@/, "@")
@@ -220,14 +226,14 @@ class LivingStyleGuide::Document < ::Tilt::Template
     end
   end
 
-  private
   def parse_arguments(arguments_string, options)
+    return [] if arguments_string.nil?
     arguments = arguments_string.split(/(?<!\\);/)
     arguments.map! do |argument|
       argument.strip!
       argument.gsub! "\\;", ";"
       if /^(?<key>[a-zA-Z0-9_\-]+):(?<value>.+)$/ =~ argument
-        options[key.downcase.gsub("-", "_").to_sym] = remove_quots(value.strip)
+        options[key.downcase.tr("-", "_").to_sym] = remove_quots(value.strip)
         nil
       else
         remove_quots(argument)
@@ -236,12 +242,32 @@ class LivingStyleGuide::Document < ::Tilt::Template
     arguments.compact
   end
 
-  private
+  def parse_block(braces_block, indented_block, colon_block, options)
+    if braces_block
+      options[:block_type] = :braces
+      braces_block
+    elsif indented_block
+      options[:block_type] = :indented
+      unindent(indented_block)
+    elsif colon_block
+      options[:block_type] = :colon
+      colon_block
+    else
+      options[:block_type] = :none
+      nil
+    end
+  end
+
+  def unindent(block)
+    block.gsub(/\A\n(?<indent>(?: |\t)*)(?<content>(?:.|\n)+)\Z/) do
+      $~[:content].gsub(/^#{$~[:indent]}/, "")
+    end
+  end
+
   def remove_quots(string)
     string.sub(/^"(.*)"$|^"(.*)"$|^(.*)$/, "\\1\\2\\3").gsub(/\\("|")/, "\\1")
   end
 
-  private
   def gsub_content(regexp, &block)
     if @type == :lsg
       data.gsub(/\G(.+?)((```.+?```)|\Z)/m) do
@@ -253,12 +279,10 @@ class LivingStyleGuide::Document < ::Tilt::Template
     end
   end
 
-  private
   def template_name
-    (@type == :lsg or @type == :markdown) ? :redcarpet : @type
+    (@type == :lsg || @type == :markdown) ? :redcarpet : @type
   end
 
-  private
   def generate_id
     if @file
       id = Pathname.new(@file).cleanpath.to_s
@@ -268,12 +292,10 @@ class LivingStyleGuide::Document < ::Tilt::Template
     end
   end
 
-  private
   def scss_template
     ::LivingStyleGuide.default_options[:scss_template] || Tilt["scss"]
   end
 
-  private
   def render_scss(scss)
     sass_options = options.merge(custom: { sprockets_context: @scope })
     sass_options[:load_paths] ||= []
@@ -283,7 +305,8 @@ class LivingStyleGuide::Document < ::Tilt::Template
         sass_options[:load_paths] << path
       end
     end
-    scss_template.new(file, sass_options){ scss }.render(@scope || Object.new)
+    template = scss_template.new(file, sass_options) { scss }
+    template.render(@scope || Object.new)
   end
 end