bisu 1.7.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bed28be32f24a03d0e812b3ad88980911bd4d13a
-  data.tar.gz: 13f1165c2bf416965c75e24553f5f2672a91f1ec
+  metadata.gz: c20a1701ab5eb80ac795d51e1b1366b5ef2a69ba
+  data.tar.gz: 77b52f74cfff624fb03af1ff444220ef77b65c62
 SHA512:
-  metadata.gz: 2e4ebf64ac0b36be4fa1f058347a7029a676986289a216120bc22f680c9bbcdca545660017f2da39a2a6a05f822c3cf110820ce579d8c20f149fb16257e3adc3
-  data.tar.gz: fb3ce272578ae914ca44b785a456dec185c87435a0abba11c1debb328e2dec1909bdf2d2648b40dda9b0030d63283b28120d16ac22db95f3b2347c84e3da181f
+  metadata.gz: 6f5959e04a70095f5307a23e0ea61819394c8cdad2f499698acb9285719eb71fc6d80d65bc92e5f62ee9170c4584b45f5733cb49cc21360504403247953e9a9b
+  data.tar.gz: c9d64bdd4c29f2facd4ca30c95dafd42a45142839116c9b591682d43c02829e4a676939bc8dd8cf4fa298fd2874ab245dfecc2165aa576e7ae1b0c76cf0a671b

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

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.7.1](https://github.com/hole19/bisu/releases/tag/v1.7.1)
+Released on 2019/03/04
+
+#### Added
+- Applies the same new line behaviour in every platform
+
 ## [1.7.0](https://github.com/hole19/bisu/releases/tag/v1.7.0)
 Released on 2019/02/18
 

data/Gemfile

@@ -5,6 +5,9 @@ gem 'safe_yaml',  '~> 1.0'
 gem 'colorize',   '~> 0.7'
 gem 'xml-simple', '~> 1.1'
 
-gem 'webmock',    '~> 1.20'
-gem 'rspec'
-gem 'rspec-its'
+group :test do
+  gem 'rake'
+  gem 'webmock',    '~> 1.20'
+  gem 'rspec'
+  gem 'rspec-its'
+end

data/Gemfile.lock

@@ -7,6 +7,7 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     hashdiff (0.3.0)
+    rake (12.3.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -35,6 +36,7 @@ PLATFORMS
 
 DEPENDENCIES
   colorize (~> 0.7)
+  rake
   rspec
   rspec-its
   safe_yaml (~> 1.0)
@@ -45,4 +47,4 @@ RUBY VERSION
    ruby 2.3.1p112
 
 BUNDLED WITH
-   1.14.3
+   1.17.2

data/README.md

@@ -1,9 +1,14 @@
 Bisu 홀
 ========
 
+[![Status](https://travis-ci.org/hole19/bisu.svg?branch=master)](https://travis-ci.org/hole19/bisu?branch=master)
+[![Gem](https://img.shields.io/gem/v/bisu.svg?style=flat)](http://rubygems.org/gems/bisu "View this project in Rubygems")
+
 Bisu manages your app iOS, Android and RoR localization files for you. No more copy+paste induced errors!
 
----
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hole19/bisu/master/README_explanation.png" width="500">
+</p>
 
 Instalation
 -----
@@ -21,7 +26,7 @@ Usage
 
 *given that someone already configured Bisu
 
-Configuration
+Setup your configuration file
 -----
 
 1. Create in your project base folder a translatable.yml:
@@ -30,9 +35,7 @@ Configuration
   type: <iOS|Android|RoR>
 
   dictionary:
-    type: google_sheet
-    sheet_id: <GOOGLE-DRIVE-SHEET-ID>
-    keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
+    (see options below)
 
   translate:
     - in: path/to/1st/file.translatable
@@ -50,14 +53,30 @@ Configuration
       language: pt
   ```
 
-  Also available generic URL source:
+##### Dictionary from a URL source:
+
   ```
   dictionary:
     type: url
     url: <A-GET-URL>
   ```
 
-  Also available [OneSky](https://www.oneskyapp.com) integration:
+##### Google Sheets Dictionary:
+
+1. First ["Publish to the web"](https://www.google.com/search?q=google+sheets+publish+to+web) your Google Sheet
+1. Share only the sheet that contains the translations
+1. First column should contain the translation keys
+1. First row should contain the locale for each language
+
+  ```
+  dictionary:
+    type: google_sheet
+    sheet_id: <GOOGLE-DRIVE-SHEET-ID>
+    keys_column: <GOOGLE-DRIVE-KEY-COLUMN-TITLE>
+  ```
+
+##### OneSky integration:
+
   ```
   dictionary:
     type: one_sky
@@ -67,7 +86,13 @@ Configuration
     file_name: <ONE-SKY-FILE-NAME>
   ```
 
-1. Create a \*.translatable version for your **iOS** localization files:
+Create translation templates
+-----
+
+Create a \*.translatable version for your platform specific localization files:
+
+##### iOS
+*example: Localizable.strings.translatable*
 
   ```
   // $specialKComment1$
@@ -85,7 +110,8 @@ Configuration
   "klRequestName"    = "$kRequestName%{user_name: %@}$";
   ```
 
-1. Create a \*.translatable version for your **Android** localization files:
+##### Android
+*example: strings.xml.translatable*
 
   ```
   <?xml version="1.0" encoding="utf-8"?>
@@ -102,7 +128,8 @@ Configuration
   </resources>
   ```
 
-1. Create a \*.translatable version for your **RoR** localization files:
+##### Ruby on Rails
+*example: config/locales/yml.translatable*
 
   ```
   $specialKLocale$:

data/Rakefile

@@ -1,8 +1,9 @@
-require 'rake/testtask'
+require "rake"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob("spec/**/*_spec.rb")
+  t.rspec_opts = "--format documentation"
 end
 
-desc "Run tests"
-task :default => :test
+task default: :spec

data/lib/bisu/localizer.rb

@@ -62,6 +62,8 @@ module Bisu
     end
 
     def process(text)
+      text = text.gsub("\n", "\\n")
+
       if @type.eql?(:android)
         text = text.gsub(/[']/, "\\\\\\\\'")
         text = text.gsub("...", "…")

data/lib/bisu/version.rb

@@ -1,4 +1,4 @@
 module Bisu
-  VERSION = '1.7.0'
-  VERSION_UPDATED_AT = '2019-02-18'
+  VERSION = '1.7.1'
+  VERSION_UPDATED_AT = '2019-03-04'
 end

data/spec/lib/bisu/localizer_spec.rb

@@ -8,6 +8,8 @@ describe Bisu::Localizer do
       "kTranslationKey2" => "Naaada!",
       "k1ParameterKey"   => "Não sabes nada %{name}",
       "k2ParametersKey"  => "Sabes %{perc} por cento %{name}",
+      "kNewLineSingle"   => "Não sabes nada\nJoão das Neves",
+      "kNewLineMultiple" => "Não sabes nada\\nJoão das Neves",
 
       # type dependent translations
       "kDoubleQuoted"    => "Não sabes nada \"João das Neves\"",
@@ -52,6 +54,9 @@ describe Bisu::Localizer do
     it { translates("2 parameters: $k2ParametersKey{perc:%2$d, name:%1$s}$", to: "2 parameters: Sabes %2$d por cento %1$s") }
     it { translates("2 parameters: $k2ParametersKey{name:%1$s, perc:%2$d}$", to: "2 parameters: Sabes %2$d por cento %1$s") }
 
+    it { translates("$kNewLineSingle$",   to: "Não sabes nada\\nJoão das Neves") }
+    it { translates("$kNewLineMultiple$", to: "Não sabes nada\\nJoão das Neves") }
+
     # type dependent translations
 
     it { translates("$kDoubleQuoted$", to: expected[:double_quoted]) }

data/spec/lib/bisu/source/one_sky_spec.rb

@@ -45,7 +45,7 @@ describe Bisu::Source::OneSky do
       expect(to_i18).to eq({
         "en" => {
           "kRegularNewLine" => "This is the first line\\nthis is the second line",
-          "kErrorNewLine" => "This is the first line\\nthis is the second line"
+          "kErrorNewLine"   => "This is the first line\\nthis is the second line"
         }
       })
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bisu
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.7.1
 platform: ruby
 authors:
 - joaoffcosta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-18 00:00:00.000000000 Z
+date: 2019-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: safe_yaml
@@ -74,12 +74,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rspec"
+- ".ruby-version"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
+- README_explanation.png
 - Rakefile
 - bin/bisu
 - bisu.gemspec

data/.gitignore

@@ -1 +0,0 @@
-.ruby-version