roda-i18n 0.4.0 → 0.6.0

data/lib/roda/plugins/i18n.rb

@@ -1,217 +1,211 @@
+# frozen_string_literal: true
+
 require 'r18n-core'
 
-# 
 class Roda
-  
-  # 
   module RodaPlugins
-    
     # The i18n plugin allows you to easily add internationalisation (i18n) and
     # localisation support to your Roda app, by adding the following:
-    # 
+    #
     #    plugin :i18n
-    # 
-    # By default the default locale is set to <tt>'en'</tt> and the translations directory 
+    #
+    # By default the default locale is set to <tt>'en'</tt> and the translations directory
     # is set to <tt>'i18n'</tt> in the rooot of your app.
-    # 
+    #
     # Both <tt>:locale</tt> and <tt>:translations</tt> can be overridden during configuration:
-    #    
+    #
     #    plugin :i18n, :locale => ['de'], :translations => ['absolute/path/2/i18n']
-    # 
-    # Please note! 
+    #
+    # Please note!
     #  1) You must set +opts[:root]+ in your app if you don't define the +:translations+ path.
-    #  
+    #
     # 2) When overriding <tt>:translations</tt> the path given <b>must be absolute</b>.
-    # 
+    #
     # The path supports 'wildcards', ie: path/**/i18n so you can load translations from multiple
     # combined apps each with their own <tt>i18n</tt> folder with translations.
-    # 
-    # Note! when loading translations from multiple sources and the same translation key is used 
-    # in both files, the first loaded file takes precedence, ie: <tt>./i18n/en.yml</tt> takes 
+    #
+    # Note! when loading translations from multiple sources and the same translation key is used
+    # in both files, the first loaded file takes precedence, ie: <tt>./i18n/en.yml</tt> takes
     # precedence over <tt>./apps/app1/i18n/en.yml</tt>
-    # 
+    #
     # == USAGE
-    # 
+    #
     # The i18n plugin depends upon simple YAML based translations files:
-    # 
+    #
     #     # app/i18n/en.yml
-    #     
+    #
     #     user:
     #       edit: Edit user
     #       name: User name is %1
     #       count: !!pl
     #         1: There is 1 user
     #         n: There are %1 users
-    #     
-    # 
+    #
+    #
     # and the <tt>:t</tt> instance method to output the translations:
-    # 
-    #     
+    #
+    #
     #     t.user.edit         #=> "Edit user"
     #     t.user.name('John') #=> "User name is John"
     #     t.user.count(5)     #=> "There are 5 users"
-    #     
+    #
     #     t.does.not.exist | 'default' #=> "default"
-    #     
-    #  
+    #
+    #
     # the <tt>:l</tt> instance method provides built-in localisations support:
-    # 
+    #
     #      l Time.now           #=> "03/01/2010 18:54"
     #      l Time.now, :human   #=> "now"
     #      l Time.now, :full    #=> "3rd of January, 2010 18:54"
-    #   
+    #
     # Both the +:t+ and +:l+ methods are available in the route and template (erb) scopes. ie:
-    # 
+    #
     #     route do |r|
     #       r.root do
     #         t.welcome.message
     #       end
     #     end
-    #     
+    #
     #     # app/views/layout.erb
     #     <snip...>
     #       <h1><%= t.welcome.message %></h1>
     #     <snip...>
-    #     
-    # 
-    # 
+    #
+    #
+    #
     # Visit [R18n](https://github.com/ai/r18n/tree/master/r18n-core) for more information.
-    # 
-    # 
+    #
+    #
     # The i18n plugin also makes it easy to handle locales:
-    # 
-    # 
+    #
+    #
     # === <tt>:locale</tt> RequestMethod
-    # 
+    #
     # This request method makes it to handle translations based upon the :locale prefix on a URL,
     #  ie: <tt>blog.com/de/posts</tt>, just use the following code:
-    # 
+    #
     #     route do |r|
-    #       
+    #
     #       r.locale do    # or r.i18n_locale
-    #         r.is 'posts' do 
+    #         r.is 'posts' do
     #           t.posts.header
     #         end
     #       end
-    #       
+    #
     #     end
-    # 
-    # 
+    #
+    #
     # === <tt>:i18n_set_locale_from</tt> RequestMethod
