polyglot_routes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6cd3af8eca58dbea83f3a544870c6eda563a4863ffd12dfe0dd203dd48c9236
+  data.tar.gz: 50be1e14228851e8857388e5878a935dd16c127b721d264a554dc7ae1a59f503
+SHA512:
+  metadata.gz: 483b19a6846c37da4dee1ea84f3efb85602989693b1eb05b16871a6a7329b3c0dc8ffdb34cce2de8877bcf7a6413b4ae6dd7292fb0c464ab0925bf1baecb571f
+  data.tar.gz: 5defc3ceadbdf6e3fa9005924744699fe0c97f5a2dde6f714980526d28e048db938e992328d65e40d242cdb5823c639709f8bbb608a3cd7db809375debd5142f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bruno Costanzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# polyglot_routes
+
+[![Gem Version](https://img.shields.io/gem/v/polyglot_routes)](https://rubygems.org/gems/polyglot_routes)
+[![CI](https://github.com/bruno-costanzo/polyglot_routes/actions/workflows/ci.yml/badge.svg)](https://github.com/bruno-costanzo/polyglot_routes/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](test)
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%203.2-CC342D)](polyglot_routes.gemspec)
+[![Rails](https://img.shields.io/badge/rails-%3E%3D%207.1-D30001)](polyglot_routes.gemspec)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue)](LICENSE.txt)
+
+Translated Rails routes for every locale. No setup: you only write routes.
+
+## Install
+
+```ruby
+gem "polyglot_routes"
+```
+
+## Use
+
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  localized do
+    root "pages#home"
+    resources :products
+  end
+end
+```
+
+```yaml
+# config/locales/es.yml
+es:
+  routes:
+    products: productos
+    new: nuevo
+    edit: editar
+```
+
+With `I18n.available_locales = [:en, :es]` and `:en` as the default locale:
+
+| Path                       | Controller        | `I18n.locale` |
+|----------------------------|-------------------|---------------|
+| `/products/new`            | `products#new`    | `en`          |
+| `/es/productos/nuevo`      | `products#new`    | `es`          |
+| `/es`                      | `pages#home`      | `es`          |
+
+- The default locale has no prefix. Other locales get `/<locale>`.
+- A segment without a translation stays the same.
+- Each request sets `I18n.locale` from the URL.
+
+## Helpers
+
+```ruby
+products_path                 # follows I18n.locale
+products_path(locale: :es)    # "/es/productos"
+products_es_path              # one helper per locale
+switch_locale_path(:en)       # current page in another locale (views and controllers)
+```
+
+Only some locales: `localized(locales: %i[en es]) { ... }`.
+
+## License
+
+MIT

data/lib/polyglot_routes/controller.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PolyglotRoutes
+  # Included in every controller by the Railtie.
+  module Controller
+    def self.included(base)
+      base.around_action :polyglot_routes_with_locale
+      base.helper_method :switch_locale_path if base.respond_to?(:helper_method)
+    end
+
+    # The current page in another locale: switch_locale_path(:es)
+    def switch_locale_path(locale)
+      url_for(request.path_parameters.merge(locale: locale.to_s, only_path: true,
+                                            params: request.query_parameters))
+    end
+
+    private
+
+    def polyglot_routes_with_locale(&action)
+      locale = request.path_parameters[:locale]
+      locale ? I18n.with_locale(locale, &action) : yield
+    end
+  end
+end

data/lib/polyglot_routes/mapper.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module PolyglotRoutes
+  # Prepended into ActionDispatch::Routing::Mapper.
+  module Mapper
+    # Draws every route in the block once per locale.
+    #
+    #   localized do
+    #     resources :products
+    #   end
+    def localized(locales: PolyglotRoutes.locales)
+      locales = locales.map(&:to_s)
+      unknown = locales - PolyglotRoutes.locales
+      raise ArgumentError, "Unknown locales for localized: #{unknown.join(", ")}" if unknown.any?
+
+      previous = @polyglot_routes_locales
+      @polyglot_routes_locales = locales
+      yield
+    ensure
+      @polyglot_routes_locales = previous
+    end
+
+    private
+
+    def add_route(*args)
+      return super if @polyglot_routes_locales.nil? || @polyglot_routes_locale
+
+      @polyglot_routes_locales.each do |locale|
+        @polyglot_routes_locale = locale
+        @scope = @scope.new(defaults: (@scope[:defaults] || {}).merge(locale: locale))
+        super
+      ensure
+        @scope = @scope.parent
+        @polyglot_routes_locale = nil
+      end
+
+      define_polyglot_routes_helpers
+    end
+
+    def path_for_action(action, path)
+      result = super
+      @polyglot_routes_locale ? PolyglotRoutes.translate_path(result, @polyglot_routes_locale) : result
+    end
+
+    def name_for_action(as, action)
+      name = super
+      return name unless @polyglot_routes_locale && name
+
+      localized = "#{name}_#{@polyglot_routes_locale}"
+      return if as == ActionDispatch::Routing::Mapper::DEFAULT && has_named_route?(localized)
+
+      @polyglot_routes_last_name = name
+      localized
+    end
+
+    # Defines `products_path` / `products_url` that call the helper for I18n.locale.
+    def define_polyglot_routes_helpers
+      name = @polyglot_routes_last_name
+      @polyglot_routes_last_name = nil
+      return unless name
+
+      { "path" => @set.named_routes.path_helpers_module,
+        "url" => @set.named_routes.url_helpers_module }.each do |kind, helpers|
+        helpers.define_method("#{name}_#{kind}") do |*args|
+          PolyglotRoutes.call_helper(self, name, kind, args)
+        end
+      end
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.prepend(PolyglotRoutes::Mapper)

data/lib/polyglot_routes/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module PolyglotRoutes
+  class Railtie < Rails::Railtie
+    initializer "polyglot_routes.controller" do
+      ActiveSupport.on_load(:action_controller) { include PolyglotRoutes::Controller }
+    end
+  end
+end

data/lib/polyglot_routes/version.rb

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

data/lib/polyglot_routes.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "i18n"
+require "action_dispatch"
+require "polyglot_routes/version"
+require "polyglot_routes/mapper"
+require "polyglot_routes/controller"
+require "polyglot_routes/railtie" if defined?(Rails::Railtie)
+
+module PolyglotRoutes
+  DYNAMIC_SEGMENT = /[:*()]/
+
+  module_function
+
+  def locales
+    I18n.available_locales.map(&:to_s)
+  end
+
+  def default_locale
+    I18n.default_locale.to_s
+  end
+
+  # "/products/:id/edit" + "es" => "/es/productos/:id/editar"
+  def translate_path(path, locale)
+    segments = path.split("/").map do |segment|
+      next segment if segment.empty? || segment.match?(DYNAMIC_SEGMENT)
+
+      I18n.t(segment, scope: :routes, locale: locale, default: segment)
+    end
+
+    translated = segments.join("/")
+    translated = "/#{translated}" unless translated.start_with?("/")
+    return translated if locale == default_locale
+
+    translated == "/" ? "/#{locale}" : "/#{locale}#{translated}"
+  end
+
+  # Called by `products_path`: picks `products_es_path` for the current locale.
+  def call_helper(context, name, kind, args)
+    args = args.dup
+    options = args.last.is_a?(Hash) ? args.pop.dup : {}
+    wanted = options.key?(:locale) ? options.delete(:locale) : I18n.locale
+    args << options unless options.empty?
+
+    locale = [wanted.to_s, default_locale, *locales].find do |candidate|
+      context.respond_to?("#{name}_#{candidate}_#{kind}")
+    end
+    context.public_send("#{name}_#{locale}_#{kind}", *args)
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: polyglot_routes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bruno Costanzo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: Wrap your routes in `localized` and get one translated route per locale,
+  locale-aware URL helpers and I18n.locale set from the URL.
+email:
+- dev.bcostanzo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/polyglot_routes.rb
+- lib/polyglot_routes/controller.rb
+- lib/polyglot_routes/mapper.rb
+- lib/polyglot_routes/railtie.rb
+- lib/polyglot_routes/version.rb
+homepage: https://github.com/bruno-costanzo/polyglot_routes
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Translated Rails routes for every locale, with no setup.
+test_files: []