libspelling 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 ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 9b6e8ad64cd1d77b285a68b4ad6f2d8c0f346c72d30aec64d2d0e90ff2744efd
4
+ data.tar.gz: 7c1a0f664d2933745718c910038d547f23f279f6ac3cf680340ab5e956c7ef1a
5
+ SHA512:
6
+ metadata.gz: f733b2c675bf6e68becd797f1570cbd9effe506b8a02e3e1e27bf19c052d583f41804c31204acacc0cce3cd2d45d5f1f914c6074fdf338e65e5b1b23121eb6b5
7
+ data.tar.gz: '002947f5319210f51299c720da14442e73faeb86097f290ac9a2e57788b528fe20f1c5b232233220860178d830cf1fe700e31a9e10037a9010d32abf0717e7da'
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
+ - `Spelling`, defined from the `Spelling-1` GObject Introspection typelib at
15
+ require time, giving the spell checking GtkSourceView 5 uses. `Spelling::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,49 @@
1
+ Libspelling for Ruby
2
+ Copyright 2026 General Intelligence Systems
3
+
4
+ This product includes software developed by the GNOME Project.
5
+
6
+ --------------------------------------------------------------------------------
7
+ libspelling (the C library)
8
+ --------------------------------------------------------------------------------
9
+
10
+ This gem defines its classes from libspelling-1's GObject Introspection
11
+ typelib, Spelling-1.typelib, which it reads at require time. The spell checking
12
+ is done by that library: it is GNOME Text Editor's and Builder's spell checker.
13
+
14
+ https://gitlab.gnome.org/GNOME/libspelling
15
+ Copyright 2024 Christian Hergert and contributors
16
+ Licensed under the GNU Lesser General Public License, version 2.1 or later
17
+
18
+ This gem is distributed under the Apache License, Version 2.0. It links nothing
19
+ and vendors nothing: the library and its typelib come from the system at run
20
+ time, so a recipient remains free to replace them with their own build. Nothing
21
+ in this repository is derived from libspelling's source -- a typelib is a
22
+ machine-readable description of an interface, and what this gem does with it is
23
+ read it.
24
+
25
+ --------------------------------------------------------------------------------
26
+ enchant, and the dictionaries
27
+ --------------------------------------------------------------------------------
28
+
29
+ libspelling-1 does no spelling itself either. It asks enchant, which asks
30
+ whichever backend the user has installed -- usually hunspell -- and the word
31
+ lists those backends read are packaged separately again, under their own
32
+ licences. None of that is in this repository, and which dictionaries exist on a
33
+ machine is why Spelling::Provider#list_languages has to be asked rather than
34
+ assumed.
35
+
36
+ https://abiword.github.io/enchant/
37
+ Licensed under the GNU Lesser General Public License, version 2.1 or later
38
+
39
+ --------------------------------------------------------------------------------
40
+ ruby-gnome
41
+ --------------------------------------------------------------------------------
42
+
43
+ The loader is GObjectIntrospection::Loader, from ruby-gnome, and is written on
44
+ the model of ruby-gnome's own gtksourceview5 and libsecret loaders. It appears
45
+ here as a gem dependency rather than as copied code.
46
+
47
+ https://github.com/ruby-gnome/ruby-gnome
48
+ Copyright the Ruby-GNOME Project Team
49
+ Licensed under the GNU Lesser General Public License, version 2.1 or later
data/README.md ADDED
@@ -0,0 +1,170 @@
1
+ # libspelling
2
+
3
+ Ruby bindings for [libspelling](https://gitlab.gnome.org/GNOME/libspelling), the
4
+ spell checker GNOME Text Editor and Builder use: a GObject front end over
5
+ enchant, plus the GtkSourceView adapter that underlines misspellings as they
6
+ are typed.
7
+
8
+ ```ruby
9
+ require "libspelling"
10
+
11
+ provider = Spelling::Provider.default
12
+ provider.display_name # => "Enchant"
13
+ provider.default_code # => "en_GB", or nil where enchant found no dictionary
14
+
15
+ checker = Spelling::Checker.default
16
+ checker.check_word("the", -1) # => true (-1 means NUL-terminated)
17
+ checker.list_corrections("teh") # => ["the", ...], or nil with no dictionary
18
+ ```
19
+
20
+ The Ruby namespace is `Spelling`, not `Libspelling`: it is the namespace the
21
+ typelib declares, and only the gem is named after the shared library.
22
+
23
+ None of this needs a display or a main loop. `spelling_init` — which the loader
24
+ calls for you — registers the library's types and its enchant provider and
25
+ touches no `GdkDisplay`, so word lookups work headless and in CI.
26
+ `Spelling::TextBufferAdapter` is the exception, as it wants a real
27
+ `GtkSource::Buffer`: for that, add the
28
+ [gtksourceview5](https://rubygems.org/gems/gtksourceview5) gem and build it
29
+ inside your GTK application.
30
+
31
+ ## How this works, and what it costs to install
32
+
33
+ The library ships a GObject Introspection typelib — `Spelling-1.typelib` —
34
+ describing every class, method, property and signal it has. `Spelling::Loader`
35
+ hands that to ruby-gnome's `GObjectIntrospection::Loader`, which defines the
36
+ Ruby classes from it at `require` time. The loader is thirty lines, most of them
37
+ comment.
38
+
39
+ So this gem is pure Ruby: no extension of its own, no Cargo workspace, no
40
+ per-platform binary. You get the whole library rather than the subset somebody
41
+ got round to wrapping by hand, and it does not drift when libspelling gains API.
42
+
43
+ Be precise about install, though. `gem install libspelling` still compiles C,
44
+ because `gobject-introspection` and `glib2` are themselves native extensions
45
+ built against glib, so a compiler and glib's development headers are needed.
46
+ What *this* gem adds on top is nothing: it has no build step of its own, and
47
+ those two extensions are the ones every ruby-gnome application already has,
48
+ since `gtk4` depends on them.
49
+
50
+ This is how [ruby-gnome](https://github.com/ruby-gnome/ruby-gnome) itself ships
51
+ gtksourceview5, libsecret and the rest.
52
+
53
+ ## The one thing you must install
54
+
55
+ The typelib is a C-library artefact, so it belongs to your distribution and this
56
+ gem cannot install it:
57
+
58
+ | | |
59
+ |---|---|
60
+ | Debian / Ubuntu | `gir1.2-spelling-1` (the library itself is `libspelling-1-2`) |
61
+ | Fedora | `libspelling` |
62
+ | Arch | `libspelling` |
63
+ | nix | `pkgs.libspelling` |
64
+
65
+ `Spelling-1.typelib` names `GtkSource-5`, `Gtk-4.0` and `Gio-2.0`, and the
66
+ loader follows those at require time, so gtksourceview5's and gtk4's typelibs
67
+ have to be installed too — `gir1.2-gtksource-5` and `gir1.2-gtk-4.0` on Debian,
68
+ and the main packages elsewhere. Without them the require fails as
69
+ `Typelib file for namespace 'GtkSource' not found`.
70
+
71
+ If any of it is outside the default search path, point `GI_TYPELIB_PATH` at the
72
+ directories holding the typelibs. The dev shell in `flake.nix` does this.
73
+
74
+ Note the version: libspelling 0.4 ships `Spelling-1.typelib`, with a bare `1`
75
+ where most GNOME libraries would have `1.0`. That is the version string the
76
+ loader passes, and the reason it is worth reading off the installed file rather
77
+ than guessing.
78
+
79
+ **One trap worth knowing.** The typelib must come from the same glib build as
80
+ the `gobject-introspection` gem. Mixing two registers GIO twice in one process
81
+ and fails with `cannot register existing type 'GTlsCertificate'`. Under nix,
82
+ take both from one nixpkgs — and note that glib's typelibs live in its `out`
83
+ output, not the default one.
84
+
85
+ ## Using it from a flake
86
+
87
+ The gem needs `Spelling-1.typelib` and everything that typelib declares, resolved
88
+ transitively by the loader at `require` time. A missing one surfaces as
89
+ `Typelib file for namespace 'X' not found`, one at a time, so the whole chain
90
+ is listed here rather than discovered by repeated failure:
91
+
92
+ - `pkgs.libspelling` — its typelib, which is where `Spelling-1.typelib` lives
93
+ - `pkgs.gtksourceview5` — GtkSource-5
94
+ - `pkgs.gtk4` — Gtk-4.0, and through it Gdk, Gsk and Graphene
95
+ - `pkgs.pango` — Pango-1.0 and PangoCairo-1.0
96
+ - `pkgs.gdk-pixbuf` — GdkPixbuf-2.0
97
+ - `pkgs.graphene` — Graphene-1.0, the viewport maths
98
+ - `pkgs.harfbuzz` — HarfBuzz-0.0
99
+ - `pkgs.gobject-introspection` — its typelib
100
+ - `pkgs.glib` — GLib-2.0, GObject-2.0 and Gio-2.0, which nearly every GNOME typelib declares
101
+
102
+ Note the `.out`: a package's default output is often `bin`, which carries no
103
+ typelibs. `makeSearchPath` takes the first output, so it has to be asked for
104
+ `out` explicitly — this is the single most common way to get a search path that
105
+ looks right and finds nothing.
106
+
107
+ ```nix
108
+ {
109
+ inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
110
+
111
+ outputs = { nixpkgs, ... }:
112
+ let
113
+ system = "x86_64-linux";
114
+ pkgs = nixpkgs.legacyPackages.${system};
115
+
116
+ typelibPath = pkgs.lib.makeSearchPath "lib/girepository-1.0"
117
+ (map (drv: drv.out or drv) [ pkgs.libspelling pkgs.gtksourceview5 pkgs.gtk4 pkgs.pango pkgs.gdk-pixbuf pkgs.graphene pkgs.harfbuzz pkgs.gobject-introspection pkgs.glib ]);
118
+ in
119
+ {
120
+ devShells.${system}.default = pkgs.mkShell {
121
+ packages = [ pkgs.ruby_3_4 pkgs.bundler ] ++ [ pkgs.libspelling pkgs.gtksourceview5 pkgs.gtk4 pkgs.pango pkgs.gdk-pixbuf pkgs.graphene pkgs.harfbuzz pkgs.gobject-introspection pkgs.glib ];
122
+
123
+ shellHook = ''
124
+ export GI_TYPELIB_PATH="${typelibPath}''${GI_TYPELIB_PATH:+:$GI_TYPELIB_PATH}"
125
+ '';
126
+ };
127
+ };
128
+ }
129
+ ```
130
+
131
+ Everything must come from **one** nixpkgs. A typelib built against a different
132
+ glib than the `gobject-introspection` gem registers GIO twice in the process
133
+ and fails with `cannot register existing type 'GTlsCertificate'`.
134
+
135
+ If you are packaging an application rather than entering a shell, the same
136
+ `typelibPath` goes on the wrapper:
137
+
138
+ ```nix
139
+ makeWrapper ${ruby}/bin/ruby $out/bin/my-app \
140
+ --set GI_TYPELIB_PATH "${typelibPath}"
141
+ ```
142
+
143
+ ## Development
144
+
145
+ ```sh
146
+ nix develop
147
+ bin/test
148
+ ```
149
+
150
+ The suite runs headless, which is part of what it checks.
151
+
152
+ ## Releasing
153
+
154
+ ```sh
155
+ gem kit release
156
+ ```
157
+
158
+ That is the whole thing. It gates on the changelog having an entry for this
159
+ version, on no deprecation deadline coming due, and on a clean working tree;
160
+ then builds, pushes and tags.
161
+
162
+ There is nothing to wait for in CI. This gem is pure Ruby, so `gem build`
163
+ produces one `libspelling-X.Y.Z.gem` that is the same artefact wherever it is built —
164
+ no extension, no per-platform gems, nothing for a workflow to hand back.
165
+
166
+
167
+ ## Licence
168
+
169
+ Apache-2.0. libspelling itself is LGPL-2.1-or-later; this gem links nothing and
170
+ copies no libspelling code — it reads a description of it at runtime.
@@ -0,0 +1,69 @@
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 Spelling
7
+ # Defines everything in the Spelling namespace from `Spelling-1.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. libspelling is the first kind.
13
+ #
14
+ # The version string is the typelib's rather than the library's release
15
+ # number, and here the two look nothing alike: libspelling 0.4 ships
16
+ # `Spelling-1.typelib`, so the version is "1" -- not "1.0", which is what
17
+ # most GNOME libraries use and what would fail as `Typelib file for namespace
18
+ # 'Spelling', version '1.0' not found`.
19
+ class Loader < GObjectIntrospection::Loader
20
+ def load
21
+ self.version = "1"
22
+ super("Spelling")
23
+ end
24
+
25
+ private
26
+
27
+ # `spelling_init` has to run before anything else in the library works --
28
+ # its own documentation says "call this function before using any other
29
+ # libspelling functions in your applications" -- so the loader calls it
30
+ # rather than leaving it to the caller, exactly as ruby-gnome's GtkSource
31
+ # loader calls `gtk_source_init`. Skip it and the namespace loads and then
32
+ # hands back nulls.
33
+ #
34
+ # It needs neither a display nor a main loop: it registers the library's
35
+ # types and its enchant provider and touches no GdkDisplay, so requiring
36
+ # this gem is safe headless, in CI and over ssh.
37
+ def pre_load(repository, namespace)
38
+ call_init_function(repository, namespace)
39
+ end
40
+
41
+ def call_init_function(repository, namespace)
42
+ init = repository.find(namespace, "init")
43
+ init.invoke([])
44
+ end
45
+
46
+ # Having called it, do not also define `Spelling.init`: a second call is
47
+ # pointless at best, and this is what ruby-gnome's GtkSource loader does
48
+ # with `gtk_source_init` for the same reason.
49
+ def load_function_info(info)
50
+ case info.name
51
+ when "init"
52
+ # Already called, in pre_load.
53
+ else
54
+ super
55
+ end
56
+ end
57
+
58
+ def post_load(repository, namespace)
59
+ require_libraries
60
+ end
61
+
62
+ def require_libraries
63
+ # Nothing yet. Hand-written Ruby that improves on what the typelib gives
64
+ # -- an each that yields, a to_s, a keyword-argument constructor -- goes
65
+ # in files required from here, which is the convention ruby-gnome uses
66
+ # for exactly that purpose.
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,8 @@
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 Libspelling
7
+ VERSION = "1.0.0"
8
+ end
@@ -0,0 +1,8 @@
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 Libspelling
7
+ VERSION = "<%= version %>"
8
+ end
@@ -0,0 +1,51 @@
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 "libspelling/version"
9
+ require_relative "libspelling/loader"
10
+
11
+ # Ruby bindings for libspelling, spell checking for GtkSourceView 5.
12
+ #
13
+ # libspelling-1 is the C library GNOME Text Editor and Builder spell check
14
+ # with: a GObject front end over enchant carrying dictionary discovery,
15
+ # correction lists, the user's personal word list, and {TextBufferAdapter},
16
+ # which underlines misspellings in a GtkSourceView buffer as they are typed.
17
+ #
18
+ # Nothing here wraps a C function by hand. The library ships a GObject
19
+ # Introspection typelib describing every class, method, property and signal it
20
+ # has, and ruby-gnome's GObjectIntrospection::Loader reads that at require time
21
+ # and defines the Ruby classes from it. {Spelling::Loader} is thirty lines, most
22
+ # of them comment; what you get is the whole library, and it does not drift
23
+ # when libspelling gains API.
24
+ #
25
+ # This is how ruby-gnome itself ships gtksourceview5, libsecret and the rest.
26
+ #
27
+ # The Ruby namespace is `Spelling`, not `Libspelling`: it is the typelib's
28
+ # namespace (`Spelling-1.typelib`), and only the gem is named after the shared
29
+ # library. `Libspelling` holds nothing but {Libspelling::VERSION}.
30
+ #
31
+ # The typelib has to be findable at require time, which means the library's
32
+ # `girepository-1.0` directory on `GI_TYPELIB_PATH` or in the system default --
33
+ # along with the typelibs `Spelling-1` names, which are `GtkSource-5`,
34
+ # `Gtk-4.0` and `Gio-2.0`, and the ones those name in turn. This gem cannot
35
+ # install any of it: it is a C library artefact and belongs to the
36
+ # distribution. See the README for the package name; `flake.nix` wires up a dev
37
+ # shell that has it.
38
+ #
39
+ # One trap, paid for already: the typelib must come from the same glib build as
40
+ # the `gobject-introspection` gem. Mix two and GIO is registered twice in one
41
+ # process, which fails as `cannot register existing type 'GTlsCertificate'`.
42
+ module Spelling
43
+ LOG_DOMAIN = "Spelling"
44
+ GLib::Log.set_log_domain(LOG_DOMAIN)
45
+
46
+ class Error < StandardError
47
+ end
48
+
49
+ loader = Loader.new(self)
50
+ loader.load
51
+ end
metadata ADDED
@@ -0,0 +1,96 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: libspelling
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: 'libspelling for Ruby -- the spell checker GNOME Text Editor and Builder
55
+ use: dictionary discovery, correction lists, the personal word list, and the GtkSourceView
56
+ buffer adapter. Defined from its GObject Introspection typelib at require time rather
57
+ than wrapped by hand, so the binding is the whole library and does not drift as
58
+ it gains API. The Ruby namespace is Spelling.'
59
+ email:
60
+ - nathankidd@hey.com
61
+ executables: []
62
+ extensions: []
63
+ extra_rdoc_files: []
64
+ files:
65
+ - CHANGELOG.md
66
+ - LICENSE
67
+ - NOTICE
68
+ - README.md
69
+ - lib/libspelling.rb
70
+ - lib/libspelling/loader.rb
71
+ - lib/libspelling/version.rb
72
+ - lib/libspelling/version.rb.erb
73
+ homepage: https://github.com/n-at-han-k/libspelling-rb
74
+ licenses:
75
+ - Apache-2.0
76
+ metadata:
77
+ source_code_uri: https://github.com/n-at-han-k/libspelling-rb
78
+ documentation_uri: https://n-at-han-k.github.io/libspelling-rb/
79
+ rdoc_options: []
80
+ require_paths:
81
+ - lib
82
+ required_ruby_version: !ruby/object:Gem::Requirement
83
+ requirements:
84
+ - - ">="
85
+ - !ruby/object:Gem::Version
86
+ version: '3.3'
87
+ required_rubygems_version: !ruby/object:Gem::Requirement
88
+ requirements:
89
+ - - ">="
90
+ - !ruby/object:Gem::Version
91
+ version: '0'
92
+ requirements: []
93
+ rubygems_version: 3.7.2
94
+ specification_version: 4
95
+ summary: Ruby bindings for libspelling, GNOME's spell checker.
96
+ test_files: []