togostanza 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feff200c04b172dbf93674165cef73d4e2432717
-  data.tar.gz: 6dcbe4dac0882915a682b26ca69b597285b0dc30
+  metadata.gz: de2bb4688cc93399337e9abecabae51456ab1403
+  data.tar.gz: 55a3943993b9773f9e06cd5f46728fa951cfeb6a
 SHA512:
-  metadata.gz: 2cea6cdb5e858b346db2d7ea8761c09539ee78abae30618da7f664812f46465c45d2a1d12e66eb19d9be6d5af2f30d8e72ea4c19ae67e6d5729cff2741f2606b
-  data.tar.gz: 9185b04d45877f93179462ed5bf3865d5d75d30ffb0d1773fb4f5696461246046ac9ed42c6ad158cfa4173d1b6cc002a7ec972aab4633b5a535e9022285fbe0e
+  metadata.gz: 2cb8e3171ae7b79e7418fe627a522058579dc70c403df1e1ff765cf02b083b6407cdd5cdbea8dc8b13870f9e03f5ff362018c630a801c6228f91d179150b26a1
+  data.tar.gz: 5f310e6972a9fee2ec33ba2466a1655602b651e9d780565afa33f800b4eff2b4223db6f326bf8b172af1e0265dea327d652e36bdc0883d3c19e9216670e15df2

data/lib/togostanza/application.rb

@@ -25,6 +25,17 @@ module TogoStanza
       haml :index
     end
 
+    get '/metadata.json' do
+      metadata = {
+        "@context" => {
+          stanza: "http://togostanza.org/resource/stanza#"
+        },
+        "stanza:stanzas" => Stanza.all.map {|stanza| stanza.new.metadata }.compact
+      }
+
+      json metadata
+    end
+
     get '/:id.json' do |id|
       json Stanza.find(id).new(params).context
     end
@@ -60,5 +71,11 @@ module TogoStanza
         json enabled: false, count: 0, urls: []
       end
     end
+
+    get '/:id/metadata.json' do |id|
+      @stanza = Stanza.find(id).new
+
+      json @stanza.metadata
+    end
   end
 end

data/lib/togostanza/cli.rb

@@ -41,12 +41,13 @@ module TogoStanza
       end
 
       def create_files
-        template 'Gemfile.erb',      "#{file_name}/Gemfile"
-        template 'gemspec.erb',      "#{file_name}/#{file_name}.gemspec"
-        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 'Gemfile.erb',       "#{file_name}/Gemfile"
+        template 'gemspec.erb',       "#{file_name}/#{file_name}.gemspec"
+        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"
       end

data/lib/togostanza/stanza/base.rb

@@ -221,5 +221,15 @@ module TogoStanza::Stanza
 
       TogoStanza::Markdown.render(File.read(path))
     end
+
+    def metadata
+      path = File.join(root, 'metadata.json')
+
+      if File.exist?(path)
+        JSON.load(open(path))
+      else
+        nil
+      end
+    end
   end
 end

data/lib/togostanza/version.rb

@@ -1,3 +1,3 @@
 module TogoStanza
-  VERSION = '1.2.2'
+  VERSION = '1.3.0'
 end

data/spec/dummy/foo_stanza/metadata.json

@@ -0,0 +1,24 @@
+{
+  "@id": "http://togogenome.org/stanza/foo",
+  "stanza:label": "Foo Stanza",
+  "stanza:definition": "This is Foo Stanza.",
+  "stanza:parameter": [
+    { "stanza:key": "name",
+      "stanza:example": "alice",
+      "stanza:description": "Name",
+      "stanza:required": true
+    }
+  ],
+  "stanza:usage": "<div data-stanza=\"http://togogenome.org/stanza/foo\" data-stanza-name=\"alice\"></div>",
+  "stanza:type": "Stanza",
+  "stanza:context": "Gene",
+  "stanza:display": "Table",
+  "stanza:provider": "DBCLS",
+  "stanza:license": "CC-BY",
+  "stanza:author": "author name",
+  "stanza:address": "name@example.org",
+  "stanza:contributor": [ "Taro Stanza", "Hanako Stanza" ],
+  "stanza:version": "1",
+  "stanza:created": "2015-02-27",
+  "stanza:updated": "2015-02-27"
+}

data/spec/features/metadata_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe 'Metadata' do
+  describe '/metadata.json' do
+    before do
+      # 実行順により base_spec で作られた Classオブジェクトが返って来て意図通りのテストにならないため
+      allow(TogoStanza::Stanza).to receive(:all).and_return([BarStanza, FooStanza])
+
+      visit '/metadata.json'
+    end
+
+    it 'should return metadata as JSON' do
+      json = JSON.parse(page.body)
+
+      json["stanza:stanzas"].class.should eq(Array)
+      json["stanza:stanzas"].first.should include('stanza:label' => 'Foo Stanza')
+    end
+  end
+
+  describe '/:id/metadata.json' do
+    before do
+      visit '/foo/metadata.json'
+    end
+
+    it 'should return metadata as JSON' do
+      json = JSON.parse(page.body)
+
+      json.should include('stanza:label' => 'Foo Stanza')
+    end
+  end
+end

data/templates/stanza/metadata.json.erb

@@ -0,0 +1,20 @@
+{
+  "@context": {
+    "stanza": "http://togostanza.org/resource/stanza#"
+  },
+  "@id": "http://togogenome.org/stanza/<%= stanza_id %>",
+  "stanza:label": "",
+  "stanza:definition": "",
+  "stanza:parameters": [
+  ],
+  "stanza:usage": "<div data-stanza=\"http://togogenome.org/stanza/<%= stanza_id %>\"></div>",
+  "stanza:type": "stanza:Stanza",
+  "stanza:context": "",
+  "stanza:display": "",
+  "stanza:provider": "provider of this stanza",
+  "stanza:license": "",
+  "stanza:author": "author name",
+  "stanza:address": "name@example.org",
+  "stanza:created": "<%= Date.today %>",
+  "stanza:updated": "<%= Date.today %>"
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: togostanza
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Keita Urashima
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -297,11 +297,13 @@ files:
 - spec/dummy/config.ru
 - spec/dummy/foo_stanza/help.md
 - spec/dummy/foo_stanza/lib/foo_stanza.rb
+- spec/dummy/foo_stanza/metadata.json
 - spec/dummy/foo_stanza/stanza.rb
 - spec/dummy/foo_stanza/template.hbs
 - spec/features/api_spec.rb
 - spec/features/help_spec.rb
 - spec/features/listing_spec.rb
+- spec/features/metadata_spec.rb
 - spec/features/rendering_spec.rb
 - spec/features/resource_spec.rb
 - spec/lib/togostanza/stanza/base_spec.rb
@@ -316,6 +318,7 @@ files:
 - 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
@@ -354,11 +357,13 @@ test_files:
 - spec/dummy/config.ru
 - spec/dummy/foo_stanza/help.md
 - spec/dummy/foo_stanza/lib/foo_stanza.rb
+- spec/dummy/foo_stanza/metadata.json
 - spec/dummy/foo_stanza/stanza.rb
 - spec/dummy/foo_stanza/template.hbs
 - spec/features/api_spec.rb
 - spec/features/help_spec.rb
 - spec/features/listing_spec.rb
+- spec/features/metadata_spec.rb
 - spec/features/rendering_spec.rb
 - spec/features/resource_spec.rb
 - spec/lib/togostanza/stanza/base_spec.rb