tolq-parsers-xliff 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 024c991a661bf8c6d41da6fb6d191c182305d65a
+  data.tar.gz: 4947037b715d563dda83289aa56e3ddd980d20a9
+SHA512:
+  metadata.gz: 161d131f4accca1be730f0391cae7d986d90ce5775a905398b1ceb33f49bc921ba487dbbe6c33ac89d7863bfa45c489ac193f5b5cc0e698de7d7a898590293e7
+  data.tar.gz: bf54f6c354a4e6699612c119ef7b5214eb9be5ecce09a6950fef8ddca2bf766bd3eb905f722de334ec70b58e244669607755de4f95ce47b596d234728dea6893

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# 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 timonv@gmail.com. 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

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xliff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Timon Vonk
+
+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,63 @@
+# Tolq::Parsers::Xliff
+
+This parser parses xliff to and from the Tolq api format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tolq-parsers-xliff'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tolq-parsers-xliff
+
+## Usage
+
+TODO: Write binary instructions
+
+Currently only parsing _to_ the tolq format is supported.
+
+Example:
+
+```ruby
+xliff = File.open("myxliff.xlf", "rb", &:read)
+parser = Tolq::Parsers::Xliff::Parser.new(quality: 'standard').parser.parse(xliff)
+```
+
+## Development
+
+Pointers:
+
+* Keep in-code documentation up to date, document all public methods, and use YARD
+* Write y'r tests
+* Keep readme up to date
+* Make PRs, not war
+
+TODO
+
+## Todo
+
+Many things are left to do:
+
+* Support multiple xlif 'files'
+* Preserve metadata that is not relevant for Tolq
+* Support custom options like callback url, context, name, and so on
+* Deal with existing translations if any
+* Write a proper binary
+* Support unparsing from tolq format back to Xliff
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tolq/parsers/xliff. 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

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/tolq_xliff

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Stub file, not meant for production usage
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'tolq-parsers-xliff'
+
+xliff = ARGF.read
+puts Tolq::Parsers::Xliff::Parser.new(quality: "standard").parse(xliff)

data/lib/tolq-parsers-xliff.rb

@@ -0,0 +1,10 @@
+require 'xliffer'
+
+Dir[File.dirname(__FILE__) + '/xliff/*.rb'].each {|file| require file }
+
+module Tolq
+  module Parsers
+    module Xliff
+    end
+  end
+end

data/lib/xliff/parser.rb

@@ -0,0 +1,45 @@
+module Tolq::Parsers::Xliff
+  class Parser
+
+    # Creates a new Xliff parser
+    #
+    # @param quality [Symbol] the Tolq quality to order in, one of `:basic`, `:standard`, `:professional` or `:expert`
+    # @return [Tolq::Parsers::Xliff::Parser] a parser ready to parse an xliff text
+    def initialize(quality:)
+      @quality = quality
+    end
+
+    # Parses an Xliff text
+    #
+    # @param xliff_text [String] the xlif format text to parse
+    # @return [Hash] A hash suitable to be converted to json for the Tolq Api
+    def parse(xliff_text)
+      xliff = XLIFFer::XLIFF.new(xliff_text)
+      file = xliff.files.first
+      request_data = extract_request_data_from_file(file)
+
+      {
+        "request" => request_data,
+        "source_language_code" => strip_region_language(file.source_language),
+        "target_language_code" => strip_region_language(file.target_language),
+        "quality" => @quality.to_s
+      }
+    end
+
+    private
+
+    def extract_request_data_from_file(xliff_file)
+      xliff_file.strings.inject({}) do |acc, string|
+        acc[string.id] = {"text" => string.source }
+        if string.note.length > 0
+          acc[string.id].merge!("translator_message" => string.note)
+        end
+        acc
+      end
+    end
+
+    def strip_region_language(language)
+      language[0..1]
+    end
+  end
+end

data/lib/xliff/version.rb

@@ -0,0 +1,7 @@
+module Tolq
+  module Parsers
+    module Xliff
+      VERSION = "0.1.0"
+    end
+  end
+end

data/tolq-parsers-xliff.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xliff/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tolq-parsers-xliff"
+  spec.version       = Tolq::Parsers::Xliff::VERSION
+  spec.authors       = ["Timon Vonk"]
+  spec.email         = ["timonv@gmail.com"]
+
+  spec.summary       = %q{Parses Xliff to the Tolq json api format and back}
+  spec.description   = %q{Parses Xliff to the Tolq json api format and back}
+  spec.homepage      = "https://github.com/tolq/parsers/xliff"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "xliffer"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: tolq-parsers-xliff
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timon Vonk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xliffer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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'
+description: Parses Xliff to the Tolq json api format and back
+email:
+- timonv@gmail.com
+executables:
+- tolq_xliff
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/tolq_xliff
+- lib/tolq-parsers-xliff.rb
+- lib/xliff/parser.rb
+- lib/xliff/version.rb
+- tolq-parsers-xliff.gemspec
+homepage: https://github.com/tolq/parsers/xliff
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Parses Xliff to the Tolq json api format and back
+test_files: []