flexyear 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dan Melnick & Yan Pritzker
+
+MIT License
+
+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,36 @@
+# Flexyear
+
+Flexible years! Parse decades, ranges, and etc into low & high values.
+
+Examples:
+
+    FlexYear.new("1980s").year_low = 1980
+    FlexYear.new("1980s").year_high == 1989
+
+    FlexYear.new("mid-80s").year_low == 1983
+    FlexYear.new("mid-80s").year_high == 1986
+
+It's pretty flexible in the kinds of things it takes. For more examples, see the spec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flexyear'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flexyear
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/flexyear.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flexyear/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flexyear"
+  spec.version       = Flexyear::VERSION
+  spec.authors       = ["Dan Melnick & Yan Pritzker"]
+  spec.email         = ["pair+dm+yp@reverb.com"]
+  spec.description   = %q{Parse common year range formats like '1973-75' or natural language ranges like 'mid 80s'}
+  spec.summary       = %q{Natural language year range parser}
+  spec.homepage      = "http://github.com/reverbdev/flexyear"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/flexyear/version.rb

@@ -0,0 +1,3 @@
+module Flexyear
+  VERSION = "0.0.1"
+end

data/lib/flexyear.rb

@@ -0,0 +1,104 @@
+require 'flexyear/version'
+require 'date'
+
+# Represents a flexible year entry:
+#
+#  * 1979 - a specific year
+#  * 1970s and 70s - decades
+#  * mid-70s, early-70s, late-70s - subdecades, dashes optional
+#  * 1972-1975 - a range
+#
+# All years can be in two or four digit format
+class FlexYear
+  class InvalidYearError < ArgumentError; end
+
+  attr_reader :year_low, :year_high
+
+  CIRCA_KEYWORDS = ["circ", "ca", "c.a.", "ca.", "cca", "c.", "approx", "appx", "about", "around"]
+
+  def initialize(year_string)
+    @year_string = year_string.to_s
+
+    if @year_string.start_with?("early")
+      @low = 0
+      @high = 3
+    elsif @year_string.start_with?("mid")
+      @low = 3
+      @high = 6
+    elsif @year_string.start_with?("late")
+      @low = 6
+      @high = 9
+    elsif @year_string.end_with?("s") # decade
+      @low = 0
+      @high = 9
+    elsif @year_string.include?("-")
+      @year_string =~ /(\d+)\s*-\s*(\d+)/
+      if $1 && $2
+        @year_low = centuryize($1).to_i
+        @year_high = centuryize($2, @year_low).to_i
+        return
+      end
+    elsif CIRCA_KEYWORDS.any?{|circa_pattern| @year_string.downcase.include?(circa_pattern)}
+      @low  = -1
+      @high = 1
+    elsif @year_string.downcase.include?('reissue')
+      raise InvalidYearError, 'Please enter the date of manufacture, not the reissue era.'
+    else # specific year
+      @low = 0
+      @high = 0
+    end
+
+    parse_year
+  end
+
+  def to_s
+    @year_string
+  end
+
+  private
+
+  def centuryize(year, base_year=nil)
+    base = "19" # 19th century
+    if base_year
+      base = (base_year/100).to_s
+    end
+
+    if year.length == 1
+      "#{base}0#{year}"
+    elsif year.length == 2
+      "#{base}#{year}"
+    else
+      year
+    end
+  end
+
+  def parse_year
+    if @year_string =~ /(\d+).*s$/
+      @base_year = centuryize($1).to_i
+    elsif @year_string =~ /^\w+\s+(\d+)/
+      @base_year = centuryize($1).to_i
+    else
+      @base_year = @year_string.gsub(/\D+/,'').to_i
+    end
+
+    if @base_year > 9999
+      raise InvalidYearError, "Please use a four digit year."
+    end
+
+    @year_low = @base_year + (@low || -1)
+    @year_high = @base_year + (@high || 1)
+  end
+
+  # Represents a flexible year entry that must be in the past.
+  class Historical < FlexYear
+    private
+
+    def parse_year
+      super
+
+      if @base_year > DateTime.now.year
+        raise InvalidYearError, "The year must be in the past. You specified #{@base_year}; Today is #{DateTime.now.year}"
+      end
+    end
+  end
+end

data/spec/flexyear_spec.rb

