livingstyleguide 2.0.0.alpha.10 → 2.0.0.alpha.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba96e42a926901d8cd5997497cec4602f05f179c
-  data.tar.gz: b2e505615ea2fdcb6e5d6112bc8fe1d4c69b41ca
+  metadata.gz: ac71c904b754f1bf069310514347b950d2d0ab8d
+  data.tar.gz: 37b597563643b5db04e73fb181f8be5b23917ada
 SHA512:
-  metadata.gz: 8f9fac2110874728aad315e163252dec08023263415490220151b45ac208a53ab5ac2d7a9c1b390ff6f734789ed568460e75bb8c9cbb48f7ece2eb649fa1247c
-  data.tar.gz: d3f407cef912bb92a79cf0f80ffe98a7ddb75ee5b740e28a241550f813f968cc0999d1ca6ba7d296abdddffd9e45745952c9d3d61be5f67a883957f2e7bc546f
+  metadata.gz: bea2424d954964fd4c77f113ba255858efb06479f961089580c00617add66e69960b3b3599c53400587a6f0a0f3e4c947086ab118d6c344f88d71efb4d52c1f0
+  data.tar.gz: 6c051d0f26ef17995e7f1ebeef29ef520d937136b93976107351fda9f8e8a8f0f83d0e6a51d802a9cbfd616dd3bc8b776726f7ca0e26f9182b4f1ae1e05dfb01

data/bin/livingstyleguide

@@ -1,16 +1,15 @@
 #!/usr/bin/env ruby
 
-require 'rubygems'
+require "rubygems"
 begin
-require 'bundler/setup'
+require "bundler/setup"
 rescue LoadError
 end
 
-lib = File.expand_path('../lib', File.dirname(__FILE__))
+lib = File.expand_path("../lib", File.dirname(__FILE__))
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'livingstyleguide'
-require 'livingstyleguide/command_line_interface'
+require "livingstyleguide"
+require "livingstyleguide/command_line_interface"
 
 LivingStyleGuide::CommandLineInterface.start(ARGV)
-

data/lib/livingstyleguide.rb

@@ -4,25 +4,25 @@ Encoding.default_internal = Encoding::UTF_8
 require "yaml"
 
 begin
-  require 'compass'
+  require "compass"
 rescue LoadError
 end
 
 module LivingStyleGuide
   @@default_options = {
     default_language: :example,
-    title: 'Living Style Guide',
-    header: '<h1 class="lsg--page-title">Living Style Guide</h1>',
-    footer: '<div class="lsg--footer"><a class="lsg--logo" href="http://livingstyleguide.org">Made with the LivingStyleGuide gem.</a></div>',
-    root: '/'
+    title: "Living Style Guide",
+    header: %Q(<h1 class="lsg--page-title">Living Style Guide</h1>),
+    footer: %Q(<div class="lsg--footer"><a class="lsg--logo" href="http://livingstyleguide.org">Made with the LivingStyleGuide gem.</a></div>),
+    root: "/"
   }
 
   def self.default_options
     @@default_options
   end
 
-  def self.add_filter(*keys, &block)
-    Filters.add_filter(*keys, &block)
+  def self.command(*keys, &block)
+    Commands.command(*keys, &block)
   end
 
   def self.parse_data(data)
@@ -34,10 +34,16 @@ module LivingStyleGuide
       end
     end
   end
+
+  def self.template(file, scope)
+    file = "#{File.dirname(__FILE__)}/livingstyleguide/templates/#{file}"
+    erb = File.read(file)
+    ERB.new(erb).result(scope)
+  end
 end
 
-require 'livingstyleguide/version'
-require 'livingstyleguide/markdown_extensions'
-require 'livingstyleguide/document'
-require 'livingstyleguide/filters'
-require 'livingstyleguide/integration'
+require "livingstyleguide/version"
+require "livingstyleguide/markdown_extensions"
+require "livingstyleguide/document"
+require "livingstyleguide/commands"
+require "livingstyleguide/integration"

data/lib/livingstyleguide/command_line_interface.rb

@@ -1,10 +1,10 @@
-require 'thor'
-require 'tilt'
+require "thor"
+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,7 +12,7 @@ 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
@@ -31,7 +31,7 @@ module LivingStyleGuide
       if input_file.nil?
         puts html
       else
