alpinist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3dc5a49e339407762a5f9eb5ca0d650512114eb
+  data.tar.gz: d99948b25f222c03b43508ffc9740390210eb8a3
+SHA512:
+  metadata.gz: 015740d84d3b30f7b5a88087e0c409d5ab87ccb1ca1f882fffdf69d04b695c2bdadc6fbc57bbb2b27d842fb20667cecc817a6dc243ef576e74dc2b66e3603c40
+  data.tar.gz: c5da1c544c7ea63433d143385c4d398cf4462e7fe3e7c75cb60e5fe9450e1ed6e10eddd1d083441403169855072d7b7239aca7b1dcfb1cc6bf269becae8aac76

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alpinist.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Toru KAWAMURA
+
+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,152 @@
+# Alpinist
+
+ALPS (Application-Level Profile Semantics) processor
+
+This is currently a work in progress.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alpinist'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install alpinist
+
+## Usage
+
+See the example below.
+
+## Example
+
+Suppose this ALPS profile were on http://example.com/Rubygem
+
+```json
+{
+  "alps": {
+    "version": "1.0",
+    "doc": {
+      "format": "text",
+      "value": "RubyGem info"
+    },
+    "descriptor": [
+      {
+        "id": "RubyGem",
+        "type": "semantic",
+        "href": "http://alps.io/schema.org/SoftwareApplication#SoftwareApplication",
+        "descriptor": [
+          {
+            "id": "name",
+            "type": "semantic",
+            "href": "http://alps.io/schema.org/SoftwareApplication#name"
+          },
+          {
+            "id": "version",
+            "type": "semantic",
+            "href": "http://alps.io/schema.org/SoftwareApplication#version"
+          },
+          {
+            "id": "authors",
+            "type": "semantic",
+            "href": "http://alps.io/schema.org/SoftwareApplication#author"
+          },
+          {
+            "id": "info",
+            "type": "semantic",
+            "href": "http://alps.io/schema.org/SoftwareApplication#description"
+          },
+          {
+            "id": "licenses",
+            "type": "semantic",
+            "href": "http://alps.io/schema.org/SoftwareApplication#license"
+          },
+          {
+            "id": "project_uri",
+            "type": "safe",
+            "href": "http://alps.io/schema.org/SoftwareApplication#url"
+          },
+          {
+            "id": "gem_uri",
+            "type": "safe",
+            "href": "http://alps.io/schema.org/SoftwareApplication#downloadUrl"
+          },
+          {
+            "id": "homepage_uri",
+            "type": "safe",
+            "href": "http://alps.io/iana/relations#related"
+          },
+          {
+            "id": "source_code_uri",
+            "type": "safe"
+          },
+          {
+            "id": "dependencies",
+            "type": "semantic",
+            "href": "http://alps.io/schema.org/SoftwareApplication#requirements"
+          }
+        ]
+      }
+    ]
+  }
+}
+```
+
+```ruby
+fetcher = Alpinist::ProfileFetcher.new
+profile_url = 'http://example.com/Rubygem'
+doc = fetcher.fetch(profile_url)
+profile = Alpinist::Profile.new(doc, profile_url)
+semantics = Alpinist::Semantics.new(profile, fetcher)
+semantics.build!
+semantics.print_tree # for debug
+```
+```
+* http://alps.io/schema.org/Thing
++---+ http://alps.io/schema.org/CreativeWork
+    +---+ http://alps.io/schema.org/SoftwareApplication#SoftwareApplication
+        +---> http://example.com/RubyGem#RubyGem
+* http://alps.io/schema.org/Thing#name
++---+ http://alps.io/schema.org/SoftwareApplication#name
+    +---> http://example.com/RubyGem#name
+* http://alps.io/schema.org/CreativeWork#version
++---+ http://alps.io/schema.org/SoftwareApplication#version
+    +---> http://example.com/RubyGem#version
+* http://alps.io/schema.org/CreativeWork#author
++---+ http://alps.io/schema.org/SoftwareApplication#author
+    +---> http://example.com/RubyGem#authors
+* http://alps.io/schema.org/Thing#description
++---+ http://alps.io/schema.org/SoftwareApplication#description
+    +---> http://example.com/RubyGem#info
+* http://example.com/RubyGem#licenses
+* http://alps.io/schema.org/Thing#url
++---+ http://alps.io/schema.org/SoftwareApplication#url
+    +---> http://example.com/RubyGem#project_uri
+* http://alps.io/schema.org/SoftwareApplication#downloadUrl
++---> http://example.com/RubyGem#gem_uri
+* http://alps.io/iana/relations#related
++---> http://example.com/RubyGem#homepage_uri
+* http://example.com/RubyGem#source_code_uri
+* http://alps.io/schema.org/SoftwareApplication#requirements
++---> http://example.com/RubyGem#dependencies
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/alpinist/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

data/Rakefile

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

data/alpinist.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alpinist/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alpinist"
+  spec.version       = Alpinist::VERSION
+  spec.authors       = ["Toru KAWAMURA"]
+  spec.email         = ["tkawa@4bit.net"]
+
+  spec.summary       = %q{ALPS (Application-Level Profile Semantics) processor}
+  spec.description   = %q{ALPS (Application-Level Profile Semantics) processor}
+  spec.homepage      = "https://github.com/tkawa/alpinist-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "multi_xml"
+  spec.add_dependency "rubytree"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "alpinist"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/alpinist.rb

@@ -0,0 +1,10 @@
+require 'tree'
+require 'alpinist/descriptor'
+require 'alpinist/profile'
+require 'alpinist/profile_fetcher'
+require 'alpinist/semantics'
+require 'alpinist/version'
+
+module Alpinist
+  # Your code goes here...
+end

data/lib/alpinist/descriptor.rb

@@ -0,0 +1,23 @@
+module Alpinist
+  class Descriptor
+    attr_reader :id, :name, :type, :rt, :href, :doc, :ext
+    attr_accessor :reference
+
+    def initialize(id: nil, name: nil, type: nil, rt: nil, href: nil, doc: nil, ext: nil, reference: nil)
+      @id = id
+      @name = name
+      @type = type
+      @rt = rt
+      @href = href
+      @doc = doc
+      @ext = ext
+      @reference = reference
+    end
+
+    def inspect
+      display_variable_name = %w(@id @name @type @rt @href @doc @ext)
+      variables_inspect = display_variable_name.map{ |n| "#{n}=#{instance_variable_get(n).inspect}" }.join(' ')
+      "#<#{self.class}:#{__id__} #{variables_inspect}>"
+    end
+  end
+end

data/lib/alpinist/profile.rb

@@ -0,0 +1,82 @@
+require 'json'
+require 'multi_xml'
+
+module Alpinist
+  class Profile
+    attr_reader :root_nodes, :url
+
+    def initialize(document, url)
+      @document = document
+      @url = url
+      @root_nodes = []
+      @descriptors = {}
+      @insubstantial_descriptors = []
+      parse!
+    end
+
+    def find_node(id)
+      @root_nodes.inject(nil) do |result, root_node|
+        result || root_node.find { |node| node.name == id && node.content.reference.nil? }
+      end
+    end
+
+    def find_descriptor(id)
+      id = id.sub(/^#/, '')
+      @descriptors[id] || @insubstantial_descriptors.find { |descriptor| descriptor.id == id }
+    end
+
+    def root_descriptors
+      @root_nodes.map(&:content)
+    end
+
+    def all_descriptors
+      @descriptors.values
+    end
+
+    private
+
+    def parse!
+      doc =
+        begin
+          JSON.parse(@document)
+        rescue JSON::ParserError # TODO: improve
+          MultiXml.parse(@document)
+        end
+      alps = doc['alps']
+      raise unless alps
+
+      @root_nodes = Array.wrap(alps['descriptor']).map do |data|
+        define_descriptor(data)
+      end
+    end
+
+    def define_descriptor(data)
+      if data['id'] # substantial
+        id = data['id']
+        descriptor = Descriptor.new(id: id, name: data['name'], type: data['type'], rt: data['rt'], href: data['href'], doc: data['doc'], ext: data['ext'])
+        @descriptors[id] = descriptor
+        set_reference(id, descriptor)
+      else # insubstantial
+        url, id = data['href'].split('#')
+        reference = @descriptors[id] if url.empty?
+        descriptor = Descriptor.new(id: id, name: data['name'], type: data['type'], rt: data['rt'], href: data['href'], doc: data['doc'], ext: data['ext'], reference: reference)
+        @insubstantial_descriptors << descriptor
+      end
+      node = Tree::TreeNode.new(id, descriptor) # 適切なTreeに取替可能
+      if data['descriptor']
+        Array.wrap(data['descriptor']).each do |data_child|
+          node << define_descriptor(data_child) # FIXME: idの重複
+        end
+      end
+      node
+    end
+
+    def set_reference(id, descriptor) # 必要？
+      @insubstantial_descriptors.each do |insubstantial_descriptor|
+        if insubstantial_descriptor.reference.nil? && insubstantial_descriptor.id == id
+          insubstantial_descriptor.reference = descriptor
+        end
+      end
+    end
+  end
+end

data/lib/alpinist/profile_fetcher.rb

@@ -0,0 +1,18 @@
+require 'open-uri'
+module Alpinist
+  class ProfileFetcher
+    def fetch(url, as: nil, &block)
+      if url.match(%r|http://alps\.io/|)
+        as ||= url
+        url = "#{url}.xml"
+      end
+      if as
+        puts "Fetch: #{url} as #{as}"
+      else
+        puts "Fetch: #{url}"
+      end
+      block ||= ->(sio) { sio.read }
+      open(url, &block)
+    end
+  end
+end

data/lib/alpinist/semantics.rb

@@ -0,0 +1,56 @@
+module Alpinist
+  class Semantics
+    def initialize(initial_profile, fetcher = ProfileFetcher.new)
+      @initial_profile = initial_profile
+      @fetcher = fetcher
+      @profiles = {}
+      @profiles[initial_profile.url] = initial_profile
+      @nodes = {}
+    end
+
+    def build!
+      @initial_profile.all_descriptors.each do |descriptor|
+        descriptor_url = "#{@initial_profile.url}##{descriptor.id}"
+        connect_to_parent(descriptor_url, descriptor)
+      end
+    end
+
+    def find_node(descriptor_url)
+      @nodes[descriptor_url]
+    end
+
+    def print_tree
+      root_nodes = @nodes.values.select { |node| node.is_root? }
+      root_nodes.each(&:print_tree)
+    end
+
+    private
+
+    def connect_to_parent(descriptor_url, descriptor)
+      node = (@nodes[descriptor_url] ||= Tree::TreeNode.new(descriptor_url, descriptor)) # 適切なTreeに取替可能
+      if parent_descriptor_url = descriptor.href
+        parent_descriptor = find_descriptor(parent_descriptor_url)
+        if parent_descriptor
+          parent_node = connect_to_parent(parent_descriptor_url, parent_descriptor)
+          parent_node << node
+        else
+          puts "Descriptor #{parent_descriptor_url} not found."
+        end
+      end
+      node
+    end
+
+    def find_descriptor(descriptor_url)
+      profile_url, descriptor_id = descriptor_url.split('#')
+      profile = (@profiles[profile_url] ||= begin
+        document = @fetcher.fetch(profile_url)
+        Profile.new(document, profile_url)
+      end)
+      if descriptor_id
+        profile.find_descriptor(descriptor_id)
+      else
+        profile.root_descriptors.first # idなしの参照は先頭のdescriptorを指すことにする
+      end
+    end
+  end
+end

data/lib/alpinist/version.rb

@@ -0,0 +1,3 @@
+module Alpinist
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: alpinist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Toru KAWAMURA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  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: rubytree
+  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.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: ALPS (Application-Level Profile Semantics) processor
+email:
+- tkawa@4bit.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alpinist.gemspec
+- bin/console
+- bin/setup
+- lib/alpinist.rb
+- lib/alpinist/descriptor.rb
+- lib/alpinist/profile.rb
+- lib/alpinist/profile_fetcher.rb
+- lib/alpinist/semantics.rb
+- lib/alpinist/version.rb
+homepage: https://github.com/tkawa/alpinist-ruby
+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.4.3
+signing_key: 
+specification_version: 4
+summary: ALPS (Application-Level Profile Semantics) processor
+test_files: []