circa 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 circa.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+
+guard :minitest do
+  watch(%r|^spec/(.+)_spec\.rb$|)
+  watch(%r|^lib/(.+)\.rb$|) { |m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Robert Dallas Gray
+
+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,18 @@
+# Circa
+
+Use MySQL-style partial dates in Rails (and elsewhere).
+
+```ruby
+$ date = circa('2001-01-00')
+$ date.valid_parts
+{ year: '2001', month: '01' }
+$ date.to_date.to_s
+'2001-01-01'
+$ time = circa('2001-01-11 13:30:00')
+$ time.valid_parts
+{ year: '2001', month: '01', day: '11', hour: '13', minute: '30', second: '00' }
+```
+
+## Installation
+
+    $ gem install circa

data/Rakefile

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

data/circa.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'circa'
+  spec.version       = Circa::VERSION
+  spec.authors       = ['Robert Dallas Gray']
+  spec.email         = ['mail@robertdallasgray.com']
+  spec.description   = %q{Utilities for working with MySQL-style partial dates}
+  spec.summary       = %q{Utilities for working with MySQL-style partial dates}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'm', '~> 1.3.1'
+  spec.add_development_dependency 'guard', '>= 1.8'
+  spec.add_development_dependency 'guard-minitest'
+end

data/lib/circa.rb

@@ -0,0 +1,27 @@
+require 'circa/version'
+require 'circa/date'
+require 'circa/time'
+
+module Circa
+  def circa(input_string)
+    if match_date(input_string)
+      Date.new(input_string)
+    elsif match_time(input_string)
+      Time.new(input_string)
+    else
+      raise ArgumentError, "Invalid input string: #{input_string}"
+    end
+  end
+
+  private
+
+  def match_date(input_string)
+    input_string =~ Date::REGEX
+  end
+
+  def match_time(input_string)
+    date_re = Date::REGEX.source.sub(/\$$/, '')
+    time_re = Time::REGEX.source.sub(/^\^/, '')
+    input_string =~ Regexp.new("#{date_re}T|\s#{time_re}")
+  end
+end

data/lib/circa/date.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+require_relative 'util'
+
+module Circa
+  class Date
+    include Util
+    REGEX = /^(\d{4})(?:-(0[0-9]|1[0-2])(?:-([0-2][0-9]|3[0-1])))$/
+    attr_reader :valid_parts
+
+    def initialize(date_string)
+      @year = '0000'
+      @month = '00'
+      @day = '00'
+      @valid_parts = {}
+      unless validate(date_string)
+        raise ArgumentError, "Invalid date: #{date_string}"
+      end
+    end
+
+    def to_s
+      "#{@year}-#{@month}-#{@day}"
+    end
+
+    def to_date
+      return nil if valid_parts.empty?
+      parts = [:year, :month, :day]
+      args = valid_parts_as_args(parts)
+      ::Date.send(:new, *args)
+    end
+
+    private
+
+    def validate(date_string)
+      matches = REGEX.match(date_string)
+      return false if matches.nil?
+      set_year(matches) && set_month(matches) && set_day(matches)
+    end
+
+    def set_year(matches)
+      @year = matches[1]
+      set_dependent(@year, matches[2], :year)
+    end
+
+    def set_month(matches)
+      @month = matches[2]
+      set_dependent(@month, matches[3], :month)
+    end
+
+    def set_dependent(a, b, name)
+      a.to_i > 0 ? @valid_parts[name] = a : b.to_i == 0
+    end
+
+    def set_day(matches)
+      @day = matches[3]
+      if @day.to_i > 0
+        return false unless ::Date.strptime(matches[0]).to_s == matches[0]
+        @valid_parts[:day] = @day
+      end
+      true
+    end
+  end
+end

data/lib/circa/time.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+require_relative 'date'
+require_relative 'util'
+
+module Circa
+  class Time
+    include Util
+    REGEX = /^([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z?$/
+
+    def initialize(time_string)
+      parts = time_string.split(/T|\s/)
+      @date = Date.new(parts[0])
+      @hour = '00'
+      @minute = '00'
+      @second = '00'
+      @valid_parts = {}
+      unless validate(parts[1])
+        raise ArgumentError, "Invalid time: #{time_string}"
+      end
+    end
+
+    def to_s
+      "#{@date.to_s} #{@hour}:#{@minute}:#{@second}"
+    end
+
+    def valid_parts
+      time_parts = { hour: @hour, minute: @minute, second: @second }
+      @date.valid_parts.merge(time_parts)
+    end
+
+    def to_time
+      parts = [:year, :month, :day, :hour, :minute, :second]
+      args = valid_parts_as_args(parts)
+      ::DateTime.send(:new, *args)
+    end
+
+    private
+
+    def validate(time_string)
+      time_string.chomp!('Z')
+      matches = REGEX.match(time_string)
+      set_time(matches) if matches
+    end
+
+    def set_time(matches)
+      @hour, @minute, @second = matches[1..3]
+      [@hour, @minute, @second].join.to_i == 0 || @date.valid_parts[:day]
+    end
+  end
+end

data/lib/circa/util.rb

@@ -0,0 +1,10 @@
+# encoding: UTF-8
+
+module Circa
+  module Util
+    def valid_parts_as_args(parts)
+      valid = self.valid_parts
+      parts.take_while {|p| valid[p] }.map {|p| valid[p].to_i }
+    end
+  end
+end

data/lib/circa/version.rb

@@ -0,0 +1,5 @@
+# coding: UTF-8
+
+module Circa
+  VERSION = '0.0.1'
+end

data/spec/circa/date_spec.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+require 'minitest/spec'
+require_relative '../../lib/circa/date'
+
+describe Circa::Date do
+
+  before do
+    @correct_date = '2001-11-11'
+    @zero_year = '0000-11-11'
+    @zero_month = '2001-00-11'
+    @incorrect_date = '2001-02-30'
+    @partial_date = '2001-11-00'
+    @zero_date = '0000-00-00'
+  end
+
+  it 'should reject a date with a zero year and non-zero month' do
+    -> { Circa::Date.new(@zero_year) }.must_raise ArgumentError
+  end
+
+  it 'should reject a date with a zero month and non-zero day' do
+    -> { Circa::Date.new(@zero_month) }.must_raise ArgumentError
+  end
+
+  it 'should reject an incorrect date' do
+    -> { Circa::Date.new(@incorrect_date) }.must_raise ArgumentError
+  end
+
+  it 'should return a correct date string intact' do
+    Circa::Date.new(@correct_date).to_s.must_equal '2001-11-11'
+  end
+
+  it 'should return a correct partial date string' do
+    Circa::Date.new(@partial_date).to_s.must_equal '2001-11-00'
+  end
+
+  it 'should return valid date parts for a complete date' do
+    parts = Circa::Date.new(@correct_date).valid_parts
+    parts.must_equal({ year: '2001', month: '11', day: '11' })
+  end
+
+  it 'should return valid date parts for a partial date' do
+    parts = Circa::Date.new(@partial_date).valid_parts
+    parts.must_equal({ year: '2001', month: '11' })
+  end
+
+  it 'should return a correct date given a correct date string' do
+    date = Circa::Date.new(@correct_date).to_date
+    date.must_equal Date.new(2001, 11, 11)
+  end
+
+  it 'should return a correct date given a partial date' do
+    date = Circa::Date.new(@partial_date).to_date
+    date.must_equal Date.new(2001, 11, 01)
+  end
+
+  it 'should return nil on to_date given a zero date' do
+    date = Circa::Date.new(@zero_date).to_date
+    date.must_be_nil
+  end
+end

data/spec/circa/time_spec.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+require 'minitest/spec'
+require_relative '../../lib/circa/time'
+
+describe Circa::Time do
+
+  before do
+    @correct_time = '2001-11-11 13:30:30'
+    @incorrect_time = '2001-11-11 24:30:30'
+    @zero_day = '2001-11-00 13:30:30'
+    @utc = '2001-11-11T13:30:30Z'
+    @partial_time = '2001-11-00 00:00:00'
+  end
+
+  it 'should return a correct time string intact' do
+    Circa::Time.new(@correct_time).to_s.must_equal @correct_time
+  end
+
+  it 'should return a partial time string intact' do
+    Circa::Time.new(@partial_time).to_s.must_equal @partial_time
+  end
+
+  it 'should reject an incorrect time string' do
+    -> { Circa::Time.new(@incorrect_time) }.must_raise ArgumentError
+  end
+
+  it 'should reject a time with a zero day' do
+    -> { Circa::Time.new(@zero_day) }.must_raise ArgumentError
+  end
+
+  it 'should accept a UTC time string' do
+    Circa::Time.new(@utc).to_s.must_equal @correct_time
+  end
+
+  it 'should return valid parts' do
+    t = Circa::Time.new(@correct_time)
+    valid_parts = {
+      year: '2001', month: '11', day: '11',
+      hour: '13', minute: '30', second: '30'
+    }
+    t.valid_parts.must_equal valid_parts
+  end
+
+  it 'should return a correct datetime given a correct time' do
+    t = Circa::Time.new(@correct_time)
+    t.to_time.must_equal DateTime.new(2001, 11, 11, 13, 30, 30)
+  end
+
+  it 'should return a correct datetime given a partial time' do
+    t = Circa::Time.new(@partial_time)
+    t.to_time.must_equal DateTime.new(2001, 11, 1, 0, 0, 0)
+  end
+end

data/spec/circa_spec.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+require 'minitest/spec'
+require_relative '../lib/circa'
+
+describe Circa do
+
+  before do
+    class Circafied
+      include Circa
+    end
+    @circafied = Circafied.new
+  end
+
+  it 'should return a new Circa::Date via a convenience method' do
+    d = @circafied.circa('2001-11-11')
+    d.must_be_instance_of Circa::Date
+  end
+
+  it 'should return a new Circa::Time via a convenience method' do
+    d = @circafied.circa('2001-11-11 13:30:30')
+    d.must_be_instance_of Circa::Time
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: circa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Dallas Gray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utilities for working with MySQL-style partial dates
+email:
+- mail@robertdallasgray.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circa.gemspec
+- lib/circa.rb
+- lib/circa/date.rb
+- lib/circa/time.rb
+- lib/circa/util.rb
+- lib/circa/version.rb
+- spec/circa/date_spec.rb
+- spec/circa/time_spec.rb
+- spec/circa_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Utilities for working with MySQL-style partial dates
+test_files:
+- spec/circa/date_spec.rb
+- spec/circa/time_spec.rb
+- spec/circa_spec.rb