wca_i18n 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2036008d8b47f5d3f4fcaa760a5e38d905c96465
-  data.tar.gz: 30d0d6ba8fe65285220d8cd1ee45779faf499c26
+SHA256:
+  metadata.gz: 9554abfdee1791abd95ba8b9b598bfffd143c9cd55e16829118e4e4ab84777d2
+  data.tar.gz: bcab8fe2d2baf5ef5432abfdd0c1155e4d9666ad293c73fdbbef5818f2dd0753
 SHA512:
-  metadata.gz: 9d405e390f910117f4bd7f64919a781e97a110ba00befd789494cfdde132a190490c6a99f38d654457343d0e2784be6560cb79ea9e8a6f48f684da3c696b6ffa
-  data.tar.gz: 3add718c5ffc764fa9e96d8e97f4af6e83384323afffcee862ea0476380ca4dc2df25191a7d2118d9f3d2318cff63ab63903fe00d7e6b27f5b6a33cbb766b44f
+  metadata.gz: 6e7f180bd18fab47d8c437281cec14895b49c02c8cea40fd88157c82a1ddc44b1868fc35399e2b576745fb80ac2753ca57e602a46a88049ff51cf108e52e0369
+  data.tar.gz: fa57f2ac88ea7da0a00d33573ba0d26d6be9226f3174f2e31ccfe31b7bf40f6bc212b782f709bb4cb45c7a1655a72cfc34bc58982e84b2691a39a390eeaacaca

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/bundle/
 
 # rspec failure tracking
 .rspec_status

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4.3
-before_install: gem install bundler -v 1.16.0
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1
+deploy:
+  provider: rubygems
+  api_key:
+    secure: LOAbx7/3XEoTqOS91rFP6U9CA8wAYThY8eAuZxQh0VVAi6EushRNQQJ21EFtatRB86/VNZ2fLQe3fDYQltKDrGjEcf/jT3j0PAMUbvhFIS8OlOFPUdK/TPfssPcrDzU8u7YJ3WZ4X+mAimCOokXoJ8ueqeNuhpCV3rXdxaVcxn0C0r4dzfzsPWihle3wopBak13hnZ2baiHGt8INWVO+kcukeW0ldscwt1A8XiCggBWpFHtsRHU+ki1UWNXIw5NKy4/hLVuDyy9FRi4ofOXvdW0R8Pybg5Aqvx9rs91Xkv6sQt1dPYy5QAblF2KidHfDXPk7uuJKYEO04MMLxKsqO39CpckxoYyS8qmDn9On6s/flVElye95+4ZgjYsiSrx4U1OnP0rgFMCbh9jh29w5e7T4MwaKkEqbK2KZGD0z9unbm5+Klk4+jI5BdgFNw8sw4W/1T1xaNO8FWWlq6OKk+U2MIsVXZqWy1mIEO14+eEODauFrFYh+BzigjG66oMnLt0G6D6xDJWSGKgPhbS8BvGWmTeNT5gDLizG+cHhV4RxsPCq3+NPXhNtTFXHXZHb7XWMTgIUd3r5aBSmkY6yfmWjUqgWtJYAdzjkL3hHMx14iatMz5tN3ApWu3It8o9wOFTfwU4lkqQO8h20wtPmZOmAPic4Id9z3CRPkU3GKsao=
+  on:
+    tags: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    wca_i18n (0.4.2)
+    wca_i18n (0.4.3)
       colorize (~> 0.8)
 
 GEM
@@ -36,4 +36,4 @@ DEPENDENCIES
   wca_i18n!
 
 BUNDLED WITH
-   1.16.0
+   1.16.1

data/README.md

@@ -1,4 +1,4 @@
-# WcaI18n [![Build Status](https://travis-ci.org/thewca/wca-i18n.svg?branch=master)](https://travis-ci.org/thewca/wca-i18n)
+# WcaI18n [![Build Status](https://travis-ci.org/thewca/wca_i18n.svg?branch=master)](https://travis-ci.org/thewca/wca_i18n)
 
 Use this Gem to diff Rails translations.
 
@@ -34,18 +34,28 @@ $ wca_i18n en.yml *.yml
 There are two parts to this library: `WcaI18n::YAMLWithComments` (a YAML parser
 that preserves comments) and `WcaI18n::Translation` (used to load and diff
 translation YAML files). Until we have better documentation, it's best to look
