tardis 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd81323814d01d31fb82be8ac90979f8512f408d
+  data.tar.gz: 6d5f1b7ec03662eccf3368cfb1c0ba377f56e8af
+SHA512:
+  metadata.gz: 44432b5b0684e8e51f00306d382dff1a792c2babbcee1f94b862b40566426c0b59f83dc95dbd806ab81cf6160d1e85cf242514c50ae6b3ec565ab981b5f0ac00
+  data.tar.gz: ce6359ce3908d310c73520f62d7f7e3ed2370f674d03a0c2f59d16bcb8823e001fc8b06bb7145c66a95944f9767d78292e8e94030061d1ba0140ccad1e6fe196

data/lib/tardis.rb

@@ -0,0 +1,6 @@
+module Tardis
+  require_relative "tardis/version"
+  require_relative "tardis/moment"
+end
+
+require_relative "tardis/main"

data/lib/tardis/main.rb

@@ -0,0 +1,14 @@
+class Numeric
+  include(Tardis::Moment::Downscale)
+  include(Tardis::Moment::Upscale)
+end
+
+class Time
+  include(Tardis::Moment)
+  include(Tardis::Moment::Traversal)
+end
+
+class Date
+  include(Tardis::Moment)
+  include(Tardis::Moment::Traversal)
+end

data/lib/tardis/moment.rb

@@ -0,0 +1,17 @@
+# Tardis::Time is the module where all time based methods, classes, and modules
+# are defined. Anything that has to do with the second unit of measurement goes
+# into Tardis::Time.
+module Tardis
+  module Moment
+    # The units of time, based in seconds
+    SECOND = 1
+    MINUTE = SECOND * 60
+    HOUR = MINUTE * 60
+    DAY = HOUR * 24
+    WEEK = DAY * 7
+
+    require_relative "moment/upscale"
+    require_relative "moment/downscale"
+    require_relative "moment/traversal"
+  end
+end

data/lib/tardis/moment/downscale.rb

@@ -0,0 +1,35 @@
+module Tardis
+  module Moment
+    module Downscale
+      def to_seconds
+        downscale_to(Tardis::Moment::SECOND)
+      end
+      alias_method :in_seconds, :to_seconds
+
+      def to_minutes
+        downscale_to(Tardis::Moment::MINUTE)
+      end
+      alias_method :in_minutes, :to_minutes
+
+      def to_hours
+        downscale_to(Tardis::Moment::HOUR)
+      end
+      alias_method :in_hours, :to_hours
+
+      def to_days
+        downscale_to(Tardis::Moment::DAY)
+      end
+      alias_method :in_days, :to_days
+
+      def to_weeks
+        downscale_to(Tardis::Moment::WEEK)
+      end
+      alias_method :in_weeks, :to_weeks
+
+      def downscale_to(unit)
+        self.to_f / unit.to_f
+      end
+      private :downscale_to
+    end
+  end
+end

data/lib/tardis/moment/traversal.rb

@@ -0,0 +1,93 @@
+module Tardis
+  module Moment
+    module Traversal
+      # example: time_left = next_birthday.from Date.yesterday
+      # anatomy: [Time|Date].from([Time|Date]) => Integer
+      # description: |
+      #   Called on a Time or Date object and given a Time or Date object.
+      #   Returns an Integer, representing a number of seconds between the
+      #   object called on (a time in the future) and the object given (a
+      #   time in the past).
+      def from(timestamp)
+        # Transform the time/date object (self), which represents the
+        # starting point, to an integer.
+        beginning = self.to_i
+
+        # Transform the time/date object (an argument), which represents
+        # the point in the
+        ending = timestamp.to_i
+
+        # Subtract the end period from the start period which will
+        # return the total amount of time in seconds from the
+        # start the end.
+        beginning - ending
+      end
+
+      # example: @account.created_at.to Date.today
+      # anatomy: [Time|Date].to([Time|Date]) => Integer
+      # description: |
+      #   Called on a Time or Date object and given a Time or Date object.
+      #   Returns an Integer, representing a number of seconds between the
+      #   object called on (a time in the past) and the object given (a
+      #   time in the future).
+      def to(timestamp)
+        # Transform the time/date object (self), which represents the
+        # starting point, to an integer.
+        beginning = timestamp.to_i
+
+        # Transform the time/date object (an argument), which represents
+        # the point in the
+        ending = self.to_i
+
+        # Subtract the end period from the start period which will
+        # return the total amount of time in seconds from the
+        # start the end.
+        beginning - ending
+      end
+
+      # example: time_left = next_birthday.from_now
+      # anatomy: [Time|Date].from_now => Integer
+      # description: |
+      #   Called on a Time or Date object and returns an Integer,
+      #   representing a number of seconds between the object
+      #   called on (a time in the future) and now in time.
+      def from_now
+        # Call the .from() method with self as the starting point and
+        # Time.new as the end
+        self.from(Time.new)
+      end
+
+      # example: @account.created_at.to_now
+      # anatomy: [Time|Date].to_now => Integer
+      # description: |
+      #   Called on a Time or Date object and returns an Integer,
+      #   representing a number of seconds between the object
+      #   called on (a time in the past) and now in time.
+      def to_now
+        # Call the .to() method with self as the starting point and
+        # Time.new as the end
+        self.to(Time.new)
+      end
+
+      # example: 5.days.ago
+      # anatomy: [Integer].ago => Time
+      # description: |
+      #   Called on an Integer object and returns an Time object, which
+      #   represents the point in time before the given amount of seconds.
+      def ago
+        # Subtract the Integer from Time.new
+        Time.new - self
+      end
+
+      # example: 5.days.later
+      # anatomy: [Integer].later => Time
+      # description: |
+      #   Called on an Integer object and returns an Time object, which
+      #   represents the point in time after the given amount of seconds.
+      def later
+        # Add the Integer to Time.new
+        Time.new + self
+      end
+    end
+  end
+end

