i18n-js 3.7.1 → 4.0.0.alpha1

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

@@ -0,0 +1,50 @@
+# 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[:config_file])
+
+        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,30 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class UI
+      def initialize(stdout:, stderr:)
+        @stdout = stdout
+        @stderr = stderr
+      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
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class CLI
+    class VersionCommand < Command
+      command_name "version"
+      description "Show package version"
+
+      parse do |opts|
+        opts.banner = "Usage: i18n #{name}"
+
+        opts.on_tail do
+          ui.exit_with("v#{I18nJS::VERSION}")
+        end
+      end
+    end
+  end
+end

data/lib/i18n-js/listen.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+gem "listen"
+require "listen"
+require "i18n-js"
+
+module I18nJS
+  class << self
+    attr_accessor :started
+  end
+
+  def self.listen(
+    config_file: Rails.root.join("config/i18n.yml"),
+    locales_dir: Rails.root.join("config/locales")
+  )
+    return unless Rails.env.development?
+    return if started
+
+    self.started = true
+
+    relative_paths =
+      [config_file, locales_dir].map {|path| relative_path(path) }
+
+    debug("Watching #{relative_paths.inspect}")
+
+    listener(config_file, locales_dir.to_s).start
+    I18nJS.call(config_file: config_file)
+  end
+
+  def self.relative_path(path)
+    Pathname.new(path).relative_path_from(Rails.root).to_s
+  end
+
+  def self.relative_path_list(paths)
+    paths.map {|path| relative_path(path) }
+  end
+
+  def self.debug(message)
+    logger.tagged("i18n-js") { logger.debug(message) }
+  end
+
+  def self.logger
+    @logger ||= ActiveSupport::TaggedLogging.new(Rails.logger)
+  end
+
+  def self.listener(config_file, locales_dir) # rubocop:disable Metrics/MethodLength
+    paths = [File.dirname(config_file), locales_dir]
+
+    Listen.to(*paths) do |changed, added, removed|
+      changes = compute_changes(
+        [config_file, locales_dir],
+        changed,
+        added,
+        removed
+      )
+
+      next unless changes.any?
+
+      debug(changes.map {|key, value| "#{key}=#{value.inspect}" }.join(", "))
+
+      I18nJS.call(config_file: config_file)
+    end
+  end
+
+  def self.compute_changes(paths, changed, added, removed)
+    paths = paths.map {|path| relative_path(path) }
+
+    {
+      changed: included_on_watched_paths(paths, changed),
+      added: included_on_watched_paths(paths, added),
+      removed: included_on_watched_paths(paths, removed)
+    }.select {|_k, v| v.any? }
+  end
+
+  def self.included_on_watched_paths(paths, changes)
+    changes.map {|change| relative_path(change) }.select do |change|
+      paths.any? {|path| change.start_with?(path) }
+    end
+  end
+end

data/lib/i18n-js/schema.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module I18nJS
+  class Schema
+    InvalidError = Class.new(StandardError)
+
+    ROOT_KEYS = %i[translations].freeze
+    REQUIRED_ROOT_KEYS = %i[translations].freeze
+    REQUIRED_TRANSLATION_KEYS = %i[file patterns].freeze
+    TRANSLATION_KEYS = %i[file patterns].freeze
+
+    def self.validate!(target)
+      new(target).validate!
+    end
+
+    attr_reader :target
+
+    def initialize(target)
+      @target = target
+    end
+
+    def validate!
+      expect_type(:root, target, Hash, target)
+
+      expect_required_keys(REQUIRED_ROOT_KEYS, target)
+      reject_extraneous_keys(ROOT_KEYS, target)
+      validate_translations
+    end
+
+    def validate_translations
+      translations = target[:translations]
+
+      expect_type(:translations, translations, Array, target)
+      expect_array_with_items(:translations, translations)
+
+      translations.each do |translation|
+        validate_translation(translation)
+      end
+    end
+
+    def validate_translation(translation)
+      expect_required_keys(REQUIRED_TRANSLATION_KEYS, translation)
+      reject_extraneous_keys(TRANSLATION_KEYS, translation)
+      expect_type(:file, translation[:file], String, translation)
+      expect_type(:patterns, translation[:patterns], Array, translation)
+      expect_array_with_items(:patterns, translation[:patterns], translation)
+    end
+
+    def reject(error_message, node = nil)
+      node_json = "\n#{JSON.pretty_generate(node)}" if node
+      raise InvalidError, "#{error_message}#{node_json}"
+    end
+
+    def expect_type(attribute, value, expected_type, payload)
+      return if value.is_a?(expected_type)
+
+      actual_type = value.class
+
+      message = [
+        "Expected #{attribute.inspect} to be #{expected_type};",
+        "got #{actual_type} instead"
+      ].join(" ")
+
+      reject message, payload
+    end
+
+    def expect_array_with_items(attribute, value, payload = value)
+      return unless value.empty?
+
+      reject "Expected #{attribute.inspect} to have at least one item", payload
+    end
+
+    def expect_required_keys(required_keys, value)
+      keys = value.keys.map(&:to_sym)
+
+      required_keys.each do |key|
+        next if keys.include?(key)
+
+        reject "Expected #{key.inspect} to be defined", value
+      end
+    end
+
+    def reject_extraneous_keys(allowed_keys, value)
+      keys = value.keys.map(&:to_sym)
+      extraneous = keys - allowed_keys
+
+      return if extraneous.empty?
+
+      reject "Unexpected keys: #{extraneous.join(', ')}", value
+    end
+  end
+end

