moirai 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f735406747923f4a2493a81628e4cd88cf6f54d926fb31448ca5dab4ae70a8b9
+  data.tar.gz: 40f69e72824a96f13fe4e67b753a36617a745cdca04c61e691c7cc7877c55b96
+SHA512:
+  metadata.gz: 19eeb5b122adcd1f46fbfee0a39440f5d6ef9536bf28f8486f36fed40506d61449793adc6681cd3ce5eb35c10f9b5021928f97494e0c7063a5736fc8c0a2ea90
+  data.tar.gz: 9e3d8298eac29bca6008af867b57f8e663d9128c07bccf531c400c2c2889109b15515b676b6bbd0d85144fae119cc087a5ad3bb6cec83564edae67907b73543c

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @renuo/moirai

data/.github/workflows/test.yml

@@ -0,0 +1,56 @@
+name: Test & lint
+on: [push, pull_request]
+
+env:
+  RAILS_ENV: test
+  PGHOST: localhost
+  PGUSER: postgres
+
+jobs:
+  tests:
+    name: Test
+    
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        ruby: [3.1, 3.2, 3.3]
+    
+    runs-on: ${{ matrix.os }}
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      
+      - name: Run tests
+        run: bin/check
+  
+  
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.3
+          bundler-cache: true
+      
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+      
+      - name: Run linters
+        run: bin/fastcheck

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/log/*.log
+/pkg/
+/tmp/
+/test/dummy/db/*.sqlite3
+/test/dummy/db/*.sqlite3-*
+/test/dummy/log/*.log
+/test/dummy/storage/
+/test/dummy/tmp/
+
+.env
+/Gemfile.lock
+*.gem
+.idea/

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "rails_7_2" do
+  gem "rails", "~> 7.2"
+end
+
+appraise "rails_7_1" do
+  gem "rails", "~> 7.1"
+end
+
+appraise "rails_7_0" do
+  gem "rails", "~> 7.0"
+end
+
+appraise "rails_6_1" do
+  gem "rails", "~> 6.1"
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.1.0 
+
+* Gem structure created ([@oliveranthony17][])
+
+[@coorasse]: https://github.com/coorasse
+
+[@oliveranthony17]: https://github.com/oliveranthony17
+
+[@CuddlyBunion341]: https://github.com/CuddlyBunion341

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "puma"
+  gem "sqlite3"
+  gem "minitest"
+  gem "rake"
+  gem "standard"
+  gem "appraisal"
+  gem "better_errors"
+  gem "binding_of_caller"
+  gem "sprockets-rails"
+end

data/README.md

@@ -0,0 +1,180 @@
+# 🧵 Moirai
+
+<img src="./docs/moirai.png" width="100%" />
+
+### Manage translation strings in real time
+
+- Let your non-developer team members finally manage translations (yes, even Karen from marketing...).
+- See those translations live in your app, so you can make sure “Submit” isn’t overlapping the button where “**Do not press this button EVER” should be.
+- Automatically create Pull Requests based on these changes, saving your developers from yet another “small tweak” email request.
+
+> Let the world be translated, one typo at a time.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "moirai"
+```
+
+And then execute:
+```bash
+bundle
+```
+
+Next, you need to run the generator which will create the necessary files including the database migration, as well as inserting the engine in the `routes.rb` file:
+
+```bash
+bin/rails g moirai:install
+```
+
+Then run:
+
+```bash
+bin/rails db:migrate
+```
+
+## Usage
+
+### How to change translations
+
+If you mounted Moirai under "/moirai", head there and you will find a list of all the files containing texts that can be translated.
+Open a file, change the value of translations, and press ENTER to update the translation and see it immediately changed on the application.
+
+### Inline editing
+
+By default, inline editing is disabled. To enable it, set the `moirai=true` query parameter in the URL.
+If you want to only allow specific users to perform inline editing, you can override the `moirai_edit_enabled?` method in your application helper.
+
+```ruby
+module ApplicationHelper
+  def moirai_edit_enabled?
+    params[:moirai] == "true" || current_user&.admin?
+  end
+end
+```
+
+### Automatic PR creation with Octokit (**optional**)
+
+If you would like Moirai to automatically create a pull request on GitHub to keep translations synchronized with the codebase, 
+you need to set up [Octokit](https://github.com/octokit/octokit.rb).
+You will also need to create a **Personal Access Token** on GitHub, and configure the access in the appropriate **environment variables** (this is explained below).
+
+#### 1. Add Octokit to Your Gemfile
+
+First, add Octokit to your project’s Gemfile:
+
+```
+gem 'octokit'
+```
+
+Then run `bundle install`.
+
+#### 2. Create a Personal Access Token (PAT) on GitHub
+
+You will need a Personal Access Token (PAT) with the `Content - Write` permission to allow Octokit to create branches and pull requests.
+
+-	Go to GitHub Token Settings.
+-	Click Generate New Token.
+-	Give your token a name (e.g., “Moirai”).
+-	Under Scopes, select:
+     -	repo (for full control of private repositories, including writing content).
+     -	content (for read/write access to code, commit statuses, and pull requests).
+-	Generate the token and copy it immediately as it will be shown only once.
+
+#### 3. Set Up Environment Variables
+
+You need to configure the following environment variables in your application:
+
+-	`MOIRAI_GITHUB_REPO_NAME`: The name of the repository where the pull request will be created.
+-	`MOIRAI_GITHUB_ACCESS_TOKEN`: The Personal Access Token (PAT) you created earlier.
+
+For example, in your `.env` file:
+
+```env
+MOIRAI_GITHUB_REPO_NAME=your-organization/your-repo
+MOIRAI_GITHUB_ACCESS_TOKEN=your-generated-token
+```
+
+We also support Rails credentials. The environment variables need to be stored in a slightly different way to adhere to convention. For example:
+
+```env
+moirai:
+  github_repo_name: your-organization/your-repo
+  github_access_token: your-generated-token
+```
+
+#### 4. Triggering the pull request creation
+
+Moirai will now be able to use this Personal Access Token to create a pull request on GitHub when a translation is updated.
+
+To trigger this, you can press the `Create or update PR` button once you have made your changes.
+
+### Authentication
+
+Moirai allows you to use basic HTTP authentication to protect the engine. 
+To enable this, you need to set the following environment variables:
+
+```env
+MOIRAI_BASICAUTH_NAME=moirai
+MOIRAI_BASICAUTH_PASSWORD=moirai
+```
+
+> ⚠️ Remember to protect Moirai. You don't want to give everyone the possibility to change strings in the application.
+
+If you have authenticated users, you can leverage the Rails Routes protection mechanism to protect the engine. 
+See the following example:
+
+```ruby
+authenticated :user, lambda {|u| u.role == "admin"} do
+  mount Moirai::Engine => '/moirai', as: 'moirai'
+end
+```
+
+## Development
+
+1. Check out the repo:
+    ```bash
+    git clone git@github.com:renuo/moirai.git
+    cd moirai
+    ```
+
+2. Run the setup script to install dependencies:
+    ```bash
+    bin/setup
+    ```
+
+3. Copy the example environment variables file to create your own `.env` file:
+    ```bash
+    cp .env.example .env
+    ```
+
+4. Set your environment variables using the newly created `.env` file.
+
+5. Run the tests:
+    ```bash
+    bin/check
+    ```
+
+6. To view the engine in a dummy app:
+    ```bash
+    bin/rails s
+    ```
+
+## TODO
+
+* Support for HTML
+* Support for interpolation
+* Support for count variants
+* Better inline editing tool
+* Performance of translations lookup
+* Support for translations and strings coming from other gems
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Copyright
+
+Copyright [Renuo AG](https://www.renuo.ch/).

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/app/assets/config/moirai_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../stylesheets/moirai .css
+//= link_directory ../javascripts/moirai .js

data/app/assets/javascripts/moirai/application.js

@@ -0,0 +1,2 @@
+//= require ./stimulus/init
+//= require ./controllers/moirai_translation_controller

data/app/assets/javascripts/moirai/controllers/moirai_translation_controller.js

@@ -0,0 +1,27 @@
+Stimulus.register(
+  "moirai-translation",
+  class extends Controller {
+    click(event) {
+      event.preventDefault()
+    }
+
+    submit(event) {
+      const {filePath, key} = event.target.dataset
+
+      const csrfToken = document.querySelector('meta[name="csrf-token"]').content  
+
+      const formObject = new FormData()
+      formObject.append('translation[key]', key)
+      formObject.append('translation[file_path]', filePath)
+      formObject.append('translation[value]', event.target.innerText)
+
+      fetch(`/moirai/translation_files`, {
+        method: 'POST',
+        headers: {
+          'X-CSRF-Token': csrfToken
+        },
+        body: formObject
+      })
+    }
+  }
+);

data/app/assets/javascripts/moirai/stimulus/init.js

@@ -0,0 +1,5 @@
+import {
+  Application,
+  Controller,
+} from "https://unpkg.com/@hotwired/stimulus/dist/stimulus.js";
+window.Stimulus = Application.start();

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

@@ -0,0 +1,15 @@
+/*
+ * 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
+ */

data/app/controllers/moirai/application_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Moirai
+  class ApplicationController < ActionController::Base
+    before_action :authenticate, if: :basic_auth_present?
+
+    def authenticate
+      if basic_auth_present?
+        authenticate_or_request_with_http_basic do |name, password|
+          name == ENV["MOIRAI_BASICAUTH_NAME"] && password == ENV["MOIRAI_BASICAUTH_PASSWORD"]
+        end
+      end
+    end
+
+    private
+
+    def basic_auth_present?
+      ENV["MOIRAI_BASICAUTH_NAME"].present? && ENV["MOIRAI_BASICAUTH_PASSWORD"].present?
+    end
+  end
+end

data/app/controllers/moirai/translation_files_controller.rb

@@ -0,0 +1,93 @@
+module Moirai
+  class TranslationFilesController < ApplicationController
+    before_action :load_file_handler, only: [:index, :show, :create_or_update]
+    before_action :set_translation_file, only: [:show]
+
+    def index
+      @files = @file_handler.file_paths.map do |path|
+        {
+          id: Digest::SHA256.hexdigest(path),
+          name: File.basename(path),
+          path: path
+        }
+      end
+    end
+
+    def show
+      @translation_keys = @file_handler.parse_file(@decoded_path)
+    end
+
+    def create_or_update
+      if (translation = Translation.find_by(file_path: translation_params[:file_path],
+        key: translation_params[:key],
+        locale: @file_handler.get_first_key(translation_params[:file_path])))
+        handle_update(translation)
+      else
+        handle_create
+      end
+    end
+
+    def open_pr
+      flash.notice = "I created an amazing PR"
+      changes = Moirai::TranslationDumper.new.call
+      Moirai::PullRequestCreator.new.create_pull_request(changes)
+      redirect_back_or_to(root_path)
+    end
+
+    private
+
+    def handle_update(translation)
+      translation_from_file = @file_handler.parse_file(translation_params[:file_path])
+      if translation_from_file[translation.key] == translation_params[:value] || translation_params[:value].blank?
+        translation.destroy
+        flash.notice = "Translation #{translation.key} was successfully deleted."
+        redirect_to_translation_file(translation.file_path)
+        return
+      end
+
+      if translation.update(value: translation_params[:value])
+        flash.notice = "Translation #{translation.key} was successfully updated."
+      else
+        flash.alert = translation.errors.full_messages.join(", ")
+      end
+
+      redirect_to_translation_file(translation.file_path)
+    end
+
+    def handle_create
+      translation_from_file = @file_handler.parse_file(translation_params[:file_path])
+      if translation_from_file[translation_params[:key]] == translation_params[:value]
+        flash.alert = "Translation #{translation_params[:key]} already exists."
+        redirect_to_translation_file(translation_params[:file_path])
+        return
+      end
+
+      translation = Translation.new(translation_params)
+      translation.locale = @file_handler.get_first_key(translation_params[:file_path])
+      if translation.save
+        flash.notice = "Translation #{translation.key} was successfully created."
+      else
+        flash.alert = translation.errors.full_messages.join(", ")
+      end
+
+      redirect_to_translation_file(translation.file_path)
+    end
+
+    def redirect_to_translation_file(file_path)
+      redirect_back_or_to moirai_translation_file_path(Digest::SHA256.hexdigest(file_path))
+    end
+
+    def set_translation_file
+      @file_path = @file_handler.file_hashes[params[:id]]
+      @decoded_path = CGI.unescape(@file_path)
+    end
+
+    def translation_params
+      params.require(:translation).permit(:key, :locale, :value, :file_path)
+    end
+
+    def load_file_handler
+      @file_handler = Moirai::TranslationFileHandler.new
+    end
+  end
+end

data/app/helpers/moirai/application_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Moirai
+  module ApplicationHelper
+    def shorten_path(path)
+      path.gsub(Rails.root.to_s, ".")
+    end
+  end
+end

data/app/jobs/moirai/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Moirai
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/moirai/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Moirai
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/moirai/translation.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Moirai
+  class Translation < Moirai::ApplicationRecord
+    validates_presence_of :key, :locale, :file_path
+    validate :file_path_must_exist
+
+    private
+
+    def file_path_must_exist
+      errors.add(:file_path, "must exist") unless file_path && File.exist?(file_path)
+    end
+  end
+end

data/app/models/moirai/translation_dumper.rb

@@ -0,0 +1,43 @@
+module Moirai
+  class TranslationDumper
+    def call
+      project_root = Rails.root.to_s
+      Moirai::Translation.pluck(:file_path).uniq.map do |file_path|
+        absolute_file_path = File.expand_path(file_path, project_root)
+        next unless absolute_file_path.start_with?(project_root)
+
+        updated_file_contents = get_updated_file_contents(file_path)
+        {
+          file_path: file_path.sub(project_root, "."),
+          content: updated_file_contents
+        }
+      end.compact
+    end
+
+    private
+
+    def get_updated_file_contents(file_path)
+      translations = Moirai::Translation.where(file_path: file_path)
+
+      yaml = YAML.load_file(file_path)
+
+      translations.each do |translation|
+        keys = [translation.locale] + translation.key.split(".")
+
+        node = yaml
+
+        (0...keys.size).each do |i|
+          key = keys[i]
+          if i == keys.size - 1
+            node[key] = translation.value
+          else
+            node[key] ||= {}
+            node = node[key]
+          end
+        end
+      end
+
+      yaml.to_yaml
+    end
+  end
+end

