anvl-converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d07e26a4986332542f86866a21504c4d81978a99
+  data.tar.gz: c257c697c0af18b8df1e95136e121849fad58442
+SHA512:
+  metadata.gz: 82ebde4c91d00dc847e9fd0b23ae42a509f8a8ba348a0c266c828faaf50c403c99dfd3a97b6e9c132b95715767edc2a2d239dbcddc385981028d9380b0a5f369
+  data.tar.gz: 836613db75915e1c2fb514cdae24fa393636771924058373595a4e64a29cefc11b887df86dbec3dd701b6481b1a815ac4fd119a10720b4d9c4dd45d37e0171c2

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.DS_Store
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+- 2.4.1
+addons:
+  code_climate:
+    repo_token: "$CODECLIMATE_REPO_TOKEN"
+install:
+- travis_retry bundle install
+script:
+- bundle exec rspec
+- bundle exec codeclimate-test-reporter || true
+notifications:
+  email: false
+deploy:
+  provider: rubygems
+  api_key:
+    secure: BMX2JmLCio7KJm3coR6Jz5/ygERi7oAL4xSNhNffQMcHa6cZn06HpNjMWVtU/TFouI3AN+tAVpe9RIoLpCEYCPfXDholi1AoGIDhaxDG+PopnTsGJUchs9xpsyaOZcqdNRl55EBEozm28qVCQDmJbket2vaiguUI/Scf+fNTuslK3azz8r4slpl+4PxiaZRuoCnN0YGI3pdG41jfuoEWY2YJlgShkXiYiUdeKtEjzGUgN/ky6GYxVx53rd0AtBlblYfa3KjTR0/8j4/ej/duWiXW4XRpsEJNL9NZDdFJ2WoLG8M71K8DSn7dHFx9V2cK0J92kGZUCfIZWt4SmtAYvyPu3hw690ORJubNRSNe/uMIx4E10L1YbXQL3VPlcOR0UgYziy2HQiC93MCskNtPbax+MYDFgl0a9COVrskXnRXgDY8/3EoeoOXZGuNRIhH3PLBk32bDzdgOaRFriqX4Y47XHkllis2hh0gO6UHuzIj7TrYJpMcdTDCa3aYAu4P7yRhvMtaCvkLOywcAG/Qm+tv9mfDWWEi2ZtCfGk+G+C8K5pCVX9/mUfY4zSdsztD0qL6IJfv4Lv3YoOAHx2RNDGmsNBr0LsNGwOpe52hkD6UC1YNWzDdlcjmaPr7cv5x0FURpfJBq01SjYbfRP0aq/6tTpinaZO3E5l0byICPuOU=
+  gem: anvl-converter
+  on:
+    tags: true
+    repo: datacite/anvl-converter

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## v.0.1.0 (January 8, 2017)
+
+[anvl-converter 0.1.0](https://github.com/datacite/anvl-converter/releases/tag/v.0.1.0) was released on January 8, 2017:
+
+* initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    anvl-converter (0.1.0)
+      activesupport (>= 4.2.5, < 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    i18n (0.9.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.1)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.4)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  anvl-converter!
+  bundler (~> 1.0)
+  codeclimate-test-reporter (~> 1.0, >= 1.0.8)
+  rake (~> 12.0)
+  rspec (~> 3.4)
+  simplecov
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 DataCite
+
+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,31 @@
+# anvl-converter
+
+[![Gem Version](https://badge.fury.io/rb/anvl-converter.svg)](https://badge.fury.io/rb/anvl-converter) [![Build Status](https://travis-ci.org/datacite/anvl-converter.svg?branch=master)](https://travis-ci.org/datacite/anvl-converter) [![Maintainability](https://api.codeclimate.com/v1/badges/24b09e147fe522875d4c/maintainability)](https://codeclimate.com/github/datacite/anvl-converter/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/24b09e147fe522875d4c/test_coverage)](https://codeclimate.com/github/datacite/anvl-converter/test_coverage)
+
+A Name-Value Language (ANVL) parser in Ruby
+
+ANVL serializing and parsing, based on Python code at https://ezid.cdlib.org/doc/apidoc.html,
+and Ruby code at https://github.com/duke-libraries/ezid-client.
+
+More info about ANVL [here](https://tools.ietf.org/html/draft-kunze-anvl-01).
+
+## Development
+
+We use rspec for unit testing:
+
+```
+bundle exec rspec
+```
+
+Follow along via [Github Issues](https://github.com/datacite/anvl-converter/issues).
+
+### Note on Patches/Pull Requests
+
+* Fork the project
+* Write tests for your new feature or a test that reproduces a bug
+* Implement your feature or make a bug fix
+* Do not mess with Rakefile, version or history
+* Commit, push and make a pull request. Bonus points for topical branches.
+
+## License
+**anvl-converter** is released under the [MIT License](https://github.com/datacite/anvl-converter/blob/master/LICENSE.md).

data/anvl-converter.gemspec

@@ -0,0 +1,28 @@
+require "date"
+require File.expand_path("../lib/anvl/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = "Martin Fenner"
+  s.email         = "mfenner@datacite.org"
+  s.name          = "anvl-converter"
+  s.homepage      = "https://github.com/datacite/anvl-converter"
+  s.summary       = "Ruby library to parse and generate ANVL"
+  s.date          = Date.today
+  s.description   = "Ruby library to parse and generate ANVL."
+  s.require_paths = ["lib"]
+  s.version       = Anvl::VERSION
+  s.extra_rdoc_files = ["README.md"]
+  s.license       = 'MIT'
+
+  # Declary dependencies here, rather than in the Gemfile
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.add_development_dependency 'rspec', '~> 3.4'
+  s.add_development_dependency 'rake', '~> 12.0'
+  s.add_dependency 'activesupport', '>= 4.2.5', '< 6'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0', '>= 1.0.8'
+  s.add_development_dependency 'simplecov'
+
+  s.require_paths = ["lib"]
+  s.files       = `git ls-files`.split($/)
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/anvl.rb

@@ -0,0 +1,5 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+require 'anvl/core_ext/ruby/hash'
+require 'anvl/core_ext/ruby/string'
+require "anvl/version"

data/lib/anvl/core_ext/ruby/hash.rb

@@ -0,0 +1,6 @@
+class Hash
+  def to_anvl
+    lines = self.map { |k, v| [k.to_s.kanvlesc, v.to_s.anvlesc].join(": ") }
+    lines.join("\n").force_encoding(Encoding::UTF_8)
+  end
+end

data/lib/anvl/core_ext/ruby/string.rb

@@ -0,0 +1,35 @@
+class String
+  def from_anvl
+    hsh = self.split("\n").reduce({}) do |sum, line|
+      if line.start_with?("#")
+        # ignore
+      elsif line.include?(":")
+        k, v = line.split(":", 2)
+        sum[k.to_s.strip.kanvlunesc] = v.to_s.strip.anvlunesc
+      elsif line.start_with?(" ")
+        sum[sum.keys.last] += " " + line.strip
+      end
+
+      sum
+    end
+
+    # use string or symbol for keys
+    HashWithIndifferentAccess.new(hsh)
+  end
+
+  def kanvlesc
+    self.anvlesc.gsub(/:/, "%3A")
+  end
+
+  def anvlesc
+    self.gsub(/%/, "%25").gsub(/\n/, "%0A").gsub(/\r/, "%0D")
+  end
+
+  def kanvlunesc
+    self.gsub(/%3A/, ":").anvlunesc
+  end
+
+  def anvlunesc
+    self.gsub(/%25/, "%").gsub(/%0A/, "\n").gsub(/%0D/, "\r")
+  end
+end

data/lib/anvl/version.rb

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

data/spec/hash_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Hash do
+  context "to_anvl" do
+    it "convert" do
+      hsh = { "_status" => "public" }
+      expect(hsh.to_anvl).to eq("_status: public")
+    end
+
+    it "escape newlines" do
+      hsh = { "name" => "Josiah\nCarberry" }
+      expect(hsh.to_anvl).to eq("name: Josiah%0ACarberry")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'simplecov'
+SimpleCov.start
+
+require 'anvl'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/string_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe String do
+  context "from_anvl" do
+    it "convert" do
+      str = "_status: public"
+      expect(str.from_anvl).to eq("_status"=>"public")
+    end
+
+    it "escaped newlines" do
+      str = "name: Josiah%0ACarberry"
+      expect(str.from_anvl).to eq("name"=>"Josiah\nCarberry")
+    end
+
+    it "ignore comment" do
+      str = "# first draft"
+      expect(str.from_anvl).to eq({})
+    end
+
+    it "draft example" do
+      str = <<-DOC
+entry:
+# first draft
+who:          Gilbert, W.S. | Sullivan, Arthur
+what:         The Yeomen of
+              the Guard
+when/created: 1888
+      DOC
+      anvl = str.from_anvl
+      expect(anvl["entry"]).to eq("")
+      expect(anvl["who"]).to eq("Gilbert, W.S. | Sullivan, Arthur")
+      expect(anvl["what"]).to eq("The Yeomen of the Guard")
+      expect(anvl["when/created"]).to eq("1888")
+    end
+
+    it "draft example using symbol keys" do
+      str = <<-DOC
+entry:
+# first draft
+who:          Gilbert, W.S. | Sullivan, Arthur
+what:         The Yeomen of
+              the Guard
+when/created: 1888
+      DOC
+      anvl = str.from_anvl
+      expect(anvl[:entry]).to eq("")
+      expect(anvl[:who]).to eq("Gilbert, W.S. | Sullivan, Arthur")
+      expect(anvl[:what]).to eq("The Yeomen of the Guard")
+      expect(anvl[:"when/created"]).to eq("1888")
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: anvl-converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Fenner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Ruby library to parse and generate ANVL.
+email: mfenner@datacite.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- anvl-converter.gemspec
+- lib/anvl.rb
+- lib/anvl/core_ext/ruby/hash.rb
+- lib/anvl/core_ext/ruby/string.rb
+- lib/anvl/version.rb
+- spec/hash_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb
+homepage: https://github.com/datacite/anvl-converter
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Ruby library to parse and generate ANVL
+test_files:
+- spec/hash_spec.rb
+- spec/spec_helper.rb
+- spec/string_spec.rb