edtf-humanize 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8e0e270335cf2b7abbc0422aae7201a087a0be8b
-  data.tar.gz: bbe083a2e89d792d98d849cc68200f1ee83c2ff2
+SHA256:
+  metadata.gz: 370eca8ed68c9afdd06117f0e584f82f2f48eac108a1113b77ce91355844bcba
+  data.tar.gz: 608b950683ce5117a1bcb9fe63380fc99ce705b53184f8e68c6e6a545527bbf7
 SHA512:
-  metadata.gz: 44252fe461dcc101dd6bda09cc54d313a5466b295aa0dbdf140e4ffd9269f12c2541a525afe622402891367bbd8d26c4f5a08921d96fdb7c72e6f0230a585cc4
-  data.tar.gz: a15d6d76736c69afb1c70bfca8bd3e56ae849f15c916fd3727eb4fd0821fb80252ac46d91f1d5b77ff4ae88cfd98c3f3f3ddad24ef8c92e7e7a7c1c4acde61d4
+  metadata.gz: 4093df048a06504a30c04a8960ed6e253bb39a3d5d0015ac6f791287515ea9d2c800c0d04bf1e2834b5da2757243b47a1ab78589c5b259e7b9a7bd58ad4d2991
+  data.tar.gz: 6946c6594d3149788cbfc4ec50f770d450b3716817d7c8ad4c73c0ad58cd3a3b535436b1e373ccf998528d9ebdd4eb9faed24f42898da2d5de58b9ca9023bd7e

data/LICENSE.txt

@@ -0,0 +1,12 @@
+Copyright (c) 2014, Duke University
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/edtf/humanize.rb

@@ -9,6 +9,7 @@ module Edtf
     require 'edtf/humanize/season'
     require 'edtf/humanize/interval'
     require 'edtf/humanize/set'
+    require 'edtf/humanize/unknown'
     require 'edtf/humanize/iso_date'
 
     EDTF::Decade.include Edtf::Humanize::Decade
@@ -16,8 +17,10 @@ module Edtf
     EDTF::Season.include Edtf::Humanize::Season
     EDTF::Interval.include Edtf::Humanize::Interval
     EDTF::Set.include Edtf::Humanize::Set
+    EDTF::Unknown.include Edtf::Humanize::Unknown
     Date.include Edtf::Humanize::IsoDate
 
+
     def self.configuration
       @configuration ||= Configuration.new
     end
@@ -41,10 +44,13 @@ module Edtf
                     :century_suffix,
                     :unspecified_digit_substitute,
                     :interval_connector,
+                    :interval_unspecified_suffix,
                     :set_dates_connector,
                     :set_last_date_connector,
                     :set_two_dates_connector,
-                    :interval_unspecified_suffix
+                    :set_earlier_prefix,
+                    :set_later_prefix,
+                    :unknown
 
       def initialize
         @day_precision_strftime_format = "%B %-d, %Y"
@@ -52,12 +58,12 @@ module Edtf
         @year_precision_strftime_format = "%Y"
 
         @approximate_date_prefix = "circa "
-        
+
         @uncertain_date_suffix = "?"
-        
+
         @decade_suffix = "s"
         @century_suffix = "s"
-        
+
         @unspecified_digit_substitute = "x"
 
         @interval_connector = " to "
@@ -66,9 +72,13 @@ module Edtf
         @set_dates_connector = ", "
         @set_last_date_connector = " or "
         @set_two_dates_connector = " or "
+        @set_earlier_prefix = "on or before "
+        @set_later_prefix = "on or after "
+
+        @unknown = "unknown"
       end
 
     end
-   
+
   end
 end

data/lib/edtf/humanize/century.rb

@@ -3,7 +3,7 @@ module Edtf
     module Century
 
       include Edtf::Humanize::Formats
-    
+
       def humanize
         "#{self.begin.year}#{Edtf::Humanize.configuration.century_suffix}"
       end

data/lib/edtf/humanize/decade.rb

