webring-rails 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b6068bf5f22b55c8e30fe5499cbafb35ac14bd888343fa43b130d8efc04f6e6
-  data.tar.gz: b38877901600d82768c718481768236f2b11a892e2a1906c1e5bae2c56763374
+  metadata.gz: 85902566f8117884214215614a8dc3b89c0065d797fb0c4ab2863e4af823185b
+  data.tar.gz: 0c783b549c5e21ad829677d17d6413a083bed29b47b3dc75eacf08dd6ec205b8
 SHA512:
-  metadata.gz: 883bea826f837c1b7e4a3fe6279a218bfb2741bc0617f0c3a8617eec2b72c3b05b23e3ace09429b35e7a1561ac0505cf612a7c574d45bc2291832e9c02c063d0
-  data.tar.gz: 617bd8e61c560dd586ed445f0e3fb0c27a615dc4503bf2dc2436f0567cb3c17d4990c0f2d225ae7030ac7f40d1bc0f51115d0832fbd36ca63abad60f1a1718ac
+  metadata.gz: 9f7df96b07dcbacf10d092ffd1a9c3419c2a096517ae1986b1a13970fa3bb85114aff19bb05b6e9002ee87d9710201569c16254a0fbcf8ca31936938ad6b19de
+  data.tar.gz: 076dbbe45eacad535ae1940e229c6fc2abfa94f7afcea0f13aee58b437a62bfdb445e120dc090748f34960f8d09eca45fd8f9cbd8fc2ec94f6755f9a90757fac

data/README.md

@@ -4,71 +4,19 @@
 
 Webring for Rails (webring_rails) is a flexible engine for creating and managing a webring system in your Ruby on Rails application. A webring is a collection of websites linked together in a circular structure, allowing visitors to navigate from one site to another.
 
-## Table of Contents
-
-- [Features](#features)
-- [Requirements](#requirements)
-- [Installation](#installation)
-  - [Quick Start](#quick-start)
-  - [Manual Setup](#manual-setup)
-  - [Configuration Options](#configuration-options)
-  - [Setting Up Your Host Application](#setting-up-your-host-application)
-- [Usage](#usage)
-  - [Generators](#generators)
-    - [Installation Generator](#installation-generator)
-    - [Member Model Generator](#member-model-generator)
-    - [Navigation Controller Generator](#navigation-controller-generator)
-  - [Basic Implementation](#basic-implementation)
-  - [Customizing Your Webring](#customizing-your-webring)
-- [Models](#models)
-  - [Webring::Member](#webringmember)
-- [Modules](#modules)
-  - [Webring::Navigation](#webringnavigation)
-    - [Key Features](#key-features)
-    - [Available Methods](#available-methods)
-    - [Usage in Models](#usage-in-models)
-    - [Implementation Example](#implementation-example)
-    - [Customizing Navigation Behavior](#customizing-navigation-behavior)
-- [Controllers](#controllers)
-  - [Webring::NavigationController](#webringnavigationcontroller)
-    - [How to Use the Navigation Controller](#how-to-use-the-navigation-controller)
-    - [Customizing Navigation Behavior](#customizing-navigation-behavior-1)
-  - [Webring::MembersController](#webringmemberscontroller)
-- [Widget](#widget)
-  - [Webring::WidgetController](#webringwidgetcontroller)
-  - [Widget.js](#widgetjs)
-    - [How to Use the Widget](#how-to-use-the-widget)
-    - [Widget Customization Options](#widget-customization-options)
-    - [Example With All Options](#example-with-all-options)
-    - [Multiple Widgets on the Same Page](#multiple-widgets-on-the-same-page)
-- [Development](#development)
-  - [Migrations](#migrations)
-  - [Testing](#testing)
-- [Contributing](#contributing)
-- [License](#license)
-
 ## Features
 
-Webring for Rails provides the following features:
-
 - Complete MVC structure for managing webring members
 - Circular navigation system between member websites
 - UID-based member identification for security
 - Embeddable JavaScript widget for easy member site integration
 - Customizable widget appearance and behavior
+- Optional membership request system for sites to apply to join the webring
 - Generators for easy setup and customization
 - Extensible architecture for adding custom features
 
-## Requirements
-
-- Ruby 2.7.0 or later
-- Rails 6.0 or later
-- ActiveRecord-compatible database (MySQL, PostgreSQL, SQLite)
-
 ## Installation
 
-### Quick Start
-
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -88,510 +36,28 @@ rails generate webring:install
 rails generate webring:member
 
 # Create the navigation controller
-rails generate webring:controller
-
-# Run migrations
-rails db:migrate
-```
-
-### Manual Setup
-
-If you prefer to set things up step by step:
-
-1. Add the gem to your Gemfile:
-
-```ruby
-gem 'webring_rails'
-```
-
-2. Install the gem:
-
-```bash
-bundle install
-```
-
-3. Mount the engine in your routes:
-
-```ruby
-# config/routes.rb
-Rails.application.routes.draw do
-  mount Webring::Engine => "/webring"
-
-  # Your other routes...
-end
+rails generate webring:controller:navigation
 ```
 
-4. Create necessary migrations:
+### Optional Features
 
 ```bash
-rails generate migration CreateWebringMembers uid:string name:string url:string
-```
-
-5. Configure your migration:
-
-```ruby
-class CreateWebringMembers < ActiveRecord::Migration[6.0]
-  def change
-    create_table :webring_members do |t|
-      t.string :uid, null: false, index: { unique: true }
-      t.string :name, null: false, index: { unique: true }
-      t.string :url, null: false, index: { unique: true }
+# Enable the membership request system
+rails generate webring:membership_request
 
-      t.timestamps
-    end
-  end
-end
+# Add membership request controller and routes
+rails generate webring:controller:membership_requests
 ```
 
-6. Run migrations:
+Finally, run the migrations:
 
 ```bash
 rails db:migrate
 ```
 
-### Configuration Options
-
-You can configure the webring engine by creating an initializer:
-
-```ruby
-# config/initializers/webring.rb
-Webring.setup do |config|
-  # Set the primary key type (uuid recommended for production)
-  config.primary_key_type = :uuid
-end
-```
-
-### Setting Up Your Host Application
-
-To properly integrate the webring in your host application:
-
-1. Set up default URL options for mailers in each environment:
-
-```ruby
-# config/environments/development.rb
-config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
-```
-
-2. Add root route in your application:
-
-```ruby
-# config/routes.rb
-root to: 'home#index'
-```
-
-## Usage
-
-### Generators
-
-WebringRails provides several generators to help you set up webring functionality in your application.
-
-> [!IMPORTANT]
-> Make sure to run the generators in the order listed below for the best setup experience.
-
-#### Installation Generator
-
-```bash
-rails generate webring:install
-```
-
-This generator:
-- Mounts the Webring engine in your routes.rb
-
-#### Member Model Generator
-
-```bash
-rails generate webring:member
-```
-
-This generator:
-- Creates the Webring::Member model with uid, name and url fields
-- Creates a migration for the members table
-- Adds member routes to your routes.rb file
-
-#### Navigation Controller Generator
-
-```bash
-rails generate webring:controller
-```
-
-This generator:
-- Creates the Webring::NavigationController with '/next', '/previous', and '/random' actions
-- Adds navigation routes to your routes.rb file
-
-### Basic Implementation
-
-After setting up the gem, you'll need to add members to your webring:
-
-```ruby
-# Through the console or in a seed file
-Webring::Member.create(name: "My Awesome Site", url: "https://myawesomesite.com")
-Webring::Member.create(name: "Another Cool Site", url: "https://anothercoolsite.com")
-```
-
-### Customizing Your Webring
-
-You can customize various aspects of your webring:
-
-1. Create custom views:
-
-```bash
-rails generate webring:views
-```
-
-2. Create a custom navigation controller:
-
-```ruby
-# app/controllers/custom_navigation_controller.rb
-class CustomNavigationController < Webring::NavigationController
-  def next
-    # Your custom implementation
-    super
-  end
-end
-
-# config/routes.rb
-get 'webring/next', to: 'custom_navigation#next'
-```
-
-## Models
-
-### Webring::Member
-
-> [!NOTE]
-> The Member model is the core component of your webring, representing each site in the ring.
-
-The Member model includes:
-
-- Validations for presence and uniqueness of `url`, uniqueness of `name`, and presence and uniqueness of `uid`
-- Automatic generation of unique UID (32-character hex string) for each member
-- Automatic population of `name` from `url` if name is not provided
-- Navigation methods for finding next, previous, and random members:
-  - `find_next(source_member_uid)` - Finds the next member after the given UID
-  - `find_previous(source_member_uid)` - Finds the previous member before the given UID
-  - `find_random(source_member_uid: nil)` - Finds a random member, excluding the source member
-
-#### Example Usage
-
-```ruby
-# Creating a new member
-member = Webring::Member.create(url: "https://example.com", name: "Example Site")
-
-# Finding the next member
-next_member = Webring::Member.find_next(member.uid)
-
-# Finding the previous member
-prev_member = Webring::Member.find_previous(member.uid)
-
-# Finding a random member (excluding the current one)
-random_member = Webring::Member.find_random(source_member_uid: member.uid)
-```
-
-## Modules
-
-### Webring::Navigation
-
-> [!TIP]
-> The Navigation module is designed to be highly extensible. You can easily override its methods to customize the navigation behavior for your specific needs.
-
-The Navigation module provides methods for navigating through members in a webring pattern. It's designed to be extended by models that act as webring members.
-
-#### Key Features
-
-- **Webring-style navigation**: Implements the circular navigation pattern typical of webrings
-- **UID-based member identification**: Uses unique identifiers instead of numeric IDs for security
-- **Creation time ordering**: Uses `created_at` timestamps to determine the sequence of members
-- **Edge case handling**: Properly handles wraparound at the beginning and end of the ring
-
-#### Available Methods
-
-The module provides three core methods:
-
-- `find_next(source_member_uid)`: Finds the next member in the ring after the specified member
-  - If the source member is the last in the ring, it returns the first member
-  - Uses creation time for navigation ordering
-
-- `find_previous(source_member_uid)`: Finds the previous member in the ring before the specified member
-  - If the source member is the first in the ring, it returns the last member
-  - Uses creation time for navigation ordering
-
-- `find_random(source_member_uid: nil)`: Finds a random member in the ring
-  - If a source member UID is provided, it excludes that member from the selection
-  - If the source member is the only one in the ring, it returns that same member
-
-#### Usage in Models
-
-> [!WARNING]
-> Make sure your model has `uid` and `created_at` columns before extending the Navigation module, as they're required for the default implementation.
-
-The module is designed to be extended in your model:
-
-```ruby
-class YourMember < ApplicationRecord
-  extend Webring::Navigation
-
-  # Your model code...
-end
-```
-
-#### Implementation Example
-
-The `Webring::Member` model extends the Navigation module:
-
-```ruby
-module Webring
-  class Member < ApplicationRecord
-    extend Webring::Navigation
-
-    # Member model implementation...
-  end
-end
-```
-
-This allows you to call navigation methods on the class:
-
-```ruby
-# Find the next member after member with UID 'abc123...'
-next_member = Webring::Member.find_next('abc123...')
-
-# Find the previous member before member with UID 'abc123...'
-previous_member = Webring::Member.find_previous('abc123...')
-
-# Find a random member (excluding member with UID 'abc123...')
-random_member = Webring::Member.find_random(source_member_uid: 'abc123...')
-```
-
-#### Customizing Navigation Behavior
-
-You can override the default navigation behavior by creating your own module that includes or extends the Webring::Navigation module:
-
-```ruby
-module YourApp
-  module CustomNavigation
-    include Webring::Navigation
-
-    # Override methods as needed
-    def find_next(source_member_uid)
-      # Custom implementation for finding the next member
-      # For example, you might want to order by name instead of created_at
-      source_member = find_by(uid: source_member_uid)
-      return order(:name).first unless source_member
-
-      where('name > ?', source_member.name)
-        .order(:name)
-        .first || order(:name).first
-    end
-  end
-end
-```
-
-Then apply your custom navigation module to your model:
-
-```ruby
-class YourMember < ApplicationRecord
-  extend YourApp::CustomNavigation
-
-  # Your model code...
-end
-```
-
-**Note**: The Navigation module requires models to have `uid` and `created_at` columns for its default implementation.
-
-## Controllers
-
-### Webring::NavigationController
-
-> [!IMPORTANT]
-> The Navigation controller is responsible for handling all webring navigation requests and redirecting users between member sites.
-
-Navigation controller manages the webring navigation flow for end users visiting member sites:
-
-- `next` - Redirects to the next member in the webring
-- `previous` - Redirects to the previous member in the webring
-- `random` - Redirects to a random member in the webring
-
-This controller handles requests to navigate between members. When a navigation request is received with a source member's UID, the controller determines the appropriate member to navigate to and redirects the user to that member's URL.
-
-#### How to Use the Navigation Controller
-
-To use the navigation controller in your webring implementation, you need to create navigation links that point to your application's navigation routes with the `source_member_uid` parameter.
-
-Example routes:
-```
-https://your-app.com/webring/previous?source_member_uid=abc123...
-https://your-app.com/webring/random?source_member_uid=abc123...
-https://your-app.com/webring/next?source_member_uid=abc123...
-```
-
-Replace `abc123...` with the actual member UID and `https://your-app.com` with your application's domain.
-
-The controller handles several cases:
-- If the source member UID is invalid or not found, it returns a 404 "Member not found" response
-- If there are no members in the webring, it returns a 404 "No members in the webring" response
-- For `next` and `previous` actions, if the current member is the last or first respectively, it wraps around to the other end of the ring
-- For `random` action, it ensures the random member is not the same as the source member (unless there's only one member)
-
-#### Customizing Navigation Behavior
-
-If you want to customize the navigation behavior, you can create your own controller that inherits from the default navigation controller:
-
-```ruby
-# app/controllers/my_navigation_controller.rb
-class MyNavigationController < Webring::NavigationController
-  # Override methods and call super if needed
-  def next
-    # Your custom logic before default behavior
-    super
-    # `super` will redirect to member.url, so no code will be executed after this
-  end
-
-  def previous
-    # Completely custom implementation
-    @previous_member = Webring::Member.find_previous(params[:source_member_uid])
-    redirect_to @previous_member.url, allow_other_host: true
-  end
-end
-```
-
-Then update your routes to use your custom controller:
-
-```ruby
-# config/routes.rb
-Rails.application.routes.draw do
-  # ... other routes ...
-
-  # Override default webring routes with your custom controller
-  get 'webring/next', to: 'my_navigation#next'
-  get 'webring/previous', to: 'my_navigation#previous'
-  get 'webring/random', to: 'my_navigation#random'
-end
-```
-
-### Webring::MembersController
-
-Members controller provides full CRUD functionality for managing webring members:
-
-- `index` - Lists all webring members
-- `show` - Displays details for a specific member
-- `new` - Form for creating a new member
-- `create` - Creates a new webring member
-- `edit` - Form for editing an existing member
-- `update` - Updates an existing webring member
-- `destroy` - Deletes a webring member
-
-This controller provides the basic functionality for your application to manage webring membership.
-
-## Widget
-
-### Webring::WidgetController
-
-The Widget controller serves a JavaScript widget that can be embedded on member sites to provide navigation through the webring.
-
-- `show` - Serves the widget.js JavaScript file with proper CORS headers
-
-### Widget.js
-
-The widget.js file is a standalone JavaScript snippet that creates a navigation widget on member sites. It's designed to be easily embedded with a single script tag and offers various customization options.
-
-#### How to Use the Widget
-
-To add the webring widget to a member's site, include the following code:
-
-```html
-<!-- Webring Widget -->
-<script src='https://yourhub.com/webring/widget.js' data-member-uid='MEMBER_UID'></script>
-<div id='webring-widget'></div>
-<!-- End Webring Widget -->
-```
-
-Replace `https://yourhub.com` with your application's domain and `MEMBER_UID` with the member's unique identifier.
-
-#### Widget Customization Options
-
-The widget can be customized through data attributes on the script tag:
-
-- **Widget Type** (`data-widget-type`):
-  - `full`: Text, back button, random button, forward button (default)
-  - `no-text`: Back button, random button, forward button (no text)
-  - `two-way`: Back and forward buttons (no random)
-  - `one-way`: Forward button only
-
-- **Button Text** (`data-button-text`):
-  - `true`: Show text labels on buttons (default)
-  - `false`: Show only symbols (no text)
-
-- **Styling** (`data-styles`):
-  - `full`: Apply all styles (default)
-  - `layout`: Only layout styles, no visual design
-  - `none`: No styles applied
-
-- **Target Element** (`data-target-id`):
-  - Sets a custom ID for the target container (default: `webring-widget`)
-
-#### Example With All Options
-
-```html
-<script src='https://yourhub.com/webring/widget.js'
-        data-member-uid='MEMBER_UID'
-        data-widget-type='full'
-        data-button-text='true'
-        data-styles='full'
-        data-target-id='custom-widget-id'></script>
-<div id='custom-widget-id'></div>
-```
-
-#### Multiple Widgets on the Same Page
-
-You can include multiple widgets on the same page by specifying different target IDs:
-
-```html
-<!-- First Widget -->
-<script src='https://yourhub.com/webring/widget.js'
-        data-member-uid='MEMBER_UID'
-        data-widget-type='full'
-        data-target-id='webring-widget-1'></script>
-<div id='webring-widget-1'></div>
-
-<!-- Second Widget -->
-<script src='https://yourhub.com/webring/widget.js'
-        data-member-uid='MEMBER_UID'
-        data-widget-type='no-text'
-        data-target-id='webring-widget-2'></script>
-<div id='webring-widget-2'></div>
-```
-
-## Development
-
-To set up the development environment:
-
-1. Clone this repository
-2. Run `bundle install`
-3. Run `bin/setup_dummy` to prepare the test dummy app
-
-### Migrations
-
-After creating a new migration in the engine, you need to run:
-```bash
-cd test/dummy
-bin/rails db:migrate
-```
-Which will run the migrations in the dummy app.
-You don't need to copy migrations to the dummy app, it looks for them in the engine.
-
-### Testing
-
-> [!WARNING]
-> As of now, there are no tests. Contributions to add test coverage are welcome!
-
-## Contributing
-
-We welcome contributions to Webring for Rails! Here's how you can help:
+## Documentation
 
-1. Fork the repository
-2. Create a feature branch: `git checkout -b my-new-feature`
-3. Make your changes and add tests if possible
-4. Commit your changes: `git commit -am 'Add some feature'`
-5. Push to the branch: `git push origin my-new-feature`
-6. Submit a pull request
+For detailed documentation on models, controllers, modules, widget customization, and more advanced installation options, please visit the [Webring Rails Wiki](https://github.com/lstpsche/webring-rails/wiki).
 
 ## License
 

data/app/controllers/webring/members_controller.rb

@@ -1,11 +1,10 @@
 module Webring
   class MembersController < ::ApplicationController
-    before_action :set_member, only: %i[show edit update destroy]
+    before_action :members, only: %i[index]
+    before_action :member, only: %i[show edit update destroy]
 
     # GET /webring/members
-    def index
-      @members = Member.all.order(created_at: :desc)
-    end
+    def index; end
 
     # GET /webring/members/1
     def show; end
@@ -31,8 +30,8 @@ module Webring
 
     # PATCH/PUT /webring/members/1
     def update
-      if @member.update(member_params)
-        redirect_to admin_panel_member_path(@member), notice: 'Member was successfully updated.'
+      if member.update(member_params)
+        redirect_to admin_panel_member_path(member), notice: 'Member was successfully updated.'
       else
         render :edit, status: :unprocessable_entity
       end
@@ -40,21 +39,23 @@ module Webring
 
     # DELETE /webring/members/1
     def destroy
-      @member.destroy
+      member.destroy
 
       redirect_to admin_panel_members_url, notice: 'Member was successfully destroyed.'
     end
 
     private
 
-    # Use callbacks to share common setup or constraints between actions.
-    def set_member
-      @member = Member.find_by!(uid: params[:id])
+    def members
+      @members ||= Member.all.order(created_at: :desc)
+    end
+
+    def member
+      @member ||= Member.find_by!(uid: params[:id])
     end
 
-    # Only allow a list of trusted parameters through.
     def member_params
-      params.require(:member).permit(:name, :url)
+      params.require(:member).permit(:name, :url, :description)
     end
   end
 end

data/app/controllers/webring/membership_requests_controller.rb

@@ -0,0 +1,23 @@
+module Webring
+  class MembershipRequestsController < ApplicationController
+    def new
+      @membership_request = MembershipRequest.new
+    end
+
+    def create
+      @membership_request = MembershipRequest.new(membership_request_params)
+
+      if @membership_request.save
+        redirect_to root_path
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def membership_request_params
+      params.require(:membership_request).permit(:name, :url, :callback_email, :description)
+    end
+  end
+end

data/app/models/concerns/webring/membership_request_actions.rb

@@ -0,0 +1,28 @@
+module Webring
+  module MembershipRequestActions
+    extend ActiveSupport::Concern
+
+    def approve!
+      return if approved?
+
+      transaction do
+        update!(status: :approved)
+
+        Webring::Member.create!(
+          name: name,
+          url: url,
+          description: description,
+          webring_membership_request_id: id
+        )
+      end
+    end
+
+    def reject!
+      return if rejected?
+
+      transaction do
+        update!(status: :rejected)
+      end
+    end
+  end
+end

data/app/models/webring/member.rb

@@ -5,11 +5,10 @@ module Webring
     UID_LENGTH = 16 # 32-character hex string
 
     validates :url, presence: true, uniqueness: true
-    validates :name, uniqueness: true, if: -> { name.present? }
+    validates :name, presence: true, uniqueness: true
     validates :uid, presence: true, uniqueness: true, length: { is: UID_LENGTH * 2 }
 
     before_validation :generate_uid, if: -> { uid.blank? }
-    before_validation :set_name_from_url, if: -> { name.blank? && url.present? }
 
     def to_param
       uid
@@ -23,9 +22,5 @@ module Webring
         break unless self.class.exists?(uid: uid)
       end
     end
-
-    def set_name_from_url
-      self.name = url
-    end
   end
 end

data/app/models/webring/membership_request.rb

@@ -0,0 +1,16 @@
+module Webring
+  class MembershipRequest < ApplicationRecord
+    include Webring::MembershipRequestActions
+
+    has_one :member, class_name: 'Webring::Member',
+                     foreign_key: :webring_membership_request_id,
+                     dependent: :nullify,
+                     inverse_of: :membership_request
+
+    validates :url, presence: true, uniqueness: true
+    validates :name, presence: true
+    validates :description, presence: true
+
+    enum :status, { pending: 0, approved: 1, rejected: 2 }, default: :pending
+  end
+end

data/lib/generators/USAGE

@@ -6,8 +6,7 @@ Example:
     rails generate webring:install
 
     This will create:
-        config/initializers/webring.rb
-        # And mount the Webring engine in your routes.rb file
+        # Mount the Webring engine in your routes.rb file
 
 Example:
     rails generate webring:member
@@ -15,11 +14,25 @@ Example:
     This will create:
         app/models/webring/member.rb
         db/migrate/TIMESTAMP_create_webring_members.rb
-        # And add member routes to your routes.rb file
 
 Example:
-    rails generate webring:controller
+    rails generate webring:membership_request
+
+    This will create:
+        app/models/webring/membership_request.rb
+        db/migrate/TIMESTAMP_create_webring_membership_requests.rb
+        db/migrate/TIMESTAMP_add_membership_request_to_webring_members.rb
+
+Example:
+    rails generate webring:navigation_controller
 
     This will create:
         app/controllers/webring/navigation_controller.rb
         # And add navigation routes to your routes.rb file
+
+Example:
+    rails generate webring:membership_requests_controller
+
+    This will create:
+        app/controllers/webring/membership_requests_controller.rb
+        # And add membership request routes to your routes.rb file

data/lib/generators/webring/install/templates/AFTER_INSTALL

@@ -33,7 +33,26 @@ This will:
     - GET /webring/previous - Navigate to the previous site
     - GET /webring/random   - Navigate to a random site
 
-3. Customize Your Routes [Optional]
+3. Enable Membership Requests [Optional]
+----------------------------------------
+Generate a membership request model to allow sites to request joining your webring:
+
+    $ rails generate webring:membership_request
+
+This will:
+  - Create a Webring::MembershipRequest model in app/models/webring/membership_request.rb
+  - Create migrations to set up the webring_membership_requests table
+  - Add appropriate database indexes and relations to Webring::Member
+
+After generating the model, run the migration:
+
+    $ rails db:migrate
+
+Then, optionally generate a controller to handle membership requests:
+
+    $ rails generate webring:controller:membership_requests
+
+4. Customize Your Routes [Optional]
 ----------------------------------
 The engine is mounted at '/webring' by default. You can change this in your routes.rb file:
 
@@ -43,7 +62,7 @@ The engine is mounted at '/webring' by default. You can change this in your rout
     # Example custom mount point
     mount Webring::Engine => '/network', as: 'webring'
 
-4. Add Webring Navigation UI Elements
+5. Add Webring Navigation UI Elements
 ------------------------------------
 Add navigation links to your views to enable users to navigate through the webring:
 
@@ -54,7 +73,7 @@ Add navigation links to your views to enable users to navigate through the webri
 Note: Replace 'your_member.uid' with the actual UID of your site in the webring.
       If you're building a standalone webring hub, you can omit the source_member_uid parameter.
 
-5. Managing Webring Members
+6. Managing Webring Members
 --------------------------
 You can add members to your webring using the Webring::Member model:
 

data/lib/generators/webring/member/member_generator.rb

@@ -13,6 +13,7 @@ module Webring
     #   # uid  - A unique identifier for the member (automatically generated)
     #   # name - The name of the member site (defaults to URL if not provided)
     #   # url  - The URL of the member site (required)
+    #   # description - The description of the member site (required)
     #
     # @note After running this generator, you should run the migration with:
     #       rails db:migrate

data/lib/generators/webring/member/templates/AFTER_INSTALL

@@ -18,21 +18,14 @@ The generated model is located at:
 
 The Member model has the following attributes:
   - uid: A unique identifier automatically generated for each member (32-character hex)
-  - name: The name of the member site (optional, defaults to URL if not provided)
+  - name: The name of the member site (required)
   - url: The URL of the member site (required)
+  - description: The description of the member site (required)
 
 3. Adding Members to Your Webring
 -------------------------------
 You can add members to your webring using the Webring::Member model:
 
-    Webring::Member.create(name: 'Example Site', url: 'https://example.com')
+    Webring::Member.create(name: 'Example Site', url: 'https://example.com', description: 'Example description')
 
-The uid will be automatically generated if not provided.
-
-4. Next Steps
------------
-Consider generating the navigation controller to enable navigation between webring members:
-
-    $ rails generate webring:controller
-
-This will create routes and controller actions for webring navigation.
+The uid will be automatically generated if not provided. It is recommended to leave the UID generation to the model.

data/lib/generators/webring/member/templates/migration.rb

@@ -2,14 +2,15 @@ class CreateWebringMembers < ActiveRecord::Migration<%= "[#{Rails::VERSION::MAJO
   def change
     create_table :webring_members do |t|
       t.string :uid, null: false, limit: 32
-      t.string :name
+      t.string :name, null: false
       t.string :url, null: false
+      t.text :description, null: false
+
+      t.index :uid, unique: true
+      t.index :name, unique: true
+      t.index :url, unique: true
 
       t.timestamps
     end
-
-    add_index :webring_members, :uid, unique: true
-    add_index :webring_members, :name, unique: true
-    add_index :webring_members, :url, unique: true
   end
 end

data/lib/generators/webring/member/templates/model.rb

@@ -5,11 +5,10 @@ module Webring
     UID_LENGTH = 16 # 32-character hex string
 
     validates :url, presence: true, uniqueness: true
-    validates :name, uniqueness: true, if: -> { name.present? }
+    validates :name, presence: true, uniqueness: true
     validates :uid, presence: true, uniqueness: true, length: { is: UID_LENGTH * 2 }
 
     before_validation :generate_uid, if: -> { uid.blank? }
-    before_validation :set_name_from_url, if: -> { name.blank? && url.present? }
 
     def to_param
       uid
@@ -23,9 +22,5 @@ module Webring
         break unless self.class.exists?(uid: uid)
       end
     end
-
-    def set_name_from_url
-      self.name = url
-    end
   end
 end

data/lib/generators/webring/membership_request/membership_request_generator.rb

@@ -0,0 +1,73 @@
+require 'rails/generators/active_record'
+require 'rails/generators/named_base'
+require_relative '../shared/route_injector'
+
+module Webring
+  module Generators
+    # @description The MembershipRequestGenerator creates the MembershipRequest model for handling webring membership requests
+    # It creates both the model file and a migration to create the database table
+    #
+    # @usage Run: rails generate webring:membership_request
+    #
+    # @example Generated MembershipRequest model has the following attributes:
+    #   # name - The name of the member site
+    #   # url - The URL of the member site (required)
+    #   # callback_email - Email for notifications
+    #   # description - Description of the site
+    #
+    # @note After running this generator, you should run the migration with:
+    #       rails db:migrate
+    class MembershipRequestGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Shared::RouteInjector
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates a Webring::MembershipRequest model and necessary migration for storing webring membership requests'
+
+      # Creates a migration file to create the webring_membership_requests table
+      # @return [void]
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/create_webring_membership_requests.rb'
+        migration_template 'relations_migration.rb', 'db/migrate/add_membership_request_to_webring_members.rb'
+      end
+
+      # Creates the MembershipRequest model file based on the template
+      # @return [void]
+      def create_model_file
+        template 'model.rb', 'app/models/webring/membership_request.rb'
+      end
+
+      # Injects the belongs_to relationship into the Member model
+      # @return [void]
+      def inject_into_member_model
+        member_model_path = 'app/models/webring/member.rb'
+
+        if File.exist?(member_model_path)
+          inject_into_file member_model_path, after: "class Member\n" do
+            "  belongs_to :membership_request,\n" \
+            "             class_name: 'Webring::MembershipRequest',\n" \
+            "             foreign_key: :webring_membership_request_id,\n" \
+            "             optional: true,\n" \
+            "             inverse_of: :member\n"
+          end
+        end
+      end
+
+      # Generates the next migration number for the migration file
+      # This is required by Rails::Generators::Migration
+      # @param dirname [String] The directory where migrations are stored
+      # @return [Integer] The next migration number
+      def self.next_migration_number(dirname)
+        next_migration_number = current_migration_number(dirname) + 1
+        ActiveRecord::Migration.next_migration_number(next_migration_number)
+      end
+
+      # Displays the README with next steps after installation
+      # @return [void]
+      def show_readme
+        readme 'AFTER_INSTALL' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/webring/membership_request/templates/AFTER_INSTALL

@@ -0,0 +1,41 @@
+==============================================
+Webring::MembershipRequest Model Has Been Generated!
+==============================================
+
+The MembershipRequest model is the core component for handling new site requests to join your webring. Follow these steps to complete the setup:
+
+1. Run Database Migration
+------------------------
+Apply the migration to create the webring_membership_requests table:
+
+    $ rails db:migrate
+
+2. Review and Customize the Model
+-------------------------------
+The generated model is located at:
+    app/models/webring/membership_request.rb
+
+The MembershipRequest model has the following attributes:
+  - name: The name of the requesting site (required)
+  - url: The URL of the requesting site (required)
+  - callback_email: The email address to send notifications to (required)
+  - description: The description of the requesting site (required)
+  - status: The status of the request (pending, approved, rejected)
+
+3. Generate Controller [Optional]
+--------------------------------
+Generate a controller to handle membership requests:
+
+    $ rails generate webring:controller:membership_requests
+
+This will:
+  - Create the Webring::MembershipRequestsController in app/controllers/webring/membership_requests_controller.rb
+  - Add membership request routes to your routes.rb file:
+    - GET /webring/membership_requests/new - Renders the view for submitting a new membership request (view is your responsibility)
+    - POST /webring/membership_requests    - Creates a new membership request
+
+4. Managing Membership Requests
+-------------------------------
+You can manage membership requests using the Webring::MembershipRequest model:
+
+    Webring::MembershipRequest.create(name: 'Example Site', url: 'https://example.com', description: 'Example description', callback_email: 'example@example.com')

data/lib/generators/webring/membership_request/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateWebringMembershipRequests < ActiveRecord::Migration<%= "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" %>
+  def change
+    create_table :webring_membership_requests do |t|
+      t.string :name, null: false
+      t.string :url, null: false
+      t.text :description, null: false
+      t.string :callback_email, null: false
+      t.integer :status, default: 0
+
+      t.index :url, unique: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/webring/membership_request/templates/model.rb

@@ -0,0 +1,29 @@
+module Webring
+  class MembershipRequest < ApplicationRecord
+    has_one :member, class_name: 'Webring::Member',
+                     foreign_key: :webring_membership_request_id,
+                     dependent: :nullify,
+                     inverse_of: :membership_request
+
+    validates :url, presence: true, uniqueness: true
+    validates :name, presence: true
+    validates :description, presence: true
+
+    enum :status, { pending: 0, approved: 1, rejected: 2 }, default: :pending
+
+    def approve!
+      return if approved?
+
+      transaction do
+        update!(status: :approved)
+
+        Webring::Member.create!(
+          name: name,
+          url: url,
+          description: description,
+          webring_membership_request_id: id
+        )
+      end
+    end
+  end
+end

data/lib/generators/webring/membership_request/templates/relations_migration.rb

@@ -0,0 +1,5 @@
+class AddMembershipRequestToWebringMembers < ActiveRecord::Migration<%= "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" %>
+  def change
+    add_reference :webring_members, :webring_membership_request, null: true, foreign_key: true
+  end
+end

data/lib/generators/webring/membership_requests_controller/membership_requests_controller_generator.rb

@@ -0,0 +1,44 @@
+require_relative '../shared/route_injector'
+
+module Webring
+  module Generators
+    # @description The MembershipRequestsControllerGenerator creates a controller to handle webring membership requests
+    # This generator creates both the controller file and adds the required routes
+    #
+    # @usage Run: rails generate webring:controller:membership_requests
+    #
+    # @example The generated controller provides endpoints for creating membership requests:
+    #   # GET /webring/membership_requests/new - Controller for creating a new membership request
+    #   # POST /webring/membership_requests    - Create a new membership request
+    #
+    # @note This generator should be run after installing the Webring engine and
+    #       generating the MembershipRequest model with webring:membership_request
+    class MembershipRequestsControllerGenerator < Rails::Generators::Base
+      include Shared::RouteInjector
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates a Webring::MembershipRequestsController and necessary routes for membership requests'
+
+      # Creates the MembershipRequestsController file based on the template
+      # @return [void]
+      def create_controller_file
+        template 'membership_requests_controller.rb', 'app/controllers/webring/membership_requests_controller.rb'
+      end
+
+      # Adds membership request routes to the application's routes.rb file
+      # These routes are used to create new membership requests
+      # @return [void]
+      def create_membership_request_routes
+        route_content = <<~ROUTE
+          # Webring membership request routes
+          namespace :webring do
+            resources :membership_requests, only: [:new, :create]
+          end
+        ROUTE
+
+        inject_webring_routes(route_content)
+      end
+    end
+  end
+end

data/lib/generators/webring/membership_requests_controller/templates/membership_requests_controller.rb

@@ -0,0 +1,23 @@
+module Webring
+  class MembershipRequestsController < ApplicationController
+    def new
+      @membership_request = MembershipRequest.new
+    end
+
+    def create
+      @membership_request = MembershipRequest.new(membership_request_params)
+
+      if @membership_request.save
+        redirect_to root_path, notice: 'Your membership request has been submitted!'
+      else
+        render :new, status: :unprocessable_entity
+      end
+    end
+
+    private
+
+    def membership_request_params
+      params.require(:membership_request).permit(:name, :url, :callback_email, :description)
+    end
+  end
+end

data/lib/generators/webring/{controller/controller_generator.rb → navigation_controller/navigation_controller_generator.rb}

@@ -14,7 +14,7 @@ module Webring
     #
     # @note This generator should be run after installing the Webring engine and
     #       generating the Member model with webring:member
-    class ControllerGenerator < Rails::Generators::Base
+    class NavigationControllerGenerator < Rails::Generators::Base
       include Shared::RouteInjector
 
       source_root File.expand_path('templates', __dir__)

data/lib/generators/webring_generator.rb

@@ -10,7 +10,7 @@ module Webring
       end
 
       def invoke_webring_controller
-        invoke 'webring:controller'
+        invoke 'webring:member_controller'
       end
     end
   end

data/lib/webring/version.rb

@@ -1,3 +1,3 @@
 module Webring
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webring-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Nikita Shkoda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-04 00:00:00.000000000 Z
+date: 2025-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,29 +65,37 @@ files:
 - app/assets/javascripts/webring/widget.js
 - app/controllers/webring/application_controller.rb
 - app/controllers/webring/members_controller.rb
+- app/controllers/webring/membership_requests_controller.rb
 - app/controllers/webring/navigation_controller.rb
 - app/controllers/webring/widget_controller.rb
 - app/helpers/webring/application_helper.rb
-- app/jobs/webring/application_job.rb
-- app/mailers/webring/application_mailer.rb
+- app/models/concerns/webring/membership_request_actions.rb
 - app/models/concerns/webring/navigation.rb
 - app/models/webring/application_record.rb
 - app/models/webring/member.rb
+- app/models/webring/membership_request.rb
 - config/routes.rb
 - lib/generators/USAGE
-- lib/generators/webring/controller/controller_generator.rb
-- lib/generators/webring/controller/templates/navigation_controller.rb
 - lib/generators/webring/install/install_generator.rb
 - lib/generators/webring/install/templates/AFTER_INSTALL
 - lib/generators/webring/member/member_generator.rb
 - lib/generators/webring/member/templates/AFTER_INSTALL
 - lib/generators/webring/member/templates/migration.rb
 - lib/generators/webring/member/templates/model.rb
+- lib/generators/webring/membership_request/membership_request_generator.rb
+- lib/generators/webring/membership_request/templates/AFTER_INSTALL
+- lib/generators/webring/membership_request/templates/migration.rb
+- lib/generators/webring/membership_request/templates/model.rb
+- lib/generators/webring/membership_request/templates/relations_migration.rb
+- lib/generators/webring/membership_requests_controller/membership_requests_controller_generator.rb
+- lib/generators/webring/membership_requests_controller/templates/membership_requests_controller.rb
+- lib/generators/webring/navigation_controller/navigation_controller_generator.rb
+- lib/generators/webring/navigation_controller/templates/navigation_controller.rb
 - lib/generators/webring/shared/route_injector.rb
 - lib/generators/webring_generator.rb
+- lib/webring-rails.rb
 - lib/webring/engine.rb
 - lib/webring/version.rb
-- lib/webring_rails.rb
 homepage: https://github.com/lstpsche/webring_rails
 licenses:
 - MIT

data/app/jobs/webring/application_job.rb

@@ -1,4 +0,0 @@
-module Webring
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/webring/application_mailer.rb

@@ -1,6 +0,0 @@
-module Webring
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end