data/app/models/moirai/translation_file_handler.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Moirai
+  class TranslationFileHandler
+    attr_reader :file_paths, :file_hashes
+
+    def initialize
+      load_file_paths
+      generate_file_hashes
+    end
+
+    def parse_file(path)
+      yaml_content = YAML.load_file(path)
+      root_key = yaml_content.keys.first
+      flatten_hash(yaml_content[root_key])
+    end
+
+    def get_first_key(file_path)
+      yaml_content = YAML.load_file(file_path)
+      yaml_content.keys.first
+    end
+
+    private
+
+    def load_file_paths
+      i18n_file_paths = I18n.load_path
+      @file_paths = i18n_file_paths.select { |path| path.starts_with?(Rails.root.to_s) && path.end_with?(".yml", ".yaml") }
+    end
+
+    def generate_file_hashes
+      @file_hashes = @file_paths.map { |path| [Digest::SHA256.hexdigest(path), path] }.to_h
+    end
+
+    def flatten_hash(hash, parent_key = "", result = {})
+      hash.each do |key, value|
+        new_key = parent_key.empty? ? key.to_s : "#{parent_key}.#{key}"
+        case value
+        when Hash
+          flatten_hash(value, new_key, result)
+        when Array
+          value.each_with_index do |item, index|
+            array_key = "#{new_key}.#{index}"
+            if item.is_a?(Hash)
+              flatten_hash(item, array_key, result)
+            else
+              result[array_key] = item
+            end
+          end
+        else
+          result[new_key] = value
+        end
+      end
+      result
+    end
+  end
+end