dogma.rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5079232ee6960c019d2b4bd739a5f492d26f238dd200bf90eb19ee36facf0b13
+  data.tar.gz: ca5f074c183a4e98dafc06e1a26238514517b802de8e06fca6e7b925707630b3
+SHA512:
+  metadata.gz: c22b4ac95ee4643fc8859bb372d71d9730f79b5b5764f21f315c6b64b823c6470c94c12253ceb3a0a8ad3a74cd1a959fcc7879e50a7eaa60e7554a43590ddd9e
+  data.tar.gz: a2620d57273f10c132d8ef2a23df65602001727c4eb20b5014aaaf8e1a9508f93a969b6be727c3c920e778ea063670c344e18b6b526af676ff73cf6815fc995a

data/AUTHORS

@@ -0,0 +1 @@
+* Arto Bendiken <arto@bendiken.net>

data/CHANGES.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

data/CREDITS.md

@@ -0,0 +1 @@
+# Credits

data/README.md

@@ -0,0 +1,48 @@
+# Dogma for Ruby
+
+[![Project license](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://unlicense.org)
+[![Ruby compatibility](https://img.shields.io/badge/ruby-2.7%2B-blue)](https://rubygems.org/gems/dogma.rb)
+[![RubyGems gem](https://img.shields.io/gem/v/dogma.rb.svg)](https://rubygems.org/gems/dogma.rb)
+[![Continuous integration](https://github.com/dogmatists/dogma.rb/workflows/Continuous%20integration/badge.svg)](https://github.com/dogmatists/dogma.rb/actions?query=workflow%3A%22Continuous+integration%22)
+
+<https://dogma.dev>
+
+## Prerequisites
+
+- [Ruby](https://www.ruby-lang.org/en/) 2.7+
+
+## Installation
+
+```bash
+$ gem install dogma.rb
+```
+
+## Examples
+
+### Importing the library
+
+```ruby
+require 'dogma'
+```
+
+### Checking the library version
+
+## Reference
+
+### Classes
+
+- [`Dogma::Angle`](https://dogma.dev/Angle/)
+- [`Dogma::Latitude`](https://dogma.dev/Latitude/)
+- [`Dogma::Longitude`](https://dogma.dev/Longitude/)
+
+## See Also
+
+Dogma for [C][], [C++][], [Dart][], [Protobuf][], [Python][], and [Zig][].
+
+[C]:        https://github.com/dogmatists/dogma.c
+[C++]:      https://github.com/dogmatists/dogma.cpp
+[Dart]:     https://github.com/dogmatists/dogma.dart
+[Protobuf]: https://github.com/dogmatists/dogma.pb
+[Python]:   https://github.com/dogmatists/dogma.py
+[Ruby]:     https://github.com/dogmatists/dogma.rb
+[Zig]:      https://github.com/dogmatists/dogma.zig

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org/>

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/dogma.rb

@@ -0,0 +1,7 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'dogma/version'
+
+require_relative 'dogma/angle'
+require_relative 'dogma/latitude'
+require_relative 'dogma/longitude'

data/lib/dogma/angle.rb

@@ -0,0 +1,47 @@
+# This is free and unencumbered software released into the public domain.
+
+##
+# An angle.
+#
+# @see https://dogma.dev/Angle/
+class Dogma::Angle
+  # @return [Float]
+  attr_reader :radians
+
+  ##
+  # @param  [Float, #to_f] degrees
+  # @param  [Float, #to_f] radians
+  # @param  [Float, #to_f] turns
+  # @return [void]
+  def initialize(degrees: nil, radians: nil, turns: nil)
+    @radians = case
+      when radians then radians.to_f
+      when degrees then degrees.to_f/180 * Math::PI
+      when turns then turns * 2*Math::PI
+    end
+  end
+
+  ##
+  # @return [Float]
+  def to_f
+    self.radians
+  end
+
+  ##
+  # @return [Float]
+  def as_degrees
+    self.radians/Math::PI * 180
+  end
+
+  ##
+  # @return [Float]
+  def as_radians
+    self.radians
+  end
+
+  ##
+  # @return [Float]
+  def as_turns
+    self.radians / (2*Math::PI)
+  end
+end # Dogma::Angle

data/lib/dogma/latitude.rb

@@ -0,0 +1,21 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'angle'
+
+##
+# A latitude.
+#
+# @see https://dogma.dev/Latitude/
+class Dogma::Latitude < Dogma::Angle
+  MIN = -90
+  MAX = 90
+
+  ##
+  # @param  [Float, #to_f] degrees (-90..90)
+  # @return [void]
+  def initialize(degrees)
+    degrees = degrees.to_f
+    raise ArgumentError, "Latitude bounds are ±90°, but got #{degrees}°" if degrees.abs > MAX
+    super(degrees: degrees)
+  end
+end # Dogma::Latitude

data/lib/dogma/longitude.rb

@@ -0,0 +1,21 @@
+# This is free and unencumbered software released into the public domain.
+
+require_relative 'angle'
+
+##
+# A longitude.
+#
+# @see https://dogma.dev/Longitude/
+class Dogma::Longitude < Dogma::Angle
+  MIN = -180
+  MAX = 180
+
+  ##
+  # @param  [Float, #to_f] degrees (-180..180)
+  # @return [void]
+  def initialize(degrees)
+    degrees = degrees.to_f
+    raise ArgumentError, "Longitude bounds are ±180°, but got #{degrees}°" if degrees.abs > MAX
+    super(degrees: degrees)
+  end
+end # Dogma::Longitude

data/lib/dogma/version.rb

@@ -0,0 +1,21 @@
+# This is free and unencumbered software released into the public domain.
+
+module Dogma
+  module VERSION
+    FILE = File.expand_path('../../VERSION', __dir__).freeze
+    STRING = File.read(FILE).chomp.freeze
+    MAJOR, MINOR, TINY, EXTRA = STRING.split('.').map(&:to_i).freeze
+
+    ##
+    # @return [String]
+    def self.to_s() STRING end
+
+    ##
+    # @return [String]
+    def self.to_str() STRING end
+
+    ##
+    # @return [Array(Integer, Integer, Integer)]
+    def self.to_a() [MAJOR, MINOR, TINY].freeze end
+  end # VERSION
+end # Dogma

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: dogma.rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Arto Bendiken
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Dogma for Ruby.
+email: arto@bendiken.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- AUTHORS
+- CHANGES.md
+- CREDITS.md
+- README.md
+- UNLICENSE
+- VERSION
+- lib/dogma.rb
+- lib/dogma/angle.rb
+- lib/dogma/latitude.rb
+- lib/dogma/longitude.rb
+- lib/dogma/version.rb
+homepage: https://github.com/dogmatists/dogma.rb
+licenses:
+- Unlicense
+metadata:
+  bug_tracker_uri: https://github.com/dogmatists/dogma.rb/issues
+  changelog_uri: https://github.com/dogmatists/dogma.rb/blob/master/CHANGES.md
+  documentation_uri: https://www.rubydoc.info/github/dogmatists/dogma.rb/master
+  homepage_uri: https://github.com/dogmatists/dogma.rb
+  source_code_uri: https://github.com/dogmatists/dogma.rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Dogma for Ruby.
+test_files: []