yaks 0.5.0 → 0.6.0.alpha

data/{lib → yaks/lib}/yaks/default_policy.rb

@@ -92,7 +92,8 @@ module Yaks
     # @return [#call] format_class
     def serializer_for_format(format_class)
       {
-        json: JSON.method(:pretty_generate)
+        json: JSON.method(:pretty_generate),
+        html: :to_html.to_proc
       }.fetch(format_class.serializer)
     end
   end

data/{lib → yaks/lib}/yaks/runner.rb

@@ -37,7 +37,7 @@ module Yaks
       insert_hooks(
         [[ :map, mapper ],
          [ :format, formatter ],
-         [ :primitivize, primitivize], # really a JSON-preprocessor, should be pulled out
+         [ :primitivize, primitivizer],
          [ :serialize, serializer ]])
     end
     memoize :steps
@@ -54,6 +54,17 @@ module Yaks
     end
     memoize :formatter
 
+    def primitivizer
+      ->(input) do
+        if format_class.serializer == :json
+          primitivize.call(input)
+        else
+          input
+        end
+      end
+    end
+    memoize :primitivizer
+
     # @param [Hash] opts
     # @return [String]
     def format_name

data/yaks/lib/yaks/version.rb

@@ -0,0 +1,3 @@
+module Yaks
+  VERSION = '0.6.0.alpha'
+end

data/{spec → yaks/spec}/unit/yaks/runner_spec.rb

@@ -235,7 +235,7 @@ RSpec.describe Yaks::Runner do
       expect(runner.steps).to eql [
         [ :map, runner.mapper ],
         [ :format, runner.formatter ],
-        [ :primitivize, runner.primitivize],
+        [ :primitivize, runner.primitivizer],
         [ :serialize, runner.serializer ]
       ]
     end

data/yaks-html/README.md

@@ -0,0 +1,3 @@
+A HTML output format for Yaks.
+
+Browse your hypermedia API like a good old fashioned web site.

data/yaks-html/lib/yaks/format/html.rb

@@ -0,0 +1,70 @@
+# -*- coding: utf-8 -*-
+
+module Yaks
+  class Format
+    class HTML < self
+      include Adamantium
+
+      register :html, :html, 'text/html'
+
+      def template
+        Hexp.parse(File.read(File.expand_path('../template.html', __FILE__)))
+      end
+      memoize :template
+
+      def section(name)
+        template.select(".#{name}").first
+      end
+
+      def serialize_resource(resource)
+        template.replace('body') do |body|
+          body.content(render_resource(resource))
+        end
+      end
+
+      def render_resource(resource, templ = section('resource'))
+        templ
+          .replace('.type') { |header| header.content(resource.type.to_s + (resource.collection? ? ' collection' : '')) }
+          .replace('.attribute', &render_attributes(resource.attributes))
+          .replace('.link', &render_links(resource.links))
+          .replace('.subresources') {|table| resource.subresources.empty? ? [] : render_subresources(resource.subresources, templ).call(table) }
+      end
+
+      def render_attributes(attributes)
+        ->(templ) do
+          attributes.map do |key, value|
+            templ
+              .replace('.name')  {|x| x.content(key.to_s) }
+              .replace('.value') {|x| x.content(value.inspect) }
+          end
+        end
+      end
+
+      def render_links(links)
+        ->(templ) do
+          links.map do |link|
+            templ
+              .replace('.rel a') {|a| a.attr('href', link.rel.to_s).content(link.rel.to_s) }
+              .replace('.uri a') {|a| a.attr('href', link.uri).content(link.uri) }
+              .replace('.title') {|x| x.content(link.title) }
+              .replace('.templated') {|x| x.content(link.templated?.inspect) }
+          end
+        end
+      end
+
+      def render_subresources(subresources, templ)
+        templ = templ.replace('h1,h2,h3,h4') {|h| h.set_tag("h#{h.tag[/\d/].to_i.next}") }
+        ->(wrap) do
+          wrap.replace('.subresource') { |row|
+            subresources.map do |rel, resources|
+              row
+                .replace('.rel a') {|a| a.attr('href', rel.to_s).content(rel.to_s) }
+                .replace('.value') {|x| x.content(resources.map { |resource| render_resource(resource, templ) })}
+            end
+          }
+        end
+      end
+
+    end
+  end
+end

data/yaks-html/lib/yaks/format/template.html

@@ -0,0 +1,56 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <style type="text/css">
+      .resource {
+        border: 1px solid black;
+        padding: 0.3em;
+      }
+
+      h1,h2,h3,h4,h5 {
+        background-color: #090
+      }
+
+      table {
+        width:99%;
+        margin: 0.5em;
+      }
+
+      th{ background-color: #fee; }
+
+    </style>
+  </head>
+  <body>
+    <div class="resource">
+      <h1 class="type">Resource Type</h1>
+
+      <table border="1" class="attributes">
+        <tr><th>Attribute</th><th>Value</th></tr>
+        <tr class="attribute"><td class="name">name</td><td class="value">value</td></tr>
+      </table>
+
+      <table border="1" class="links">
+        <tr>
+          <th>Rel</th>
+          <th>URI</th>
+          <th>Title</th>
+          <th>Templated</th>
+        </tr>
+
+        <tr class="link">
+          <td class="rel"><a href="">rel</a></td>
+          <td class="uri"><a href="">uri</a></td>
+          <td class="title">title</td>
+          <td class="templated">false</td>
+        </tr>
+      </table>
+
+      <table border="1" class="subresources">
+        <tr><th>Rel</th><th>Subresource</th></tr>
+        <tr class="subresource"><td class="rel"><a>rel</a></td><td class="value">value</td></tr>
+      </table>
+    </div>
+  </body>
+</html>

data/yaks-html/lib/yaks-html.rb

@@ -0,0 +1,3 @@
+require 'hexp'
+
+require 'yaks/format/html'

data/yaks-html/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+RSpec.configure do |rspec|
+  rspec.include FixtureHelpers
+  rspec.backtrace_exclusion_patterns = [] if ENV['FULLSTACK']
+  rspec.disable_monkey_patching!
+  rspec.raise_errors_for_deprecations!
+end

data/yaks-html/yaks-html.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require File.expand_path('../../yaks/lib/yaks/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'yaks-html'
+  gem.version     = Yaks::VERSION
+  gem.authors     = [ 'Arne Brasseur' ]
+  gem.email       = [ 'arne@arnebrasseur.net' ]
+  gem.description = 'HTML output format for Yaks'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/plexus/yaks'
+  gem.license     = 'MIT'
+
+  gem.require_paths    = %w[lib]
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = `git ls-files -- spec`.split($/)
+  gem.extra_rdoc_files = %w[README.md]
+
+  gem.add_runtime_dependency 'yaks', Yaks::VERSION
+  gem.add_runtime_dependency 'hexp', '>= 0.3'
+end