webring-rails 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b272723dd4b551c5d77e195df9a4144b260c92b9a0f284d7bf2935e0b0e3a49
-  data.tar.gz: 110b576926898690377edd1c617351b588ce0bb0804db33a51584e0abe2cf9da
+  metadata.gz: 919f405578a35bb65238570b3e7bdc650e2685ac435dde5f40a814828dfbc491
+  data.tar.gz: db6dd54f0c3138e534c4dfe7ec3bce2075e1d06e978ca21865ef099ac253256f
 SHA512:
-  metadata.gz: b60a09f995bcdeb4880a7f06fdded5dca653a034161f1da82a03bf98e960b3203158c63519808296a91ed10717cd1a502471f9f9d615f6b591a5501654dae276
-  data.tar.gz: 15b9c7a4e3d31462a779303269c313c5bffe6605ae94216ff3b3e118d0616abef0518883ac69b149b4c6a3de9aa210071f64054916260e60be5886e0bca40d00
+  metadata.gz: 7b89d911a5b51898e9a2ac0f8c157fd5d1aac5e54a885918a6bdf76a3758721501d6040c97fe4df93a692d373806df21dcff26456d7546ceb23b935c77b723cc
+  data.tar.gz: 6072b3a3573f4c9433f11472eba97590dc7cb4af7c53db2b5b476d3590787d99d9a98b64f1fee64787bdc6c6190b4308741637ce4f8af1fff901e653e241a75b

data/app/assets/javascripts/webring/widget.js

@@ -2,11 +2,11 @@
  * Webring Navigation Widget
  *
  * Usage:
- * <script src="https://yourhub.com/webring/widget.js" data-member-uid="YOUR_MEMBER_UID" data-widget-type="full"></script>
+ * <script src="https://yourhub.com/widget.js" data-member-uid="YOUR_MEMBER_UID" data-widget-type="full"></script>
  * <div id="webring-widget"></div>
  *
  * For multiple widgets on same page:
- * <script src="https://yourhub.com/webring/widget.js" data-member-uid="YOUR_MEMBER_UID" data-widget-type="full" data-target-id="custom-widget-id"></script>
+ * <script src="https://yourhub.com/widget.js" data-member-uid="YOUR_MEMBER_UID" data-widget-type="full" data-target-id="custom-widget-id"></script>
  * <div id="custom-widget-id"></div>
  *
  * Widget Types:
@@ -14,6 +14,7 @@
  * - no-text: back btn, random btn, forward btn (no text)
  * - two-way: back btn, forward btn (no random)
  * - one-way: forward btn only
+ * - random-only: random btn only
  *
  * Additional Options:
  * - data-button-text="true|false": If true, buttons will show text labels. If false, only symbols are shown. Default: true
@@ -26,7 +27,7 @@
 (function() {
   // Configuration constants
   const WIDGET_CONFIG = {
-    VALID_TYPES: ['full', 'no-text', 'two-way', 'one-way'],
+    VALID_TYPES: ['full', 'no-text', 'two-way', 'one-way', 'random-only'],
     DEFAULT_TYPE: 'full',
     DEFAULT_TARGET_ID: 'webring-widget',
     STYLE_ID: 'webring-widget-styles',
@@ -34,6 +35,8 @@
     DEFAULT_STYLE_TYPE: 'full'
   };
 
+  const logoSvg = (width = 20, height = 20, style = "") => `<<REPLACE_ME_LOGO_SVG>>`;
+
   const NAVIGATION_ACTIONS = {
     prev: {
       symbol: '«',
@@ -42,24 +45,32 @@
       path: 'previous'
     },
     random: {
-      symbol: '⚡',
-      text: 'Random',
+      symbol: logoSvg(22, 22),
+      text: `${logoSvg(20, 20, "margin-right: 4px; margin-top: 1px;")} Random`,
       title: 'Random site',
-      path: 'random'
+      path: 'random',
+      additionalClass: 'random-btn'
     },
     next: {
       symbol: '»',
       text: 'Next »',
       title: 'Next site',
       path: 'next'
+    },
+    logoOnly: {
+      symbol: logoSvg(22, 22),
+      text: `${logoSvg(20, 20)} Random`,
+      title: 'Ruby Webring',
+      path: ''
     }
   };
 
   const WIDGET_TYPE_CONFIG = {
     'full': { showTitle: true, actions: ['prev', 'random', 'next'] },
     'no-text': { showTitle: false, actions: ['prev', 'random', 'next'] },
-    'two-way': { showTitle: false, actions: ['prev', 'next'] },
-    'one-way': { showTitle: false, actions: ['next'] }
+    'two-way': { showTitle: false, actions: ['prev', 'logoOnly', 'next'], showLogoInMiddle: true },
+    'one-way': { showTitle: false, actions: ['next'], showLogoInButton: true },
+    'random-only': { showTitle: false, actions: ['random'] }
   };
 
   // Define styles outside the function to avoid duplication
@@ -83,6 +94,7 @@
         gap: 10px;
         width: 100%;
         justify-content: center;
+        align-items: center;
       }
       .webring-nav a.webring-btn {
         display: flex;
@@ -91,14 +103,23 @@
         padding: 6px 12px;
         text-decoration: none;
       }
+      .webring-nav a.webring-btn.random-btn {
+        padding: 6px 9px 6px 9px;
+      }
+      .webring-nav .logo-only {
+        padding: 8px 3px 6px 3px;
+      }
       .webring-nav[data-widget-type="no-text"] {
         padding: 8px 10px;
       }
       .webring-nav[data-widget-type="one-way"] {
         max-width: 200px;
       }
-      .webring-nav[data-widget-type="one-way"] nav {
-        justify-content: center;
+      .webring-logo-inline {
+        display: inline-block;
+        vertical-align: middle;
+        margin-right: 6px;
+        margin-top: 1px;
       }
     `,
     design: `
@@ -175,13 +196,28 @@
       const config = WIDGET_TYPE_CONFIG[widgetType];
       const linkElements = config.actions.map(action => {
         const actionConfig = NAVIGATION_ACTIONS[action];
+
+        // Logo-only block
+        if (action === 'logoOnly') {
+          return `<div class="logo-only">${logoSvg(22, 22)}</div>`;
+        }
+
         const url = `${baseUrl}/webring/${actionConfig.path}?source_member_uid=${memberUid}`;
-        const label = buttonText ? actionConfig.text : actionConfig.symbol;
-        return `<a href="${url}" title="${actionConfig.title}" class="webring-btn">${label}</a>`;
+        let label = buttonText ? actionConfig.text : actionConfig.symbol;
+        const btnClass = `webring-btn${actionConfig.additionalClass ? ` ${actionConfig.additionalClass}` : ''}`;
+
+        // One-way type case
+        if (widgetType === 'one-way' && config.showLogoInButton && action === 'next') {
+          label = buttonText
+            ? `<span class="webring-logo-inline">${logoSvg(20, 20)}</span> ${actionConfig.text}`
+            : `<span class="webring-logo-inline">${logoSvg(20, 20)}</span> ${actionConfig.symbol}`;
+        }
+
+        return `<a href="${url}" title="${actionConfig.title}" class="${btnClass}">${label}</a>`;
       }).join('\n          ');
 
       // Create widget HTML
-      const title = config.showTitle ? '<span class="webring-title">Webring</span>' : '';
+      const title = config.showTitle ? '<span class="webring-title">Ruby Webring</span>' : '';
       container.innerHTML = `
         <div class="webring-nav" data-widget-type="${widgetType}">
           ${title}

data/app/controllers/webring/widget_controller.rb

@@ -1,20 +1,26 @@
 module Webring
   class WidgetController < ::ApplicationController
     # Disable CSRF protection for widget.js as it needs to be loaded from other domains
-    skip_forgery_protection only: :show
+    skip_forgery_protection
 
     # Set CORS headers for the widget
-    before_action :set_cors_headers, only: :show
+    before_action :set_cors_headers
 
     # Serve the webring navigation widget JavaScript
-    # GET /webring/widget.js
+    # GET /widget.js
     def show
       respond_to do |format|
         format.js do
           response.headers['Content-Type'] = 'application/javascript'
 
-          # Serve the JavaScript file from the engine's assets
-          render file: Webring::Engine.root.join('app/assets/javascripts/webring/widget.js')
+          # Take the JavaScript file from the engine's assets and replace the customizable Logo SVG
+          widget_js =
+            Webring::Engine
+            .root.join('app/assets/javascripts/webring/widget.js')
+            .read
+            .gsub('<<REPLACE_ME_LOGO_SVG>>', logo_svg)
+
+          render js: widget_js
         end
       end
     end
@@ -27,5 +33,14 @@ module Webring
       response.headers['Access-Control-Allow-Headers'] = 'Origin, X-Requested-With, Content-Type, Accept'
       response.headers['Access-Control-Max-Age'] = '86400'
     end
+
+    # should include `${width}`, `${height}`, `${style}` in order to be customizable
+    def logo_svg
+      <<~SVG
+        <svg width="${width}" height="${height}" style="${style}" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+          <path d="M13 3L6 14H12L11 21L18 10H12L13 3Z" fill="currentColor"/>
+        </svg>
+      SVG
+    end
   end
 end

data/app/models/webring/member.rb

@@ -4,6 +4,8 @@ module Webring
 
     UID_LENGTH = 16 # 32-character hex string
 
+    self.filter_attributes += %i[uid]
+
     validates :url, presence: true, uniqueness: true
     validates :name, presence: true, uniqueness: true
     validates :uid, presence: true, uniqueness: true, length: { is: UID_LENGTH * 2 }

data/config/routes.rb

@@ -2,7 +2,6 @@ Webring::Engine.routes.draw do
   get 'next', to: 'navigation#next'
   get 'previous', to: 'navigation#previous'
   get 'random', to: 'navigation#random'
-  get 'widget.js', to: 'widget#show', format: 'js', as: :widget
 
   root to: 'navigation#random'
 end

data/lib/generators/webring/custom_widget_controller/custom_widget_controller_generator.rb

@@ -0,0 +1,47 @@
+require_relative '../shared/route_injector'
+
+module Webring
+  module Generators
+    # @description The CustomWidgetControllerGenerator creates a controller to handle webring custom widgets
+    # This generator creates both the controller file and adds the required routes
+    #
+    # @usage Run: rails generate webring:custom_widget_controller
+    #
+    # @example The generated controller provides an endpoint for embedding the widget via the <script> tag:
+    #   # GET /widget.js - Get the widget's code for a script tag
+    #
+    # @note This generator should be run after installing the Webring engine
+    class CustomWidgetControllerGenerator < Rails::Generators::Base
+      include Shared::RouteInjector
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc 'Creates a Webring::CustomWidgetController and necessary routes for custom widget'
+
+      # Creates the CustomWidgetController file based on the template
+      def create_controller_file
+        template 'custom_widget_controller.rb', 'app/controllers/webring/custom_widget_controller.rb'
+      end
+
+      # Adds custom widget routes to the application's routes.rb file
+      # These routes are used to create new custom widgets
+      def create_custom_widget_routes
+        routes_file = 'config/routes.rb'
+        widget_route = "get 'widget.js', to: 'widget#show', format: 'js', as: :widget"
+        new_widget_route = "get 'widget.js', to: 'custom_widget#show', format: 'js', as: :widget"
+
+        if File.read(routes_file).include?(widget_route)
+          gsub_file routes_file, widget_route, new_widget_route
+        else
+          route_content = <<~ROUTE
+            scope module: 'webring' do
+              get 'widget.js', to: 'custom_widget#show', format: 'js', as: :widget
+            end
+          ROUTE
+
+          inject_webring_routes(route_content)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module Webring
+  class CustomWidgetController < Webring::WidgetController
+    private
+
+    # should include `${width}`, `${height}`, `${style}` in order to be customizable
+    # remove the method or call `super` to use the default logo
+    def logo_svg
+      <<~SVG
+        Add your custom logo SVG here
+      SVG
+    end
+  end
+end

data/lib/generators/webring/install/install_generator.rb

@@ -15,14 +15,13 @@ module Webring
 
       desc 'Creates Webring routes and mounts the engine in your application.'
 
-      # Adds the engine mount point to the application's routes.rb file
-      # @return [void]
+      # Adds the engine mount point and widget route to the application's routes.rb file
       def add_webring_routes
+        route "scope module: 'webring' do\n  get 'widget.js', to: 'widget#show', format: 'js', as: :widget\nend\n\n"
         route "mount Webring::Engine => '/webring', as: 'webring'\n\n"
       end
 
       # Displays the README with next steps after installation
-      # @return [void]
       def show_readme
         readme 'AFTER_INSTALL' if behavior == :invoke
       end

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

@@ -2,7 +2,7 @@
 Webring Engine Has Been Successfully Installed!
 ==============================================
 
-The Webring engine has been mounted at '/webring' in your application. Below are
+The Webring engine has been mounted at '/webring' in your application as well as the widget route. Below are
 the next steps to complete the webring setup and customization options.
 
 1. Configure Your Members Model
@@ -24,7 +24,7 @@ After generating the model, run the migration:
 --------------------------------------------
 Generate a navigation controller to handle navigation between webring members:
 
-    $ rails generate webring:controller
+    $ rails generate webring:navigation_controller
 
 This will:
   - Create the Webring::NavigationController in app/controllers/webring/navigation_controller.rb
@@ -50,7 +50,7 @@ After generating the model, run the migration:
 
 Then, optionally generate a controller to handle membership requests:
 
-    $ rails generate webring:controller:membership_requests
+    $ rails generate webring:membership_requests_controller
 
 4. Customize Your Routes [Optional]
 ----------------------------------
@@ -80,3 +80,13 @@ You can add members to your webring using the Webring::Member model:
     Webring::Member.create(name: 'Example Site', url: 'https://example.com')
 
 Consider building an admin interface to manage your webring members.
+
+7. Customize the Widget
+-----------------------
+You can customize the widget's logo or the widget's server controller by adding a customizable widget controller.
+
+    $ rails generate webring:custom_widget_controller
+
+This will:
+  - Create a Webring::CustomWidgetController in app/controllers/webring/custom_widget_controller.rb
+  - Replace the default widget route with the customizable one or add the customizable one if the default one is not present

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

@@ -26,13 +26,11 @@ module Webring
       desc 'Creates a Webring::Member model and necessary migration for storing webring members'
 
       # Creates a migration file to create the webring_members table
-      # @return [void]
       def create_migration_file
         migration_template 'migration.rb', 'db/migrate/create_webring_members.rb'
       end
 
       # Creates the Member model file based on the template
-      # @return [void]
       def create_model_file
         template 'model.rb', 'app/models/webring/member.rb'
       end
@@ -47,7 +45,6 @@ module Webring
       end
 
       # Displays the README with next steps after installation
-      # @return [void]
       def show_readme
         readme 'AFTER_INSTALL' if behavior == :invoke
       end

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

@@ -4,6 +4,8 @@ module Webring
 
     UID_LENGTH = 16 # 32-character hex string
 
+    self.filter_attributes += %i[uid]
+
     validates :url, presence: true, uniqueness: true
     validates :name, presence: true, uniqueness: true
     validates :uid, presence: true, uniqueness: true, length: { is: UID_LENGTH * 2 }

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

@@ -26,30 +26,38 @@ module Webring
       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'
 
+        inject_conditions = [
+          { line: 'UID_LENGTH =', inject_options: { after: /UID_LENGTH =.*\n\n/ } },
+          { line: 'extend Webring::Navigation', inject_options: { after: "extend Webring::Navigation\n\n" } },
+          { line: 'class Member < ApplicationRecord', inject_options: { after: "class Member < ApplicationRecord\n" } }
+        ]
+
         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"
+          content = File.read(member_model_path)
+          options = inject_conditions.find { |condition| content.include?(condition[:line]) }&.fetch(:inject_options)
+          return if options.nil? || options.empty?
+
+          inject_into_file member_model_path, **options 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" \
+            "\n"
           end
         end
       end
@@ -64,7 +72,6 @@ module Webring
       end
 
       # Displays the README with next steps after installation
-      # @return [void]
       def show_readme
         readme 'AFTER_INSTALL' if behavior == :invoke
       end

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

@@ -21,14 +21,12 @@ module Webring
       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

data/lib/generators/webring/navigation_controller/navigation_controller_generator.rb

@@ -22,14 +22,12 @@ module Webring
       desc 'Creates a Webring::NavigationController and necessary routes for webring navigation'
 
       # Creates the NavigationController file based on the template
-      # @return [void]
       def create_controller_file
         template 'navigation_controller.rb', 'app/controllers/webring/navigation_controller.rb'
       end
 
       # Adds navigation routes to the application's routes.rb file
       # These routes are used to navigate between webring members
-      # @return [void]
       def create_navigation_routes
         route_content = <<~ROUTE
           # Webring navigation routes

data/lib/generators/webring/shared/route_injector.rb

@@ -20,7 +20,6 @@ module Webring
         # to the end of the routes file.
         #
         # @param route_content [String] The routes to be added
-        # @return [void]
         def inject_webring_routes(route_content)
           cleared_route_content = route_content.gsub(/^/, '  ')
           routes_file = 'config/routes.rb'

data/lib/webring/version.rb

@@ -1,3 +1,3 @@
 module Webring
-  VERSION = '1.2.1'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webring-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Nikita Shkoda
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-07 00:00:00.000000000 Z
+date: 2025-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,6 +76,8 @@ files:
 - app/models/webring/membership_request.rb
 - config/routes.rb
 - lib/generators/USAGE
+- lib/generators/webring/custom_widget_controller/custom_widget_controller_generator.rb
+- lib/generators/webring/custom_widget_controller/templates/custom_widget_controller.rb
 - lib/generators/webring/install/install_generator.rb
 - lib/generators/webring/install/templates/AFTER_INSTALL
 - lib/generators/webring/member/member_generator.rb