auto_glossary 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fddd93fba68c2b99a3ea1e2017393b053f0341ec1ee68815bd90afaf23166ea0
-  data.tar.gz: 4bb4aeb3e1752b1cc3965229586785ca91b49ccbe994b3db665fd42fd40c074d
+  metadata.gz: 813e962b2d5958e1ee0c7cb5bd6413f26c02642af914e5fce89ec950e8954f57
+  data.tar.gz: 8121ec42733161e0487e0062db1e28f73e75b47abc17d9b0dd8e61197bc1408d
 SHA512:
-  metadata.gz: ece9e23d884a593aa881e15be743d2eb9293dac1b1ab3576410036c10b3704c903d42fb9cde3d751ddd198162aeb7e93a0b2f4bac8d6794d1a73616b809de31f
-  data.tar.gz: c9bcd7372a7216cb60309e2a6e658619bf6472d2f49e8450a2283214963a5c2a82d5bc64a69df736eb034c69fd8c47e632c8190189ab22ba012726dddcd02a69
+  metadata.gz: a0e445b98e5e3c7c1b6e1a544cbd4a5bfde53c79dba364033f1e12d5688860ff404ec635f26c3c3a0f8fa802f381be43aa194f9b03ad0045d7d2d218c7bd59c8
+  data.tar.gz: b01082634e8538b6cf02d425006119a5c16b55d158060507830fcf111187da0fc9f7dade38a2886bda104259ddb512f229bc72297243fbe89d0aeb4e61e05bed

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-02-19
+
+### Added
+- Initial release of Auto-Glossary gem
+- Wikipedia glossary term fetching and caching
+- Automatic term highlighting in Rails views
+- Hover tooltips with term definitions
+- Click-through modals for full definitions
+- Rails Engine architecture for easy integration
+- Install generator for quick setup
+- Smart plural and variation handling
+- Accessible keyboard navigation
+- Responsive design for all devices
+- API endpoint for term definitions
+- Stimulus JavaScript controller
+- Complete documentation and examples
+
+[0.1.0]: https://github.com/mrdbidwill/auto-glossary/releases/tag/v0.1.0

data/README.md

@@ -1,35 +1,148 @@
-# AutoGlossary
+# Auto-Glossary
 
-TODO: Delete this and the text below, and describe your gem
+Automatically highlight and define technical terms from Wikipedia glossaries in your Rails applications.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/auto_glossary`. To experiment with that code, run `bin/console` for an interactive prompt.
+## What It Does
+
+Auto-Glossary identifies technical terms in your content and provides instant definitions from Wikipedia. Perfect for educational websites, scientific documentation, and technical blogs.
+
+**Example:**
+
+```
+The basidiospores are produced by the basidium on the hymenium surface of the pileus.
+```
+
+With Auto-Glossary, each technical term becomes interactive with:
+- **Hover tooltips** - Quick definition preview
+- **Click modals** - Full definition with Wikipedia attribution
+- **Smart matching** - Handles plurals and variations automatically
+
+## Demo
+
+Visit [auto-glossary.com](https://auto-glossary.com/demo) to see it in action!
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'auto_glossary'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+Then execute:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle install
+```
+
+Or install it yourself:
+
+```bash
+gem install auto_glossary
+```
+
+## Quick Start
+
+### 1. Run the installer
+
+```bash
+rails generate auto_glossary:install
+```
+
+This will:
+- Mount the engine routes
+- Copy the Stimulus JavaScript controller
+- Show you the next steps
+
+### 2. Add stylesheet to your layout
+
+In `app/views/layouts/application.html.erb`, add:
+
+```erb
+<%= stylesheet_link_tag 'glossary', 'data-turbo-track': 'reload' %>
+```
+
+### 3. Add Stimulus controller to body tag
+
+```erb
+<body data-controller="glossary">
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+### 4. Use in your views
+
+```erb
+<%= mark_glossary_terms(@article.body) %>
+```
+
+### 5. Restart your Rails server
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+rails server
 ```
 
-## Usage
+Done! Technical terms will now be automatically highlighted with hover tooltips and click-through definitions.
+
+## Usage Examples
 
-TODO: Write usage instructions here
+### Basic Usage
 
-## Development
+```erb
+<%= mark_glossary_terms(@text) %>
+```
+
+### Mark Only First Occurrence
+
+```erb
+<%= mark_glossary_terms(@text, first_only: true) %>
+```
+
+### Mark All Occurrences
+
+```erb
+<%= mark_glossary_terms(@text, first_only: false) %>
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Browse All Terms
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Visit `/glossary` in your app to see all available glossary terms and definitions.
+
+## Features
+
+- ⚡ **Fast** - Aggressive caching (24 hours), minimal performance impact
+- 🎯 **Smart** - Handles plurals, variations, and edge cases automatically
+- 📱 **Responsive** - Beautiful tooltips and modals on all devices
+- ♿ **Accessible** - Full keyboard navigation and screen reader support
+- 🔌 **No Database Required** - Uses Rails.cache and Wikipedia API
+- ⚖️ **Open Source** - MIT licensed
+
+## How It Works
+
+1. Fetches glossary terms from Wikipedia's "Glossary of Mycology"
+2. Caches terms for 24 hours
+3. Marks terms in your text with special HTML
+4. JavaScript handles tooltips and modals
+5. Definitions loaded on-demand from Wikipedia
+
+## Configuration
+
+The gem uses the [Glossary of Mycology](https://en.wikipedia.org/wiki/Glossary_of_mycology) by default. To use a different Wikipedia glossary, override the `GLOSSARY_PAGE` constant in `WikipediaGlossaryService`.
+
+## Requirements
+
+- Rails 7.0 or higher
+- Ruby 3.2 or higher
+- Stimulus JS (included in Rails 7+)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/auto_glossary.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrdbidwill/auto-glossary
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+- Built by [Will Johnston](https://github.com/mrdbidwill)
+- Powered by [Wikipedia's Glossary of Mycology](https://en.wikipedia.org/wiki/Glossary_of_mycology) (CC BY-SA 4.0)
+- Demo site: [auto-glossary.com](https://auto-glossary.com)

data/app/controllers/auto_glossary/glossary_controller.rb

@@ -3,6 +3,7 @@
 module AutoGlossary
   class GlossaryController < ApplicationController
     skip_before_action :verify_authenticity_token, only: [:definition]
+    skip_before_action :authenticate_user!, raise: false if respond_to?(:authenticate_user!)
 
     # GET /glossary/definition?term=basidiospore
     def definition

data/lib/auto_glossary/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AutoGlossary
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auto_glossary
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Will Johnston
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - Rakefile