unitsml 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a08ed1b145023452764dc89296ba34e9ca5eb00cdbaa48cdd053bdc0ead1dbb9
+  data.tar.gz: a74caaa5c72e9752d97c4c7c753d82f2af0f7ede94463bbc51eb084f1f009275
+SHA512:
+  metadata.gz: 8f46a6311181f3cd1e199bfb1478ca7fe5a1aeebc51b6523add6af95dd17b3abfc0ed8aabe68e45d03ded5bcd6f28ce480155f7c6aa94ef7345819f25499b338
+  data.tar.gz: 790714452652b58d3e37056a6359193f42b7ff11d490cf6130005dd7059653eb90b61c54f39e712ea7cd92f52452b8c4485181adbb2bebd2e27c752e83ba46d3

data/.github/workflows/rake.yml

@@ -0,0 +1,11 @@
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main

data/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.UNITSML_CI_RUBYGEMS_API_KEY }}

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "unitsdb"]
+  path = unitsdb
+  url = git@github.com:unitsml/unitsdb.git
+[submodule "vendor/unitsdb"]
+  path = vendor/unitsdb
+  url = git@github.com:unitsml/unitsdb.git

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in unitsml.gemspec
+gemspec
+
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    unitsml (0.2.0)
+      htmlentities
+      parslet
+      plurimath
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    htmlentities (4.3.4)
+    method_source (0.9.2)
+    mini_portile2 (2.8.1)
+    nokogiri (1.14.0)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    ox (2.14.17)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    parslet (2.0.0)
+    plurimath (0.3.6)
+      ox
+      parslet
+    powerpack (0.1.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    racc (1.6.2)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (0.54.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  equivalent-xml
+  pry (~> 0.12.2)
+  rake
+  rspec (~> 3.6)
+  rubocop (= 0.54.0)
+  simplecov (~> 0.15)
+  unitsml!
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Тараскин Михаил
+
+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/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "unitsml"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+git submodule update --init --recursive
+# Do any other automated setup that you need to do here

data/docs/CODE_OF_CONDUCT.adoc

@@ -0,0 +1,72 @@
+= Contributor Covenant Code of Conduct
+
+== Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+== Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+== Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+== Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+== Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at MITaraskin@domclick.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+== Attribution
+
+This Code of Conduct is adapted
+from the https://contributor-covenant.org[Contributor Covenant’s homepage],
+https://contributor-covenant.org/version/1/4[version 1.4].

data/docs/README.adoc

@@ -0,0 +1,54 @@
+= unitsml-ruby
+
+Gem-wrapper for unitsdb
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'unitsml'
+----
+
+And then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source,sh]
+----
+$ gem install unitsml
+----
+
+== Usage
+
+=== Unit lookup
+
+[source,ruby]
+----
+Unitsml.find_unit(ascii: 'mL') # Unitsml::Unit (with unit attributes)
+----
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to https://rubygems.org[rubygems.org].
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at `https://github.com/unitsml/unitsml-ruby`. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the https://github.com/unitsml/unitsml-ruby/blob/master/docs/CODE_OF_CONDUCT.adoc[code of conduct].
+
+
+== License
+
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT license].
+
+== Code of Conduct
+
+Everyone interacting in the Unitsml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the https://github.com/unitsml/unitsml-ruby/blob/master/docs/CODE_OF_CONDUCT.adoc[code of conduct].

data/docs/navigation.adoc

@@ -0,0 +1,9 @@
+---
+items:
+- title: README
+  path: README/
+- title: Code of conduct
+  path: CODE_OF_CONDUCT/
+---
+
+= Navigation

data/lib/unitsml/dimension.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Unitsml
+  class Dimension
+    attr_accessor :dimension_name, :power_numerator
+
+    def initialize(dimension_name, power_numerator = nil)
+      @dimension_name = dimension_name
+      @power_numerator = power_numerator
+    end
+
+    def ==(object)
+      self.class == object.class &&
+        dimension_name == object&.dimension_name &&
+        power_numerator == object&.power_numerator
+    end
+
+    def dim_hash
+      Unitsdb.parsable_dimensions[dimension_name]
+    end
+
+    def dim_symbols
+      dim_hash&.values&.last&.values&.first["dim_symbols"].first
+    end
+
+    def to_mathml
+      value = dim_symbols["mathml"]
+      value = Ox.parse(value)
+      if power_numerator
+        msup = Utility.ox_element("msup")
+        msup << (Utility.ox_element("mrow") << value)
+        msup << (
+          Utility.ox_element("mrow") << (
+            Utility.ox_element("mn") << power_numerator
+          )
+        )
+        value = msup
+      end
+      value
+    end
+
+    def to_latex
+      value = dim_symbols["latex"]
+      if power_numerator
+        value = "#{value}^#{power_numerator}"
+      end
+      value
+    end
+
+    def to_asciimath
+      value = dim_symbols["ascii"]
+      value = "#{value}^#{power_numerator}" if power_numerator
+      value
+    end
+
+    def to_html
+      value = dim_symbols["html"]
+      value = "#{value}<sup>#{power_numerator}</sup>" if power_numerator
+      value
+    end
+
+    def to_unicode
+      value = dim_symbols["unicode"]
+      value = "#{value}^#{power_numerator}" if power_numerator
+      value
+    end
+
+    def generate_id
+      "#{dimension_name.split('_').last}#{power_numerator}"
+    end
+
+    def to_xml
+      fields = dim_hash[:fields]
+      symbol = fields.values.first["symbol"]
+      power_numerator_value = power_numerator || 1
+      attributes = { symbol: symbol, powerNumerator: power_numerator_value }
+      element_name = modelize(fields.keys.first.capitalize)
+      Utility.ox_element(element_name, attributes: attributes)
+    end
+
+    def modelize(value)
+      value&.split("_")&.map(&:capitalize)&.join
+    end
+  end
+end

