lokalise_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d1228cffa0e9cf5ca3a149942246d942478e42c0d9f8e56c9a86273077aaa7e
+  data.tar.gz: 25885db67dfd0626bb7f15528a8bb049377202da1da8ccb114b1fa6191d39d1b
+SHA512:
+  metadata.gz: f05d5b99e4de60ab91490f9085950e8e8ab25291be7ff350126966c35664fd37a14c996d4d6bd4351d228ab13125479c792b6380ebab1eeb7531559b27b07a4e
+  data.tar.gz: 2a95e4eb1d9959fbd1ce03243c4ef7c59aca8bf2a424c33bc5da7e0e884784b4f0dc5286e02a5233e66f961dea3d024acccb33f5707b0e262bd00e2ceeb7b0c1

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hello@lokalise.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/.github/CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. 

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 (26-Sep-20)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'tzinfo-data', platforms: %i[mingw mswin x64_mingw jruby]
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 Lokalise team, Ilya Bodrov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# LokaliseRails
+
+<!-- [![Gem Version](https://badge.fury.io/rb/ruby-lokalise-api.svg)](https://badge.fury.io/rb/ruby-lokalise-api) -->
+[![Build Status](https://travis-ci.org/bodrovis/lokalise_rails.svg?branch=master)](https://travis-ci.org/bodrovis/lokalise_rails)
+[![Test Coverage](https://codecov.io/gh/bodrovis/lokalise_rails/graph/badge.svg)](https://codecov.io/gh/bodrovis/lokalise_rails)
+
+This gem provides [Lokalise](http://lokalise.com) integration for Ruby on Rails and allows to exchange translation files easily. It relies on [ruby-lokalise-api](https://lokalise.github.io/ruby-lokalise-api) to send APIv2 requests.
+
+## Getting started
+
+### Requirements
+
+This gem requires Ruby 2.5+ and Rails 5.1+. It might work with older versions of Rails though. You will also need to setup a Lokalise account and a translation project. Finally, you will need to generate a read/write API token at your Lokalise profile.
+
+### Installation
+
+Add the gem to your `Gemfile`
+
+```ruby
+gem 'lokalise_rails'
+```
+
+and run
+
+```
+bundle install
+rails g lokalise_rails:install
+```
+
+The latter command will generate a new initializer `lokalise_rails.rb` looking like this:
+
+```ruby
+require 'lokalise_rails'
+
+LokaliseRails.api_token = ENV['LOKALISE_API_TOKEN']
+LokaliseRails.project_id = ENV['LOKALISE_PROJECT_ID']
+# ...
+```
+
+You have to provide `api_token` and `project_id` to proceed. [Other options can be customized as well (see below)](https://github.com/bodrovis/lokalise_rails#import-settings) but they have sensible defaults.
+
+## Importing translations from Lokalise
+
+To import translations from the specified Lokalise project to your Rails app, run the following command:
+
+```
+rails lokalise_rails:import
+```
+
+Please note that any existing files inside the `locales` directory will be overwritten! You may enable [safe mode](https://github.com/bodrovis/lokalise_rails#import-settings) to check whether the folder is empty or not.
+
+## Configuration
+
+Options are specified in the `config/initializers/lokalise_rails.rb` file.
+
+### Global settings
+
+* `LokaliseRails.api_token` (`string`, required) - Lokalise API token with read/write permissions.
+* `LokaliseRails.project_id` (`string`, required) - Lokalise project ID. You must have import/export permissions in the specified project.
+* `locales_path` - method returning a string with the path to your translation files. Defaults to `"#{Rails.root}/config/locales"`. To provide a custom path, override the method inside the initializer (make sure that the path exists!):
+
+```ruby
+class LokaliseRails
+  class << self
+    def locales_path
+      "#{Rails.root}/config/locales_custom"
+    end
+  end
+end
+```
+
+### Import settings
+
+* `LokaliseRails.import_opts` (`hash`) - options that will be passed to Lokalise API when downloading translations to your app. Here are the default options:
+
+```ruby
+{
+  format: 'yaml',
+  placeholder_format: :icu,
+  yaml_include_root: true,
+  original_filenames: true,
+  directory_prefix: '',
+  indentation: '2sp'
+}
+```
+
+Full list of available options [can be found at the official API documentation](https://app.lokalise.com/api2docs/curl/#transition-download-files-post).
+* `LokaliseRails.import_safe_mode` (`boolean`) - default to `false`. When this option is enabled, the import task will check whether the `locales` directory is empty or not. If it is not empty, you will be prompted to continue.
+
+## License
+
+Copyright (c) [Lokalise team](http://lokalise.com), [Ilya Bodrov](http://bodrovis.tech)

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommened for running the tests'
+end
+
+task default: :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end

data/lib/generators/lokalise_rails/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+class LokaliseRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+
+      desc 'Creates a LokaliseRails config file.'
+
+      def copy_config
+        template 'lokalise_rails_config.rb', "#{Rails.root}/config/initializers/lokalise_rails.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/lokalise_rails_config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'lokalise_rails'
+
+# These are mandatory options that you must set before running rake tasks:
+LokaliseRails.api_token = ENV['LOKALISE_API_TOKEN']
+LokaliseRails.project_id = ENV['LOKALISE_PROJECT_ID']
+
+# Import options have the following defaults:
+# @import_opts = {
+#   format: 'yaml',
+#   placeholder_format: :icu,
+#   yaml_include_root: true,
+#   original_filenames: true,
+#   directory_prefix: '',
+#   indentation: '2sp'
+# }
+
+# Safe mode is disabled by default:
+# @import_safe_mode = false
+
+# Provide a custom path to the directory with your translation files:
+# class LokaliseRails
+#   class << self
+#     def locales_path
+#       "#{Rails.root}/config/locales"
+#     end
+#   end
+# end

data/lib/lokalise_rails.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lokalise_rails/task_definition/base'
+require 'lokalise_rails/task_definition/importer'
+require 'lokalise_rails/railtie' if defined?(Rails)
+
+class LokaliseRails
+  @project_id = nil
+  @import_opts = {
+    format: 'yaml',
+    placeholder_format: :icu,
+    yaml_include_root: true,
+    original_filenames: true,
+    directory_prefix: '',
+    indentation: '2sp'
+  }
+  # @export_opts = {
+  #
+  # }
+  @import_safe_mode = false
+  @api_token = nil
+
+  class << self
+    attr_accessor :import_opts, :import_safe_mode, :api_token, :export_opts,
+                  :project_id
+
+    def locales_path
+      "#{Rails.root}/config/locales"
+    end
+  end
+end

data/lib/lokalise_rails/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class LokaliseRails
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/lokalise_rails_tasks.rake'
+    end
+  end
+end

data/lib/lokalise_rails/task_definition/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ruby-lokalise-api'
+require 'open-uri'
+
+class LokaliseRails
+  module TaskDefinition
+    class Base
+      class << self
+        def check_required_opts
+          return [false, 'Project ID is not set! Aborting...'] unless LokaliseRails.project_id
+          return [false, 'Lokalise API token is not set! Aborting...'] unless LokaliseRails.api_token
+
+          [true, '']
+        end
+      end
+    end
+  end
+end

data/lib/lokalise_rails/task_definition/importer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class LokaliseRails
+  module TaskDefinition
+    class Importer < Base
+      class << self
+        def import!
+          status_ok, msg = check_required_opts
+          return msg unless status_ok
+          return 'Task cancelled!' unless proceed_when_safe_mode?
+
+          open_and_process_zip download_files['bundle_url']
+
+          'Task complete!'
+        end
+
+        def download_files
+          client = ::Lokalise.client LokaliseRails.api_token
+          opts = LokaliseRails.import_opts
+
+          client.download_files LokaliseRails.project_id, opts
+        end
+
+        def open_and_process_zip(path)
+          Zip::File.open_buffer(URI.open(path)) { |zip| process_zip zip }
+        end
+
+        def process_zip(zip)
+          zip.each do |entry|
+            next unless /\.ya?ml/.match?(entry.name)
+
+            filename = entry.name.include?('/') ? entry.name.split('/')[1] : entry.name
+            data = YAML.safe_load entry.get_input_stream.read
+            File.open("#{LokaliseRails.locales_path}/#{filename}", 'w+:UTF-8') do |f|
+              f.write(data.to_yaml)
+            end
+          end
+        end
+
+        def proceed_when_safe_mode?
+          return true unless LokaliseRails.import_safe_mode && !Dir.empty?(LokaliseRails.locales_path.to_s)
+
+          $stdout.puts "The target directory #{LokaliseRails.locales_path} is not empty!"
+          $stdout.print 'Enter Y to continue: '
+          answer = $stdin.gets
+          answer.to_s.strip == 'Y'
+        end
+      end
+    end
+  end
+end

data/lib/lokalise_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class LokaliseRails
+  VERSION = '0.0.1'
+end

data/lokalise_rails.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/lokalise_rails/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'lokalise_rails'
+  spec.version               = LokaliseRails::VERSION
+  spec.authors               = ['Ilya Bodrov']
+  spec.email                 = ['golosizpru@gmail.com']
+  spec.summary               = 'Lokalise integration for Ruby on Rails'
+  spec.description           = 'This gem allows to exchange translation files between your Rails app and Lokalise TMS.'
+  spec.homepage              = 'https://github.com/bodrovis/lokalise_rails'
+  spec.license               = 'MIT'
+  spec.platform              = Gem::Platform::RUBY
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.files = Dir['README.md', 'LICENSE',
+                   'CHANGELOG.md', 'lib/**/*.rb',
+                   'lokalise_rails.gemspec', '.github/*.md',
+                   'Gemfile', 'Rakefile']
+  spec.test_files       = Dir['spec/**/*.rb']
+  spec.extra_rdoc_files = ['README.md']
+  spec.require_paths    = ['lib']
+
+  spec.add_dependency 'ruby-lokalise-api', '~> 3.1'
+  spec.add_dependency 'rubyzip', '~> 2.3'
+
+  spec.add_development_dependency 'codecov', '~> 0.1'
+  spec.add_development_dependency 'dotenv', '~> 2.5'
+  if ENV['TEST_RAILS_VERSION'].nil?
+    spec.add_development_dependency 'rails', '~> 6.0.3'
+  else
+    spec.add_development_dependency 'rails', ENV['TEST_RAILS_VERSION'].to_s
+  end
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rspec-rails', '~> 4.0'
+  spec.add_development_dependency 'rubocop', '~> 0.60'
+  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'vcr', '~> 6.0'
+end