flame-r18n 1.3.0 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5fe2146f9f4b7a918d01b3686420378f58ecc2a
-  data.tar.gz: 18f7f0478fd922587f1aa7dd6a24d56a5b7037a7
+SHA256:
+  metadata.gz: 5a5f6fc1c0c0f1f730300be1408affef95fec1566ffd6a32924814612f1f7f67
+  data.tar.gz: a4f30a3d514ba7470a40772502b6fe6585ef0c4caac61e555d2479bf53867da0
 SHA512:
-  metadata.gz: 43072cf755dac06280a4a38910701573f09ce97af58178b21b6937aa99c57d3c42650e8f0673de9b3dcdc1a8cad5d767395470e565526ef62b800caa4f7a3401
-  data.tar.gz: 93201ac10ad284aee53450e6b377bed8ee54d4c06c794a62f0458179b57a945a72c000028dafe585a4a1740a36febaf50fd472fb64c4d7ffbb58a8f55b248599
+  metadata.gz: bc0cb8373fc77e73b38bf13644b6f9ac6811872f52dfb3f1e4a287a99d2aaba3d363b86093f7cae8473544bb64a219b82222e54ca2ff855b49fb09a4948dca55
+  data.tar.gz: e98841a62976c6763fa43e465b8a4fb7359cf5fc31bc675d1aaa2f10098eb7fae49e247ba0029305f3fe12ba02bed6df33989853dfae29749fcf28acc2792c92

data/CHANGELOG.md