-    # 
+    #
     # Obtains the locale from either ENV, HTTP (browser), Params or Session values
-    # 
-    # 
+    #
+    #
     # Naturally we can allow browsers to override the default locale within routes, like this:
-    # 
+    #
     #     route do |r|
     #       i18n_set_locale_from(:http)  #=> set to the browser's default locale (en-US)
     #       r.get '' do
     #         t.hello  #=> 'Howdy, I speak American English'
     #       end
     #     end
-    # 
+    #
     # The def
-    # 
-    # 
+    #
+    #
     #     route do |r|
     #       i18n_set_locale('de')
     #       r.get 'in-german' do
     #         t.hello  #=> 'Guten tag, ich spreche deutsch'
     #       end
     #     end
-    # 
-    # 
-    # 
-    # 
+    #
+    #
+    #
+    #
     module RodaI18n
-      
       # default options
       OPTS = {
         # set the default locale
-        locale:           'en',
+        locale: 'en',
         # set the default fallback locale
-        default_locale:   'en',
+        default_locale: 'en',
         # set the default translations.
-        translations:     nil
+        translations: nil
       }.freeze
-      
-            
+
       def self.configure(app, opts = OPTS)
-        if app.opts[:i18n]
-          opts = app.opts[:i18n][:orig_opts].merge(opts)
-        else
-          opts = OPTS.merge(opts)
-        end
-        
+        opts = if app.opts[:i18n]
+                 app.opts[:i18n][:orig_opts].merge(opts)
+               else
+                 OPTS.merge(opts)
+               end
+
         app.opts[:i18n]             = opts.dup
         app.opts[:i18n][:orig_opts] = opts
         opts = app.opts[:i18n]
-        
+
         # set the translations path to defaults if nil
         opts[:translations] = File.expand_path('i18n', app.opts[:root]) if opts[:translations].nil?
         ::R18n.default_places = opts[:translations]
-        
-        # default_locale is either 'en' or the set value, so reset :default_locale if 
+
+        # default_locale is either 'en' or the set value, so reset :default_locale if
         # it is somehow nil or an empty string ' '
-        if opts[:default_locale].nil? || opts[:default_locale] =~ /^\s*$/
-          opts[:default_locale] = 'en'
-        end
+        opts[:default_locale] = 'en' if opts[:default_locale].nil? || opts[:default_locale] =~ /^\s*$/
         ::R18n::I18n.default = opts[:default_locale]
