i18n-json 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d34f8bbee444530bf71f4d3b7760e1d08de77a44b41896cf58385c8aa03a688d
-  data.tar.gz: 3017e38551fa0c1978b8374589c365561dcea14107f7f6adb6c82179cba3bbae
+  metadata.gz: b81e3b3409e00ed7ddcc14ca89fb4a3d156e994fc3726e0b7497b830b79d7283
+  data.tar.gz: d70e1fde67b202d8615f7664f24badd060b15be60193202813ef9234ab6655d2
 SHA512:
-  metadata.gz: ea8b93e7caf242b46a4486ae53d81b5cd9534329f6a998e17bce88570a5935dbcfb343f47ff669891b6655d9bb010939bd3bad9157a1a75290c63a2628b3dab0
-  data.tar.gz: e719b49e2ac49c152fc07e8aa4f73c0194d665688b6be12b832399b331ef1d1822f3debf3bec4b005e0e4f975cb8cc53c31eb8570f9781175e8328b4947f63dd
+  metadata.gz: 38b833a5607098230ebb72afcfd26350d3fca1eaf48efa3b011a1266b32f461344c93cefea6de1a7f30973366de61992f4adb7091b3f9d792108d2cc8b74acd5
+  data.tar.gz: 4ea046aa5a7611a68698f863fa140223ed0853b02b4d3c6324980b2b50e8bdfc3a0d528cb7f0c200054332ddd83775ddebe5bfcb8fe1898d94ef72df13ba9745

data/.github/FUNDING.yml

@@ -1,2 +1,3 @@
 ---
+github: [fnando]
 custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.github/workflows/tests.yml

@@ -1,47 +1,63 @@
 ---
 name: tests
 
-on: [push]
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+  schedule:
+    - cron: "0 10 * * *"
+
+  workflow_dispatch:
+    inputs: {}
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.0.x, 2.7.x, 2.6.x]
+        gemfile:
+          - Gemfile
 
     steps:
-      - name: Clone repo
-        uses: actions/checkout@v1
+      - uses: actions/checkout@v2.3.4
 
-      - name: Ruby cache
-        uses: actions/cache@v1
-        id: cache
-        with:
-          path: ~/local/rubies
-          key: ruby-2.6.5
-
-      - name: Rubygems cache
-        uses: actions/cache@v1
+      - uses: actions/cache@v2
         with:
           path: vendor/bundle
-          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: ${{ runner.os }}-gem-
-
-      - name: Install ruby
-        uses: clupprich/ruby-build-action@master
-        id: ruby
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+          restore-keys: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
         with:
-          ruby-version: 2.6.5
-          cache-available: ${{ steps.cache.outputs.cache-hit == 'true' }}
+          ruby-version: ${{ matrix.ruby }}
 
-      - name: Bundle install
+      - name: Install dependencies
+        run: |
+          sudo apt-get install -y libevent-dev libseccomp-dev git libsasl2-dev
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
         run: |
           gem install bundler
           bundle config path vendor/bundle
-          bundle install --jobs 4 --retry 3
+          bundle update --jobs 4 --retry 3
 
-      - name: Run ruby tests
+      - name: Run Tests
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
         run: |
           bundle exec rake
-
-      - name: Run lint
-        run: |
-          bundle exec rubocop

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.lock

data/.rubocop.yml

@@ -4,6 +4,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Naming/FileName:
   Exclude:

data/README.md

@@ -46,12 +46,13 @@ translations:
       - "*"
 ```
 
-The code API:
+The Ruby API:
 
 ```ruby
 require "i18n-json"
 
-I18n::JSON.call(config_file: "config/i18n.yml")
+I18nJSON.call(config_file: "config/i18n.yml")
+I18nJSON.call(config: config)
 ```
 
 The CLI API:
@@ -61,20 +62,76 @@ $ i18n-json init --config config/i18n.yml
 $ i18n-json export --config config/i18n.yml --require config/boot.rb
 ```
 
+## Automatically export translations
+
+### Using guard
+
+You can also automatically export translations when file changes using
+[guard-i18n-json](https://github.com/fnando/guard-i18n-json).
+
+First, add the template to your `Guardfile` with the following command:
+
+```console
+$ bundle exec guard init i18n_json
+```
+
+Something like this will be added:
+
+```ruby
+guard(:i18n_json,
+      run_on_start: true,
+      config_file: "./config/i18n.yml",
+      require_file: "./config/boot.rb") do
+  watch(%r{^(app|config)/locales/.+\.(yml|po)$})
+  watch(%r{^config/i18n.yml$})
+  watch("Gemfile")
+end
+```
+
+Configure file paths accordingly.
+
+### Using listen
+
+Create a file under `config/initializers/i18n.rb` with the following content:
+
+```ruby
+# frozen_string_literal: true
+
+require "i18n-json/listen"
+
+I18nJSON.listen
+```
+
+The code above will watch for changes based on `config/i18n.yml` and
+`config/locales`. You can customize these options with
+`I18nJSON.listen(config_file: "config/i18n.yml", locales_dir: "config/locales")`.
+
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/i18n-json. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/fnando/i18n-json. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the I18n::Json project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/i18n-json/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the I18n::Json project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
+[code of conduct](https://github.com/fnando/i18n-json/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,6 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task default: :test
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/i18n-json.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = I18nJSON::VERSION
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["me@fnando.com"]
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   spec.summary       = "Export I18n translations to JSON."
   spec.description   = spec.summary

data/lib/guard/i18n_json.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+gem "guard"
+gem "guard-compat"
+require "guard/compat/plugin"
+
+require "i18n-json"
+require_relative "i18n_json/version"
+
+module Guard
+  class I18nJson < 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
+        require @require_file
+        ::I18nJSON.call(config_file: @config_file)
+      end
+
+      current_thread.join
+    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 "[guard-i18n-json] #{message}"
+    end
+
+    def info(message)
+      ::Guard::UI.info "[guard-i18n-json] #{message}"
+    end
+  end
+end

data/lib/guard/i18n_json/templates/Guardfile

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

data/lib/i18n-json.rb

@@ -16,8 +16,14 @@ require_relative "./i18n-json/schema"
 require_relative "./i18n-json/version"
 
 module I18nJSON
-  def self.call(config_file:)
-    config = Glob::SymbolizeKeys.call(YAML.load_file(config_file))
+  MissingConfigError = Class.new(StandardError)
+
+  def self.call(config_file: nil, config: nil)
+    if !config_file && !config
+      raise MissingConfigError, "you must set either `config_file` or `config`"
+    end
+
+    config = Glob::SymbolizeKeys.call(config || YAML.load_file(config_file))
     Schema.validate!(config)
 
     config[:translations].each do |group|
@@ -30,7 +36,7 @@ module I18nJSON
     output_file_path = File.expand_path(group[:file])
 
     if output_file_path.include?(":locale")
-      filtered_translations.keys.each do |locale|
+      filtered_translations.each_key do |locale|
         locale_file_path = output_file_path.gsub(/:locale/, locale.to_s)
         write_file(locale_file_path, locale => filtered_translations[locale])
       end

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

@@ -45,9 +45,18 @@ module I18nJSON
           ui.fail_with("ERROR: require file doesn't exist at #{require_file}")
         end
 
-        require require_file if require_file
+        require_without_warnings(require_file) if require_file
         I18nJSON.call(config_file: config_file)
       end
+
+      private def require_without_warnings(path)
+        old_verbose = $VERBOSE
+        $VERBOSE = nil
+
+        require path
+      ensure
+        $VERBOSE = old_verbose
+      end
     end
   end
 end

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

@@ -35,10 +35,12 @@ module I18nJSON
           file << <<~YAML
             ---
             translations:
-              - file: some/dir/locale.json
+              - file: app/javascript/locales.json
                 patterns:
                   - "*"
                   - "!*.activerecord"
+                  - "!*.errors"
+                  - "!*.number.nth"
 
           YAML
         end

data/lib/i18n-json/listen.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+gem "listen"
+require "listen"
+require "i18n-json"
+
+module I18nJSON
+  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
+    I18nJSON.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-json") { 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(", "))
+
+      I18nJSON.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-json/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nJSON
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-json
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glob
@@ -193,7 +193,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -201,12 +200,15 @@ files:
 - bin/setup
 - exe/i18n-json
 - i18n-json.gemspec
+- lib/guard/i18n_json.rb
+- lib/guard/i18n_json/templates/Guardfile
 - lib/i18n-json.rb
 - lib/i18n-json/cli.rb
 - lib/i18n-json/cli/command.rb
 - lib/i18n-json/cli/export_command.rb
 - lib/i18n-json/cli/init_command.rb
 - lib/i18n-json/cli/ui.rb
+- lib/i18n-json/listen.rb
 - lib/i18n-json/schema.rb
 - lib/i18n-json/version.rb
 homepage: https://github.com/fnando/i18n-json
@@ -215,7 +217,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/fnando/i18n-json
   source_code_uri: https://github.com/fnando/i18n-json
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -223,15 +225,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Export I18n translations to JSON.
 test_files: []

data/Gemfile.lock

@@ -1,90 +0,0 @@
-PATH
-  remote: .
-  specs:
-    i18n-json (0.0.1)
-      glob
-      i18n
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    ast (2.4.0)
-    awesome_print (1.8.0)
-    byebug (11.0.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    docile (1.3.2)
-    glob (0.2.0)
-    i18n (1.7.0)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    json (2.3.0)
-    method_source (0.9.2)
-    minitest (5.13.0)
-    minitest-utils (0.4.6)
-      minitest
-    parallel (1.19.1)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.7.0)
-      byebug (~> 11.0)
-      pry (~> 0.10)
-    pry-meta (0.0.10)
-      awesome_print
-      pry
-      pry-byebug
-      pry-remote
-    pry-remote (0.1.8)
-      pry (~> 0.9)
-      slop (~> 3.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    redis (4.1.3)
-    rubocop (0.77.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-fnando (0.0.3)
-    ruby-progressbar (1.10.1)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    slop (3.6.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.0)
-    zeitwerk (2.2.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activesupport
-  bundler
-  i18n-json!
-  minitest
-  minitest-utils
-  pry-meta
-  rake
-  redis
-  rubocop
-  rubocop-fnando
-  simplecov
-
-BUNDLED WITH
-   2.0.2