phraseapp_updater 2.1.1 → 3.0.0

data/.circleci/config.yml

@@ -1,98 +0,0 @@
-version: 2.1
-
-executors:
-  ruby:
-    parameters:
-      ruby-version:
-        type: string
-        default: "2.6"
-      gemfile:
-        type: string
-        default: "Gemfile"
-    docker:
-      - image: circleci/ruby:<< parameters.ruby-version >>
-        environment:
-          BUNDLE_JOBS: 3
-          BUNDLE_RETRY: 3
-          BUNDLE_PATH: vendor/bundle
-          RAILS_ENV: test
-          BUNDLE_GEMFILE: << parameters.gemfile >>
-
-jobs:
-  test:
-    parameters:
-      ruby-version:
-        type: string
-    executor:
-      name: ruby
-      ruby-version: << parameters.ruby-version >>
-    parallelism: 1
-    steps:
-      - checkout
-
-      - run:
-          # Remove the non-appraisal gemfile for safety: we never want to use it.
-          name: Prepare bundler
-          command: bundle -v
-
-      - run:
-          name: Compute a gemfile lock
-          command: bundle lock && cp "${BUNDLE_GEMFILE}.lock" /tmp/gem-lock
-
-      - restore_cache:
-          keys:
-            - phraseapp_updater-v2-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
-            - phraseapp_updater-v2
-
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install
-
-      - save_cache:
-          key: phraseapp_updater-v2-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
-          paths:
-            - vendor/bundle
-
-      - run:
-          name: Run rspec
-          command: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
-
-      - store_test_results:
-          path: test_results
-
-  publish:
-    executor: ruby
-    steps:
-       - checkout
-       - run:
-           name: Setup Rubygems
-           command: |
-             mkdir ~/.gem &&
-             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials &&
-             chmod 0600 ~/.gem/credentials
-       - run:
-           name: Publish to Rubygems
-           command: |
-             gem build phraseapp_updater.gemspec
-             gem push phraseapp_updater-*.gem
-
-
-workflows:
-  version: 2.1
-  build:
-    jobs:
-      - test:
-          name: 'ruby 2.5'
-          ruby-version: "2.5"
-      - test:
-          name: 'ruby 2.6'
-          ruby-version: "2.6"
-      - publish:
-          requires:
-            - 'ruby 2.5'
-            - 'ruby 2.6'
-          filters:
-            branches:
-              only: master
-            tags:
-              ignore: /.*/

data/.envrc

@@ -1 +0,0 @@
-eval "$(lorri direnv)"

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.3
-before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.markdown

@@ -1,50 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-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.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at kev@bibo.com.ph. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/
-

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in phraseapp_updater.gemspec
-gemspec
-gem 'byebug'
-gem 'rspec_junit_formatter'
-
-gem 'irb', require: false

data/README.markdown

