remote_i18n_extension 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c3bce95a44838b0a32f1185768b5455e6c096cc4a3231427512081acdf945a4
-  data.tar.gz: 51133a49f1b9fb6f7b3381790f5f0ce246dd0729352f59c5a218102f9ee5502c
+  metadata.gz: 1d39598ad005dbd539128eee44e2268057997da793b9b4d02dd5e21833b2ddd3
+  data.tar.gz: dd65bf84f074976cec0dc388b5c7747fbd8515fe8790fc653f1b2460cbca53d0
 SHA512:
-  metadata.gz: 3febda8ef89077970b89e7e156e1615c5c1b0f3be95d3c588b94721eee6fc88c19fe824afd86d346a6f83e71059dff95b112f5fa8f646de9c7bf3fa37f5804bd
-  data.tar.gz: 4fa8aafc02ad43c5d1144787b4d49a845689e04061a67eaa635e9ad4a7a87bffca1e229bee62e7326f39e1412b8298309cabfd8ae26971b5c4b993ee1ea43db7
+  metadata.gz: e188c887f2bfd729a4052aaecf932108f74297a734944b16e4da63f60f115d07823c2b3e85688eb91f38a340c9481bd5516eac42d640d0cee9c8d3dcf66526fd
+  data.tar.gz: 3190ea3504cc94f43a3a7ae52933e84b6eddb246c0529ed5ae859744500096f201bf8d6ebf26cf6a1c83151db6765830745568d0fcfc235884126bc6db2602a8

data/CHANGELOG.md

@@ -2,4 +2,9 @@
 
 ## 1.0.0 (06-May-23)
 
-* Initial release
+* Initial release
+
+## 1.0.9 (09-May-23)
+
+* Base level test coverage added
+* Adds generator for configuration files

data/README.md

@@ -1,9 +1,89 @@
-# Remote-I18n-Extension-Hcc
+# Remote-I18n-Extension
 
-This gem provides an extension to the exsiting url(https://github.com/ruby-i18n/i18n)[I18n] gem by providing the ability to fetch locales from remote files
+This gem is built on top of the popular [I18n](https://github.com/ruby-i18n/i18n) gem providing the ability to fetch translations from remotely hosted locale files. In case of a missing translation the gem fallbacks to serving translations from local files(present under `config/locales`) folder of your rails project.
 
+## Requirements
 
-# Getting Started
+This gem requires `ruby 3.1.3` and `Rails 7.0.4.3`
 
-# Requirements
- This gem requires `ruby 3.1.3` and `Rails 7.0.4.3`
+## Installation
+To get started paste the following inside your Gemfile and run `bundle`
+```
+gem 'remote_i18n_extension', '~> 1.0', '>= 1.0.9'
+```
+or install via terminal using the following command:
+```
+gem install remote_i18n_extension
+```
+
+After that run the following command to generate the config file
+```
+rails g remote_i18n_extension:install
+```
+This will create the following config file `config/initializers/remote_i18n_extension.rb`
+
+### Generated Configuration File
+```
+require 'remote_i18n_extension'
+
+RemoteI18nExtension.config do |config|
+  # All the configurations are mandatory
+
+  # URL to your remote locales folder housing all the translations
+  # For now the library expects all the locales to be stored in a single (root) folder
+  # e.g. https://raw.githubusercontent.com/Gooner91/locales-repo/master/locales
+  # config.remote_host = ENV['LOCALES_REMOTE_HOST']
+
+
+  # Below configurations are for the ruby I18n module
+
+  # List of available locales
+  # config.available_locales = [:en, :de]
+
+
+  # config.locale = :en
+
+  # Paths to the translation files (in your local rails project for fallback)
+  # e.g. Dir[Rails.root.join("config", "locales", "*.{rb,yml}")]
+  # config.load_path = %w[]
+end
+
+```
+
+### Configurations values
+#### remote_host
+- base URL/URL to the folder hosting the remote files
+  - an example URL would be `https://raw.githubusercontent.com/Gooner91/locales-repo/master/locales` if all the translation files are uploaded in side  the `locales` folder provided in the above URL
+#### available_locales
+- the standard I18n configuration option e.g. `%i[:en :de]`
+#### locale 
+- the standard I18n configuration option e.g. `:en`
+#### load_path 
+- the standard I18n configuration option e.g. ` Dir[Rails.root.join("config", "locales", "*.yml")]`
+
+## Usage
+Fire up the server and you should be able to reference translations using the following method:
+```
+RemoteI18nExtension.t('activerecord.attributes.user.confirmation_sent_at')
+```
+
+## Demo Video
+A demo of the working of this gem can be seen on the following loom link:
+https://www.loom.com/share/78825da1d74248f1b80949bf4e72b1cc
+
+## Constraints:
+
+This gem facilitates fetching the `locales` that are hosted online. For that purpose the gem expects all the `locales`/`translation` files to be stored at one place.
+
+ 
+## Future Aspects:
+
+Since this was a time bound activity, there are some improvments/fine tuning that can be done even further:
+
+- Better look up support, nested file structure support for remote locales
+- Increasing the overall test coverage of the gem, for now just a few basic unit test cases are added to check the behavior of the `Remote` backend, test coverage should be increased
+- During testing with a demo Rails project, sometimes the gem behaves inconsistently when it comes to fallback behavior, understanding the edge cases and consistencies better and handle those as well
+- Improving code quality, fixing offences pointed out by rubocop as well as properly setting up rubocop rules
+- Better error handling
+- Tools for measuring test coverage should be integrated i.e. simplecov
+- Enforcing validation on configurations, in case some configuration is missing (raising appropriate errors)

data/lib/generators/templates/remote_i18n_extension_config.rb

@@ -4,8 +4,7 @@ RemoteI18nExtension.config do |config|
   # All the configurations are mandatory
 
   # URL to your remote locales folder housing all the translations
-  # Please make sure this folder mirrors your local locales folder
-  # to avoid fallbacks to local
+  # For now the library expects all the locales to be stored in a single (root) folder
   # e.g. https://raw.githubusercontent.com/Gooner91/locales-repo/master/locales
   # config.remote_host = ENV['LOCALES_REMOTE_HOST']
 
@@ -18,8 +17,7 @@ RemoteI18nExtension.config do |config|
 
   # config.locale = :en
 
-  # Paths to the translation files
-  # Please make sure the paths to the translation files is same for local and remote locales folder
+  # Paths to the translation files (in your local rails project for fallback)
   # e.g. Dir[Rails.root.join("config", "locales", "*.{rb,yml}")]
   # config.load_path = %w[]
 end

data/lib/remote_i18n_extension/version.rb

@@ -1,3 +1,3 @@
 module RemoteI18nExtension
-  VERSION = '1.0.8'.freeze
+  VERSION = '1.0.9'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remote_i18n_extension
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Hassan Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-08 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n