circa 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c96a7be7dbfc6799b76fb01492897d79ea09a3a
+  data.tar.gz: 4ced0fb59c9d6e8aa4fcdd3c1924768aa202f6e6
+SHA512:
+  metadata.gz: e7ad0307a6212212c173fb246acc73ebeb7fdea0e390eb285187c7763a1f299e7365c481720062d46254d12fe92e77bcfff8a10fa5dc0c44866b056dd0364bb1
+  data.tar.gz: 9e8861a92cf222e219eb3cab238c147d3bde5a73fb6b3ea71256a6c1d9eb059b3c4c1fb36e0bfc42515b3030a63ce7910c2260a4075538b2348f0d6430aee8f1

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/lib/circa.rb

@@ -1,8 +1,17 @@
+# encoding: UTF-8
+
 require 'circa/version'
 require 'circa/date'
 require 'circa/time'
 
 module Circa
+  # Convenience method to create a new {Circa::Date} or {Circa::Time}
+  # @param [String] input_string
+  #   A string in format %Y-%m-%d or %Y-%m-%d %H:%M:%S
+  # @return [Circa::Date/Circa::Time]
+  #   A new {Circa::Date} or {Circa::Time} depending on input
+  # @raise [ArgumentError]
+  #   If an invalid input string is given
   def circa(input_string)
     if match_date(input_string)
       Date.new(input_string)

data/lib/circa/date.rb

@@ -1,13 +1,28 @@
 # encoding: UTF-8
 
+require 'date'
 require_relative 'util'
 
 module Circa
+  # Manage partial dates.
+  # @!attribute [r] valid_parts
+  #   @return [Hash]
+  #     A hash of valid parts in the date,
+  #     with keys [:year, :month, :day] where applicable,
+  #     and according values
   class Date
     include Util
+
+    # Match partial dates in format %Y-%m-%d
     REGEX = /^(\d{4})(?:-(0[0-9]|1[0-2])(?:-([0-2][0-9]|3[0-1])))$/
+
     attr_reader :valid_parts
 
+    # Create a new {Circa::Date}
+    # @param [String] date_string
+    #   A string in format %Y-%m-%d
+    # @raise [ArgumentError]
+    #  If an invalid string is given
     def initialize(date_string)
       @year = '0000'
       @month = '00'
@@ -18,10 +33,16 @@ module Circa
       end
     end
 
+    # Get the date as a string
+    # @return [String]
+    #   A string in format %Y-%m-%d
     def to_s
       "#{@year}-#{@month}-#{@day}"
     end
 
+    # Get the date as a {::Date}
+    # @return [::Date]
+    #   A {::Date}
     def to_date
       return nil if valid_parts.empty?
       parts = [:year, :month, :day]

data/lib/circa/time.rb

@@ -4,10 +4,18 @@ require_relative 'date'
 require_relative 'util'
 
 module Circa
+  # Manage partial times.
   class Time
     include Util
+
+    # Match times in format %H:%M:%S
     REGEX = /^([0-1][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])Z?$/
 
+    # Create a new {Circa::Time}
+    # @param [String] time_string
+    #   A string in format %Y-%m-%d %H:%M:%S
+    # @raise [ArgumentError]
+    #   If an invalid string is given
     def initialize(time_string)
       parts = time_string.split(/T|\s/)
       @date = Date.new(parts[0])
@@ -20,15 +28,26 @@ module Circa
       end
     end
 
+    # Get the time as a string
+    # @return [String]
+    #   {Circa::Date#to_s} plus the time in format %H:%M:%S
     def to_s
       "#{@date.to_s} #{@hour}:#{@minute}:#{@second}"
     end
 
+    # Get the valid parts of the time
+    # @return [Hash]
+    #   A hash with keys [:year, :month, :day, :hour, :minute, :second]
+    #   where each of those keys is valid in the time,
+    #   and values per the keys
     def valid_parts
       time_parts = { hour: @hour, minute: @minute, second: @second }
       @date.valid_parts.merge(time_parts)
     end
 
+    # Get the time as a {::DateTime}
+    # @return [DateTime]
+    #   A {::DateTime}
     def to_time
       parts = [:year, :month, :day, :hour, :minute, :second]
       args = valid_parts_as_args(parts)

data/lib/circa/util.rb

@@ -2,6 +2,9 @@
 
 module Circa
   module Util
+
+    private
+
     def valid_parts_as_args(parts)
       valid = self.valid_parts
       parts.take_while {|p| valid[p] }.map {|p| valid[p].to_i }

data/lib/circa/version.rb

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

data/spec/circa/date_spec.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require 'minitest/spec'
+require_relative '../spec_helper'
 require_relative '../../lib/circa/date'
 
 describe Circa::Date do

data/spec/circa/time_spec.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require 'minitest/spec'
+require_relative '../spec_helper'
 require_relative '../../lib/circa/time'
 
 describe Circa::Time do

data/spec/circa_spec.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 
-require 'minitest/spec'
+require_relative 'spec_helper'
 require_relative '../lib/circa'
 
 describe Circa do

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+# encoding: UTF-8
+
+require 'minitest/autorun'

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: circa
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Robert Dallas Gray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,23 +27,20 @@ dependencies:
 - !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
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,33 +55,29 @@ dependencies:
 - !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
@@ -113,32 +102,34 @@ files:
 - spec/circa/date_spec.rb
 - spec/circa/time_spec.rb
 - spec/circa_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 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
+- spec/spec_helper.rb
+has_rdoc: