livingstyleguide 0.6.0.alpha.2 → 1.0.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c33ece860e06225991997ea016a1bb63296bcc80
-  data.tar.gz: 5ce8ad16bad308ed0b874b27e7e2dd8de467f55f
+  metadata.gz: 7ab15e228a445c7b95dac21e5e7b08cd52ebbd65
+  data.tar.gz: 978c972a638c80ffb4e90179d31b0767656b0310
 SHA512:
-  metadata.gz: 473fcd6e4a359e8f3246113a8b5c832408b1dde659038d55444c4fdf82da4d3cd32fc1943dc02b03a92885683a2d75e19b5328f0bd873add7c0dbb22c0e7077f
-  data.tar.gz: de49cd6ffa45fd89f67d9e8c2f396237ba92f9091b352ee9eae3587e3e2ed57d86b7c6423385919f65d0311ee680ec4a9cd8d375974557865bfbe37f103d660e
+  metadata.gz: 50f4df04107e5f799d4599f73092227ad3cc145cc96d5ef23155d04785d841e415645adca2a982a5ccedaeac23557fb80b4fb5bf62e35c9a5d717d8a78ca7c61
+  data.tar.gz: 6b59104477eeaddf0a38e5876fc0c8e913f2fbeb4d453fa477aa239bff2ae235fcf1040addb0fbdbb87f35c95e89b45841571b34fee245f62f0e1acaa55cce5e

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 1.8.7
-  - rbx-19mode
+  - 2.0.0
+  - 2.1.0

data/CHANGELOG.md

@@ -36,4 +36,24 @@
 
 * Better support for load paths in Rails
 * Fix for colors
+* New YAML based configuration
+  ([see this gist](https://gist.github.com/hagenburger/7945859#file-styleguide-1-html-lsg))
+* Option to set the HTML title
+* Custom footer and header HTML
+  ([example](https://github.com/hagenburger/livingstyleguide/blob/master/test/fixtures/standalone/styleguide-with-header-footer.html.lsg))
+* Linking of JavaScript files (like jQuery, application.js, …) into the
+  style guide
+  ([example](https://github.com/hagenburger/livingstyleguide/blob/master/test/fixtures/standalone/styleguide-with-javascript.html.lsg))
+* Custom styles can be set within YAML configuration
+  ([example](https://github.com/hagenburger/livingstyleguide/blob/master/test/fixtures/standalone/styleguide-with-style.html.lsg))
+
+## 1.0.0.alpha.3
+
+* [Cache control for Sprockets](https://github.com/hagenburger/livingstyleguide/issues/25)
+* API to provide [filters in examples](https://github.com/hagenburger/livingstyleguide/issues/22)
+* Dropped `haml-example`, `layout-example`, `javascript-example` and `haml-layout-example`;
+  moved into [filters](https://github.com/hagenburger/livingstyleguide/issues/28)
+* [A set of pre-defined filters](https://github.com/hagenburger/livingstyleguide/tree/master/lib/livingstyleguide/filters)
+* [Default filters](https://github.com/hagenburger/livingstyleguide/issues/31) (e. g. all templates should use Haml)
+* [CoffeeScript examples](https://github.com/hagenburger/livingstyleguide/issues/34)
 

data/MIT-LICENSE.md

@@ -0,0 +1,11 @@
+Copyright (c) 2012++ Nico Hagenburger
+
+http://www.hagenburger.net
+http://twitter.com/hagenburger
+http://github.com/hagenburger
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,12 +1,44 @@
 # Living Style Guide
 
-TODO: Write a gem description
+Easily create living style guides by adding Markdown documentation to
+your Sass.
+
+![Build Status Images](https://travis-ci.org/hagenburger/livingstyleguide.png)
+
+## Rails Integration
+
+1) Create *_app/assets/stylesheets/styleguide.html.lsg_* with:
+   ``` yaml
+   source: application.css.scss # replace with your default Sass/SCSS file name
+   title: "My Living Style Guide"
+   ```
+   
+2) Write documentation for each module *app/assets/stylesheets/partials/_buttons.md* (to describe *_buttons.sass* in the same folder):
+   ``` markdown
+   Buttons
+   =======
+
+   ~~~ example
+   <button class="button">Example button</button>
+   ~~~ 
+
+   ~~~ example
+   <button class="button -is-primary">Example button</button>
+   ~~~ 
+   ```
+   
+3) Open <http://localhost:3000/assets/styleguide.html>.
+   This will automatically:
+   * Combine all Markdown files and convert them to HTML
+   * Create a beautyful style guide
+   * Show the HTML source syntax highlighted close to each example
+
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'livingstyleguide'
+    gem 'livingstyleguide', '0.6.0.alpha.2'
 
 And then execute:
 
@@ -14,11 +46,8 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install livingstyleguide
+    $ gem install livingstyleguide -v0.6.0.alpha.2
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Contributing
 
@@ -27,3 +56,12 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+
+## Copyright
+
+Copyright (c) 2012 – 2014 [Nico Hagenburger](http://www.hagenburger.net).
+See [MIT-LICENSE.md](MIT-LICENSE.md) for details.
+Get in touch with [@hagenburger](http://twitter.com/hagenburger) on Twitter.
+
+

data/lib/livingstyleguide.rb

@@ -1,38 +1,17 @@
 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/renderer'
 require 'livingstyleguide/markdown_extensions'
 require 'livingstyleguide/tilt_template'
+require 'livingstyleguide/code_block'
+require 'livingstyleguide/example'
+require 'livingstyleguide/filters'
+require 'livingstyleguide/integration'
 
 module LivingStyleGuide
-  @@markdown = nil
-
-  def self.reset
-    @@markdown = nil
-  end
-
-  def self.add_markdown(markdown)
-    (@@markdown ||= '') << markdown
-  end
-
-  def self.markdown
-    @@markdown
-  end
-
 end
 
-class Sass::Engine
-  include LivingStyleGuide::Renderer
-end
-
-class String
-  def blank?
-    self.nil? || self.empty?
-  end
-end
-
-require 'livingstyleguide/integration'
-

data/lib/livingstyleguide/code_block.rb

@@ -0,0 +1,35 @@
+require 'minisyntax'
+require 'erb'
+require 'hooks'
+
+class LivingStyleGuide::CodeBlock
+  include Hooks
+  include Hooks::InstanceHooks
+  include LivingStyleGuide::FilterHooks
+  define_hooks :filter_code, :syntax_highlight
+
+  attr_accessor :source, :language
+
+  syntax_highlight do |code|
+    if language.nil?
+      code
+    else
+      ::MiniSyntax.highlight(code, language)
+    end
+  end
+
+  def initialize(source, language = nil)
+    @source = source
+    @language = language
+  end
+
+  def render
+    code = @source.strip
+    code = ERB::Util.html_escape(code).gsub(/"/, '"')
+    code = run_last_filter_hook(:syntax_highlight, code)
+    code = run_filter_hook(:filter_code, code)
+    %Q(<pre class="livingstyleguide--code-block"><code class="livingstyleguide--code">#{code}</code></pre>)
+  end
+
+end
+

data/lib/livingstyleguide/engine.rb

@@ -0,0 +1,93 @@
+module LivingStyleGuide
+
+  class Engine
+    attr_accessor :markdown, :files, :options
+
+    @@default_options = {
+      default_language: 'example'
+    }
+
+    def self.default_options
+      @@default_options
+    end
+
+    def initialize(source, options, sass_options)
+      @source = source
+      @options = @@default_options.merge(options)
+      @sass_options = sass_options
+      @markdown = ''
+      @files = []
+    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)
+    end
+
+    def css
+      sass_engine.render
+    end
+
+    def html
+      renderer = RedcarpetHTML.new(@options)
+      redcarpet = ::Redcarpet::Markdown.new(renderer, REDCARPET_RENDER_OPTIONS)
+      redcarpet.render(markdown)
+    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)
+    end
+
+  end
+
+  class TemplateData
+    include ERB::Util
+
+    def initialize(engine)
+      @engine = engine
+    end
+
+    def get_binding
+      binding
+    end
+
+    def title
+      @engine.options[:title]
+    end
+
+    def css
+      @engine.css
+    end
+
+    def html
+      @engine.html
+    end
+
+    def head
+      (@engine.options[:javascript_before] || []).map do |src|
+        %Q(<script src="#{src}"></script>)
+      end.join("\n")
+    end
+
+    def header
+      contents = [@engine.options[:header]]
+      contents.join("\n")
+    end
+
+    def footer
+      contents = [@engine.options[:footer]]
+      contents << (@engine.options[:javascript_after] || []).map do |src|
+        %Q(<script src="#{src}"></script>)
+      end
+      contents.join("\n")
+    end
+
+  end
+
+end
+

data/lib/livingstyleguide/example.rb

@@ -0,0 +1,86 @@
+require 'minisyntax'
+require 'erb'
+require 'hooks'
+
+class LivingStyleGuide::Example
+  include Hooks
+  include Hooks::InstanceHooks
+  include LivingStyleGuide::FilterHooks
+
+  FILTER_REGEXP = /^@([a-z\-_]+)(\s+(.+?))?$/
+
+  define_hooks :filter_before, :filter_after, :html, :pre_processor
+  attr_reader :options
+  @@filters = {}
+
+  def initialize(input, options = {})
+    @options = { default_filters: [] }.merge(options)
+    @source = input
+    @wrapper_classes = %w(livingstyleguide--example)
+    @syntax = :html
+    @filters = @options[:default_filters].clone
+    @output_code_block = true
+    parse_filters
+    apply_filters
+  end
+
+  html do |content|
+    %Q(<div class="#{wrapper_classes}">\n  #{content}\n</div>\n)
+  end
+
+  def render
+    html = run_last_filter_hook(:html, filtered_example)
+    code_block = LivingStyleGuide::CodeBlock.new(@source, @syntax).render if @output_code_block
+    "#{html}#{code_block}"
+  end
+
+  def self.add_filter(key = nil, &block)
+    if key
+      @@filters[key.to_sym] = block
+    else
+      instance_eval &block
+    end
+  end
+
+  def add_wrapper_class(class_name)
+    @wrapper_classes << class_name
+  end
+
+  def wrapper_classes
+    @wrapper_classes.join(' ')
+  end
+
+  def suppress_code_block
+    @output_code_block = false
+  end
+
+  private
+  def parse_filters
+    lines = @source.split(/\n/)
+    @source = lines.reject do |line|
+      if line =~ FILTER_REGEXP
+        @filters << line
+      end
+    end.join("\n")
+  end
+
+  private
+  def apply_filters
+    @filters.each do |filter|
+      set_filter *filter.match(FILTER_REGEXP)[1..2]
+    end
+  end
+
+  private
+  def set_filter(key, argument = nil)
+    instance_exec argument, &@@filters[key.to_s.gsub('-', '_').to_sym]
+  end
+
+  private
+  def filtered_example
+    source = run_filter_hook(:filter_before, @source)
+    source = run_last_filter_hook(:pre_processor, source)
+    run_filter_hook(:filter_after, source)
+  end
+end
+

data/lib/livingstyleguide/filter_hooks.rb

@@ -0,0 +1,34 @@
+module LivingStyleGuide::FilterHooks
+  def self.included(base)
+    base.class_eval do
+      extend Methods
+      include Methods
+    end
+  end
+
+  module Methods
+    def run_filter_hook(name, source)
+      _hooks[name].each do |hook|
+        source = run_single_hook(hook, source)
+      end
+      source
+    end
+
+    def run_last_filter_hook(name, source)
+      run_single_hook(_hooks[name].last, source)
+    end
+
+    private
+    def run_single_hook(hook, source)
+      if hook.kind_of?(Symbol)
+        send(hook, source)
+      elsif hook.nil?
+        source
+      else
+        instance_exec(source, &hook)
+      end
+    end
+  end
+end
+
+

data/lib/livingstyleguide/filters.rb

@@ -0,0 +1,8 @@
+require 'livingstyleguide/filters/highlights'
+require 'livingstyleguide/filters/full_width'
+require 'livingstyleguide/filters/haml'
+require 'livingstyleguide/filters/javascript'
+require 'livingstyleguide/filters/coffee_script'
+require 'livingstyleguide/filters/add_wrapper_class'
+require 'livingstyleguide/filters/font_example'
+

data/lib/livingstyleguide/filters/add_wrapper_class.rb

@@ -0,0 +1,4 @@
+LivingStyleGuide::Example.add_filter :add_wrapper_class do |css_class|
+  add_wrapper_class css_class
+end
+