@@ -1,177 +0,0 @@
-# PhraseAppUpdater
-
-[![Build Status](https://travis-ci.org/iknow/phraseapp_updater.svg?branch=master)](https://travis-ci.org/iknow/phraseapp_updater)
-
-**Version** 2.0.0
-
-This is a tool for managing synchronization between locale data in
-[PhraseApp](https://phraseapp.com) and committed in your project. It can perform
-JSON-aware three-way merges with respect to a common ancestor, and maintains a
-record of the common ancestor on PhraseApp using tags.
-
-Our workflow considers localization data stored on PhraseApp to be a working
-copy for a given branch. We expect developers working on the code and
-translators working on PhraseApp to both be able to make changes and have them
-integrated.
-
-PhraseApp provides [APIs](https://phraseapp.com/docs/api/v2/) and a [Ruby
-gem](https://github.com/phrase/phraseapp-ruby) for accessing them, but the API
-only allows either a) completely overwriting PhraseApp's data with local data or
-b) reapplying PhraseApp's data on top of the local data. Neither of these cases
-is appropriate for integrating changes made on both sides.
-
-What we want instead is a three way merge where the committed data wins on
-conflict. Non-conflicting changes on PhraseApp are preserved, while changes to
-the same key on both sides take the committed data. The result of the merge is
-then applied to both sides, keeping them up to date with each other.
-
-This is especially important when removing keys. Imagine we have the
-following, no-longer useful key:
-
-```json
-unused:
-  one: An unused
-```
-
-On PhraseApp, we've added another plural form:
-
-
-```json
-unused:
-  one: An unused
-  zero: No unused's
-```
-
-And in our feature branch, we remove it. The result we want is that the key
-completely disappears, instead of getting a result like either of the above.
-
-## Installation
-
-This gem provides a command line interface for performing the
-merge and uploading the result to PhraseApp. To use it, install the gem:
-
-`gem install phraseapp_updater`
-
-You may also use this gem programatically from your own application.
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'phraseapp_updater'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install phraseapp_updater
-
-## Usage
-
-CLI
----
-
-**Setup**
-
-`phraseapp_updater setup` creates and initializes a PhraseApp project
-corresponding to your branch. It must be provided with the current git revision
-of the branch and the path to the locale files.
-
-```
-phraseapp_updater setup --phraseapp_project_name=<yourbranch> --parent_commit=<yourhash> --phraseapp_api_key=<yourkey> --file-format=json <path_to_locales>
-```
-
-**Synchronize**
-
-`phraseapp_updater synchronize` synchronizes a git remote branch with its
-corresponding PhraseApp project, incorporating changes from each side into the
-other. If both sides were changed, a three-way merge is performed. The result is
-uploaded to PhraseApp and committed and pushed to the git remote as appropriate.
-
-The option `--no_commit` may be provided to restrict changes to the PhraseApp
-side. If specified, then in the case that the branch was modified, the merge
-result will be uploaded to PhraseApp and the common ancestor updated to the
-branch head.
-
-```
-phraseapp_updater synchronize <checkout_path> --prefix=config/locales --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey>  --file-format=json
-```
-
-**Download**
-
-`phraseapp_updater download` downloads and normalizes locale files from
-PhraseApp, saving them to the specified location. The revision of the recorded
-common ancestor is printed to standard out.
-
-```
-phraseapp_updater download --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey> --file-format=json <target_path>
-```
-
-**Upload**
-
-`phraseapp_updater upload` uploads normalized locale files from your branch to
-PhraseApp and resets the recorded common ancestor to the specified revision.
-
-```
-phraseapp_updater upload --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey> --file-format=json <path_to_locales>
-```
-
-**Update Parent Commit**
-`phraseapp_updater update_parent_commit` records a new common ancestor on
-PhraseApp without changing the locales.
-
-```
-phraseapp_updater update_parent_commit --phraseapp_project_id=<yourid> --phraseapp_api_key=<yourkey> --parent_commit=<yournewhash>
-```
-
-**Merge**
-
-`phraseapp_updater merge` performs a content-aware three-way merge between
-locale files in three directories: `ancestor_path`, `our_path`, and
-`their_path`. In the case of conflicts, the changes from `our_path` are
-accepted. The results are normalized and written to the path specified with
-`to`.
-
-```
-phraseapp_updater merge ancestor_path our_path their_path --to target_path --file-format=json
-```
-
-
-**Diff**
-
-Performs a content-aware diff between locale files in two directories. Returns
-with exit status 1 or 0 to signal differences or no differences respectively
-
-```
-phraseapp_updater diff path1 path2 --file-format=json
-```
-
-## Future Improvements
-
-If you'd like to contribute, these would be very helpful!
-
-* We'd like to use "unverified" translations on PhraseApp as the equivalent of
-  an unstaged working copy. For this to work, we need to be able to recover
-  previous translations at the same key. While PhraseApp doesn't itself keep
-  this history, we could do this by restoring the absent keys from the diff
-  between verified and unverified download from the common ancestor.
-* Expose the changed files on the command line.
-* Checking if PhraseApp files changed during execution before upload, to reduce the race condition window.
-* More specs for the API and shell.
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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`. When everything is working, make a pull request.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/iknow/phraseapp_updater. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,7 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-

data/nix/gem/Gemfile

@@ -1,24 +0,0 @@
-source "https://rubygems.org/"
-
-gem "byebug", "11.0.1"
-gem "coderay", "1.1.2"
-gem "deep_merge", "1.2.1"
-gem "diff-lcs", "1.3"
-gem "hashdiff", "0.4.0"
-gem "io-console", "0.5.4"
-gem "irb", "1.2.1"
-gem "method_source", "0.9.2"
-gem "multi_json", "1.14.1"
-gem "oj", "2.18.5"
-gem "parallel", "1.19.1"
-gem "phraseapp-ruby", "1.6.0"
-gem "pry", "0.12.2"
-gem "rake", "10.5.0"
-gem "reline", "0.1.2"
-gem "rspec", "3.8.0"
-gem "rspec-core", "3.8.0"
-gem "rspec-expectations", "3.8.3"
-gem "rspec-mocks", "3.8.0"
-gem "rspec-support", "3.8.0"
-gem "rspec_junit_formatter", "0.4.1"
-gem "thor", "0.20.3"

data/nix/gem/Gemfile.lock

@@ -1,68 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    byebug (11.0.1)
-    coderay (1.1.2)
-    deep_merge (1.2.1)
-    diff-lcs (1.3)
-    hashdiff (0.4.0)
-    io-console (0.5.4)
-    irb (1.2.1)
-      reline (>= 0.0.1)
-    method_source (0.9.2)
-    multi_json (1.14.1)
-    oj (2.18.5)
-    parallel (1.19.1)
-    phraseapp-ruby (1.6.0)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    reline (0.1.2)
-      io-console (~> 0.5)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rspec_junit_formatter (0.4.1)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    thor (0.20.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug (= 11.0.1)
-  coderay (= 1.1.2)
-  deep_merge (= 1.2.1)
-  diff-lcs (= 1.3)
-  hashdiff (= 0.4.0)
-  io-console (= 0.5.4)
-  irb (= 1.2.1)
-  method_source (= 0.9.2)
-  multi_json (= 1.14.1)
-  oj (= 2.18.5)
-  parallel (= 1.19.1)
-  phraseapp-ruby (= 1.6.0)
-  pry (= 0.12.2)
-  rake (= 10.5.0)
-  reline (= 0.1.2)
-  rspec (= 3.8.0)
-  rspec-core (= 3.8.0)
-  rspec-expectations (= 3.8.3)
-  rspec-mocks (= 3.8.0)
-  rspec-support (= 3.8.0)
-  rspec_junit_formatter (= 0.4.1)
-  thor (= 0.20.3)
-
-BUNDLED WITH
-   1.17.3

data/nix/gem/gemset.nix

@@ -1,230 +0,0 @@
-{
-  byebug = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1mmkls9n56l4gx2k0dnyianwz36z2zgpxli5bpsbr7jbw7hn2x6j";
-      type = "gem";
-    };
-    version = "11.0.1";
-  };
-  coderay = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "15vav4bhcc2x3jmi3izb11l4d9f3xv8hp2fszb7iqmpsccv1pz4y";
-      type = "gem";
-    };
-    version = "1.1.2";
-  };
-  deep_merge = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1q3picw7zx1xdkybmrnhmk2hycxzaa0jv4gqrby1s90dy5n7fmsb";
-      type = "gem";
-    };
-    version = "1.2.1";
-  };
-  diff-lcs = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "18w22bjz424gzafv6nzv98h0aqkwz3d9xhm7cbr1wfbyas8zayza";
-      type = "gem";
-    };
-    version = "1.3";
-  };
-  hashdiff = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1ncwxv7jbm3jj9phv6dd514463bkjwggxk10n2z100wf4cjcicrk";
-      type = "gem";
-    };
-    version = "0.4.0";
-  };
-  io-console = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "109yzpv9kslwra2mxnjsg3r6mwxkbqmxihj266qdvccapghi05wg";
-      type = "gem";
-    };
-    version = "0.5.4";
-  };
-  irb = {
-    dependencies = ["reline"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1r1y8i46qd5izdszzzn5jxvwvq00m89rk0hm8cs8f21p7nlwmh5w";
-      type = "gem";
-    };
-    version = "1.2.1";
-  };
-  method_source = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1pviwzvdqd90gn6y7illcdd9adapw8fczml933p5vl739dkvl3lq";
-      type = "gem";
-    };
-    version = "0.9.2";
-  };
-  multi_json = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0xy54mjf7xg41l8qrg1bqri75agdqmxap9z466fjismc1rn2jwfr";
-      type = "gem";
-    };
-    version = "1.14.1";
-  };
-  oj = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1jli4mi1xpmm8564pc09bfvv7znzqghidwa3zfw21r365ihmbv2p";
-      type = "gem";
-    };
-    version = "2.18.5";
-  };
-  parallel = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "12jijkap4akzdv11lm08dglsc8jmc87xcgq6947i1s3qb69f4zn2";
-      type = "gem";
-    };
-    version = "1.19.1";
-  };
-  phraseapp-ruby = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "14n2hhwjn32xk0qk6rprs3awnrddhnd4zckyd0a4j8lv8k648pnn";
-      type = "gem";
-    };
-    version = "1.6.0";
-  };
-  pry = {
-    dependencies = ["coderay" "method_source"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "00rm71x0r1jdycwbs83lf9l6p494m99asakbvqxh8rz7zwnlzg69";
-      type = "gem";
-    };
-    version = "0.12.2";
-  };
-  rake = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0jcabbgnjc788chx31sihc5pgbqnlc1c75wakmqlbjdm8jns2m9b";
-      type = "gem";
-    };
-    version = "10.5.0";
-  };
-  reline = {
-    dependencies = ["io-console"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0908ijrngc3wkn5iny7d0kxkp74w6ixk2nwzzngplplfla1vkp8x";
-      type = "gem";
-    };
-    version = "0.1.2";
-  };
-  rspec = {
-    dependencies = ["rspec-core" "rspec-expectations" "rspec-mocks"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "15ppasvb9qrscwlyjz67ppw1lnxiqnkzx5vkx1bd8x5n3dhikxc3";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec-core = {
-    dependencies = ["rspec-support"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1p1s5bnbqp3sxk67y0fh0x884jjym527r0vgmhbm81w7aq6b7l4p";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec-expectations = {
-    dependencies = ["diff-lcs" "rspec-support"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1c4gs5ybf7km0qshdm92p38zvg32n1j2kr5fgs2icacz7xf2y6fy";
-      type = "gem";
-    };
-    version = "3.8.3";
-  };
-  rspec-mocks = {
-    dependencies = ["diff-lcs" "rspec-support"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "06y508cjqycb4yfhxmb3nxn0v9xqf17qbd46l1dh4xhncinr4fyp";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec-support = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "0p3m7drixrlhvj2zpc38b11x145bvm311x6f33jjcxmvcm0wq609";
-      type = "gem";
-    };
-    version = "3.8.0";
-  };
-  rspec_junit_formatter = {
-    dependencies = ["rspec-core"];
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1aynmrgnv26pkprrajvp7advb8nbh0x4pkwk6jwq8qmwzarzk21p";
-      type = "gem";
-    };
-    version = "0.4.1";
-  };
-  thor = {
-    groups = ["default"];
-    platforms = [];
-    source = {
-      remotes = ["https://rubygems.org"];
-      sha256 = "1yhrnp9x8qcy5vc7g438amd5j9sw83ih7c30dr6g6slgw9zj3g29";
-      type = "gem";
-    };
-    version = "0.20.3";
-  };
-}