lokalise_rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87524123a10425d69c33950f4b2c16366146f5c1ab14c19dbc7185de61fb726a
-  data.tar.gz: 39ba0b0a91f443ea162d7804c89906f4523f7c13411fbd541624bafb9197a569
+  metadata.gz: b8341e9150b8080050eb672077a415739178279e452ccad5d9f25bc7a24f83be
+  data.tar.gz: 4b6a74a12e62625d7bd6a41c8b46a93d029ef315551d4c6883375d9bf765aa72
 SHA512:
-  metadata.gz: 4e36f385c123ab80402aaa428973c2c0706b2cbceabade8bcf12689fe0955bdc927a223c27a9114c102d83af6a709b061e1c10d2e189ca832b5b56a0a6b043f8
-  data.tar.gz: bbbe1857d99cdc7c3595f611d664c555981fbdf5f1d37c30a52cb179d641902f879b1492996dc7c1c1cb6dacdfbd7c2a3ca226f31a687879fddf59b1e8f9fe7a
+  metadata.gz: 13f5680ba0f8cfcd279929d7ab577712b1392760ca1d11460f6290d03d1ac9c4fe4915057656e3440cdda5a0958e5b230547549c9f2d4fe431c774fd7fe9ebd2
+  data.tar.gz: 4b98524742a8ed099f176351e073526db7e9fdae8e492318ac9f86c5b6ec8a7e650d9726a0b57571856e04a973e7aa9bcd7456aa9a6117e677d5039de33d1580

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.0.1 (14-Oct-20)
+
+* Minor bug fixes and spec updates
+
 ## 1.0.0 (01-Oct-20)
 
 * Added export feature

data/README.md

@@ -62,6 +62,22 @@ To export translations from your Rails app to the specified Lokalise project, ru
 rails lokalise_rails:export
 ```
 
+## Running tasks programmatically
+
+You can also run the import and export tasks from the Rails app:
+
+```ruby
+require "#{Rails.root}/config/lokalise_rails.rb"
+
+# Import the files:
+result = LokaliseRails::TaskDefinition::Importer.import!
+# `result` contains a boolean value with the result of the operation
+
+# Export the files:
+processes = LokaliseRails::TaskDefinition::Exporter.export!
+# `processes` contains a list of queued background processes
+```
+
 ## Configuration
 
 Options are specified in the `config/lokalise_rails.rb` file.
@@ -111,6 +127,11 @@ en_US:
 c.skip_file_export = ->(file) { f.split[1].to_s.include?('fr') }
 ```
 
+## Running tests
+
+1. Copypaste `.env.example` file as `.env`. Put your Lokalise API token and project ID inside. The `.env` file is excluded from version control so your data is safe. All in all, we use pre-recorded VCR cassettes, so the actual API requests won’t be sent. However, providing at least some values is required.
+2. Run `rspec .`. Observe test results and code coverage.
+
 ## License
 
 Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Bodrov](http://bodrovis.tech)

data/lib/lokalise_rails/task_definition/exporter.rb

@@ -14,7 +14,7 @@ module LokaliseRails
 
           if errors.any?
             errors.each { |e| $stdout.puts e }
-            return false
+            return errors
           end
 
           queued_processes = []

data/lib/lokalise_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LokaliseRails
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/lib/lokalise_rails/exporter_spec.rb

@@ -18,6 +18,8 @@ describe LokaliseRails::TaskDefinition::Exporter do
 
     describe '.export!' do
       it 'sends a proper API request' do
+        allow_project_id
+        
         process = VCR.use_cassette('upload_files') do
           described_class.export!
         end.first
@@ -91,6 +93,8 @@ describe LokaliseRails::TaskDefinition::Exporter do
 
     describe '.export!' do
       it 'rescues from export errors' do
+        allow_project_id
+
         processes = VCR.use_cassette('upload_files_error') do
           described_class.export!
         end

data/spec/lib/lokalise_rails/importer_spec.rb

@@ -22,6 +22,7 @@ describe LokaliseRails::TaskDefinition::Importer do
     end
 
     it 'rescues from errors during file download' do
+      allow_project_id
       allow(LokaliseRails).to receive(:api_token).and_return('incorrect')
 
       VCR.use_cassette('download_files_error') do
@@ -34,13 +35,13 @@ describe LokaliseRails::TaskDefinition::Importer do
   describe '.import!' do
     it 'halts when the API key is not set' do
       expect(LokaliseRails).to receive(:api_token).and_return(nil)
-      expect(-> {described_class.import!}).to output(/API token is not set/).to_stdout
+      expect(-> { described_class.import! }).to output(/API token is not set/).to_stdout
       expect(count_translations).to eq(0)
     end
 
     it 'halts when the project_id is not set' do
       expect(LokaliseRails).to receive(:project_id).and_return(nil)
-      expect(-> {described_class.import!}).to output(/Project ID is not set/).to_stdout
+      expect(-> { described_class.import! }).to output(/Project ID is not set/).to_stdout
       expect(count_translations).to eq(0)
     end
   end

data/spec/spec_helper.rb

@@ -30,6 +30,7 @@ require 'rspec/rails'
 RSpec.configure do |config|
   config.include FileManager
   config.include RakeUtils
+  config.include SpecAddons
 end
 
 # rubocop:disable Style/MixinUsage

data/spec/support/spec_addons.rb

@@ -0,0 +1,6 @@
+module SpecAddons
+  def allow_project_id
+    allow(LokaliseRails).to receive(:project_id).
+    and_return('189934715f57a162257d74.88352370')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lokalise_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ilya Bodrov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-lokalise-api
@@ -250,6 +250,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/rake_utils.rb
+- spec/support/spec_addons.rb
 - spec/support/vcr.rb
 homepage: https://github.com/bodrovis/lokalise_rails
 licenses:
@@ -306,4 +307,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/file_manager.rb
 - spec/support/rake_utils.rb
+- spec/support/spec_addons.rb
 - spec/support/vcr.rb