blastwolf 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in blastwolf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Gladhill
+
+MIT License
+
+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

@@ -0,0 +1,29 @@
+# Blastwolf
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'blastwolf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install blastwolf
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/blastwolf

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "rubygems" # ruby1.9 doesn't "require" it though
+require 'blastwolf'
+
+BlastWolf.new.do_it_all

data/blastwolf.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blastwolf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "blastwolf"
+  spec.version       = Blastwolf::VERSION
+  spec.authors       = ["Tom Gladhill"]
+  spec.email         = ["whoojemaflip@gmail.com"]
+  spec.description   = "Pattern library documentation"
+  spec.summary       = "Pattern library documentation"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "liquid", "~> 2.5"
+  spec.add_dependency "sass", "~> 3.2"
+  spec.add_dependency "pygments.rb", "~> 0.5.2"
+end

data/lib/blastwolf/pygments.rb

@@ -0,0 +1,86 @@
+
+# lovingly plagerised from https://raw.github.com/mojombo/jekyll/master/lib/jekyll/tags/highlight.rb
+
+module Tags
+  class HighlightBlock < Liquid::Block
+    include Liquid::StandardFilters
+
+    # The regular expression syntax checker. Start with the language specifier.
+    # Follow that by zero or more space separated options that take one of two
+    # forms:
+    #
+    # 1. name
+    # 2. name=value
+    SYNTAX = /^([a-zA-Z0-9.+#-]+)((\s+\w+(=\w+)?)*)$/
+
+    def initialize(tag_name, markup, tokens)
+      super
+      if markup.strip =~ SYNTAX
+        @lang = $1
+        @options = {}
+        if defined?($2) && $2 != ''
+          $2.split.each do |opt|
+            key, value = opt.split('=')
+            if value.nil?
+              if key == 'linenos'
+                value = 'inline'
+              else
+                value = true
+              end
+            end
+            @options[key] = value
+          end
+        end
+      else
+        raise SyntaxError.new <<-eos
+Syntax Error in tag 'highlight' while parsing the following markup:
+
+#{markup}
+
+Valid syntax: highlight <lang> [linenos]
+eos
+      end
+    end
+
+    def render(context)
+      if true
+        render_pygments(context, super)
+      else
+        render_codehighlighter(context, super)
+      end
+    end
+
+    def render_pygments(context, code)
+      require 'pygments'
+
+      @options[:encoding] = 'utf-8'
+
+      output = add_code_tags(
+        Pygments.highlight(code, :lexer => @lang, :options => @options),
+        @lang
+      )
+
+      output = context["pygments_prefix"] + output if context["pygments_prefix"]
+      output = output + context["pygments_suffix"] if context["pygments_suffix"]
+      output
+    end
+
+    def render_codehighlighter(context, code)
+      #The div is required because RDiscount blows ass
+      <<-HTML
+<div>
+  <pre><code class='#{@lang}'>#{h(code).strip}</code></pre>
+</div>
+      HTML
+    end
+
+    def add_code_tags(code, lang)
+      # Add nested <code> tags to code blocks
+      code = code.sub(/<pre>/,'<pre><code class="' + lang + '">')
+      code = code.sub(/<\/pre>/,"</code></pre>")
+    end
+
+  end
+end
+
+Liquid::Template.register_tag('highlight', Tags::HighlightBlock)

data/lib/blastwolf/templates/doc_page.liquid

@@ -0,0 +1,10 @@
+<article>
+  <h2><a id='{{ title }}'>{{ title }}</a></h2>
+  <section>{{ contents }}</section>
+  
+  <pre>
+    {{ contents }}
+  </pre>
+  
+  <hr />
+</article>

data/lib/blastwolf/templates/index.liquid

@@ -0,0 +1,21 @@
+<h1>Pattern Library Index</h1>
+<h2>Contents:</h2>
+
+<ul>
+{% for pattern in patterns %}
+  <li><a href='#{{ pattern.title }}'>{{ pattern.title }}</a></li>
+{% endfor %}
+</ul>
+
+{% for pattern in patterns %}
+<article>
+  <h2><a id='{{ pattern.title }}'>{{ pattern.title }}</a></h2>
+  <section>{{ pattern.contents }}</section>
+  
+  {% highlight html %}
+    {{ pattern.contents }}
+  {% endhighlight %}
+  
+  <hr />
+</article>
+{% endfor %}

data/lib/blastwolf/templates/layout.liquid

@@ -0,0 +1,14 @@
+<html>
+  <head>
+    <title>{{ title }}</title>
+    <link rel='stylesheet' href='css/global.css' media='all'>
+    <script src='http://code.jquery.com/jquery-1.10.1.min.js'></script>
+    <script src='js/patterns.js'></script>
+    <style>.highlight {clear:both; margin-top:50px;}</style>
+  </head>
+  <body>
+    <main>
+      {{ content }}
+    </main>
+  </body>
+</html>

data/lib/blastwolf/version.rb

@@ -0,0 +1,3 @@
+module Blastwolf
+  VERSION = "0.1.0"
+end

data/lib/blastwolf.rb

@@ -0,0 +1,198 @@
+require "blastwolf/version"
+
+require 'pathname'
+require 'liquid'
+require 'sass'
+require 'pygments'
+require 'blastwolf/pygments'
+
+PROJECT_ROOT = Dir.pwd
+
+class BlastWolf
+  def initialize( user_config={} )
+
+    @config = {
+      :template_dir => 'blastwolf/templates',
+      :default_scss => ['html.syntax', '_colours', '_layout'],
+      :build_folder => File.join(PROJECT_ROOT, '_build'),
+      :patterns_folder => File.join(PROJECT_ROOT, 'examples')
+    }
+    
+    @config.merge!( user_config )
+
+    setup_build_folders( @config[:build_folder] )
+  end
+
+  def do_it_all
+    generate_homepage
+    generate_doc_pages
+    build_patterns_artifacts
+    build_global_scss
+  end
+
+  def copy_markup(src, dest)
+    Dir.glob(File.join(src, '*.html')).each do |file|
+      FileUtils.cp file, dest
+    end
+  end
+
+  def copy_folders( folders, src, dest )
+    folders.each do |f|
+      FileUtils.cp_r( File.join(src, f), dest )
+    end
+  end
+
+  def setup_build_folders( target_folder )
+    # FileUtils.rm_r target_folder unless File.directory?( target_folder )
+    FileUtils.mkdir(target_folder) unless File.directory?( target_folder )
+
+    ['css', 'js', 'scss', 'img'].each do |dir|
+      subdir = File.join(target_folder, dir)
+      FileUtils.mkdir( subdir ) unless File.directory?( subdir )
+    end
+  end
+
+  def generate_homepage
+    title = "Index of examples"
+    patterns = get_patterns
+    html = render( 'index', title, patterns )
+    write_file( :home, html )
+  end
+
+  def build_patterns_artifacts
+    write_file( :scss, build_artifact( :scss ) )
+    build_js
+    build_image_dir
+  end
+
+  def build_image_dir
+    img_dir = File.join(@config[:build_folder], 'img')
+    Dir.glob(File.join(examples_path, "*.{jpg,png,gif}")) do |file|
+      puts file
+      FileUtils.cp file, img_dir
+    end
+  end
+
+  def generate_doc_pages
+    get_patterns.each do |pattern|
+      doc = render( 'doc_page', pattern['title'], pattern )
+      filename = File.join(@config[:build_folder], pattern['filename'])
+      File.open(filename, "w") { |file| file.write(doc) }
+    end
+  end
+
+  def build_artifact( type )
+    contents = ''
+
+    Dir.glob(examples_path type) do |file|
+      contents << File.read( file )
+      contents << "\n\t/* -------------------------- */\n"
+    end
+
+    contents
+  end
+
+  def build_js
+    js = "$(document).ready(function() {\n\n"
+    js << build_artifact(:js)
+    js << "});"
+
+    write_file( :js, js )
+  end
+
+  def compile_css
+    scss_path = File.join(@config[:build_folder], 'scss')
+    file = File.join(scss_path, 'global.scss')
+    template = File.read(file)
+    sass_engine = Sass::Engine.new(template, { :load_paths => [scss_path], :syntax => :scss,})
+    output = sass_engine.render
+
+    write_file( :css, output )
+  end
+
+  def build_global_scss
+    includes = @default_scss
+    includes << "patterns"
+    file_contents = includes.map { |inc|
+      "@import '#{inc}';\n"
+      }.join()
+
+    write_file( :global_scss, file_contents )
+  end
+
+
+  def get_patterns
+    patterns = []
+    Dir.glob(examples_path :html ).each do |file|
+      patterns << {
+        'title' => get_title( file ),
+        'filename' => get_filename( file ),
+        'contents' => File.read( file )
+      }
+    end
+    patterns
+  end
+
+  def render( template_file, page_title, vars )
+
+    contents = Liquid::Template.parse( get_template( template_file ) )
+    layout = Liquid::Template.parse( get_template('layout') )
+
+    vars = { 'patterns' => vars } if vars.kind_of?(Array)
+
+    rendered_page = layout.render(
+      'title' => page_title, 
+      'content' => contents.render( vars )
+      )
+  end
+
+  def get_template( filename )
+    template_filename = filename + '.liquid'
+    template_dir = File.join(File.dirname(__FILE__), 'blastwolf', 'templates')
+    File.read(File.join(template_dir, template_filename))
+  end
+
+  def write_file( file_descriptor, contents )
+    case file_descriptor
+    when :scss
+      filename = 'scss/patterns.scss'
+    when :js
+      filename = 'js/patterns.js'
+    when :home
+      filename = 'index.html'
+    when :global_scss
+      filename = 'scss/global.scss'
+    when :css
+      filename = 'css/global.css'
+    else
+      raise "I've no idea what file you want me to write"
+    end
+
+    filename = File.join(@config[:build_folder], filename)
+    puts filename
+
+    File.open(filename, 'w') { |file| file.write(contents) }
+  end
+
+
+  def get_title( file )
+    get_filename( file ).gsub(/\..*$/, '').gsub(/_(.)/) {|s| " #{s.upcase}" }
+  end
+
+
+  def get_filename( absolute_file_path )
+    Pathname.new( absolute_file_path ).basename.to_s
+  end
+
+
+  def examples_path( filetype=nil )
+    path = ''
+    if [:html, :scss, :js].include? filetype
+      path = File.join(PROJECT_ROOT, @config[:patterns_folder], '*', '*.' + filetype.to_s)
+    else
+      path = File.join(PROJECT_ROOT, @config[:patterns_folder], '*')
+    end
+    path
+  end
+
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: blastwolf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tom Gladhill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+description: Pattern library documentation
+email:
+- whoojemaflip@gmail.com
+executables:
+- blastwolf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/blastwolf
+- blastwolf.gemspec
+- lib/blastwolf.rb
+- lib/blastwolf/pygments.rb
+- lib/blastwolf/templates/doc_page.liquid
+- lib/blastwolf/templates/index.liquid
+- lib/blastwolf/templates/layout.liquid
+- lib/blastwolf/version.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pattern library documentation
+test_files: []