data/lib/tardis/moment/upscale.rb

@@ -0,0 +1,35 @@
+module Tardis
+  module Moment
+    module Upscale
+      def second
+        upscale_to(Tardis::Moment::SECOND)
+      end
+      alias_method :seconds, :second
+
+      def minute
+        upscale_to(Tardis::Moment::MINUTE)
+      end
+      alias_method :minutes, :minute
+
+      def hour
+        upscale_to(Tardis::Moment::HOUR)
+      end
+      alias_method :hours, :hour
+
+      def day
+        upscale_to(Tardis::Moment::DAY)
+      end
+      alias_method :days, :day
+
+      def week
+        upscale_to(Tardis::Moment::WEEK)
+      end
+      alias_method :weeks, :week
+
+      def upscale_to(unit)
+        self * unit
+      end
+      private :upscale_to
+    end
+  end
+end

data/lib/tardis/version.rb

@@ -0,0 +1,3 @@
+module Tardis
+  VERSION = "1.0.0"
+end

data/spec/lib/tardis/moment_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+RSpec.describe Tardis::Moment do
+  let(:described_class) { Class.new { include Tardis::Moment } }
+  let(:minute) { described_class.const_get("MINUTE") }
+  let(:hour) { described_class.const_get("HOUR") }
+  let(:day) { described_class.const_get("DAY") }
+  let(:week) { described_class.const_get("WEEK") }
+
+  describe Tardis::Moment::SECOND do
+    let(:second) { described_class.const_get("SECOND") }
+
+    it "is the base unit" do
+      expect(second).to eq(1)
+    end
+  end
+
+  describe Tardis::Moment::MINUTE do
+    let(:minute) { described_class.const_get("MINUTE") }
+
+    it "is the correct value in seconds" do
+      expect(minute).to eq(60)
+    end
+  end
+
+  describe Tardis::Moment::HOUR do
+    let(:hour) { described_class.const_get("HOUR") }
+
+    it "is the correct value in seconds" do
+      expect(hour).to eq(3_600)
+    end
+  end
+
+  describe Tardis::Moment::DAY do
+    let(:day) { described_class.const_get("DAY") }
+
+    it "is the correct value in seconds" do
+      expect(day).to eq(86_400)
+    end
+  end
+
+  describe Tardis::Moment::WEEK do
+    let(:week) { described_class.const_get("WEEK") }
+
+    it "is the correct value in seconds" do
+      expect(week).to eq(604_800)
+    end
+  end
+end

data/spec/lib/tardis/time/downscale_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+RSpec.describe Tardis::Moment::Downscale do
+  before(:each) do
+    Numeric.include(Tardis::Moment::Downscale)
+  end
+
+  describe "#to_seconds" do
+    it "returns number of seconds" do
+      expect(1.to_seconds).to eq(1)
+    end
+  end
+
+  describe "#as_seconds" do
+    it "returns number of seconds" do
+      expect(2.in_seconds).to eq(2)
+    end
+  end
+
+  describe "#to_minutes" do
+    it "returns number of minutes" do
+      expect(60.to_minutes).to eq(1)
+    end
+  end
+
+  describe "#as_minutes" do
+    it "returns number of minutes" do
+      expect(120.in_minutes).to eq(2)
+    end
+  end
+
+  describe "#hour" do
+    it "returns number of hours" do
+      expect(3_600.to_hours).to eq(1)
+    end
+  end
+
+  describe "#hours" do
+    it "returns number of hours" do
+      expect(7_200.in_hours).to eq(2)
+    end
+  end
+
+  describe "#day" do
+    it "returns number of days" do
+      expect(86_400.to_days).to eq(1)
+    end
+  end
+
+  describe "#days" do
+    it "returns number of days" do
+      expect(172_800.in_days).to eq(2)
+    end
+  end
+
+  describe "#week" do
+    it "returns number of weeks" do
+      expect(604_800.to_weeks).to eq(1)
+    end
+  end
+
+  describe "#weeks" do
+    it "returns number of weeks" do
+      expect(1_209_600.in_weeks).to eq(2)
+    end
+  end
+end

data/spec/lib/tardis/time/traversal_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Tardis::Moment::Traversal do
+  before(:each) do
+    Time.include(Tardis::Moment::Traversal)
+  end
+end

data/spec/lib/tardis/time/upscale_spec.rb

@@ -0,0 +1,67 @@
+require "spec_helper"
+
+RSpec.describe Tardis::Moment::Upscale do
+  before(:each) do
+    Numeric.include(Tardis::Moment::Upscale)
+  end
+
+  describe "#second" do
+    it "returns seconds, based on the number given in seconds" do
+      expect(1.second).to eq(1)
+    end
+  end
+
+  describe "#seconds" do
+    it "returns seconds, based on the number given in seconds" do
+      expect(2.seconds).to eq(2)
+    end
+  end
+
+  describe "#minute" do
+    it "returns seconds, based on the number given in minutes" do
+      expect(1.minute).to eq(60)
+    end
+  end
+
+  describe "#minutes" do
+    it "returns seconds, based on the number given in minutes" do
+      expect(2.minutes).to eq(120)
+    end
+  end
+
+  describe "#hour" do
+    it "returns seconds, based on the number given in hours" do
+      expect(1.hour).to eq(3_600)
+    end
+  end
+
+  describe "#hours" do
+    it "returns seconds, based on the number given in hours" do
+      expect(2.hours).to eq(7_200)
+    end
+  end
+
+  describe "#day" do
+    it "returns seconds, based on the number given in days" do
+      expect(1.day).to eq(86_400)
+    end
+  end
+
+  describe "#days" do
+    it "returns seconds, based on the number given in days" do
+      expect(2.days).to eq(172_800)
+    end
+  end
+
+  describe "#week" do
+    it "returns seconds, based on the number given in weeks" do
+      expect(1.week).to eq(604_800)
+    end
+  end
+
+  describe "#weeks" do
+    it "returns seconds, based on the number given in weeks" do
+      expect(2.weeks).to eq(1_209_600)
+    end
+  end
+end

data/spec/lib/tardis/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Tardis::VERSION do
+  it "should be a string" do
+    expect(Tardis::VERSION).to be_kind_of(String)
+  end
+end

data/spec/lib/tardis_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe Tardis do
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "pry"
+require "rspec"
+require "tardis"

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: tardis
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kurtis Rainbolt-Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: A library for managing units of time and traversal of time.
+email:
+- me@kurtisrainboltgreene.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tardis.rb
+- lib/tardis/main.rb
+- lib/tardis/moment.rb
+- lib/tardis/moment/downscale.rb
+- lib/tardis/moment/traversal.rb
+- lib/tardis/moment/upscale.rb
+- lib/tardis/version.rb
+- spec/lib/tardis/moment_spec.rb
+- spec/lib/tardis/time/downscale_spec.rb
+- spec/lib/tardis/time/traversal_spec.rb
+- spec/lib/tardis/time/upscale_spec.rb
+- spec/lib/tardis/version_spec.rb
+- spec/lib/tardis_spec.rb
+- spec/spec_helper.rb
+homepage: http://krainboltgreene.github.io/tardis.gem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A library for managing units of time and traversal of time.
+test_files:
+- spec/lib/tardis/moment_spec.rb
+- spec/lib/tardis/time/downscale_spec.rb
+- spec/lib/tardis/time/traversal_spec.rb
+- spec/lib/tardis/time/upscale_spec.rb
+- spec/lib/tardis/version_spec.rb
+- spec/lib/tardis_spec.rb
+- spec/spec_helper.rb
+has_rdoc: