skymap 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a82d2da6f139662ddad63ac5f7a61d4228d2665106c7102a828710cf3da940
-  data.tar.gz: 446b8d777d47bc92fe8878247f61d45168f0e469180d779d304b3e66da5cb185
+  metadata.gz: 4c452f10b960f7fd529a6c7b686d4a002ee424966aaf725d02d6136cafbb3f39
+  data.tar.gz: 1f62d95726d712568a243ff936c16b3eb1154f31c8c16909575026dccef04070
 SHA512:
-  metadata.gz: 3703c46d73bdad50017a6b00d06038ecb8876f7d7522b2699db3c1793d5e547e48511e372979be603ebf618bd6d0448140821e71e3397ec9c6b43eae58c18d88
-  data.tar.gz: e842f5ebbc50609e9904ac20a0f284286277b9d96eb3b24c82ed50764a3452412f6384bbb9e64592e25f54b3cc7bf5b40d2f772fb532fa1be4720f44e8e890a1
+  metadata.gz: 815b9cca8e47e204b3ded57575169dfbc6b534246e2bc62b3fdb1c60770e3894b6c1e1215a04a7af3d239f9403a91861c11118926170df577b3923ed8c2f9e0b
+  data.tar.gz: 8eaa436a22575fcf838b8d6898d1cff408acacfae56f17e15675dd513e092207f78db778c1e3d0da0ecd99603747b8715752029e04941b2edbb709d894e94a5a

data/CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.4.0] - 2026-11-05
+
+### Added
+
+- `Skymap::Theme` gives the colors and the font of the map, with the
+  `Skymap::Theme.dark` (default), `Skymap::Theme.light` and
+  `Skymap::Theme.night` themes, and is given to `Skymap::Chart` with `theme:`
+- `Skymap::Layers::StarNames` writes the names of the brightest stars, down to
+  a `magnitude_limit:` (2 by default), from `Skymap::Catalog::StarNames` or the
+  names given with `names:`, and placed for the stars drawn down to
+  `stars_magnitude_limit:` (5 by default)
+- `Skymap::Catalog::StarNames` gives the IAU name of 333 stars of the Bright
+  Star Catalogue, such as Sirius or Betelgeuse
+
+### Changed
+
+- The names of the planets next to the horizon move towards the center of the
+  map until they fit in the sky
+
 ## [0.3.0] - 2026-11-01
 
 ### Added
@@ -79,7 +98,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial release to reserve the gem name on RubyGems.org
 
-[Unreleased]: https://github.com/rhannequin/skymap/compare/v0.3.0...HEAD
+[Unreleased]: https://github.com/rhannequin/skymap/compare/v0.4.0...HEAD
+[0.4.0]: https://github.com/rhannequin/skymap/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/rhannequin/skymap/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/rhannequin/skymap/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/rhannequin/skymap/compare/v0.0.1...v0.1.0

data/README.md

@@ -8,8 +8,8 @@ Skymap is a Ruby library for generating maps of the sky.
 <p align="center">
   <img
     src="https://raw.githubusercontent.com/rhannequin/skymap/main/sky_map.svg"
-    width="480"
-    alt="The sky over Paris on September 24, 2026 at 22:00 UTC, with the stars, the constellation lines, boundaries and names, the ecliptic, the Moon and Saturn"
+    width="640"
+    alt="The sky over Paris on September 23, 2026 at 20:00 UTC, with the stars, the constellation lines, boundaries and names, the ecliptic, the Moon and Saturn"
   >
 </p>
 
@@ -34,29 +34,34 @@ gem install skymap
 ## Usage
 
 Skymap draws the sky seen by an observer at a given instant, and returns it