@@ -3,7 +3,7 @@ module Edtf
     module Decade
 
       include Edtf::Humanize::Formats
-    
+
       def humanize
         "#{self.begin.year}#{Edtf::Humanize.configuration.decade_suffix}"
       end

data/lib/edtf/humanize/formats.rb

@@ -25,14 +25,14 @@ module Edtf
 
       # October 5, 1995
       def day_precision_format date
-        date.strftime(Edtf::Humanize.configuration.day_precision_strftime_format)
+        I18n.localize(date, format: Edtf::Humanize.configuration.day_precision_strftime_format)
       end
 
       # October 1995
       def month_precision_format date
-        date.strftime(Edtf::Humanize.configuration.month_precision_strftime_format)
+        I18n.localize(date, format: Edtf::Humanize.configuration.month_precision_strftime_format)
       end
-      
+
       # 1995
       def year_precision_format date
         date.strftime(Edtf::Humanize.configuration.year_precision_strftime_format)

data/lib/edtf/humanize/interval.rb

@@ -5,7 +5,11 @@ module Edtf
       include Edtf::Humanize::Formats
 
       def humanize
-        "#{apply_if_approximate(self.from)}#{simple_date_format(self.from)}#{Edtf::Humanize.configuration.interval_connector}#{simple_date_format(self.to)}"
+        "#{apply_if_approximate(self.from)}"\
+        "#{simple_date_format(self.from)}"\
+        "#{Edtf::Humanize.configuration.interval_connector}"\
+        "#{apply_if_approximate(self.to)}"\
+        "#{simple_date_format(self.to)}"
       end
 
       private

data/lib/edtf/humanize/season.rb

@@ -5,7 +5,19 @@ module Edtf
       include Edtf::Humanize::Formats
 
       def humanize
-        "#{apply_if_approximate(self)}#{self.season} #{self.year}#{apply_if_uncertain(self)}"
+        "#{apply_if_approximate(self)}"\
+        "#{translate_season(self.season)} #{self.year}"\
+        "#{apply_if_uncertain(self)}"
+      end
+
+      private
+
+      def translate_season(season)
+        begin
+          I18n.translate!("date.seasons.#{self.season}")
+        rescue I18n::MissingTranslationData
+          self.season
+        end
       end
 
     end

data/lib/edtf/humanize/set.rb

@@ -5,15 +5,36 @@ module Edtf
       include Edtf::Humanize::Formats
 
       def humanize
-        display = []
-        self.entries.each do |date|
-          display << "#{apply_if_approximate(date)}#{simple_date_format(date)}"
-        end
-        display.to_sentence(
-          words_connector: Edtf::Humanize.configuration.set_dates_connector,
+        format_set_entries(self).to_sentence(
+          words_connector:     Edtf::Humanize.configuration.set_dates_connector,
           last_word_connector: Edtf::Humanize.configuration.set_last_date_connector,
           two_words_connector: Edtf::Humanize.configuration.set_two_dates_connector
-          )
+        )
+      end
+
+      private
+
+      def format_set_entries(dates)
+        dates.entries.map.with_index { |date, index|
+          "#{apply_if_earlier(dates, index)}"\
+          "#{apply_if_later(dates, index)}"\
+          "#{apply_if_approximate(date)}"\
+          "#{simple_date_format(date)}"
+        }
+      end
+
+      # '[..1760-12-03]' => on or before December 3, 1760
+      def apply_if_earlier(dates, index)
+        if dates.earlier? && index == 0
+          Edtf::Humanize.configuration.set_earlier_prefix
+        end
+      end
+
+      # '[1760-12..]' => on or after December 1760
+      def apply_if_later(dates, index)
+        if dates.later? && (index + 1) == dates.size
+          Edtf::Humanize.configuration.set_later_prefix
+        end
       end
 
     end

data/lib/edtf/humanize/unknown.rb

@@ -0,0 +1,11 @@
+module Edtf
+  module Humanize
+    module Unknown
+
+      def humanize
+        Edtf::Humanize.configuration.unknown
+      end
+
+    end
+  end
+end

