rails_translations 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5af6142ee3a589039ee1a384285162e1f5af9f50360f14b1016a75485c9fa88d
+  data.tar.gz: 0d409ae7dcabf3fdc8ddab2e685a950b751a4f7ff2144dd77411bae665fb9e1e
+SHA512:
+  metadata.gz: 91c24d850ea7cc47c35812e846b25d37ef2698f81a1daaebf2abb31e3b647670c82f810895c89228bff5a73ede96f54aa8af3a1e65d69380feb1aecdebe94185
+  data.tar.gz: 82f37cc74496cc176263414363e8906209db0e932df40dbeac7d808fd67bf73368e756e13d237d57d7b50eade6b15b19781f6ef41c69620b343009ba2c1d19fc

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_translations.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -0,0 +1,19 @@
+PATH
+  remote: .
+  specs:
+    rails_translations (0.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails_translations!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 vedraninho
+
+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,99 @@
+# RailsTranslations
+
+A gem that syncs locales yml files and generates models attributes translation placeholders.
+
+## Installation
+
+Add this line to your application's Gemfile only (`recommended: for development environment only`):
+
+```ruby
+gem 'rails_translations'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+This gem can only be used from Rails console at this point. The terminal commands will be added in future releases.
+
+## Equilizing translations files
+
+**It's assumed that you are using default rails `config/locales/` folder organization with files which are not nested under subfolders and which have `.yml` extension.**
+
+There are 2 commands which equilize your translation files:
+
+### `RailsTranslations.equilize_translations(options={})`
+
+This will go through all your translations files and merge their keys. The existing keys inside the each file will be preserved and those added from other files will have default suffix `"TODO: "`. It will not cross merge keys if you have multiple files for same locale in your `config/locales/` directory.
+
+### `RailsTranslations.equilize_files(file_name, options={})`
+
+This is essentially the same as the first command but only for one set of translation files. For example if you pass `"models"` as a file name it will merge the translations of *models.en.yml, models.hr.yml, models.de.yml* etc. You can list your file names with `RailsTranslations.get_translations_files_list` - this will give you the file names without `locale.yml` extension.
+
+### Options
+`equilize_locales:` accepts the array of locales you want to merge with other locales. For example, if you have `:hr, :en, :de` and you pass `RailsTranslations.equilize_translations(equilize_locales: [:hr, :de])` the missing keys in files for those locales will be added from other locales - in this case any keys from *models.hr.yml* and *models.de.yml* will not be added to *models.en.yml*.
+
+`take_from_locales:` accepts the array of locales you want to take missing translations from. So if you pass `RailsTranslations.equilize_translations(equilize_locales: [:hr, :de])` no translations from `.en` files would be copied to the `.de` or `.hr` files.
+
+`file_names:` accepts the array of file names you want to equilize - only for `equilize_translations` mathod. For example `RailsTranslations.equilize_translations(file_names: ["mailing", "devise"])`. Note that file name for base translation files, such as `en.yml` or `de.yml`, is empty string `""`.
+
+`prefix:` here you specify how you want to prefix the added missing translations. Default value is `"TODO:"`. And if you pass `RailsTranslations.equilize_translations(prefix: "MISSING:")` it will add the missing translation as:
+```yml
+de:
+  ...
+  missing_translation: "MISSING: some missing translation"
+  ...
+```
+
+### Usage tips
+
+When copying missing translations the method will prioretize the locale which goes first, so if your `I18n.available_locales` are `[:en, :de, :hr]` missing translation will be copied from `:en` first. To change this order, just pass the `take_from_locales:` in prefered order.
+
+If you pass unexisting `file_names:` the method will create set of files with that name so it can be used to generate new translation files. 
+
+If you have `[:en, :de, :hr]` available locales and you are missing the files for one of the locales it will generate new file by mergeing other two locale files, so it can be used for generating new set of files if new available locale is added or files are simply missing.
+
+## Building models attributes placeholders
+
+It is used to collect models attributes and make the translations placeholders in file named `"models_fields"` by default.
+
+`RailsTranslations.build_attributes_placeholders(options={})`
+
+It will go through your models, collect attributes and for each your available locale generate something like:
+
+```yml
+en:
+  activerecord:
+    attributes:
+      user:
+        email: ""
+        encrypted_password: ""
+        reset_password_token: ""
+        reset_password_sent_at: ""
+        ...
+```
+
+If that file already exists, it will not override the existing translations, it will only add the missing ones.
+
+### Options
+
+`write_to_locales:` accepts array of locales for which you want to generate the files. `RailsTranslations.build_attributes_placeholders(write_to_locales: [:hr])` will only generate `models_fields.hr.yml`.
+
+`file_name:` define the file name, default value is `"models_fields"`.
+
+## Future improvements
+
+- Use Thor to make it executable from command line.
+- Pass model names to `build_attributes_placeholders` method to avoid repeteadly removing unwanted translation placeholders.
+- Add module for editing translations in browser.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/vedranmijatovic0/rails_translations
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_translations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rails_translations

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rails_translations'
+
+#RailsTranslations::CLI.start(ARGV)

data/lib/custom_hash.rb

@@ -0,0 +1,40 @@
+module CustomHash
+	refine Hash do
+
+		def set_deep_values(new_value)
+			self.keys.each do |key|
+				self[key].is_a?(Hash) ? self[key].set_deep_values(new_value) : self[key] = new_value
+			end
+			self
+		end
+
+		def prefix_deep_values_with(prefix="TODO:")
+			self.keys.each do |key|
+				self[key].is_a?(Hash) ? self[key].prefix_deep_values_with(prefix) : self[key] = "#{prefix} #{self[key]}"
+			end
+			self
+		end
+
+		def to_yml(identation=0)
+			yml = ""
+			self.each do |key, value|
+				key = "\"#{key}\"" if key.in? yml_reserved_words
+				if value.is_a?(Hash)
+					yml += "#{ "  " * identation }#{key}:\n#{value.to_yml(identation+1)}"
+				else
+					yml += "#{ "  " * identation }#{key}: \"#{value.gsub('"', '\\"')}\"\n"
+				end
+			end
+			yml
+		end
+
+		def yml_reserved_words
+			[
+				"y", "Y", "yes", "Yes", "YES", "n", "N", "no",
+				"No", "NO", "true", "True", "TRUE", "false", "False",
+				"FALSE", "on", "On", "ON", "off", "Off", "OFF"
+			]
+		end
+
+	end
+end

data/lib/rails_translations/version.rb

@@ -0,0 +1,3 @@
+module RailsTranslations
+  VERSION = "0.2.1"
+end

data/lib/rails_translations.rb

@@ -0,0 +1,104 @@
+require "rails_translations/version"
+require "custom_hash"
+
+module RailsTranslations
+  class Error < StandardError; end
+
+  using CustomHash
+
+  class << self
+
+    def equilize_translations(options={})
+      file_names = options[:file_names] ? options[:file_names] : get_translation_file_names
+      file_names.each do |file_name|
+        equilize_files(file_name, options)
+      end
+    end
+
+    def equilize_files(file_name, options={})
+      equilize_locales = options[:equilize_locales] ? options[:equilize_locales] : I18n.available_locales
+      take_from_locales = options[:take_from_locales] ? options[:take_from_locales] : I18n.available_locales
+      prefix = options[:prefix].blank? ? nil : options[:prefix]
+
+      equilize_locales.each do |locale|
+        keys = load_keys(file_name, locale)
+        other_locales = take_from_locales - [ locale ]
+        other_locales.each do |other_locale|
+          other_keys = load_keys(file_name, other_locale).prefix_deep_values_with()
+          keys = other_keys.deep_merge(keys)
+        end
+        write_to_yml_file(file_name, locale, keys)
+      end
+    end
+
+    def build_attributes_placeholders(options={})
+      models_attributes = collect_attributes_from_models
+      write_to_locales = options[:write_to_locales] ? options[:write_to_locales] : I18n.available_locales
+
+      file_name = options[:file_name].blank? ? 'models_fields' : options[:file_name]
+
+      write_to_locales.each do |locale|
+        write_to_yml_file(
+          file_name,
+          locale,
+          models_attributes.deep_merge(load_keys(file_name, locale))
+        )
+      end
+    end
+
+    def get_translations_files_list
+      get_translations_files_paths.map{ |f| f.split(File::SEPARATOR).last }
+    end
+
+    private
+
+    def collect_attributes_from_models(options={})
+      models_attributes = { activerecord: { attributes: {} }}
+      application_models.each do |model|
+        attributes = model.new.attributes.keys - ["created_at", "updated_at", "id"]
+        if attributes.any?
+          model_attributes = {}
+          (attributes).each do |key|
+            model_attributes.merge!({ :"#{key}" => '' })
+          end
+          models_attributes[:activerecord][:attributes][model.name.underscore] = model_attributes
+        end
+      end
+      models_attributes.deep_stringify_keys
+    end
+
+    def application_models
+      Rails.application.eager_load!
+      (ActiveRecord::Base.descendants - [ApplicationRecord])
+    end
+
+    def load_translation_file(file_name)
+      begin
+        YAML::load(File.read(File.join(Rails.root, 'config', 'locales', file_name)))
+      rescue Errno::ENOENT
+        {}
+      end
+    end
+
+    def get_translations_files_paths
+      Dir.glob(File.join("config", "locales", "*"))
+    end
+
+    def get_translation_file_names
+      get_translations_files_list.map{ |f| f.gsub(f.split(".")[-2..-1].join("."), "").sub(/\.$/, "") }.flatten.uniq
+    end
+
+    def load_keys(file_name, locale)
+      load_translation_file([file_name, locale, 'yml'].reject(&:blank?).join("."))[locale.to_s].to_h
+    end
+
+    def write_to_yml_file(file_name, locale, keys)
+      file = File.join(Rails.root, 'config', 'locales', [ file_name, locale, "yml" ].reject(&:blank?).join("."))
+      file_keys = { :"#{locale}" => keys }
+      open(file, 'w') do |f|
+        f.puts file_keys.to_yml
+      end
+    end
+
+  end
+end

data/rails_translations.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/rails_translations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_translations"
+  spec.version       = RailsTranslations::VERSION
+  spec.authors       = ["vedraninho"]
+  spec.email         = ["vedran.mijatovic@bamboolab.eu"]
+
+  spec.summary       = "Sync your translations files and generate file with model attributes"
+  spec.homepage      = "https://gitlab.com/vedranmijatovic0/rails_translations"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: rails_translations
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- vedraninho
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- vedran.mijatovic@bamboolab.eu
+executables:
+- rails_translations
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rails_translations
+- lib/custom_hash.rb
+- lib/rails_translations.rb
+- lib/rails_translations/version.rb
+- rails_translations.gemspec
+homepage: https://gitlab.com/vedranmijatovic0/rails_translations
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/vedranmijatovic0/rails_translations
+  source_code_uri: https://gitlab.com/vedranmijatovic0/rails_translations
+  changelog_uri: https://gitlab.com/vedranmijatovic0/rails_translations
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Sync your translations files and generate file with model attributes
+test_files: []