livingstyleguide 1.1.1 → 1.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56208f284daa1f7b7353302654d9f5afa13092e7
-  data.tar.gz: fe9bae1832214c6ac1bf2fbf44989745ab08b2b7
+  metadata.gz: 86825c04643629696331540ff589ba16fb57d592
+  data.tar.gz: 8b7c01b7e88a6bfd3af8ba4616d7101a5928ce4f
 SHA512:
-  metadata.gz: b8d0caf0f12defe2d316f2f89d4807473be7ab9981ef4eb489df7e29a1509a6cc2cfcda62cbf92ba30a9e5b0a4243490c90fb88dd1735fb34d9bd64060c6777c
-  data.tar.gz: 4e10438988bde6607deb69d2cd796d8213c713763683ffbbf3899c59601bfa4a2f1e97a54bac8ac92da163844f0a1b1d28afca20486e9f3b3bee5770831afada
+  metadata.gz: 5cacdc1aca7c7da0e9bd6a5b65877daa7ec01eab7b52f438c502fd7b19b12a5a1c8d12dd16634aa1003ef5921f1bdb2fb4b5ed03cf2fd8861bc4ee69910fbae2
+  data.tar.gz: 278a316fe32545e1c046e7be77f1f2fb2e2f5690553e5fcd6ddd712e2dfe61ca2e2c14adddbec0d4ddb2375368ef8444421d3da1a90307a23c5b7a257d55b58b

data/lib/livingstyleguide/command_line_interface.rb

@@ -1,5 +1,8 @@
 require 'rubygems'
+begin
 require 'bundler/setup'
+rescue LoadError
+end
 require 'thor'
 require 'tilt'
 
@@ -8,10 +11,12 @@ module LivingStyleGuide
 
     desc 'compile filename', 'Compiles the living style guide to HTML.'
     def compile(file)
-      Compass.add_project_configuration
-      html = Tilt.new(file).render
       output_file = file.sub(/\.lsg$/, '')
-      output_file.sub! /^#{Compass.configuration.sass_dir}/, Compass.configuration.css_dir
+      if defined?(Compass)
+        Compass.add_project_configuration 
+        output_file.sub! /^#{Compass.configuration.sass_dir}/, Compass.configuration.css_dir
+      end
+      html = Tilt.new(file).render
       File.write output_file, html
       puts "Successfully generated a living style guide at #{output_file}."
     end

data/lib/livingstyleguide/engine.rb

@@ -1,7 +1,7 @@
 module LivingStyleGuide
 
   class Engine
-    attr_accessor :markdown, :files, :options
+    attr_accessor :markdown, :files, :options, :variables
 
     @@default_options = {
       default_language: 'example',
@@ -15,18 +15,41 @@ module LivingStyleGuide
       @@default_options
     end
 
-    def initialize(source, options, sass_options)
-      @source = source
+    def initialize(options, sass_options)
       @options = @@default_options.merge(options)
       @sass_options = sass_options
-      @markdown = ''
+      @variables = {}
       @files = []
+      @markdown = ''
     end
 
     def render
-      data = TemplateData.new(self)
-      template = File.read(File.join(File.dirname(__FILE__), '..', '..', 'templates', 'layouts', 'default.html.erb'))
-      ERB.new(template).result(data.get_binding)
+      template('layout.html.erb')
+    end
+
+    def files
+      collect_data if @files.empty?
+      @files
+    end
+
+    def variables
+      collect_data if @variables.empty?
+      @variables
+    end
+
+    def markdown
+      generate_markdown if @markdown.empty?
+      @markdown
+    end
+
+    def sass
+      separator = @options[:syntax] == :sass ? "\n" : ';'
+      [
+        %Q(@import "#{@options[:source]}"),
+        style_variables,
+        %Q(@import "livingstyleguide"),
+        @options[:styleguide_sass] || @options[:styleguide_scss]
+      ].flatten.join(separator)
     end
 
     def css
@@ -34,17 +57,97 @@ module LivingStyleGuide
     end
 
     def html
-      renderer = RedcarpetHTML.new(@options)
+      renderer = RedcarpetHTML.new(@options, self)
       redcarpet = ::Redcarpet::Markdown.new(renderer, REDCARPET_RENDER_OPTIONS)
       redcarpet.render(markdown)
     end
 
+    private
+    def collect_data
+      traverse_children sass_engine.to_tree
+    end
+
+    private
+    def traverse_children(node)
+      node.children.each do |child|
+        if child.is_a?(Sass::Tree::ImportNode)
+          add_file child.imported_file.to_tree
+        elsif child.is_a?(Sass::Tree::VariableNode)
+          add_variable child
+        end
+      end
+    end
+
+    private
+    def add_file(node)
+      filename = File.expand_path(node.filename)
+      if local_sass_file?(filename)
+        @files << filename
+        traverse_children node
+      end
+    end
+
+    private
+    def add_variable(node)
+      key = import_filename(node.filename)
+      @variables[key] ||= []
+      @variables[key] << node.name
+    end
+
+    private
+    def local_sass_file?(filename)
+      @local_sass_file_regexp ||= /^#{File.expand_path(@options[:root])}\/.+\.s[ac]ss$/
+      filename =~ @local_sass_file_regexp
+    end
+
+    private
+    def import_filename(filename)
+      @import_filename_regexp ||= /(?<=^|\/)_?([^\/]+?)\.s[ac]ss$/
+      filename.sub(@import_filename_regexp, '\\1')
+    end
+
     private
     def sass_engine
       return @sass_engine if @sass_engine
       sass_options = @sass_options.clone
       sass_options[:living_style_guide] = self
-      @sass_engine = ::Sass::Engine.new(@source, sass_options)
+      @sass_engine = ::Sass::Engine.new(sass, sass_options)
+      collect_data
+      @sass_engine.to_tree << output_variables
+      @sass_engine
+    end
+
+    private
+    def output_variables
+      scss = template('variables.scss.erb')
+      ::Sass::Engine.new(scss, syntax: :scss).to_tree.children
+    end
+
+    private
+    def style_variables
+      return unless @options.has_key?(:style)
+      @options[:style].map do |key, value|
+        "$livingstyleguide--#{key}: #{value}"
+      end
+    end
+
+    private
+    def generate_markdown
+      files.clone.each do |sass_filename|
+        next unless sass_filename.is_a?(String)
+        glob = "#{sass_filename.sub(/\.s[ac]ss$/, '')}.md"
+        Dir.glob(glob) do |markdown_filename|
+          files << markdown_filename
+          @markdown << File.read(markdown_filename)
+        end
+      end
+    end
+
+    private
+    def template(filename)
+      data = TemplateData.new(self)
+      erb = File.read(File.join(File.dirname(__FILE__), 'templates', filename))
+      ERB.new(erb).result(data.get_binding)
     end
 
   end
@@ -68,6 +171,10 @@ module LivingStyleGuide
       @engine.css
     end
 
+    def variables
+      @engine.variables
+    end
+
     def html
       @engine.html
     end

data/lib/livingstyleguide/example.rb

@@ -10,11 +10,12 @@ class LivingStyleGuide::Example
   FILTER_REGEXP = /^@([a-z\-_]+)(?:\s+(.+?))?$/
 
   define_hooks :filter_before, :filter_after, :html, :pre_processor
-  attr_reader :options
+  attr_reader :options, :engine
   @@filters = {}
 
-  def initialize(input, options = {})
+  def initialize(input, options, engine)
     @options = { default_filters: [] }.merge(options)
+    @engine = engine
     @source = input
     @wrapper_classes = %w(livingstyleguide--example)
     @syntax = :html

data/lib/livingstyleguide/filters/colors.rb

@@ -3,7 +3,7 @@ LivingStyleGuide::Example.add_filter :colors do |file|
 
 
   if file
-    colors = [LivingStyleGuide::VariablesImporter.variables(file)]
+    colors = [engine.variables[file]]
   else
     colors = []
   end

data/lib/livingstyleguide/integration/compass.rb

@@ -1,5 +1,5 @@
-Compass.configuration.add_import_path LivingStyleGuide::VariablesImporter.new
-
-base_directory = File.join(File.dirname(__FILE__), '..', '..', '..')
-Compass::Frameworks.register 'livingstyleguide', path: base_directory
+if defined?(Compass)
+  base_directory = File.join(File.dirname(__FILE__), '..', '..', '..')
+  Compass::Frameworks.register 'livingstyleguide', path: base_directory
+end
 

data/lib/livingstyleguide/integration/rails.rb

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

data/lib/livingstyleguide/integration/sprockets.rb

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

data/lib/livingstyleguide/markdown_extensions.rb

@@ -15,9 +15,10 @@ module LivingStyleGuide
 
   class RedcarpetHTML < ::Redcarpet::Render::HTML
 
-    def initialize(options = {})
+    def initialize(options = {}, engine)
       @options = options
-      super
+      @engine = engine
+      super @options
     end
 
     def header(text, header_level)
@@ -43,7 +44,7 @@ module LivingStyleGuide
     def block_code(code, language)
       language ||= @options[:default_language]
       if language == 'example'
-        Example.new(code, @options).render
+        Example.new(code, @options, @engine).render
       else
         CodeBlock.new(code.strip, language.to_s.strip.to_sym).render
       end

data/lib/livingstyleguide/sass_extensions/functions.rb

@@ -1,8 +1,9 @@
 module LivingStyleGuide::SassExtensions::Functions
 
   def list_variables(uri)
+    Sass::Util.sass_warn '`list-variables()` is depricated and will be removed in v2.0.0.'
     uri = uri.value
-    variables = LivingStyleGuide::VariablesImporter.variables(uri)
+    variables = parse_variables(uri)
     variables.map! do |name|
       Sass::Script::String.new(name)
     end
@@ -15,5 +16,25 @@ module LivingStyleGuide::SassExtensions::Functions
     end
   end
 
+  private
+  def parse_variables(uri)
+    uri = uri.dup
+    uri += '.s?ss' unless uri =~ /\.s[ac]ss$/
+    uri.gsub! %r{^(.*)/(.+)$}, '\1/{_,}\2'
+    variables = []
+    paths = [Compass.configuration.sass_path, Compass.configuration.additional_import_paths].flatten
+    paths.each do |path|
+      if path.is_a? String
+        Dir.glob(File.join(path, uri)).each do |file|
+          sass = File.read(file)
+          variables << sass.scan(%r(\$([a-z0-9\-_]+)\s*:))
+        end
+      end
+    end
+    variables.flatten!
+    variables.uniq!
+    variables
+  end
+
 end
 

data/lib/livingstyleguide/{variables_importer/content.erb → templates/variables.scss.erb}

@@ -4,7 +4,7 @@
   }
 <% end %>
 
