edtf 3.0.8 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79b11e60a9c93e8708e3176ac04cecf8a63ea0df9fdbae09aa0c5583d4829632
-  data.tar.gz: d8cb5d2aefdb707bbd7dc44de1bdc9e470f8198e699fc5bad7ba2a3acd7e2eba
+  metadata.gz: 508a9d4cc114b76f7f7c4b96e92322fbe936d20e4c879258cc07bde58a469b47
+  data.tar.gz: a818969998194574dbeb8912f4652b0574e50343ba5aac39a88e956534d3a3cf
 SHA512:
-  metadata.gz: b8972cc08117bc4b0b015c7f1f07004a0d5e28f972350d4c3eb0b57ee67e5fcdfa6b4e666f4ee3df5c8478f35852d647f1000de64b0bda9416c5f7f3351c5aef
-  data.tar.gz: c197e8bffc0377e3d52a841544525b1a8cbf47e5eb1708b6560b6eaf0db7fc6c37371de8e65af3e000e343294da7c51a5d4c378e9f877500ba994548f42a750a
+  metadata.gz: 574b53436042ada550507f2c7432ccec439389eb812161850e4c4e7004554c3e1838d853b49966448c2cf84ffdd607af971eb71f9d3932dfc39e639c6b004fef
+  data.tar.gz: 31708d12d6cbef246d378d67ef1d5c799e586409269f88e539ba395695a255a66a6f65f4d34850e8e941073954fdc77c391561529c44f62c0fbf11290ca6fda1

data/.github/workflows/ci.yml

@@ -0,0 +1,40 @@
+name: ci
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    environment: CI
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - 'jruby'
+
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Upload coverage results
+        if: matrix.ruby-version == '3.1'
+        continue-on-error: true
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ github.token }}

data/.simplecov

@@ -1,4 +1,19 @@
+require 'simplecov-lcov'
+
+SimpleCov::Formatter::LcovFormatter.config do |c|
+  c.output_directory = 'coverage'
+  c.lcov_file_name = 'lcov.info'
+  c.report_with_single_file = true
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  SimpleCov::Formatter::LcovFormatter
+])
+
 SimpleCov.start do
   add_filter 'spec/'
   add_filter 'features/'
+
+  enable_coverage :branch
 end

data/Gemfile

@@ -2,20 +2,16 @@ source 'https://rubygems.org'
 gemspec
 
 group :debug do
-  gem 'ruby-debug', :require => false, :platform => :jruby
-  gem 'byebug', :require => false, :platform => :mri
-  gem 'rubinius-compiler', '~>2.0', :require => false, :platform => :rbx
-  gem 'rubinius-debugger', '~>2.0', :require => false, :platform => :rbx
+  gem 'debug', platform: 'mri'
 end
 
 group :development do
   gem 'rake'
-  gem 'racc', :platform => :ruby
+  gem 'racc'
   gem 'cucumber'
-  gem 'rspec', '~>3.0'
-  gem 'simplecov', :require => false
-  gem 'rubinius-coverage', :platform => :rbx
-  gem 'coveralls', '~>0.8', :require => false
+  gem 'rspec'
+  gem 'simplecov', platform: 'mri'
+  gem 'simplecov-lcov', platform: 'mri'
 end
 
 group :extra do
@@ -24,13 +20,3 @@ end
 
 # active_support requires this
 gem 'i18n'
-
-platform :rbx do
-  gem 'rubysl-singleton', '~>2.0'
-  gem 'rubysl-open3', '~>2.0'
-  gem 'rubysl-enumerator', '~>2.0'
-  gem 'rubysl-base64', '~>2.0'
-  gem 'rubysl-bigdecimal', '~>2.0'
-  gem 'rubysl-drb', '~>2.0'
-  gem 'json'
-end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2016 Sylvester Keil. All rights reserved.
+Copyright 2011-2022 Sylvester Keil. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

data/README.md

