tolq-parsers-xlsx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4914b8dce4cda89edc16b29f75c30b656a70811
+  data.tar.gz: 91e6d1876611d6a993e741879b4055811dafffa4
+SHA512:
+  metadata.gz: f9b5d81c5532da4ce46fe55e8d6c39e77abb64487ff230ff7efcdef3a6586f3710e04c7cc7824e592bf122fce2cb509e3207f0f3729dd9b19431053b3f6c7d6c
+  data.tar.gz: a6a7c598f2ea09dc19b9b5ed3fa413a61e1290395ad08371a52201e0e2a842dc392df00ec3985b1a427a681908550551a4a119b2c8683d52acff47ff9c478f7b

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

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

data/lib/xlsx/column_helper.rb

@@ -0,0 +1,32 @@
+module Tolq::Parsers::XLSX
+  module ColumnHelper
+    # Converts column to char, zero indexed
+    def self.column_to_char(idx)
+      dividend = idx + 1
+      column_name = ""
+
+      while dividend > 0
+        modulo = (dividend - 1) % 26
+        column_name = (65 + modulo).chr + column_name
+        dividend = (dividend - modulo) / 26
+      end
+
+      column_name
+    end
+
+    # Converts char to column, zero indexed
+    def self.char_to_column(char)
+      char
+        .split('')
+        .reverse
+        .map.with_index { |c,idx| (c.ord - 64) * (26**idx)}
+        .inject(&:+) - 1
+    end
+
+    def self.from_char_notation(key)
+      char, row = key.scan(/([A-Z]+)(\d+)/).first
+      return  row.to_i - 1, ColumnHelper.char_to_column(char)
+    end
+  end
+end
+

data/lib/xlsx/parser.rb

@@ -0,0 +1,93 @@
+module Tolq::Parsers::XLSX
+  class ParseError < StandardError; end
+  class Parser
+
+    # Helper method to convert a XLSX into a annotated hash. Note that format
+    # is different from the Tolq api. It's just a hash.
+    #
+    # @param xlsx_io [IO] String or IO of xlsx
+    # @param parse_opts [Hash] Options for the XLSX parser
+    # @return [Hash] Hash representation of xlsx, i.e. { 'A1' => 'Hello World'
+    def self.to_hash(xlsx_io, **parse_opts)
+      extract_request_data_from_xlsx(xlsx_io, text_node: false)
+    end
+
+    # Creates a new xlsx 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::XLSX::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 xlsx
+    #
+    # @param xlsx_io [IO] A string or IO object to parse
+    # @param parse_opts [Hash] Options for the XLSX parser (i.e. col_sep, quote_char)
+    # @param exclude [Array] List of ranges to exclude in excel notation, i.e. ["A1:A3"]
+    # @return [Hash] A hash suitable to be converted to json for a Tolq api request
+    def parse(xlsx_io, exclude: [], **parse_opts)
+      exclude_ranges = to_numeric_exclude_ranges(exclude)
+      request_data = self.class.extract_request_data_from_xlsx(xlsx_io, exclude_ranges: exclude_ranges)
+      return nil if request_data.empty?
+
+      {
+        "request" => request_data,
+        "source_language_code" => @source_language_code,
+        "target_language_code" => @target_language_code,
+        "quality" => @quality.to_s
+      }
+    end
+
+    private
+
+    def self.extract_request_data_from_xlsx(xlsx_io, text_node: true, exclude_ranges: [])
+      workbook = RubyXL::Parser.parse_buffer(xlsx_io)
+      # TODO Validate single sheet
+      hash = {}
+      row_idx = 0
+      workbook.worksheets.first.each do |row|
+        cell_idx = 0
+        row && row.cells.each do |cell|
+          unless cell.value
+            cell_idx += 1
+            next
+          end
+          if excluded?(cell_idx, row_idx, exclude_ranges)
+            cell_idx += 1
+            next
+          end
+          cell_char = ColumnHelper.column_to_char(cell_idx)
+          if text_node
+            hash["#{cell_char}#{row_idx + 1}"] = { 'text' => cell.value }
+          else
+            hash["#{cell_char}#{row_idx + 1}"] = cell.value
+          end
+          cell_idx += 1
+        end
+        row_idx += 1
+      end
+      hash
+    end
+
+    def self.excluded?(colidx, rowidx, exclude_ranges)
+      !!exclude_ranges.find do |range|
+        from, to = range
+        colidx >= from.last && colidx <= to.last &&
+          rowidx >= from.first && rowidx <= to.first
+      end
+    end
+
+    def to_numeric_exclude_ranges(exclude_arr)
+      exclude_arr.map do |exrange|
+        exrange
+          .split(":")
+          .map { |k| ColumnHelper.from_char_notation(k) }
+      end
+    end
+  end
+end

data/lib/xlsx/unparser.rb

@@ -0,0 +1,33 @@
+module Tolq::Parsers::XLSX
+  # Unparses a tolq response to XLSX suitable
+  class Unparser
+    # Unparses the tolq response
+    #
+    # @param tolq_response [Hash] A parsed response from our api
+    # @return [String] A xlsx formatted string
+    def from_tolq_response(tolq_response, original:, **args)
+      translations = tolq_response['translations'].values.first
+      translate_xlsx(translations, original: original).stream.read
+    end
+
+    # Unparses a translations hash of key => translation
+    #
+    # @param translations [Hash] A hash of translations with key => translation
+    # @return [String] A xlsx formatted string
+    def from_hash(translations, original:, **args)
+      translate_xlsx(translations, original: original).stream.read
+    end
+
+    private
+
+    def translate_xlsx(translations, original:)
+      workbook = RubyXL::Parser.parse_buffer(original)
+      worksheet = workbook.worksheets.first
+      translations.each do |k,v|
+        row, col = ColumnHelper.from_char_notation(k)
+        worksheet[row][col].change_contents(v)
+      end
+      workbook
+    end
+  end
+end

data/lib/xlsx/version.rb

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

data/tolq-parsers-xlsx.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xlsx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tolq-parsers-xlsx"
+  spec.version       = Tolq::Parsers::XLSX::VERSION
+  spec.authors       = ["Timon Vonk"]
+  spec.email         = ["timon@tolq.com"]
+
+  spec.summary       = %q{Parses and unparses between Tolq and xlsx}
+  spec.description   = %q{Parses and unparses between Tolq and xlsx to be used with the Tolq api}
+  spec.homepage      = "https://github.com/tolq/parsers/xlsx"
+  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 'rubyXL'
+  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,141 @@
+--- !ruby/object:Gem::Specification
+name: tolq-parsers-xlsx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Timon Vonk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  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'
+- !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 xlsx 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-xlsx.rb
+- lib/xlsx/column_helper.rb
+- lib/xlsx/parser.rb
+- lib/xlsx/unparser.rb
+- lib/xlsx/version.rb
+- tolq-parsers-xlsx.gemspec
+homepage: https://github.com/tolq/parsers/xlsx
+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 xlsx
+test_files: []