webring-rails 1.0.0

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

@@ -0,0 +1,63 @@
+==============================================
+Webring Engine Has Been Successfully Installed!
+==============================================
+
+The Webring engine has been mounted at '/webring' in your application. Below are
+the next steps to complete the webring setup and customization options.
+
+1. Configure Your Members Model
+-------------------------------
+Generate a member model to store information about sites in your webring:
+
+    $ rails generate webring:member
+
+This will:
+  - Create a Webring::Member model in app/models/webring/member.rb
+  - Create a migration to set up the webring_members table
+  - Add appropriate database indexes
+
+After generating the model, run the migration:
+
+    $ rails db:migrate
+
+2. Generate Navigation Controller [Optional]
+--------------------------------------------
+Generate a navigation controller to handle navigation between webring members:
+
+    $ rails generate webring:controller
+
+This will:
+  - Create the Webring::NavigationController in app/controllers/webring/navigation_controller.rb
+  - Add navigation routes to your routes.rb file:
+    - GET /webring/next     - Navigate to the next site
+    - GET /webring/previous - Navigate to the previous site
+    - GET /webring/random   - Navigate to a random site
+
+3. Customize Your Routes [Optional]
+----------------------------------
+The engine is mounted at '/webring' by default. You can change this in your routes.rb file:
+
+    # Original mount point
+    mount Webring::Engine => '/webring', as: 'webring'
+
+    # Example custom mount point
+    mount Webring::Engine => '/network', as: 'webring'
+
+4. Add Webring Navigation UI Elements
+------------------------------------
+Add navigation links to your views to enable users to navigate through the webring:
+
+    <%= link_to 'Next Site', webring.next_path(source_member_uid: your_member.uid) %>
+    <%= link_to 'Previous Site', webring.previous_path(source_member_uid: your_member.uid) %>
+    <%= link_to 'Random Site', webring.random_path %>
+
+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
+--------------------------
+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.

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

@@ -0,0 +1,55 @@
+require 'rails/generators/active_record'
+require 'rails/generators/named_base'
+require_relative '../shared/route_injector'
+
+module Webring
+  module Generators
+    # @description The MemberGenerator creates the Member model, which is the core of the webring
+    # It creates both the model file and a migration to create the database table
+    #
+    # @usage Run: rails generate webring:member
+    #
+    # @example Generated Member model has the following attributes:
+    #   # 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)
+    #
+    # @note After running this generator, you should run the migration with:
+    #       rails db:migrate
+    class MemberGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      include Shared::RouteInjector
+
+      source_root File.expand_path('templates', __dir__)
+
+      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
+
+      # 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/member/templates/AFTER_INSTALL

@@ -0,0 +1,38 @@
+==============================================
+Webring::Member Model Has Been Generated!
+==============================================
+
+The Member model is the core component of the webring, representing each site
+in your webring network. Follow these steps to complete the setup:
+
+1. Run Database Migration
+------------------------
+Apply the migration to create the webring_members table:
+
+    $ rails db:migrate
+
+2. Review and Customize the Model
+-------------------------------
+The generated model is located at:
+    app/models/webring/member.rb
+
+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)
+  - url: The URL 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')
+
+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.

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

@@ -0,0 +1,15 @@
+class CreateWebringMembers < ActiveRecord::Migration<%= "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" %>
+  def change
+    create_table :webring_members do |t|
+      t.string :uid, null: false, limit: 32
+      t.string :name
+      t.string :url, null: false
+
+      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

@@ -0,0 +1,31 @@
+module Webring
+  class Member < ApplicationRecord
+    extend Webring::Navigation
+
+    UID_LENGTH = 16 # 32-character hex string
+
+    validates :url, presence: true, uniqueness: true
+    validates :name, uniqueness: true, if: -> { name.present? }
+    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
+    end
+
+    private
+
+    def generate_uid
+      loop do
+        self.uid = SecureRandom.hex(UID_LENGTH)
+        break unless self.class.exists?(uid: uid)
+      end
+    end
+
+    def set_name_from_url
+      self.name = url
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Webring
+  module Generators
+    module Shared
+      # @description The RouteInjector module provides utility methods for injecting routes
+      # into the application's routes.rb file. It's used by various Webring generators
+      # to add their respective routes.
+      #
+      # @usage Include this module in a generator class:
+      #   include Webring::Generators::Shared::RouteInjector
+      #
+      # @example
+      #   # Then you can use the inject_webring_routes method:
+      #   inject_webring_routes("namespace :webring do\n  resources :members\nend")
+      module RouteInjector
+        private
+
+        # Injects routes into the application's routes.rb file
+        # If the Webring engine is already mounted, this will add the routes
+        # right after the engine's mount point. Otherwise, it will add them
+        # 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'
+          mount_point = "mount Webring::Engine => '/webring', as: 'webring'\n"
+
+          if File.read(routes_file).include?(mount_point)
+            inject_into_file routes_file, after: mount_point do
+              "\n#{cleared_route_content}"
+            end
+          else
+            route "#{cleared_route_content}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/webring_generator.rb

@@ -0,0 +1,17 @@
+module Webring
+  module Generators
+    class WebringGenerator < Rails::Generators::NamedBase
+      namespace 'webring'
+
+      desc 'Creates a Webring configuration for the given model name'
+
+      def invoke_webring_member
+        invoke 'webring:member'
+      end
+
+      def invoke_webring_controller
+        invoke 'webring:controller'
+      end
+    end
+  end
+end

data/lib/webring/engine.rb

@@ -0,0 +1,35 @@
+module Webring
+  class Engine < ::Rails::Engine
+    isolate_namespace Webring
+
+    # configure app generators for templates
+    config.app_generators do |g|
+      g.templates.unshift File.expand_path('../../generators/webring/templates', __dir__)
+    end
+
+    # load generators properly for Rails compatibility
+    initializer 'webring.load_generators' do |app|
+      generators_path = File.expand_path('../../generators', __dir__)
+
+      # add generators path to Rails paths
+      if defined?(Rails.application.config.generators.templates)
+        Rails.application.config.generators.templates.unshift(File.join(generators_path, 'webring/templates'))
+      end
+
+      # ensure the generators path exists in the app's paths
+      if app.config.respond_to?(:paths)
+        app.config.paths['lib/generators'] ||= []
+        app.config.paths['lib/generators'] << generators_path
+      end
+    end
+
+    # add migrations from the engine to the main app
+    initializer 'webring.append_migrations' do |app|
+      unless app.root.to_s == root.to_s
+        config.paths['db/migrate'].expanded.each do |expanded_path|
+          app.config.paths['db/migrate'] << expanded_path
+        end
+      end
+    end
+  end
+end

data/lib/webring/version.rb

@@ -0,0 +1,3 @@
+module Webring
+  VERSION = '1.0.0'.freeze
+end

data/lib/webring_rails.rb

@@ -0,0 +1,5 @@
+require 'webring/version'
+require 'webring/engine'
+
+module Webring
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: webring-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nikita Shkoda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.75'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.31'
+description: Mountable Rails Engine for webring implementation with an embeddable
+  styled widget
+email:
+- lstpsche@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- app/assets/javascripts/webring/widget.js
+- app/controllers/webring/application_controller.rb
+- app/controllers/webring/members_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/navigation.rb
+- app/models/webring/application_record.rb
+- app/models/webring/member.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/shared/route_injector.rb
+- lib/generators/webring_generator.rb
+- lib/webring/engine.rb
+- lib/webring/version.rb
+- lib/webring_rails.rb
+homepage: https://github.com/lstpsche/webring_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lstpsche/webring_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.7
+signing_key:
+specification_version: 4
+summary: WebRing plugin for Rails
+test_files: []