interpreted_date 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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.3@interpreted-date"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interpreted_date.gemspec
+gemspec
+
+group :test do
+	gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brett Huneycutt
+
+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,29 @@
+# InterpretedDate
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'interpreted_date'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interpreted_date
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/interpreted_date.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interpreted_date/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "interpreted_date"
+  gem.version       = InterpretedDate::VERSION
+  gem.authors       = ["Brett Huneycutt"]
+  gem.email         = ["brett@1000memories.com"]
+  gem.description   = %q{Human readable dates from incomplete dates}
+  gem.summary       = %q{Provide one, some or all of decade, year, month and day and get back a human readable date.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/interpreted_date/version.rb

@@ -0,0 +1,3 @@
+class InterpretedDate
+  VERSION = "0.0.1"
+end

data/lib/interpreted_date.rb

@@ -0,0 +1,93 @@
+require "interpreted_date/version"
+
+class InterpretedDate
+  attr_accessor :decade, :year, :month, :day
+
+  # Allows date strings to be generated with Ruby even for dates w/o years
+  DEFAULT_YEAR = -1
+
+  def initialize(attributes = {})
+    self.decade = attributes[:decade]
+    self.year = attributes[:year]
+    self.month = attributes[:month]
+    self.day = attributes[:day]
+  end
+
+  def self.from_date(date)
+    new(year: date.year, month: date.month, day: date.day)
+  end
+
+  def interpreted_year
+    @interpreted_year ||= year || (decade && (decade + 5)) || DEFAULT_YEAR
+  end
+
+  def date_attributes
+    return @date_attributes  if @date_attributes
+
+    @date_attributes = [interpreted_year, month]
+    @date_attributes << day  if month
+    @date_attributes.compact!
+    @date_attributes
+  end
+
+  def date
+    @date ||= Date.new(*date_attributes)  if !date_attributes.empty?
+  rescue Exception => e
+    nil
+  end
+
+  def to_i
+    date.to_time.to_i  if date && (decade || year)
+  end
+
+  def to_s(options = {})
+    preposition = options.fetch(:preposition) { false }
+    if day && month && year && date
+      date.strftime("%B %-d, %Y")
+    elsif month && year && date
+      date.strftime("%B %Y")
+    elsif year && date
+      output = preposition ? "in " : ""
+      output << date.strftime("%Y")
+      output
+    elsif decade
+      output = preposition ? "in the " : ""
+      output << decade.to_s
+      output << "s"
+      output
+    elsif day && month && date
+      date.strftime("%B %-d")
+    end
+  end
+
+  def as_json(options = {})
+    {
+      'string' => self.to_s,
+      'integer' => self.to_i,
+      'decade' => decade,
+      'year' => year,
+      'month' => month,
+      'day' => day,
+    }
+  end
+
+  def self.interpret_date(date_string)
+    date, specificity = DateTools.date_and_specificity(date_string)
+
+    parts = {}
+
+    return  unless specificity
+
+    parts[:day] = date.day  if specificity <= 1
+    parts[:month] = date.month  if specificity <= 2
+    parts[:year] = date.year  if specificity <= 3
+    parts[:decade] = date.year - (date.year % 10) if specificity <= 5
+
+    new(parts)
+  end
+
+  def present?
+    [decade, year, month, day].any?(&:present?)
+  end
+
+end

data/spec/interpreted_date_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe InterpretedDate do
+
+  describe "with no date attributes" do
+    subject { InterpretedDate.new }
+
+    it "returns nil string" do
+      subject.to_s.should be_nil
+    end
+
+    it "returns nil integer" do
+      subject.to_i.should be_nil
+    end
+  end
+
+  describe "with decade only" do
+    subject { InterpretedDate.new({:decade => 1950}) }
+
+    it "returns the right string" do
+      subject.to_s.should eq("1950s")
+    end
+
+    it "optionally returns a string with a preposition" do
+      subject.to_s(preposition: true).should eq("in the 1950s")
+    end
+
+    it "returns the right integer" do
+      subject.to_i.should eq(Date.new(1955).to_time.to_i)
+    end
+  end
+
+  describe "with decade and year" do
+    subject { InterpretedDate.new({:decade => 1950, :year => 1954}) }
+
+    it "returns the right string" do
+      subject.to_s.should eq("1954")
+    end
+
+    it "optionally returns a string with a preposition" do
+      subject.to_s(preposition: true).should eq("in 1954")
+    end
+
+    it "returns the right integer" do
+      subject.to_i.should eq(Date.new(1954).to_time.to_i)
+    end
+  end
+
+  describe "with decade, year and month" do
+    subject { InterpretedDate.new({:decade => 1950, :year => 1955, :month => 3}) }
+
+    it "returns the right string" do
+      subject.to_s.should eq("March 1955")
+    end
+
+    it "returns the right integer" do
+      subject.to_i.should eq(Date.new(1955, 3).to_time.to_i)
+    end
+  end
+
+  describe "with decade, year, month and day" do
+    subject { InterpretedDate.new({:decade => 1950, :year => 1955, :month => 3, :day => 1}) }
+
+    it "returns the right string" do
+      subject.to_s.should eq("March 1, 1955")
+    end
+
+    it "returns the right integer" do
+      subject.to_i.should eq(Date.new(1955, 3, 1).to_time.to_i)
+    end
+  end
+
+  describe "with month and day" do
+    subject { InterpretedDate.new({:month => 10, :day => 31}) }
+
+    it "returns the right string" do
+      subject.to_s.should eq("October 31")
+    end
+
+    it "returns nil integer" do
+      subject.to_i.should be_nil
+    end
+  end
+
+  describe "with invalid date" do
+    subject { InterpretedDate.new({:year => 2012, :month => 2, :day => 31}) }
+
+    it "returns nil string" do
+      subject.to_s.should be_nil
+    end
+
+    it "returns nil integer" do
+      subject.to_i.should be_nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require './lib/interpreted_date'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: interpreted_date
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Brett Huneycutt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies: []
+description: Human readable dates from incomplete dates
+email:
+- brett@1000memories.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- interpreted_date.gemspec
+- lib/interpreted_date.rb
+- lib/interpreted_date/version.rb
+- spec/interpreted_date_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Provide one, some or all of decade, year, month and day and get back a human
+  readable date.
+test_files:
+- spec/interpreted_date_spec.rb
+- spec/spec_helper.rb