docks_app 0.0.1

data/.editorconfig

@@ -0,0 +1,8 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.ruby-version
+.bundle
+.config
+.yardoc
+.docks
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*/.*

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/ClassLength:
+  Max: 125
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/AbcSize:
+  Max: 20

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - ruby-head
+notifications:
+  slack: lemon:SeSji4OVQ1qGtQ2Gg2iTLCge

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Sauve
+
+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,35 @@
+# Docks
+
+[![Build Status](https://travis-ci.org/docks-app/docks.svg?branch=master)](https://travis-ci.org/docks-app/docks)
+
+Docks is for creating beautiful, live, styleguides.
+
+A styleguide is a collection of your application’s visual and programmatic patterns.
+
+Docks supports patterns for JavaScript, CoffeeScript, Sass, Less, Stylus, ERB, Slim, and Haml.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'docks'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install docks
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/docks/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+Dir.glob('tasks/**/*.rake').each(&method(:import))

data/bin/docks

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "docks"
+require "docks/command_line"
+
+Docks::CommandLine.new(ARGV).run

data/config/json/docks_config.json

@@ -0,0 +1,71 @@
+{
+  // An array of glob patterns specifying all source files. These will be the
+  // sources for all of your library's patterns. Include any style, script,
+  // markup, stub, and description files you have to document your patterns.
+  // These paths should be relative to the root of your project.
+  "sources": {{{sources}}},
+
+  // The destination folder in which you would like to generate the static
+  // pattern library. This path should be relative to the root of your project.
+  "destination": {{{destination}}},
+
+  // When generating your static styleguide, these assets will be included
+  // in the default layout file automatically (via a `link` tag when the asset
+  // is a stylesheet, and via a `script` tag when it is a JavaScript file).
+  //
+  // These assets must be compiled — Docks will not compile assets for you
+  // automatically. Feel free to omit this option if you are going to manually
+  // add the required asset tags to your layout file. These paths should be
+  // relative to the root of your project.
+  "compiled_assets": {{{compiled_assets}}},
+
+  "templates": {{{templates}}},
+
+  // The root path of your pattern library. When generating a static version,
+  // all pattern files will be nested inside this directory.
+  "mount_at": {{{mount_at}}},
+
+  "use_theme_assets": {{{use_theme_assets}}},
+
+  // The name of the Github repo for this project. This can either be the URL or
+  // in the form `<username>/<repo>`. The default theme uses this option, if
+  // passed, to provide links to create issue and view source for your pattern
+  // library's files.
+  "github_repo": {{{github_repo}}},
+
+  // This option allows you to specify the default template files to use and
+  // provide a list of patterns that will use custom templates for rendering.
+  // The special key `default` will set the default template to render for
+  // patterns that do not have a custom template. The special key `demo` will
+  // specify the template to use for rendering demos (the content that will
+  // appear in iframes in the default theme).
+  //
+  // To provide a custom template for any other pattern, simply use the pattern
+  // identifier as a key and the custom template (relative to the
+  // `asset_folders.templates` directory inside of the `library_assets` folder)
+  // as the value. For example, you could use `color: color.erb` to have the
+  // pattern with an ID of `color` use the template in (using the default
+  // folders): `<root>/pattern_library_assets/templates/color.erb`. To provide
+  // more complex matching or custom layouts in addition to custom templates,
+  // you must use the `.rb` version of this config file.
+  "custom_templates": {{{custom_templates}}},
+
+  // The naming convention to use for such things as identifying a state versus
+  // a variant and determining the base class of a given variation. There are
+  // a few bundled naming conventions, viewable under lib/docks/naming_conventions.
+  // You can either pass a string with the name of the desired naming convention
+  // (capitalization is important) or pass an instance of a naming convention
+  // class. If creating your own naming convention, make sure to inherit and
+  // override all methods in `Docks::NamingConventions::Base`.
+  "naming_convention": {{{ naming_convention }}},
+
+  // A list of file names that contain helper modules needed to render your
+  // components, or that you want available to be used inside your views. Every
+  // module in each of these files will be included in the renderer so that you
+  // have access to them in all of your templates. These files should be relative
+  // to the root of your project.
+  "helpers": {{{helpers}}},
+
+  "theme": {{{theme}}},
+  "paginate": {{{paginate}}}
+}

data/config/ruby/docks_config.rb

@@ -0,0 +1,127 @@
+Docks.configure do |config|
+
+  # An array of glob patterns specifying all source files. These will be the
+  # sources for all of your library's patterns. Include any style, script,
+  # markup, stub, and description files you have to document your patterns.
+  # These paths should be relative to the root of your project.
+  config.sources = {{{sources}}}
+
+  # The destination folder in which you would like to generate the static
+  # pattern library. This path should be relative to the root of your project.
+  config.destination = {{{destination}}}
+
+  # When generating your static styleguide, these assets will be included
+  # in the default layout file automatically (via a `link` tag when the asset
+  # is a stylesheet, and via a `script` tag when it is a JavaScript file).
+  #
+  # These assets must be compiled — Docks will not compile assets for you
+  # automatically. Feel free to omit this option if you are going to manually
+  # add the required asset tags to your layout file. These paths should be
+  # relative to the root of your project.
+  config.compiled_assets = {{{compiled_assets}}}
+
+  config.templates = {{{templates}}}
+
+  # The root path of your pattern library. When generating a static version,
+  # all pattern files will be nested inside this directory.
+  config.mount_at = {{{mount_at}}}
+
+  config.use_theme_assets = {{{use_theme_assets}}}
+
+  # The name of the Github repo for this project. This can either be the URL or
+  # in the form `<username>/<repo>`. The default theme uses this option, if
+  # passed, to provide links to create issue and view source for your pattern
+  # library's files.
+  config.github_repo = {{{github_repo}}}
+
+  # Yields an object that allows you to register custom templates for particular
+  # patterns. See `Docks::Templates` for all of the available template
+  # customizations. The basics are that you can set the fallback template,
+  # fallback layout file, and the template for demos with the `fallback=`,
+  # `default_layout=`, and `demo=` methods. You can also register a custom
+  # template for patterns matching a pattern ID by calling `Templates.register`
+  # like so:
+  #
+  # config.custom_templates do |templates|
+  #   templates.register("color.html.erb", for: /color/)
+  #   # or, equivalently, templates << Docks::Templates::Template.new("color.html.erb", for: /color/)
+  # end
+  #
+  # Which would register "color.html.erb" to be used for patterns whose name
+  # matches `/color/`. You can also call `Docks::Templates.register` with a
+  # hash of pattern: template pairs, in which the keys will be used as the
+  # "matcher" and the values will be the custom template to use for patterns
+  # with a matching name.
+  config.custom_templates = {{{custom_templates}}}
+
+  # The naming convention to use for such things as identifying a state versus
+  # a variant and determining the base class of a given variation. There are
+  # a few bundled naming conventions, viewable under lib/docks/naming_conventions.
+  # You can either pass a string with the name of the desired naming convention
+  # (capitalization is important) or pass an instance of a naming convention
+  # class. If creating your own naming convention, make sure to inherit and
+  # override all methods in `Docks::NamingConventions::Base`.
+  config.naming_convention = {{{naming_convention}}}
+
+  # A list of file names or Modules that contain helper modules needed to render
+  # your components, or that you want available to be used inside your views.
+  #
+  # If you pass a list of files, every module in each file will be included in
+  # the renderer so that you have access to them in all of your templates. These
+  # files should be relative to the root of your project.
+  #
+  # If you pass a list of modules, no additional work is required on your part.
+  # These will be included automatically in all template rendering.
+  config.helpers = {{{helpers}}}
+
+  # This option allows you to provide a custom lambda to determine what pattern
+  # a given string belongs to. The lambda should accept a single file name
+  # which may be either a filename (most commonly), or any other string (for
+  # example, this is used to try to match the name of a component to a markup
+  # file by first running both through this lambda). The default, if you do
+  # not provide anything for the option below (or provide an empty lambda)
+  # will strip leading underscores and normalize dashes and underscores of the
+  # extension-less base name of whatever string you pass to it. For details,
+  # see `lib/group.rb`.
+  config.pattern_id = lambda do |file|
+  end
+
+  # Yields an object that allows you to register custom tags. Your
+  # tag should extend `Docks::Tags::Base` (or a subclass). Once you have defined
+  # it, register the custom tag as follows:
+  #
+  # config.custom_tags { |tags| tags << MyCustomTagClass }
+  config.custom_tags do |tags|
+  end
+
+  # Yields an object that allows you to register custom languages. Your
+  # language should extend `Docks::Languages::Base`. (or a subclass) Once you
+  # have defined it, register the custom language as follows:
+  #
+  # config.custom_languages { |languages| languages << MyCustomLanguageClass }
+  config.custom_languages do |languages|
+  end
+
+  # Yields an object that allows you to register custom parsers. Your
+  # parser should extend `Docks::Parsers::Base` (or a subclass). The second
+  # argument should be a hash with a `:for` key that specifies a regular
+  # expression that will match files that should use this parser. Once you have
+  # defined it, register the custom parser as follows:
+  #
+  # config.custom_parsers { |parsers| parsers.register(MyCustomParserClass, for: /the_pattern_to_match/) }
+  config.custom_parsers do |parsers|
+  end
+
+  # Yields an object that allows you to register custom symbol sources (that is,
+  # objects that understand specific types that may be found in your
+  # documentation and that can provide links to the relevant documentation
+  # for those types). Your symbol source should extend `Docks::SymbolSources::Base`.
+  # Once you have defined it, register the custom source as follows:
+  #
+  # config.custom_symbol_sources { |symbol_sources| symbol_sources << MyCustomSourceClass }
+  config.custom_symbol_sources do |symbol_sources|
+  end
+
+  config.theme = {{{theme}}}
+  config.paginate = {{{paginate}}}
+end

data/config/yaml/docks_config.yml

@@ -0,0 +1,70 @@
+---
+# An array of glob patterns specifying all source files. These will be the
+# sources for all of your library's patterns. Include any style, script,
+# markup, stub, and description files you have to document your patterns.
+# These paths should be relative to the root of your project.
+sources: {{{sources}}}
+
+# The destination folder in which you would like to generate the static
+# pattern library. This path should be relative to the root of your project.
+destination: {{{destination}}}
+
+# When generating your static styleguide, these assets will be included
+# in the default layout file automatically (via a `link` tag when the asset
+# is a stylesheet, and via a `script` tag when it is a JavaScript file).
+#
+# These assets must be compiled — Docks will not compile assets for you
+# automatically. Feel free to omit this option if you are going to manually
+# add the required asset tags to your layout file. These paths should be
+# relative to the root of your project.
+compiled_assets: {{{compiled_assets}}}
+
+templates: {{{templates}}}
+
+# The root path of your pattern library. When generating a static version,
+# all pattern files will be nested inside this directory.
+mount_at: {{{mount_at}}}
+
+use_theme_assets: {{{use_theme_assets}}}
+
+# The name of the Github repo for this project. This can either be the URL or
+# in the form `<username>/<repo>`. The default theme uses this option, if
+# passed, to provide links to create issue and view source for your pattern
+# library's files.
+github_repo: {{{github_repo}}}
+
+# This option allows you to specify the default template files to use and
+# provide a list of patterns that will use custom templates for rendering.
+# The special key `default` will set the default template to render for
+# patterns that do not have a custom template. The special key `demo` will
+# specify the template to use for rendering demos (the content that will
+# appear in iframes in the default theme).
+#
+# To provide a custom template for any other pattern, simply use the pattern
+# identifier as a key and the custom template (relative to the
+# `asset_folders.templates` directory inside of the `library_assets` folder)
+# as the value. For example, you could use `color: color.erb` to have the
+# pattern with an ID of `color` use the template in (using the default
+# folders): `<root>/pattern_library_assets/templates/color.erb`. To provide
+# more complex matching or custom layouts in addition to custom templates,
+# you must use the `.rb` version of this config file.
+custom_templates: {{{custom_templates}}}
+
+# The naming convention to use for such things as identifying a state versus
+# a variant and determining the base class of a given variation. There are
+# a few bundled naming conventions, viewable under `lib/docks/naming_conventions`.
+# You can either pass a string with the name of the desired naming convention
+# (capitalization is important) or pass an instance of a naming convention
+# class. If creating your own naming convention, make sure to inherit and
+# override all methods in `Docks::NamingConventions::Base`.
+naming_convention: {{{naming_convention}}}
+
+# A list of file names that contain helper modules needed to render your
+# components, or that you want available to be used inside your views. Every
+# module in each of these files will be included in the renderer so that you
+# have access to them in all of your templates. These files should be relative
+# to the root of your project.
+helpers: {{{helpers}}}
+
+theme: {{{theme}}}
+paginate: {{{paginate}}}

data/docks.gemspec

@@ -0,0 +1,38 @@
+require "rubygems"
+
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "docks/version"
+
+Gem::Specification.new do |s|
+  s.name                  = "docks_app"
+  s.version               = Docks::VERSION
+  s.platform              = Gem::Platform::RUBY
+  s.required_ruby_version = ">= 1.9.3"
+  s.authors               = ["Chris Sauve"]
+  s.email                 = ["chrismsauve@gmail.com"]
+  s.license               = "MIT"
+  s.homepage              = ""
+  s.summary               = "A pattern library generator for front-end projects."
+  s.description           = s.summary
+
+  s.files                 = `git ls-files`.split("\n")
+  s.test_files            = `git ls-files -- spec/*`.split("\n")
+  s.executables           = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths         = ["lib"]
+
+  s.add_runtime_dependency "redcarpet", "~> 3.1"
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "mustache", "~> 0.99.5"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rubocop", "< 1.0"
+  s.add_development_dependency "rake", "~> 10.4"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "haml", "~> 4.0"
+  s.add_development_dependency "slim", "~> 3.0"
+  s.add_development_dependency "awesome_print", "~> 1.6"
+  s.add_development_dependency "rspec-html-matchers", "~> 0.7"
+  s.add_development_dependency "html2haml", "~> 2.0"
+  s.add_development_dependency "html2slim", "~> 0.2"
+end