data/lib/i18n-js/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module I18nJS
+  VERSION = "4.0.0.alpha1"
+end

metadata

@@ -1,213 +1,204 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 4.0.0.alpha1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: glob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.6
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: gem-release
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-fnando
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
-description: It's a small library to provide the Rails I18n translations on the Javascript.
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Export i18n translations and use them on JavaScript.
 email:
-- fnando.vieira@gmail.com
-executables: []
+- me@fnando.com
+executables:
+- i18n
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
 - ".gitignore"
-- ".npmignore"
-- ".travis.yml"
-- Appraisals
+- ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
-- app/assets/javascripts/i18n.js
-- app/assets/javascripts/i18n/filtered.js.erb
-- app/assets/javascripts/i18n/shims.js
-- app/assets/javascripts/i18n/translations.js
-- gemfiles/i18n_0_6.gemfile
-- gemfiles/i18n_0_7.gemfile
-- gemfiles/i18n_0_8.gemfile
-- gemfiles/i18n_0_9.gemfile
-- gemfiles/i18n_1_0.gemfile
-- gemfiles/i18n_1_1.gemfile
-- gemfiles/i18n_1_2.gemfile
-- gemfiles/i18n_1_3.gemfile
-- gemfiles/i18n_1_4.gemfile
-- gemfiles/i18n_1_5.gemfile
-- gemfiles/i18n_1_6.gemfile
-- gemfiles/i18n_1_7.gemfile
-- gemfiles/i18n_1_8.gemfile
+- exe/i18n
 - i18n-js.gemspec
+- lib/guard/i18n-js.rb
+- lib/guard/i18n-js/templates/Guardfile
+- lib/guard/i18n-js/version.rb
 - lib/i18n-js.rb