data/lib/edtf/humanize/version.rb

@@ -1,5 +1,5 @@
 module Edtf
   module Humanize
-    VERSION = "0.0.3"
+    VERSION = "1.0.0"
   end
 end

data/spec/edtf_humanize_spec.rb

@@ -0,0 +1,65 @@
+require 'edtf-humanize'
+
+RSpec.describe Edtf::Humanize do
+
+  it { is_expected.to be_a(Module) }
+
+  context 'with a decade' do
+    it 'should return a humanized decade string' do
+      expect(Date.edtf('199x').humanize).to eq('1990s')
+    end
+  end
+
+  context 'with a centrury' do
+    it 'should return a humanized century string' do
+      expect(Date.edtf('19xx').humanize).to eq('1900s')
+    end
+  end
+
+  context 'with an interval' do
+    it 'should return a humanized interval string' do
+      expect(Date.edtf('1970/1980').humanize).to eq('1970 to 1980')
+    end
+  end
+
+  context 'with an appoximate interval'
+  it 'should return a humanized approximate interval string' do
+    expect(Date.edtf('1970~/1980~').humanize).to eq('circa 1970 to circa 1980')
+  end
+
+  context 'with an iso date' do
+    it 'should return a humanized ISO date string' do
+      expect(Date.edtf('1975-07-01').humanize).to eq('July 1, 1975')
+    end
+  end
+
+  context 'with an uncertain iso date' do
+    it 'should return a humanized uncertain ISO date string' do
+      expect(Date.edtf('1975?').humanize).to eq('1975?')
+    end
+  end
+
+  context 'with an unspecfic year iso date' do 
+    it 'should return a humanized unspecified year ISO date string' do
+      expect(Date.edtf('197u').humanize).to eq('197x')
+    end
+  end
+
+  context 'with a season' do
+    it 'should return a humanized season string' do
+      expect(Date.edtf('1975-22').humanize).to eq('summer 1975')
+    end
+  end
+
+  context 'with a set' do 
+    it 'should return a humanized set string' do
+      expect(Date.edtf('[1980, 1981, 1983]').humanize).to eq('1980, 1981 or 1983')
+    end
+  end
+
+  context 'with an unknown value' do
+    it 'should return a humanized unknown string' do
+      expect(Date.edtf('uuuu').humanize).to eq('unknown')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+#
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,45 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: edtf-humanize
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Cory Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: edtf
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: edtf
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
-  type: :runtime
+        version: '3.9'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,14 +87,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: This gem adds a humanize method to EDTF::Decade, EDTF::Interval, EDTF::Set,
-  EDTF::Season, and Date (ISO 8601 compliant) objects.
+  EDTF::Season, EDTF::Unknown, and Date (ISO 8601 compliant) objects.
 email:
 - cory.lown@duke.edu
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Rakefile
+- LICENSE.txt
 - lib/edtf-humanize.rb
 - lib/edtf/humanize.rb
 - lib/edtf/humanize/century.rb
@@ -70,46 +104,10 @@ files:
 - lib/edtf/humanize/iso_date.rb
 - lib/edtf/humanize/season.rb
 - lib/edtf/humanize/set.rb
+- lib/edtf/humanize/unknown.rb
 - lib/edtf/humanize/version.rb
-- lib/tasks/edtf_humanize_tasks.rake
-- test/dummy/README.rdoc
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/edtf_humanize_test.rb
-- test/test_helper.rb
+- spec/edtf_humanize_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/duke-libraries/edtf-humanize
 licenses:
 - BSD-3-Clause
@@ -129,47 +127,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: This gem adds a humanize method to EDTF dates.
 test_files:
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/config/secrets.yml
-- test/dummy/config.ru
-- test/dummy/db/test.sqlite3
-- test/dummy/log/test.log
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/README.rdoc
-- test/edtf_humanize_test.rb
-- test/test_helper.rb
+- spec/spec_helper.rb
+- spec/edtf_humanize_spec.rb