data/lib/unitsml/extender.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Unitsml
+  class Extender
+    attr_accessor :symbol
+
+    def initialize(symbol)
+      @symbol = symbol
+    end
+
+    def ==(object)
+      self.class == object.class &&
+        symbol == object&.symbol
+    end
+
+    def to_mathml
+      Utility.ox_element("mo") << "&#x22c5;"
+    end
+
+    def to_latex
+      "/"
+    end
+
+    def to_asciimath
+      symbol
+    end
+
+    def to_html
+      "&#x22c5;"
+    end
+
+    def to_unicode
+      symbol == "*" ? "·" : symbol
+    end
+  end
+end

data/lib/unitsml/formula.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require "plurimath"
+require_relative "utility"
+module Unitsml
+  class Formula
+    attr_accessor :value, :explicit_value, :root
+
+    def initialize(value = [],
+                   explicit_value: nil,
+                   root: false,
+                   orig_text: nil,
+                   norm_text: nil)
+      @value = value
+      @explicit_value = explicit_value
+      @root = root
+      @orig_text = orig_text
+      @norm_text = norm_text
+    end
+
+    def ==(object)
+      self.class == object.class &&
+        value == object&.value &&
+        explicit_value == object&.explicit_value &&
+        root == object.root
+    end
+
+    def to_mathml
+      if root
+        attributes = { xmlns: "http://www.w3.org/1998/Math/MathML", display: "block" }
+        math = Utility.ox_element("math", attributes: attributes)
+        Ox.dump(
+          Utility.update_nodes(
+            math,
+            value.map(&:to_mathml).flatten,
+          ),
+        ).gsub(/&amp;(.*?)(?=<\/)/, '&\1')
+      else
+        value.map(&:to_mathml)
+      end
+    end
+
+    def to_latex
+      value.map(&:to_latex).join
+    end
+
+    def to_asciimath
+      value.map(&:to_asciimath).join
+    end
+
+    def to_html
+      value.map(&:to_html).join
+    end
+
+    def to_unicode
+      value.map(&:to_unicode).join
+    end
+
+    def to_xml
+      dimensions_array = extract_dimensions(value)
+      if (dimensions_array).any?
+        dimensions(sort_dims(dimensions_array))
+      elsif @orig_text.match(/-$/)
+        prefixes
+      else
+        units
+      end
+    end
+
+    def to_plurimath
+      return Plurimath::Math.parse(to_asciimath, :asciimath) if @orig_text.match?(/-$/)
+
+      Plurimath::Math.parse(to_mathml, :mathml)
+    end
+
+    private
+
+    def extract_dimensions(formula)
+      dimensions = []
+
+      formula.each do |term|
+        if term.is_a?(Dimension)
+          dimensions << term
+        elsif term.is_a?(Sqrt) && term.value.is_a?(Dimension)
+          sqrt_term = term.value.dup
+          sqrt_term.power_numerator = "0.5"
+          dimensions << sqrt_term
+        elsif term.is_a?(Formula)
+          dimensions.concat(extract_dimensions(term.value))
+        end
+      end
+
+      dimensions
+    end
+
+    def extract_units(formula)
+      units_arr = []
+
+      formula.each do |term|
+        case term
+        when Unit
+          units_arr << term.dup
+        when Formula
+          units_arr.concat(extract_units(term.value.dup))
+        when Sqrt
+          next unless term.value.is_a?(Unit)
+
+          units_arr << term.value
+        end
+      end
+
+      units_arr
+    end
+
+    def units
+      all_units = extract_units(value)
+      norm_text = Utility.postprocess_normtext(all_units)
+      dims = Utility.units2dimensions(extract_units(value))
+      dimension, dimension_component = unique_dimensions(dims, norm_text)
+      [
+        Utility.unit(all_units, self, dims, norm_text, explicit_value&.dig(:name)),
+        Utility.prefixes(all_units),
+        dimension,
+        dimension_component,
+        Utility.quantity(norm_text, explicit_value&.dig(:quantity)),
+      ].join
+    end
+
+    def unique_dimensions(dims, norm_text)
+      [
+        Utility.dimension(norm_text),
+        Utility.dimension_components(dims),
+      ].uniq
+    end
+
+    def dimensions(dims)
+      dim_id = dims.map(&:generate_id).join
+      attributes = { xmlns: Utility::UNITSML_NS, "xml:id": "D_#{dim_id}" }
+      Ox.dump(
+        Utility.update_nodes(
+          Utility.ox_element("Dimension", attributes: attributes),
+          dims.map(&:to_xml),
+        ),
+      )
+    end
+
+    def sort_dims(values)
+      dims_hash = Utility::Dim2D
+      values.sort do |first, second|
+        dims_hash.dig(first.dimension_name, :order) <=> dims_hash.dig(second.dimension_name, :order)
+      end
+    end
+
+    def prefixes
+      norm_text = @norm_text&.split("-")&.first
+      prefix_object = Unit.new("", prefix: Prefix.new(norm_text))
+      [
+        Utility.prefixes([prefix_object]),
+        Utility.dimension(norm_text),
+        Utility.quantity(norm_text, explicit_value&.dig(:quantity)),
+      ].join
+    end
+  end
+end