styleguide-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07294314006ad4217991f4b26ff1040cbe0fb67b
+  data.tar.gz: 8b0b554d67165c9b4ccd49f79bbcee5431ab3399
+SHA512:
+  metadata.gz: c2795266f07d5a29c4a31df12f769f95b42924c94db9316143de48e360b71bb9daadde920156c1427c8d388891711416d25110ec5ef064d1ff1ba609e4ac70b1
+  data.tar.gz: 029fb948f604ac22484b7ae9eb8dd11b1df98171b4cc42a5f08936acbe1fab33258e5a43448a66bc93f6e50750a06682a07764808fbf47c5a665ab9f195cb6e2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+# v0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem’s dependencies in styleguide-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nico Hagenburger
+
+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,41 @@
+# Style Guide API
+
+TODO: Write a gem description
+
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+``` ruby
+gem "styleguide-api"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install styleguide-api
+
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Contributing
+
+1. Fork it ( https://github.com/livingstyleguide/styleguide-api/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
+
+
+## Copyright
+
+Copyright 2015 [Nico Hagenburger](http://www.hagenburger.net).
+Released under [MIT License](LICENSE.txt).
+Get in touch with [@hagenburger](http://twitter.com/hagenburger) on Twitter or [open an issue](https://github.com/livingstyleguide/styleguide-api/issues/new).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task default: [:test]

data/lib/styleguide-api.rb

@@ -0,0 +1,99 @@
+require "styleguide-api/version"
+require "styleguide-api/helpers"
+require "tilt"
+require "open-uri"
+require "json"
+
+module StyleGuideAPI
+  class << self
+    attr_accessor :live
+    attr_accessor :theme
+  end
+
+  def self.initialize
+    @live = false
+    @templates = {}
+    @template_paths = {}
+    @data = nil
+    @theme = nil
+    @stylesheets = {}
+  end
+  initialize
+
+  def self.data
+    return @data if @data and not (live and @template_paths.any?)
+    @data = {}
+    load_templates
+    @data
+  end
+
+  def self.load(uri)
+    json = open(uri).read
+    @data = JSON.parse(json)
+  end
+
+  def self.add_templates(glob, options = {})
+    current_theme = options[:theme] || theme
+    @template_paths[current_theme] ||= []
+    @template_paths[current_theme] << glob
+  end
+
+  def self.add_stylesheet(file)
+    @stylesheets[theme] ||= []
+    @stylesheets[theme] << file
+  end
+
+  def self.render(template_name, locals = {}, &block)
+    scope = locals.delete(:scope) || Object.new
+    template = template_for(template_name)
+    template.render(scope, locals, &block)
+  end
+
+  def self.template_for(name)
+    @templates[theme][name] if @templates[theme] && @templates[theme][name]
+    template = data[theme]["templates"][name]
+    @templates[theme] ||= {}
+    @templates[theme][name] = Tilt[template["type"]].new { template["source"] }
+  end
+
+  def self.theme
+    @theme ||= themes.first || "default"
+  end
+
+  def self.themes
+    (@template_paths.keys + (@data ? @data.keys : [])).uniq
+  end
+
+  def self.to_json
+    data.to_json
+  end
+
+  def self.stylesheets
+    data[theme]["stylesheets"] || []
+  end
+
+  private
+  def self.load_templates
+    themes.each do |theme|
+      @data[theme] ||= {
+        "templates" => {},
+        "stylesheets" => @stylesheets[theme]
+      }
+      @template_paths[theme].each do |glob|
+        path = glob.split("*").first
+        Dir.glob(glob).each do |file|
+          key, type = file.sub("/_", "/").sub(/^#{path}(.+?)\.(\w+)$/, "\\1"), $2
+          if Tilt[type]
+            @data[theme]["templates"][key] = {
+              "source" => File.read(file).strip,
+              "type" => type
+            }
+          end
+        end
+      end
+    end
+  end
+
+end
+
+require "styleguide-api/middleman" if defined?(Middleman)

data/lib/styleguide-api/helpers.rb

@@ -0,0 +1,13 @@
+module StyleGuideAPI::Helpers
+
+  def style_template(name, locals = {}, &block)
+    StyleGuideAPI::render(name, locals, &block)
+  end
+
+  def style_css
+    StyleGuideAPI.stylesheets.map do |url|
+      %Q(<link href="#{url}" rel="stylesheet">)
+    end.join("\n")
+  end
+
+end

data/lib/styleguide-api/middleman.rb

@@ -0,0 +1,43 @@
+require 'middleman-core'
+
+class StyleGuideAPI::MiddlemanExtension < ::Middleman::Extension
+  option :templates, '', 'Glob to load templates'
+
+  def initialize(app, options_hash = {}, &block)
+    super
+
+    app.configure :development do
+      StyleGuideAPI.live = true
+    end
+
+    if options_hash.has_key?(:templates)
+      StyleGuideAPI.add_templates options_hash[:templates]
+    end
+
+    if options_hash.has_key?(:load)
+      StyleGuideAPI.load options_hash[:load]
+    end
+
+    if options_hash.has_key?(:theme)
+      StyleGuideAPI.theme = options_hash[:theme]
+    end
+  end
+
+  helpers StyleGuideAPI::Helpers
+
+  helpers do
+    def style_template(name, locals = {}, &block)
+      locals[:scope] = self
+      if block_given?
+        template = StyleGuideAPI.data[StyleGuideAPI.theme]["templates"][name]
+        type = template["type"].to_sym
+        handler_class = ::Padrino::Helpers::OutputHelpers.handlers[type]
+        html = handler_class.new(self).capture_from_template(&block)
+        block = Proc.new { html }
+      end
+      StyleGuideAPI::render(name, locals, &block)
+    end
+  end
+end
+
+StyleGuideAPI::MiddlemanExtension.register(:styleguide_api)

data/lib/styleguide-api/version.rb

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

data/styleguide-api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "styleguide-api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "styleguide-api"
+  spec.version       = StyleGuideAPI::VERSION
+  spec.authors       = ["Nico Hagenburger"]
+  spec.email         = ["nico@hagenburger.net"]
+  spec.summary       = %q{Helpers for creating a style guide API}
+  spec.description   = %q{Helpers for a style guide API provider and consumer with Tilt templates}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "tilt"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "heredoc_unindent"
+end

data/test/fixtures/load_test/products/_ball.erb

@@ -0,0 +1 @@
+<div class="product"><%= name %></div>

data/test/fixtures/load_test/style.json

@@ -0,0 +1,10 @@
+{
+  "my-theme": {
+    "templates": {
+      "my-template": {
+        "source": ".my-template",
+        "type": "haml"
+      }
+    }
+  }
+}

data/test/fixtures/load_test/user.haml

@@ -0,0 +1 @@
+.user= name

data/test/fixtures/render_test/block.haml

@@ -0,0 +1,2 @@
+.first-name= name
+.last-name= yield

data/test/fixtures/render_test/user.haml

@@ -0,0 +1 @@
+.user= name

data/test/fixtures/themes_test/blue/user.haml

@@ -0,0 +1 @@
+.user-blue= name

data/test/fixtures/themes_test/red/user.haml

@@ -0,0 +1 @@
+.user-red= name

data/test/helper_test.rb

@@ -0,0 +1,50 @@
+require "test_helper"
+
+describe StyleGuideAPI::Helpers do
+
+  before do
+    StyleGuideAPI.add_templates "test/fixtures/render_test/*.haml"
+    StyleGuideAPI.add_stylesheet "base.css"
+    StyleGuideAPI.add_stylesheet "more.css"
+    @helpers = Class.new do
+      extend StyleGuideAPI::Helpers
+    end
+  end
+
+  after do
+    StyleGuideAPI.initialize
+  end
+
+  describe "rendering templates" do
+
+    it "should render templates" do
+      result = @helpers.style_template("user", name: "Homer")
+      assert_equal <<-HTML.strip, result.strip
+        <div class='user'>Homer</div>
+      HTML
+    end
+
+    it "should accept blocks" do
+      result = @helpers.style_template("block", name: "Homer") { "Simpson" }
+      assert_equal <<-HTML.unindent.strip, result.strip
+        <div class='first-name'>Homer</div>
+        <div class='last-name'>Simpson</div>
+      HTML
+    end
+
+  end
+
+  describe "stylesheets" do
+
+    it "should create stylesheet link tags" do
+      result = @helpers.style_css
+      assert_equal <<-HTML.unindent.strip, result
+        <link href="base.css" rel="stylesheet">
+        <link href="more.css" rel="stylesheet">
+      HTML
+    end
+
+  end
+
+end
+

data/test/load_test.rb

@@ -0,0 +1,60 @@
+require "test_helper"
+
+describe StyleGuideAPI do
+
+  after do
+    StyleGuideAPI.initialize
+  end
+
+  describe "loading templates" do
+
+    it "should load templates" do
+      StyleGuideAPI.add_templates "test/fixtures/load_test/**/*.*"
+      data = {
+        "user" => {
+          "source" => ".user= name",
+          "type" => "haml"
+        },
+        "products/ball" => {
+          "source" => "<div class=\"product\"><%= name %></div>",
+          "type" => "erb"
+        }
+      }
+      assert_equal(data, StyleGuideAPI.data["default"]["templates"])
+
+      FileUtils.cp "test/fixtures/load_test/user.haml",
+                   "test/fixtures/load_test/new-user.haml"
+      assert_equal(data, StyleGuideAPI.data["default"]["templates"])
+
+      FileUtils.rm "test/fixtures/load_test/new-user.haml"
+    end
+
+    it "should dynamically load templates" do
+      StyleGuideAPI.live = true
+      StyleGuideAPI.add_templates "test/fixtures/load_test/**/*.*"
+      assert_equal %w(products/ball user),
+                   StyleGuideAPI.data["default"]["templates"].keys.sort
+
+      FileUtils.cp "test/fixtures/load_test/user.haml",
+                   "test/fixtures/load_test/new-user.haml"
+      assert_equal %w(new-user products/ball user),
+                   StyleGuideAPI.data["default"]["templates"].keys.sort
+
+      FileUtils.rm "test/fixtures/load_test/new-user.haml"
+    end
+
+    it "should load templates from JSON" do
+      StyleGuideAPI.load("test/fixtures/load_test/style.json")
+      assert_equal "my-theme", StyleGuideAPI.theme
+      assert_equal "<div class='my-template'></div>", StyleGuideAPI.render("my-template").strip
+    end
+
+    it "should add a CSS file" do
+      StyleGuideAPI.add_templates "test/fixtures/load_test/**/*.*"
+      StyleGuideAPI.add_stylesheet "styles.css"
+      assert_equal %w(styles.css), StyleGuideAPI.data["default"]["stylesheets"]
+    end
+
+  end
+
+end

data/test/provider_test.rb

@@ -0,0 +1,34 @@
+require "test_helper"
+require "json"
+
+describe StyleGuideAPI do
+
+  after do
+    StyleGuideAPI.initialize
+  end
+
+  describe "providing templates" do
+
+    it "should provide templates as JSON" do
+      StyleGuideAPI.add_templates "test/fixtures/load_test/*.haml"
+      StyleGuideAPI.add_stylesheet "http://abc.xy/styles.css"
+      json = <<-JSON
+        {
+          "default": {
+            "stylesheets": ["http://abc.xy/styles.css"],
+            "templates": {
+              "user": {
+                "source": ".user= name",
+                "type": "haml"
+              }
+            }
+          }
+        }
+      JSON
+      assert_equal(JSON.parse(json), JSON.parse(StyleGuideAPI.to_json))
+    end
+
+  end
+
+end
+

data/test/render_test.rb

@@ -0,0 +1,33 @@
+require "test_helper"
+require "tilt/haml"
+
+describe StyleGuideAPI do
+
+  before do
+    StyleGuideAPI.add_templates "test/fixtures/render_test/*.haml"
+  end
+
+  after do
+    StyleGuideAPI.initialize
+  end
+
+  describe "rendering templates" do
+
+    it "should render templates" do
+      result = StyleGuideAPI.render("user", name: "Homer")
+      assert_equal <<-HTML.strip, result.strip
+        <div class='user'>Homer</div>
+      HTML
+    end
+
+    it "should accept blocks" do
+      result = StyleGuideAPI.render("block", name: "Homer") { "Simpson" }
+      assert_equal <<-HTML.unindent.strip, result.strip
+        <div class='first-name'>Homer</div>
+        <div class='last-name'>Simpson</div>
+      HTML
+    end
+
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require "minitest/autorun"
+require "heredoc_unindent"
+require "styleguide-api"

data/test/themes_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+require "tilt/haml"
+
+describe StyleGuideAPI do
+
+  after do
+    StyleGuideAPI.initialize
+  end
+
+  describe "rendering templates" do
+
+    it "should render templates" do
+      StyleGuideAPI.add_templates "test/fixtures/themes_test/red/*.haml", theme: "red"
+      StyleGuideAPI.add_templates "test/fixtures/themes_test/blue/*.haml", theme: "blue"
+
+      result = StyleGuideAPI.render("user", name: "Homer")
+      assert_match "user-red", result.strip
+
+      StyleGuideAPI.theme = "blue"
+      result = StyleGuideAPI.render("user", name: "Homer")
+      assert_match "user-blue", result.strip
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: styleguide-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nico Hagenburger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tilt
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: heredoc_unindent
+  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'
+description: Helpers for a style guide API provider and consumer with Tilt templates
+email:
+- nico@hagenburger.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/styleguide-api.rb
+- lib/styleguide-api/helpers.rb
+- lib/styleguide-api/middleman.rb
+- lib/styleguide-api/version.rb
+- styleguide-api.gemspec
+- test/fixtures/load_test/products/_ball.erb
+- test/fixtures/load_test/style.json
+- test/fixtures/load_test/user.haml
+- test/fixtures/render_test/block.haml
+- test/fixtures/render_test/user.haml
+- test/fixtures/themes_test/blue/user.haml
+- test/fixtures/themes_test/red/user.haml
+- test/helper_test.rb
+- test/load_test.rb
+- test/provider_test.rb
+- test/render_test.rb
+- test/test_helper.rb
+- test/themes_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Helpers for creating a style guide API
+test_files:
+- test/fixtures/load_test/products/_ball.erb
+- test/fixtures/load_test/style.json
+- test/fixtures/load_test/user.haml
+- test/fixtures/render_test/block.haml
+- test/fixtures/render_test/user.haml
+- test/fixtures/themes_test/blue/user.haml
+- test/fixtures/themes_test/red/user.haml
+- test/helper_test.rb
+- test/load_test.rb
+- test/provider_test.rb
+- test/render_test.rb
+- test/test_helper.rb
+- test/themes_test.rb
+has_rdoc: