flutter_polyglot_cli 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e0f887cd9f71ec8c78e02f6e91cdea499513dd6832476cb84182331d70a9945
+  data.tar.gz: a9638484acba81bb61e4450428a75e51ef96857d149062c35b360b638572dd7f
+SHA512:
+  metadata.gz: d6deee52b4e90c401455f672407e3377c9a211afda52cb50527e38a2c1a3511004d9541bb49d3b54de0de3c24abdc48b0fed85c0a2353d51ecf9edacd471c6da
+  data.tar.gz: e3013e19e2080dd5e1d6931a3b30b4ade0cff28f9add1e7c07f2f6437b5306e9c9c17d1c7718aaea08b07236f15b83e9e586b9b7361e9d760c72ace4e0f03b65

data/.gitignore

@@ -0,0 +1,129 @@
+
+# Created by https://www.gitignore.io/api/ruby,xcode,macos,visualstudiocode
+# Edit at https://www.gitignore.io/?templates=ruby,xcode,macos,visualstudiocode
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+
+### Xcode ###
+# Xcode
+# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
+
+## User settings
+xcuserdata/
+
+## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)
+*.xcscmblueprint
+*.xccheckout
+
+## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)
+DerivedData/
+*.moved-aside
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+
+### Xcode Patch ###
+*.xcodeproj/*
+!*.xcodeproj/project.pbxproj
+!*.xcodeproj/xcshareddata/
+!*.xcworkspace/contents.xcworkspacedata
+/*.gcno
+**/xcshareddata/WorkspaceSettings.xcsettings
+
+# End of https://www.gitignore.io/api/ruby,xcode,macos,visualstudiocode

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    flutter_polyglot_cli (1.0.0)
+      activesupport
+      commander
+      json_api_client
+      osx_keychain
+      tty-prompt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    RubyInline (3.12.5)
+      ZenTest (~> 4.3)
+    ZenTest (4.12.0)
+    activemodel (6.0.0)
+      activesupport (= 6.0.0)
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    commander (4.4.7)
+      highline (~> 2.0.0)
+    concurrent-ruby (1.1.5)
+    equatable (0.6.1)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    highline (2.0.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    json_api_client (1.16.1)
+      activemodel (>= 3.2.0)
+      activesupport (>= 3.2.0)
+      addressable (~> 2.2)
+      faraday (~> 0.15, >= 0.15.2)
+      faraday_middleware (~> 0.9)
+      rack (>= 0.2)
+    method_source (0.9.2)
+    minitest (5.12.2)
+    multipart-post (2.1.1)
+    necromancer (0.5.0)
+    osx_keychain (1.0.2)
+      RubyInline (~> 3)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.1)
+    rack (2.0.7)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tty-color (0.5.0)
+    tty-cursor (0.7.0)
+    tty-prompt (0.19.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.6.0)
+    tty-reader (0.6.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
+    tty-screen (0.7.0)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    wisper (2.0.1)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  flutter_polyglot_cli!
+  pry-byebug
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Filip Gulan
+
+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,72 @@
+
+# Flutter Polyglot CLI
+
+Polyglot client for Flutter development
+
+## Installation
+
+To install polyflut simply run:
+
+    gem install flutter_polyglot_cli
+
+If you have any issues with above command, please consult this [thread](https://stackoverflow.com/questions/2119064/sudo-gem-install-or-gem-install-and-gem-locations).
+
+You can check if everything is OK running:
+
+    polyflut --help
+
+You should see output with all commands and their description.
+
+## Usage
+
+### Login
+
+You will have to login with your Infinum ID if you want to use polyglot:
+
+    polyflut login
+
+If your login action is successful, polyglot will ask you to access Keychain. There it will save your access token, so you don’t have to enter your credentials every time when you use `polyflut` command.
+
+### Setup
+
+To setup polyglot in your Xcode project use:
+
+    polyflut init
+
+It will prompt you with project list to select one you are setting up. You can provide source language (Swift/ObjC), translations path and resources path. It will create `polyglot.yml` file which you can edit later and add additional Polyglot projects.
+
+Also, you can pass optional parameter `--query` or `-q`. It will prompt you with a list of all projects that match specified query.
+
+### Projects
+
+If you want to see all polyglot projects and their `IDs` enter:
+
+    polyflut projects
+
+Also, you can pass optional parameter `--query` or `-q`. It will prompt you with a list of all projects that match specified query.
+
+### Pull
+
+Finally, to fetch translations use:
+
+    $ polyflut pull
+
+This will generate a Localization folder in which you will have a Localization class, Localization Delegate, Localization Keys files and an initialize_i18n folder with `.messages` files. This will also create `.arb` files which contain key-value pairs for each language. 
+
+### Usage
+
+After all the files are generated, all you need to do is add Locales to `supportedLocales` property and add `LocalizationDelegate` to `localizationsDelegates` property of your `MaterialApp`. For iOS, you need to set supported locales in project configuration under the info tab.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/infinum/flutter-polyglot-cli.
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'flutter_polyglot_cli'
+
+# 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
+“

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/exe/polyflut

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander'
+require 'commander/import'
+require 'flutter_polyglot_cli'
+
+program :name, 'polyflut'
+program :version, PolyglotFlutter::VERSION
+program :description, 'An Flutter client for managing polyflut\'s translations.'
+
+command :login do |c|
+  c.syntax = 'polyflut login'
+  c.description = 'Fetches and writes your token to the keychain using the email and password you provide.'
+  c.action do
+    PolyglotFlutter::ErrorHandler.rescuable do
+      PolyglotFlutter::Command::Login.init
+    end
+  end
+end
+
+command :init do |c|
+  c.syntax = 'polyflut init [options]'
+  c.description = 'Sets up a polyflut.yml config for selected project.'
+  c.option '--query STRING', String, 'Only show projects which name matches query string.'
+  c.action do |_args, options|
+    PolyglotFlutter::ErrorHandler.rescuable do
+      PolyglotFlutter::Command::Setup.init(options)
+    end
+  end
+end
+
+command :projects do |c|
+  c.syntax = 'polyflut projects [options]'
+  c.description = 'Lists all available polyflut projects with their IDs.'
+  c.option '--query STRING', String, 'Only show projects which name matches query string.'
+  c.action do |_args, options|
+    PolyglotFlutter::ErrorHandler.rescuable do
+      PolyglotFlutter::Command::Projects.init(options)
+    end
+  end
+end
+
+command :pull do |c|
+  c.syntax = 'polyflut pull'
+  c.description = 'Pulls all translations from Polyglot and generates necessary files'
+  c.action do |_args, _options|
+    PolyglotFlutter::ErrorHandler.rescuable do
+      PolyglotFlutter::Command::Pull.init
+    end
+  end
+end

data/flutter-polyglot-cli.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flutter_polyglot_cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'flutter_polyglot_cli'
+  spec.version = PolyglotFlutter::VERSION
+  spec.authors = ['Maroje Marcelic']
+  spec.email = ['maroje.marcelic@infinum.com']
+
+  spec.summary       = 'A CLI for pulling polyglot translations and generating Flutter Source Files'
+  spec.homepage      = 'https://github.com/infinum/flutter-polyglot-cli'
+  spec.license       = 'MIT'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'commander'
+  spec.add_dependency 'json_api_client'
+  spec.add_dependency 'osx_keychain'
+  spec.add_dependency 'tty-prompt'
+end

data/lib/flutter_polyglot_cli/api/base.rb

@@ -0,0 +1,18 @@
+module PolyglotFlutter
+  module Resource
+    class Base < JsonApiClient::Resource
+      extend PolyglotFlutter::Helper::Depaginate
+
+      self.site = 'https://polyglot.infinum.co/api/v2/'
+
+      def self.token(token)
+        self.connection_options = { headers: { 'X-Auth-Token' => token } }
+        self
+      end
+
+      def self.depaginate(opts = {})
+        depaginate_query(where(opts))
+      end
+    end
+  end
+end

data/lib/flutter_polyglot_cli/api/language.rb

@@ -0,0 +1,18 @@
+module PolyglotFlutter
+  module Resource
+    class Language < Base
+      include Helper::General
+
+      def code(use_simple_naming = false)
+        code = locale.downcase
+        return code unless use_simple_naming
+
+        code.split('_').first
+      end
+
+      def clean_name
+        clean_variable_name(name)
+      end
+    end
+  end
+end

data/lib/flutter_polyglot_cli/api/project.rb

@@ -0,0 +1,7 @@
+module PolyglotFlutter
+  module Resource
+    class Project < Base
+      has_one :default_language, class_name: :language
+    end
+  end
+end

data/lib/flutter_polyglot_cli/api/session.rb

@@ -0,0 +1,6 @@
+module PolyglotFlutter
+  module Resource
+    class Session < Base
+    end
+  end
+end

data/lib/flutter_polyglot_cli/api/translation.rb

@@ -0,0 +1,8 @@
+module PolyglotFlutter
+  module Resource
+    class Translation < Base
+      has_one :translation_key
+      has_one :language
+    end
+  end
+end

data/lib/flutter_polyglot_cli/api/translation_key.rb

@@ -0,0 +1,32 @@
+module PolyglotFlutter
+  module Resource
+    class TranslationKey < Base
+      def clean_translation(language)
+        translation_value = name
+        translation = translations.find { |key| key.language.id == language.id }
+        translation_value = translation.value if translation&.value
+        escape_translation(translation_value)
+        if translation_value.include? '%'
+          translation_value = convert_aruments(translation_value)
+        end
+        translation_value
+      end
+
+      private
+
+      def escape_translation(translation)
+        translation
+          .gsub('"', '\\"')
+      end
+
+      def convert_aruments(translation)
+        new_translation = translation
+        translation.scan(/(%\w*)/).each_with_index do |match, index|
+          new_translation = new_translation.sub(match[0], '{arg' + String(index) + '}')
+        end
+
+        new_translation
+      end
+    end
+  end
+end

data/lib/flutter_polyglot_cli/commands/login.rb

@@ -0,0 +1,31 @@
+module PolyglotFlutter
+  module Command
+    class Login
+      include Helper::Terminal
+
+      def self.init
+        new.call
+      end
+
+      def call
+        PolyglotFlutter::IO::Token.write(token)
+      end
+
+      private
+
+      def token
+        prompt.say('Logging into API...')
+        @data = PolyglotFlutter::Resource::Session.create(email: email, password: password)
+        @data.token
+      end
+
+      def email
+        prompt.ask('Email:') { |value| value.validate :email }
+      end
+
+      def password
+        prompt.mask('Password:')
+      end
+    end
+  end
+end

data/lib/flutter_polyglot_cli/commands/projects.rb

@@ -0,0 +1,59 @@
+require 'commander/blank'
+require 'commander/command'
+
+module PolyglotFlutter
+  module Command
+    class Projects
+      include Helper::Terminal
+      include Helper::General
+
+      attr_accessor :options
+
+      def self.init(options = Commander::Command::Options.new)
+        new(options).call
+      end
+
+      def initialize(options = Commander::Command::Options.new)
+        @options = options
+      end
+
+      def call
+        list_projects
+      end
+
+      def filtered_projects
+        projects
+          .select { |key, _id| key[/^(.*?(#{option_query})[^$]*)$/i] }
+          .sort_by { |p| p[0].downcase }
+          .to_h
+      end
+
+      def projects
+        prompt.say('Getting projects...')
+        PolyglotFlutter::Resource::Project.token(token).depaginate.each_with_object({}) do |r, hash|
+          hash[r.name] = r.id
+        end
+      end
+
+      def option_query
+        @option_query ||= @options.__hash__.fetch(:query, '')
+      end
+
+      private
+
+      def list_projects
+        projects = filtered_projects
+        selection = projects
+                    .each_with_object({}) do |project, hash|
+          project_name = project[0]
+          project_id = project[1]
+          display_name = "#{project_name} => #{project_id}"
+          hash[display_name] = project_id
+        end
+        prompt.say("  Name - ID: \n  ----------")
+        selected_id = prompt
+                      .select('', selection)
+      end
+    end
+  end
+end