yatapp 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 401283e7da3d120b0c443af81eb7bfb45ab0c0d0
-  data.tar.gz: c77d8887d5e7e339a34169b8dafa62b2087cd558
+  metadata.gz: b12a1257b937f74da0bf2c3f18e3bc7ea21e1dbc
+  data.tar.gz: 31e98c114fc12650211a608426fbf455c5fe76d0
 SHA512:
-  metadata.gz: 347e3529cc7fbd21a695167a384232d60a75b3f6f558ab0398ee64f6e5cb2a8c59453ff8070fd368026488f180d5c84c8dcc6f6aedaf36a9e3aa34c047633109
-  data.tar.gz: 8fea501d16fa9524e034de8e6f7bfba7cf158824d5538df33988819ac377dec4a727f169d88f020bf04099f4221b5d9a3fc0df99c1a703d4d7b3e7f9b20ff8a9
+  metadata.gz: 77b77d31c68566ca619acee60bd423703bf5f0005a0afdd7b0b917e831cedd48a3e68c0ed82daf3aec5d968652bcf22eb129f2e2dfa51e308f16056c4a3607b4
+  data.tar.gz: d3306498e3ac160adb1f51c9964cd2aab520013aa2efaf474d4941141bd2e24dd4efcd940aa6b6cbe354cb198367104a80f158ff428e770c209b745fc73d7e91

data/README.md

@@ -32,6 +32,7 @@ Gem can be used in two ways:
 * `translation_format` - format you wish to get files in, available for now are (yaml, js, json, properties, xml, strings and plist). Default: `json`
 * `save_to_path` - you can define where files should be saved. Default: `/config/locales/`
 * `root` - add locale as root to file with translations. Default: `false`
+* `strip_empty` - generates only keys that have text and skip empty ones. Default `false`
 
 First two parameters are required and the rest is optional.
 
@@ -55,7 +56,9 @@ Translations with root set to `true`:
 
 ### API Integration
 
-Recommended configuration:
+#### Rails
+
+Recommended configuration for Rails applications:
 
 ```ruby
 # config/initializers/yatapp.rb
@@ -66,28 +69,29 @@ Yatapp.configure do |c|
   c.api_access_token = ENV['YATA_API_KEY']
   c.project_id = ENV['YATA_PROJECT_ID']
   c.languages  = ['en', 'de', 'en_US']
-  c.translations_format = 'json'
+  c.translation_format = 'json'
 end
 ```
 
 To save file in a different location from default or add a locale as a root, add to configuration two lines as in example below:
 
 ```ruby
-  # config/initializers/yatapp.rb
-
-  include Yatapp
-
-  Yatapp.configure do |c|
-    c.api_access_token = ENV['YATA_API_KEY']
-    c.project_id = ENV['YATA_PROJECT_ID']
-    c.languages  = ['en', 'de', 'en_US']
-    c.translations_format = 'json'
-    c.save_to_path = '/public/locales/'
-    c.root = true
-  end
+# config/initializers/yatapp.rb
+
+include Yatapp
+
+Yatapp.configure do |c|
+  c.api_access_token = ENV['YATA_API_KEY']
+  c.project_id = ENV['YATA_PROJECT_ID']
+  c.languages  = ['en', 'de', 'en_US']
+  c.translation_format = 'json'
+  c.save_to_path = '/public/locales/'
+  c.root = true
+  c.strip_empty = true
+end
 ```
 
-From now on your translations will be saved in `/public/locales/` directory and translations will have locale as a root.
+From now on your translations will be saved in `/public/locales/` directory, translations will have locale as a root and all keys without text will be skipped.
 
 
 API integration allows you to download all translations using rake task:
@@ -96,6 +100,41 @@ API integration allows you to download all translations using rake task:
 $ rake yata:fetch_translations
 ```
 
+#### Sinatra
+
+Add to your Gemfile `yatapp` gem:
+
+```ruby
+# Gemfile
+
+gem 'yatapp'
+```
+
+Install with `bundle install`.
+
+Add Rakefile file in root of your project with custom task:
+
+```ruby
+# Rakefile
+
+require 'yatapp'
+require 'sinatra'
+
+Yatapp.configure do |c|
+  c.api_access_token = ENV['YATA_API_KEY']
+  c.project_id = ENV['YATA_PROJECT_ID']
+  c.languages  = ['en', 'de', 'en_US']
+  c.translation_format = 'json'
+  c.save_to_path = Sinatra::Application.settings.root + '/config/locales/'
+end
+
+task :fetch_translations do
+  Yatapp.get_translations
+end
+```
+
+From now on your translations can be fetched with command: `rake fetch_translations`
+
 ### Websocket Integration
 
 Websocket integration connects to Yata server and stays open. All changes in translations are auto-fetched to the app.

data/lib/yatapp/configuration.rb

@@ -7,7 +7,8 @@ module Yatapp
       :languages,
       :translation_format,
       :root,
-      :save_to_path
+      :save_to_path,
+      :strip_empty
     ].freeze
 
     attr_accessor *CONFIGURATION_OPTIONS

data/lib/yatapp/version.rb

@@ -1,3 +1,3 @@
 module Yatapp
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

data/lib/yatapp/yata_api_caller.rb

@@ -9,11 +9,12 @@ module Yatapp
     attr_accessor *Yatapp::Configuration::CONFIGURATION_OPTIONS
 
     def initialize
-      @translation_format = 'json'
-      @save_to_path       = ""
-      @root               = false
-      @languages          = ['en']
       initialize_configuration
+      @translation_format ||= 'json'
+      @save_to_path       ||= ""
+      @root               ||= false
+      @languages          ||= ['en']
+      @strip_empty        ||= false
     end
 
     def get_translations
@@ -73,7 +74,7 @@ module Yatapp
         url = url.sub(':format', translation_format)
         url = url.sub(':api_version', API_VERSION)
         url = url.sub(':lang', lang)
-        url = url + "?apiToken=#{api_access_token}&root=#{root}"
+        url = url + "?apiToken=#{api_access_token}&root=#{root}&strip_empty=#{strip_empty}"
       end
 
       def download_url_websocket(lang)

data/yatapp.gemspec

@@ -30,6 +30,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faye-websocket'
   spec.add_dependency 'rails-i18n'
   spec.add_dependency 'httparty'
+  spec.add_dependency 'rake'
+  
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yatapp
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - luki3k5
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: bundler
   requirement: !ruby/object:Gem::Requirement