roda-i18n 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9c2738c4186efd7bb356272c3fad656bd1a79237
-  data.tar.gz: 72a1cb79f9dbc234b12411d58e7801e935933a7e
+SHA256:
+  metadata.gz: 299cfc297f403c8b9d9c40dad750ddfbc2a868ffea9b8f8f6a2dbb8e39d88c50
+  data.tar.gz: b7581d6db878fb686b04383587dea2dee374ed86ab5b7a8d630ca71d8360796f
 SHA512:
-  metadata.gz: 941708ff91f4da8c9da9d03e2dafe545d1845e9e679d0e66d249408832c8aa3ecd53dbc2dbde3b56e756b5c2091eeb0e0eb529a305154fb0857f4b8972ab6b6d
-  data.tar.gz: 4781db341bd8d1fa1154dcc68d0ca45b56f7ccb76a9a4b3be103e066a26ea521472ff7af9a7e5515bed4d11e4d0e64de0812be79d89f77a9baca7597488590b7
+  metadata.gz: d228be9cfef332c4de8c8a8e83dc0401c0f9c361a612f417da1e8af239092c77399af7dc7fd721788f9ca1494f631c70ac7280355321bfd99e9231b3de7fa03c
+  data.tar.gz: 79bd150bdd0e4642326a1807274f4586e597558867bd0c539c59fe82c30a10f70f5f818736d34dd4cdaca7799ee2290f21c0e3fb0c14587335198f3ed3221fad

data/.gitignore

@@ -1,9 +1,11 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+.tool-versions
+.devcontainer/

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # CHANGELOG
 
+## next (unreleased)
+
+* your changes here
+ 
+## 0.5.0 (unreleased)
+
+* Merge pull request #5 from simonneutert/bump-dependencies - Add/Bump dependencies, minimum Ruby version to 3.0.0
+
+  * __Breaking Changes:__
+  * minimum Ruby version is now >= 3.0.0
+
+  * __Dependencies:__
+  * Add `date` to `gemspec`
+  * Bump `r18n-core` to `~> 5.0`
+  * Bump `roda` to `~> 3.8`
+  * Bump `rack-test` to `1.1.0`
+  
+  * Bump `bundler` to `~> 2.5`
+  * Bump `rack-test` to `~> 2.1`
+  * Bump `rake` to `~> 13.2`
+
+  * __Tests:__
+  * switched from rack session to roda session (as plugin in test suite)
+  * fixed failing tests and updated fixtures for proper YAML due to the above changes (Psych was freaking out about the prior YAML formatting)
 
 ## 0.4.0 (2018-05-08)
 
@@ -53,7 +77,6 @@
   * Update development dependency `rake` to `12.3`
   * Remove noop check for exception
 
-
 ## 0.3.0 (2016-08-11)
 
 * Merged PR #3 by @jonduarte - Making routes behind #locale block work
@@ -64,15 +87,13 @@
 
 * Add alias for rake test
 
-
 ## 0.2.0 (2015-11-24)
 
 * Mainly internal build and setup improvements
 
-
 ## 0.1.0 (2015-09-13)
 
 * Initial public release
   
   * Big Thank You to @jeremyevans for his assistance in creating this initial version.
-  
+  

data/Gemfile

@@ -1,4 +1,20 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in roda-i18n.gemspec
 gemspec
+
+gem 'bundler', '~> 2.5'
+gem 'erubi'
+gem 'kramdown'
+gem 'minitest', '~> 5.7', '>= 5.7.0'
+gem 'minitest-hooks', '~> 1.1', '>= 1.1.0'
+gem 'minitest-rg'
+gem 'rack-test', '~> 2.1'
+gem 'rake', '~> 13.2'
+gem 'rubocop'
+gem 'rubocop-minitest'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'simplecov'

data/Gemfile.lock

