libshumate 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +48 -0
- data/LICENSE +200 -0
- data/NOTICE +61 -0
- data/README.md +166 -0
- data/lib/libshumate/loader.rb +43 -0
- data/lib/libshumate/version.rb +8 -0
- data/lib/libshumate/version.rb.erb +8 -0
- data/lib/libshumate.rb +50 -0
- metadata +94 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 46e6a33e8fbd83db23131b875fa93fa6c6eabcbce7e435a6e8b88ac49b52215f
|
|
4
|
+
data.tar.gz: 1b58fc4dd0f43b9268eb1dc0996e9994716bc9b05546bb07c210a14b6e1f1cac
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 7724133da120da8efa60f9179d3a7ecbc0a1b96acdadd9de22e9680687f8b979b2240aaa514738f33439264a18739a4238abf405c4af7613bb432ea360887c88
|
|
7
|
+
data.tar.gz: 7080bd282833d26499fd300a0b1d15132b41c2e3fa9598762db3fdb5f01d57579e185ddd6116ef9fe94a5535dcd09864dd84a0187fa57223914bf40166b630e1
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project are documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [Unreleased]
|
|
9
|
+
|
|
10
|
+
## [1.0.0] - 2026-11-03
|
|
11
|
+
|
|
12
|
+
### Added
|
|
13
|
+
|
|
14
|
+
- `Shumate`, defined from the `Shumate-1.0` GObject Introspection typelib at
|
|
15
|
+
require time, giving the GTK4 map widget: a tiled map view, markers and layers. `Shumate::Loader` is a
|
|
16
|
+
`GObjectIntrospection::Loader` subclass, so the binding is the whole
|
|
17
|
+
namespace rather than a hand-written subset, and it does not drift as the
|
|
18
|
+
library gains API.
|
|
19
|
+
- A dev shell (`flake.nix`) that pins the library and glib from one nixpkgs and
|
|
20
|
+
puts their typelibs on `GI_TYPELIB_PATH`, and CI that runs the suite inside
|
|
21
|
+
it, because the environment is the hard part of an introspection binding.
|
|
22
|
+
|
|
23
|
+
### Changed
|
|
24
|
+
|
|
25
|
+
- The binding no longer goes through Rust. Earlier revisions wrapped a
|
|
26
|
+
gir-generated crate with magnus, which meant an `ext/` directory, a Cargo
|
|
27
|
+
workspace, system libraries at build time and a nine-platform cross-compile
|
|
28
|
+
matrix, to expose the handful of functions someone had written by hand. The
|
|
29
|
+
typelib loader replaces all of it with about twenty lines of Ruby.
|
|
30
|
+
- The gem is pure Ruby and declares no extensions. Installing it still
|
|
31
|
+
compiles C, because `glib2` and `gobject-introspection` are native
|
|
32
|
+
extensions built against glib — but this gem adds no build step of its own,
|
|
33
|
+
and those two are what every ruby-gnome application already has via `gtk4`.
|
|
34
|
+
- `bin/release-gem` releases one gem. It was built for the Rust model, where a
|
|
35
|
+
release meant a source gem plus one precompiled gem per platform downloaded
|
|
36
|
+
from the Cross Compile workflow; that workflow is gone and there are no
|
|
37
|
+
platform gems, so left alone it aborted before doing anything.
|
|
38
|
+
|
|
39
|
+
### Removed
|
|
40
|
+
|
|
41
|
+
- `ext/`, `Cargo.toml`, `Cargo.lock`, the cross-compile workflow, and the
|
|
42
|
+
`rb_sys` and `rake-compiler` dependencies.
|
|
43
|
+
- `bin/release-gem`. It existed because releasing a Rust gem meant publishing a
|
|
44
|
+
source gem plus one precompiled gem per platform, downloaded from the Cross
|
|
45
|
+
Compile workflow's artifacts. There is nothing to compile here, so there is
|
|
46
|
+
one gem and one push, which is exactly what `gem kit release` does. The
|
|
47
|
+
script added only a check that the local version was ahead of RubyGems, and
|
|
48
|
+
`gem push` already refuses a version that has been pushed.
|
data/LICENSE
ADDED
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to the Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by the Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding any notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. Please also get an
|
|
186
|
+
individualized contributor license agreement from each contributor.
|
|
187
|
+
|
|
188
|
+
Copyright 2026 General Intelligence Systems
|
|
189
|
+
|
|
190
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
191
|
+
you may not use this file except in compliance with the License.
|
|
192
|
+
You may obtain a copy of the License at
|
|
193
|
+
|
|
194
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
195
|
+
|
|
196
|
+
Unless required by applicable law or agreed to in writing, software
|
|
197
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
198
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
199
|
+
See the License for the specific language governing permissions and
|
|
200
|
+
limitations under the License.
|
data/NOTICE
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
Libshumate for Ruby
|
|
2
|
+
Copyright 2026 General Intelligence Systems
|
|
3
|
+
|
|
4
|
+
This product includes software developed by the GNOME Project.
|
|
5
|
+
|
|
6
|
+
--------------------------------------------------------------------------------
|
|
7
|
+
libshumate (the C library)
|
|
8
|
+
--------------------------------------------------------------------------------
|
|
9
|
+
|
|
10
|
+
This gem defines the Shumate namespace from libshumate's GObject Introspection
|
|
11
|
+
typelib, `Shumate-1.0.typelib`, at require time. The code that does the work is
|
|
12
|
+
the C library.
|
|
13
|
+
|
|
14
|
+
https://gitlab.gnome.org/GNOME/libshumate
|
|
15
|
+
Copyright 2008-2026 the libshumate contributors
|
|
16
|
+
Licensed under the GNU Lesser General Public License, version 2.1 or later
|
|
17
|
+
|
|
18
|
+
--------------------------------------------------------------------------------
|
|
19
|
+
Why the LGPL does not reach this gem
|
|
20
|
+
--------------------------------------------------------------------------------
|
|
21
|
+
|
|
22
|
+
This gem is distributed under the Apache License, Version 2.0, and that remains
|
|
23
|
+
true, for a simpler reason than it would need if there were an extension here.
|
|
24
|
+
|
|
25
|
+
There is no extension here. Nothing in this gem compiles against, links, or is
|
|
26
|
+
derived from libshumate. What it contains is a twenty-line loader and the string
|
|
27
|
+
"Shumate". At runtime ruby-gnome's GObjectIntrospection::Loader reads the
|
|
28
|
+
typelib the installing machine already has and defines Ruby classes that call
|
|
29
|
+
into the library through libffi -- so the library is never shipped, never
|
|
30
|
+
bundled, and is always the recipient's own copy, which they can replace at will.
|
|
31
|
+
|
|
32
|
+
Section 6 of the LGPL also requires that this notice say the library is used and
|
|
33
|
+
where to get it, which the section above does.
|
|
34
|
+
|
|
35
|
+
The same holds for the libraries libshumate's typelib depends on, which the
|
|
36
|
+
loader resolves transitively from the same machine: GTK 4, GDK, GSK, Pango,
|
|
37
|
+
GdkPixbuf, HarfBuzz, Graphene and glib.
|
|
38
|
+
|
|
39
|
+
--------------------------------------------------------------------------------
|
|
40
|
+
ruby-gnome
|
|
41
|
+
--------------------------------------------------------------------------------
|
|
42
|
+
|
|
43
|
+
The loader is modelled on ruby-gnome's own, which is how ruby-gnome ships
|
|
44
|
+
gtksourceview5, libsecret and the rest. `gobject-introspection` and `glib2`,
|
|
45
|
+
this gem's runtime dependencies beyond gem_kit, come from that project.
|
|
46
|
+
|
|
47
|
+
https://github.com/ruby-gnome/ruby-gnome
|
|
48
|
+
Copyright 2002-2026 the Ruby-GNOME Project Team
|
|
49
|
+
Licensed under the GNU Lesser General Public License, version 2.1 or later
|
|
50
|
+
|
|
51
|
+
They are depended on as gems, and are neither copied nor modified here.
|
|
52
|
+
|
|
53
|
+
--------------------------------------------------------------------------------
|
|
54
|
+
On the GTK4 widgets
|
|
55
|
+
--------------------------------------------------------------------------------
|
|
56
|
+
|
|
57
|
+
libshumate is mostly GtkWidget subclasses, and all of them are bound, because
|
|
58
|
+
the loader binds whatever the typelib describes rather than whatever somebody
|
|
59
|
+
got round to wrapping by hand. Constructing one still needs what GTK needs, a
|
|
60
|
+
display and a main loop, so the suite exercises the plain GObjects --
|
|
61
|
+
Shumate::Coordinate and Shumate::Viewport -- which need neither.
|
data/README.md
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# libshumate
|
|
2
|
+
|
|
3
|
+
Ruby bindings for libshumate, the GTK4 map widget.
|
|
4
|
+
|
|
5
|
+
```ruby
|
|
6
|
+
require "libshumate"
|
|
7
|
+
|
|
8
|
+
registry = Shumate::MapSourceRegistry.new
|
|
9
|
+
registry.populate_defaults
|
|
10
|
+
|
|
11
|
+
source = registry.get_by_id("osm-mapnik")
|
|
12
|
+
source.name # => "OpenStreetMap Mapnik"
|
|
13
|
+
|
|
14
|
+
viewport = Shumate::Viewport.new
|
|
15
|
+
viewport.reference_map_source = source
|
|
16
|
+
viewport.zoom_level = 12.0
|
|
17
|
+
|
|
18
|
+
Shumate::Coordinate.new(51.5074, -0.1278)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Most of libshumate is `GtkWidget` subclasses — `Shumate::Map`,
|
|
22
|
+
`Shumate::SimpleMap`, `Shumate::Marker` — and those need what any GTK widget
|
|
23
|
+
needs: a display and a main loop. The map sources, the viewport and the
|
|
24
|
+
coordinates above are plain `GObject`s and need neither, which is also why they
|
|
25
|
+
are what the suite exercises.
|
|
26
|
+
|
|
27
|
+
## How this works, and what it costs to install
|
|
28
|
+
|
|
29
|
+
The library ships a GObject Introspection typelib — `Shumate-1.0.typelib` — describing
|
|
30
|
+
every class, method, property and signal it has. `Shumate::Loader`, about twenty
|
|
31
|
+
lines, hands that to ruby-gnome's `GObjectIntrospection::Loader`, which defines
|
|
32
|
+
the Ruby classes from it at `require` time.
|
|
33
|
+
|
|
34
|
+
So this gem is pure Ruby: no extension of its own, no Cargo workspace, no
|
|
35
|
+
per-platform binary. You get the whole library rather than the subset somebody
|
|
36
|
+
got round to wrapping by hand, and it does not drift when the library gains API.
|
|
37
|
+
|
|
38
|
+
Be precise about install, though: `gem install libshumate` still compiles C, because
|
|
39
|
+
`gobject-introspection` and `glib2` are themselves native extensions built
|
|
40
|
+
against glib, so a compiler and glib's development headers are needed. What
|
|
41
|
+
this gem adds on top is nothing — those two are what every ruby-gnome
|
|
42
|
+
application already has, since `gtk4` depends on them.
|
|
43
|
+
|
|
44
|
+
## Using it with the gtk4 gem
|
|
45
|
+
|
|
46
|
+
Put `require "gtk4"` before `require "libshumate"` in an application.
|
|
47
|
+
|
|
48
|
+
The loader defines whatever the typelib describes, and `Shumate-1.0.typelib`
|
|
49
|
+
declares `Gtk-4.0`, `Gsk-4.0` and `Gdk-4.0` as dependencies. So if nothing has
|
|
50
|
+
loaded GTK yet, this gem's loader resolves those typelibs itself and
|
|
51
|
+
`Shumate::Map.ancestors` comes out as `[Shumate::Map, GtkWidget,
|
|
52
|
+
GtkConstraintTarget, ...]` — classes defined straight off the typelib, not the
|
|
53
|
+
`Gtk::Widget` the `gtk4` gem defines with its hand-written overrides on top. A
|
|
54
|
+
`Shumate::Map` from that load cannot be packed into a `Gtk::Box`.
|
|
55
|
+
|
|
56
|
+
Requiring `gtk4` first makes the real `Gtk` namespace the one already in the
|
|
57
|
+
registry, and Shumate's widgets land under it. This gem does not depend on the
|
|
58
|
+
`gtk4` gem, because the namespace loads and is useful without it — the sources,
|
|
59
|
+
viewport and coordinates above work on `gobject-introspection` alone — and
|
|
60
|
+
depending on `gtk4` would pull all of GTK onto anyone who only wanted those.
|
|
61
|
+
The ordering is the cost of that choice.
|
|
62
|
+
|
|
63
|
+
## The one thing you must install
|
|
64
|
+
|
|
65
|
+
The typelib is a C-library artefact, so it belongs to your distribution and
|
|
66
|
+
this gem cannot install it:
|
|
67
|
+
|
|
68
|
+
| | |
|
|
69
|
+
|---|---|
|
|
70
|
+
| Debian / Ubuntu | `gir1.2-shumate-1.0` |
|
|
71
|
+
| Fedora | `libshumate` |
|
|
72
|
+
| Arch | `libshumate` |
|
|
73
|
+
| nix | `pkgs.libshumate` |
|
|
74
|
+
|
|
75
|
+
If it is not in the default search path, point `GI_TYPELIB_PATH` at the
|
|
76
|
+
directory holding `Shumate-1.0.typelib`. The dev shell in `flake.nix` does this.
|
|
77
|
+
|
|
78
|
+
**One trap worth knowing.** The typelib must come from the same glib build as
|
|
79
|
+
the `gobject-introspection` gem. Mixing two registers GIO twice in one process
|
|
80
|
+
and fails with `cannot register existing type 'GTlsCertificate'`. Under nix,
|
|
81
|
+
take both from one nixpkgs — and note that glib's typelibs live in its `out`
|
|
82
|
+
output, not the default one.
|
|
83
|
+
|
|
84
|
+
## Using it from a flake
|
|
85
|
+
|
|
86
|
+
The gem needs `Shumate-1.0.typelib` and everything that typelib declares, resolved
|
|
87
|
+
transitively by the loader at `require` time. A missing one surfaces as
|
|
88
|
+
`Typelib file for namespace 'X' not found`, one at a time, so the whole chain
|
|
89
|
+
is listed here rather than discovered by repeated failure:
|
|
90
|
+
|
|
91
|
+
- `pkgs.libshumate` — its typelib, which is where `Shumate-1.0.typelib` lives
|
|
92
|
+
- `pkgs.gtk4` — Gtk-4.0, and through it Gdk, Gsk and Graphene
|
|
93
|
+
- `pkgs.graphene` — Graphene-1.0, the viewport maths
|
|
94
|
+
- `pkgs.pango` — Pango-1.0 and PangoCairo-1.0
|
|
95
|
+
- `pkgs.cairo` — cairo-1.0
|
|
96
|
+
- `pkgs.gdk-pixbuf` — GdkPixbuf-2.0
|
|
97
|
+
- `pkgs.harfbuzz` — HarfBuzz-0.0
|
|
98
|
+
- `pkgs.glib` — GLib-2.0, GObject-2.0 and Gio-2.0, which nearly every GNOME typelib declares
|
|
99
|
+
|
|
100
|
+
Note the `.out`: a package's default output is often `bin`, which carries no
|
|
101
|
+
typelibs. `makeSearchPath` takes the first output, so it has to be asked for
|
|
102
|
+
`out` explicitly — this is the single most common way to get a search path that
|
|
103
|
+
looks right and finds nothing.
|
|
104
|
+
|
|
105
|
+
```nix
|
|
106
|
+
{
|
|
107
|
+
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
|
108
|
+
|
|
109
|
+
outputs = { nixpkgs, ... }:
|
|
110
|
+
let
|
|
111
|
+
system = "x86_64-linux";
|
|
112
|
+
pkgs = nixpkgs.legacyPackages.${system};
|
|
113
|
+
|
|
114
|
+
typelibPath = pkgs.lib.makeSearchPath "lib/girepository-1.0"
|
|
115
|
+
(map (drv: drv.out or drv) [ pkgs.libshumate pkgs.gtk4 pkgs.graphene pkgs.pango pkgs.cairo pkgs.gdk-pixbuf pkgs.harfbuzz pkgs.glib ]);
|
|
116
|
+
in
|
|
117
|
+
{
|
|
118
|
+
devShells.${system}.default = pkgs.mkShell {
|
|
119
|
+
packages = [ pkgs.ruby_3_4 pkgs.bundler ] ++ [ pkgs.libshumate pkgs.gtk4 pkgs.graphene pkgs.pango pkgs.cairo pkgs.gdk-pixbuf pkgs.harfbuzz pkgs.glib ];
|
|
120
|
+
|
|
121
|
+
shellHook = ''
|
|
122
|
+
export GI_TYPELIB_PATH="${typelibPath}''${GI_TYPELIB_PATH:+:$GI_TYPELIB_PATH}"
|
|
123
|
+
'';
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Everything must come from **one** nixpkgs. A typelib built against a different
|
|
130
|
+
glib than the `gobject-introspection` gem registers GIO twice in the process
|
|
131
|
+
and fails with `cannot register existing type 'GTlsCertificate'`.
|
|
132
|
+
|
|
133
|
+
If you are packaging an application rather than entering a shell, the same
|
|
134
|
+
`typelibPath` goes on the wrapper:
|
|
135
|
+
|
|
136
|
+
```nix
|
|
137
|
+
makeWrapper ${ruby}/bin/ruby $out/bin/my-app \
|
|
138
|
+
--set GI_TYPELIB_PATH "${typelibPath}"
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Development
|
|
142
|
+
|
|
143
|
+
```sh
|
|
144
|
+
nix develop
|
|
145
|
+
bin/test
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Releasing
|
|
149
|
+
|
|
150
|
+
```sh
|
|
151
|
+
gem kit release
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
That is the whole thing. It gates on the changelog having an entry for this
|
|
155
|
+
version, on no deprecation deadline coming due, and on a clean working tree;
|
|
156
|
+
then builds, pushes and tags.
|
|
157
|
+
|
|
158
|
+
There is nothing to wait for in CI. This gem is pure Ruby, so `gem build`
|
|
159
|
+
produces one `libshumate-X.Y.Z.gem` that is the same artefact wherever it is built —
|
|
160
|
+
no extension, no per-platform gems, nothing for a workflow to hand back.
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
## Licence
|
|
164
|
+
|
|
165
|
+
Apache-2.0. The library itself keeps its own licence; this gem links nothing
|
|
166
|
+
and copies no code from it — it reads a description of it at runtime.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Released under the Apache License, Version 2.0.
|
|
4
|
+
# Copyright, 2026, by General Intelligence Systems.
|
|
5
|
+
|
|
6
|
+
module Shumate
|
|
7
|
+
# Defines everything in the Shumate namespace from `Shumate-1.0.typelib`.
|
|
8
|
+
#
|
|
9
|
+
# Modelled on ruby-gnome's own loaders -- see
|
|
10
|
+
# gtksourceview5/lib/gtksourceview5/loader.rb for one that has to call the
|
|
11
|
+
# library's init function first, and libsecret/lib/libsecret/loader.rb for
|
|
12
|
+
# one that does not.
|
|
13
|
+
#
|
|
14
|
+
# The version string is the typelib's rather than the library's release
|
|
15
|
+
# number, and the two often differ: this one is "1.0", from
|
|
16
|
+
# `Shumate-1.0.typelib`.
|
|
17
|
+
class Loader < GObjectIntrospection::Loader
|
|
18
|
+
def load
|
|
19
|
+
self.version = "1.0"
|
|
20
|
+
super("Shumate")
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
private
|
|
24
|
+
|
|
25
|
+
# There is no `pre_load` hook here because libshumate has no init function
|
|
26
|
+
# to call: `Shumate-1.0.typelib` declares none. GtkSource's loader has to
|
|
27
|
+
# invoke `gtk_source_init` before anything in that namespace works;
|
|
28
|
+
# Secret's, like this one, does not. Skipping an init a library *does* need
|
|
29
|
+
# gives a namespace that loads and then returns nulls or segfaults, so this
|
|
30
|
+
# was checked against the typelib rather than assumed.
|
|
31
|
+
|
|
32
|
+
def post_load(repository, namespace)
|
|
33
|
+
require_libraries
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def require_libraries
|
|
37
|
+
# Nothing yet. Hand-written Ruby that improves on what the typelib gives
|
|
38
|
+
# -- an each that yields, a to_s, a keyword-argument constructor -- goes
|
|
39
|
+
# in files required from here, which is the convention ruby-gnome uses
|
|
40
|
+
# for exactly that purpose.
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
data/lib/libshumate.rb
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# Released under the Apache License, Version 2.0.
|
|
4
|
+
# Copyright, 2026, by General Intelligence Systems.
|
|
5
|
+
|
|
6
|
+
require "gobject-introspection"
|
|
7
|
+
|
|
8
|
+
require_relative "libshumate/version"
|
|
9
|
+
require_relative "libshumate/loader"
|
|
10
|
+
|
|
11
|
+
# Ruby bindings for libshumate, the GTK4 map widget.
|
|
12
|
+
#
|
|
13
|
+
# Nothing here wraps a C function by hand. The library ships a GObject
|
|
14
|
+
# Introspection typelib describing every class, method, property and signal it
|
|
15
|
+
# has, and ruby-gnome's GObjectIntrospection::Loader reads that at require time
|
|
16
|
+
# and defines the Ruby classes from it. {Shumate::Loader} is about twenty lines;
|
|
17
|
+
# what you get is the whole library, and it does not drift when the library
|
|
18
|
+
# gains API.
|
|
19
|
+
#
|
|
20
|
+
# This is how ruby-gnome itself ships gtksourceview5, libsecret and the rest.
|
|
21
|
+
#
|
|
22
|
+
# The typelib has to be findable at require time, which means the library's
|
|
23
|
+
# `girepository-1.0` directory on `GI_TYPELIB_PATH` or in the system default.
|
|
24
|
+
# This gem cannot install it -- it is a C library artefact and belongs to the
|
|
25
|
+
# distribution. See the README for the package name; `flake.nix` wires up a dev
|
|
26
|
+
# shell that has it.
|
|
27
|
+
#
|
|
28
|
+
# In an application, `require "gtk4"` before this. `Shumate-1.0.typelib`
|
|
29
|
+
# declares Gtk-4.0, Gsk-4.0 and Gdk-4.0 as dependencies, so if nothing has
|
|
30
|
+
# loaded GTK yet this loader resolves those typelibs itself and Shumate's
|
|
31
|
+
# widgets end up descending from a bare `GtkWidget` defined off the typelib
|
|
32
|
+
# rather than from the `Gtk::Widget` the gtk4 gem defines -- which means they
|
|
33
|
+
# cannot be packed into a `Gtk::Box`. gtk4 is not a dependency of this gem
|
|
34
|
+
# because the namespace is useful without it (map sources, viewports and
|
|
35
|
+
# coordinates are plain GObjects), so the ordering is on the caller. See the
|
|
36
|
+
# README.
|
|
37
|
+
#
|
|
38
|
+
# One trap, paid for already: the typelib must come from the same glib build as
|
|
39
|
+
# the `gobject-introspection` gem. Mix two and GIO is registered twice in one
|
|
40
|
+
# process, which fails as `cannot register existing type 'GTlsCertificate'`.
|
|
41
|
+
module Shumate
|
|
42
|
+
LOG_DOMAIN = "Shumate"
|
|
43
|
+
GLib::Log.set_log_domain(LOG_DOMAIN)
|
|
44
|
+
|
|
45
|
+
class Error < StandardError
|
|
46
|
+
end
|
|
47
|
+
|
|
48
|
+
loader = Loader.new(self)
|
|
49
|
+
loader.load
|
|
50
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: libshumate
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Nathan Kidd
|
|
8
|
+
bindir: bin
|
|
9
|
+
cert_chain: []
|
|
10
|
+
date: 1980-01-01 00:00:00.000000000 Z
|
|
11
|
+
dependencies:
|
|
12
|
+
- !ruby/object:Gem::Dependency
|
|
13
|
+
name: gem_kit
|
|
14
|
+
requirement: !ruby/object:Gem::Requirement
|
|
15
|
+
requirements:
|
|
16
|
+
- - "~>"
|
|
17
|
+
- !ruby/object:Gem::Version
|
|
18
|
+
version: '0.2'
|
|
19
|
+
type: :runtime
|
|
20
|
+
prerelease: false
|
|
21
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
22
|
+
requirements:
|
|
23
|
+
- - "~>"
|
|
24
|
+
- !ruby/object:Gem::Version
|
|
25
|
+
version: '0.2'
|
|
26
|
+
- !ruby/object:Gem::Dependency
|
|
27
|
+
name: gobject-introspection
|
|
28
|
+
requirement: !ruby/object:Gem::Requirement
|
|
29
|
+
requirements:
|
|
30
|
+
- - "~>"
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '4.3'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
36
|
+
requirements:
|
|
37
|
+
- - "~>"
|
|
38
|
+
- !ruby/object:Gem::Version
|
|
39
|
+
version: '4.3'
|
|
40
|
+
- !ruby/object:Gem::Dependency
|
|
41
|
+
name: lefthook
|
|
42
|
+
requirement: !ruby/object:Gem::Requirement
|
|
43
|
+
requirements:
|
|
44
|
+
- - "~>"
|
|
45
|
+
- !ruby/object:Gem::Version
|
|
46
|
+
version: '2.2'
|
|
47
|
+
type: :development
|
|
48
|
+
prerelease: false
|
|
49
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
50
|
+
requirements:
|
|
51
|
+
- - "~>"
|
|
52
|
+
- !ruby/object:Gem::Version
|
|
53
|
+
version: '2.2'
|
|
54
|
+
description: Libshumate, the GTK4 map widget, for Ruby. Defined from its GObject Introspection
|
|
55
|
+
typelib at require time rather than wrapped by hand, so the binding is the whole
|
|
56
|
+
library and does not drift as it gains API.
|
|
57
|
+
email:
|
|
58
|
+
- nathankidd@hey.com
|
|
59
|
+
executables: []
|
|
60
|
+
extensions: []
|
|
61
|
+
extra_rdoc_files: []
|
|
62
|
+
files:
|
|
63
|
+
- CHANGELOG.md
|
|
64
|
+
- LICENSE
|
|
65
|
+
- NOTICE
|
|
66
|
+
- README.md
|
|
67
|
+
- lib/libshumate.rb
|
|
68
|
+
- lib/libshumate/loader.rb
|
|
69
|
+
- lib/libshumate/version.rb
|
|
70
|
+
- lib/libshumate/version.rb.erb
|
|
71
|
+
homepage: https://github.com/n-at-han-k/libshumate-rb
|
|
72
|
+
licenses:
|
|
73
|
+
- Apache-2.0
|
|
74
|
+
metadata:
|
|
75
|
+
source_code_uri: https://github.com/n-at-han-k/libshumate-rb
|
|
76
|
+
documentation_uri: https://n-at-han-k.github.io/libshumate-rb/
|
|
77
|
+
rdoc_options: []
|
|
78
|
+
require_paths:
|
|
79
|
+
- lib
|
|
80
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
81
|
+
requirements:
|
|
82
|
+
- - ">="
|
|
83
|
+
- !ruby/object:Gem::Version
|
|
84
|
+
version: '3.3'
|
|
85
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - ">="
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '0'
|
|
90
|
+
requirements: []
|
|
91
|
+
rubygems_version: 3.7.2
|
|
92
|
+
specification_version: 4
|
|
93
|
+
summary: Ruby bindings for libshumate, the GTK4 map widget.
|
|
94
|
+
test_files: []
|