webring-rails 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 919f405578a35bb65238570b3e7bdc650e2685ac435dde5f40a814828dfbc491
-  data.tar.gz: db6dd54f0c3138e534c4dfe7ec3bce2075e1d06e978ca21865ef099ac253256f
+  metadata.gz: 9f2abb7d64673f6596274eaeb143aa6378f0ce099a86880765a10ba0c951a9be
+  data.tar.gz: c5ad3ea3677093b17e271784910c47c57b3a3f45b3f222cd0ca736bbfca4ab8a
 SHA512:
-  metadata.gz: 7b89d911a5b51898e9a2ac0f8c157fd5d1aac5e54a885918a6bdf76a3758721501d6040c97fe4df93a692d373806df21dcff26456d7546ceb23b935c77b723cc
-  data.tar.gz: 6072b3a3573f4c9433f11472eba97590dc7cb4af7c53db2b5b476d3590787d99d9a98b64f1fee64787bdc6c6190b4308741637ce4f8af1fff901e653e241a75b
+  metadata.gz: 18c794c278923c41f060667a806d3a5968e5b05f9e133c989817c881980939568c9aacccffc63b349fbcd6e4475f5fe94e27be8b8253bee41bf3d0aeb21b84a9
+  data.tar.gz: d83a28c05cedaec133e26c4936b33a3c786bf276ade1318665cc8ea2542bf01ea9e8180fdb32a92a83a9f3ce5ac9b92399efad4b7ea2e01e1877ae87050d8c09

data/README.md

@@ -1,8 +1,8 @@
-![Webring Widget Sample](widget-sample.jpeg)
+![Webring Widget Sample](widget-sample.png)
 
 # Webring for Rails
 
-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.
+[Webring for Rails (webring-rails)](https://github.com/lstpsche/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.
 
 ## Features
 

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

@@ -22,6 +22,10 @@
  *   - full: Apply all styles (default)
  *   - layout: Only layout styles, no visual design
  *   - none: No styles applied
+ * - data-prev-text="Custom Text": Sets custom text for the "previous" button. Default: "« Prev"
+ * - data-random-text="Custom Text": Sets custom text for the "random" button (keeps the logo). Default: "Random"
+ * - data-next-text="Custom Text": Sets custom text for the "next" button. Default: "Next »"
+ * - data-widget-text="Custom Text": Sets custom text for the widget title. Default: "Webring"
  */
 
 (function() {
@@ -32,36 +36,73 @@
     DEFAULT_TARGET_ID: 'webring-widget',
     STYLE_ID: 'webring-widget-styles',
     VALID_STYLE_TYPES: ['full', 'layout', 'none'],
-    DEFAULT_STYLE_TYPE: 'full'
+    DEFAULT_STYLE_TYPE: 'full',
+    DEFAULT_TEXTS: {
+      PREV: '« Prev',
+      RANDOM: 'Random',
+      NEXT: 'Next »',
+      WIDGET: 'Webring'
+    }
+  };
+
+  // Default text configurations
+  const TEXT_DEFAULTS = {
+    prev: { default: '« Prev', enforced: false },
+    random: { default: 'Random', enforced: false },
+    next: { default: 'Next »', enforced: false },
+    widgetTitle: { default: 'Webring', enforced: false }
   };
 
+  // These defaults will be provided by the widget_controller
+  const PROVIDED_TEXT_DEFAULTS = "<<REPLACE_ME_TEXT_DEFAULTS>>";
+
+  // Parse the provided defaults JSON string
+  const parsedProvidedDefaults =
+    PROVIDED_TEXT_DEFAULTS !== "<<REPLACE_ME_TEXT_DEFAULTS>>"
+      ? (typeof PROVIDED_TEXT_DEFAULTS === 'string' ? JSON.parse(PROVIDED_TEXT_DEFAULTS) : PROVIDED_TEXT_DEFAULTS)
+      : {};
+
+  // Merge defaults with provided defaults, with provided taking priority
+  const FULL_TEXT_DEFAULTS = Object.keys(TEXT_DEFAULTS).reduce((acc, key) => {
+    acc[key] = {
+      default: parsedProvidedDefaults[key]?.default || TEXT_DEFAULTS[key].default,
+      enforced: parsedProvidedDefaults[key]?.enforced || TEXT_DEFAULTS[key].enforced
+    };
+    return acc;
+  }, {});
+
   const logoSvg = (width = 20, height = 20, style = "") => `<<REPLACE_ME_LOGO_SVG>>`;
 
   const NAVIGATION_ACTIONS = {
     prev: {
       symbol: '«',
-      text: '« Prev',
+      text: `« ${FULL_TEXT_DEFAULTS.prev.default}`,
+      text_enforced: FULL_TEXT_DEFAULTS.prev.enforced,
       title: 'Previous site',
-      path: 'previous'
+      path: 'previous',
+      additionalClass: 'prev-btn'
     },
     random: {
-      symbol: logoSvg(22, 22),
-      text: `${logoSvg(20, 20, "margin-right: 4px; margin-top: 1px;")} Random`,
+      symbol: logoSvg(23, 23),
+      text: `${logoSvg(20, 20, "margin-right: 4px; margin-top: 1px;")} ${FULL_TEXT_DEFAULTS.random.default}`,
+      text_enforced: FULL_TEXT_DEFAULTS.random.enforced,
       title: 'Random site',
       path: 'random',
       additionalClass: 'random-btn'
     },
     next: {
       symbol: '»',
-      text: 'Next »',
+      text: `${FULL_TEXT_DEFAULTS.next.default} »`,
+      text_enforced: FULL_TEXT_DEFAULTS.next.enforced,
       title: 'Next site',
-      path: 'next'
+      path: 'next',
+      additionalClass: 'next-btn'
     },
     logoOnly: {
-      symbol: logoSvg(22, 22),
-      text: `${logoSvg(20, 20)} Random`,
-      title: 'Ruby Webring',
-      path: ''
+      symbol: logoSvg(23, 23),
+      text: logoSvg(23, 23),
+      path: '',
+      additionalClass: 'logo-only'
     }
   };
 
@@ -104,7 +145,7 @@
         text-decoration: none;
       }
       .webring-nav a.webring-btn.random-btn {
-        padding: 6px 9px 6px 9px;
+        padding: 6px 8px 6px 8px;
       }
       .webring-nav .logo-only {
         padding: 8px 3px 6px 3px;
@@ -121,6 +162,16 @@
         margin-right: 6px;
         margin-top: 1px;
       }
+      /* no-text prev button */
+      .webring-nav[data-button-text="false"] a.webring-btn.prev-btn {
+        padding-top: 5px;
+        padding-right: 12.5px;
+      }
+      /* no-text next button */
+      .webring-nav[data-button-text="false"] a.webring-btn.next-btn {
+        padding-top: 5px;
+        padding-left: 12.5px;
+      }
     `,
     design: `
       .webring-nav[data-widget-type="full"] {
@@ -130,6 +181,7 @@
         font-weight: 600;
       }
       .webring-nav a.webring-btn {
+        text-wrap: nowrap;
         color: #000000;
         font-weight: 600;
         background-color: #ffffff;
@@ -172,6 +224,12 @@
     const stylesType = script.getAttribute('data-styles') || WIDGET_CONFIG.DEFAULT_STYLE_TYPE;
     const stylesOption = WIDGET_CONFIG.VALID_STYLE_TYPES.includes(stylesType) ? stylesType : WIDGET_CONFIG.DEFAULT_STYLE_TYPE;
 
+    // Custom text data attributes
+    const prevText = script.getAttribute('data-prev-text');
+    const randomText = script.getAttribute('data-random-text');
+    const nextText = script.getAttribute('data-next-text');
+    const widgetText = script.getAttribute('data-widget-text');
+
     if (!memberUid) {
       console.error('Webring Widget: Missing data-member-uid attribute on script tag.');
       return;
@@ -192,14 +250,31 @@
         return;
       }
 
+      // Apply custom texts if provided or use defaults based on enforcement settings
+      const customTexts = {
+        prev: NAVIGATION_ACTIONS.prev.text_enforced ?
+          { ...NAVIGATION_ACTIONS.prev } :
+          (prevText ? { ...NAVIGATION_ACTIONS.prev, text: `« ${prevText}` } : NAVIGATION_ACTIONS.prev),
+        random: NAVIGATION_ACTIONS.random.text_enforced ?
+          { ...NAVIGATION_ACTIONS.random } :
+          (randomText ? {
+            ...NAVIGATION_ACTIONS.random,
+            text: `${logoSvg(20, 20, "margin-right: 4px; margin-top: 1px;")} ${randomText}`
+          } : NAVIGATION_ACTIONS.random),
+        next: NAVIGATION_ACTIONS.next.text_enforced ?
+          { ...NAVIGATION_ACTIONS.next } :
+          (nextText ? { ...NAVIGATION_ACTIONS.next, text: `${nextText} »` } : NAVIGATION_ACTIONS.next),
+        logoOnly: NAVIGATION_ACTIONS.logoOnly
+      };
+
       // Navigation links
       const config = WIDGET_TYPE_CONFIG[widgetType];
       const linkElements = config.actions.map(action => {
-        const actionConfig = NAVIGATION_ACTIONS[action];
+        const actionConfig = customTexts[action] || NAVIGATION_ACTIONS[action];
 
         // Logo-only block
         if (action === 'logoOnly') {
-          return `<div class="logo-only">${logoSvg(22, 22)}</div>`;
+          return `<div class="${actionConfig.additionalClass}">${actionConfig.symbol}</div>`;
         }
 
         const url = `${baseUrl}/webring/${actionConfig.path}?source_member_uid=${memberUid}`;
@@ -208,8 +283,12 @@
 
         // One-way type case
         if (widgetType === 'one-way' && config.showLogoInButton && action === 'next') {
+          const buttonTextContent = NAVIGATION_ACTIONS.next.text_enforced ?
+            FULL_TEXT_DEFAULTS.next.default :
+            (nextText || customTexts.next.text.replace(' »', ''));
+
           label = buttonText
-            ? `<span class="webring-logo-inline">${logoSvg(20, 20)}</span> ${actionConfig.text}`
+            ? `<span class="webring-logo-inline">${logoSvg(20, 20)}</span> ${buttonTextContent} »`
             : `<span class="webring-logo-inline">${logoSvg(20, 20)}</span> ${actionConfig.symbol}`;
         }
 
@@ -217,9 +296,13 @@
       }).join('\n          ');
 
       // Create widget HTML
-      const title = config.showTitle ? '<span class="webring-title">Ruby Webring</span>' : '';
+      const titleText = FULL_TEXT_DEFAULTS.widgetTitle.enforced ?
+        FULL_TEXT_DEFAULTS.widgetTitle.default :
+        (widgetText || FULL_TEXT_DEFAULTS.widgetTitle.default);
+
+      const title = config.showTitle ? `<span class="webring-title">${titleText}</span>` : '';
       container.innerHTML = `
-        <div class="webring-nav" data-widget-type="${widgetType}">
+        <div class="webring-nav" data-widget-type="${widgetType}" data-button-text="${buttonText}">
           ${title}
           <nav class="webring-buttons">
             ${linkElements}

data/app/controllers/webring/widget_controller.rb

@@ -19,6 +19,7 @@ module Webring
             .root.join('app/assets/javascripts/webring/widget.js')
             .read
             .gsub('<<REPLACE_ME_LOGO_SVG>>', logo_svg)
+            .gsub('"<<REPLACE_ME_TEXT_DEFAULTS>>"', JSON.generate(text_defaults))
 
           render js: widget_js
         end
@@ -42,5 +43,16 @@ module Webring
         </svg>
       SVG
     end
+
+    # Provide default texts for the widget
+    # Override this method to customize the default texts
+    def text_defaults
+      {
+        prev: { default: 'Prev', enforced: false },
+        random: { default: 'Random', enforced: false },
+        next: { default: 'Next', enforced: false },
+        widgetTitle: { default: 'Webring', enforced: false }
+      }
+    end
   end
 end

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

@@ -9,5 +9,16 @@ module Webring
         Add your custom logo SVG here
       SVG
     end
+
+    # Override default texts for the widget
+    # Remove the method or call `super` to use the gem's default texts
+    def text_defaults
+      {
+        prev: { default: 'Prev', enforced: false },
+        random: { default: 'Random', enforced: false },
+        next: { default: 'Next', enforced: false },
+        widgetTitle: { default: 'Webring', enforced: false }
+      }
+    end
   end
 end

data/lib/webring/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webring-rails
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Nikita Shkoda