-<% variables.each do |variable| %>
+<% variables.values.flatten.each do |variable| %>
   $<%= variable %>: null !default;
   @if $<%= variable %> != null {//and type-of($<%= variable %>) != map {
     .\$<%= variable %> {

data/lib/livingstyleguide/tilt_template.rb

@@ -1,11 +1,10 @@
 require 'tilt'
 require 'erb'
-require 'compass'
 require 'yaml'
 require 'json'
 
-module ::Tilt
-  class LivingStyleGuideTemplate < Template
+module LivingStyleGuide
+  class TiltTemplate < ::Tilt::Template
     self.default_mime_type = 'text/html'
 
     def prepare
@@ -14,23 +13,28 @@ module ::Tilt
     def evaluate(scope, locals, &block)
       @scope = scope
       parse_options(data)
-      generate_sass
       render_living_style_guide
     end
 
     private
     def sass_options
-      options = Compass.configuration.to_sass_plugin_options
+      if defined?(Compass)
+        options = Compass.configuration.to_sass_plugin_options
+      else
+        load_path = File.join(File.dirname(__FILE__), '..', '..', 'stylesheets')
+        options = { load_paths: [load_path] }
+      end
       if defined?(Rails)
-        options[:load_paths] = options[:load_paths] | Rails.application.config.assets.paths
+        options[:load_paths] += Rails.application.config.assets.paths
       end
-      options[:template_location].each do |path, short|
-        options[:load_paths] << ::LivingStyleGuide::Importer.new(path)
+      if options[:template_location]
+        options[:template_location].each do |path, short|
+          options[:load_paths] << path
+        end
       end
       options[:filename]  = eval_file
       options[:line]      = line
       options[:syntax]    = @options[:syntax]
-      options[:importer]  = LivingStyleGuide::Importer.new('.')
       options[:sprockets] = { context: @scope }
       options[:custom]    = { sprockets_context: @scope }
       options
@@ -50,25 +54,11 @@ module ::Tilt
       @options[:root] ||= root
     end
 
-    private
-    def generate_sass
-      @sass = [
-        %Q(@import "#{@options[:source]}"),
-        style_variables,
-        %Q(@import "livingstyleguide"),
-        %Q(@import "#{::LivingStyleGuide::VariablesImporter::VARIABLE_IMPORTER_STRING}"),
-        @options[:styleguide_sass] || @options[:styleguide_scss]
-      ].flatten.join(@options[:syntax] == :sass ? "\n" : ';')
-    end
-
     private
     def configure_cache
       return unless @scope.respond_to?(:depend_on)
-      test = /^#{root}/
       @engine.files.uniq.each do |file|
-        if file =~ test
-          @scope.depend_on file
-        end
+        @scope.depend_on file
       end
     end
 
@@ -93,23 +83,15 @@ module ::Tilt
       path
     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 = ::LivingStyleGuide::Engine.new(@sass, @options, sass_options)
+      @engine = ::LivingStyleGuide::Engine.new(@options, sass_options)
       html = @engine.render
       configure_cache
       html
     end
   end
-
-  register 'lsg', LivingStyleGuideTemplate
 end
 
+Tilt.register 'lsg', LivingStyleGuide::TiltTemplate
+

data/lib/livingstyleguide/version.rb

@@ -1,3 +1,3 @@
 module LivingStyleGuide
-  VERSION = '1.1.1'
+  VERSION = '1.2.0.pre.1'
 end

data/lib/livingstyleguide.rb

@@ -1,10 +1,12 @@
+begin
+  require 'compass'
+rescue LoadError
+end
+
 require 'livingstyleguide/version'
-require 'compass'
 require 'livingstyleguide/filter_hooks'
 require 'livingstyleguide/sass_extensions'
 require 'livingstyleguide/engine'
-require 'livingstyleguide/variables_importer'
-require 'livingstyleguide/importer'
 require 'livingstyleguide/markdown_extensions'
 require 'livingstyleguide/tilt_template'
 require 'livingstyleguide/code_block'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: livingstyleguide
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0.pre.1
 platform: ruby
 authors:
 - Nico Hagenburger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minisyntax
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: compass
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +94,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +204,6 @@ files:
 - lib/livingstyleguide/filters/haml.rb
 - lib/livingstyleguide/filters/highlights.rb
 - lib/livingstyleguide/filters/javascript.rb
-- lib/livingstyleguide/importer.rb
 - lib/livingstyleguide/integration.rb
 - lib/livingstyleguide/integration/compass.rb
 - lib/livingstyleguide/integration/rails.rb
@@ -212,16 +211,15 @@ files:
 - lib/livingstyleguide/markdown_extensions.rb
 - lib/livingstyleguide/sass_extensions.rb
 - lib/livingstyleguide/sass_extensions/functions.rb
+- lib/livingstyleguide/templates/layout.html.erb
+- lib/livingstyleguide/templates/variables.scss.erb
 - lib/livingstyleguide/tilt_template.rb
-- lib/livingstyleguide/variables_importer.rb
-- lib/livingstyleguide/variables_importer/content.erb
 - lib/livingstyleguide/version.rb
 - stylesheets/_livingstyleguide.scss
 - stylesheets/livingstyleguide/_code.scss
 - stylesheets/livingstyleguide/_color-swatches.scss
 - stylesheets/livingstyleguide/_content.scss
 - stylesheets/livingstyleguide/_layout.scss
-- templates/layouts/default.html.erb
 homepage: http://livingstyleguide.org
 licenses: []
 metadata: {}
@@ -236,9 +234,9 @@ 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.2.2

data/lib/livingstyleguide/importer.rb

@@ -1,40 +0,0 @@
-class LivingStyleGuide::Importer < Sass::Importers::Filesystem
-
-  def initialize(root)
-    super(root)
-  end
-
-  def find_relative(name, base, options, absolute = false)
-    @options = options
-    engine = super(name, base, options)
-    find_markdown(options[:filename])
-    engine
-  end
-
-  def find(name, options)
-    @options = options
-    super(name, options)
-  end
-
-  private
-  def find_markdown(sass_filename)
-    files << sass_filename
-    glob = "#{sass_filename.sub(/\.s[ac]ss$/, '')}.md"
-    Dir.glob(glob) do |markdown_filename|
-      files << markdown_filename
-      markdown << File.read(markdown_filename)
-    end
-  end
-
-  private
-  def files
-    @options[:living_style_guide].files
-  end
-
-  private
-  def markdown
-    @options[:living_style_guide].markdown
-  end
-
-end
-

data/lib/livingstyleguide/variables_importer.rb

@@ -1,96 +0,0 @@
-require 'erb'
-require 'ostruct'
-require 'compass'
-
-module LivingStyleGuide
-  class VariablesImporter < Sass::Importers::Base
-    VALID_FILE_NAME = /\A#{Sass::SCSS::RX::IDENT}\Z/
-    VARIABLE_IMPORTER_STRING = 'LivingStyleGuide::VariablesImporter'
-    VALID_EXTENSIONS = %w(*.sass *.scss)
-
-    TEMPLATE_FOLDER = File.join(File.expand_path('../', __FILE__), 'variables_importer')
-    CONTENT_TEMPLATE_FILE = File.join(TEMPLATE_FOLDER, 'content.erb')
-    CONTENT_TEMPLATE = ERB.new(File.read(CONTENT_TEMPLATE_FILE))
-
-    def find(uri, options)
-      if uri =~ /^#{VARIABLE_IMPORTER_STRING}$/
-        @options = options
-        return self.class.sass_engine(uri, all_variables, self, options)
-      end
-      nil
-    end
-
-    def find_relative(uri, base, options)
-      nil
-    end
-
-    def to_s
-      self.class.name
-    end
-
-    def hash
-      self.class.name.hash
-    end
-
-    def eql?(other)
-      other.class == self.class
-    end
-
-    def key(uri, options={})
-      [self.class.name + ":variables:" + File.dirname(File.expand_path(uri)), File.basename(uri)]
-    end
-
-    def self.variables(uri)
-      uri = uri.dup
-      uri += '.s?ss' unless uri =~ /\.s[ac]ss$/
-      uri.gsub! %r{^(.*)/(.+)$}, '\1/{_,}\2'
-      variables = []
-      paths = [Compass.configuration.sass_path, Compass.configuration.additional_import_paths].flatten
-      paths.each do |path|
-        if path.is_a? String
-          Dir.glob(File.join(path, uri)).each do |file|
-            sass = File.read(file)
-            variables << sass.scan(%r(\$([a-z0-9\-_]+)\s*:))
-          end
-        end
-      end
-      variables.flatten!
-      variables.uniq!
-      variables
-    end
-
-    def all_variables
-      variables = []
-      test = /^#{File.expand_path(@options[:living_style_guide].options[:root])}/
-      @options[:living_style_guide].files.each do |file|
-        if File.expand_path(file) =~ test
-          sass = File.read(file)
-          variables << sass.scan(%r(\$([a-z\-_]+)\s*:))
-        end
-      end
-      variables.flatten!
-      variables.uniq!
-      variables
-    end
-
-    def self.sass_options(uri, importer, options)
-      options.merge! :filename => uri.gsub(%r{\*/},"*\\/"), :syntax => :scss, :importer => importer
-    end
-
-    def self.sass_engine(uri, name, importer, options)
-      content = content_for_images(uri, name, options[:skip_overrides])
-      Sass::Engine.new(content, sass_options(uri, importer, options))
-    end
-
-    def self.content_for_images(uri, variables, skip_overrides = false)
-      binder = LivingStyleGuide::Binding.new(:variables => variables)
-      CONTENT_TEMPLATE.result(binder.get_binding)
-    end
-  end
-
-  class Binding < OpenStruct
-    def get_binding
-      binding
-    end
-  end
-end