-as an SVG string:
+as an SVG string. This is the map above:
 
 ```ruby
 require "skymap"
 
+Astronoby::Ephem.download(name: "inpop19a.bsp", target: "inpop19a.bsp")
+ephem = Astronoby::Ephem.load("inpop19a.bsp")
+
 observer = Astronoby::Observer.new(
   latitude: Astronoby::Angle.from_degrees(48.8575),
   longitude: Astronoby::Angle.from_degrees(2.3514)
 )
-instant = Astronoby::Instant.from_time(Time.utc(2026, 9, 24, 22))
+instant = Astronoby::Instant.from_time(Time.utc(2026, 9, 23, 20))
 canvas = Skymap::Canvas.new(size: 800, padding: 24)
 stars = Skymap::Catalog::Stars.new.to_a
+lines = Skymap::Catalog::ConstellationLines.new.to_a
 
 chart = Skymap::Chart.new(observer: observer, instant: instant, canvas: canvas)
 svg = chart.render(
   Skymap::Layers::ConstellationBoundaries.new(
     boundaries: Skymap::Catalog::ConstellationBoundaries.new
   ),
-  Skymap::Layers::ConstellationLines.new(
-    lines: Skymap::Catalog::ConstellationLines.new,
-    stars: stars
-  ),
+  Skymap::Layers::Ecliptic.new,
+  Skymap::Layers::ConstellationLines.new(lines: lines, stars: stars),
   Skymap::Layers::Stars.new(stars: stars),
+  Skymap::Layers::ConstellationNames.new(lines: lines, stars: stars),
+  Skymap::Layers::Planets.new(ephem: ephem, labels: true),
+  Skymap::Layers::Moon.new(ephem: ephem),
   Skymap::Layers::CardinalDirections.new
 )
 
@@ -64,7 +69,12 @@ File.write("sky_map.svg", svg)
 ```
 
 The observer and the instant are [Astronoby] objects. Astronoby computes where