-        output_file = input_file.sub(/(\.html)?\.lsg$/, '.html') if output_file.nil?
+        output_file = input_file.sub(/(\.html)?\.lsg$/, ".html") if output_file.nil?
         if defined?(Compass)
           Compass.add_project_configuration
           output_file = output_file.sub(/^#{Compass.configuration.sass_dir}/, Compass.configuration.css_dir)
@@ -43,4 +43,3 @@ module LivingStyleGuide
 
   end
 end
-

data/lib/livingstyleguide/commands.rb

@@ -0,0 +1,39 @@
+class LivingStyleGuide::Commands
+  attr_reader :document
+
+  def initialize(doc)
+    @document = doc
+  end
+
+  def get_binding
+    binding
+  end
+
+  def self.command(*keys, &block)
+    keys.each do |key|
+      define_method key, &block
+    end
+  end
+end
+
+require "livingstyleguide/commands/options"
+require "livingstyleguide/commands/default"
+require "livingstyleguide/commands/import_and_use"
+require "livingstyleguide/commands/require"
+require "livingstyleguide/commands/full_width"
+require "livingstyleguide/commands/haml"
+require "livingstyleguide/commands/type"
+require "livingstyleguide/commands/markdown"
+require "livingstyleguide/commands/javascript"
+require "livingstyleguide/commands/coffee_script"
+require "livingstyleguide/commands/add_wrapper_class"
+require "livingstyleguide/commands/font_example"
+require "livingstyleguide/commands/colors"
+require "livingstyleguide/commands/css"
+require "livingstyleguide/commands/sass"
+require "livingstyleguide/commands/style"
+require "livingstyleguide/commands/data"
+require "livingstyleguide/commands/layout"
+require "livingstyleguide/commands/syntax"
+require "livingstyleguide/commands/search_box"
+require "livingstyleguide/commands/toggle_code"

data/lib/livingstyleguide/commands/add_wrapper_class.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :add_wrapper_class do |arguments, options, block|
+  document.classes << arguments.first
+  nil
+end

data/lib/livingstyleguide/commands/coffee_script.rb

@@ -0,0 +1,5 @@
+LivingStyleGuide.command :coffee_script, :coffee do |arguments, options, block|
+  document.type = :coffee
+  document.template = :javascript
+  nil
+end

data/lib/livingstyleguide/{filters → commands}/colors.rb

@@ -1,4 +1,4 @@
-LivingStyleGuide.add_filter :colors do |arguments, options, content|
+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 = colors.flatten

data/lib/livingstyleguide/{filters → commands}/css.rb

@@ -1,4 +1,4 @@
-LivingStyleGuide.add_filter :css do |arguments, options, css|
+LivingStyleGuide.command :css do |arguments, options, css|
   file = arguments.first
   if file =~ /\.css$/
     if document.file

data/lib/livingstyleguide/{filters → commands}/data.rb

@@ -1,4 +1,4 @@
-LivingStyleGuide.add_filter :data do |arguments, options, data|
+LivingStyleGuide.command :data do |arguments, options, data|
   data = LivingStyleGuide.parse_data(data)
   if data.is_a?(Array)
     document.locals = [] unless document.locals.is_a?(Array)

data/lib/livingstyleguide/{filters → commands}/default.rb

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

data/lib/livingstyleguide/{filters → commands}/font_example.rb

@@ -5,11 +5,11 @@ LivingStyleGuide.default_options[:font_example] = { text: <<-TEXT }
   !&/()$=@;:,.
 TEXT
 
-LivingStyleGuide.add_filter :font_example do |arguments, options, text|
+LivingStyleGuide.command :font_example do |arguments, options, text|
   text ||= LivingStyleGuide.default_options[:font_example][:text]
   text = ERB::Util.html_escape(text)
   text.strip!
   text.gsub!(/\n/, "<br>\n")
   font = ERB::Util.html_escape(arguments.first)
-  ERB.new(File.read("#{File.dirname(__FILE__)}/../templates/font-example.html.erb")).result(binding)
+  LivingStyleGuide.template("font-example.html.erb", binding)
 end

data/lib/livingstyleguide/commands/full_width.rb

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

data/lib/livingstyleguide/commands/haml.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :haml do |arguments, options, block|
+  document.type = :haml
+  nil
+end

data/lib/livingstyleguide/{filters → commands}/import_and_use.rb

@@ -1,8 +1,8 @@
-require 'tilt'
+require "tilt"
 
 def map_files(glob, &block)
-  glob << '.lsg' unless glob =~ /\.(\w+|\*)$/
-  glob.gsub!(/[^\/]+$/, '{_,}\\0')
+  glob << ".lsg" unless glob =~ /\.(\w+|\*)$/
+  glob.gsub!(/[^\/]+$/, "{_,}\\0")
   glob = File.join(document.path, glob)
 
   Dir.glob(glob).map do |file|
@@ -11,7 +11,7 @@ def map_files(glob, &block)
   end.join
 end
 
-LivingStyleGuide.add_filter :import do |arguments, options, data|
+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."
@@ -26,7 +26,7 @@ LivingStyleGuide.add_filter :import do |arguments, options, data|
   end
 end
 
-LivingStyleGuide.add_filter :use do |arguments, options, data|
+LivingStyleGuide.command :use do |arguments, options, data|
   glob = arguments.first
   map_files glob do |file|
     File.read(file)

data/lib/livingstyleguide/{filters → commands}/javascript.rb

@@ -1,4 +1,4 @@
-LivingStyleGuide.add_filter :javascript do |arguments, options, block|
+LivingStyleGuide.command :javascript do |arguments, options, block|
   document.type = :javascript
   document.template = :javascript
   nil

data/lib/livingstyleguide/{filters → commands}/layout.rb

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

data/lib/livingstyleguide/commands/markdown.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :markdown do |arguments, options, block|
+  document.type = :markdown
+  nil
+end

data/lib/livingstyleguide/{filters → commands}/options.rb

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

data/lib/livingstyleguide/commands/require.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :require do |arguments, options, block|
+  Kernel.require arguments.first
+  nil
+end

data/lib/livingstyleguide/{filters → commands}/sass.rb

@@ -1,4 +1,6 @@
-LivingStyleGuide.add_filter :scss do |arguments, options, scss|
+require "sass"
+
+LivingStyleGuide.command :scss do |arguments, options, scss|
   file = arguments.first
   if file
     if document.file
@@ -12,7 +14,7 @@ LivingStyleGuide.add_filter :scss do |arguments, options, scss|
   nil
 end
 
-LivingStyleGuide.add_filter :sass do |arguments, options, sass|
+LivingStyleGuide.command :sass do |arguments, options, sass|
   file = arguments.first
   if file
     if document.file

data/lib/livingstyleguide/commands/search_box.rb

@@ -0,0 +1,10 @@
+LivingStyleGuide.default_options[:search_box] = {
+  placeholder: "Search …"
+}
+
+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)
+  nil
+end

