lokalise_rails 0.0.1

data/spec/dummy/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Rails.application.routes.draw do
+  # For details on the DSL available within this file, see https://guides.rubyonrails.org/routing.html
+end

data/spec/dummy/db/seeds.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/spec/lib/generators/lokalise_rails/install_generator_spec.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'generators/lokalise_rails/install_generator'
+
+describe LokaliseRails::Generators::InstallGenerator do
+  before :all do
+    remove_config
+  end
+
+  after :all do
+    remove_config
+    described_class.start
+  end
+
+  it 'installs config file properly' do
+    described_class.start
+    expect(File.file?(config_file)).to be true
+  end
+end

data/spec/lib/lokalise_rails/importer_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+describe LokaliseRails::TaskDefinition::Importer do
+  describe '.download_files' do
+    it 'returns a proper download URL' do
+      response = VCR.use_cassette('download_files') do
+        described_class.download_files
+      end
+
+      expect(response['project_id']).to eq('189934715f57a162257d74.88352370')
+      expect(response['bundle_url']).to include('s3-eu-west-1.amazonaws.com')
+    end
+  end
+
+  describe '.import!' do
+    it 'halts when the API key is not set' do
+      expect(LokaliseRails).to receive(:api_token).and_return(nil)
+      result = described_class.import!
+      expect(result).to include('API token is not set')
+      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)
+      result = described_class.import!
+      expect(result).to include('Project ID is not set')
+      expect(count_translations).to eq(0)
+    end
+  end
+end

data/spec/lib/lokalise_rails_spec.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+describe LokaliseRails do
+  describe 'parameters' do
+    let(:fake_class) { class_double('LokaliseRails') }
+
+    it 'is possible to set project_id' do
+      expect(fake_class).to receive(:project_id=).with('123.abc')
+      fake_class.project_id = '123.abc'
+    end
+
+    it 'is possible to set import_opts' do
+      expect(fake_class).to receive(:import_opts=).with(duck_type(:each))
+      fake_class.import_opts = {
+        format: 'json',
+        indentation: '8sp'
+      }
+    end
+
+    it 'is possible to set import_safe_mode' do
+      expect(fake_class).to receive(:import_safe_mode=).with(true)
+      fake_class.import_safe_mode = true
+    end
+
+    it 'is possible to set api_token' do
+      expect(fake_class).to receive(:api_token=).with('abc')
+      fake_class.api_token = 'abc'
+    end
+
+    it 'is possible to override locales_path' do
+      expect(fake_class).to receive(:locales_path).and_return('/demo/path')
+
+      expect(fake_class.locales_path).to eq('/demo/path')
+    end
+  end
+end

data/spec/lib/tasks/import_task_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+RSpec.describe LokaliseRails do
+  context 'when directory is empty' do
+    before do
+      mkdir_locales
+      rm_translation_files
+    end
+
+    after :all do
+      rm_translation_files
+    end
+
+    it 'is callable' do
+      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+        :download_files
+      ).and_return(
+        {
+          'project_id' => '123.abc',
+          'bundle_url' => "#{Rails.root}/public/translations.zip"
+        }
+      )
+
+      expect(import_executor).to output(/complete!/).to_stdout
+
+      expect(count_translations).to eq(4)
+
+      main_en = File.join described_class.locales_path, 'main_en.yml'
+      expect(File.file?(main_en)).to be true
+    end
+
+    it 'downloads ZIP archive properly' do
+      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+        :download_files
+      ).and_return(
+        {
+          'project_id' => '123.abc',
+          'bundle_url' => 'https://github.com/bodrovis/lokalise_rails/blob/master/spec/dummy/public/translations.zip?raw=true'
+        }
+      )
+
+      expect(import_executor).to output(/complete!/).to_stdout
+
+      expect(count_translations).to eq(4)
+
+      main_en = File.join described_class.locales_path, 'main_en.yml'
+      expect(File.file?(main_en)).to be true
+    end
+  end
+
+  context 'when directory is not empty' do
+    before :all do
+      mkdir_locales
+      rm_translation_files
+      temp_file = File.join described_class.locales_path, 'kill.me'
+      File.open(temp_file, 'w+') { |file| file.write('temp') }
+      described_class.import_safe_mode = true
+    end
+
+    after :all do
+      rm_translation_files
+      described_class.import_safe_mode = false
+    end
+
+    it 'returns a success message with default settings' do
+      expect(LokaliseRails::TaskDefinition::Importer).to receive(
+        :download_files
+      ).and_return(
+        {
+          'project_id' => '123.abc',
+          'bundle_url' => "#{Rails.root}/public/translations.zip"
+        }
+      )
+      expect($stdin).to receive(:gets).and_return('Y')
+      expect(import_executor).to output(/is not empty/).to_stdout
+
+      expect(count_translations).to eq(5)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'simplecov'
+SimpleCov.start 'rails' do
+  add_filter 'spec/'
+  add_filter '.github/'
+  add_filter 'lib/generators/templates/'
+end
+
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
+# Support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].sort.each { |f| require f }
+
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require_relative '../spec/dummy/config/environment'
+ActiveRecord::Migrator.migrations_paths = [File.expand_path('../spec/dummy/db/migrate', __dir__)]
+ENV['RAILS_ROOT'] ||= "#{File.dirname(__FILE__)}../../../spec/dummy"
+
+require 'rspec/rails'
+
+RSpec.configure do |config|
+  config.include FileUtils
+  config.include RakeUtils
+end
+
+Rails.application.load_tasks

data/spec/support/file_utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FileUtils
+  def mkdir_locales
+    FileUtils.mkdir_p(LokaliseRails.locales_path) unless File.directory?(LokaliseRails.locales_path)
+  end
+
+  def rm_translation_files
+    FileUtils.rm_rf locales_dir
+  end
+
+  def locales_dir
+    Dir["#{LokaliseRails.locales_path}/*"]
+  end
+
+  def count_translations
+    locales_dir.count { |file| File.file?(file) }
+  end
+
+  def remove_config
+    FileUtils.remove_file config_file if File.file?(config_file)
+  end
+
+  def config_file
+    "#{Rails.root}/config/initializers/lokalise_rails.rb"
+  end
+end

data/spec/support/rake_utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RakeUtils
+  def import_executor
+    -> { Rake::Task['lokalise_rails:import'].execute }
+  end
+
+  def install_invoker
+    Rails::Generators.invoke 'lokalise_rails:install'
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'vcr'
+
+VCR.configure do |c|
+  c.ignore_hosts 'codeclimate.com'
+  c.hook_into :faraday
+  c.cassette_library_dir = File.join(File.dirname(__FILE__), '..', 'fixtures', 'vcr_cassettes')
+  c.filter_sensitive_data('<LOKALISE_TOKEN>') { ENV.fetch('LOKALISE_API_TOKEN') }
+  c.configure_rspec_metadata!
+end

metadata

@@ -0,0 +1,317 @@
+--- !ruby/object:Gem::Specification
+name: lokalise_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ilya Bodrov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-lokalise-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.60'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.37'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: This gem allows to exchange translation files between your Rails app
+  and Lokalise TMS.
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/lokalise_rails/install_generator.rb
+- lib/generators/templates/lokalise_rails_config.rb
+- lib/lokalise_rails.rb
+- lib/lokalise_rails/railtie.rb
+- lib/lokalise_rails/task_definition/base.rb
+- lib/lokalise_rails/task_definition/importer.rb
+- lib/lokalise_rails/version.rb
+- lokalise_rails.gemspec
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/lokalise_rails.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/db/seeds.rb
+- spec/lib/generators/lokalise_rails/install_generator_spec.rb
+- spec/lib/lokalise_rails/importer_spec.rb
+- spec/lib/lokalise_rails_spec.rb
+- spec/lib/tasks/import_task_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_utils.rb
+- spec/support/rake_utils.rb
+- spec/support/vcr.rb
+homepage: https://github.com/bodrovis/lokalise_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Lokalise integration for Ruby on Rails
+test_files:
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/helpers/application_helper.rb
+- spec/dummy/app/models/application_record.rb
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/production.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/lokalise_rails.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/db/seeds.rb
+- spec/lib/generators/lokalise_rails/install_generator_spec.rb
+- spec/lib/lokalise_rails/importer_spec.rb
+- spec/lib/lokalise_rails_spec.rb
+- spec/lib/tasks/import_task_spec.rb
+- spec/spec_helper.rb
+- spec/support/file_utils.rb
+- spec/support/rake_utils.rb
+- spec/support/vcr.rb