flexyear 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03f0180f05ab5d01948b0a24796cbfd9a7b23970
+  data.tar.gz: cfaa51b4ed1ebae6f300a629cd1d500b3a1ab7e2
+SHA512:
+  metadata.gz: b48806ae6b6b7658b7b0893a56bcfbb3ee28dbec7991cc3bad224495bb66ec3a8fd57fafbffd6a1b92c482ad431fbae6e21a215a0c62451fdb87c40e38cad2e5
+  data.tar.gz: 82427042b5d194fdc6afe64fc615e638ff9a4c7252071f76bb6cb6b4b2dc9cfd5c66ddaa724962d614985432cc921cb599dbea10fbd680beae595a958b73bdd0

data/CHANGELOG

@@ -0,0 +1,5 @@
+0.0.2
+	- Refactor main parser code into parser subclasses (@tmaier)
+	- Remove ReissueParser, moved to Reverb codebase as it's not generic
+0.0.1
+	- Initial Release

data/README.md

@@ -4,11 +4,13 @@ Flexible years! Parse decades, ranges, and etc into low & high values.
 
 Examples:
 
-    FlexYear.new("1980s").year_low = 1980
-    FlexYear.new("1980s").year_high == 1989
+```ruby
+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
+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.
 
@@ -16,7 +18,9 @@ It's pretty flexible in the kinds of things it takes. For more examples, see the
 
 Add this line to your application's Gemfile:
 
-    gem 'flexyear'
+```ruby
+gem 'flexyear'
+```
 
 And then execute:
 
@@ -26,7 +30,6 @@ Or install it yourself as:
 
     $ gem install flexyear
 
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/flexyear.gemspec

@@ -5,7 +5,7 @@ require 'flexyear/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "flexyear"
-  spec.version       = Flexyear::VERSION
+  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'}
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/flexyear/range_parsers/circa_parser.rb

@@ -0,0 +1,13 @@
+class FlexYear
+  class CircaParser < RangeParser
+    CIRCA_KEYWORDS = ["circ", "ca", "c.a.", "ca.", "cca", "c.", "approx", "appx", "about", "around"]
+
+    def self.can_parse?(string)
+      CIRCA_KEYWORDS.any?{|circa_pattern| string.downcase.include?(circa_pattern)}
+    end
+
+    def parse
+      [-1, 1]
+    end
+  end
+end

data/lib/flexyear/range_parsers/decade_parser.rb

@@ -0,0 +1,11 @@
+class FlexYear
+  class DecadeParser < RangeParser
+    def self.can_parse?(string)
+      string.end_with?('s')
+    end
+
+    def parse
+      [0, 9]
+    end
+  end
+end

data/lib/flexyear/range_parsers/early_parser.rb

@@ -0,0 +1,11 @@
+class FlexYear
+  class EarlyParser < RangeParser
+    def self.can_parse?(string)
+      string.start_with?('early')
+    end
+
+    def parse
+      [0, 3]
+    end
+  end
+end

data/lib/flexyear/range_parsers/late_parser.rb

@@ -0,0 +1,11 @@
+class FlexYear
+  class LateParser < RangeParser
+    def self.can_parse?(string)
+      string.start_with?('late')
+    end
+
+    def parse
+      [6, 9]
+    end
+  end
+end

data/lib/flexyear/range_parsers/mid_parser.rb

@@ -0,0 +1,11 @@
+class FlexYear
+  class MidParser < RangeParser
+    def self.can_parse?(string)
+      string.start_with?('mid')
+    end
+
+    def parse
+      [3, 6]
+    end
+  end
+end

data/lib/flexyear/range_parsers/range_parser.rb

@@ -0,0 +1,31 @@
+class FlexYear
+  class RangeParser
+    class << self
+      attr_reader :parser_classes
+    end
+
+    @parser_classes = []
+
+    def self.parse(string)
+      parser = find_parser(string)
+      return nil unless parser
+      parser.parse
+    end
+
+    def self.find_parser(string)
+      parser_class = RangeParser.parser_classes.find do |klass|
+        klass.can_parse?(string)
+      end
+      return parser_class.new(string) if parser_class
+      nil
+    end
+
+    def self.inherited(subclass)
+      RangeParser.parser_classes << subclass
+    end
+
+    def initialize(string)
+      @string = string
+    end
+  end
+end

data/lib/flexyear/range_parsers/specific_year_parser.rb

@@ -0,0 +1,11 @@
+class FlexYear
+  class SpecificYearParser < RangeParser
+    def self.can_parse?(string)
+      string =~ /\A\d+\z/
+    end
+
+    def parse
+      [0, 0]
+    end
+  end
+end

data/lib/flexyear/range_parsers/year_range_parser.rb

@@ -0,0 +1,10 @@
+class FlexYear
+  class YearRangeParser < RangeParser
+    def self.can_parse?(string)
+      string.include?('-') && string =~ /(\d+)\s*-\s*(\d+)/
+    end
+
+    # Nothing to do here, see FlexYear#parse_year
+    def parse; end
+  end
+end

data/lib/flexyear/version.rb

@@ -1,3 +1,3 @@
-module Flexyear
-  VERSION = "0.0.1"
+class FlexYear
+  VERSION = "0.0.2"
 end

data/lib/flexyear.rb

@@ -1,3 +1,11 @@
+require 'flexyear/range_parsers/range_parser'
+require 'flexyear/range_parsers/early_parser'
+require 'flexyear/range_parsers/mid_parser'
+require 'flexyear/range_parsers/late_parser'
+require 'flexyear/range_parsers/decade_parser'
+require 'flexyear/range_parsers/year_range_parser'
+require 'flexyear/range_parsers/circa_parser'
+require 'flexyear/range_parsers/specific_year_parser'
 require 'flexyear/version'
 require 'date'
 
@@ -14,39 +22,10 @@ class FlexYear
 
   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
+    @low, @high = RangeParser.parse(@year_string)
 
     parse_year
   end
@@ -73,20 +52,25 @@ class FlexYear
   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
+    if @year_string =~ /(\d+)\s*-\s*(\d+)/ && $1 && $2
+      @year_low = centuryize($1).to_i
+      @year_low, @year_high = [@year_low, centuryize($2, @year_low).to_i].sort
     else
-      @base_year = @year_string.gsub(/\D+/,'').to_i
-    end
+      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
+      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)
+      @year_low = @base_year + (@low || 0)
+      @year_high = @base_year + (@high || 0)
+    end
   end
 
   # Represents a flexible year entry that must be in the past.

data/spec/flexyear_spec.rb

@@ -82,6 +82,12 @@ describe FlexYear do
     end
   end
 
+  context "given a range 1975-1973 (from high to low)" do
+    subject { FlexYear.new('1975-1973') }
+    its(:year_low) { should eq(1973) }
+    its(:year_high) { should eq(1975) }
+  end
+
   context "given a range" do
     ["2003-4", "2003-04"].each do |range|
       subject { FlexYear.new(range) }
@@ -90,12 +96,6 @@ describe FlexYear do
     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)') }

metadata

@@ -1,95 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: flexyear
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.2
 platform: ruby
-authors: 
+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 
+date: 2013-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Parse common year range formats like '1973-75' or natural language ranges like 'mid 80s'
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+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: 
+files:
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - flexyear.gemspec
 - lib/flexyear.rb
+- lib/flexyear/range_parsers/circa_parser.rb
+- lib/flexyear/range_parsers/decade_parser.rb
+- lib/flexyear/range_parsers/early_parser.rb
+- lib/flexyear/range_parsers/late_parser.rb
+- lib/flexyear/range_parsers/mid_parser.rb
+- lib/flexyear/range_parsers/range_parser.rb
+- lib/flexyear/range_parsers/specific_year_parser.rb
+- lib/flexyear/range_parsers/year_range_parser.rb
 - lib/flexyear/version.rb
 - spec/flexyear_spec.rb
-has_rdoc: true
 homepage: http://github.com/reverbdev/flexyear
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+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: 1.3.6
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Natural language year range parser
-test_files: 
+test_files:
 - spec/flexyear_spec.rb
+has_rdoc: