as-duration 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efd76209348cb343f2ef4b2d5039cb1dd033640c
+  data.tar.gz: 3110aaa5b289824b2d18291a2acf675c1b8cffa0
+SHA512:
+  metadata.gz: bc6cf946e1a327453b91a30b3282a0478085039b909a538bb0bd9aecfcda44e9aa2a5e8cf06121668fc3867f3a9bd418c40a021d22d65938acfd8899ef764f82
+  data.tar.gz: 6f38f2966c070df139baca861f030c62d1456331a5cd5538190fbf63e1fe43c91c0bc421f261a490be168ec81f40e41ec1803ede3c9dcd6e66ec527746ad68ea

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Janko Marohnić
+
+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,145 @@
+# AS::Duration
+
+This gem is an extraction of `ActiveSupport::Duration` from Rails, along with the
+related core extensions.
+
+Ruby 2.0 or greater is required.
+
+## Why not simply use ActiveSupport?
+
+If you're in a Rails project, then you should use `ActiveSupport::Duration`.
+Otherwise there are several reason why you might prefer `as-duration`:
+
+* You simply don't want to have ActiveSupport as a dependency
+* You want to control what you require. You may think that requiring
+  `active_support/core_ext/integer/time` will only require what you want, but
+  in fact it will require a total of **5000 LOC** (a lot of those are additional
+  core extensions which you may not have wanted). `as-duration` has only
+  under **200 LOC**, and only gives you what you've asked for.
+
+## Is it well tested?
+
+It sure is! I copied all the related tests from Rails, and modified them
+so that they work standalone. So, `as-duration` passes all of Rails' tests.
+
+## Installation
+
+```ruby
+gem 'as-duration'
+```
+
+## Features
+
+*DISCLAIMER: In most cases `as-duration` should work exactly like
+`ActiveSupport::Duration`. However, there are a few modifications made, mostly
+removing some of the magic, see [Modifications](#modifications-to-activesupportduration).*
+
+### Numeric methods
+
+The following methods are added on `Numeric` (`Float` and `Integer`):
+
+```rb
+# plural versions
+2.seconds
+3.minutes
+4.hours
+5.days
+6.weeks
+7.fortnights
+8.months
+9.years
+
+# singular versions
+1.second
+1.minute
+1.hour
+1.day
+1.week
+1.fortnight
+1.month
+1.year
+```
+
+The only exception is `#months` and `#years` which are only added to `Integer`
+(to maintain precision in calculations).
+
+### Duration/Time arithmetics
+
+You can add and subtract durations from `Time` or `Date` objects.
+
+```rb
+Time.now + 2.hours
+Date.today + 1.year
+```
+
+When you add seconds/minutes/hours to a Date, the Date is automatically
+converted to a `Time` object.
+
+```rb
+(Date.today + 1.minute).class #=> Time
+```
+
+As syntax sugar, you can also call time methods on the duration object:
+
+```rb
+# forward in time
+1.year.from_now
+2.months.since(Date.new(2015,4,27))
+2.months.after(Date.new(2015,4,27))
+2.months.from(Date.new(2015,4,27))
+
+# back in time
+2.hours.ago
+20.minutes.until(Time.now)
+20.minutes.before(Time.now)
+20.minutes.to(Time.now)
+```
+
+### Duration/Duration arithmetics
+
+You can add and subtract durations:
+
+```rb
+1.week + 1.day
+2.minutes - 1.second
+```
+
+Unlike `ActiveSupport::Duration`, you can't add durations to integers and vice
+versa. You either have to convert the integer to a duration, or
+the duration to an integer with `AS::Duration#to_i`. This is to help you
+not to mix different time units.
+
+```rb
+# Bad
+10 + 1.minute  # TypeError
+1.minute + 10  # TypeError
+
+# Good
+10.seconds + 1.minute  # AS::Duration
+1.minute.to_i + 10     # Integer
+```
+
+## Modifications to `ActiveSupport::Duration`
+
+The behaviour of `ActiveSupport::Duration` has been slightly modified, mostly
+to remove some magic:
+
+* Added `#from`, `#after`, `#before` and `#to` to `AS::Duration`
+* `#from_now` and `#ago` cannot take any arguments, they always use the current
+  time (passing an argument doesn't read well, better to use `#from` and
+  `#until`)
+* Removed support for `DateTime`
+  - `DateTime` was first introduced in Ruby so that you can represent time
+    that the `Time` class at the moment wasn't able to. However, the `Time`
+    class improved over time and removed those limitations, so there is no more
+    need to use `DateTime`
+* Year lasts 365 days instead of 365.25
+* `AS::Duration` doesn't act like an Integer
+  - to compare it with an integer you have to either convert the integer to
+    a duration or convert the duration to an integer (with `#to_i`)
+  - you can only add and subtract two duration objects
+* Removed hash equality
+
+## License
+
+[MIT](LICENSE.txt)

data/lib/as-duration.rb

@@ -0,0 +1 @@
+require "as/duration"

data/lib/as/duration.rb

@@ -0,0 +1,133 @@
+require "as/duration/core_ext"
+require "time"
+
+module AS
+  class Duration
+    include Comparable
+
+    attr_reader :parts
+
+    def initialize(parts)
+      parts = parts.dup
+
+      # Remove partial weeks and days for accurate date behaviour
+      if Float === parts[:weeks]
+        parts[:weeks], partial_weeks = parts[:weeks].divmod(1)
+        parts[:days] = parts.fetch(:days, 0) + 7 * partial_weeks
+      end
+      if Float === parts[:days]
+        parts[:days], partial_days = parts[:days].divmod(1)
+        parts[:hours] = parts.fetch(:hours, 0) + 24 * partial_days
+      end
+
+      @parts = parts.freeze
+    end
+
+    def to_i
+      @parts.inject(0) do |sum, (type, value)|
+        case type
+        when :seconds    then sum + value
+        when :minutes    then sum + value * 60
+        when :hours      then sum + value * 60 * 60
+        when :days       then sum + value * 60 * 60 * 24
+        when :weeks      then sum + value * 60 * 60 * 24 * 7
+        when :fortnights then sum + value * 60 * 60 * 24 * 14
+        when :months     then sum + value * 60 * 60 * 24 * 30
+        when :years      then sum + value * 60 * 60 * 24 * 365
+        end
+      end
+    end
+
+    def <=>(other)
+      return nil if not Duration === other
+      self.to_i <=> other.to_i
+    end
+
+    def +(other)
+      raise TypeError, "can only add Duration objects" if not Duration === other
+      added_parts = parts.merge(other.parts) { |key, old, new| old + new }
+      Duration.new(added_parts)
+    end
+
+    def -(other)
+      raise TypeError, "can only subtract Duration objects" if not Duration === other
+      self + (-other)
+    end
+
+    def -@
+      negated_parts = parts.inject({}) { |h, (k, v)| h.update(k => -v) }
+      Duration.new(negated_parts)
+    end
+
+    def from(time)
+      advance(time)
+    end
+    alias since from
+    alias after from
+
+    def from_now
+      from(Time.now)
+    end
+
+    def until(time)
+      (-self).advance(time)
+    end
+    alias to     until
+    alias before until
+
+    def ago
+      self.until(Time.now)
+    end
+
+    protected
+
+    def advance(time)
+      case time
+      when Time then advance_time(time)
+      when Date then advance_date(time)
+      else
+        raise ArgumentError, "expected Time or Date, got #{time.inspect}"
+      end
+    end
+
+    def advance_time(time)
+      date = advance_date_part(time.to_date)
+
+      time_advanced_by_date_args =
+        if time.utc?
+          Time.utc(date.year, date.month, date.day, time.hour, time.min, time.sec)
+        elsif time.zone
+          Time.local(date.year, date.month, date.day, time.hour, time.min, time.sec)
+        else
+          Time.new(date.year, date.month, date.day, time.hour, time.min, time.sec, time.utc_offset)
+        end
+
+      time_advanced_by_date_args + seconds_to_advance
+    end
+
+    def advance_date(date)
+      date = advance_date_part(date)
+
+      if seconds_to_advance == 0
+        date
+      else
+        date.to_time + seconds_to_advance
+      end
+    end
+
+    def advance_date_part(date)
+      date = date >> parts.fetch(:years, 0) * 12
+      date = date >> parts.fetch(:months, 0)
+      date = date +  parts.fetch(:weeks, 0) * 7
+      date = date +  parts.fetch(:days, 0)
+      date = date.gregorian if date.julian?
+      date
+    end
+
+    def seconds_to_advance
+      parts.fetch(:seconds, 0) +
+      parts.fetch(:minutes, 0) * 60 +
+      parts.fetch(:hours, 0) * 3600
+    end
+  end
+end

data/lib/as/duration/core_ext.rb

@@ -0,0 +1,5 @@
+require "as/duration/core_ext/numeric"
+require "as/duration/core_ext/integer"
+
+require "as/duration/core_ext/time"
+require "as/duration/core_ext/date"

data/lib/as/duration/core_ext/date.rb

@@ -0,0 +1,5 @@
+require "as/duration/operations"
+
+class Date
+  prepend AS::Duration::Operations::DateAndTime
+end

data/lib/as/duration/core_ext/integer.rb

@@ -0,0 +1,11 @@
+class Integer
+  def months
+    AS::Duration.new(months: self)
+  end
+  alias month months
+
+  def years
+    AS::Duration.new(years: self)
+  end
+  alias year years
+end

data/lib/as/duration/core_ext/numeric.rb

@@ -0,0 +1,31 @@
+class Numeric
+  def seconds
+    AS::Duration.new(seconds: self)
+  end
+  alias second seconds
+
+  def minutes
+    AS::Duration.new(minutes: self)
+  end
+  alias minute minutes
+
+  def hours
+    AS::Duration.new(hours: self)
+  end
+  alias hour hours
+
+  def days
+    AS::Duration.new(days: self)
+  end
+  alias day days
+
+  def weeks
+    AS::Duration.new(weeks: self)
+  end
+  alias week weeks
+
+  def fortnights
+    AS::Duration.new(weeks: self * 2)
+  end
+  alias fortnight fortnights
+end

data/lib/as/duration/core_ext/time.rb

@@ -0,0 +1,5 @@
+require "as/duration/operations"
+
+class Time
+  prepend AS::Duration::Operations::DateAndTime
+end

data/lib/as/duration/operations.rb

@@ -0,0 +1,23 @@
+module AS
+  class Duration
+    module Operations
+      module DateAndTime
+        def +(other)
+          if Duration === other
+            other.since(self)
+          else
+            super
+          end
+        end
+
+        def -(other)
+          if Duration === other
+            other.until(self)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: as-duration
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extraction of ActiveSupport::Duration and the related core extensions.
+email:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/as-duration.rb
+- lib/as/duration.rb
+- lib/as/duration/core_ext.rb
+- lib/as/duration/core_ext/date.rb
+- lib/as/duration/core_ext/integer.rb
+- lib/as/duration/core_ext/numeric.rb
+- lib/as/duration/core_ext/time.rb
+- lib/as/duration/operations.rb
+homepage: https://github.com/janko-m/as-duration
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Extraction of ActiveSupport::Duration and the related core extensions.
+test_files: []
+has_rdoc: