tolq-parsers-yaml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ca3ceea42b71f7d27d75a0333b8c6ea0c4cc16e
+  data.tar.gz: 5fad9e25350eedff58e0443bfde7cdd6fdeb7613
+SHA512:
+  metadata.gz: a2952d722ac4c130a4dd81dcb6c2ee18becccef5b3231888db52ad280596809868283c0657f7e3be3daf6295058e17b8bea0e8fee092f3b23b9e00572818d6dd
+  data.tar.gz: fdf5f5cd8738868706ec9352b79b8f63036e989cc339dc5223b2882d97a4bbd722ed69f995dcd604268d3b7c8215fd3497a0c39faa9ab753f072725b71d665b7

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 yaml.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,57 @@
+# Yaml
+
+This parser parses yaml to and from the Tolq api format.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tolq-parsers-yaml'
+```
+
+And then execute:
+
+```shell
+  $ bundle
+```
+Or install it yourself as:
+
+```shell
+  $ gem install tolq-parsers-yaml
+```
+
+## Usage
+
+To parse to the tolq format:
+
+```ruby
+yaml = File.open('myyaml.yml', 'rb', &:read)
+parser = Tolq::Parsers::Yaml::Parser.new(quality: 'standard')
+parser.parse(yaml)
+```
+
+And to unparse from the tolq format back to yaml:
+
+```ruby
+unparser = Tolq::Parsers::Yaml::Unparser.new
+unparser.unparse(tolq_api_response)
+```
+## 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
+
+## 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/lib/tolq_parsers_yaml.rb

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

data/lib/yaml/parser.rb

@@ -0,0 +1,60 @@
+module Tolq::Parsers::Yaml
+  class Parser
+
+    # Creates a new Yaml parser
+    #
+    # @param quality [Symbol] the Tolq quality to order in
+    # @param source_language_code [String] The two letter source language code
+    # @param target_language_code [String] The two letter target language code
+    # @return [Tolq::Parsers::Yaml::Parser
+    def initialize(quality:, source_language_code:, target_language_code:)
+      @quality = quality
+      @source_language_code = source_language_code
+      @target_language_code = target_language_code
+    end
+
+    # Parses a YAML text
+    #
+    # @param yaml_text [String] the yaml format text to parse
+    # @return [Hash] A hash suitable to be converted to json for a Tolq api request
+    def parse(yaml_text)
+      request_data = extract_request_data_from_yaml(yaml_text)
+
+      {
+        "request" => request_data,
+        "source_language_code" => @source_language_code,
+        "target_language_code" => @target_language_code,
+        "quality" => @quality.to_s
+      }
+    end
+
+    private
+
+    def extract_request_data_from_yaml(yaml_text)
+      parsed = YAML.load(yaml_text)
+      hash = recursively_extract(strip_root(parsed))
+      hash.inject({}) do |acc, (k,v)|
+        acc[k] = { 'text' => v}
+        acc
+      end
+    end
+
+    def recursively_extract(val, mem={}, prefix="")
+      return mem.update(prefix => val) unless val.is_a?(Hash)
+      val.each do |k,v|
+        prefix = prefix.length > 0 ? prefix + "." : prefix
+        recursively_extract(v, mem, prefix + k.to_s)
+      end
+      mem
+    end
+
+    def strip_root(hash)
+      first_key = hash.keys.first
+      if first_key.to_s.length == 2 && hash[first_key].is_a?(Hash)
+        hash[first_key]
+      else
+        hash
+      end
+    end
+  end
+end

data/lib/yaml/unparser.rb

@@ -0,0 +1,33 @@
+module Tolq::Parsers::Yaml
+  # Unparses a tolq response to YAML suitable for an I18n application
+  class Unparser
+    # Unparses the tolq response
+    #
+    # @param tolq_response [Hash] A parsed response from our api
+    # @return [String] A yaml formatted string
+    def unparse(tolq_response)
+      translations = tolq_response['translations']
+      split = split_keys(translations.values.first)
+      { translations.keys.first => split }.to_yaml
+    end
+
+    private
+
+    # Splits a key like 'a.b.c' into { 'a' => 'b' => 'c' }
+    #
+    # Basically for each key, we split the keys and build the
+    # hash bottom up. Then we pass in the result to the next
+    # key.
+    def split_keys(translations)
+      translations.inject({}) do |acc, (k, v)|
+        keys = k.split('.')
+        deep_merge(acc, keys.reverse.inject(v) { |a, key| { key => a } })
+      end
+    end
+
+    def deep_merge(original, second)
+      merger = Proc.new { |k, x, y| x.is_a?(Hash) ? x.merge(y, &merger) : x || y }
+      original.merge(second, &merger)
+    end
+  end
+end

data/lib/yaml/version.rb

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

data/tolq-parsers-yaml.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tolq-parsers-yaml"
+  spec.version       = Tolq::Parsers::Yaml::VERSION
+  spec.authors       = ["Timon Vonk"]
+  spec.email         = ["timon@tolq.com"]
+
+  spec.summary       = %q{Parses and unparses between Tolq and Yaml}
+  spec.description   = %q{Parses and unparses between Tolq and Yaml to be used with the Tolq api}
+  spec.homepage      = "https://github.com/tolq/parsers/yaml"
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "json"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: tolq-parsers-yaml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timon Vonk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-08 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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 and unparses between Tolq and Yaml to be used with the Tolq api
+email:
+- timon@tolq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tolq_parsers_yaml.rb
+- lib/yaml/parser.rb
+- lib/yaml/unparser.rb
+- lib/yaml/version.rb
+- tolq-parsers-yaml.gemspec
+homepage: https://github.com/tolq/parsers/yaml
+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 and unparses between Tolq and Yaml
+test_files: []
+has_rdoc: