rosette 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03866ba93b8b990e22574cb0d1f84a6e2059988ca1bd8e091ab8551aaa4db1d9'
-  data.tar.gz: 26c70b8d2e6999dde21bd11fe0972505d2fc9b31b554ece1528f2f50aedd9dae
+  metadata.gz: 97ee90651ff8eb4ca983a10bf740934c878df05922013c149306b42e56778f21
+  data.tar.gz: 78b300250348617901cd7d2165b9fe0763ad49bf3327850ffdb2852d9dd55678
 SHA512:
-  metadata.gz: d29a828701e75efa5654cacdfc353c34066dae80befff846f326ecf24611aa27396fdd8f0da8f233fd59fc818c9cb9867d1993b35e72d0c02aca392bb0acb171
-  data.tar.gz: f8a993fe6be29486261e7495e2992610e14af47d9e7538ed54ac95ddf992f7122c661cf617a4fa650e008767b9327dc19a4ee6ee17b3ff896ef5a1e99204cc6a
+  metadata.gz: 182c58aa6fa14ba3b25aaf89d11dcc8e1c461fda6d1fd92b34ab709f98eade14da02d6afd66b994c4ddb2191f07ae5c5db281b131c2dfa280ff6c94bdb616761
+  data.tar.gz: d6a1b2bb51890b68a9f33d9bd3aa799a55a7cc6135abdd614747ca2118bf6a139c50ae0874f5d99dcd5fa160d700c5a344bc5eb333bb4fe229549c4724bf74ee

data/README.md

@@ -1,10 +1,9 @@
 # Rosette
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+Rosette is a Ruby on Rails engine that helps you add missing translations to your application. If your main app is configured to raise on missing translations, Rosette will catch any `I18n::MissingTranslationData` error and display a form to add the missing translations. The form includes an input for each available locale set by `config.i18n.available_locales`.
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,13 +15,22 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install rosette
+Make sure your app raises error for missing translations in development:
+
+```ruby
+# config/environments/development.rb
+
+config.i18n.raise_on_missing_translations = true
 ```
 
