skymap 0.4.0 → 0.5.0

data/lib/skymap/theme.rb

@@ -1,25 +1,52 @@
 # frozen_string_literal: true
 
 module Skymap
-  Theme = Data.define(
-    :background,
-    :sky,
-    :horizon,
-    :star,
-    :constellation_line,
-    :boundary,
-    :ecliptic,
-    :planet,
-    :sun,
-    :moon,
-    :moon_shadow,
-    :moon_shadow_opacity,
-    :constellation_name,
-    :star_name,
-    :planet_name,
-    :label,
-    :font
-  ) do
+  required_colors = %i[
+    background
+    sky
+    horizon
+    star
+    constellation_line
+    boundary
+    ecliptic
+    planet
+    sun
+    moon
+    moon_shadow
+    moon_shadow_opacity
+    constellation_name
+    star_name
+    planet_name
+    label
+    font
+  ].freeze
+  optional_colors = {
+    grid: :boundary,
+    scale: :star_name,
+    field_circle: :planet,
+    deep_sky: :constellation_name
+  }.freeze
+
+  Theme = Data.define(*required_colors, *optional_colors.keys) do
+    const_set(:OPTIONAL_COLORS, optional_colors)
+
+    def self.check_fallbacks(optional, required)
+      optional.each do |slot, fallback|
+        next if required.include?(fallback)
+
+        raise ArgumentError,
+          "#{slot} must fall back to a required slot, not #{fallback.inspect}"
+      end
+    end
+
+    check_fallbacks(optional_colors, required_colors)
+
+    prepend(Module.new {
+      optional_colors.each do |slot, fallback|
+        define_method(slot) { super() || public_send(fallback) }
+      end
+    })
+
     def self.dark
       new(
         background: "none",
@@ -29,6 +56,7 @@ module Skymap
         constellation_line: "#46689c",
         boundary: "#2b3f5e",
         ecliptic: "#8c7a3a",
+        grid: "#22324a",
         planet: "#ffe6b3",
         sun: "#ffd34d",
         moon: "#f1ecd6",
@@ -51,6 +79,7 @@ module Skymap
         constellation_line: "#5b7bb0",
         boundary: "#b8c4d9",
         ecliptic: "#b08d1f",
+        grid: "#d5ddea",
         planet: "#c2570c",
         sun: "#f0a500",
         moon: "#e8d27a",
@@ -73,6 +102,7 @@ module Skymap
         constellation_line: "#8a2020",
         boundary: "#4a1212",
         ecliptic: "#a33a1a",
+        grid: "#3a0e0e",
         planet: "#ff9a7a",
         sun: "#ff8a3d",
         moon: "#ffb3a0",
@@ -87,14 +117,18 @@ module Skymap
     end
 
     def initialize(**slots)
+      optional = self.class::OPTIONAL_COLORS
+
       slots.except(:moon_shadow_opacity).each do |slot, value|
+        next if value.nil? && optional.key?(slot)
+
         check_text(slot, value)
       end
       if slots.key?(:moon_shadow_opacity)
         check_opacity(slots[:moon_shadow_opacity])
       end
 
-      super
+      super(**optional.transform_values { nil }, **slots)
     end
 
     private

data/lib/skymap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skymap
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/skymap/view.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Skymap
+  View = Data.define(
+    :center,
+    :field_of_view,
+    :orientation,
+    :rotation,
+    :mirrored
+  ) do
+    def initialize(
+      center:,
+      field_of_view:,
+      orientation: :zenith_up,
+      rotation: Astronoby::Angle.zero,
+      mirrored: false
+    )
+      unless center.is_a?(Astronoby::Coordinates::Equatorial) ||
+          center.is_a?(Astronoby::Coordinates::Horizontal)
+        raise ArgumentError,
+          "center must be equatorial or horizontal coordinates"
+      end
+
+      unless field_of_view.is_a?(Astronoby::Angle) &&
+          field_of_view.positive? && field_of_view.radians <= Math::PI
+        raise ArgumentError,
+          "field_of_view must be an Astronoby::Angle " \
+          "above 0 and up to 180 degrees"
+      end
+
+      unless View::ORIENTATIONS.include?(orientation)
+        raise ArgumentError,
+          "orientation must be one of #{View::ORIENTATIONS.join(", ")}"
+      end
+
+      unless rotation.is_a?(Astronoby::Angle) && rotation.radians.finite?
+        raise ArgumentError, "rotation must be an Astronoby::Angle"
+      end
+
+      unless [true, false].include?(mirrored)
+        raise ArgumentError, "mirrored must be true or false"
+      end
+
+      super
+    end
+  end
+
+  View::ORIENTATIONS = %i[zenith_up equatorial].freeze
+end

data/lib/skymap.rb

@@ -6,39 +6,63 @@ require_relative "skymap/canvas"
 require_relative "skymap/catalog/constellation_boundaries"
 require_relative "skymap/catalog/constellation_lines"
 require_relative "skymap/catalog/constellation_names"
+require_relative "skymap/catalog/deep_sky_objects"
 require_relative "skymap/catalog/star_names"
+require_relative "skymap/catalog/star_records"
 require_relative "skymap/catalog/stars"
 require_relative "skymap/chart"
+require_relative "skymap/cone"
 require_relative "skymap/constellation_boundary"
 require_relative "skymap/constellation_line"
 require_relative "skymap/context"
+require_relative "skymap/deep_sky_object"
+require_relative "skymap/eyepiece"
+require_relative "skymap/field"
+require_relative "skymap/geometry"
 require_relative "skymap/horizon"
+require_relative "skymap/label_placement"
+require_relative "skymap/magnitude_limit"
 require_relative "skymap/layers/cardinal_directions"
 require_relative "skymap/layers/constellation_boundaries"
 require_relative "skymap/layers/constellation_lines"
 require_relative "skymap/layers/constellation_names"
+require_relative "skymap/layers/deep_sky_objects"
 require_relative "skymap/layers/ecliptic"
+require_relative "skymap/layers/field_circles"
+require_relative "skymap/layers/grid"
 require_relative "skymap/layers/moon"
 require_relative "skymap/layers/planets"
+require_relative "skymap/layers/scale"
 require_relative "skymap/layers/star_names"
 require_relative "skymap/layers/stars"
 require_relative "skymap/layers/sun"
 require_relative "skymap/point"
+require_relative "skymap/print_size"
+require_relative "skymap/projection/oblique_stereographic"
 require_relative "skymap/projection/stereographic"
 require_relative "skymap/renderer/boundary"
 require_relative "skymap/renderer/caption"
+require_relative "skymap/renderer/deep_sky_symbol"
 require_relative "skymap/renderer/dot"
 require_relative "skymap/renderer/ecliptic"
+require_relative "skymap/renderer/field_circle"
+require_relative "skymap/renderer/grid"
+require_relative "skymap/renderer/horizon_line"
 require_relative "skymap/renderer/label"
 require_relative "skymap/renderer/line"
 require_relative "skymap/renderer/moon"
 require_relative "skymap/renderer/planet"
+require_relative "skymap/renderer/scale_bar"
 require_relative "skymap/renderer/sun"
 require_relative "skymap/renderer/svg"
+require_relative "skymap/setup"
 require_relative "skymap/star"
+require_relative "skymap/star_list"
 require_relative "skymap/star_size"
+require_relative "skymap/telescope"
 require_relative "skymap/theme"
 require_relative "skymap/version"
+require_relative "skymap/view"
 
 module Skymap
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skymap
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Rémy Hannequin
@@ -145,52 +145,81 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- data/LICENSE-deep_sky_objects.txt
+- data/LICENSE-stars.txt
 - data/constellations/iau/boundaries.csv
 - data/constellations/iau/lines.csv
 - data/constellations/iau/names.csv
+- data/deep_sky_objects.csv
 - data/star_names.csv
-- data/stars.csv
+- data/stars.bin
 - lib/skymap.rb
 - lib/skymap/canvas.rb
 - lib/skymap/catalog/constellation_boundaries.rb
 - lib/skymap/catalog/constellation_lines.rb
 - lib/skymap/catalog/constellation_names.rb
+- lib/skymap/catalog/deep_sky_objects.rb
 - lib/skymap/catalog/star_names.rb
+- lib/skymap/catalog/star_records.rb
 - lib/skymap/catalog/stars.rb
 - lib/skymap/chart.rb
+- lib/skymap/cone.rb
 - lib/skymap/constellation_boundary.rb
 - lib/skymap/constellation_line.rb
 - lib/skymap/context.rb
+- lib/skymap/deep_sky_object.rb
+- lib/skymap/eyepiece.rb
+- lib/skymap/field.rb
+- lib/skymap/geometry.rb
 - lib/skymap/horizon.rb
+- lib/skymap/label_placement.rb
 - lib/skymap/layers/cardinal_directions.rb
 - lib/skymap/layers/constellation_boundaries.rb
 - lib/skymap/layers/constellation_lines.rb
 - lib/skymap/layers/constellation_names.rb
+- lib/skymap/layers/deep_sky_objects.rb
 - lib/skymap/layers/ecliptic.rb
+- lib/skymap/layers/field_circles.rb
+- lib/skymap/layers/grid.rb
 - lib/skymap/layers/moon.rb
 - lib/skymap/layers/planets.rb
+- lib/skymap/layers/scale.rb
 - lib/skymap/layers/star_names.rb
 - lib/skymap/layers/stars.rb
 - lib/skymap/layers/sun.rb
+- lib/skymap/magnitude_limit.rb
 - lib/skymap/point.rb
+- lib/skymap/print_size.rb
+- lib/skymap/projection/oblique_stereographic.rb
 - lib/skymap/projection/stereographic.rb
 - lib/skymap/renderer/boundary.rb
 - lib/skymap/renderer/caption.rb
+- lib/skymap/renderer/deep_sky_symbol.rb
 - lib/skymap/renderer/dot.rb
 - lib/skymap/renderer/ecliptic.rb
+- lib/skymap/renderer/field_circle.rb
+- lib/skymap/renderer/grid.rb
+- lib/skymap/renderer/horizon_line.rb
 - lib/skymap/renderer/label.rb
 - lib/skymap/renderer/line.rb
 - lib/skymap/renderer/moon.rb
 - lib/skymap/renderer/planet.rb
+- lib/skymap/renderer/scale_bar.rb
 - lib/skymap/renderer/sun.rb
 - lib/skymap/renderer/svg.rb
+- lib/skymap/setup.rb
 - lib/skymap/star.rb
+- lib/skymap/star_list.rb
 - lib/skymap/star_size.rb
+- lib/skymap/telescope.rb
 - lib/skymap/theme.rb
 - lib/skymap/version.rb
+- lib/skymap/view.rb
 homepage: https://github.com/rhannequin/skymap
 licenses:
 - MIT
+- CC-BY-SA-4.0
+- LicenseRef-CC-BY-NC-3.0-IGO
 metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://github.com/rhannequin/skymap