Microdata

v0.2.4

Microdata v0.2.4 Microdata.Helpers View Source

Microdata.Helpers is a module for generic parsing helpers (ie those not coupled to the parsing mechanism).

For example, certain tags require their values to be absolute URLs.

Link to this section Summary

Functions

absolute_url?(url)

Helper function to determine if a passed URL is absolute. Returns true/false bools

parse_item_id(string)

Parse item id from a provided string

parse_item_types(string)

Parse item types from a space-separated string

parse_property_names(atom)

Parse property names from a provided string

parse_property_names(string, item)
validate_url(url)

Validates that URLs include scheme & host

Link to this section Functions

Link to this function absolute_url?(url) View Source 
absolute_url?(String.t()) :: boolean()

Helper function to determine if a passed URL is absolute. Returns true/false bools.

Examples 

iex> Microdata.Helpers.absolute_url?(nil)
false

iex> Microdata.Helpers.absolute_url?("path/to/page")
false

iex> Microdata.Helpers.absolute_url?("/path/to/page")
false

iex> Microdata.Helpers.absolute_url?("https://google.com")
true
Link to this function parse_item_id(string) View Source 
parse_item_id(String.t()) :: URI.t()

Parse item id from a provided string.

Examples 

iex> Microdata.Helpers.parse_item_id(nil)
nil

iex> Microdata.Helpers.parse_item_id("\r foo   \n")
URI.parse("foo")

iex> Microdata.Helpers.parse_item_id("https://google.com")
URI.parse("https://google.com")
Link to this function parse_item_types(string) View Source 
parse_item_types(String.t()) :: [String.t()]

Parse item types from a space-separated string.

Examples 

iex> Microdata.Helpers.parse_item_types(nil)
[]

iex> Microdata.Helpers.parse_item_types("foo")
["foo"]

iex> Microdata.Helpers.parse_item_types("foo bar")
["foo", "bar"]

iex> Microdata.Helpers.parse_item_types("\n\nfoo bar baz   \n ")
["foo", "bar", "baz"]
Link to this function parse_property_names(atom) View Source

Parse property names from a provided string.

Examples 

iex> Microdata.Helpers.parse_property_names(nil)
nil

iex> Microdata.Helpers.parse_property_names("bar", %Microdata.Item{types: MapSet.new(["foo"])})
["foo/bar"]

iex> Microdata.Helpers.parse_property_names("\rbar baz bar   \n", %Microdata.Item{types: MapSet.new(["foo"])})
["foo/bar", "foo/baz"]
Link to this function parse_property_names(string, item) View Source 
parse_property_names(String.t(), Microdata.Item.t()) :: [String.t()]
Link to this function validate_url(url) View Source 
validate_url(String.t()) :: {:error, String.t()} | {:ok, String.t()}

Validates that URLs include scheme & host

Examples 

iex> Microdata.Helpers.validate_url("foo")
{:error, "No scheme"}

iex> Microdata.Helpers.validate_url("http://")
{:error, "No host"}

iex> Microdata.Helpers.validate_url("http://foo.com")
{:ok, "http://foo.com"}