-## Contributing
-Contribution directions go here.
+Whether you currently use or are interested in starting to use [i18n-task to normalize](https://github.com/glebm/i18n-tasks#normalize-data) your locales files, add this initializer:
+
+```ruby
+# config/initializers/rosette.rb
+
+Rosette.normalize = true
+```
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/stylesheets/rosette/application.css

@@ -1,15 +1,83 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */
+@import url('https://fonts.googleapis.com/css2?family=Inter:wght@400;500');
+
+.text-center {
+  text-align: center;
+}
+
+body {
+  font-family: 'Inter', sans-serif;
+  background-color: white;
+  margin: 5rem;
+}
+
+.form-wrapper {
+  background-color: rgb(241, 237, 237);
+  padding: 2.5rem;
+  margin: 32px auto;
+  border-radius: 0.5rem;
+  max-width: 38rem;
+  box-shadow: rgba(0, 0, 0, 0.05) 0px 1px 2px 0px;
+  position: relative;
+}
+
+.form {
+  display: flex;
+  flex-direction: column;
+}
+
+.input-text {
+  margin-bottom: 1rem;
+  padding: 1rem;
+  border-radius: .375rem;
+  border-color: rgb(211, 211, 211);
+  border: solid 1px rgba(0, 0, 0, 0.16);
+  box-shadow: rgba(0, 0, 0, 0.05) 0px 1px 2px 0px;
+  background-color: rgb(251, 249, 249);
+}
+
+.input-text:focus {
+  outline: 1rem solid transparent;
+  outline-offset: 1rem;
+  border-color: rgb(163, 163, 163);
+}
+
+label {
+  margin-bottom: 1rem;
+}
+
+.button {
+  background-color: rgb(220, 38, 38);
+  color: white;
+  padding: 0.75rem 5rem;
+  border-color: transparent;
+  border-radius: .375rem;
+  margin: 1rem auto 0 auto;
+  font-size: 1rem;
+  line-height: 1.25rem;
+  cursor: pointer;
+  transition: background-color 0.8s;
+}
+
+.button:hover {
+  background-color: rgb(235, 63, 54);
+}
+
+.note {
+  font-size: .75rem;
+  color: rgb(107, 114, 128);
+  margin-top: 1rem;
+}
+
+.error {
+  color: #856404;
+  background-color: #fff3cd;
+  border-color: #ffeeba;
+  padding: 0.75rem 1.25rem;
+  margin-bottom: 1rem;
+  border-radius: 0.25rem;
+}
+
+.locale {
+  color: rgb(220, 38, 38);
+  font-weight: 500;
+}

data/app/controllers/rosette/translations_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Rosette
+  class TranslationsController < ApplicationController
+    def create
+      available_locales.each { |locale, translation| Manager.create(locale, key, translation) }
+
+      Manager.normalize!
+
+      redirect_to redirect_path, notice: 'Translation(s) added'
+    rescue StandardError => e
+      @error_message = e.message
+      render_rosette_new(key, redirect_path)
+    end
+
+    private
+
+    def translations_params
+      params.require(:translations).permit(:key, :redirect_path, available_locales: {})
+    end
+
+    def available_locales
+      translations_params[:available_locales]
+    end
+
+    def key
+      translations_params[:key]
+    end
+
+    def redirect_path
+      URI.parse(translations_params[:redirect_path]).to_s
+    end
+  end
+end

data/app/views/layouts/rosette/application.html.erb

@@ -1,15 +1,15 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Rosette</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
+  <head>
+    <title>Rosette</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
 
-  <%= stylesheet_link_tag    "rosette/application", media: "all" %>
-</head>
-<body>
+    <%= stylesheet_link_tag "rosette/application", media: "all" %>
+  </head>
+  <body>
 
-<%= yield %>
+  <%= yield %>
 
-</body>
+  </body>
 </html>

data/app/views/rosette/new.html.erb

@@ -0,0 +1,28 @@
+<h1 class="text-center">Add missing translation</h1>
+
+<p class="text-center locale"><%= key %></p>
+
+<div class="form-wrapper">
+  <%= form_with scope: :translations, url: rosette.translations_path, class: 'form' do |f| %>
+    <% if @error_message %>
+      <p class="error"><%= @error_message %></p>
+    <% end %>
+
+    <%= f.hidden_field :key, value: key %>
+    <%= f.hidden_field :redirect_path, value: redirect_path %>
+
+    <%= f.fields_for :available_locales do |a| %>
+      <% Rosette.available_locales.each do |locale| %>
+        <%= a.label locale, "#{locale.capitalize} translation:" %>
+        <%= a.text_field locale, required: false, label: false, class: 'input-text' %>
+      <% end %>
+    <% end %>
+
+    <%= f.button 'Submit', class: 'button' %>
+  <% end %>
+
+</div>
+
+<div class="note text-center">
+  If you prefer to add the translation directly to the yaml file, you can choose not to fill in the input field.
+</div>

data/bin/rails

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("..", __dir__)
+ENGINE_PATH = File.expand_path("../lib/rosette/engine", __dir__)
+APP_PATH = File.expand_path("../spec/example_app/config/application", __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails"
+
+require "action_controller/railtie"
+require "action_view/railtie"
+require "active_model/railtie"
+require "active_record/railtie"
+require "rails/engine/commands"

data/bin/rosette

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+begin
+  require File.join(Dir.pwd, 'config/environment')
+rescue LoadError
+  puts <<~ERR
+    Could not load your Rails app
+    =============================
+    Rosette assumes you have a config/environment.rb file it can load. If this is the case, please
+    make sure you are using Rosette CLI from the root of your Rails application. Do not hesitate to
+    raise an issue if you need further assistance.
+  ERR
+  exit 1
+end
+
+require 'rosette'
+
+command = ARGV.shift
+ARGV.clear
+
+Rosette::CLI.run(command: command)

data/config/routes.rb

@@ -1,2 +1,3 @@
 Rosette::Engine.routes.draw do
+  resources :translations, only: [:create]
 end

data/lib/rosette/cli.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Rosette
+  class CLI
+    COMMANDS = %w[add remove read].freeze
+
+    class << self
+      def run(command:)
+        return display_help unless command.in?(COMMANDS)
+
+        ask_user_for_key
+        send(command)
+      end
+
+      private
+
+      def read
+        Rosette.available_locales.each do |locale|
+          translation = Manager.read(locale, @key)
+          puts "Translation for #{locale} is: #{translation}"
+        end
+      end
+
+      def add
+        Rosette.available_locales.each do |locale|
+          puts "Please enter #{locale} translation:"
+          Manager.create(locale, @key, gets.chomp)
+        end
+      end
+
+      def remove
+        Rosette.available_locales.each do |locale|
+          Manager.delete(locale, @key)
+        end
+      end
+
+      def ask_user_for_key
+        puts 'Please provide the key to translation:'
+        @key = gets.chomp
+
+        normalize_key!
+      end
+
+      def normalize_key!
+        Rosette.available_locales.each do |locale|
+          @key.delete_prefix!("#{locale}.")
+        end
+      end
+
+      def display_help
+        puts <<~HELP
+          Usage: rosette [command]
+
+          Available commands:
+
+            read      read translation from available locales
+            add       add a translation to available locales
+            remove    remove translation from available locales
+
+          For each command you must provide a key pointing to the translation.
+          It can begin with or without the locale. These are all valid keys:
+
+            fr.activemodel.errors.blank
+            en.activemodel.errors.blank
+            activemodel.errors.blank
+
+        HELP
+      end
+    end
+  end
+end

data/lib/rosette/controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rosette
+  module Controller
+    extend ActiveSupport::Concern
+
+    included { rescue_from I18n::MissingTranslationData, with: :add_missing_translation_data }
+
+    private
+
+    def add_missing_translation_data(exception)
+      key = exception.message.sub(/translation missing:.+?\./, '')
+
+      render_rosette_new(key, request.fullpath)
+    end
+
+    def render_rosette_new(key, redirect_path)
+      render 'rosette/new', layout: 'rosette/application', locals: { key: key, redirect_path: redirect_path }
+    end
+  end
+end

data/lib/rosette/engine.rb

@@ -1,5 +1,17 @@
+# frozen_string_literal: true
+
 module Rosette
   class Engine < ::Rails::Engine
     isolate_namespace Rosette
+
+    config.after_initialize do |app|
+      app.routes.prepend do
+        mount Rosette::Engine, at: '/rosette'
+      end
+    end
+
+    ActiveSupport.on_load(:action_controller_base) do
+      include Rosette::Controller
+    end
   end
 end

data/lib/rosette/manager.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class Manager
+  %w[create read delete].each do |verb|
+    class_eval <<-METHOD, __FILE__, __LINE__ + 1
+      def self.#{verb}(*args)
+        new(*args).send('#{verb}')
+      end
+    METHOD
+  end
+
+  private
+
+  def initialize(locale, key, translation = nil)
+    @file_path   = Rails.root.join("config/locales/#{locale}.yml")
+    @keys        = normalize "#{locale}.#{key}"
+    @translation = translation
+  end
+  
+  def read
+    stored_translations.dig(*@keys)
+  end
+
+  def create
+    new_translation      = @keys.reverse.inject(@translation) { |v, k| { k => v } }
+    updated_translations = deep_merge(stored_translations, new_translation)
+    persist(updated_translations)
+    
+    Manager.normalize!
+  end
+
+  def delete
+    updated_translations = delete_translation(stored_translations, @keys)
+    persist(updated_translations)
+
+    Manager.normalize!
+  end
+
+  def delete_translation(translations, keys)
+    return translations.delete(keys.first) if keys.length == 1
+
+    head, *tail = keys
+    delete_translation(translations[head], tail)
+
+    translations
+  end
+
+  def persist(translations)
+    File.write(@file_path, translations.deep_stringify_keys.to_yaml)
+  end
+
+  def stored_translations
+    YAML.safe_load(File.read(@file_path), symbolize_names: true)
+  end
+
+  def deep_merge(hash, other_hash)
+    hash.merge(other_hash) do |_key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        deep_merge(this_val, other_val)
+      else
+        other_val
+      end
+    end
+  end
+
+  def normalize(key)
+    key.split('.').map(&:to_sym)
+  end
+
+  def self.normalize!
+    I18n::Tasks::CLI.start(['normalize']) if Rosette.normalize
+  end
+end

data/lib/rosette/version.rb

@@ -1,3 +1,3 @@
 module Rosette
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/rosette.rb

@@ -1,6 +1,18 @@
-require "rosette/version"
+# frozen_string_literal: true
+
+require "rosette/cli"
+require "rosette/controller"
 require "rosette/engine"
+require "rosette/manager"
+require "rosette/version"
+
+require "i18n/tasks/cli"
+require "yaml"
 
 module Rosette
-  # Your code goes here...
+  mattr_accessor :normalize
+
+  def self.available_locales
+    Rails.configuration.i18n.available_locales.map(&:to_s)
+  end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rosette
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Alexandre Platteeuw
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.12
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +55,8 @@ dependencies:
 description: Add missing translations from the interface of your application
 email:
 - alexplatteeuw@gmail.com
-executables: []
+executables:
+- rosette
 extensions: []
 extra_rdoc_files: []
 files:
@@ -51,12 +66,19 @@ files:
 - app/assets/config/rosette_manifest.js
 - app/assets/stylesheets/rosette/application.css
 - app/controllers/rosette/application_controller.rb
+- app/controllers/rosette/translations_controller.rb
 - app/helpers/rosette/application_helper.rb
 - app/models/rosette/application_record.rb
 - app/views/layouts/rosette/application.html.erb
+- app/views/rosette/new.html.erb
+- bin/rails
+- bin/rosette
 - config/routes.rb
 - lib/rosette.rb
+- lib/rosette/cli.rb
+- lib/rosette/controller.rb
 - lib/rosette/engine.rb
+- lib/rosette/manager.rb
 - lib/rosette/version.rb
 - lib/tasks/rosette_tasks.rake
 homepage: https://rubygems.org/gems/rosette