@@ -0,0 +1,90 @@
+# Changelog
+
+## master (unreleased)
+
+## 3.0.0.rc1 (2021-04-16)
+
+*   Add tests, fix some errors.
+    100% coverage, yay!
+*   Update version of Flame dependency to `~> 5.0`.
+*   Set locale with region by locale without.
+    From `Accept-Language` HTTP header.
+*   Remove extra slashes in a root path with query string when redirecting (`LocaleInPath`).
+*   Replace `LocaleInPath#path_witout_locale` with `#fullpath_without_locale`.
+*   Take out `path_with_preferred_locale` from `redirect_to_path_with_preferred_locale`.
+*   Update R18n dependency.
+*   Update development dependencies, lock them better.
+*   Add Travis CI, then switch to Cirrus CI.
+*   Add `rubocop-performance` and `rubocop-rspec`.
+    Resolve new offenses.
+*   Support Ruby 3.
+*   Move gem version to a separate file.
+*   Add RuboCop task for CI.
+*   Add `remark` task for CI.
+*   Replace `rake` with `toys`.
+*   Add code documentation.
+*   Add more meta-information to gem specs.
+*   Add badges to README.
+*   Add "Development", "Contributing" and "License" sections to README.
+
+## 2.3.1 (2017-10-13)
+
+*   Fix the critical issue with caching 301 Location by browsers.
+
+## 2.3.0.1 (2017-10-13)
+
+*   Fix the critical issue with caching 301 Location by browsers.
+
+## 2.3.0 (2017-08-23)
+
+*   Add redefined `LocaleInPath#path_to` method.
+
+## 2.2.1 (2017-08-10)
+
+*   Fix an error with `LocaleInPath` module.
+
+## 2.2.0 (2017-08-09)
+
+*   Add `Flame::R18n::LocaleInPath` module for general methods in such case.
+
+## 2.1.1 (2017-08-08)
+
+*   Fix calling root `::R18n` constant.
+
+## 2.1.0 (2017-08-08)
+
+*   Don't use locale param if it is not in available locales.
+
+## 2.0.0 (2017-05-17)
+
+*   Split `Flame::R18n` to `Configuration` and `Initialization`.
+    Change `prepend` to `include`s for application and controller.
+*   Fix gem building.
+*   Add RuboCop config.
+
+## 1.3.0 (2016-11-11)
+
+*   Initialize `R18n` already with `preferred_locale` instead of setting it later to `session`.
+
+## 1.2.0 (2016-11-08)
+
+*   Add possibility of redefining `preferred_locale`.
+
+## 1.1.1 (2016-09-28)
+
+*   Fix an error with non-word chars in `preferred_locale`.
+
+## 1.1.0 (2016-05-20)
+
+*   Set default locale to `session[:locale]` when no preferred.
+    Change `include` to `prepend`.
+*   Prevent `preferred_locale` duplicates in `locales`.
+*   Fix issue when `locales_from_env` returns `nil`.
+*   Add README file.
+*   Add LICENSE file.
+*   Fix gem specs file name.
+*   Change homepage in gem specs from GitLab to GitHub.
+
+## 1.0.0 (2016-01-29)
+
+*   Initial release.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alexander Popov
+
+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,58 @@
+# Flame R18n
+
+Flame plugin which provides
+[i18n and L10n](https://en.wikipedia.org/wiki/Internationalization_and_localization) support
+to your web application.
+
+It is a wrapper for [R18n core library](https://github.com/r18n/r18n-core).
+See [R18n documentation](https://github.com/r18n/r18n-core/blob/master/README.md)
+for more information.
+
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/flame-r18n?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/flame-r18n)
+[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/flame-r18n/master.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/flame-r18n)
+[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/flame-r18n.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/flame-r18n)
+![Depfu](https://img.shields.io/depfu/AlexWayfer/flame-r18n?style=flat-square)
+[![Inline docs](https://inch-ci.org/github/AlexWayfer/flame-r18n.svg?branch=master)](https://inch-ci.org/github/AlexWayfer/flame-r18n)
+[![license](https://img.shields.io/github/license/AlexWayfer/flame-r18n.svg?style=flat-square)](https://github.com/AlexWayfer/flame-r18n/blob/master/LICENSE.txt)
+[![Gem](https://img.shields.io/gem/v/flame-r18n.svg?style=flat-square)](https://rubygems.org/gems/flame-r18n)
+
+## Usage
+
+```ruby
+# Gemfile
+gem 'flame-r18n'
+
+# config.ru
+require 'flame-r18n' # or `Bundler.require`
+
+# For application configuration
+# config/processors/r18n.rb
+::R18n.default_places = File.join config[:root_dir], 'locales'
+::R18n::I18n.default = 'en'
+
+# _controller.rb
+include Flame::R18n::Initialization # for loading thread-based locale
+
+# site/_controller.rb
+prepend Flame::R18n::LocaleInPath # for mounting controllers at `/:locale`
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+Then, run `toys rspec` to run the tests.
+
+To install this gem onto your local machine, run `toys gem install`.
+
+To release a new version, run `toys gem release %version%`.
+See how it works [here](https://github.com/AlexWayfer/gem_toys#release).
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/flame-r18n).
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).

data/lib/flame/r18n.rb

@@ -1,59 +1,8 @@
-require 'r18n-core'
-
-module Flame
-	# Module for Flame::R18n extension with helper methods and base class
-	module R18n
-		include ::R18n::Helpers
-
-		def self.config(app)
-			app.config[:default_locale] = proc { ::R18n::I18n.default }
-			app.config[:locales] = proc { ::R18n.default_places }
-			app.config[:locales_dir] = proc do
-				File.join(app.config[:root_dir], 'locales')
-			end
-
-			::R18n.default_places { app.config[:locales_dir] }
-		end
-
-		def execute(method)
-			load_r18n
-			session[:locale] = ::R18n.get.locale.code
-			super
-		end
-
-		def init_r18n(locale)
-			::R18n::I18n.new(
-				Array(locale) | locales_from_env,
-				::R18n.default_places,
-				off_filters: :untranslated,
-				on_filters: :untranslated_html
-			)
-		end
+# frozen_string_literal: true
 
-		def thread_locale=(locale)
-			::R18n.thread_set init_r18n locale
-		end
-
-		private
-
-		def locales_from_env
-			::R18n::I18n.parse_http(request.env['HTTP_ACCEPT_LANGUAGE'])
-		end
-
-		def preferred_locale
-			return super if defined? super
-			params[:locale] || session[:locale]
-		end
-
-		def load_r18n
-			::R18n.clear_cache! if config[:environment] == 'development'
+require 'r18n-core'
 
-			::R18n.thread_set do
-				default_locale = config[:default_locale]
-				::R18n::I18n.default = default_locale if default_locale
+require_relative './r18n/version'
 
-				init_r18n preferred_locale
-			end
-		end
-	end
-end
+require_relative './r18n/initialization'
+require_relative './r18n/locale_in_path'

data/lib/flame/r18n/initialization.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Flame
+	module R18n
+		## Module for R18n in thread initialization with helper methods
+		module Initialization
+			include ::R18n::Helpers
+
+			## Patch controller initialization
+			## Load R18n and set the current locale to the session
+			def initialize(*)
+				super
+				load_r18n
+				session[:locale] = r18n.locale.code
+			end
+
+			## Force change thread locale
+			## @param locale [R18n::Locale] the locale that will be set
+			def thread_locale=(locale)
+				::R18n.thread_set init_r18n locale
+			end
+
+			private
+
+			def locales_from_env
+				::R18n::I18n.parse_http(request.env['HTTP_ACCEPT_LANGUAGE'])
+			end
+
+			def preferred_locale
+				locale_param || session[:locale]
+			end
+
+			def locale_param
+				params[:locale] if available_locale_codes.include?(params[:locale])
+			end
+
+			def available_locale_codes
+				::R18n.available_locales.map(&:code)
+			end
+
+			def load_r18n
+				::R18n.clear_cache! if config[:environment] == 'development'
+
+				self.thread_locale = preferred_locale
+			end
+
+			def init_r18n(locale)
+				::R18n::I18n.new(
+					Array(locale) | locales_from_env,
+					::R18n.default_places,
+					off_filters: :untranslated,
+					on_filters: :untranslated_html
+				)
+			end
+		end
+	end
+end

data/lib/flame/r18n/locale_in_path.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Flame
+	module R18n
+		## Module for including to controllers, mounted with `:locale` param in path
+		module LocaleInPath
+			protected
+
+			## Patch controller execution
+			## Halt with redirect to the same URL, but with the preferred locale,
+			## if necessary
+			## @param action [Symbol] action which will be executed
+			def execute(action)
+				unless request_path_with_available_locale?
+					return halt redirect_to_path_with_preferred_locale
+				end
+
+				super
+			end
+
+			private
+
+			## Complete returning path with locale, if necessary
+			def path_to(*args)
+				args << {} unless args.last.is_a? Hash
+				args.last[:locale] = r18n.locale.code unless args.last.include?(:locale)
+				super
+			end
+
+			def request_path_with_available_locale?
+				available_locale_codes.include?(request.path.parts.first.to_s)
+			end
+
+			def redirect_to_path_with_preferred_locale
+				redirect path_with_preferred_locale.sub(%r{(/)+(?=\?|$)}, ''), 302
+			end
+
+			def path_with_preferred_locale
+				Flame::Path.merge(nil, r18n.locale.code, request.fullpath)
+			end
+
+			## Get the current path without the preferred locale in it
+			## @return [Flame::Path] the current path without locale in it
+			def fullpath_without_locale
+				return request.fullpath.to_s unless request_path_with_available_locale?
+
+				Flame::Path.merge(
+					request.fullpath.to_s.split('/')[2..-1].unshift('/')
+				)
+			end
+
+			## Get the current path with the specific locale in it
+			## @param locale [R18n::Locale] the locale that will be in the path
+			## @return [Flame::Path] the current path with the specific locale in it
+			def fullpath_with_specific_locale(locale)
+				fullpath_parts = request.fullpath.to_s.split('/')
+				fullpath_parts[1] = locale.code
+				Flame::Path.merge fullpath_parts
+			end
+		end
+	end
+end

data/lib/flame/r18n/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Flame
+	module R18n
+		VERSION = '3.0.0.rc1'
+	end
+end

metadata

@@ -1,50 +1,205 @@
 --- !ruby/object:Gem::Specification
 name: flame-r18n
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Alexander Popov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-11-11 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flame
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0.rc3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 5.0.0.rc3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: r18n-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
-description: Flame extension which provides i18n support to translate your web application.
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: gem_toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: toys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: |
+  Flame plugin which provides i18n and L10n support to your web application.
   It is a wrapper for R18n core library. See R18n documentation for more information.
 email:
 - alex.wayfer@gmail.com
@@ -52,12 +207,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
 - lib/flame/r18n.rb
+- lib/flame/r18n/initialization.rb
+- lib/flame/r18n/locale_in_path.rb
+- lib/flame/r18n/version.rb
 homepage: https://github.com/AlexWayfer/flame-r18n
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/AlexWayfer/flame-r18n
+  homepage_uri: https://github.com/AlexWayfer/flame-r18n
+  changelog_uri: https://github.com/AlexWayfer/flame-r18n/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,16 +229,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
-summary: R18n plugin for Flame-framework
+summary: Flame plugin which provides i18n and L10n support
 test_files: []