data/lib/livingstyleguide/{filters → commands}/style.rb

@@ -1,4 +1,4 @@
-LivingStyleGuide.add_filter :style do |arguments, options, block|
+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)

data/lib/livingstyleguide/commands/syntax.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :syntax do |arguments, options, block|
+  document.syntax = arguments.first.to_sym
+  nil
+end

data/lib/livingstyleguide/commands/toggle_code.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :toggle_code do |arguments, options, content|
+  document.before << LivingStyleGuide.template("toggle-code.html.erb", binding)
+  nil
+end

data/lib/livingstyleguide/commands/type.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide.command :type do |arguments, options, block|
+  document.type = arguments.first.to_sym
+  nil
+end

data/lib/livingstyleguide/document.rb

@@ -1,18 +1,18 @@
 # encoding: utf-8
 
-require 'tilt'
-require 'erb'
-require 'digest'
-require 'pathname'
+require "tilt"
+require "erb"
+require "digest"
+require "pathname"
 
 class LivingStyleGuide::Document < ::Tilt::Template
-  attr_accessor :source, :type, :filters, :template, :classes, :html
+  attr_accessor :source, :type, :commands, :template, :classes, :html
   attr_accessor :css, :id, :locals
   attr_accessor :title
   attr_accessor :syntax
   attr_reader :scope
 
-  %w(scss head header footer defaults).each do |attr|
+  %w(scss head header footer defaults javascript before after).each do |attr|
     define_method attr do
       if options.has_key?(:livingstyleguide)
         options[:livingstyleguide].send(attr)
@@ -32,11 +32,11 @@ class LivingStyleGuide::Document < ::Tilt::Template
 
   def prepare
     @type = :lsg
-    @filters = LivingStyleGuide::Filters.new(self)
+    @commands = LivingStyleGuide::Commands.new(self)
     @template = options.has_key?(:livingstyleguide) ? :default : :layout
     @classes = []