-- lib/i18n/js.rb
-- lib/i18n/js/dependencies.rb
-- lib/i18n/js/engine.rb
-- lib/i18n/js/fallback_locales.rb
-- lib/i18n/js/formatters/base.rb
-- lib/i18n/js/formatters/js.rb
-- lib/i18n/js/formatters/json.rb
-- lib/i18n/js/middleware.rb
-- lib/i18n/js/private/hash_with_symbol_keys.rb
-- lib/i18n/js/segment.rb
-- lib/i18n/js/utils.rb
-- lib/i18n/js/version.rb
-- lib/rails/generators/i18n/js/config/config_generator.rb
-- lib/rails/generators/i18n/js/config/templates/i18n-js.yml
-- lib/tasks/export.rake
-- package.json
-- spec/fixtures/custom_path.yml
-- spec/fixtures/default.yml
-- spec/fixtures/erb.yml
-- spec/fixtures/except_condition.yml
-- spec/fixtures/js_export_dir_custom.yml
-- spec/fixtures/js_export_dir_none.yml
-- spec/fixtures/js_extend_parent.yml
-- spec/fixtures/js_extend_segment.yml
-- spec/fixtures/js_file_per_locale.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_hash.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_locale.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml
-- spec/fixtures/js_file_per_locale_without_fallbacks.yml
-- spec/fixtures/js_file_with_namespace_prefix_and_pretty_print.yml
-- spec/fixtures/js_sort_translation_keys_false.yml
-- spec/fixtures/js_sort_translation_keys_true.yml
-- spec/fixtures/json_only.yml
-- spec/fixtures/locales.yml
-- spec/fixtures/merge_plurals.yml
-- spec/fixtures/merge_plurals_with_no_overrides.yml
-- spec/fixtures/merge_plurals_with_partial_overrides.yml
-- spec/fixtures/millions.yml
-- spec/fixtures/multiple_conditions.yml
-- spec/fixtures/multiple_conditions_per_locale.yml
-- spec/fixtures/multiple_files.yml
-- spec/fixtures/no_config.yml
-- spec/fixtures/no_scope.yml
-- spec/fixtures/simple_scope.yml
-- spec/js/currency.spec.js
-- spec/js/current_locale.spec.js
-- spec/js/dates.spec.js
-- spec/js/defaults.spec.js
-- spec/js/extend.spec.js
-- spec/js/interpolation.spec.js
-- spec/js/jasmine/MIT.LICENSE
-- spec/js/jasmine/jasmine-html.js
-- spec/js/jasmine/jasmine.css
-- spec/js/jasmine/jasmine.js
-- spec/js/jasmine/jasmine_favicon.png
-- spec/js/locales.spec.js
-- spec/js/localization.spec.js
-- spec/js/numbers.spec.js
-- spec/js/placeholder.spec.js
-- spec/js/pluralization.spec.js
-- spec/js/prepare_options.spec.js
-- spec/js/require.js
-- spec/js/specs.html
-- spec/js/specs_requirejs.html
-- spec/js/translate.spec.js
-- spec/js/translations.js
-- spec/js/utility_functions.spec.js
-- spec/ruby/i18n/js/fallback_locales_spec.rb
-- spec/ruby/i18n/js/segment_spec.rb
-- spec/ruby/i18n/js/utils_spec.rb
-- spec/ruby/i18n/js_spec.rb
-- spec/spec_helper.rb
-- yarn.lock
-homepage: http://rubygems.org/gems/i18n-js
+- lib/i18n-js/cli.rb
+- lib/i18n-js/cli/command.rb
+- lib/i18n-js/cli/export_command.rb
+- lib/i18n-js/cli/init_command.rb
+- lib/i18n-js/cli/ui.rb
+- lib/i18n-js/cli/version_command.rb
+- lib/i18n-js/listen.rb
+- lib/i18n-js/schema.rb
+- lib/i18n-js/version.rb
+homepage: https://github.com/fnando/i18n-js
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/fnando/i18n-js
+  bug_tracker_uri: https://github.com/fnando/i18n-js/issues
+  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha1
+  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha1/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha1/README.md
+  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha1/LICENSE.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -216,73 +207,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
-summary: It's a small library to provide the Rails I18n translations on the Javascript.
-test_files:
-- spec/fixtures/custom_path.yml
-- spec/fixtures/default.yml
-- spec/fixtures/erb.yml
-- spec/fixtures/except_condition.yml
-- spec/fixtures/js_export_dir_custom.yml
-- spec/fixtures/js_export_dir_none.yml
-- spec/fixtures/js_extend_parent.yml
-- spec/fixtures/js_extend_segment.yml
-- spec/fixtures/js_file_per_locale.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_hash.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_locale.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml
-- spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml
-- spec/fixtures/js_file_per_locale_without_fallbacks.yml
-- spec/fixtures/js_file_with_namespace_prefix_and_pretty_print.yml
-- spec/fixtures/js_sort_translation_keys_false.yml
-- spec/fixtures/js_sort_translation_keys_true.yml
-- spec/fixtures/json_only.yml
-- spec/fixtures/locales.yml
-- spec/fixtures/merge_plurals.yml
-- spec/fixtures/merge_plurals_with_no_overrides.yml
-- spec/fixtures/merge_plurals_with_partial_overrides.yml
-- spec/fixtures/millions.yml
-- spec/fixtures/multiple_conditions.yml
-- spec/fixtures/multiple_conditions_per_locale.yml
-- spec/fixtures/multiple_files.yml
-- spec/fixtures/no_config.yml
-- spec/fixtures/no_scope.yml
-- spec/fixtures/simple_scope.yml
-- spec/js/currency.spec.js
-- spec/js/current_locale.spec.js
-- spec/js/dates.spec.js
-- spec/js/defaults.spec.js
-- spec/js/extend.spec.js
-- spec/js/interpolation.spec.js
-- spec/js/jasmine/MIT.LICENSE
-- spec/js/jasmine/jasmine-html.js
-- spec/js/jasmine/jasmine.css
-- spec/js/jasmine/jasmine.js
-- spec/js/jasmine/jasmine_favicon.png
-- spec/js/locales.spec.js
-- spec/js/localization.spec.js
-- spec/js/numbers.spec.js
-- spec/js/placeholder.spec.js
-- spec/js/pluralization.spec.js
-- spec/js/prepare_options.spec.js
-- spec/js/require.js
-- spec/js/specs.html
-- spec/js/specs_requirejs.html
-- spec/js/translate.spec.js
-- spec/js/translations.js
-- spec/js/utility_functions.spec.js
-- spec/ruby/i18n/js/fallback_locales_spec.rb
-- spec/ruby/i18n/js/segment_spec.rb
-- spec/ruby/i18n/js/utils_spec.rb
-- spec/ruby/i18n/js_spec.rb
-- spec/spec_helper.rb
+summary: Export i18n translations and use them on JavaScript.
+test_files: []