hypermicrodata 0.1.0

data/lib/hypermicrodata/itemprop_parser.rb

@@ -0,0 +1,114 @@
+module Hypermicrodata
+# Class that parses itemprop elements
+  class ItempropParser
+
+    NON_TEXTCONTENT_ELEMENTS = {
+      'a' => 'href',        'area' => 'href',
+      'audio' => 'src',     'embed' => 'src',
+      'iframe' => 'src',    'img' => 'src',
+      'link' => 'href',     'meta' => 'content',
+      'object' => 'data',   'source' => 'src',
+      'time' => 'datetime', 'track' => 'src',
+      'video' => 'src'
+    }
+
+    LINK_ELEMENTS = ['a', 'area', 'audio', 'embed', 'iframe',
+                     'img', 'link', 'source', 'track', 'video']
+
+    URL_ATTRIBUTES = ['data', 'href', 'src']
+
+    # A Hash representing the properties.
+    # Hash is of the form {'property name' => 'value'}
+    attr_reader :property
+
+    # Create a new Itemprop object
+    # [element]  The itemprop element to be parsed
+    # [page_url] The url of the page, including filename, used to form
+    #            absolute urls
+    def initialize(element, page_url=nil)
+      @element, @page_url = element, page_url
+      if link?
+        @property = Link.new(extract_property, extract_property_names, extract_rel_names)
+      else
+        @property = Property.new(extract_property, extract_property_names, extract_rel_names)
+      end
+    end
+
+    # Parse the element and return a hash representing the properties.
+    # Hash is of the form {'property name' => 'value'}
+    # [element]  The itemprop element to be parsed
+    # [page_url] The url of the page, including filename, used to form
+    #            absolute urls
+    def self.parse(element, page_url=nil)
+      self.new(element, page_url).property
+    end
+
+    def link?
+      LINK_ELEMENTS.include?(@element.name)
+    end
+
+  private
+    def extract_properties
+      prop_names = extract_property_names
+      prop_names.each_with_object({}) do |name, memo|
+        memo[name] = extract_property
+      end
+    end
+
+    def extract_links
+      rel_names = extract_rel_names
+      rel_names.each_with_object({}) do |name, memo|
+        memo[name] = extract_property_value
+      end
+    end
+
+    # This returns an empty string if can't form a valid
+    # absolute url as per the Microdata spec.
+    def make_absolute_url(url)
+      return url unless URI.parse(url).relative?
+      begin
+        URI.parse(@page_url).merge(url).to_s
+      rescue URI::Error
+        url
+      end
+    end
+
+    def non_textcontent_element?(element)
+      NON_TEXTCONTENT_ELEMENTS.has_key?(element)
+    end
+
+    def url_attribute?(attribute)
+      URL_ATTRIBUTES.include?(attribute)
+    end
+
+    def extract_property_names
+      itemprop_attr = @element.attribute('itemprop')
+      itemprop_attr ? itemprop_attr.value.split : []
+    end
+
+    def extract_rel_names
+      link_rel = @element.attribute('rel')
+      link? && link_rel ? link_rel.value.split : []
+    end
+
+    def extract_property_value
+      element = @element.name
+      if non_textcontent_element?(element)
+        attribute = NON_TEXTCONTENT_ELEMENTS[element]
+        value = @element.attribute(attribute).value
+        url_attribute?(attribute) ? make_absolute_url(value) : value
+      else
+        @element.inner_text.strip
+      end
+    end
+
+    def extract_property
+      if @element.attribute('itemscope')
+        Item.new(@element, @page_url)
+      else
+        extract_property_value
+      end
+    end
+
+  end
+end

data/lib/hypermicrodata/link.rb

@@ -0,0 +1,7 @@
+module Hypermicrodata
+  class Link < Property
+    def link?
+      true
+    end
+  end
+end

data/lib/hypermicrodata/property.rb

@@ -0,0 +1,27 @@
+module Hypermicrodata
+  class Property
+    attr_reader :value, :names, :rels
+
+    def initialize(value, names, rels = [])
+      @value = value
+      @names = names
+      @rels = rels
+    end
+
+    def item
+      @value if @value.is_a?(Item)
+    end
+
+    def item?
+      !!item
+    end
+
+    def link?
+      false
+    end
+
+    def submit_button?
+      false
+    end
+  end
+end

data/lib/hypermicrodata/rails/html_based_json_renderer.rb

@@ -0,0 +1,35 @@
+module Hypermicrodata
+  module Rails
+    module HtmlBasedJsonRenderer
+      def initialize
+        super
+        @_render_based_html_options = {}
+      end
+
+      def set_location(location)
+        location_url = url_for(location)
+        @_render_based_html_options[:location] = location_url
+        response.headers['Content-Location'] = location_url
+      end
+
+      def set_profile_path(path)
+        @_render_based_html_options[:profile_path] = view_context.path_to_asset(path)
+      end
+
+      def render_based_html(*args)
+         lookup_context.formats.first
+        if m = lookup_context.formats.first.to_s.match(/json$/)
+          json_format = m.pre_match.to_sym
+          json = Hypermicrodata::Extract.new(render_to_string(formats: :html), @_render_based_html_options).to_json(json_format)
+          render(json: json)
+        else
+          render(*args)
+        end
+      end
+
+      def default_render(*args)
+        render_based_html(*args)
+      end
+    end
+  end
+end

