i18n-js 3.9.2 → 4.0.1

data/Rakefile

@@ -1,25 +1,15 @@
-require "appraisal"
-require "rubygems"
-require "bundler"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-Bundler::GemHelper.install_tasks
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
 
-RSpec::Core::RakeTask.new(:"spec:ruby")
-
-desc "Run JavaScript specs"
-task "spec:js" do
-  # Need to call `exit!` manually to propogate exit status
-  system "npm", "test" or exit!(1)
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-desc "Run all specs"
-task :spec => ["spec:ruby", "spec:js"]
+RuboCop::RakeTask.new
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
-  task :default do
-    sh "appraisal install && rake appraisal spec"
-  end
-else
-  task :default => :spec
-end
+task default: %i[test rubocop]

data/exe/i18n

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/i18n-js/cli"
+I18nJS::CLI.new(argv: ARGV, stdout: $stdout, stderr: $stderr).call

data/i18n-js.gemspec

@@ -1,30 +1,49 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "i18n/js/version"
-
-Gem::Specification.new do |s|
-  s.name        = "i18n-js"
-  s.version     = I18n::JS::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Nando Vieira"]
-  s.email       = ["fnando.vieira@gmail.com"]
-  s.homepage    = "https://rubygems.org/gems/i18n-js"
-  s.summary     = "It's a small library to provide the Rails I18n translations on the Javascript."
-  s.description = s.summary
-  s.license       = "MIT"
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-
-  s.add_dependency "i18n", ">= 0.6.6"
-
-  s.add_development_dependency "appraisal", "~> 2.3"
-  s.add_development_dependency "rspec", "~> 3.0"
-  s.add_development_dependency "rake", "~> 12.0"
-  s.add_development_dependency "gem-release", ">= 0.7"
-  s.add_development_dependency "coveralls", ">= 0.7"
-
-  s.required_ruby_version = ">= 2.1.0"
+# frozen_string_literal: true
+
+require_relative "./lib/i18n-js/version"
+
+Gem::Specification.new do |spec|
+  spec.name    = "i18n-js"
+  spec.version = I18nJS::VERSION
+  spec.authors = ["Nando Vieira"]
+  spec.email   = ["me@fnando.com"]
+
+  spec.summary     = "Export i18n translations and use them on JavaScript."
+  spec.description = spec.summary
+  spec.license     = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.metadata = {"rubygems_mfa_required" => "true"}
+
+  github_url = "https://github.com/fnando/i18n-js"
+  github_tree_url = "#{github_url}/tree/v#{spec.version}"
+
+  spec.homepage = github_url
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["bug_tracker_uri"] = "#{github_url}/issues"
+  spec.metadata["source_code_uri"] = github_tree_url
+  spec.metadata["changelog_uri"] = "#{github_tree_url}/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{github_tree_url}/README.md"
+  spec.metadata["license_uri"] = "#{github_tree_url}/LICENSE.md"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|f| f.match(%r{^(test|spec|features|images)/}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "glob"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
 end

data/lib/guard/i18n-js/templates/Guardfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+guard(:"i18n-js",
+      run_on_start: true,
+      config_file: "./config/i18n.yml",
+      require_file: "./config/environment.rb") do
+  watch(%r{^(app|config)/locales/.+\.(yml|po)$})
+  watch(%r{^config/i18n.yml$})
+  watch("Gemfile")
+end

data/lib/guard/i18n-js/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+gem "guard"
+gem "guard-compat"
+require "guard/compat/plugin"
+
+require "i18n-js"
+
+module Guard
+  class I18njsVersion < Plugin
+    VERSION = I18nJS::VERSION
+  end
+end

data/lib/guard/i18n-js.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+gem "guard"
+gem "guard-compat"
+require "guard/compat/plugin"
+
+require "i18n-js"
+
+module Guard
+  class I18njs < Plugin
+    attr_reader :config_file, :require_file, :current_thread
+
+    def initialize(options = {})
+      @config_file = options.delete(:config_file)
+      @require_file = options.delete(:require_file)
+      super
+    end
+
+    def start
+      export_files
+    end
+
+    def stop
+      current_thread&.exit
+    end
+
+    def reload
+      export_files
+    end
+
+    def run_all
+      export_files
+    end
+
+    def run_on_additions(paths)
+      export_files(paths)
+    end
+
+    def run_on_modifications(paths)
+      export_files(paths)
+    end
+
+    def run_on_removals(paths)
+      export_files(paths)
+    end
+
+    def export_files(changes = nil)
+      return unless validate_file(:config_file, config_file)
+      return unless validate_file(:require_file, require_file)
+
+      current_thread&.exit
+
+      info("Changes detected: #{changes.join(', ')}") if changes
+
+      @current_thread = Thread.new do
+        capture do
+          system "i18n",
+                 "export",
+                 "--config",
+                 config_file.to_s,
+                 "--require",
+                 require_file.to_s,
+                 "--quiet"
+        end
+      end
+
+      current_thread.join
+    end
+
+    def capture
+      original = $stdout
+      $stdout = StringIO.new
+      yield
+    rescue StandardError
+      # noop
+    ensure
+      $stdout = original
+    end
+
+    def validate_file(key, file)
+      return true if file && File.file?(file)
+
+      error("#{key.inspect} must be a file")
+      false
+    end
+
+    def error(message)
+      ::Guard::UI.error "[i18n-js] #{message}"
+    end
+
+    def info(message)
+      ::Guard::UI.info "[i18n-js] #{message}"
+    end
+  end
+end

data/lib/i18n-js/cli/check_command.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require "benchmark"
+
+module I18nJS
+  class CLI
+    class CheckCommand < Command
+      command_name "check"
+      description "Check for missing translations"
+
+      parse do |opts|
+        opts.banner = "Usage: i18n #{name} [options]"
+
+        opts.on(
+          "-cCONFIG_FILE",
+          "--config=CONFIG_FILE",
+          "The configuration file that will be used"
+        ) do |config_file|
+          options[:config_file] = config_file
+        end
+
+        opts.on(
+          "-rREQUIRE_FILE",
+          "--require=REQUIRE_FILE",
+          "A Ruby file that must be loaded"
+        ) do |require_file|
+          options[:require_file] = require_file
+        end
+
+        opts.on(
+          "--[no-]color",
+          "Force colored output"
+        ) do |colored|
+          options[:colored] = colored
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          ui.exit_with opts.to_s
+        end
+      end
+
+      command do
+        set_defaults!
+        ui.colored = options[:colored]
+
+        unless options[:config_file]
+          ui.fail_with("=> ERROR: you need to specify the config file")
+        end
+
+        ui.stdout_print("=> Config file:", options[:config_file].inspect)
+        config_file = File.expand_path(options[:config_file])
+
+        if options[:require_file]
+          ui.stdout_print("=> Require file:", options[:require_file].inspect)
+          require_file = File.expand_path(options[:require_file])
+        end
+
+        unless File.file?(config_file)
+          ui.fail_with(
+            "=> ERROR: config file doesn't exist at",
+            config_file.inspect
+          )
+        end
+
+        if require_file && !File.file?(require_file)
+          ui.fail_with(
+            "=> ERROR: require file doesn't exist at",
+            require_file.inspect
+          )
+        end
+
+        config = Glob::SymbolizeKeys.call(YAML.load_file(config_file))
+        Schema.validate!(config)
+
+        load_require_file!(require_file) if require_file
+
+        default_locale = I18n.default_locale
+        available_locales = I18n.available_locales
+        ignored_keys = config.dig(:check, :ignore) || []
+
+        mapping = available_locales.each_with_object({}) do |locale, buffer|
+          buffer[locale] =
+            Glob::Map.call(Glob.filter(I18nJS.translations, ["#{locale}.*"]))
+                     .map {|key| key.gsub(/^.*?\./, "") }
+        end
+
+        default_locale_keys = mapping.delete(default_locale)
+
+        if ignored_keys.any?
+          ui.stdout_print "=> Check #{options[:config_file].inspect} for " \
+                          "ignored keys."
+        end
+
+        ui.stdout_print "=> #{default_locale}: #{default_locale_keys.size} " \
+                        "translations"
+
+        total_missing_count = 0
+
+        mapping.each do |locale, partial_keys|
+          ignored_count = 0
+
+          # Compute list of filtered keys (i.e. keys not ignored)
+          filtered_keys = partial_keys.reject do |key|
+            key = "#{locale}.#{key}"
+
+            ignored = ignored_keys.include?(key)
+            ignored_count += 1 if ignored
+            ignored
+          end
+
+          extraneous = (partial_keys - default_locale_keys).reject do |key|
+            key = "#{locale}.#{key}"
+            ignored = ignored_keys.include?(key)
+            ignored_count += 1 if ignored
+            ignored
+          end
+
+          missing = (default_locale_keys - (filtered_keys - extraneous))
+                    .reject {|key| ignored_keys.include?("#{locale}.#{key}") }
+
+          ignored_count += extraneous.size
+          total_missing_count += missing.size
+
+          ui.stdout_print "=> #{locale}: #{missing.size} missing, " \
+                          "#{extraneous.size} extraneous, " \
+                          "#{ignored_count} ignored"
+
+          all_keys = (default_locale_keys + extraneous + missing).uniq.sort
+
+          all_keys.each do |key|
+            next if ignored_keys.include?("#{locale}.#{key}")
+
+            label = if extraneous.include?(key)
+                      ui.yellow("extraneous")
+                    elsif missing.include?(key)
+                      ui.red("missing")
+                    else
+                      next
+                    end
+
+            ui.stdout_print("   - #{locale}.#{key} (#{label})")
+          end
+        end
+
+        exit(1) if total_missing_count.nonzero?
+      end
+
+      private def set_defaults!
+        config_file = "./config/i18n.yml"
+        require_file = "./config/environment.rb"
+
+        options[:config_file] ||= config_file if File.file?(config_file)
+        options[:require_file] ||= require_file if File.file?(require_file)
+      end
+    end
+  end
+end

data/lib/i18n-js/cli/command.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class Command
+      attr_reader :ui, :argv
+
+      def self.command_name(name)
+        define_method(:name) { name }
+      end
+
+      def self.description(description)
+        define_method(:description) { description }
+      end
+
+      def self.parse(&block)
+        define_method(:parse) do
+          OptionParser
+            .new {|opts| instance_exec(opts, &block) }
+            .parse!(argv)
+        end
+      end
+
+      def self.command(&block)
+        define_method(:command, &block)
+      end
+
+      def initialize(argv:, ui:)
+        @argv = argv.dup
+        @ui = ui
+      end
+
+      def call
+        parse
+        command
+      end
+
+      def options
+        @options ||= {}
+      end
+
+      private def load_require_file!(require_file)
+        require_without_warnings(require_file)
+      rescue Exception => error # rubocop:disable Lint/RescueException
+        ui.stderr_print("=> ERROR: couldn't load",
+                        options[:require_file].inspect)
+        ui.fail_with(
+          "\n#{error_description(error)}\n#{error.backtrace.join("\n")}"
+        )
+      end
+
+      private def error_description(error)
+        [
+          error.class.name,
+          error.message
+        ].reject(&:empty?).join(" => ")
+      end
+
+      private def require_without_warnings(path)
+        old_verbose = $VERBOSE
+        $VERBOSE = nil
+
+        load path
+      ensure
+        $VERBOSE = old_verbose
+      end
+    end
+  end
+end

data/lib/i18n-js/cli/export_command.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "benchmark"
+
+module I18nJS
+  class CLI
+    class ExportCommand < Command
+      command_name "export"
+      description "Export translations as JSON files"
+
+      parse do |opts|
+        opts.banner = "Usage: i18n #{name} [options]"
+
+        opts.on(
+          "-cCONFIG_FILE",
+          "--config=CONFIG_FILE",
+          "The configuration file that will be used"
+        ) do |config_file|
+          options[:config_file] = config_file
+        end
+
+        opts.on(
+          "-rREQUIRE_FILE",
+          "--require=REQUIRE_FILE",
+          "A Ruby file that must be loaded"
+        ) do |require_file|
+          options[:require_file] = require_file
+        end
+
+        opts.on(
+          "-q",
+          "--quiet",
+          "A Ruby file that must be loaded"
+        ) do |quiet|
+          options[:quiet] = quiet
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          ui.exit_with opts.to_s
+        end
+      end
+
+      command do
+        set_defaults!
+
+        unless options[:config_file]
+          ui.fail_with("=> ERROR: you need to specify the config file")
+        end
+
+        log("=> Config file:", options[:config_file].inspect)
+        config_file = File.expand_path(options[:config_file])
+
+        if options[:require_file]
+          log("=> Require file:", options[:require_file].inspect)
+          require_file = File.expand_path(options[:require_file])
+        end
+
+        unless File.file?(config_file)
+          ui.fail_with(
+            "=> ERROR: config file doesn't exist at",
+            config_file.inspect
+          )
+        end
+
+        if require_file && !File.file?(require_file)
+          ui.fail_with(
+            "=> ERROR: require file doesn't exist at",
+            require_file.inspect
+          )
+        end
+
+        time = Benchmark.realtime do
+          load_require_file!(require_file) if require_file
+          I18nJS.call(config_file: config_file)
+        end
+
+        log("=> Done in #{time.round(2)}s")
+      end
+
+      private def log(*args)
+        return if options[:quiet]
+
+        ui.stdout_print(*args)
+      end
+
+      private def set_defaults!
+        config_file = "./config/i18n.yml"
+        require_file = "./config/environment.rb"
+
+        options[:config_file] ||= config_file if File.file?(config_file)
+        options[:require_file] ||= require_file if File.file?(require_file)
+      end
+    end
+  end
+end

data/lib/i18n-js/cli/init_command.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class InitCommand < Command
+      command_name "init"
+      description "Initialize a project"
+
+      parse do |opts|
+        opts.banner = "Usage: i18n #{name} [options]"
+
+        opts.on(
+          "-cCONFIG_FILE",
+          "--config=CONFIG_FILE",
+          "The configuration file that will be generated"
+        ) do |config_file|
+          options[:config_file] = config_file
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          ui.exit_with opts.to_s
+        end
+      end
+
+      command do
+        file_path = File.expand_path(
+          options.fetch(:config_file, "config/i18n.yml")
+        )
+
+        if File.file?(file_path)
+          ui.fail_with("ERROR: #{file_path} already exists!")
+        end
+
+        FileUtils.mkdir_p(File.dirname(file_path))
+
+        File.open(file_path, "w") do |file|
+          file << <<~YAML
+            ---
+            translations:
+              - file: app/javascript/locales.json
+                patterns:
+                  - "*"
+                  - "!*.activerecord"
+                  - "!*.errors"
+                  - "!*.number.nth"
+
+          YAML
+        end
+      end
+    end
+  end
+end

data/lib/i18n-js/cli/ui.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class UI
+      attr_reader :stdout, :stderr
+      attr_accessor :colored
+
+      def initialize(stdout:, stderr:, colored: nil)
+        @stdout = stdout
+        @stderr = stderr
+        @colored = colored
+      end
+
+      def stdout_print(*message)
+        stdout << "#{message.join(' ')}\n"
+      end
+
+      def stderr_print(*message)
+        stderr << "#{message.join(' ')}\n"
+      end
+
+      def fail_with(*message)
+        stderr_print(message)
+        exit(1)
+      end
+
+      def exit_with(*message)
+        stdout_print(message)
+        exit(0)
+      end
+
+      def yellow(text)
+        ansi(text, 33)
+      end
+
+      def red(text)
+        ansi(text, 31)
+      end
+
+      def colored?
+        colored_output = if colored.nil?
+                           stdout.tty?
+                         else
+                           colored
+                         end
+
+        colored_output && !no_color?
+      end
+
+      def ansi(text, code)
+        if colored?
+          "\e[#{code}m#{text}\e[0m"
+        else
+          text
+        end
+      end
+
+      def no_color?
+        !ENV["NO_COLOR"].nil? && ENV["NO_COLOR"] == "1"
+      end
+    end
+  end
+end