@@ -0,0 +1,104 @@
+PATH
+  remote: .
+  specs:
+    roda-i18n (0.6.0)
+      date
+      r18n-core (~> 5)
+      roda (~> 3.8)
+      tilt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    date (3.3.4)
+    date (3.3.4-java)
+    docile (1.4.1)
+    erubi (1.13.0)
+    json (2.7.2)
+    json (2.7.2-java)
+    kramdown (2.4.0)
+      rexml
+    language_server-protocol (3.17.0.3)
+    minitest (5.25.1)
+    minitest-hooks (1.5.2)
+      minitest (> 5.3)
+    minitest-rg (5.3.0)
+      minitest (~> 5.0)
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
+    r18n-core (5.0.1)
+    racc (1.8.1)
+    racc (1.8.1-java)
+    rack (3.1.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.7)
+    roda (3.83.0)
+      rack
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.3)
+      parser (>= 3.3.1.0)
+    rubocop-minitest (0.36.0)
+      rubocop (>= 1.61, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    tilt (2.4.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  java
+  ruby
+  universal-java-17
+  universal-java-22
+  x64-mingw32
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.5)
+  erubi
+  kramdown
+  minitest (~> 5.7, >= 5.7.0)
+  minitest-hooks (~> 1.1, >= 1.1.0)
+  minitest-rg
+  rack-test (~> 2.1)
+  rake (~> 13.2)
+  roda-i18n!
+  rubocop
+  rubocop-minitest
+  rubocop-performance
+  rubocop-rake
+  simplecov
+
+BUNDLED WITH
+   2.5.18

data/README.md

@@ -1,50 +1,39 @@
 # Roda-i18n
 
-[![Gem Version](https://badge.fury.io/rb/roda-i18n.svg)](https://badge.fury.io/rb/roda-i18n)  [![Build Status](https://travis-ci.org/kematzy/roda-i18n.svg?branch=master)](https://travis-ci.org/kematzy/roda-i18n)
+[![Gem Version](https://badge.fury.io/rb/roda-i18n.svg)](https://badge.fury.io/rb/roda-i18n) [![Ruby](https://github.com/kematzy/roda-i18n/actions/workflows/ruby.yml/badge.svg)](https://github.com/kematzy/roda-i18n/actions/workflows/ruby.yml)
 
 
-Add Internationalisation (i18n) and localisation support to your [Roda](http://roda.jeremyevans.net/) 
-apps, based upon the [R18n](https://github.com/ai/r18n) gem.
+Add Internationalisation (i18n) and localisation support to your [Roda](http://roda.jeremyevans.net/) apps, based upon the [R18n](https://github.com/ai/r18n) gem.
 
-Extensively tested and with 100% code test coverage.
+Extensively tested and with a goal of 100% code test coverage.
 
 
 ## Installation
 
-To use this gem, just do
+To install this gem:
 
 ```bash
-  $ (sudo) gem install roda-i18n
+$ gem install roda-i18n
 ```
   
-or if you use Bundler
+Or if you use Bundler, add this to your Gemfile:
 
 ```ruby
-gem "roda-i18n"
+gem 'roda-i18n'
 ```
 
-<br>
-
-
 ## Getting Started
 
-To add internationalisation and localisation support to your app just add the following code snippet 
-in your app.
+To add internationalisation and localisation support to your app just add the following code snippet in your app.
 
 ```ruby
 plugin :i18n
 ```
 
-By default the default locale is set to `'en'` and the translations directory is set to the `'i18n'` 
-directory in the root of your app, ie: `'/path/2/app/i18n'`.
-
+By default the default locale is set to `'en'` and the translations directory is set to the `'i18n'` directory in the root of your app, ie: `'/path/2/app/i18n'`.
 
-**IMPORTANT! Make sure you create the 'i18n' folder and add an `'en.yml'` file with at least one 
-translation within it.**
 
-
-<br>
----
+**IMPORTANT! Make sure you create the 'i18n' folder and add an `'en.yml'` file with at least one translation within it.**
 
 
 ## Configuration
@@ -59,36 +48,26 @@ plugin :i18n, :locale => ['de'], :translations => ['absolute/path/2/i18n']
 
 **NOTE!** 
 
- 1. You must set `opts[:root]` in your app if you do not define the `:translations` path during 
-    plugin configuration.
-
- 3. When overriding `:translations` the **any path(s) given must be absolute**.
+ 1. You must set `opts[:root]` in your app if you do not define the `:translations` path during plugin configuration.
 
+ 2. When overriding `:translations`, then **any path(s) given must be absolute**.
 
 #### Loading translations from multiple i18n directories
 
-The `:translations` path supports 'wildcards', ie: `path/**/i18n` so you can load translations from 
-multiple combined apps, each with their own `i18n` folder with translations.
+The `:translations` path supports 'wildcards', ie: `path/**/i18n` so you can load translations from multiple combined apps, each with their own `i18n` folder with translations.
 
 **Please Note!** 
 
-When loading translations from multiple sources and the same translation key is available in 
-multiple files of the same locale, then **the translations in the first loaded translation file 
-takes precedence over subsequent loaded translations**. 
+When loading translations from multiple sources and the same translation key is available in multiple files of the same locale, then **the translations in the first loaded translation file takes precedence over subsequent loaded translations**. 
 
 * ie: translations in `./i18n/en.yml` takes precedence over translations in `./apps/app1/i18n/en.yml`
 
-
 You can also set a list of preferred locales as an array ordered by priority.
 
 ```ruby
 plugin :i18n, :locale => ['es','fr','en']
 ```
 
-
-<br>
----
-
 ##  USAGE
 
 The **i18n** plugin depends upon simple YAML based translations files:
@@ -122,7 +101,6 @@ l Time.now, :human   #=> "now"
 l Time.now, :full    #=> "3rd of January, 2010 18:54"
 ```    
 
-
 Both the `:t` and `:l` methods are available within the route and template (erb) scopes. ie:
 
 ```ruby 
@@ -138,24 +116,18 @@ end
  <snip...>
 ```  
 
-Please visit [R18n](https://github.com/ai/r18n/tree/master/r18n-core) for more information about the 
+Please visit [R18n-Core](https://github.com/ai/r18n/tree/master/r18n-core) for more information about the 
 R18n gem used to create the above.
 
-<br>
----
-
 ## Key Methods / Functionality
 
-
-<br>
-
+This plugin brings some methods and functionalities you can setup in your Roda project.
 
 ### `#locale(opts = {}, &blk)` - (request method)
 
 This request method makes it easy to handle translations based upon the **`:locale` prefix on a 
 route / URL**. ie: `blog.com/**de**/posts`.
 
-
 To enable this, just use the following code structure:
 
 ```ruby
@@ -174,14 +146,7 @@ route do |r|
 end
 ```    
 
-	
-
-**NOTE!** Any URL / request with a non-present or not supported locale will be given the 
-**configured default locale** or the EN (English) default locale.
-
-
-<br>
-
+**NOTE!** Any URL / request with a non-present or not supported locale will be given the **configured default locale** or the EN (English) default locale.
 
 ### `#i18n_set_locale_from(type)` - (request method)
 
@@ -210,10 +175,6 @@ end
 
 **NOTE!** defaults to the configured default locale, or English, if the given locale type is invalid.
 
-
-<br>
-
-
 ### `i18n_set_locale(locale, &blk)` - (request method)
 
 Enables overriding the default locale and setting a temporary `:locale` within a route block.
@@ -235,27 +196,16 @@ route do |r|
 end
 ```  
 
-<br>
----
-
 ## InstanceMethods
 
 ### `#t`
 
 This is the main translation output method. (See examples above)
 
-
-<br>
-
-
 ### `#l`
 
 Key localisation method. Handles dates etc. (See examples above)
 
-
-<br>
-
-
 ### `#i18n_available_locales`
 
 Returns a two-dimensional array of available locales.
@@ -264,30 +214,18 @@ Returns a two-dimensional array of available locales.
 puts i18n_available_locales #=> [ ['en', 'English'], ...]
 ```
 
-
-        
 ### `#i18n_default_places`
 
-
-<br>
-
-
 ## Class Methods
         
 ### `#i18n_opts()`
 
 Return the i18n options for this class as a Hash.
 
-
-<br>
----
-
-
 ## Ideas
 
 A few ideas that may be outlandish, but possible?
 
-
 ### Ability to load translations from multiple locations via an array.
 
 ```ruby
@@ -301,16 +239,9 @@ plugin :i18n, :translations => ['app1/i18n', 'app2/i18n', 'app3/i18n']
 >     R18n.default_places = [MyLoader.new, DBLoader.new, 'path/to/yaml']
 >    
 
-
 ### Sequel DBLoader for DB based translations support
 
-Som form of built-in support for storing / loading translations from a Sequel based DB.
-
-
-<br>
-
-
-----
+Some form of built-in support for storing / loading translations from a Sequel based DB.
 
 ## TODOs
 
@@ -324,26 +255,26 @@ Som form of built-in support for storing / loading translations from a Sequel ba
 
 * ...and some more stuff that slipped my mind right now.
 
-
 ## Credits
 
-* This plugin have been inspired by the `sinatra-i18n` gem available at 
-  [github/ai/r18n](http://github.com/ai/r18n) created by [Andrey Sitnik](http://github.com/ai).
+* This plugin has been inspired by the `sinatra-i18n` gem available at [github/ai/r18n](http://github.com/ai/r18n) created by [Andrey Sitnik](http://github.com/ai).
 
-* Testing code have been partly copied from [Forme](github.com/jeremyevans/forme).
+* Testing code has been partly copied from [Forme](https://github.com/jeremyevans/forme).
 
-* Inspiration and assistance by [Jeremy Evans](github.com/jeremyevans). Many thanks Jeremy!! 
+* Inspiration and assistance by [Jeremy Evans](https://github.com/jeremyevans). Many thanks Jeremy!! 
 
 * Code fixes and improvements by:
 
-   * [Jonathan Duarte](github.com/jonduarte). Many thanks Jonathan
+   * [Jonathan Duarte](https://github.com/jonduarte). Many thanks Jonathan for PR [#3](https://github.com/kematzy/roda-i18n/pull/3)
+
+   * [Adam Daniels](https://github.com/adam12). Many thanks Adam for PR [#4](https://github.com/kematzy/roda-i18n/pull/4), [#5](https://github.com/kematzy/roda-i18n/pull/5) & [#6](https://github.com/kematzy/roda-i18n/pull/6)
 
+   * [Firas Zaidan](https://github.com/zaidan). Many thanks Firas for PR [#7](https://github.com/kematzy/roda-i18n/pull/7)
+   
+   * [Simon Neutert](https://github.com/simonneutert). Many thanks Simon for PR [#8](https://github.com/kematzy/roda-i18n/pull/8)
 
 ## Licence
 
 MIT 
 
-Copyright: 2015 Kematzy 
-
-
-
+Copyright: 2015 - 2024 Kematzy

data/RELEASING.md

@@ -0,0 +1,7 @@
+# RubyGems Release Process
+
+1. Update/Check the version number in the gemspec file.
+2. Check the [CHANGELOG](CHANGELOG.md) for all contributions since the last release.
+3. Update the [README](README.md) in case of any changes.
+4. Run `bundle install` to update the Gemfile.lock file.
+5. Run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -1,29 +1,25 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 require 'rake/testtask'
 
+RuboCop::RakeTask.new
+
 Rake::TestTask.new(:spec) do |t|
   t.libs << 'spec'
   t.libs << 'lib'
   t.test_files = FileList['spec/**/*_spec.rb']
 end
 
-task :default => :spec
-task :test => :spec
+task default: %i[rubocop coverage]
+
+desc 'alias for spec task'
+task test: :spec
 
 desc 'Run specs with coverage'
 task :coverage do
   ENV['COVERAGE'] = '1'
   Rake::Task['spec'].invoke
-    # `open coverage/index.html` # if OSX
-end
-
-desc 'Run Rubocop report'
-task :rubocop do
-  res = `which rubocop`
-  if res != ""
-    `rubocop -f html -o ./rubocop/report.html lib/`
-      # `open rubocop/report.html` # if OSX
-  else
-    puts "\nERROR: 'rubocop' gem is not installed or available. Please install with 'gem install rubocop'."
-  end
+  # `open coverage/index.html` # if OSX
 end

data/lib/roda/i18n/version.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 class Roda
-  
   module I18n
-    VERSION = '0.4.0'
+    VERSION = '0.6.0'
   end
-  
 end

data/lib/roda/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'roda'
 require 'roda/i18n/version'
 require 'roda/plugins/i18n'