data/lib/hypermicrodata/serializer/base.rb

@@ -0,0 +1,24 @@
+module Hypermicrodata
+  module Serializer
+    class Base
+      def initialize(document, location = nil, profile_path = nil)
+        @document = document
+        @location = location
+        @profile_path = profile_path
+      end
+
+      def to_json(options = {})
+        MultiJson.dump(serialize, options)
+      end
+
+      def serialize
+        # return hash or array suitable for application/json
+        if @document.items
+          @document.items.map(&:to_hash)
+        else
+          []
+        end
+      end
+    end
+  end
+end

data/lib/hypermicrodata/serializer/hal.rb

@@ -0,0 +1,47 @@
+module Hypermicrodata
+  module Serializer
+    class Hal < Base
+      def serialize
+        items = @document.items
+        if items.length == 1
+          hal_resource = item_to_resource(items.first, @location)
+        else
+          hal_resource = Halibut::Core::Resource.new(@location)
+          items.each do |item|
+            embedded_resource = item_to_resource(item)
+            item.type.each do |type|
+              hal_resource.add_embedded_resource(type, embedded_resource)
+            end
+          end
+        end
+        hal_resource.add_link('profile', @profile_path) if @profile_path
+        hal_resource.to_hash
+      end
+
+      private
+      def item_to_resource(item, self_url = nil)
+        resource = Halibut::Core::Resource.new(self_url)
+        item.properties.each do |name, same_name_properties|
+          same_name_properties.each do |property|
+            if property.item
+              subresource = item_to_resource(property.item)
+              resource.add_embedded_resource(name, subresource)
+            else
+              resource.set_property(name, property.value)
+            end
+          end
+        end
+        resource.add_link('self', item.id) if item.id
+        Array(item.type).each do |type|
+          resource.add_link('type', type)
+        end
+        item.links.each do |rel, same_rel_links|
+          same_rel_links.each do |link|
+            resource.add_link(rel, link.value)
+          end
+        end
+        resource
+      end
+    end
+  end
+end

data/lib/hypermicrodata/serializer/jsonld.rb

@@ -0,0 +1,44 @@
+module Hypermicrodata
+  module Serializer
+    class Jsonld < Base
+
+    end
+
+    # json-ld patch
+    # HTMLのリンクセマンティクスを保存できてないなぁ
+    # JSON-LDにするのやめるべきかも。いろいろめんどくさい。
+    module JsonldSerializer
+      def to_hash
+        hash = {}
+        hash[:id] = unwrap(id) if id
+        re_schema_org = %r|^http://schema\.org/|i
+        if type.all?{|t| t.match(re_schema_org) }
+          hash['@context'] = 'http://schema.org'
+          hash['@type'] = unwrap(type.map{|t| t.sub(re_schema_org, '') })
+        else
+          hash['@type'] = unwrap(type)
+        end
+        properties.each do |name, values|
+          final_values = values.map do |value|
+            if value.is_a?(Hypermicrodata::Item)
+              value.to_hash
+            else
+              value
+            end
+          end
+          hash[name] = unwrap(final_values)
+        end
+        hash
+      end
+
+      def unwrap(values)
+        if values.is_a?(Array) && values.length == 1
+          values.first
+        else
+          values
+        end
+      end
+    end
+    # Hypermicrodata::Item.send :prepend, JsonldSerializer
+  end
+end

data/lib/hypermicrodata/serializer/uber.rb

