i18n-analyzer 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6ff7a3c2ece55420785b938db6410a5054f24e6304b4e5b0e1897edb0bcd7f41
+  data.tar.gz: 637d9ef134e5b95cded7b2cdae33669d8c0038dd33faa146945853f57a856a20
+SHA512:
+  metadata.gz: 06e137807490742fa26e3898e1338f2b748d8e8f9fc7f5ac74ff12a84618893485278cbdf399abf19db68e96931b60c38a025aa01add50241b4cad0f4bddaa5c
+  data.tar.gz: 856765900a00b0d2bb5280f7081db4df4a321c4836ed65165529525112bf6d4bd8fd45660febc0315b0d948a7317de372df3263400611c880edce127ee6589df

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright hko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# I18n::Analyzer
+I18n-Analyzer is a small and mountable gem developed by open-circle-ltd for analyzing I18n translations. It gives you an additional page, where you can exactly see, what is translated and what is still missing, from model classes to its fields.
+
+## Usage
+Look at the installation section
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "i18n-analyzer"
+```
+
+Then add this line to your application's routes.rb:
+
+```ruby
+mount I18n::Analyzer::Engine, at: '/analyzer'
+```
+it is also possible to create another link, if it is necessary
+
+### Security Note
+If the analyzer is being mounted, it is recommended to safeguard it by mounting the analyzer in a protected namespace, an example would look like this in routes.rb:
+```ruby
+authenticate :admin do
+  # other mountable apps, not visible for the world
+  mount I18n::Analyzer::Engine, at: '/analyzer'
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+~~Or install it yourself as:~~ Not working for now, gem has to be yet published
+```bash
+$ gem install i18n-analyzer
+```
+
+## Using Library locally
+You can also use the library locally, the steps are as follows:
+
+```ruby
+gem "i18n-analyzer", path: '/path/to/your/gem/i18n-analyzer'
+```
+
+Then add this line to your application's routes.rb:
+
+```ruby
+mount I18n::Analyzer::Engine, at: '/analyzer'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Contributing
+Feel free to create a pull request
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+// TODO: configure file
+// link i18n/analyzer/application.css

data/app/assets/stylesheets/i18n/analyzer/application.css

@@ -0,0 +1,18 @@
+/*
+This file is commented out for now, later on it will be worked upon
+*/
+/*
+ * 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/i18n/analyzer/analyzers_controller.rb

@@ -0,0 +1,5 @@
+module I18n::Analyzer
+  class AnalyzersController < ApplicationController
+    def index; end
+  end
+end

data/app/controllers/i18n/analyzer/application_controller.rb

@@ -0,0 +1,6 @@
+module I18n
+  module Analyzer
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/views/i18n/analyzer/analyzers/index.html.haml

@@ -0,0 +1,52 @@
+-# TODO: implement bootstrap to replace css
+-# NOTE: CSS was implemented to make the functionality presentable. Please do not roast this css
+:css
+  *{ font-family: sans-serif; text-align: center; margin-left: auto; margin-right: auto;} .analyzer-table {font-family: Arial, Helvetica, sans-serif; border-collapse: collapse; width: 60%;} .analyzer-table td, .analyzer-table th {border: 1px solid #ddd; padding: 8px;} .analyzer-table th {padding-top: 12px;padding-bottom: 12px;text-align: center;background-color: #0d3862;color: white;} .no-translation{background-color: #c12917; color: white;}
+
+%h1 I18N - ActiveRecord Debug
+- Rails.application.eager_load! if Rails.env.development?
+- models = ApplicationRecord.descendants
+%table.analyzer-table
+  %tr
+    %th
+    %th{colspan: 2} DE
+    %th{colspan: 2} EN
+  %tr
+    %th Model
+    %th Singular
+    %th Plural
+    %th Singular
+    %th Plural
+  - models.sort_by { |i| i.name }.each do |model|
+    %tr
+      %th= model.name
+      - I18n.with_locale(:de) do
+        %td{class: "#{'no-translation' if model.model_name.human(count: 1, default: '').empty?}"}
+          = model.model_name.human(count: 1)
+        %td{class: "#{'no-translation' if model.model_name.human(count: 99, default: '').empty?}"}
+          = model.model_name.human(count: 99)
+
+      - I18n.with_locale(:en) do
+        %td{class: "#{'no-translation' if model.model_name.human(count: 1, default: '').empty?}"}
+          = model.model_name.human(count: 1)
+        %td{class: "#{'no-translation' if model.model_name.human(count: 99, default: '').empty?}"}
+          = model.model_name.human(count: 99)
+
+- models.sort_by { |i| i.name }.each do |model|
+  %h2= model.name
+  %table.analyzer-table
+    %tr
+      %th Attribute
+      -# TODO: make it, that it reads out the languages from the project and then it loops through the languages
+      %th DE
+      %th EN
+    - model.new.attributes.sort_by { |i| i }.each do |atr, _value|
+      %tr
+        %th= atr
+        - I18n.with_locale(:de) do
+          %td{class: "#{'no-translation' if model.human_attribute_name(atr, default: '').empty?}"}
+            = model.human_attribute_name(atr)
+
+        - I18n.with_locale(:en) do
+          %td{class: "#{'no-translation' if model.human_attribute_name(atr, default: '').empty?}"}
+            = model.human_attribute_name(atr)

data/app/views/layouts/i18n/analyzer/application.html.haml

@@ -0,0 +1,10 @@
+!!!
+%html
+  %head
+    %meta{:content => "text/html; charset=UTF-8", "http-equiv" => "Content-Type"}/
+    %title I18n-Analyzer
+    = csrf_meta_tags
+    = csp_meta_tag
+    = yield :head
+  %body
+    = yield

data/config/routes.rb

@@ -0,0 +1,3 @@
+I18n::Analyzer::Engine.routes.draw do
+  root to: "analyzers#index"
+end

data/lib/i18n/analyzer/engine.rb

@@ -0,0 +1,12 @@
+module I18n
+  module Analyzer
+    class Engine < ::Rails::Engine
+      isolate_namespace I18n::Analyzer
+
+      # TODO: figure out asset precompilation
+      # initializer "i18n_analyzer.assets.precompile" do |app|
+      #   app.config.assets.precompile += %w[i18n_analyzer/application.css]
+      # end
+    end
+  end
+end

data/lib/i18n/analyzer/version.rb

@@ -0,0 +1,6 @@
+module I18n
+  # TODO: make versioning dynamically with semantic release
+  module Analyzer
+    VERSION = "0.1.3"
+  end
+end

data/lib/i18n/analyzer.rb

@@ -0,0 +1,11 @@
+require "i18n/analyzer/version"
+require "i18n/analyzer/engine"
+
+module I18n
+  module Analyzer
+    # NOTE: This is an important method, do not delete this, this was carefully designed and reviewed
+    def self.❨╯°□°❩╯︵┻━┻
+      puts "Take a deep breath and count to ten..."
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: i18n-analyzer
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- opencircle-operator
+bindir: bin
+cert_chain: []
+date: 2025-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.1
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: I18n-Analyzer is a small and mountable gem developed by open-circle-ltd
+  for analyzing I18n translations. It gives you an additional page, where you can
+  exactly see, what is translated and what is still missing, from model classes to
+  its fields.
+email:
+- operator@open-circle.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/manifest.js
+- app/assets/stylesheets/i18n/analyzer/application.css
+- app/controllers/i18n/analyzer/analyzers_controller.rb
+- app/controllers/i18n/analyzer/application_controller.rb
+- app/views/i18n/analyzer/analyzers/index.html.haml
+- app/views/layouts/i18n/analyzer/application.html.haml
+- config/routes.rb
+- lib/i18n/analyzer.rb
+- lib/i18n/analyzer/engine.rb
+- lib/i18n/analyzer/version.rb
+homepage: https://github.com/open-circle-ltd/i18n-analyzer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/open-circle-ltd/i18n-analyzer
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A mountable gem for analyzing I18n translations in your rails application.
+test_files: []