@@ -1,7 +1,7 @@
 EDTF-Ruby
 =========
-[![Build Status](https://travis-ci.org/inukshuk/edtf-ruby.png?branch=master)](https://travis-ci.org/inukshuk/edtf-ruby)
-[![Coverage Status](https://coveralls.io/repos/inukshuk/edtf-ruby/badge.png)](https://coveralls.io/r/inukshuk/edtf-ruby)
+[![ci](https://github.com/inukshuk/edtf-ruby/actions/workflows/ci.yml/badge.svg)](https://github.com/inukshuk/edtf-ruby/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/inukshuk/edtf-ruby/badge.svg?branch=main)](https://coveralls.io/github/inukshuk/edtf-ruby?branch=main)
 
 EDTF-Ruby comprises a parser and an API implementation of the [Extended
 Date/Time Format standard](http://www.loc.gov/standards/datetime/).
@@ -135,9 +135,11 @@ state of dates in Ruby:
 As you can see above, you can use the bang! methods to set individual date
 parts.
 
-In addition, EDTF supports *unspecified* date parts:
+In addition, EDTF supports *unspecified* date parts. EDTF-Ruby provides parsing
+for both the draft and finalized EDTF specifications, with output meeting the
+requirements of the final specification:
 
-    > d = Date.edtf('1999-03-uu')
+    > d = Date.edtf('1999-03-XX')
     > d.unspecified?
     => true
     > d.unspecified? :year
@@ -146,7 +148,11 @@ In addition, EDTF supports *unspecified* date parts:
     => true
     > d.unspecified! :month
     > d.edtf
-    => "1999-uu-uu"
+    => "1999-XX-XX"
+
+    > draft_d = Date.edtf('1999-03-uu')
+    > draft_d.edtf
+    => "1999-03-XX"
 
 All three, uncertain, approximate, and unspecified attributes do not factor
 into date calculations (like comparisons or successors etc.).
@@ -334,8 +340,7 @@ and submit a pull request.
 
 Credits
 -------
-EDTF-Ruby was written by [Sylvester Keil](http://sylvester.keil.or.at) and
-[Namyra](https://github.com/namyra).
+EDTF-Ruby was written by Sylvester Keil and Ilja Srna.
 
 Published under the terms and conditions of the FreeBSD License; see LICENSE
 for details.

data/Rakefile

@@ -50,10 +50,6 @@ task :build => [:check_warnings] do
   system 'gem build edtf.gemspec'
 end
 
-require 'coveralls/rake/task'
-Coveralls::RakeTask.new
-task :test_with_coveralls => [:spec, :cucumber, 'coveralls:push']
-
 task :check_warnings do
   $VERBOSE = true
   require 'edtf'

data/cucumber.yml

@@ -1 +1 @@
-default: --format progress --require features --color
+default: --format progress --require features --color --publish-quiet

data/edtf.gemspec

@@ -8,8 +8,7 @@ Gem::Specification.new do |s|
   s.name        = 'edtf'
   s.version     = EDTF::VERSION.dup
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Sylvester Keil']
-  s.email       = ['http://sylvester.keil.or.at']
+  s.authors     = ['Sylvester Keil', 'Ilja Srna']
   s.homepage    = 'http://github.com/inukshuk/edtf-ruby'
   s.summary     = 'Extended Date/Time Format for Ruby.'
   s.description = 'A Ruby implementation of the Extended Date/Time Format (EDTF).'

data/features/parser/unspecified.feature

@@ -9,15 +9,26 @@ Feature: Parse unspecified date strings
     And the day should be "<day>"
     And the unspecified string code be "<unspecified>"
 
-    @102 @level1
+    @102 @level1 @draft
     Scenarios: examples from the specification draft
       | string     | year | month | day | unspecified |
-      | 199u       | 1990 | 1     | 1   | sssu-ss-ss  |
-      | 19uu       | 1900 | 1     | 1   | ssuu-ss-ss  |
-      | 1999-uu    | 1999 | 1     | 1   | ssss-uu-ss  |
-      | 1999-02-uu | 1999 | 2     | 1   | ssss-ss-uu  |
-      | 1999-uu-uu | 1999 | 1     | 1   | ssss-uu-uu  |
+      | 199u       | 1990 | 1     | 1   | sssX-ss-ss  |
+      | 19uu       | 1900 | 1     | 1   | ssXX-ss-ss  |
+      | 1999-uu    | 1999 | 1     | 1   | ssss-XX-ss  |
+      | 1999-02-uu | 1999 | 2     | 1   | ssss-ss-XX  |
+      | 1999-uu-uu | 1999 | 1     | 1   | ssss-XX-XX  |
+
+    @102 @level1 @final
+    Scenarios: examples from the specification draft
+      | string     | year | month | day | unspecified |
+      | 199X       | 1990 | 1     | 1   | sssX-ss-ss  |
+      | 19XX       | 1900 | 1     | 1   | ssXX-ss-ss  |
+      | 1999-XX    | 1999 | 1     | 1   | ssss-XX-ss  |
+      | 1999-02-XX | 1999 | 2     | 1   | ssss-ss-XX  |
+      | 1999-XX-XX | 1999 | 1     | 1   | ssss-XX-XX  |
 
   Scenario: Completely unknown
     When I parse the string "uuuu"
     Then the result should be an Unknown
+    When I parse the string "XXXX"
+    Then the result should be an Unknown

data/features/print/level_1_edtf.feature

@@ -1,21 +1,21 @@
 Feature: Print Date/Time objects as Level 1 EDTF strings
   As a Ruby programmer
   I want to convert Date/Time objects to EDTF strings
-  
+
   @101 @level1
 	Scenario: Uncertain or approximate dates
 		When I parse the string "2001?"
 		When I convert the date
 		Then the EDTF string should be "2001?"
-		
+
 		When I parse the string "2004-06?"
 		When I convert the date
 		Then the EDTF string should be "2004-06?"
-		
+
 		When I parse the string "2004-06-11?"
 		When I convert the date
 		Then the EDTF string should be "2004-06-11?"
-		
+
 		When I parse the string "1984~"
 		When I convert the date
 		Then the EDTF string should be "1984~"
@@ -23,28 +23,50 @@ Feature: Print Date/Time objects as Level 1 EDTF strings
 		When I parse the string "1984?~"
 		When I convert the date
 		Then the EDTF string should be "1984?~"
-		
-	@102 @level1
+
+	@102 @level1 @draft
 	Scenario: Unspecified dates
 		When I parse the string "199u"
 		When I convert the date
-		Then the EDTF string should be "199u"
+		Then the EDTF string should be "199X"
 
 		When I parse the string "19uu"
 		When I convert the date
-		Then the EDTF string should be "19uu"
+		Then the EDTF string should be "19XX"
 
 		When I parse the string "1999-uu"
 		When I convert the date
-		Then the EDTF string should be "1999-uu"
+		Then the EDTF string should be "1999-XX"
 
 		When I parse the string "1999-01-uu"
 		When I convert the date
-		Then the EDTF string should be "1999-01-uu"
+		Then the EDTF string should be "1999-01-XX"
+
+		When I parse the string "1999-XX-XX"
+		When I convert the date
+		Then the EDTF string should be "1999-XX-XX"
+
+  @102 @level1 @final
+  Scenario: Unspecified dates
+    When I parse the string "199X"
+    When I convert the date
+    Then the EDTF string should be "199X"
+
+    When I parse the string "19XX"
+		When I convert the date
+		Then the EDTF string should be "19XX"
+
+		When I parse the string "1999-XX"
+		When I convert the date
+		Then the EDTF string should be "1999-XX"
+
+		When I parse the string "1999-01-XX"
+		When I convert the date
+		Then the EDTF string should be "1999-01-XX"
 
-		When I parse the string "1999-uu-uu"
+		When I parse the string "1999-XX-XX"
 		When I convert the date
-		Then the EDTF string should be "1999-uu-uu"
+		Then the EDTF string should be "1999-XX-XX"
 
 	@103 @level1 @interval
 	Scenario: Prints L1 Extended Intervals
@@ -88,19 +110,28 @@ Feature: Print Date/Time objects as Level 1 EDTF strings
 		When I convert the date
 		Then the EDTF string should be "1984-06-02?/unknown"
 
-	@104 @level1
+	@104 @level1 @draft
 	Scenario: Prints years with more than four digits
 		When I parse the string "y170000002"
 		When I convert the date
-		Then the EDTF string should be "y170000002"
+		Then the EDTF string should be "Y170000002"
 
 		When I parse the string "y-170000002"
 		When I convert the date
-		Then the EDTF string should be "y-170000002"
+		Then the EDTF string should be "Y-170000002"
+
+  @104 @level1 @final
+  Scenario: Prints years with more than four digits
+    When I parse the string "Y170000002"
+		When I convert the date
+		Then the EDTF string should be "Y170000002"
+
+		When I parse the string "Y-170000002"
+		When I convert the date
+		Then the EDTF string should be "Y-170000002"
 
 	@105 @level1 @season
 	Scenario: Prints seasons
 		When I parse the string "2001-21"
 		When I convert the date
 		Then the EDTF string should be "2001-21"
-		

data/features/print/level_2_edtf.feature

@@ -1,12 +1,16 @@
 Feature: Print Date/Time objects as Level 2 EDTF strings
   As a Ruby programmer
   I want to convert Date/Time objects to EDTF strings
-  
+
   @202 @level2
 	Scenario: Prints internal unspecified dates
 		When I parse the string "156u-12-25"
 		When I convert the date
-		Then the EDTF string should be "156u-12-25"
+		Then the EDTF string should be "156X-12-25"
+
+    When I parse the string "156X-12-25"
+		When I convert the date
+		Then the EDTF string should be "156X-12-25"
 
   @205 @level2 @interval
 	Scenario: Prints L2 extended intervals
@@ -16,7 +20,11 @@ Feature: Print Date/Time objects as Level 2 EDTF strings
 
 		When I parse the string "2004-06-uu/2004-07-03"
 		When I convert the date
-		Then the EDTF string should be "2004-06-uu/2004-07-03"
+		Then the EDTF string should be "2004-06-XX/2004-07-03"
+
+    When I parse the string "2004-06-XX/2004-07-03"
+		When I convert the date
+		Then the EDTF string should be "2004-06-XX/2004-07-03"
 
   @209 @level2 @season
 	Scenario: Prints qualified seasons

data/features/support/env.rb

@@ -1,20 +1,11 @@
 begin
   require 'simplecov'
-  require 'coveralls' if ENV['CI']
 rescue LoadError
   # ignore
 end
 
 begin
-  case
-  when RUBY_PLATFORM < 'java'
-    require 'debug'
-    Debugger.start
-  when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
-    require 'rubinius/debugger'
-  else
-    require 'byebug'
-  end
+  require 'debug'
 rescue LoadError
   # ignore
 end

data/lib/edtf/date.rb

@@ -9,7 +9,7 @@ class Date
     :uncertain   => '?',
     :approximate => '~',
     :calendar    => '^',
-    :unspecified => 'u'
+    :unspecified => 'X'
   }.freeze
 
   EXTENDED_ATTRIBUTES = %w{
@@ -172,7 +172,7 @@ class Date
 
   # Returns the Date's EDTF string.
   def edtf
-    return "y#{year}" if long_year?
+    return "Y#{year}" if long_year?
 
     v = values
     s = FORMATS.take(v.length).zip(v).map { |f,d| f % d.abs }