utcd 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1999018864ed7a8696ffd804a3450f4d65a2fde7c888642263fda60ebd91a42f
+  data.tar.gz: 9572f56a6cf25e71d46d5ef8f0288df9f64fb83a4b6eeb4c4353e95085ba2dbc
+SHA512:
+  metadata.gz: 47e0bd79c416f75f84a1490b6ee8570688f1d580b46e086a00d0476d5bf6d13b42ef2593efb5101fff9b343c0acb04abe84259fe60aa8572e47ee0805edda0e7
+  data.tar.gz: 21cc114231f130cea92d05b21a5de8df42619ff71a26e9c70149be6bf0c6a64b67ce6e3754ac92973dd8ea39664a356053001d213dab555f79a50943e5b0534b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+LocalizableFiles/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,116 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RefinementImportMethods: # new in 1.27
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+Naming/BlockForwarding: # new in 1.24
+  Enabled: true
+Security/CompoundHash: # new in 1.28
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/FetchEnvVar: # new in 1.28
+  Enabled: true
+Style/FileRead: # new in 1.24
+  Enabled: true
+Style/FileWrite: # new in 1.24
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MapToHash: # new in 1.24
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NestedFileDirname: # new in 1.26
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/ObjectThen: # new in 1.28
+  Enabled: true
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantInitialize: # new in 1.27
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.4
+before_install: gem install bundler -v 2.1.4

data/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "ruby-debug",
+            "request": "launch",
+            "name": "Launch File",
+            "program": "${workspaceFolder}/lib/utcd.rb",
+            "programArgs": [],
+            "useBundler": false
+        }
+    ]
+}

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in utcd.gemspec
+gemspec
+
+gem 'apfel'
+gem 'graphql-client'
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'rest-client', '~> 2.0'

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    utcd (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    apfel (0.0.5)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    graphql (2.0.11)
+    graphql-client (0.18.0)
+      activesupport (>= 3.0)
+      graphql
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.2)
+    netrc (0.11.0)
+    rake (12.3.3)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apfel
+  graphql-client
+  rake (~> 12.0)
+  rest-client (~> 2.0)
+  rspec (~> 3.0)
+  utcd!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Rodrigo
+
+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,25 @@
+# Utcd
+This gem will allow you to handle your localizable files stored and shared on a private server. Allowing anyone on your team to edit them and share them with you.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utcd'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install utcd
+
+## Usage
+Search in ~/.rvm/gemsets/global.gems
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :test do
+  bundle exec 'rspec'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'utcd'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/api.rb