-        
-        ::R18n.clear_cache! if ENV['RACK_ENV'] != 'production'
-        i18n   = R18n::I18n.new(
-          opts[:locale], 
+        # :nocov:
+        ::R18n.clear_cache! if ENV['RACK_ENV'] != 'production' # nocov for simple one-liner
+        # :nocov:
+        i18n = R18n::I18n.new(
+          opts[:locale],
           ::R18n.default_places,
-          off_filters:  :untranslated,
-          on_filters:   :untranslated_html
+          off_filters: :untranslated,
+          on_filters: :untranslated_html
         )
         ::R18n.set(i18n)
       end
-      
+
       # methods used within Roda's route block
-      # 
+      #
       module RequestMethods
-        
         # Obtains the locale from either ENV, HTTP (browser), Params or Session
         # values.
-        # 
+        #
         #   route do |r|
         #     # A): set from URL params ie: GET /posts?locale=de
         #     r.i18n_set_locale_from(:params)
-        # 
+        #
         #       /url?locale=de
         #       <%= t.one %>    #=> Ein
         #       /url?locale=es
         #       <%= t.one %>    #=> Uno
-        #     
+        #
         #     # B): set from session[:locale] (if present)
         #     r.i18n_set_locale_from(:session)
-        # 
+        #
         #       session[:locale] = 'de'
         #       <%= t.one %>    #=> Ein
         #       session[:locale] = 'es'
         #       <%= t.one %>    #=> Uno
-        #     
+        #
         #     # C): set from the browser's HTTP request locale
         #     r.i18n_set_locale_from(:http)
-        # 
+        #
         #       HTTP_ACCEPT_LANGUAGE = 'sv-se;q=1,es;q=0.8,en;q=0.6'
         #       <%= t.one %>    #=> Ett
-        #     
+        #
         #     # D): set from the server ENV['LANG'] variable
         #     r.i18n_set_locale_from(:ENV)
-        #     
+        #
         #       ENV['LANG'] = 'en_US.UTF8'
         #         <%= t.one %>    #=> One
         #       ENV['LANG'] = 'es'
         #         <%= t.one %>    #=> Uno
-        #     
-        #     r.is 'posts' do 
+        #
+        #     r.is 'posts' do
         #       t.posts.header # use translations
         #     end
         #   end
-        # 
+        #
         def i18n_set_locale_from(type)
           case type.to_sym
           when :http
@@ -219,7 +213,10 @@ class Roda
           when :session
             loc = session[:locale] if session[:locale]
           when :params
+            # :nocov:
+            # loc will be nil, and caught after the `case` statement
             loc = scope.request.params['locale'] if scope.request.params['locale']
+            # :nocov:
           when :ENV
             # ENV['LANG']="en_US.UTF-8"
             loc = ENV['LANG'].split('.').first if ENV['LANG']
@@ -228,99 +225,102 @@ class Roda
           end
           # sanity check: set to default locale if not set above
           loc = ::R18n::I18n.default.to_s if loc.nil?
-          
+
           i18n = ::R18n::I18n.new(
-            loc, 
+            loc,
             ::R18n.default_places,
-            off_filters:  :untranslated, 
-            on_filters:   :untranslated_html 
+            off_filters: :untranslated,
+            on_filters: :untranslated_html
           )
           ::R18n.set(i18n)
         end
-        
+
         # Enables setting temporary :locale blocks within the routing block.
-        # 
+        #
         #   route do |r|
-        #     
+        #
         #     r.i18n_set_locale('de') do
         #       # within this block the locale is DE (German)
         #     end
-        #     
+        #
         #     r.i18n_set_locale('es') do
         #       # within this block the locale is ES (Spanish)
         #     end
-        #     
+        #
         #   end
-        # 
-        def i18n_set_locale(locale, &blk)
-          locale = ::R18n::I18n.default.to_s if locale.nil?
-          
+        #
+        def i18n_set_locale(locale)
+          sanitized_locale = i18n_set_locale_with_fallback(locale)
+
           i18n = ::R18n::I18n.new(
-            locale, 
-            ::R18n.default_places, 
-            off_filters:  :untranslated, 
-            on_filters:   :untranslated_html
+            sanitized_locale,
+            ::R18n.default_places,
+            off_filters: :untranslated,
+            on_filters: :untranslated_html
           )
           ::R18n.set(i18n)
           yield if block_given?
-          # return # NB!! needed to enable routes below to work
         end
-        
+
         # Match only paths that contain one available locale from the ::R18n.available_locales
         # list, otherwise skip it.
         #
         # This custom matcher allows us to have other routes below the r.locale .. declaration
         def _match_available_locales_only
-         lambda do
-           locale = remaining_path.split("/").reject(&:empty?).first.to_s
-           if ::R18n.available_locales.map(&:code).map(&:downcase).include?(locale.downcase)
-             @captures.push(locale)
-             @remaining_path = remaining_path.sub("/#{locale}", "")
-           end
-         end
+          lambda do
+            locale = remaining_path.split('/').reject(&:empty?).first.to_s
+            if ::R18n.available_locales.map { |locale| locale.code.downcase }.include?(locale.downcase)
+              @captures.push(locale)
+              @remaining_path = remaining_path.sub("/#{locale}", '')
+            end
+          end
         end
-        
+
         # Sets the locale based upon <tt>:locale</tt> prefixed routes
-        #  
+        #
         #   route do |r|
         #     r.locale do
         #       # all routes are prefixed with '/:locale'
         #       # ie: GET /de/posts  => will use DE translations
         #       # ie: GET /es/posts  => will use ES translations
-        #       r.is 'posts' do 
+        #       r.is 'posts' do
         #         t.posts.header # use translations or locales
         #       end
         #     end
         #     r.get(:about) { erb(:about) }
         #   end
         #
-        def locale(opts = {}, &blk)
+        def locale(opts = {})
           on(_match_available_locales_only, opts) do |l|
             loc = l || Roda.opts[:locale]
             ::R18n.set(loc)
-            yield loc if block_given?
+            # :nocov:
+            yield loc if block_given? # nothing will happen without a block
             return # NB!! needed to enable routes below to work
+            # :nocov:
           end
         end
-        alias_method :i18n_locale, :locale
-      
-      end # /module RequestMethods
-      
-      
+        alias i18n_locale locale
+
+        # Sets a fallback for locale => I18n.default
+        def i18n_set_locale_with_fallback(locale)
+          return ::R18n::I18n.default.to_s if locale.nil?
+
+          locale
+        end
+      end
+
       module ClassMethods
-        
         # Return the i18n options for this plugin.
         def i18n_opts
           opts[:i18n]
         end
-        
-      end # /module ClassMethods
-      
-      
+      end
+
       # defines method available within the views / routing block
       module InstanceMethods
         include ::R18n::Helpers
-        
+
         def i18n_available_locales
           @available_locales = []
           ::R18n.available_locales.each do |l|
@@ -328,15 +328,13 @@ class Roda
           end
           @available_locales
         end
-        
+
         def i18n_default_places
           ::R18n.default_places
         end
-        
       end
-      
-    end # /module RodaI18n
-    
+    end
+
     register_plugin(:i18n, RodaI18n)
-  end # /module RodaPlugins
-end # /class Roda
+  end
+end

data/roda-i18n.gemspec

@@ -1,19 +1,20 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'roda/i18n/version'
 
 Gem::Specification.new do |spec|
   spec.name           = 'roda-i18n'
-  spec.version        = ::Roda::I18n::VERSION
+  spec.version        = Roda::I18n::VERSION
   spec.authors        = ['Kematzy']
   spec.email          = ['kematzy@gmail.com']
-  
+
   spec.summary        = 'Roda Internationalisation plugin'
-  spec.description    = "The Roda-i18n plugin enables easy addition of internationalisation (i18n) and localisation support in Roda apps"
+  spec.description    = 'The Roda-i18n plugin enables easy addition of internationalisation (i18n) and localisation support in Roda apps'
   spec.homepage       = 'http://github.com/kematzy/roda-i18n'
   spec.license        = 'MIT'
-  
+
   # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
   # delete this section to allow pushing this gem to any host.
   # if spec.respond_to?(:metadata)
@@ -22,29 +23,25 @@ Gem::Specification.new do |spec|
   #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   # end
 
-  spec.files          = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir         = "exe"
+  spec.files          = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features|.github|.devcontainer)/}) ||
+      f.match(/^(Dockerfile|.tool-versions|justfile|.rubocop)/)
+  end
+  spec.bindir         = 'exe'
   spec.executables    = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths  = ["lib"]
