time-lord 0.2.5 → 1.0.1

data/.gitignore

@@ -1,4 +1,34 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore
+
+# Ignore all of the generated gem stuff
+/pkg
+/*.gem
+
+# Ignore bundler config
+/.bundle
+/Gemfile.lock
+
+# Ignore all bundler caching
+/vendor/cache
+/vendor/ruby
+
+# Ignore all tempfiles
+/tmp
+
+# Ignores that should be in the global gitignore
+# /*.rbc
+# /.config
+/.yardoc
+# /InstalledFiles
+/_yardoc
+# /coverage/
+/doc/
+# /lib/bundler/man/
+# /rdoc/
+# /spec/reports/
+# /test/tmp/
+# /test/version_tmp/

data/.rvmrc

@@ -3,47 +3,51 @@
 # 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-p0@time-lord"
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p385@time-lord"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.6 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
 
-#
 # First we attempt to load the desired environment directly from the environment
-# file. This is very fast and efficicent compared to running through the entire
+# 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
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
   \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
-
-  [[ -s ".rvm/hooks/after_use" ]] && . ".rvm/hooks/after_use"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
 else
   # If the environment file has not yet been created, use the RVM CLI to select.
-  rvm --create  "$environment_id"
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
 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'
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
 # fi
-
-#
-# If you use bundler and would like to run bundle each time you enter the
-# directory, you can uncomment the following code.
-#
-#   # Ensure that Bundler is installed. Install it if it is not.
-#   if ! command -v bundle >/dev/null; then
-#      printf "The rubygem 'bundler' is not installed. Installing it now.\n"
-#      gem install bundler
-#   fi
-#
-#   # Bundle while reducing excess noise.
-#   printf "Bundling your gems. This may take a few minutes on a fresh clone.\n"
-#   bundle | grep -v '^Using ' | grep -v ' is complete' | sed '/^$/d'
-#
-

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode

data/COPYRIGHT

@@ -1,19 +1,22 @@
-Copyright (c) 2010 Kurtis Rainbolt-Greene:
+Copyright (c) 2013 Kurtis Rainbolt-Greene
 
-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:
+MIT License
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+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 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.
+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

@@ -1,33 +1,59 @@
 time-lord
 =========
 
-**Current Version**: 0.1.5
-
-`time-lord` is a gem that builds on the Time class to give more human expressions.
-It adds a lot of nifty little ideas present in Rails helpers to the time class.
-Nothing too fancy, just a little human touch to data.
+  - [![Gem Version](https://badge.fury.io/rb/time-lord.png)](https://rubygems.org/gems/time-lord)
+  - [![Code Climate](https://codeclimate.com/github/krainboltgreene/time-lord.png)](https://codeclimate.com/github/krainboltgreene/time-lord)
+  - [![Build Status](https://travis-ci.org/krainboltgreene/time-lord.png)](https://travis-ci.org/krainboltgreene/time-lord)
+  - [![Dependency Status](https://gemnasium.com/krainboltgreene/time-lord.png)](https://gemnasium.com/krainboltgreene/time-lord)
+  - [![Coverage Status](https://coveralls.io/repos/krainboltgreene/time-lord/badge.png?branch=master)](https://coveralls.io/r/krainboltgreene/time-lord)
 
+`time-lord` is a gem that gives you more human like expressions for time and space math.
+Underneath the covers `time-lord` gives you single purpose objects for handling the more complex parts of Time & Space.
+Specifically conversion, periods between two points, and scaling.
 
 Examples
 --------
 
-To use `time-lord` you need a Time, Date, or DateTime object.
-You can pass an object that doesn't act like those, but you'll have to tell it to try and parse.
-Even then it might not be able to, so be careful and just send Time-likes.
-Here's an example or two:
+In `time-lord` you have Period objects:
+
+``` ruby
+1.hour.ago.class #=> <TimeLord::Period @beginning=2013-03-03 23:44:59 -0800, @ending=2013-03-04 00:44:59 -0800>
+```
+
+Periods, if forced into strings or integers, represent the number of seconds between the two points
+
+``` ruby
+1.hour.ago.to_i #=> -3600
+```
+
+Obviously Periods act a lot like a Range and can be coerced into one:
 
 ``` ruby
-Time.now.ago_in_words
-  # => "just now"
+1.hour.ago.to_range #=> 1362383339..1362386939
+```
 
-olden_times = Time.parse("1942-04-01")
+You may have noticed the negative integer from `Period#to_i`.
+This represents the period beginning before the ending.
+The reverse comes from using `Period#from_now`:
 
-"I was dancing with Queen Elizabeth #{olden_times.ago_in_words} from now!"
+``` ruby
+1.hour.from_now.to_i #=> 3600
+```
 
-# => "I was dancing with Queen Elizabeth 7 decades ago from now!"
+Periods also have a special `Period#to_words` method:
+
+``` ruby
+1.hour.ago.to_words #=> "1 hour ago"
+200.minutes.ago.to_words #=> "3 hour ago"
+```
+
+Of course you can also do fun Time math:
+
+``` ruby
+Time.now #=> 2013-03-04 00:55:49 -0800
+Time.now - 2.hours #=> 2013-03-03 22:55:50 -0800
 ```
 
-There's a lot more to come hopefully.
 Time is fun.
 
 
@@ -36,9 +62,7 @@ Installing
 
 **Requirements**
 
-1. Any Ruby with a Time class
-2. Any Gem manager
-3. A blue telephone box
+1. A blue telephone box (optional)
 
 Like any other gem you can install it via the `gem` command:
 
@@ -49,7 +73,7 @@ $ gem install time-lord
 Although I suggest using `bundler`:
 
 ``` ruby
-gem 'time-lord', '0.1.5'
+gem 'time-lord', '~> 1.0'
 ```
 
 
@@ -58,8 +82,8 @@ gem 'time-lord', '0.1.5'
 To make sure you did everything right, just do the following:
 
 ```
-$ ruby -e "puts Time.now.ago_in_words"
-> just now
+$ ruby -e "1.hour.ago.to_words"
+> 1 hour ago
 ```
 
 
@@ -113,7 +137,7 @@ Credits
 License
 -------
 
-Copyright (c) 2011 Kurtis Rainbolt-Greene
+Copyright (c) 2013 Kurtis Rainbolt-Greene
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,2 +1,31 @@
-require 'bundler'
+#!/usr/bin/env ruby
+require 'bundler/gem_tasks'
+require 'rake/clean'
+require 'rake/testtask'
+require 'yard'
+
+begin
+  Bundler.setup :default, :development
+rescue Bundler::BundlerError => error
+  $stderr.puts error.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit error.status_code
+end
+
 Bundler::GemHelper.install_tasks
+
+desc "Run all of the tests"
+Rake::TestTask.new do |config|
+  config.libs << 'test'
+  config.pattern = 'test/**/*_test*'
+  config.verbose = true
+  config.warning = true
+end
+
+desc "Generate all of the docs"
+YARD::Rake::YardocTask.new do |config|
+  config.files = Dir['lib/**/*.rb']
+end
+
+desc 'Default: run tests, and generate docs'
+task :default => [ :test, :yard ]

data/lib/time-lord.rb

@@ -1,83 +1,8 @@
 require 'time'
 
-class Time
-  Second     = 1
-  Minute     = Second  * 60
-  Hour       = Minute  * 60
-  Day        = Hour    * 24
-  Week       = Day     * 7
-  Fortnight  = Week    * 2
-  Month      = Week    * 4
-  Quarter    = Month   * 3
-  Year       = Month   * 12
-  Olympiad   = Year    * 4
-  Lustrum    = Year    * 5
-  Decade     = Year    * 10
-  Indiction  = Year    * 15
-  Jubilee    = Decade  * 5
-  Century    = Decade  * 10
-  Millennium = Century * 10
-  Eon        = 1.0/0
-
-  def ago_in_words
-    # Find the time difference between the time provided and the current time.
-    difference = get_time_difference_from self
-
-    # Catch less than 1 second differences.
-    return "just now" if (-1...1) === difference
-
-    name   = get_unit_name_from difference
-    amount = get_unit_amount_from difference
-    count  = get_unit_count_from(difference, amount).abs
-
-    # Determine if unit name needs pluralization.
-    name += "s" if count > 1
-
-    # Return the remaining string.
-    difference >= 0 ? "#{count} #{name} ago" : "in #{count} #{name}"
-  end
-
-  private
-
-  def get_time_difference_from time
-    Time.now.to_i - time.to_i
-  end
-
-  def get_unit_count_from difference, amount
-    difference / amount
-  end
-
-  def get_unit_name_from difference
-    case difference.abs
-      when Second...Minute      then "second"
-      when Minute...Hour        then "minute"
-      when Hour...Day           then "hour"
-      when Day...Week           then "day"
-      when Week...Month         then "week"
-      when Month...Year         then "month"
-      when Year..Decade         then "year"
-      when Decade...Century     then "decade"
-      when Century...Millennium then "century"
-      when Millennium...Eon     then "millennium"
-    end
-  end
-
-  def get_unit_amount_from difference
-    case difference.abs
-      when Second...Minute      then Second
-      when Minute...Hour        then Minute
-      when Hour...Day           then Hour
-      when Day...Week           then Day
-      when Week...Month         then Week
-      when Month...Year         then Month
-      when Year..Decade         then Year
-      when Decade...Century     then Decade
-      when Century...Millennium then Century
-      when Millennium...Eon     then Millennium
-    end
-  end
-
-  alias_method :time_ago_in_words, :ago_in_words
-  alias_method :distance_in_words, :ago_in_words
-  alias_method :time_distance_in_words, :ago_in_words
-end
+require_relative 'time-lord/units'
+require_relative 'time-lord/time'
+require_relative 'time-lord/period'
+require_relative 'time-lord/scale'
+require_relative 'time-lord/extensions/integer'
+require_relative 'time-lord/extensions/time'

data/lib/time-lord/extensions/integer.rb

@@ -0,0 +1,16 @@
+class Integer
+  TimeLord::Units.constants.each do |constant|
+    define_method constant.downcase do
+      self * TimeLord::Units.const_get(constant)
+    end
+    alias_method "#{constant.downcase}s", constant.downcase
+  end
+
+  def ago
+    TimeLord::Time.new(Time.now - self).period
+  end
+
+  def from_now
+    TimeLord::Time.new(Time.now + self).period
+  end
+end

data/lib/time-lord/extensions/time.rb

@@ -0,0 +1,5 @@
+class Time
+  def ago
+    TimeLord::Time.new(self).period
+  end
+end

data/lib/time-lord/period.rb

@@ -0,0 +1,54 @@
+module TimeLord
+  class Period
+    attr_writer :beginning, :ending
+
+    def initialize(beginning, ending)
+      self.beginning = beginning
+      self.ending = ending
+    end
+
+    def to_words
+      "#{value} #{unit} #{tense}"
+    end
+    alias_method :in_words, :to_words
+
+    def difference
+      beginning - ending
+    end
+    alias_method :to_i, :difference
+
+    def to_time
+      if difference < 0 then @beginning else @ending end
+    end
+
+    def to_range
+      beginning..ending
+    end
+
+    def beginning
+      @beginning.to_i
+    end
+
+    def ending
+      @ending.to_i
+    end
+
+    private
+
+    def value
+      Scale.new(absolute).to_value
+    end
+
+    def unit
+      Scale.new(absolute).to_unit
+    end
+
+    def absolute
+      difference.abs
+    end
+
+    def tense
+      if difference < 0 then "ago" else "from now" end
+    end
+  end
+end