@@ -0,0 +1,59 @@
+require 'graphql/client'
+require 'graphql/client/http'
+require_relative 'queries'
+require 'rest_client'
+require_relative 'tools'
+
+module API
+  extend self
+  extend Queries
+  extend Tools
+
+  def check_server_locales
+    # Execute the query
+    result = Queries::Client.query(Queries::RetrieveAllLocales)
+    # Check for errors
+    raise result.errors.first.message if result.errors.any?
+    # Print array of locales
+    puts "________ LOCALES ON SERVER ________"
+    puts result.data.all_locales.map { |locale| "- #{locale}" }
+  end
+
+  def check_server_locales_for_platform(platform)
+    # Execute the query
+    result = Queries::Client.query(Queries::RetrieveAllLocalesForPlatform, variables: {platform: platform})
+    # Check for errors
+    raise result.errors.first.message if result.errors.any?
+    # Print array of locales
+    puts "________ LOCALES ON SERVER: #{platform.upcase}________"
+    puts result.data.all_locales_for_platform.map { |locale| "- #{locale}" }
+  end
+
+  def upload_server_locale_file(path, platform, locale)
+    url = "#{Constants::BASE_URI}/upload?folder=#{platform}/#{locale}"
+    response = RestClient.post url, {:file => File.new(path, "rb"), :multipart => true}
+    return response.gsub(/\"/, '').split('/').last
+  end
+
+  def download_server_locale_file(path)
+    url = "http://localhost:8080/files#{path}"
+    result = RestClient.get url
+    return result
+  end
+
+  def create_segment_on_server(file_name, locale)
+    # Execute the query
+    result = Queries::Client.query(Queries::CreateSegment, variables: {language: locale, platform: platform, fileName: file_name})
+    # Check for errors
+    raise result.errors.first.message if result.errors.any?
+  end
+
+  def retrieve_server_translations_for_locale(locale)
+    # Execute the query
+    result = Queries::Client.query(Queries::RetrieveTranslationsForLocale, variables: {platform: platform, locale: locale})
+    # Check for errors
+    raise result.errors.first.message if result.errors.any?
+    # Return array of paths
+    return result.data.find_translations_for_locale.map { |translation|  create_path_from_segment(translation)  }
+  end
+end

data/lib/constants.rb

@@ -0,0 +1,4 @@
+module Constants
+    extend self
+    BASE_URI = 'http://localhost:8080'
+end

data/lib/network.rb

@@ -0,0 +1,18 @@
+require_relative 'constants'
+
+module Network
+    extend self
+    extend Constants
+
+    HTTP = GraphQL::Client::HTTP.new("#{Constants::BASE_URI}/graphql") do
+        def headers(_context)
+          { 'User-Agent': 'My Client' }
+        end
+      end
+
+      Schema = GraphQL::Client.load_schema('./schema.json')
+
+      def create_schema
+        GraphQL::Client.dump_schema(Network::HTTP, './schema.json')
+      end
+end

data/lib/queries.rb

@@ -0,0 +1,49 @@
+require_relative 'network'
+
+module Queries
+  extend Network
+  extend self
+
+    Client = GraphQL::Client.new(schema: Network::Schema, execute: Network::HTTP)
+
+    RetrieveAllLocales = Client.parse <<-'GRAPHQL'
+        query {
+            allLocales
+        }
+        GRAPHQL
+
+   RetrieveAllLocalesForPlatform = Client.parse <<-'GRAPHQL'
+        query($platform: String!) {
+            allLocalesForPlatform(input: { platform: $platform })
+        }
+        GRAPHQL
+
+    CreateSegment = Client.parse <<-'GRAPHQL'
+        mutation (
+            $language: String!
+            $platform: String!
+            $fileName: String!
+        ) {
+            createTranslation(
+                input: { language: $language, platform: $platform, fileName: $fileName }
+            ) {
+                id
+                language
+                platform
+                fileName
+            }
+        }
+        GRAPHQL
+
+    RetrieveTranslationsForLocale = Client.parse <<-'GRAPHQL'
+        query ($platform: String!, $locale: String!) {
+            findTranslationsForLocale(input: { platform: $platform, locale: $locale }) {
+                id
+                language
+                platform
+                fileName
+            }
+        }
+        GRAPHQL
+
+end

data/lib/tools.rb

@@ -0,0 +1,64 @@
+module Tools
+  extend self
+
+  def retrieve_localizable_folder_path
+    localizable_file_path = Dir.glob("#{Dir.pwd}/**/*#{platform_extension}").first
+    return nil if localizable_file_path.nil?
+
+    localizable_file_path.gsub(%r{/[^/]+$}, '')
+  end
+
+  def retrieve_files_in_locale(locale)
+    localizable_folder_path = retrieve_localizable_folder_path
+    return nil if localizable_folder_path.nil?
+
+    Dir.glob("#{localizable_folder_path}/#{locale}#{platform_extension}/*.strings")
+  end
+
+  def retrieve_locales
+    languages = Dir.glob("#{Dir.pwd}/**/*#{platform_extension}")
+    languages.map { |language| language.split('/').last.split('.').first }
+  end
+
+  def read_localizable_file(file)
+    Apfel.parse(file).key_values
+  end
+
+  def status
+    locales = retrieve_locales
+    puts 'Used locales:'
+    for locale in locales
+      files_in_locale = Dir.glob("#{retrieve_localizable_folder_path}/#{locale}.lproj/*.strings")
+      puts "\n_______________ #{locale.upcase} _______________"
+      for file in files_in_locale
+        puts " #{file.split('/').last}"
+      end
+    end
+  end
+
+  def platform
+    ios_folder = Dir.glob("#{Dir.pwd}/**/*#{'.lproj'}").first
+    unless ios_folder.nil?
+        return "ios"
+    end
+
+    android_folder =  Dir.glob("#{Dir.pwd}/**/*#{'.android'}").first
+    unless android_folder.nil?
+        return "android"
+    end
+
+    raise Error, 'No localizable files in project' if localizable_file_path.nil?
+  end
+
+  def platform_extension
+    platform == 'ios' ? '.lproj' : '.android'
+  end
+
+  def create_path_from_segment(segment)
+    "/#{segment.platform}/#{segment.language}/#{segment.file_name}"
+  end
+
+  def write_to_file(path, content)
+    File.open(path, 'w') { |file| file.write(content) }
+  end
+end

data/lib/utcd/version.rb

@@ -0,0 +1,3 @@
+module Utcd
+  VERSION = '0.2.0'.freeze
+end

data/lib/utcd.rb

@@ -0,0 +1,41 @@
+require 'utcd/version'
+require_relative 'tools'
+require_relative 'api'
+require 'apfel'
+
+module Utcd
+  extend Tools
+  extend API
+
+  def self.push(locale)
+    # 1º. Check that the locale folder is not empty
+    files = retrieve_files_in_locale(locale)
+    if files.nil? || files.empty? then
+        puts "No files found for locale #{locale}"
+    end
+
+    # 2. Upload synchronously all files in the locale folder
+    current_platform = platform
+    puts "Uploading files for locale #{locale}"
+    for file_path in files
+        file_path = upload_server_locale_file(file_path, platform, locale)
+        create_segment_on_server(file_path, locale)
+        puts "- #{file_path}"
+    end
+  end
+
+  def self.pull(locale)
+    # 1. Get all server files for chosen locale
+    server_files = retrieve_server_translations_for_locale(locale)
+
+    # 2. Download synchronously all files and swap them with local files
+    puts "Updating files for locale #{locale}"
+    for file in server_files
+        content = download_server_locale_file(file)
+        file_name = file.split('/').last
+        folder_path = "#{retrieve_localizable_folder_path}/#{locale}#{platform_extension}/#{file_name}"
+        write_to_file(folder_path, content)
+        puts " - #{locale}#{platform_extension}/#{file_name}"
+    end
+  end
+end