-  
+  spec.require_paths  = ['lib']
+
   spec.platform         = Gem::Platform::RUBY
-  spec.has_rdoc         = true
-  spec.extra_rdoc_files = ['README.md', "MIT-LICENSE"]
-  spec.rdoc_options     += ['--quiet', '--line-numbers', '--inline-source', '--title', 'Roda-i18n: internationalisation plugin', '--main', 'README.md']
-  
-  spec.add_runtime_dependency 'roda', '~> 3.7'
-  spec.add_runtime_dependency 'tilt'  
-  spec.add_runtime_dependency 'r18n-core', '~> 3.0'
-  
-  spec.add_development_dependency 'bundler', "~> 1.10"
-  spec.add_development_dependency 'rake', "~> 12.3"
-  spec.add_development_dependency 'erubis'
-  spec.add_development_dependency 'kramdown'
-  spec.add_development_dependency 'minitest', '~> 5.7', '>= 5.7.0'
-  spec.add_development_dependency 'minitest-hooks', '~> 1.1', '>= 1.1.0'
-  spec.add_development_dependency 'minitest-rg'
-  spec.add_development_dependency 'rack-test', '~> 1.0'
-  spec.add_development_dependency 'nokogiri'
-  spec.add_development_dependency 'simplecov'
-  
+  spec.extra_rdoc_files = ['README.md', 'MIT-LICENSE']
+  spec.rdoc_options += ['--quiet', '--line-numbers', '--inline-source', '--title',
+                        'Roda-i18n: internationalisation plugin', '--main', 'README.md']
+
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.add_dependency 'date'
+  spec.add_dependency 'r18n-core', '~> 5'
+  spec.add_dependency 'roda', '~> 3.8'
+  spec.add_dependency 'tilt'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end