@@ -0,0 +1,187 @@
+require 'flexyear'
+
+describe FlexYear do
+  context "given a blank string" do
+    subject { FlexYear.new("") }
+    its(:year_low) { should eq(0) }
+    its(:year_high) { should eq(0) }
+  end
+
+  context "given nil" do
+    subject { FlexYear.new(nil) }
+    its(:year_low) { should eq(0) }
+    its(:year_high) { should eq(0) }
+  end
+
+  context "text" do
+    subject { FlexYear.new("something") }
+    its(:year_low) { should eq(0) }
+    its(:year_high) { should eq(0) }
+  end
+
+  context "given 1979 as number" do
+    subject { FlexYear.new(1979) }
+    its(:year_low) { should eq(1979) }
+    its(:year_high) { should eq(1979) }
+  end
+
+  context "given 1979" do
+    subject { FlexYear.new("1979") }
+    its(:year_low) { should eq(1979) }
+    its(:year_high) { should eq(1979) }
+  end
+
+  context "given 1970s" do
+    subject { FlexYear.new("1970s") }
+    its(:year_low) { should eq(1970) }
+    its(:year_high) { should eq(1979) }
+  end
+
+  context "given 70s" do
+    subject { FlexYear.new("70s") }
+    its(:year_low) { should eq(1970) }
+    its(:year_high) { should eq(1979) }
+  end
+
+  context "given something with negative and dots" do
+    subject { FlexYear.new("approx.-2006") }
+    its(:year_low) { should eq(2005) }
+    its(:year_high) { should eq(2007) }
+  end
+
+  ["mid 1970s", "mid 70s", "mid-70s", "mid-70's"].each do |year|
+    context "given #{year}" do
+      subject { FlexYear.new(year) }
+      its(:year_low) { should eq(1973) }
+      its(:year_high) { should eq(1976) }
+      its(:to_s) { should eq(year) }
+    end
+  end
+
+  ["early 1970s", "early 70s", "early-70s", "early 70's"].each do |year|
+    context "given #{year}" do
+      subject { FlexYear.new(year) }
+      its(:year_low) { should eq(1970) }
+      its(:year_high) { should eq(1973) }
+    end
+  end
+
+  ["late 1970s", "late 70s", "late -70s", "late  70  s"].each do |year|
+    context "given #{year}" do
+      subject { FlexYear.new(year) }
+      its(:year_low) { should eq(1976) }
+      its(:year_high) { should eq(1979) }
+    end
+  end
+
+  ["73-75", "1973-1975", "1973 - 1975", "1973- 1975", "1973 -1975", "1973-75"].each do |range|
+    context "given a range #{range}" do
+      subject { FlexYear.new(range) }
+      its(:year_low) { should eq(1973) }
+      its(:year_high) { should eq(1975) }
+    end
+  end
+
+  context "given a range" do
+    ["2003-4", "2003-04"].each do |range|
+      subject { FlexYear.new(range) }
+      its(:year_low) { should eq(2003) }
+      its(:year_high) { should eq(2004) }
+    end
+  end
+
+  context 'given a reissue' do
+    specify do
+      expect { FlexYear.new('65 reissue') }.to raise_error(FlexYear::InvalidYearError)
+    end
+  end
+
+  context 'given a circa' do
+    context 'at the end of the string' do
+      subject { FlexYear.new('1973 (Circa)') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'at the beginning of the string' do
+      subject { FlexYear.new('Circa 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'abbreviated' do
+      subject { FlexYear.new('ca 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with dots' do
+      subject { FlexYear.new('c.a. 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with c.' do
+      subject { FlexYear.new('c. 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with ca.' do
+      subject { FlexYear.new('ca. 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with approx.' do
+      subject { FlexYear.new('approx. 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with appxly.' do
+      subject { FlexYear.new('appxly 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with around' do
+      subject { FlexYear.new('around 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with about' do
+      subject { FlexYear.new('about 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with circ' do
+      subject { FlexYear.new('circ. 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+    context 'with cca' do
+      subject { FlexYear.new('cca 1973') }
+      its(:year_low) { should eq(1972) }
+      its(:year_high) { should eq(1974) }
+    end
+
+  end
+
+  context "given 12345 (five digit year)" do
+    specify do
+      expect { FlexYear.new('12345') }.to raise_error(FlexYear::InvalidYearError)
+    end
+  end
+
+  describe FlexYear::Historical do
+    context "given a year past today" do
+      specify do
+        expect { FlexYear::Historical.new('3000') }.to raise_error(FlexYear::InvalidYearError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: flexyear
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dan Melnick & Yan Pritzker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-13 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Parse common year range formats like '1973-75' or natural language ranges like 'mid 80s'
+email: 
+- pair+dm+yp@reverb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flexyear.gemspec
+- lib/flexyear.rb
+- lib/flexyear/version.rb
+- spec/flexyear_spec.rb
+has_rdoc: true
+homepage: http://github.com/reverbdev/flexyear
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Natural language year range parser
+test_files: 
+- spec/flexyear_spec.rb