csv-i18n 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdc215a6bbfe2ff220cddf2130169ce331f98451
+  data.tar.gz: dd39f1525b9386d5ee82ca399541467de3cfbb3b
+SHA512:
+  metadata.gz: d62fd817afce55b82cac0a48118381b951444f87e6716866e18fe995e8dc6de3047069cc87ddf8e071ab1f14673160852fde20ac91be3d4833ad74c40a28a425
+  data.tar.gz: c6f317553745597639677a161f9b1274018cffcb7d0e52bd40ae853dd4af33520781a6f41671933f4d43977fa0063303d0c3c153d79763b5eff0c49f2f322583

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeremy Baker
+
+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,50 @@
+# CSV::I18n
+
+This gem makes it possible to translate the parsing error messages returned from the CSV core module using the [I18n](https://github.com/svenfuchs/i18n) library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'csv-i18n'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install csv-i18n
+
+## Usage
+
+### Translations
+
+Once you have installed the gem, you can add your translations to the language files like this:
+
+```yaml
+csv:
+  exception:
+    field_size_exceeded: "Broken on %{line_number}"
+    illegal_quoting: "Illegal quoting in line %{line_number}"
+    missing_or_stray_quote: "Missing or stray quote in line %{line_number}"
+    unclosed_quoted_field: "Unclosed quoted field on line %{line_number}."
+    unquoted_fields_do_not_allow_r_or_n: "Unquoted fields do not allow \\r or \\n (line #{line_number})."
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. 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/jhubert/csv-i18n.
+
+## 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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "csv/i18n"
+
+# 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(__FILE__)

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/csv-i18n.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv_i18n/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv-i18n"
+  spec.version       = CSVI18n::VERSION
+  spec.authors       = ["Jeremy Baker"]
+  spec.email         = ["jhubert@gmail.com"]
+
+  spec.summary       = %q{Support translation of CSV parsing errors via I18n}
+  spec.homepage      = "https://github.com/jhubert/csv-i18n"
+  spec.license       = "MIT"
+
+  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.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/csv_i18n/ext.rb

@@ -0,0 +1,46 @@
+module CSVI18n
+  module Ext
+    # Redefine the shift method to catch the exception and attempt to return
+    # a translated version of the error message using I18n.t
+    def shift
+      super
+    rescue ::CSV::MalformedCSVError => exception
+      raise $!, translated_exception_message(exception.message), $!.backtrace
+    end
+
+    private
+
+    # Parse the exception message and attempt to translate it. If no translation
+    # is possible, simply return the original error message.
+    #
+    # The translation keys need to be defined in your language files as follows.
+    #
+    #  csv:
+    #    exception:
+    #      field_size_exceeded: "Broken on %{line_number}"
+    #      illegal_quoting:
+    #      missing_or_stray_quote:
+    #      unclosed_quoted_field:
+    #      unquoted_fields_do_not_allow_r_or_n:
+    #
+    def translated_exception_message(msg)
+      return msg unless defined?(I18n)
+
+      # This will break if the CSV class changes it's error messages
+      matches = msg.match(/\s[ion]{2}?\s?\(?line (\d)\)?\.?/i)
+      return msg if matches.nil?
+
+      ::I18n.translate(
+        keyify(msg.sub(matches[0], '')),
+        scope: [:csv, :exception],
+        line_number: matches[1],
+        default: msg
+      )
+    end
+
+    # :reek:UtilityFunction but could use parameterize('_') if rails is present
+    def keyify(msg)
+      msg.gsub(/[^a-z]+/i, ' ').strip.gsub(' ', '_').downcase
+    end
+  end
+end

data/lib/csv_i18n/version.rb

@@ -0,0 +1,3 @@
+module CSVI18n
+  VERSION = "0.1.0"
+end

data/lib/csv_i18n.rb

@@ -0,0 +1,5 @@
+require 'csv'
+require 'csv_i18n/ext'
+require 'csv_i18n/version'
+
+CSV.prepend CSVI18n::Ext

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: csv-i18n
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Baker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 
+email:
+- jhubert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- csv-i18n.gemspec
+- lib/csv_i18n.rb
+- lib/csv_i18n/ext.rb
+- lib/csv_i18n/version.rb
+homepage: https://github.com/jhubert/csv-i18n
+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: Support translation of CSV parsing errors via I18n
+test_files: []