diff --git a/lib/validates_timeliness/formats.rb b/lib/validates_timeliness/formats.rb index 2b46271..deb10ed 100644 --- a/lib/validates_timeliness/formats.rb +++ b/lib/validates_timeliness/formats.rb @@ -1,19 +1,18 @@ # TODO add support switching US to euro date formats module ValidatesTimeliness module Formats - mattr_accessor :valid_time_formats - mattr_accessor :valid_date_formats - mattr_accessor :valid_datetime_formats + mattr_accessor :time_formats + mattr_accessor :date_formats + mattr_accessor :datetime_formats - mattr_accessor :valid_time_expressions - mattr_accessor :valid_date_expressions - mattr_accessor :valid_datetime_expressions + mattr_accessor :time_expressions + mattr_accessor :date_expressions + mattr_accessor :datetime_expressions mattr_accessor :format_tokens mattr_accessor :format_proc_args - # Format tokens: - # + # Format tokens: # y = year # m = month # d = day @@ -23,26 +22,28 @@ module ValidatesTimeliness # u = micro-seconds # ampm = meridian (am or pm) with or without dots (e.g. am, a.m, or a.m.) # _ = optional space - # tz = Timezone abrreviation (e.g. UTC, GMT, PST, EST) + # tz = Timezone abbreviation (e.g. UTC, GMT, PST, EST) # zo = Timezone offset (e.g. +10:00, -08:00) # # All other characters are considered literal. You can embed regexp in the # format but no gurantees that it will remain intact. If you avoid the use - # of any token characters in the regexp it may well work as expected. + # of any token characters in the regexp it may well work as expected. # - # Repeating tokens: - # + # Repeating tokens: # x = 1 or 2 digits for unit (e.g. 'h' means an hour can be '9' or '09') # xx = 2 digits exactly for unit (e.g. 'hh' means an hour can only be '09') + # + # Special Cases: # yyyyy = exactly 4 digit year # mmm = month long name (e.g. 'Jul' or 'July') + # ddd = Day name of 3 to 9 letters (e.g. Wed or Wednesday) + # u = microseconds matches 1 to 3 digits # - # u = Special case which matches 1 to 3 digits - # - # Any other combination of repeating tokens will be swallowed up by the next - # lowest length valid repeating token (e.g. yyy will be replaced with yy) + # Any other invalid combination of repeating tokens will be swallowed up + # by the next lowest length valid repeating token (e.g. yyy will be + # replaced with yy) - @@valid_time_formats = [ + @@time_formats = [ 'hh:nn:ss', 'hh-nn-ss', 'hh:nn', @@ -56,7 +57,7 @@ module ValidatesTimeliness 'h_ampm' ] - @@valid_date_formats = [ + @@date_formats = [ 'yyyy/mm/dd', 'yyyy-mm-dd', 'yyyy.mm.dd', @@ -72,20 +73,21 @@ module ValidatesTimeliness 'd mmm yy' ] - @@valid_datetime_formats = [ + @@datetime_formats = [ 'dd/mm/yyyy hh:nn:ss', 'dd/mm/yyyy hh:nn', 'yyyy-mm-dd hh:nn:ss', 'yyyy-mm-dd hh:nn', + 'ddd mmm d hh:nn:ss zo yyyy', # Ruby time string 'yyyy-mm-ddThh:nn:ss(?:Z|zo)' # iso 8601 ] - # All tokens available for format construction. The token - # array is made of token regexp, validation regexp and key for - # format proc mapping if any. If the token needs no format - # proc arg then the validation regexp should not have a capturing - # group, as all captured groups are passed to the format proc. + # All tokens available for format construction. The token array is made of + # token regexp, validation regexp and key for format proc mapping if any. + # If the token needs no format proc arg then the validation regexp should + # not have a capturing group, as all captured groups are passed to the + # format proc. @@format_tokens = [ { 'mmm' => [ /m{3,}/, '(\w{3,9})', :month ] }, { 'mm' => [ /m{2}/, '(\d{2})', :month ] }, @@ -99,26 +101,27 @@ module ValidatesTimeliness { 'ss' => [ /s{2,}/, '(\d{2})', :sec ] }, { 's' => [ /s{1}/, '(\d{1,2})', :sec ] }, { 'u' => [ /u{1,}/, '(\d{1,3})', :usec ] }, + { 'ddd' => [ /d{3,}/, '(\w{3,9})' ] }, { 'dd' => [ /d{2,}/, '(\d{2})', :day ] }, - { 'd' => [ /(?:[^\\]|\A)d{1}/, '(\d{1,2})', :day ] }, + { 'd' => [ /(?:[^\\]|\A)d{1}/, '(\d{1,2})', :day ] }, #/ { 'ampm' => [ /ampm/, '((?:a|p)\.?m\.?)', :meridian ] }, - { 'zo' => [ /zo/, '(?:[-+]\d{2}:\d{2})'] }, + { 'zo' => [ /zo/, '(?:[+-]\d{2}:?\d{2})'] }, { 'tz' => [ /tz/, '(?:\[A-Z]{1,4})' ] }, { '_' => [ /_/, '\s?' ] } ] # Arguments whichs will be passed to the format proc if matched in the - # time string. The key must match the key from the format tokens. The array + # time string. The key must should the key from the format tokens. The array # consists of the arry position of the arg, the arg name, and the code to - # place in the time array slot. The position can be nil which means the arh + # place in the time array slot. The position can be nil which means the arg # won't be placed in the array. # - # The code can be used to run manipulations - # of the arg value if required, otherwise should just be the arg name. + # The code can be used to manipulate the arg value if required, otherwise + # should just be the arg name. # @@format_proc_args = { :year => [0, 'y', 'unambiguous_year(y)'], - :month => [1, 'm', 'm'], + :month => [1, 'm', 'month_index(m)'], :day => [2, 'd', 'd'], :hour => [3, 'h', 'full_hour(h,md)'], :min => [4, 'n', 'n'], @@ -132,8 +135,7 @@ module ValidatesTimeliness regexp = string_format.dup order = {} ord = lambda {|k| order[k] = $~.begin(0) } - regexp.gsub!(/([\.\/])/, '\\1') - + #regexp = Regexp.escape(regexp) format_tokens.each do |token| token_regexp, regexp_str, arg_key = *token.values.first regexp.gsub!(token_regexp, regexp_str) && !arg_key.nil? && ord.call(arg_key) @@ -154,28 +156,28 @@ module ValidatesTimeliness # # Examples: # - # 'yyyy-mm-dd hh:nn' => lambda {|y,m,d,h,n| md||=0; [unambiguous_year(y),m,d,full_hour(h,md),n,nil,nil] } - # 'dd/mm/yyyy h:nn_ampm' => lambda {|d,m,y,h,n,md| md||=0; [unambiguous_year(y),m,d,full_hour(h,md),n,nil,nil] } + # 'yyyy-mm-dd hh:nn' => lambda {|y,m,d,h,n| md||=0; [unambiguous_year(y),month_index(m),d,full_hour(h,md),n,nil,nil].map {|t| t.to_i unless t.nil? } } + # 'dd/mm/yyyy h:nn_ampm' => lambda {|d,m,y,h,n,md| md||=0; [unambiguous_year(y),month_index(m),d,full_hour(h,md),n,nil,nil].map {|t| t.to_i unless t.nil? } } # def self.format_proc(order) arg_map = format_proc_args args = order.invert.sort.map {|p| arg_map[p[1]][1] } arr = [nil] * 7 order.keys.each {|k| i = arg_map[k][0]; arr[i] = arg_map[k][2] unless i.nil? } - proc_string = "lambda {|#{args.join(',')}| md||=nil; [#{arr.map {|i| i.nil? ? 'nil' : i }.join(',')}] }" + proc_string = "lambda {|#{args.join(',')}| md||=nil; [#{arr.map {|i| i.nil? ? 'nil' : i }.join(',')}].map {|t| t.to_i unless t.nil? } }" eval proc_string end def self.compile_formats(formats) - formats.collect do |format| + formats.collect { |format| regexp, format_proc = format_expression_generator(format) - end + } end def self.compile_format_expressions - @@valid_time_expressions = compile_formats(@@valid_time_formats) - @@valid_date_expressions = compile_formats(@@valid_date_formats) - @@valid_datetime_expressions = compile_formats(@@valid_datetime_formats) + @@time_expressions = compile_formats(@@time_formats) + @@date_expressions = compile_formats(@@date_formats) + @@datetime_expressions = compile_formats(@@datetime_formats) end def self.full_hour(hour, meridian) @@ -192,6 +194,10 @@ module ValidatesTimeliness year = "#{year.to_i < threshold ? '20' : '19'}#{year}" if year.length == 2 year.to_i end - + + def self.month_index(month) + return month.to_i if month.to_i.nonzero? + Date::ABBR_MONTHNAMES.index(month.capitalize) || Date::MONTHNAMES.index(month.capitalize) + end end end diff --git a/lib/validates_timeliness/validations.rb b/lib/validates_timeliness/validations.rb index dcb1fd1..e216556 100644 --- a/lib/validates_timeliness/validations.rb +++ b/lib/validates_timeliness/validations.rb @@ -22,17 +22,14 @@ module ValidatesTimeliness module ClassMethods # loop through format regexps and call proc on matches if available. Allow # pre or post match strings if bounded is false. Lastly fills out - # time_array to full 6 part datetime array. + # time_array to full 7 part datetime array. def extract_date_time_values(time_string, type, bounded=true) - expressions = ValidatesTimeliness::Formats.send("valid_#{type}_expressions") + expressions = ValidatesTimeliness::Formats.send("#{type}_expressions") time_array = nil expressions.each do |(regexp, processor)| matches = regexp.match(time_string.strip) if !matches.nil? && (!bounded || (matches.pre_match == "" && matches.post_match == "")) - time_array = matches[1..7] if processor.nil? - time_array = processor.call(*matches[1..7]) unless processor.nil? - time_array = time_array.map {|i| i.to_i } - time_array += [nil] * (7 - time_array.length) + time_array = processor.call(*matches[1..7]) break end end diff --git a/spec/formats_spec.rb b/spec/formats_spec.rb new file mode 100644 index 0000000..22b2efb --- /dev/null +++ b/spec/formats_spec.rb @@ -0,0 +1,154 @@ +require File.dirname(__FILE__) + '/spec_helper' + +describe ValidatesTimeliness::Formats do + attr_reader :formats + + before do + @formats = ValidatesTimeliness::Formats + end + + describe "expression generator" do + it "should generate regexp for time" do + generate_regexp_str('hh:nn:ss').should == '/(\d{2}):(\d{2}):(\d{2})/' + end + + it "should generate regexp for time with meridian" do + generate_regexp_str('hh:nn:ss ampm').should == '/(\d{2}):(\d{2}):(\d{2}) ((?:a|p)\.?m\.?)/' + end + + it "should generate regexp for time with meridian and optional space between" do + generate_regexp_str('hh:nn:ss_ampm').should == '/(\d{2}):(\d{2}):(\d{2})\s?((?:a|p)\.?m\.?)/' + end + + it "should generate regexp for time with single or double digits" do + generate_regexp_str('h:n:s').should == '/(\d{1,2}):(\d{1,2}):(\d{1,2})/' + end + + it "should generate regexp for date" do + generate_regexp_str('yyyy-mm-dd').should == '/(\d{4})-(\d{2})-(\d{2})/' + end + + it "should generate regexp for date with slashes" do + generate_regexp_str('dd/mm/yyyy').should == '/(\d{2})\/(\d{2})\/(\d{4})/' + end + + it "should generate regexp for date with dots" do + generate_regexp_str('dd.mm.yyyy').should == '/(\d{2}).(\d{2}).(\d{4})/' + end + + it "should generate regexp for Ruby time string" do + expected = '/(\w{3,9}) (\w{3,9}) (\d{2}):(\d{2}):(\d{2}) (?:[+-]\d{2}:?\d{2}) (\d{4})/' + generate_regexp_str('ddd mmm hh:nn:ss zo yyyy').should == expected + end + + it "should generate regexp for iso8601 datetime" do + expected = '/(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:[+-]\d{2}:?\d{2})/' + generate_regexp_str('yyyy-mm-ddThh:nn:sszo').should == expected + end + end + + describe "format proc generator" do + it "should generate proc which outputs date array" do + generate_proc('yyyy-mm-dd').call('2000', '1', '2').should == [2000,1,2,nil,nil,nil,nil] + end + + it "should generate proc which outputs date array from format in non time array order" do + generate_proc('dd/mm/yyyy').call('2', '1', '2000').should == [2000,1,2,nil,nil,nil,nil] + end + + it "should generate proc which outputs time array" do + generate_proc('hh:nn:ss').call('01', '02', '03').should == [nil,nil,nil,1,2,3,nil] + end + + it "should generate proc which outputs time array with meridian adjusted hour" do + generate_proc('hh:nn:ss ampm').call('01', '02', '03', 'pm').should == [nil,nil,nil,13,2,3,nil] + end + + it "should generate proc which outputs time array with unadjusted hour" do + generate_proc('hh:nn:ss ampm').call('01', '02', '03', 'am').should == [nil,nil,nil,1,2,3,nil] + end + + it "should generate proc which outputs time array with microseconds" do + generate_proc('hh:nn:ss.u').call('01', '02', '03', '99').should == [nil,nil,nil,1,2,3,99] + end + end + + describe "validation regexps" do + + describe "for time formats" do + format_tests = { + 'hh:nn:ss' => {:pass => ['12:12:12', '01:01:01'], :fail => ['1:12:12', '12:1:12', '12:12:1', '12-12-12']}, + 'hh-nn-ss' => {:pass => ['12-12-12', '01-01-01'], :fail => ['1-12-12', '12-1-12', '12-12-1', '12:12:12']}, + 'hh:nn' => {:pass => ['12:12', '01:01'], :fail => ['12:12:12', '12-12', '2:12']}, + 'h.nn' => {:pass => ['2.12', '12.12'], :fail => ['2.1', '12:12']} +# 'h nn', +# 'h-nn', +# 'h:nn_ampm', +# 'h.nn_ampm', +# 'h nn_ampm', +# 'h-nn_ampm', +# 'h_ampm' + + } + format_tests.each do |format, values| + it "should correctly match times in format '#{format}'" do + regexp = generate_regexp(format) + values[:pass].each {|value| value.should match(regexp)} + values[:fail].each {|value| value.should_not match(regexp)} + end + end + end + + end + + describe "removing format" do + before do + formats.compile_format_expressions + end + + it "should not match time after its format is removed" do + validate('12am', :time).should be_true + formats.time_formats.delete('h_ampm') + formats.compile_format_expressions + validate('12am', :time).should be_false + end + end + + describe "adding format" do + before do + formats.compile_format_expressions + end + + it "should not match time after its format is removed" do + validate("12 o'clock", :time).should be_false + formats.time_formats << "h o'clock" + formats.compile_format_expressions + validate("12 o'clock", :time).should be_true + end + end + + def validate(time_string, type) + valid = false + formats.send("#{type}_expressions").each do |(regexp, processor)| + valid = true and break if regexp =~ time_string + end + valid + end + + def generate_regexp(format) + # wrap in line start and end anchors to emulate extract values method + /\A#{formats.format_expression_generator(format)[0]}\Z/ + end + + def generate_regexp_str(format) + formats.format_expression_generator(format)[0].inspect + end + + def generate_proc(format) + formats.format_expression_generator(format)[1] + end + + def delete_format(type, format) + formats.send("#{type}_formats").delete(format) + end +end diff --git a/spec/validations_spec.rb b/spec/validations_spec.rb index cfc28df..ed963b8 100644 --- a/spec/validations_spec.rb +++ b/spec/validations_spec.rb @@ -1,5 +1,3 @@ -# TODO spec removing and adding formats -# TODO spec all formats require File.dirname(__FILE__) + '/spec_helper' describe ValidatesTimeliness::Validations do