preferred_locale 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25d7d501311ec07eb4453107066175a7ff0d34493084cc3e8d0b38864147ff3e
+  data.tar.gz: 8bf555fc4424a836839253ba9b88c1f464d2be7d97d1d7c7f20b07ee03ac8f39
+SHA512:
+  metadata.gz: b306fd65e2dfe7203705a4904b9ba5df4eb370695aa453ecb8685df8201ddc358736a200a515cd2afad41025a628c5f0bec7162087e1b8f499ad8203a5698ab1
+  data.tar.gz: 67a93005c500cc999f628a0b016ae9454b55bb8cf64c4cff65597cc9a7b08b24340ecd9336223bc61607362d3608f0c85b6e47d007094cd0dedeee2b6411c208

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,289 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+AllCops:
+  NewCops: enable
+  DisplayCopNames: false
+  DisplayStyleGuide: true
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.7
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    inject: reduce
+    detect: find
+    find_all: select
+Style/CommentAnnotation:
+  Enabled: true
+  Keywords:
+    - TODO
+    - FIXME
+    - OPTIMIZE
+    - HACK
+    - REVIEW
+    - DEPRECATED
+Layout/DotPosition:
+  EnforcedStyle: leading
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+Style/FormatString:
+  Enabled: true
+  EnforcedStyle: format
+Style/FrozenStringLiteralComment:
+  SafeAutoCorrect: true
+  Enabled: true
+Style/GlobalVars:
+  Enabled: false
+Style/GuardClause:
+  Enabled: true
+  MinBodyLength: 3
+Style/IfUnlessModifier:
+  Enabled: true
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Style/LambdaCall:
+  Enabled: true
+Style/Next:
+  Enabled: true
+  MinBodyLength: 3
+Style/NumericLiterals:
+  Enabled: true
+  MinDigits: 5
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    '%': '[]'
+    '%i': '[]'
+    '%q': '[]'
+    '%Q': '[]'
+    '%r': '{}'
+    '%s': '()'
+    '%w': '[]'
+    '%W': '[]'
+    '%x': '[]'
+Style/RaiseArgs:
+  Enabled: true
+  EnforcedStyle: exploded
+Style/SingleLineMethods:
+  Enabled: true
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+  EnforcedStyle: space
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+Style/SymbolProc:
+  Enabled: true
+Layout/TrailingEmptyLines:
+  Enabled: true
+  EnforcedStyle: final_newline
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: no_comma
+Style/TrivialAccessors:
+  Enabled: true
+  AllowDSLWriters: true
+Naming/VariableName:
+  Enabled: true
+  EnforcedStyle: snake_case
+Style/WordArray:
+  Enabled: true
+  MinSize: 2
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 5
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: true
+  CountComments: false
+  Max: 500
+Metrics/ModuleLength:
+  Enabled: true
+  CountComments: false
+  Max: 500
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Layout/LineLength:
+  Enabled: true
+  Max: 100
+  AllowURI: true
+  IgnoreCopDirectives: true
+  Exclude:
+    - config/routes.rb
+Metrics/MethodLength:
+  Enabled: true
+  CountComments: false
+  Max: 100
+Metrics/ParameterLists:
+  Enabled: true
+  Max: 5
+  CountKeywordArgs: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: true
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Enabled: false
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+Style/SymbolArray:
+  Enabled: true
+Naming/AccessorMethodName:
+  Enabled: true
+Style/Alias:
+  Enabled: true
+  EnforcedStyle: prefer_alias_method
+Style/ArrayJoin:
+  Enabled: true
+Style/AsciiComments:
+  Enabled: false
+Naming/AsciiIdentifiers:
+  Enabled: true
+Style/Attr:
+  Enabled: true
+Style/BlockComments:
+  Enabled: true
+Style/ColonMethodCall:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/EmptyLiteral:
+  Enabled: true
+Style/EvenOdd:
+  Enabled: true
+Lint/FlipFlop:
+  Enabled: true
+Style/IfWithSemicolon:
+  Enabled: true
+Style/Lambda:
+  EnforcedStyle: literal
+  # HACK: Until Rubocop is released with EnforcedStyle
+  Enabled: true
+Layout/LeadingCommentSpace:
+  Enabled: true
+Style/MultilineBlockChain:
+  Enabled: true
+Style/MultilineTernaryOperator:
+  Enabled: true
+Style/NegatedIf:
+  Enabled: true
+Style/NestedTernaryOperator:
+  Enabled: true
+Style/NilComparison:
+  Enabled: true
+Style/Not:
+  Enabled: true
+Style/OneLineConditional:
+  Enabled: true
+Style/PerlBackrefs:
+  Enabled: true
+Style/RedundantBegin:
+  Enabled: true
+Style/RedundantSelf:
+  Enabled: true
+Style/RescueModifier:
+  Enabled: true
+Style/SelfAssignment:
+  Enabled: true
+Style/ClassAndModuleChildren:
+  Enabled: true
+  Exclude:
+    - app/graphql/**/*
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+Layout/SpaceAfterColon:
+  Enabled: true
+Layout/SpaceAfterComma:
+  Enabled: true
+Layout/SpaceAroundKeyword:
+  Enabled: true
+Layout/SpaceAfterMethodName:
+  Enabled: true
+Layout/SpaceAfterNot:
+  Enabled: true
+Layout/SpaceAfterSemicolon:
+  Enabled: true
+Layout/SpaceBeforeComma:
+  Enabled: true
+Layout/SpaceBeforeComment:
+  Enabled: true
+Layout/SpaceBeforeSemicolon:
+  Enabled: true
+Layout/SpaceAroundOperators:
+  Enabled: true
+Layout/SpaceInsideParens:
+  Enabled: true
+Layout/SpaceInsideRangeLiteral:
+  Enabled: true
+Style/SpecialGlobalVars:
+  Enabled: true
+Layout/TrailingWhitespace:
+  Enabled: true
+Style/UnlessElse:
+  Enabled: true
+Style/VariableInterpolation:
+  Enabled: true
+Style/WhenThen:
+  Enabled: true
+Lint/Debugger:
+  Enabled: true
+Lint/DeprecatedClassMethods:
+  Enabled: true
+Security/Eval:
+  Enabled: true
+Lint/SuppressedException:
+  Enabled: true
+Lint/LiteralInInterpolation:
+  Enabled: true
+Lint/Loop:
+  Enabled: true
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+Lint/RequireParentheses:
+  Enabled: false
+Lint/UnderscorePrefixedVariableName:
+  Enabled: true
+Lint/UselessSetterCall:
+  Enabled: true
+RSpec/ExampleLength:
+  Max: 20
+RSpec/ImplicitSubject:
+  EnforcedStyle: single_statement_only
+  Enabled: true
+RSpec/NamedSubject:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2023-05-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in preferred_locale.gemspec
+gemspec
+
+gem 'rake'
+gem 'rspec'
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    preferred_locale (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.21.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  preferred_locale!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Emma Lejeck
+
+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,66 @@
+# PreferredLocale
+
+A gem to help you find the best locales between what you support and what a user prefers. In
+practice, this usually means finding the best locale between `I18n.available_locales` and the
+`Accept-Language` header from the request, but it could also be used to find the best locale between
+something in your database and a user's preferences.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```shell
+$ bundle add preferred_locale
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+$ gem install preferred_locale
+```
+
+## Usage
+
+To use PreferredLocale directly, you can create a new instance with your available locales:
+
+```ruby
+preferred_locale = PreferredLocale.new(available: ['en', 'fr', 'es'])
+```
+
+Then, you can find the available locales from a given list of locales from the user:
+
+```ruby
+preferred_locale.acceptable_for(['en-US', 'fr', 'ja-JP']) # => ['en', 'fr']
+```
+
+Or you can just get the best one:
+
+```ruby
+preferred_locale.preferred_for(['en-US', 'fr', 'ja-JP']) # => 'en'
+```
+
+### With Rails
+
+PreferredLocale can be used with Rails by including the `PreferredLocale::AutoLocale` module in your
+controller, which will automatically set the locale based on the `Accept-Language` header from the
+request.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run
+the tests. You can also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new
+version, update the version number in `version.rb`, and then run `bundle exec rake release`, which
+will create a git tag for the version, push git commits and the created tag, and push the `.gem`
+file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hummingbird-me/preferred_locale.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/preferred_locale/auto_locale.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+class PreferredLocale
+  module AutoLocale
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_action :set_locale
+    end
+
+    def set_locale
+      I18n.locale = preferred_locale || I18n.default_locale
+    end
+
+    def preferred_locale
+      acceptable = HeaderParser.new(request.env['HTTP_ACCEPT_LANGUAGE']).preferred_locales
+      PreferredLocale.new(
+        available: I18n.available_locales
+      ).preferred_for(
+        locales: acceptable
+      )
+    end
+  end
+end

data/lib/preferred_locale/header_parser.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class PreferredLocale
+  class HeaderParser
+    def initialize(header)
+      @header = header.to_s
+    end
+
+    def raw_locales
+      @raw_locales ||= begin
+        values = @header.split(/,\s*/).map do |item|
+          locale, quality = item.split(';q=')
+          [locale, quality ? quality.to_f : 1.0]
+        end
+        values.sort { |(_, a), (_, b)| b <=> a }.filter_map(&:first)
+      end
+    end
+
+    def preferred_locales
+      raw_locales.filter do |locale|
+        locale.match(/^[-a-z0-9]+$/i)
+      end
+    end
+  end
+end

data/lib/preferred_locale/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class PreferredLocale
+  VERSION = '1.0.0'
+end

data/lib/preferred_locale.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'preferred_locale/version'
+require_relative 'preferred_locale/header_parser'
+require_relative 'preferred_locale/auto_locale' if defined?(Rails)
+
+class PreferredLocale
+  def initialize(available: [])
+    # We need this to avoid overwriting explicit options with implicit ones
+    available_lower = available.map { |locale| locale.to_s.downcase }
+
+    # Create a map of "implicit" available locales to their "canonical" form
+    @available = available.each_with_object({}) do |locale, obj|
+      locale_str = locale.to_s
+      obj[locale_str.downcase] = locale
+      # Add the language without a country if it's not already in the list
+      language = locale_str.downcase.split('-')[0]
+      obj[language] = locale unless available_lower.include?(language)
+    end
+  end
+
+  def acceptable_for(locales: [])
+    # Build a candidate list including our implicit candidate locales
+    candidates = locales.flat_map do |locale|
+      [locale.to_s.downcase, locale.to_s.split('-')[0].downcase]
+    end
+
+    # Figure out which candidates are available
+    available = candidates.filter do |locale|
+      @available.key?(locale.downcase)
+    end
+
+    # Convert to the canonical form and then remove duplicates
+    available.map { |locale| @available[locale.downcase] }.uniq
+  end
+
+  def preferred_for(locales: [])
+    acceptable_for(locales: locales)[0]
+  end
+end

data/sig/preferred_locale.rbs

@@ -0,0 +1,23 @@
+class PreferredLocale
+  VERSION: String
+
+  def initialize: (available: Array[String]) -> void
+
+  def acceptable_for: (locales: Array[String]) -> Array[String]
+
+  def preferred_for: (locales: Array[String]) -> String | nil
+
+  class HeaderParser
+    def initialize: (header: String) -> void
+
+    def raw_locales: () -> Array[String]
+
+    def preferred_locales: () -> Array[String]
+  end
+
+  module AutoLocale
+    def preferred_locale: () -> String
+
+    def set_locale: () -> void
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: preferred_locale
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Emma Lejeck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-05-06 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- nuck@kitsu.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/preferred_locale.rb
+- lib/preferred_locale/auto_locale.rb
+- lib/preferred_locale/header_parser.rb
+- lib/preferred_locale/version.rb
+- sig/preferred_locale.rbs
+homepage: https://github.com/hummingbird-me/preferred_locale
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hummingbird-me/preferred_locale
+  source_code_uri: https://github.com/hummingbird-me/preferred_locale
+  changelog_uri: https://github.com/hummingbird-me/preferred_locale/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Get the user's preferred locale from a list of available locales
+test_files: []