togostanza 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09f09d3dd56cdf9a5299e8ae8500e8b04091bc2f
-  data.tar.gz: dad69b327df8f08983390439b91de9992076c9a3
+  metadata.gz: 131870dda2a18def21bb7abe725366739bc7368a
+  data.tar.gz: 92eb70c0d0ac8e68e1b7c4de0ee31cb918545e98
 SHA512:
-  metadata.gz: 07c4d2275cc2e31db6b8693c1c414ae92487d8647825323686f91eb14026bd6ab98a084a3c3423e083aebb4b7e2c6c85b92e3dcdf1c1829a0cffc03d14381dee
-  data.tar.gz: fab2e05345d3b10ba32a682be54a57f1c7408f7c8985a800020d03ac228e48ec8141a8693ddb2f682188c050f97b59f325c957077f1a21e51ff87070c84a67dd
+  metadata.gz: c3977125a32659d2df830390255f0230b0a09374209393efb8ed6aa99e6c559051975acd8eb820371e4a8584fc867001e7017193fb1c035db7b692c7d6e65813
+  data.tar.gz: ccbdc5e2f3c163cf793be9151072f4462006aedef737ab3175e2101573cc4be833be181d555b4931b4e2e0942f692f4a0faf14c87e15cccb19a99be29b96fa0d

data/lib/togostanza/application.rb

@@ -1,7 +1,7 @@
 require 'sinatra/base'
 require 'sinatra/json'
 require 'sinatra/reloader'
-require 'haml'
+require 'tilt/haml'
 
 module TogoStanza
   class Application < Sinatra::Base
@@ -51,9 +51,9 @@ module TogoStanza
     end
 
     get '/:id/help' do |id|
-      @stanza = Stanza.find(id).new
+      stanza = Stanza.find(id).new
 
-      render :html, @stanza.help, layout_engine: :haml
+      haml :help, locals: {stanza: stanza.metadata}
     end
 
     get '/:id/metadata.json' do |id|

data/lib/togostanza/cli.rb

@@ -46,7 +46,6 @@ module TogoStanza
         template 'lib.rb.erb',        "#{file_name}/lib/#{file_name}.rb"
         template 'stanza.rb.erb',     "#{file_name}/stanza.rb"
         template 'template.hbs.erb',  "#{file_name}/template.hbs"
-        template 'help.md.erb',       "#{file_name}/help.md"
         template 'metadata.json.erb', "#{file_name}/metadata.json"
 
         create_file "#{file_name}/assets/#{stanza_id}/.keep"

data/lib/togostanza/stanza/base.rb

@@ -156,7 +156,6 @@ end
 module TogoStanza::Stanza
   autoload :ExpressionMap, 'togostanza/stanza/expression_map'
   autoload :Grouping,      'togostanza/stanza/grouping'
-  autoload :Markdown,      'togostanza/stanza/markdown'
   autoload :Querying,      'togostanza/stanza/querying'
 
   class Context < Hashie::Mash
@@ -214,12 +213,6 @@ module TogoStanza::Stanza
       Tilt.new(path).render(context)
     end
 
-    def help
-      path = File.join(root, 'help.md')
-
-      TogoStanza::Markdown.render(File.read(path))
-    end
-
     def metadata
       path = File.join(root, 'metadata.json')
 

data/lib/togostanza/version.rb

@@ -1,3 +1,3 @@
 module TogoStanza
-  VERSION = '1.3.2'
+  VERSION = '1.3.3'
 end

data/lib/togostanza.rb

@@ -4,7 +4,6 @@ require 'sprockets'
 module TogoStanza
   autoload :Application, 'togostanza/application'
   autoload :CLI,         'togostanza/cli'
-  autoload :Markdown,    'togostanza/markdown'
   autoload :Stanza,      'togostanza/stanza'
 
   class << self

data/spec/features/help_spec.rb

@@ -8,6 +8,6 @@ describe 'Help' do
 
   it 'should display BarStanza help' do
     visit '/bar/help'
-    page.should have_css('h1', text: 'Bar')
+    page.should have_text('Work in progress')
   end
 end

data/togostanza.gemspec

@@ -21,7 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'haml'
   spec.add_runtime_dependency 'hashie'
   spec.add_runtime_dependency 'parallel'
-  spec.add_runtime_dependency 'redcarpet'
   spec.add_runtime_dependency 'sinatra'
   spec.add_runtime_dependency 'sinatra-contrib'
   spec.add_runtime_dependency 'sparql-client'

data/views/help.haml