-at our [specs](https://github.com/thewca/wca-i18n/tree/master/spec) for how to
+at our [specs](https://github.com/thewca/wca_i18n/tree/master/spec) for how to
 them.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` 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
+`bin/rspec` 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`.
+
+## Releasing
+
+To release a new version, update the version number in `version.rb`, run
+`bundle`, commit your changes, and then run `gem_push=no rake release`, which
+will create a git tag for the version and push git commits and tags. After
+this, Travis should run against the newly created tag, and push the `.gem` file
+to [rubygems.org](https://rubygems.org/gems/wca_i18n).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/thewca/wca-i18n.
+Bug reports and pull requests are welcome on GitHub at https://github.com/thewca/wca_i18n.
 
 ## License
 

data/lib/wca_i18n/translation.rb

@@ -1,18 +1,15 @@
 require "json"
 require "digest"
-require "wca_i18n/yaml_with_comments"
+require "wca_i18n/yaml_to_enriched_ruby_hash"
 
 module WcaI18n
-  TranslatedLeaf = Struct.new(:translated, :original_hash)
-
   class Translation
-    PLURALIZATION_KEYS = %w(zero one two few many other).freeze
 
     attr_accessor :locale, :data
 
     def initialize(locale, file_content)
       self.locale = locale.to_s
-      self.data = commented_yaml_to_translated_yaml(YAMLWithComments.parse(file_content))
+      self.data = YAMLToEnrichedRubyHash.parse(file_content)
     end
 
     def compare_to(base)
@@ -26,17 +23,6 @@ module WcaI18n
       original_str = Digest::SHA1.hexdigest(to_digest)[0..6]
     end
 
-    private def commented_yaml_to_translated_yaml(commented_value)
-      if leaf?(commented_value.value)
-        original_hash = extract_original_hash_from_comment(commented_value.comment)
-        return TranslatedLeaf.new(commented_value.strip_comments, original_hash)
-      end
-
-      commented_value.value.map do |key, value|
-        [key, commented_yaml_to_translated_yaml(value)]
-      end.to_h
-    end
-
     private def diff_recursive(base, translation, context)
       diff = { missing: [], unused: [], outdated: [] }
       base_leaf = base.is_a?(TranslatedLeaf)
@@ -91,11 +77,6 @@ module WcaI18n
       end
     end
 
-    private def leaf?(node)
-      # If the node is a pluralization it's also a leaf!
-      node.nil? || node.is_a?(String) || self.class.pluralization?(node)
-    end
-
     def self.pluralization?(node)
       node.is_a?(Hash) && (node.keys & PLURALIZATION_KEYS).any?
     end

data/lib/wca_i18n/version.rb

@@ -1,3 +1,3 @@
 module WcaI18n
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/lib/wca_i18n/yaml_to_enriched_ruby_hash.rb

@@ -0,0 +1,96 @@
+require "psych"
+
+module WcaI18n
+  PLURALIZATION_KEYS = %w(zero one two few many other).freeze
+  ORIGINAL_HASH_TAG = "#original_hash: ".freeze
+  TranslatedLeaf = Struct.new(:translated, :original_hash)
+
+  # Re-implement some parts of the ToRuby emitter to inject our TranslatedLeaf where needs be
+  class YAMLToEnrichedRubyHash < Psych::Visitors::ToRuby
+    def self.create(original_hashes_map)
+      class_loader = Psych::ClassLoader.new
+      scanner      = Psych::ScalarScanner.new class_loader
+      new(scanner, class_loader, original_hashes_map)
+    end
+
+    def self.parse(text)
+      tree = Psych.parser.parse(text)
+      emitter = self.create(text)
+      # Not sure why, but "accept" returns an array with one element.
+      # Probably because the root of the YAML is a sequence by default?
+      emitter.accept(tree.handler.root).first
+    end
+
+    def initialize(*args, text)
+      super(*args)
+      _build_original_hashes_by_line_from_text(text)
+    end
+
+    def pluralization_map?(v)
+      return false unless v.is_a?(Psych::Nodes::Mapping)
+      v.children.each_slice(2) do |k,v|
+        return true if WcaI18n::PLURALIZATION_KEYS.include?(accept(k))
+      end
+      return false
+    end
+
+    # Copy from the revive_hash method in https://github.com/ruby/psych/blob/e9e4567adefc52e6511df7060851bce9fe408082/lib/psych/visitors/to_ruby.rb
+    # Except we override the generic case with our code.
+    def revive_hash hash, o
+      o.children.each_slice(2) { |k,v|
+        key = accept(k)
+        val = accept(v)
+
+        if key == SHOVEL && k.tag != "tag:yaml.org,2002:str"
+          case v
+          when Nodes::Alias, Nodes::Mapping
+            begin
+              hash.merge! val
+            rescue TypeError
+              hash[key] = val
+            end
+          when Nodes::Sequence
+            begin
+              h = {}
+              val.reverse_each do |value|
+                h.merge! value
+              end
+              hash.merge! h
+            rescue TypeError
+              hash[key] = val
+            end
+          else
+            hash[key] = val
+          end
+        else
+          # This is where we handle the translated key
+          if v.is_a?(Psych::Nodes::Scalar) && !WcaI18n::PLURALIZATION_KEYS.include?(key)
+            # For scalar value, the start line registered is the correct line
+            # We assume that the '#original_hash: ' comment comes on the line before.
+            original_hash = @original_hashes_by_line.delete(v.start_line - 1)
+            val = WcaI18n::TranslatedLeaf.new(val, original_hash)
+          end
+          if pluralization_map?(v)
+            # For mappings, the start line registered is the line of the first key/value!
+            original_hash = @original_hashes_by_line.delete(v.start_line - 2)
+            val = WcaI18n::TranslatedLeaf.new(val, original_hash)
+          end
+          hash[key] = val
+        end
+      }
+      hash
+    end
+
+    def _build_original_hashes_by_line_from_text(text)
+      @original_hashes_by_line = {}.tap do |hash|
+        # Build a hash mapping a line number to its comment
+        text.each_line.with_index do |line, index|
+          stripped_line = line.strip
+          if stripped_line.start_with?(ORIGINAL_HASH_TAG)
+            hash[index] = stripped_line[ORIGINAL_HASH_TAG.length..-1]
+          end
+        end
+      end
+    end
+  end
+end

data/wca_i18n.gemspec

@@ -6,7 +6,7 @@ require "wca_i18n/version"
 Gem::Specification.new do |spec|
   spec.name          = "wca_i18n"
   spec.version       = WcaI18n::VERSION
-  spec.authors       = ["Jeremy Fleischman"]
+  spec.authors       = ["WCA Software Team"]
   spec.email         = ["software@worldcubeassociation.org"]
 
   spec.summary       = %q{Track how up to date Rails translations are.}
@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "byebug", "~> 9.0"
   spec.add_runtime_dependency "colorize", "~> 0.8"
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wca_i18n
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
-- Jeremy Fleischman
+- WCA Software Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2018-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,7 +104,7 @@ files:
 - lib/wca_i18n.rb
 - lib/wca_i18n/translation.rb
 - lib/wca_i18n/version.rb
-- lib/wca_i18n/yaml_with_comments.rb
+- lib/wca_i18n/yaml_to_enriched_ruby_hash.rb
 - wca_i18n.gemspec
 homepage: https://github.com/thewca/wca_i18n
 licenses:
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Track how up to date Rails translations are.

data/lib/wca_i18n/yaml_with_comments.rb

@@ -1,68 +0,0 @@
-require "yaml"
-
-module WcaI18n
-  class YAMLWithComments < Struct.new(:comment, :value)
-    def self.parse(text)
-      _decorate_with_comments(YAML.safe_load(text), [], text)[1]
-    end
-
-    def strip_comments
-      stripped_value = self.value
-
-      if stripped_value.kind_of?(Hash)
-        stripped_value = stripped_value.map do |key, value|
-          [key, value.strip_comments]
-        end.to_h
-      end
-
-      stripped_value
-    end
-
-    def self._decorate_with_comments(node, context, text)
-      if node.kind_of?(Hash)
-        node = node.map do |key, value|
-          text, decorated = _decorate_with_comments(value, [*context, key], text)
-          [key, decorated]
-        end.to_h
-      end
-
-      trimmed_text, comment = _extract_comment(text, context)
-      [trimmed_text, YAMLWithComments.new(comment, node)]
-    end
-
-    def self._extract_comment(text, context)
-      return ["", ""] if context.empty?
-
-      # Match any character, including newline.
-      some_chars = /[\s\S]*?/
-
-      comment_lines_group = /((?:^\s*#.*\n)*)/
-
-      match_parent = ""
-      context[0...-1].each do |key|
-        match_parent = "#{match_parent}#{some_chars}#{build_key_matcher(key)}"
-      end
-      regexp = /(#{match_parent}#{some_chars})#{comment_lines_group}\s*#{build_key_matcher(context[-1])}/
-
-      comment = nil
-      text = text.sub(regexp) do
-        # Group 1 is everything before the comment and the key.
-        before = $1
-        # Group 2 contains the comments matched before the key.
-        comments = $2
-        comment = comments.split('#').map(&:strip).reject(&:empty?).join("\n")
-
-        # We return the beginning without the key, so that the current hash + key
-        # are removed from the text, but the parents and the value stay in.
-        before
-      end
-      throw "Could not find key: #{context} in given yaml text" unless comment
-
-      [text, comment]
-    end
-
-    def self.build_key_matcher(key)
-      /['\"]?#{key}['\"]?:/
-    end
-  end
-end