-each star is in the sky and Skymap draws it.
+each star is in the sky and Skymap draws it. The Moon and the planets need an
+ephemeris, which the first lines download and load (see [Moon](#moon)). Every
+layer is optional: leave one out to hide what it draws.
+
+The map at the top of this page is generated by `bin/build_readme_map`, which
+runs this code with the ephemeris of the tests.
 
 The map is a disk: the zenith is at the center and the horizon is the edge. It
 uses a [stereographic projection], the most common one for sky charts because
@@ -77,6 +87,65 @@ The canvas is the square SVG the map is drawn on. `size` is its width and
 height, and `padding` is the space between the horizon and the edge of the
 SVG.
 
+### Themes
+
+A theme gives the colors of the map. `Chart` draws the dark theme by default,
+light stars on a black sky. Pass `theme:` to draw another one:
+
+```ruby
+chart = Skymap::Chart.new(
+  observer: observer,
+  instant: instant,
+  canvas: canvas,
+  theme: Skymap::Theme.light
+)
+```
+
+- `Skymap::Theme.dark`: the default.
+- `Skymap::Theme.light`: dark stars on a white sky, for printing.
+- `Skymap::Theme.night`: shades of red on a black sky, which keep your eyes
+  adapted to the dark when you use the map outside.
+
+<p align="center">
+  <img
+    src="https://raw.githubusercontent.com/rhannequin/skymap/main/sky_map.svg"
+    width="30%"
+    alt="The dark theme: white stars on a black sky"
+  >
+  <img
+    src="https://raw.githubusercontent.com/rhannequin/skymap/main/docs/themes/light.svg"
+    width="30%"
+    alt="The light theme: dark stars on a white sky"
+  >
+  <img
+    src="https://raw.githubusercontent.com/rhannequin/skymap/main/docs/themes/night.svg"
+    width="30%"
+    alt="The night theme: shades of red on a black sky"
+  >
+</p>
+
+Build your own from a built-in one, changing the colors you want. Each color
+is a string SVG accepts, such as `"#ffeedd"` or `"gold"`:
+
+```ruby
+theme = Skymap::Theme.dark.with(
+  sky: "#0b1026",
+  star: "#fff4d6"
+)
+```
+
+The colors are `background` (the square behind the sky, which the cardinal
+directions are written on), `sky`, `horizon`, `star`, `constellation_line`, `boundary`,
+`ecliptic`, `planet`, `sun`, `moon`, `moon_shadow` (with its
+`moon_shadow_opacity`, between 0 and 1), `constellation_name`, `star_name`,
+`planet_name` and `label` (the cardinal directions). `font` is the font family
+of every text.
+
+Use `"none"` as a color to leave something out. The dark theme has
+`background: "none"`, so the SVG is transparent around the sky, and with
+`sky: "none"` the sky is transparent too, to put the map on a background of
+your own. With `horizon: "none"`, the edge of the sky is not outlined.
+
 ### Layers
 
 A map is the sky, with the layers given to `Chart#render` drawn on top of it,
@@ -98,6 +167,46 @@ fewer stars:
 Skymap::Layers::Stars.new(stars: stars, magnitude_limit: 6)
 ```
 
+#### Star names
+
+`Skymap::Layers::StarNames` writes the names of the brightest stars, next to
+them, on the side of the center of the map. A name next to the horizon is moved
+towards the center until it fits in the sky, as far as the width of the text
+can be estimated. It takes the same stars as the stars layer, and
+`Skymap::Catalog::StarNames` gives the names of 333 stars of the catalog, as
+approved by the IAU (see [Data sources](#data-sources)):
+
+```ruby
+Skymap::Layers::StarNames.new(stars: stars)
+```
+
+Only the stars of magnitude 2 or brighter are named by default, which is about
+fifty stars. Use `magnitude_limit:` to name more or fewer stars:
+
+```ruby
+Skymap::Layers::StarNames.new(stars: stars, magnitude_limit: 3)
+```
+
+Names sit just outside the dots of the stars. Dots get smaller as the stars
+layer draws fainter stars, so if you give it a `magnitude_limit:` other than 5,
+give the same one to `stars_magnitude_limit:`:
+
+```ruby
+Skymap::Layers::Stars.new(stars: stars, magnitude_limit: 6)
+Skymap::Layers::StarNames.new(stars: stars, stars_magnitude_limit: 6)
+```
+
+Use `names:` to write the names differently: it takes anything that gives a
+name from the Harvard Revised number of a star (`hr`), such as a hash. A star
+without a name is left out:
+
+```ruby
+Skymap::Layers::StarNames.new(
+  stars: stars,
+  names: {2491 => "Sirius", 424 => "Étoile polaire"}
+)
+```
+
 #### Constellation boundaries
 
 `Skymap::Layers::ConstellationBoundaries` draws the boundaries between the
@@ -259,6 +368,15 @@ Skymap::Layers::Ecliptic.new
 W) in the padding, with a size that follows it: a padding of about 3% of the
 size gives readable labels.
 
+## Examples
+
+The [examples](https://github.com/rhannequin/skymap/tree/main/examples)
+folder has scripts and the maps they draw, for
+different combinations of layers, themes and observers: the naked-eye sky, a
+printable map of the constellations, the planets, a night vision map for
+outdoors, the southern sky and more. Start from the one closest to what you
+want to draw.
+
 ## Data sources
 
 ### Stars
@@ -279,6 +397,19 @@ This research has made use of the VizieR catalogue access tool, CDS,
 Strasbourg, France ([DOI: 10.26093/cds/vizier][vizier-doi]). The original
 description of the VizieR service was published in 2000, A&AS 143, 23.
 
+### Star names
+
+`data/star_names.csv` gives the name of 333 stars of `data/stars.csv` from
+their Harvard Revised number (`hr`), as listed in the [IAU Catalog of Star
+Names][iau-csn] by the IAU Working Group on Star Names. The catalog also names
+stars that are not in the Bright Star Catalogue, such as the host stars of
+exoplanets, which are left out.
+
+The file is generated with `bin/build_star_names`, which downloads the list
+and keeps the stars with an HR number. The IAU asks to cite its official
+version of the list at <https://www.iau.org/public/themes/naming_stars/>, and
+releases its products under a Creative Commons Attribution license.
+
 ### Constellations
 
 `data/constellations/iau/lines.csv` holds the lines of the 88 IAU
@@ -397,3 +528,4 @@ rooms and mailing lists is expected to follow the
 [jpl-ephemerides]: https://ssd.jpl.nasa.gov/planets/eph_export.html
 [naif]: https://naif.jpl.nasa.gov/naif/rules.html
 [cc-by-4]: https://creativecommons.org/licenses/by/4.0/
+[iau-csn]: https://www.pas.rochester.edu/~emamajek/WGSN/IAU-CSN.txt

data/data/star_names.csv

@@ -0,0 +1,334 @@
+hr,name
+15,Alpheratz
+21,Caph
+39,Algenib
+99,Ankaa
+153,Fulu
+168,Schedar
+188,Diphda
+219,Achird
+265,Castula
+337,Mirach
+338,Wurren
+361,Revati
+390,Adhil
+403,Ruchbah
+424,Polaris
+437,Alpherg
+458,Titawin
+464,Nembus
+472,Achernar
+510,Torcular
+539,Baten Kaitos
+542,Segin
+544,Mothallah
+546,Mesarthim
+553,Sheratan
+596,Alrescha
+603,Almach
+617,Hamal
+681,Mira
+804,Kaffaljidhma
+824,Lilii Borea
+834,Miram
+838,Bharani
+850,Angetenar
+874,Azha
+897,Acamar
+911,Menkar
+936,Algol
+941,Misam
+951,Botein
+963,Dalim
+984,Zibal
+1017,Mirfak
+1084,Ran
+1131,Atik
+1136,Rana
+1140,Celaeno
+1142,Electra
+1145,Taygeta
+1149,Maia
+1151,Asterope
+1156,Merope
+1165,Alcyone
+1178,Atlas
+1180,Pleione
+1228,Menkib
+1231,Zaurak
+1298,Beid
+1325,Keid
+1346,Prima Hyadum
+1373,Secunda Hyadum
+1393,Beemim
+1409,Ain
+1412,Chamukuy
+1457,Aldebaran
+1464,Theemin
+1481,Sceptrum
+1543,Tabit
+1577,Hassaleh
+1605,Almaaz
+1612,Saclateni
+1641,Haedus
+1666,Cursa
+1708,Capella
+1713,Rigel
+1790,Bellatrix
+1791,Elnath
+1829,Nihal
+1852,Mintaka
+1865,Arneb
+1879,Meissa
+1899,Hatysa
+1903,Alnilam
+1910,Tianguan
+1948,Alnitak
+1956,Phact
+2004,Saiph
+2040,Wazn
+2061,Betelgeuse
+2088,Menkalinan
+2095,Mahasim
+2177,Elkurud
+2216,Propus
+2282,Furud
+2286,Tejat
+2294,Mirzam
+2326,Canopus
+2421,Alhena
+2473,Mebsuta
+2484,Alzirr
+2491,Sirius
+2618,Adhara
+2646,Nganurganity
+2650,Mekbuda
+2657,Muliphein
+2693,Wezen
+2777,Wasat
+2827,Aludra
+2845,Gomeisa
+2891,Castor
+2930,Jishui
+2943,Procyon
+2990,Pollux
+3045,Azmidi
+3165,Naos
+3185,Tureis
+3208,Tegmine
+3249,Tarf
+3268,Piautos
+3275,Alsciaukat
+3307,Avior
+3323,Muscida
+3418,Minchir
+3429,Meleph
+3449,Asellus Borealis
+3461,Asellus Australis
+3482,Ashlesha
+3485,Alsephina
+3522,Copernicus
+3569,Talitha
+3572,Acubens
+3594,Alkaphrah
+3627,Nahn
+3634,Suhail
+3685,Miaplacidus
+3699,Aspidiske
+3734,Markeb
+3743,Intercrus
+3748,Alphard
+3773,Alterf
+3845,Ukdah
+3852,Subra
+3903,Zhang
+3905,Rasalas
+3923,Felis
+3982,Regulus
+4031,Adhafera
+4033,Tania Borealis
+4057,Algieba
+4069,Tania Australis
+4247,Praecipua
+4277,Chalawan
+4287,Alkes
+4295,Merak
+4301,Dubhe
+4357,Zosma
+4359,Chertan
+4375,Alula Australis
+4377,Alula Borealis
+4434,Giausar
+4518,Taiyangshou
+4534,Denebola
+4540,Zavijava
+4554,Phecda
+4609,Tonatiuh
+4623,Alchiba
+4656,Imai
+4660,Megrez
+4662,Gienah
+4689,Zaniah
+4700,Ginan
+4730,Acrux
+4757,Algorab
+4763,Gacrux
+4785,Chara
+4786,Kraz
+4825,Porrima
+4846,La Superba
+4853,Mimosa
+4863,Tianyi
+4905,Alioth
+4910,Minelauva
+4915,Cor Caroli
+4916,Taiyi
+4932,Vindemiatrix
+4968,Diadem
+5054,Mizar
+5056,Spica
+5062,Alcor
+5107,Heze
+5191,Alkaid
+5235,Muphrid
+5267,Hadar
+5288,Menkent
+5291,Thuban
+5315,Kang
+5338,Syrma
+5340,Arcturus
+5351,Xuange
+5359,Khambalia
+5409,Elgafar
+5435,Seginus
+5459,Rigil Kentaurus
+5460,Toliman
+5506,Izar
+5531,Zubenelgenubi
+5533,Merga
+5563,Kochab
+5602,Nekkar
+5603,Brachium
+5685,Zubeneschamali
+5733,Alkalurops
+5735,Pherkad
+5744,Edasich
+5747,Nusakan
+5787,Zubenelhakrabi
+5793,Alphecca
+5854,Unukalhai
+5879,Gudja
+5928,Iklil
+5944,Fang
+5953,Dschubba
+5984,Acrab
+6008,Marsic
+6027,Jabbah
+6056,Yed Prior
+6075,Yed Posterior
+6084,Alniyat
+6117,Cujam
+6132,Athebyne
+6134,Antares
+6148,Kornephoros
+6149,Marfik
+6165,Paikauhale
+6217,Atria
+6241,Larawag
+6247,Xamidimura
+6252,Pipirima
+6370,Alrakis
+6378,Sabik
+6396,Aldhibah
+6402,Guniibuu
+6406,Rasalgethi
+6410,Sarin
+6508,Lesath
+6526,Maasym
+6527,Shaula
+6536,Rastaban
+6553,Sargas
+6556,Rasalhague
+6585,Cervantes
+6603,Cebalrai
+6618,Alruba
+6630,Fuyue
+6636,Dziban
+6688,Grumium
+6705,Eltanin
+6746,Alnasl
+6789,Yildun
+6812,Polis
+6859,Kaus Media
+6879,Kaus Australis
+6913,Kaus Borealis
+6945,Fafnir
+7001,Vega
+7106,Sheliak
+7116,Ainalrami
+7121,Nunki
+7141,Alya
+7178,Sulafat
+7194,Ascella
+7228,Polaris Australis
+7235,Okab
+7254,Meridiana
+7264,Albaldah
+7298,Aladfar
+7310,Altais
+7337,Arkab Prior
+7343,Arkab Posterior
+7348,Rukbat
+7405,Anser
+7417,Albireo
+7462,Alsafi
+7479,Sham
+7525,Tarazed
+7528,Fawaris
+7557,Altair
+7595,Libertas
+7597,Terebellum
+7602,Alshain
+7754,Algedi
+7773,Alshat
+7776,Dabih
+7790,Peacock
+7796,Sadr
+7852,Aldulfin
+7882,Rotanev
+7906,Sualocin
+7924,Deneb
+7949,Aljanah
+7950,Albali
+8030,Musica
+8131,Kitalpha
+8162,Alderamin
+8232,Sadalsuud
+8238,Alfirk
+8264,Bunda
+8278,Nashira
+8301,Azelfafage
+8308,Enif
+8322,Deneb Algedi
+8353,Aldhanab
+8414,Sadalmelik
+8417,Kurhah
+8425,Alnair
+8450,Biham
+8499,Ancha
+8518,Sadachbia
+8610,Situla
+8634,Homam
+8636,Tiaki
+8650,Matar
+8684,Sadalbari
+8709,Skat
+8728,Fomalhaut
+8729,Helvetios
+8773,Fumalsamakah
+8775,Scheat
+8781,Markab
+8880,Salm
+8905,Alkarab
+8930,Veritate
+8974,Errai

data/lib/skymap/catalog/star_names.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Skymap
+  module Catalog
+    class StarNames
+      PATH = File.expand_path("../../../data/star_names.csv", __dir__)
+
+      def [](hr)
+        names[hr]
+      end
+
+      private
+
+      def names
+        @names ||= CSV
+          .read(PATH, headers: true, encoding: "UTF-8")
+          .to_h { |row| [row["hr"].to_i, row["name"]] }
+      end
+    end
+  end
+end

data/lib/skymap/chart.rb

@@ -2,10 +2,11 @@
 
 module Skymap
   class Chart
-    def initialize(observer:, instant:, canvas:)
+    def initialize(observer:, instant:, canvas:, theme: Theme.dark)
       @observer = observer
       @instant = instant
       @canvas = canvas
+      @theme = theme
     end
 
     def render(*layers)
@@ -16,7 +17,7 @@ module Skymap
       )
       elements = layers.flat_map { |layer| layer.elements(context) }
 
-      Renderer::SVG.new(canvas: @canvas).render(elements)
+      Renderer::SVG.new(canvas: @canvas, theme: @theme).render(elements)
     end
   end
 end

data/lib/skymap/layers/planets.rb

@@ -59,16 +59,11 @@ module Skymap
         name = @names[planet]
         return unless name
 
-        size = Renderer::Caption.size_for(context.canvas)
-        towards_center = (center.y > context.canvas.center.y) ? -1 : 1
-
-        Renderer::Caption.new(
-          position: Point.new(
-            x: center.x,
-            y: center.y + towards_center * (radius + size)
-          ),
+        Renderer::Caption.beside(
+          center: center,
+          radius: radius,
+          canvas: context.canvas,
           text: name,
-          size: size,
           kind: :planet
         )
       end

data/lib/skymap/layers/star_names.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Skymap
+  module Layers
+    class StarNames
+      DEFAULT_MAGNITUDE_LIMIT = 2
+
+      def initialize(
+        stars:,
+        magnitude_limit: DEFAULT_MAGNITUDE_LIMIT,
+        stars_magnitude_limit: Stars::DEFAULT_MAGNITUDE_LIMIT,
+        names: Catalog::StarNames.new
+      )
+        @stars = stars
+        @magnitude_limit = magnitude_limit
+        @stars_magnitude_limit = stars_magnitude_limit
+        @names = names
+      end
+
+      def elements(context)
+        star_size = StarSize.for(
+          canvas: context.canvas,
+          magnitude_limit: @stars_magnitude_limit
+        )
+
+        @stars.filter_map do |star|
+          next if star.magnitude > @magnitude_limit
+
+          name = @names[star.hr]
+          next unless name
+
+          next if context.horizontal(star).altitude.negative?
+
+          Renderer::Caption.beside(
+            center: context.position(star),
+            radius: star_size.radius(star.magnitude),
+            canvas: context.canvas,
+            text: name,
+            kind: :star
+          )
+        end
+      end
+    end
+  end
+end

data/lib/skymap/renderer/caption.rb

@@ -3,11 +3,38 @@
 module Skymap
   module Renderer
     CAPTION_SIZE_RATIO = 0.028
+    CAPTION_CHARACTER_WIDTH_RATIO = 0.55
 
     Caption = Data.define(:position, :text, :size, :kind) do
       def self.size_for(canvas)
         CAPTION_SIZE_RATIO * canvas.radius
       end
+
+      def self.beside(center:, radius:, canvas:, text:, kind:)
+        size = size_for(canvas)
+        towards_center = (center.y > canvas.center.y) ? -1 : 1
+        y = center.y + towards_center * (radius + size)
+
+        new(
+          position: Point.new(
+            x: within_sky(center.x, y, text, size, canvas),
+            y: y
+          ),
+          text: text,
+          size: size,
+          kind: kind
+        )
+      end
+
+      def self.within_sky(x, y, text, size, canvas)
+        dy = (y - canvas.center.y).abs + size / 2
+        room = Math.sqrt([canvas.radius**2 - dy**2, 0].max)
+        half_width = text.length * size * CAPTION_CHARACTER_WIDTH_RATIO / 2
+        reach = [room - half_width, 0].max
+
+        canvas.center.x + (x - canvas.center.x).clamp(-reach, reach)
+      end
+      private_class_method :within_sky
     end
   end
 end

data/lib/skymap/renderer/svg.rb

@@ -5,25 +5,12 @@ require "victor"
 module Skymap
   module Renderer
     class SVG
-      SKY_COLOR = "#000000"
-      HORIZON_COLOR = "#3262a8"
       HORIZON_WIDTH = 3
-      STAR_COLOR = "#ffffff"
-      LINE_COLOR = "#46689c"
-      BOUNDARY_COLOR = "#2b3f5e"
       BOUNDARY_DASH_RATIO = 4
-      ECLIPTIC_COLOR = "#8c7a3a"
-      PLANET_COLOR = "#ffe6b3"
-      SUN_COLOR = "#ffd34d"
-      MOON_COLOR = "#f1ecd6"
-      MOON_SHADOW_COLOR = "#232a35"
-      MOON_SHADOW_OPACITY = 0.6
-      CAPTION_COLORS = {constellation: "#6f8fc2", planet: PLANET_COLOR}
-      LABEL_COLOR = HORIZON_COLOR
-      LABEL_FONT = "sans-serif"
-
-      def initialize(canvas:)
+
+      def initialize(canvas:, theme:)
         @canvas = canvas
+        @theme = theme
       end
 
       def render(elements)
@@ -33,12 +20,14 @@ module Skymap
           height: @canvas.size
         )
 
+        draw_background(svg)
+
         svg.circle(
           cx: @canvas.center.x.round(2),
           cy: @canvas.center.y.round(2),
           r: @canvas.radius.round(2),
-          fill: SKY_COLOR,
-          stroke: HORIZON_COLOR,
+          fill: @theme.sky,
+          stroke: @theme.horizon,
           stroke_width: HORIZON_WIDTH
         )
 
@@ -62,13 +51,25 @@ module Skymap
 
       private
 
+      def draw_background(svg)
+        return if @theme.background == "none"
+
+        svg.rect(
+          x: 0,
+          y: 0,
+          width: @canvas.size,
+          height: @canvas.size,
+          fill: @theme.background
+        )
+      end
+
       def draw_line(svg, line)
         svg.line(
           x1: line.from.x.round(2),
           y1: line.from.y.round(2),
           x2: line.to.x.round(2),
           y2: line.to.y.round(2),
-          stroke: LINE_COLOR,
+          stroke: @theme.constellation_line,
           stroke_width: line.width.round(2),
           stroke_linecap: "round"
         )
@@ -82,7 +83,7 @@ module Skymap
             "#{point.x.round(2)},#{point.y.round(2)}"
           }.join(" "),
           fill: "none",
-          stroke: BOUNDARY_COLOR,
+          stroke: @theme.boundary,
           stroke_width: boundary.width.round(2),
           stroke_dasharray: "#{dash} #{dash}"
         )
@@ -94,7 +95,7 @@ module Skymap
             "#{point.x.round(2)},#{point.y.round(2)}"
           }.join(" "),
           fill: "none",
-          stroke: ECLIPTIC_COLOR,
+          stroke: @theme.ecliptic,
           stroke_width: ecliptic.width.round(2),
           stroke_linejoin: "round"
         )
@@ -105,7 +106,7 @@ module Skymap
           cx: dot.center.x.round(2),
           cy: dot.center.y.round(2),
           r: dot.radius.round(2),
-          fill: STAR_COLOR
+          fill: @theme.star
         )
       end
 
@@ -114,7 +115,7 @@ module Skymap
           cx: planet.center.x.round(2),
           cy: planet.center.y.round(2),
           r: planet.radius.round(2),
-          fill: PLANET_COLOR
+          fill: @theme.planet
         )
       end
 
@@ -123,7 +124,7 @@ module Skymap
           cx: sun.center.x.round(2),
           cy: sun.center.y.round(2),
           r: sun.radius.round(2),
-          fill: SUN_COLOR
+          fill: @theme.sun
         )
       end
 
@@ -139,26 +140,36 @@ module Skymap
         lit = "M #{top} A #{radius},#{radius} 0 0 1 #{bottom} " \
           "A #{terminator},#{radius} 0 0 #{bulge} #{top} Z"
 
+        theme = @theme
         svg.build do
           g(transform: "rotate(#{moon.rotation.round(2)} #{x} #{y})") do
             circle(
               cx: x,
               cy: y,
               r: radius,
-              fill: MOON_SHADOW_COLOR,
-              fill_opacity: MOON_SHADOW_OPACITY
+              fill: theme.moon_shadow,
+              fill_opacity: theme.moon_shadow_opacity.to_f
             )
-            path(d: lit, fill: MOON_COLOR)
+            path(d: lit, fill: theme.moon)
           end
         end
       end
 
       def draw_label(svg, label)
-        draw_text(svg, label, LABEL_COLOR)
+        draw_text(svg, label, @theme.label)
       end
 
       def draw_caption(svg, caption)
-        draw_text(svg, caption, CAPTION_COLORS.fetch(caption.kind))
+        draw_text(svg, caption, caption_color(caption.kind))
+      end
+
+      def caption_color(kind)
+        case kind
+        when :constellation then @theme.constellation_name
+        when :star then @theme.star_name
+        when :planet then @theme.planet_name
+        else raise ArgumentError, "unknown caption kind: #{kind}"
+        end
       end
 
       def draw_text(svg, label, fill)
@@ -167,7 +178,7 @@ module Skymap
           x: label.position.x.round(2),
           y: label.position.y.round(2),
           font_size: label.size.round(2),
-          font_family: LABEL_FONT,
+          font_family: @theme.font,
           text_anchor: "middle",
           dominant_baseline: "central",
           fill: fill

data/lib/skymap/theme.rb

@@ -0,0 +1,114 @@
+# 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
+    def self.dark
+      new(
+        background: "none",
+        sky: "#000000",
+        horizon: "#3262a8",
+        star: "#ffffff",
+        constellation_line: "#46689c",
+        boundary: "#2b3f5e",
+        ecliptic: "#8c7a3a",
+        planet: "#ffe6b3",
+        sun: "#ffd34d",
+        moon: "#f1ecd6",
+        moon_shadow: "#232a35",
+        moon_shadow_opacity: 0.6,
+        constellation_name: "#6f8fc2",
+        star_name: "#a8b8d0",
+        planet_name: "#ffe6b3",
+        label: "#3262a8",
+        font: "sans-serif"
+      )
+    end
+
+    def self.light
+      new(
+        background: "#ffffff",
+        sky: "#ffffff",
+        horizon: "#1f3f73",
+        star: "#111111",
+        constellation_line: "#5b7bb0",
+        boundary: "#b8c4d9",
+        ecliptic: "#b08d1f",
+        planet: "#c2570c",
+        sun: "#f0a500",
+        moon: "#e8d27a",
+        moon_shadow: "#3b4252",
+        moon_shadow_opacity: 0.35,
+        constellation_name: "#4a679a",
+        star_name: "#3d4a60",
+        planet_name: "#c2570c",
+        label: "#1f3f73",
+        font: "sans-serif"
+      )
+    end
+
+    def self.night
+      new(
+        background: "#000000",
+        sky: "#000000",
+        horizon: "#7a1010",
+        star: "#ff6b6b",
+        constellation_line: "#8a2020",
+        boundary: "#4a1212",
+        ecliptic: "#a33a1a",
+        planet: "#ff9a7a",
+        sun: "#ff8a3d",
+        moon: "#ffb3a0",
+        moon_shadow: "#2a0a0a",
+        moon_shadow_opacity: 0.6,
+        constellation_name: "#c24a4a",
+        star_name: "#e08a8a",
+        planet_name: "#ff9a7a",
+        label: "#7a1010",
+        font: "sans-serif"
+      )
+    end
+
+    def initialize(**slots)
+      slots.except(:moon_shadow_opacity).each do |slot, value|
+        check_text(slot, value)
+      end
+      if slots.key?(:moon_shadow_opacity)
+        check_opacity(slots[:moon_shadow_opacity])
+      end
+
+      super
+    end
+
+    private
+
+    def check_text(slot, value)
+      raise ArgumentError, "#{slot} must be a string" unless value.is_a?(String)
+      raise ArgumentError, "#{slot} must not be blank" if value.strip.empty?
+    end
+
+    def check_opacity(opacity)
+      return if opacity.is_a?(Numeric) && opacity.real? &&
+        opacity.between?(0, 1)
+
+      raise ArgumentError, "moon_shadow_opacity must be between 0 and 1"
+    end
+  end
+end

data/lib/skymap/version.rb

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

data/lib/skymap.rb

@@ -6,6 +6,7 @@ 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/star_names"
 require_relative "skymap/catalog/stars"
 require_relative "skymap/chart"
 require_relative "skymap/constellation_boundary"
@@ -19,6 +20,7 @@ require_relative "skymap/layers/constellation_names"
 require_relative "skymap/layers/ecliptic"
 require_relative "skymap/layers/moon"
 require_relative "skymap/layers/planets"
+require_relative "skymap/layers/star_names"
 require_relative "skymap/layers/stars"
 require_relative "skymap/layers/sun"
 require_relative "skymap/point"
@@ -35,6 +37,7 @@ require_relative "skymap/renderer/sun"
 require_relative "skymap/renderer/svg"
 require_relative "skymap/star"
 require_relative "skymap/star_size"
+require_relative "skymap/theme"
 require_relative "skymap/version"
 
 module Skymap

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skymap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rémy Hannequin
@@ -148,12 +148,14 @@ files:
 - data/constellations/iau/boundaries.csv
 - data/constellations/iau/lines.csv
 - data/constellations/iau/names.csv
+- data/star_names.csv
 - data/stars.csv
 - 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/star_names.rb
 - lib/skymap/catalog/stars.rb
 - lib/skymap/chart.rb
 - lib/skymap/constellation_boundary.rb
@@ -167,6 +169,7 @@ files:
 - lib/skymap/layers/ecliptic.rb
 - lib/skymap/layers/moon.rb
 - lib/skymap/layers/planets.rb
+- lib/skymap/layers/star_names.rb
 - lib/skymap/layers/stars.rb
 - lib/skymap/layers/sun.rb
 - lib/skymap/point.rb
@@ -183,6 +186,7 @@ files:
 - lib/skymap/renderer/svg.rb
 - lib/skymap/star.rb
 - lib/skymap/star_size.rb
+- lib/skymap/theme.rb
 - lib/skymap/version.rb
 homepage: https://github.com/rhannequin/skymap
 licenses: