toptranslation_cli 1.0.0

data/lib/toptranslation_cli/push.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'tty-spinner'
+require 'tty-progressbar'
+require 'pastel'
+
+module ToptranslationCli
+  class Push # rubocop:disable Metrics/ClassLength
+    using Threaded
+
+    class << self
+      def run
+        new.run
+      end
+    end
+
+    def initialize
+      ToptranslationCli.configuration.load
+
+      @pastel = Pastel.new
+      @spinner_settings = { success_mark: @pastel.green('+'), error_mark: @pastel.red('-') }
+      @spinner = TTY::Spinner.new("[#{@pastel.yellow(':spinner')}] :title", @spinner_settings)
+    end
+
+    def run
+      @documents = fetch_documents
+      changed = changed_files(local_files)
+      upload_files(changed)
+    rescue RestClient::Forbidden
+      @spinner.error('invalid access token')
+      exit 1
+    end
+
+    private
+
+      def verbose?
+        ToptranslationCli.configuration.verbose
+      end
+
+      def changed_files(files)
+        @spinner.update(title: 'Checking changed files...')
+        @spinner.auto_spin
+        changed = files.select do |file|
+          translation = translation_for_file(file)
+          translation_changed?(translation, file)
+        end
+        @spinner.success(@pastel.green("found #{changed.count} changed file(s)"))
+        changed
+      end
+
+      def upload_files(files)
+        return if files.empty?
+
+        grouped_files = files.group_by { |file| file[:placeholder_path] }.values
+
+        bar = TTY::ProgressBar.new('Uploading [:bar] :percent [:current/:total]', total: grouped_files.flatten.count)
+        bar.render
+
+        grouped_files.each_in_threads(8, true) do |file|
+          upload_file(file)
+          bar.synchronize { bar.log(file[:path]) }
+          bar.advance
+        end
+      end
+
+      def translation_for_file(file)
+        remote_document = find_document_by_path(@documents, file[:placeholder_path])
+        find_translation_by_locale(remote_document&.translations || [], file[:locale])
+      end
+
+      def mark_unchanged(spinner)
+        spinner.instance_variable_set(:@success_mark, @pastel.blue('='))
+        spinner.success(@pastel.blue('skipping unchanged file'))
+      end
+
+      def fetch_documents
+        @spinner.update(title: 'Checking remote documents...')
+        @spinner.auto_spin
+        documents = project&.documents.to_a
+        @spinner.success(@pastel.green("found #{documents.count} document(s)"))
+        documents
+      end
+
+      def local_files
+        @spinner.update(title: 'Checking local translations...')
+        @spinner.auto_spin
+        files = ToptranslationCli.configuration.files.flat_map do |path_definition|
+          project_locales.flat_map { |locale| file_to_upload(path_definition, locale) }
+        end
+        @spinner.success(@pastel.green("found #{files.count} file(s)"))
+        files
+      end
+
+      def file_to_upload(path_definition, locale)
+        placeholder_path = PlaceholderPath.new(path_definition)
+        FileFinder.new(path_definition).files(locale.code).flat_map do |path|
+          the_placeholder_path = placeholder_path.for_path(path, locale.code)
+          {
+            path: path,
+            placeholder_path: the_placeholder_path,
+            locale: locale, sha1: sha1_checksum(path)
+          }
+        end
+      end
+
+      def upload_file(file)
+        project.upload_document(
+          file[:path],
+          file[:locale].code,
+          path: file[:placeholder_path],
+          name: File.basename(file[:path])
+        )
+      end
+
+      def translation_changed?(translation, file)
+        translation.nil? || translation.sha1 != file[:sha1]
+      end
+
+      def sha1_checksum(path)
+        Digest::SHA1.file(path).hexdigest
+      end
+
+      def find_document_by_path(documents, path_with_placeholder)
+        documents.detect { |document| document.path == path_with_placeholder }
+      end
+
+      def find_translation_by_locale(translations, locale)
+        translations.detect { |translation| translation.locale.code == locale.code }
+      end
+
+      def project_locales
+        @project_locales ||= project.locales
+      end
+
+      def project
+        @project ||= ToptranslationCli.connection.projects.find(ToptranslationCli.configuration.project_identifier)
+      end
+  end
+end

data/lib/toptranslation_cli/status.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module ToptranslationCli
+  class Status
+    class << self
+      def run
+        ToptranslationCli.configuration.load
+
+        proj = project
+
+        local_files = FileFinder.local_files(proj)
+        remote_files = FileFinder.remote_files(proj)
+
+        only_local, only_remote, changed = diff(local_files, remote_files)
+
+        print_status(only_local, only_remote, changed)
+
+        (only_local + only_remote + changed).length
+      end
+
+      private
+
+        def diff(local, remote)
+          only_local = local.keys - remote.keys
+          only_remote = remote.keys - local.keys
+          changed = changed_files(local, remote, only_local, only_remote)
+
+          [only_local, only_remote, changed]
+        end
+
+        def changed_files(local, remote, only_local, only_remote)
+          (local.to_a - remote.to_a | remote.to_a - local.to_a)
+            .flat_map(&:first)
+            .uniq - only_remote - only_local
+        end
+
+        def print_status(only_local, only_remote, changed)
+          print_section 'Local: These documents exist only locally', only_local
+          print_section 'Changed: These documents exist both locally and remotely but differ', changed
+          print_section 'Remote: These documents exist only remotely', only_remote
+        end
+
+        def print_section(description, paths)
+          return if paths.empty?
+
+          puts <<~SECTION
+            #{description}
+
+            #{paths.sort.map { |path| "\t#{path}" }.join("\n")}
+
+          SECTION
+        end
+
+        def project
+          ToptranslationCli
+            .connection
+            .projects
+            .find(ToptranslationCli.configuration.project_identifier)
+        end
+    end
+  end
+end

data/lib/toptranslation_cli/threaded.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ToptranslationCli
+  module Threaded
+    refine Enumerable do
+      def in_chunks(chunks, flatten = false)
+        chunk_size = [size, (size / chunks.to_f).ceil].select(&:positive?).min
+        chunked = each_slice(chunk_size)
+
+        chunked = chunked.map(&:flatten) if flatten
+        chunked
+      end
+
+      def each_in_threads(num_threads, flatten = false)
+        in_chunks(num_threads, flatten).map do |chunk|
+          Thread.new do
+            chunk.each do |item|
+              yield item
+            end
+          end
+        end.each(&:join)
+      end
+    end
+  end
+end

data/lib/toptranslation_cli/version.rb

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

data/toptranslation_cli.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Maintain your gem's version:
+require 'toptranslation_cli/version'
+
+Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
+  s.name                  = 'toptranslation_cli'
+  s.version               = ToptranslationCli::VERSION
+  s.summary               = 'Toptranslation command line client'
+  s.description           = 'A gem for synching local files with Toptranslation translation service.'
+  s.authors               = ['Toptranslation GmbH']
+  s.email                 = 'tech@toptranslation.com'
+  s.files                 = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir                = 'exe'
+  s.executables           = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.homepage              = 'https://developer.toptranslation.com'
+  s.license               = 'MIT'
+  s.metadata              = { 'source_code_uri' => 'https://github.com/Toptranslation/tt_cli' }
+  s.required_ruby_version = '>= 2.3'
+
+  s.add_runtime_dependency 'pastel', '~> 0.7'
+  s.add_runtime_dependency 'thor', '~> 0.20'
+  s.add_runtime_dependency 'toptranslation_api', '~> 2.5'
+  s.add_runtime_dependency 'tty-progressbar', '~> 0.17'
+  s.add_runtime_dependency 'tty-prompt', '~> 0.16'
+  s.add_runtime_dependency 'tty-spinner', '~> 0.8'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'rubocop', '~> 0.74.0'
+  s.add_development_dependency 'rubocop-rspec', '~> 1.35.0'
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: toptranslation_cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Toptranslation GmbH
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: toptranslation_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.35.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.35.0
+description: A gem for synching local files with Toptranslation translation service.
+email: tech@toptranslation.com
+executables:
+- tt
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exe/tt
+- lib/toptranslation_cli.rb
+- lib/toptranslation_cli/check.rb
+- lib/toptranslation_cli/configuration.rb
+- lib/toptranslation_cli/file_finder.rb
+- lib/toptranslation_cli/info.rb
+- lib/toptranslation_cli/initializer.rb
+- lib/toptranslation_cli/placeholder_path.rb
+- lib/toptranslation_cli/pull.rb
+- lib/toptranslation_cli/push.rb
+- lib/toptranslation_cli/status.rb
+- lib/toptranslation_cli/threaded.rb
+- lib/toptranslation_cli/version.rb
+- toptranslation_cli.gemspec
+homepage: https://developer.toptranslation.com
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/Toptranslation/tt_cli
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Toptranslation command line client
+test_files: []