middleman-kss 0.1

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/CONTRIBUTING.md

@@ -0,0 +1 @@
+CONTRIBUTING.md

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gem 'middleman-core'
+gem 'redcarpet'
+
+# Specify your gem's dependencies in middleman-kss.gemspec
+gemspec
+
+group :development do
+  gem 'rake', '~> 0.9.2'
+  gem 'rdoc', '~> 3.9'
+  gem 'yard', '~> 0.8.0'
+end
+
+group :test do
+  gem 'cucumber', '~> 1.2.0'
+  gem 'fivemat'
+  gem 'aruba', '~> 0.4.11'
+  gem 'rspec', '~> 2.7'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Antti-Jussi Kovalainen (ajk.fi)
+
+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,72 @@
+# middleman-kss
+
+`middleman-kss` provides [KSS][kss] helpers for
+[Middleman](http://middlemanapp.com/). With these helpers, you can easily
+insert KSS styleguide blocks. Great for creating styleguides or design
+guidelines.
+
+P.S. This gem was mainly created to be used with my
+[middleman-styleguide-template][template], which I use for creating styleguides
+and other documentation.
+
+## Installation
+
+Add this line to your Middleman project Gemfile:
+
+    gem 'middleman-kss'
+
+And then execute:
+
+    $ bundle
+
+Open your `config.rb` and add the required settings:
+
+    set :markdown_engine, :redcarpet
+    activate :kss, :kss_dir => 'stylesheets/external'
+
+Note: The :kss_dir should be set so all the `url('...')`s in your CSS map correctly.
+
+Create a `styleblocks`-directory under `source/`
+
+    $ mkdir source/styleblocks
+
+And read the next chapter for usage instructions.
+
+## Usage
+
+Okay, here's the deal:
+
+1. Write your CSS/SCSS/LESS in [KSS][kss]
+2. Insert your CSS/SCSS/LESS into the `kss_dir`
+3. Write the HTML for individual style blocks into `source/styleblocks`
+4. Use the helpers to print the style blocks
+
+See my [middleman-styleguide-template][template] for examples!
+
+### Helpers
+
+**styleblock** <%= styleblock 'filename', [section: '1.1'] %>
+
+Renders the styleblock named `filename`.
+
+*Optional:* `section` parameter maps the
+rendered styleblock to a KSS section, which will expand the section into a fully
+documented KSS styleblock with all the available classes and such.
+
+
+## Contributing
+
+Contributions are most welcome! And well-tested and documented contributions are
+more welcome than others ;)
+
+1. [Fork the repository][fork]
+2. [Create a branch][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 pull request][pr]
+
+[kss]: https://github.com/kneath/kss
+[template]: https://github.com/Darep/middleman-styleguide-template
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Rakefile

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

data/TODO.md

@@ -0,0 +1,9 @@
+- Add kss_dir to sprockets' asset path, so Middleman includes it if it's not under stylesheets and Sass/Compass helpers work correctly
+- Refactor hacky redcarpet implementation, allow use of other engines
+- Add tests
+
+-------------------------------------------------------------------------------
+
+✓ COMPLETED:
+
+✗ NOPE:

data/lib/middleman-kss.rb

@@ -0,0 +1,7 @@
+require 'middleman-core'
+require 'middleman-kss/version'
+
+::Middleman::Extensions.register(:kss) do
+  require 'middleman-kss/extension'
+  ::Middleman::KSS
+end

data/lib/middleman-kss/_styleguide_block.html.erb

@@ -0,0 +1,29 @@
+<div class="styleguide-example">
+
+  <h3><%= @section.section %> <em><%= @section.filename %></em></h3>
+  <div class="styleguide-description markdown-body">
+    <%= kss_markdown kss_h(@section.description) %>
+    <% if @section.modifiers.any? %>
+      <ul class="styleguide-modifier">
+        <% @section.modifiers.each do |modifier| %>
+          <li><strong><%= modifier.name %></strong> - <%= modifier.description %></li>
+        <% end %>
+      </ul>
+    <% end %>
+  </div>
+  <div class="styleguide-element">
+    <%= @block_html.gsub('$modifier_class', '') %>
+  </div>
+  <% @section.modifiers.each do |modifier| %>
+    <div class="styleguide-element styleguide-modifier">
+      <span class="styleguide-modifier-name"><%= modifier.name %></span>
+      <%= @block_html.gsub('$modifier_class', " #{modifier.class_name}") %>
+    </div>
+  <% end %>
+  <div class="styleguide-html">
+    <pre>
+      <code class="language-markup"><%= kss_h @block_html.gsub('$modifier_class', '').gsub(' class=""', '') %></code>
+    </pre>
+  </div>
+
+</div>

