bisu 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2db1130663e6afdca1e4d1b22d34c5863db2f120cee81c1c802d69999b1c094b
-  data.tar.gz: 6f0cfd04fd34bb489055eaa0211aa74691f50f32c5fb13d8b7a1559c68a0f25a
+  metadata.gz: 14ce8b0b059747d79f5a63fc910129774a634d015bf02563ac888dc80c735ed0
+  data.tar.gz: 5158d8f04815351d0850c52d948a2dcebb5bb267a8154e716c31d01334fdd379
 SHA512:
-  metadata.gz: b2d8325f651a93ca9bc2edb7108af31ebc5d1e3d5e954c8a8890a1a7985d2afababe15166ca4d909984a0be453d6f6ad8965eb44b4e1588bd970bc0e3d9669af
-  data.tar.gz: 67699cebd837fc150ae54b433fb3386d79617211ff988b64bca73d681cd8daaeb6202c1e84280d1cfcf39a906c0930272c9f5f237f8d1eb187d856b0494570af
+  metadata.gz: 2773ab4e5ea6f8b0f419650e2cd4f551dacfb43d438e892a98bb9ca317774a82c61122ad232de1cd1ede184178ac502352bc356702144b70f73b7912a23adcba
+  data.tar.gz: 1bae10ebc6fb6a915d2c2122b4ceff3341b426eb47543b9e1502242e47804aa9599ef3c22f4abd62b915177d83d4a0b6a3cf08f8e7fa4aaa5ae505a8c3538429

data/.rspec

@@ -1,5 +1,4 @@
 --color
 --format documentation
 --profile
---drb
 --require spec_helper

data/.ruby-version

@@ -1 +1 @@
-2.5.0
+2.7.3

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 `Bisu` adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.9.0](https://github.com/hole19/bisu/releases/tag/v1.9.0)
+Released on 2021/05/21
+
+#### Added
+- Adds a new option to surpress missing params when that's intentional: add "//ignore-params" to the end of the translation key
+
 ## [1.8.0](https://github.com/hole19/bisu/releases/tag/v1.8.0)
 Released on 2020/04/30
 

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '2.5.0'
+ruby '2.7.3'
 
 gem 'safe_yaml',  '~> 1.0'
 gem 'colorize',   '~> 0.7'

data/Gemfile.lock

@@ -4,34 +4,35 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     colorize (0.8.1)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
     hashdiff (1.0.1)
-    public_suffix (4.0.3)
-    rake (13.0.1)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
+      rspec-support (~> 3.10.0)
     rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.9.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
     safe_yaml (1.0.5)
     webmock (1.24.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    xml-simple (1.1.5)
+    xml-simple (1.1.8)
 
 PLATFORMS
   ruby
@@ -46,7 +47,7 @@ DEPENDENCIES
   xml-simple (~> 1.1)
 
 RUBY VERSION
-   ruby 2.5.0p0
+   ruby 2.7.3p183
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -24,7 +24,7 @@ Usage
 1. Run: `bisu`
 1. That's it!*
 
-*given that someone already configured Bisu
+\*_given that someone already configured Bisu_
 
 Setup your configuration file
 -----

data/lib/bisu/localizer.rb

@@ -32,15 +32,15 @@ module Bisu
           unless t.gsub!(l[:match], localized)
             Logger.warn("Could not find translation for #{l[:match]} in #{language}")
           end
+
+          unless @type.eql?(:ror) || l[:ignore_param_warn] == true
+            localized.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} in #{language}") }
+          end
         else
           Logger.warn("Could not find translation for #{l[:match]} in #{language}")
         end
       end
 
-      unless @type.eql?(:ror)
-        t.scan(/%{[^}]+}/) { |match| Logger.error("Could not find translation param for #{match} in #{language}") }
-      end
-
       t
     end
 
@@ -57,7 +57,7 @@ module Bisu
     private
 
     def to_localize(text)
-      all_matches = text.to_enum(:scan, /\$([^\$\{]+)(?:\{(.+)\})?\$/).map { Regexp.last_match }
+      all_matches = text.to_enum(:scan, /\$([^\$\{\/]+)(?:\{(.+)\})?(\/\/ignore-params)?\$/).map { Regexp.last_match }
       all_matches.map do |match|
         params = if match[2]
           params = match[2].split(",").map(&:strip).map do |param|
@@ -67,9 +67,12 @@ module Bisu
           Hash[params]
         end
 
-        { match:  match[0],
+        {
+          match:  match[0],
           key:    match[1],
-          params: params || {} }
+          params: params || {},
+          ignore_param_warn: text.include?("//ignore-params")
+        }
       end
     end
 

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.8.0'
-  VERSION_UPDATED_AT = '2020-04-30'
+  VERSION = '1.9.0'
+  VERSION_UPDATED_AT = '2021-05-21'
 end

data/spec/lib/bisu/localizer_spec.rb

@@ -1,4 +1,9 @@
 describe Bisu::Localizer do
+  def translates(text, fallbacks: [], to:, lang: nil)
+    translation = localizer.localize(text, lang || language, locale, fallbacks)
+    expect(translation).to eq to
+  end
+
   let(:language) { "Portuguese" }
   let(:locale)   { "pt-PT" }
 
@@ -33,11 +38,6 @@ describe Bisu::Localizer do
   shared_examples_for "a localizer" do
     it { expect { localizer }.not_to raise_error }
 
-    def translates(text, fallbacks: [], to:, lang: nil)
-      translation = localizer.localize(text, lang || language, locale, fallbacks)
-      expect(translation).to eq to
-    end
-
     it { translates("a line with no key", to: "a line with no key") }
 
     it { translates("this special key: $specialKComment1$", to: "this special key: This file was automatically generated based on a translation template.") }
@@ -87,7 +87,7 @@ describe Bisu::Localizer do
        .and not_change { Bisu::Logger.summary[:error] }
     end
 
-    it "throws an error when missing key parameters (expect on ruby on rails)" do
+    it "throws a error when missing key parameters (expect on ruby on rails)" do
       if type == :ror
         expect {
           localizer.localize("$k1ParameterKey$", language, locale)
@@ -114,6 +114,17 @@ describe Bisu::Localizer do
       }.to not_change { Bisu::Logger.summary[:warn] }
        .and change { Bisu::Logger.summary[:error] }.by(1)
     end
+
+    # non localizable text with params
+
+    it "does not try to translate params outside $$" do
+      translates("%{some_text}", to: "%{some_text}")
+
+      expect {
+        localizer.localize("%{some_text}", language, locale)
+      }.to not_change { Bisu::Logger.summary[:warn] }
+       .and not_change { Bisu::Logger.summary[:error] }
+    end
   end
 
   let(:type_dependent_defaults) { {
@@ -134,6 +145,33 @@ describe Bisu::Localizer do
     ) }
 
     it_behaves_like "a localizer"
+
+    context "when a parameter replacemnt was not defined" do
+      let(:line) { "1 parameter: $k1ParameterKey$" }
+      let(:expected) { "1 parameter: Não sabes nada %{name}" }
+
+      it { translates(line, to: expected) }
+
+      it "returns an error" do
+        expect {
+          localizer.localize(line, language, locale)
+        }.to not_change { Bisu::Logger.summary[:warn] }
+         .and change { Bisu::Logger.summary[:error] }.by(1)
+      end
+
+      context "when passing //ignore-params" do
+        let(:line) { "1 parameter: $k1ParameterKey//ignore-params$" }
+
+        it { translates(line, to: expected) }
+
+        it "does not return an error" do
+          expect {
+            localizer.localize(line, language, locale)
+          }.to not_change { Bisu::Logger.summary[:warn] }
+           .and not_change { Bisu::Logger.summary[:error] }
+        end
+      end
+    end
   end
 
   describe "of type Android" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-30 00:00:00.000000000 Z
+date: 2021-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -131,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A localization automation service