rosette 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dffb250e67fdc3f3935d85dbbe875fa56b8843629b138cb4444f7e5f2166cb6b
-  data.tar.gz: d2dcf4ab94c13916db15b7739661b86fcf06ad1f8fa16e73fffbd8f1d51793b5
+  metadata.gz: 7d06214ac63c9666ca0fd74730175cc9eb308dbd16bd83e3fca8e9336d7123dc
+  data.tar.gz: d7521ae037801fa8c83d74dd2a22f6aa11f3269f90e60fc117746429b238564b
 SHA512:
-  metadata.gz: f559af7434bb4ccff09fa5eb0ba4532559fe424621846ea910bf050facce940b61b3e0edf1e09f37e2862b8f2e0083482d25e46b3412d8769aeba41c90a2f2d9
-  data.tar.gz: 99f57b0c1edf0b156d76aec004fe200430940f4318229ca2d34d0b1b2d3cc57124bacffab894252bf7f3ff58a5eb5edd8b452067fad0d7f2b0dfa4101196bda4
+  metadata.gz: 2118244884e6269ae5b3ef2146037ca7086fe32bad51f4bc4be5ab9ba3a12c262cb9244ef48d564537f3223185b3f4f563787b1b14bbc4439a078e2a0dff6267
+  data.tar.gz: 62c3f6715880adb58917f3a69544673b4110c8b47f0f1e7192e4858919104e2679925f86bba89370410c049379f56de7c72818fe67f6752789617651c85828fe

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/setup"
 
 APP_RAKEFILE = File.expand_path("spec/example_app/Rakefile", __dir__)

data/app/controllers/rosette/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rosette
   class ApplicationController < ActionController::Base
   end

data/app/controllers/rosette/translations_controller.rb

@@ -2,12 +2,13 @@
 
 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'
+      redirect_to redirect_path, notice: "Translation(s) added"
     rescue StandardError => e
       @error_message = e.message
       render_rosette_new(key, redirect_path)
@@ -15,20 +16,21 @@ module Rosette
 
     private
 
-    def translations_params
-      params.require(:translations).permit(:key, :redirect_path, available_locales: {})
-    end
+      def translations_params
+        params.require(:translations).permit(:key, :redirect_path, available_locales: {})
+      end
 
-    def available_locales
-      translations_params[:available_locales]
-    end
+      def available_locales
+        translations_params[:available_locales]
+      end
 
-    def key
-      translations_params[:key]
-    end
+      def key
+        translations_params[:key]
+      end
+
+      def redirect_path
+        URI.parse(translations_params[:redirect_path]).to_s
+      end
 
-    def redirect_path
-      URI.parse(translations_params[:redirect_path]).to_s
-    end
   end
 end

data/app/helpers/rosette/application_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rosette
   module ApplicationHelper
   end

data/app/models/rosette/application_record.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Rosette
   class ApplicationRecord < ActiveRecord::Base
+
     self.abstract_class = true
+
   end
 end

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

@@ -12,7 +12,7 @@
     <%= f.hidden_field :redirect_path, value: redirect_path %>
 
     <%= f.fields_for :available_locales do |a| %>
-      <% Rails.configuration.i18n.available_locales.each do |locale| %>
+      <% Rosette.available_locales.each do |locale| %>
         <%= a.label locale, "#{locale.capitalize} translation:" %>
         <%= a.text_field locale, required: false, label: false, class: 'input-text' %>
       <% end %>

data/bin/rails

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# 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,21 @@
+#!/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"
+
+Rosette::CLI.run

data/config/routes.rb

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

data/lib/rosette/cli.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "tty-prompt"
+
+module Rosette
+  class CLI
+
+    class << self
+
+      attr_reader :prompt, :command
+
+      delegate :select, :ask, to: :@prompt
+
+      def run
+        ask_for_command
+
+        return help if command == "help"
+
+        ask_for_key
+        send command
+      end
+
+      private
+
+        def ask_for_command
+          @prompt = TTY::Prompt.new
+          @command = select("What do you want to achieve?") do |menu|
+            menu.choice("Read a translation", "read")
+            menu.choice("Add a translation", "add")
+            menu.choice("Remove a translation", "remove")
+            menu.choice("Display help", "help")
+          end
+        end
+
+        def ask_for_key
+          @key = ask "Please provide the key to translation:"
+          normalize_key!
+        end
+
+        def normalize_key!
+          Rosette.available_locales.each do |locale|
+            @key = @key.delete_prefix("#{locale}.")
+          end
+        end
+
+        # COMMANDS
+
+        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|
+            translation = ask "Please enter #{locale} translation:"
+            Manager.create(locale, @key, translation)
+          end
+        end
+
+        def remove
+          Rosette.available_locales.each do |locale|
+            Manager.delete(locale, @key)
+          end
+        end
+
+        def help
+          puts <<~HELP
+
+            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

@@ -2,20 +2,22 @@
 
 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:.+?\./, '')
+      def add_missing_translation_data(exception)
+        key = exception.message.sub(/translation missing:.+?\./, "")
+
+        render_rosette_new(key, request.fullpath)
+      end
 
-      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
 
-    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

@@ -2,16 +2,18 @@
 
 module Rosette
   class Engine < ::Rails::Engine
+
     isolate_namespace Rosette
 
     config.after_initialize do |app|
       app.routes.prepend do
-        mount Rosette::Engine, at: '/rosette'
+        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

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

data/lib/rosette/version.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
 module Rosette
-  VERSION = "0.2.0"
+
+  VERSION = "0.3.1"
+
 end

data/lib/rosette.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "rosette/cli"
 require "rosette/controller"
 require "rosette/engine"
 require "rosette/manager"
@@ -9,5 +10,11 @@ require "i18n/tasks/cli"
 require "yaml"
 
 module Rosette
+
   mattr_accessor :normalize
+
+  def self.available_locales
+    Rails.configuration.i18n.available_locales.map(&:to_s)
+  end
+
 end

data/lib/tasks/rosette_tasks.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # desc "Explaining what the task does"
 # task :rosette do
 #   # Task goes here

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rosette
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Alexandre Platteeuw
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n-tasks
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +69,8 @@ dependencies:
 description: Add missing translations from the interface of your application
 email:
 - alexplatteeuw@gmail.com
-executables: []
+executables:
+- rosette
 extensions: []
 extra_rdoc_files: []
 files:
@@ -70,8 +85,11 @@ files:
 - 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