data/lib/middleman-kss/extension.rb

@@ -0,0 +1,82 @@
+require 'kss'
+
+begin
+  require 'redcarpet'
+rescue LoadError
+end
+
+begin
+  require 'kramdown'
+rescue LoadError
+end
+
+module Middleman
+  module KSS
+    class << self
+
+      def options
+        @@options
+      end
+
+      def registered(app, options_hash={})
+        @@options = options_hash
+        yield @@options if block_given?
+
+        app.send :include, Helpers
+      end
+      alias :included :registered
+    end
+
+    module Helpers
+      # Renders a styleblock with or without styleguide information.
+      #
+      # @param [String] tile
+      #   Name of the style tile file to render.
+      # @param [Hash] options
+      #   Options for rendering.
+      # @option options [String] :section
+      #   KSS section number (e.g. "1.1") for fetching the styleguide information.
+      #
+      # @return [String] Generated HTML.
+      #
+      def styleblock(tile, options = {})
+        extension_options = ::Middleman::KSS.options
+
+        # Parse the KSS style guide once per request (because it might change a lot, yo)
+        unless request.has_key?(:styleguide)
+          request[:styleguide] = ::Kss::Parser.new(File.join(self.source_dir, extension_options[:kss_dir]))
+        end
+
+        @styleguide = request[:styleguide]
+
+        tile_file = "_#{tile}.html.erb"
+        # TODO: remove "styleblocks" magic string
+        tile_path = File.join(self.source_dir, "styleblocks", tile_file)
+        @block_html = File.read(tile_path)
+
+        if options.has_key?(:section)
+          @section = @styleguide.section(options[:section])
+          # TODO: remove magic strings: "partials" and "_styleguide_block.html.erb"
+          styleguide_block_path = File.join(File.dirname(__FILE__), '_styleguide_block.html.erb')
+          #styleguide_block_path = File.join(self.source_dir, "partials", "_styleguide_block.html.erb")
+          render_individual_file(styleguide_block_path)
+        else
+          return @block_html.gsub('$modifier_class', '').gsub(' class=""', '')
+          #render_individual_file(@block_html)
+        end
+      end
+
+      # Simple HTML escape helper
+      def kss_h(text)
+        Rack::Utils.escape_html(text)
+      end
+
+      # Markdown in KSS
+      def kss_markdown(input)
+        markdown = ::Redcarpet::Markdown.new(::Redcarpet::Render::HTML, :autolink => true, :space_after_headers => true)
+        markdown.render(input)
+      end
+
+    end
+  end
+end

data/lib/middleman-kss/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-kss'

data/lib/middleman-kss/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module KSS
+    VERSION = "0.1"
+  end
+end

data/middleman-kss.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-kss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-kss'
+  spec.version       = Middleman::KSS::VERSION
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ['Antti-Jussi Kovalainen']
+  spec.email         = ['ajk@ajk.fi']
+  spec.description   = %q{KSS (Knyle Style Sheets) helpers for Middleman}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/darep/middleman-kss'
+  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.required_ruby_version = '>= 1.8.7'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+
+  spec.add_runtime_dependency('middleman-core', '~> 3.0')
+  spec.add_runtime_dependency('kss', '~> 0.4')
+  spec.add_runtime_dependency('redcarpet', '~> 2.2.2')
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: middleman-kss
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Antti-Jussi Kovalainen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-05 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: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: kss
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: KSS (Knyle Style Sheets) helpers for Middleman
+email:
+- ajk@ajk.fi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- lib/middleman-kss.rb
+- lib/middleman-kss/_styleguide_block.html.erb
+- lib/middleman-kss/extension.rb
+- lib/middleman-kss/middleman_extension.rb
+- lib/middleman-kss/version.rb
+- middleman-kss.gemspec
+homepage: https://github.com/darep/middleman-kss
+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: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: KSS (Knyle Style Sheets) helpers for Middleman
+test_files: []