@@ -0,0 +1,35 @@
+- if stanza
+  %h1= stanza['stanza:label']
+  - if stanza['stanza:context'].present?
+    %span.badge= stanza['stanza:context']
+  - if stanza['stanza:type'].present?
+    %span.badge= stanza['stanza:type']
+  - if stanza['stanza:display'].present?
+    %span.badge= stanza['stanza:display']
+  - if stanza['stanza:license'].present?
+    %span.badge= stanza['stanza:license']
+  %p= stanza['stanza:definition']
+  %h2 Parameters:
+  %p (* = required)
+  %table.table
+    %tbody
+      %tr
+        %th Name
+        %th Description
+      - stanza['stanza:parameter'].each do |stanza_params|
+        %tr
+          %td
+            - if stanza_params["stanza:required"]
+              %span *
+            = stanza_params["stanza:key"]
+          %td
+            #{stanza_params["stanza:description"]} (e.g., #{stanza_params["stanza:example"]})
+
+  %h2 Sample:
+  %pre
+    %code= stanza['stanza:usage']
+  %p
+    The above <code>#{'<div>'}</code> will automatically embed the following Stanza in your HTML page.
+  != stanza['stanza:usage']
+- else
+  Work in progress .

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: togostanza
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Keita Urashima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: redcarpet
-  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: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -279,12 +265,10 @@ files:
 - lib/togostanza.rb
 - lib/togostanza/application.rb
 - lib/togostanza/cli.rb
-- lib/togostanza/markdown.rb
 - lib/togostanza/stanza.rb
 - lib/togostanza/stanza/base.rb
 - lib/togostanza/stanza/expression_map.rb
 - lib/togostanza/stanza/grouping.rb
-- lib/togostanza/stanza/markdown.rb
 - lib/togostanza/stanza/querying.rb
 - lib/togostanza/version.rb
 - spec/dummy/app.rb
@@ -314,12 +298,12 @@ files:
 - templates/provider/gitignore.erb
 - templates/stanza/Gemfile.erb
 - templates/stanza/gemspec.erb
-- templates/stanza/help.md.erb
 - templates/stanza/lib.rb.erb
 - templates/stanza/metadata.json.erb
 - templates/stanza/stanza.rb.erb
 - templates/stanza/template.hbs.erb
 - togostanza.gemspec
+- views/help.haml
 - views/index.haml
 - views/layout.haml
 homepage: ''

data/lib/togostanza/markdown.rb

@@ -1,39 +0,0 @@
-require 'redcarpet'
-
-module TogoStanza
-  module Markdown
-    class << self
-      def render(source)
-        INSTANCE.render(source)
-      end
-    end
-
-    class Renderer < Redcarpet::Render::HTML
-      def table(header, body)
-        <<-HTML.strip_heredoc
-          <table class="table">
-            #{header}
-            #{body}
-          </table>
-        HTML
-      end
-    end
-
-    RENDERER = Renderer.new(
-      hard_wrap:       true,
-      safe_links_only: true,
-      with_toc_data:   true
-    )
-
-    INSTANCE = Redcarpet::Markdown.new(RENDERER,
-      autolink:            true,
-      fenced_code_blocks:  true,
-      lax_spacing:         true,
-      no_intra_emphasis:   true,
-      space_after_headers: true,
-      strikethrough:       true,
-      superscript:         false,
-      tables:              true
-    )
-  end
-end

data/lib/togostanza/stanza/markdown.rb

@@ -1,37 +0,0 @@
-module TogoStanza::Stanza
-  module Markdown
-    class << self
-      def render(source)
-        INSTANCE.render(source)
-      end
-    end
-
-    class Renderer < Redcarpet::Render::HTML
-      def table(header, body)
-        <<-HTML.strip_heredoc
-          <table class="table">
-            #{header}
-            #{body}
-          </table>
-        HTML
-      end
-    end
-
-    RENDERER = Renderer.new(
-      hard_wrap:       true,
-      safe_links_only: true,
-      with_toc_data:   true
-    )
-
-    INSTANCE = Redcarpet::Markdown.new(RENDERER,
-      autolink:            true,
-      fenced_code_blocks:  true,
-      lax_spacing:         true,
-      no_intra_emphasis:   true,
-      space_after_headers: true,
-      strikethrough:       true,
-      superscript:         false,
-      tables:              true
-    )
-  end
-end

data/templates/stanza/help.md.erb

@@ -1,22 +0,0 @@
-<%= title %>
-<%= '=' * title.size %>
-
-TODO: Write a stanza description
-
-## Parameters:
-
-(* = required)
-
-| Name             | Description                         |
-|------------------|-------------------------------------|
-| *data-stanza-foo | TODO: Write a parameter description |
-
-## Sample:
-
-```html
-<div data-stanza="<stanza url>"></div>
-```
-
-The above `<div>` will automatically embed the following Stanza in your HTML page.
-
-<div data-stanza="/stanza/<%= stanza_id %>"></div>