@@ -0,0 +1,100 @@
+module Hypermicrodata
+  module Serializer
+    class Uber < Base
+      ACTION_MAPPINGS = {
+        'GET'    => 'read',
+        'POST'   => 'append',
+        'PUT'    => 'replace',
+        'DELETE' => 'remove',
+        'PATCH'  => 'partial'
+      }.freeze
+
+      def serialize
+        items = @document.items
+        if items.length == 1
+          root_data = item_to_nested_data(items.first)
+          if @location
+            root_data.rel = 'self'
+            root_data.url = @location
+          end
+          root_data.add_link('profile', @profile_path) if @profile_path
+          uber = Uberous::Uber.new([root_data])
+        else
+          data_collection = @document.items.map do |item|
+            item_to_nested_data(item).tap do |data|
+              data.name = generate_short_name(item.type) if item.type
+            end
+          end
+          uber = Uberous::Uber.new(data_collection)
+          uber.add_link('self', @location) if @location
+          uber.add_link('profile', @profile_path) if @profile_path
+        end
+        uber.to_hash
+      end
+
+      private
+      def item_to_nested_data(item, self_name = nil)
+        parent_data = Uberous::Data.new
+        if item.id
+          parent_data.url = item.id
+          parent_data.rel = self_name if self_name # consider a link relation
+          parent_data.name = generate_short_name(item.type) if item.type
+        else
+          parent_data.name = self_name if self_name # consider a semantic descriptor
+        end
+        item.all_properties_and_links.each do |property|
+          rel = property.rels.join(' ') unless property.rels.empty?
+          if property.item?
+            # TODO: name複数の場合のduplicateをなくす
+            property.names.each do |name|
+              child_data = item_to_nested_data(property.item, name)
+              parent_data.add_data(child_data)
+            end
+            # itemかつlinkというのはたぶんない
+          elsif property.submit_button?
+            attrs = { rel: rel, url: property.action_url, model: property.query_string, action: action_name(property.method) }
+            attrs[:model] = "?#{attrs[:model]}" if %w(read remove).include?(attrs[:action])
+            attrs.reject! { |_, value| value.nil? }
+            if property.names.empty?
+              child_data = Uberous::Data.new(attrs)
+              parent_data.add_data(child_data)
+            else
+              property.names.each do |name|
+                child_data = Uberous::Data.new(attrs.merge(name: name))
+                parent_data.add_data(child_data)
+              end
+            end
+          elsif property.link?
+            attrs = { rel: rel, url: property.value }
+            attrs.reject! { |_, value| value.nil? }
+            if property.names.empty?
+              child_data = Uberous::Data.new(attrs)
+              parent_data.add_data(child_data)
+            else
+              property.names.each do |name|
+                child_data = Uberous::Data.new(attrs.merge(name: name))
+                parent_data.add_data(child_data)
+              end
+            end
+          else # only value
+            property.names.each do |name|
+              child_data = Uberous::Data.new(name: name, value: property.value)
+              parent_data.add_data(child_data)
+            end
+          end
+        end
+
+        parent_data
+      end
+
+      def generate_short_name(item_types)
+        # TODO: これでいいのか？
+        Array(item_types).first.sub(%r|^http://schema\.org/|, '') if item_types
+      end
+
+      def action_name(method_name)
+        ACTION_MAPPINGS[method_name.to_s.upcase] || method_name.to_s.downcase
+      end
+    end
+  end
+end

data/lib/hypermicrodata/submit_button.rb

@@ -0,0 +1,105 @@
+module Hypermicrodata
+  class SubmitButton < Property
+    attr_reader :form, :method
+
+    def initialize(button, form)
+      @button = button
+      @form = form.dup
+      @excluded_fields = {}
+      setup!
+    end
+
+    def value
+      "#{action_url}?#{query_string}"
+    end
+
+    def action_url
+      @form.action
+    end
+
+    def params
+      @form.build_query
+    end
+
+    def query_string
+      build_query_string(params)
+    end
+
+    def names
+      (@button.node['itemprop'] || '').split(' ')
+    end
+
+    def rels
+      rel = (@button.node['rel'] || @button.node['data-rel'] || @button.dom_class || '')
+      rel.split(' ')
+    end
+
+    def item
+      nil
+    end
+
+    def link?
+      true
+    end
+
+    def submit_button?
+      true
+    end
+
+    private
+    def setup!
+      if method_field = @form.fields.find { |f| f.name == '_method' }
+        # overload POST
+        @method = method_field.value.upcase
+        @excluded_fields['_method'] = method_field
+      else
+        @method = @form.method
+      end
+      @form.add_button_to_query(@button) # formをdupしているのでOK
+    end
+
+    def template_fields
+      @template_fields ||= begin
+        fields = @form.fields.reject {|field| field.is_a?(Mechanize::Form::Hidden) }
+        Hash[fields.map {|field| [field.name, field] }]
+      end
+    end
+
+    def build_query_string(parameters)
+      parameters.map do |name, value|
+        if field = template_fields[name]
+          [CGI.escape(name.to_s), "{#{field.type}}"].join("=")
+        elsif !@excluded_fields[name]
+          # WEBrick::HTTP.escape* has some problems about m17n on ruby-1.9.*.
+          [CGI.escape(name.to_s), CGI.escape(value.to_s)].join("=")
+        end
+      end.compact.join('&')
+    end
+  end
+
+  class FormParser
+    attr_reader :submit_buttons
+
+    def initialize(element, page_url = nil)
+      @element, @page_url = element, page_url
+      form = Mechanize::Form.new(element)
+      @submit_buttons = form.submits.map do |button|
+        SubmitButton.new(button, form)
+      end
+    end
+
+    def self.parse(element, page_url = nil)
+      self.new(element, page_url).submit_buttons
+    end
+  end
+end
+
+# Patch for bug
+Mechanize::Form.class_eval do
+  # Returns all buttons of type Submit
+  def submits
+    @submits ||= buttons.select {|f|
+      f.class == Mechanize::Form::Submit || (f.class == Mechanize::Form::Button && (f.type.nil? || f.type == 'submit'))
+    }
+  end
+end