-    @scss = ''
-    @css = ''
+    @scss = ""
+    @css = ""
     @locals = {}
     @defaults = {
       global: {
@@ -58,7 +58,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
   end
 
   def css
-    scss_with_lsg = "#{scss}; @import 'livingstyleguide';"
+    scss_with_lsg = %Q(#{scss}; @import "livingstyleguide";)
     render_scss(scss_with_lsg)
   end
 
@@ -77,7 +77,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
   end
 
   def erb
-    @erb ||= parse_filters do |name, arguments, options, block|
+    @erb ||= parse_commands do |name, arguments, options, block|
       options = %Q(document.defaults[:global].merge(document.defaults[:@#{name}] || {}).merge(#{options.inspect}))
       "<%= #{name}(#{arguments.inspect}, #{options}, #{block.inspect}) %>\n"
     end
@@ -85,13 +85,16 @@ class LivingStyleGuide::Document < ::Tilt::Template
 
   def evaluate(scope, locals, &block)
     @head = ""
-    @head << ERB.new(File.read("#{File.dirname(__FILE__)}/templates/javascript-copy.html.erb")).result(binding)
-    @head << ERB.new(File.read("#{File.dirname(__FILE__)}/templates/code-example.html.erb")).result(binding)
-    @head << ERB.new(File.read("#{File.dirname(__FILE__)}/templates/colors-example.html.erb")).result(binding)
+    @javascript = ""
+    %w(copy copy_code copy_colors toggle_code).each do |partial|
+      @javascript << LivingStyleGuide.template("scripts/#{partial}.js.erb", binding)
+    end
     @header = ""
+    @before = ""
+    @after = ""
     @footer = ""
     @scope = scope
-    result = ERB.new(erb).result(@filters.get_binding)
+    result = ERB.new(erb).result(@commands.get_binding)
     @source = result
     @html = render_html(result, locals)
     @classes.unshift "lsg--#{@type}-example"
@@ -183,7 +186,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
 
   private
   def remove_highlights(code)
-    code.gsub(/\*\*\*/, '')
+    code.gsub(/\*\*\*/, "")
   end
 
   private
@@ -192,18 +195,18 @@ class LivingStyleGuide::Document < ::Tilt::Template
   end
 
   private
-  def parse_filters
-    data.gsub('<%', '<%%').gsub(/\G(.*?)((```.+?```)|\Z)/m) do
+  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
+        name, arguments_string, block = $1, $2 || "", $3 || $4 || $5
         options = {
           block_type: $3 ? :braces : $4 ? :indented : $5 ? :block : :none
         }
-        name = name.gsub('-', '_').to_sym
+        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}/, '') }
+          block.gsub!(/\A\n(\s*)((?:.|\n)+)\Z/){ $2.gsub(/^#{$1}/, "") }
         end
         yield name, arguments, options, block
       end + code_block
@@ -217,7 +220,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
       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.gsub("-", "_").to_sym] = remove_quots(value.strip)
         nil
       else
         remove_quots(argument)
@@ -228,7 +231,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
 
   private
   def remove_quots(string)
-    string.sub(/^"(.*)"$|^'(.*)'$|^(.*)$/, '\\1\\2\\3').gsub(/\\("|')/, "\\1")
+    string.sub(/^"(.*)"$|^"(.*)"$|^(.*)$/, "\\1\\2\\3").gsub(/\\("|")/, "\\1")
   end
 
   private
@@ -252,7 +255,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
   def generate_id
     if @file
       id = Pathname.new(@file).cleanpath.to_s
-      id.sub('/_', '/').gsub(/\.\w+/, '')
+      id.sub("/_", "/").gsub(/\.\w+/, "")
     else
       "section-#{Digest::SHA256.hexdigest(data)[0...6]}"
     end
@@ -260,7 +263,7 @@ class LivingStyleGuide::Document < ::Tilt::Template
 
   private
   def scss_template
-    ::LivingStyleGuide.default_options[:scss_template] || Tilt['scss']
+    ::LivingStyleGuide.default_options[:scss_template] || Tilt["scss"]
   end
 
   private
@@ -277,4 +280,4 @@ class LivingStyleGuide::Document < ::Tilt::Template
   end
 end
 
-Tilt.register 'lsg', LivingStyleGuide::Document
+Tilt.register "lsg", LivingStyleGuide::Document