duranged 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2951d10f37ccb4455790939b928f13d81f99f66
-  data.tar.gz: 86b329f53282b75ce0fcbd6b1cb0c391e6808544
+  metadata.gz: 46db5544d738bea7c2e616f797e6667e817cd9a1
+  data.tar.gz: e7fe1eae2d4205fc344175e7ea9f9298549e77fd
 SHA512:
-  metadata.gz: 1e1561da9807d9564a2403c990f60ec5c297351bd1187f093c6fc83001440d1cd707eeb9a4155761bb79d629e4f5591156ce8852250fbb4fd5785a023873a56e
-  data.tar.gz: 776ca9e9111541289f471c0482433e86b19ed24eb1f2d47faa4a962f05b709422c20bef8a7f020c994bcc2bdd9812a024107146ff1537f443f36e4092907d723
+  metadata.gz: c38eba26ed2b9208cd0c95bfa61224287940af2cf5f92bc0b4604bf1dc8ef762d63a9a1103d5ec38d79fe46cb59287b0a3e151a948b375b33eec24f18911e979
+  data.tar.gz: 2a7319101bfb44860c33ead635bac7d27634c6a0f62ab8c56057cf83dfc6734e51d0d5cdf25269c806c9a089bc9b1c0e24e54ea20c326aadff7c320ac107b9ff

data/lib/duranged.rb

@@ -5,6 +5,8 @@ require 'active_support/core_ext/numeric'
 require 'active_support/core_ext/time'
 require 'canfig'
 require 'chronic_duration'
+require 'duranged/periods'
+require 'duranged/formatters'
 require 'duranged/base'
 require 'duranged/duration'
 require 'duranged/interval'

data/lib/duranged/base.rb

@@ -1,17 +1,10 @@
 module Duranged
   class Base
     include Comparable
-    attr_reader :value
+    include Periods
+    include Formatters
 
-    PARTS = [:years, :months, :weeks, :days_after_weeks, :days, :hours, :minutes, :seconds]
-    FORMATTERS = { 's' => -> (pad,with) { pad_value seconds, pad, with },
-                   'm' => -> (pad,with) { pad_value minutes, pad, with },
-                   'h' => -> (pad,with) { pad_value hours, pad, with },
-                   'd' => -> (pad,with) { pad_value days, pad, with },
-                   'D' => -> (pad,with) { pad_value days_after_weeks, pad, with },
-                   'w' => -> (pad,with) { pad_value weeks, pad, with },
-                   'M' => -> (pad,with) { pad_value months, pad, with },
-                   'y' => -> (pad,with) { pad_value years, pad, with } }
+    attr_reader :value
 
     class << self
       def dump(obj)
@@ -35,118 +28,6 @@ module Duranged
       end
     end
 
-    def years
-      (value.to_f / 60 / 60 / 24 / 365.25).to_i
-    end
-
-    def months
-      ((value - years.years) / 60 / 60 / 24 / 30).floor
-    end
-
-    def weeks
-      (((value - months.months - years.years) / 60 / 60 / 24).floor / 7).floor
-    end
-
-    def days_after_weeks
-      ((value - weeks.weeks - months.months - years.years) / 60 / 60 / 24).floor
-    end
-
-    def days
-      ((value - months.months - years.years) / 60 / 60 / 24).floor
-    end
-
-    def hours
-      ((value - days.days - months.months - years.years) / 60 / 60).floor
-    end
-
-    def minutes
-      ((value - hours.hours - days.days - months.months - years.years) / 60).floor
-    end
-
-    def seconds
-      (value - minutes.minutes - hours.hours - days.days - months.months - years.years).floor
-    end
-
-    def +(other)
-      if other.is_a?(Duration) || other.is_a?(Interval)
-        Duranged.logger.warn "Warning: You are adding a #{other.class.name} to a #{self.class.name}, which will result in a #{self.class.name}. If you would like a #{other.class.name} object to be returned you must add your #{self.class.name} to your #{other.class.name} instead." if other.is_a?(Range)
-        self.class.new(value + other.value)
-      elsif other.is_a?(Integer)
-        self.class.new(value + other)
-      else
-        raise ArgumentError, "value must be an Integer, Duranged::Duration or Duranged::Interval"
-      end
-    end
-
-    def -(other)
-      if other.is_a?(Duration) || other.is_a?(Interval)
-        Duranged.logger.warn "Warning: You are subtracting a #{other.class.name} from a #{self.class.name}, which will result in a #{self.class.name}. If you would like a #{other.class.name} object to be returned you must subtract your #{self.class.name} from your #{other.class.name} instead." if other.is_a?(Range)
-        self.class.new(value - other.value)
-      elsif other.is_a?(Integer)
-        self.class.new(value - other)
-      else
-        raise ArgumentError, "value must be an Integer, Duranged::Duration or Duranged::Interval"
-      end
-    end
-
-    def as_json(options=nil)
-      value
-    end
-
-    def to_h
-      PARTS.map do |part|
-        [part, send(part)]
-      end.to_h
-    end
-
-    def to_s
-      ChronicDuration.output(value, format: :long, joiner: ', ').to_s
-    end
-
-    def strfdur(format)
-      str = format.to_s
-
-      # :years(%Y years, ):months(%N months, )%D :days
-      PARTS.each do |part|
-        while matches = str.match(/:(#{part})(\((.+)\))?/i) do
-          if matches[3]
-            # only replaces if the value is > 0, otherwise blank
-            matched = ''
-            depth = 0
-            matches[3].chars.to_a.each do |char|
-              depth += 1 if char == '('
-              depth -= 1 if char == ')'
-              break if depth == -1
-              matched += char
-            end
-            value = send(part) > 0 ? strfdur(matched.dup) : ''
-            str.gsub!(":#{part}(#{matched})", value)
-          else
-            # if no nested format was passed, replace with a singular
-            # or plural part name as appropriate
-            value = send(part) == 1 ? matches[1].to_s.singularize : matches[1].to_s
-            str.gsub!(matches[0], value)
-          end
-        end
-      end
-
-      FORMATTERS.each do |conversion, block|
-        while matches = str.match(/%([-_])?([0-9]+)?(#{conversion})/) do
-          pad_with = matches[1] == '_' ? :space : :zero
-          value = instance_exec(matches[2] || 2, pad_with, &block)
-          value = value.to_i.to_s.lstrip if matches[1] == '-'
-
-          str.gsub!(matches[0], value)
-        end
-      end
-
-      str
-    end
-
-    def to_i
-      value
-    end
-
     def <=>(other)
       if value < other.to_i
         -1
@@ -157,8 +38,14 @@ module Duranged
       end
     end
 
-    def call
-      value
+    def +(other)
+      Duranged.logger.warn "Warning: You are adding a #{other.class.name} to a #{self.class.name}, which will result in a #{self.class.name}. If you would like a #{other.class.name} object to be returned you must add your #{self.class.name} to your #{other.class.name} instead." if other.is_a?(Range)
+      self.class.new(to_i + other.to_i)
+    end
+
+    def -(other)
+      Duranged.logger.warn "Warning: You are subtracting a #{other.class.name} from a #{self.class.name}, which will result in a #{self.class.name}. If you would like a #{other.class.name} object to be returned you must subtract your #{self.class.name} from your #{other.class.name} instead." if other.is_a?(Range)
+      self.class.new(to_i - other.to_i)
     end
 
     protected
@@ -166,17 +53,5 @@ module Duranged
     def parse_hash(hash)
       hash.sum { |k,v| v.to_i.send(k.to_sym) }
     end
-
-    def pad_value(value, pad=2, with=:zero)
-      send("#{with}_pad".to_sym, value, pad)
-    end
-
-    def zero_pad(value, pad=2)
-      "%0#{pad}d" % value
-    end
-
-    def space_pad(value, pad=2)
-      "%#{pad}d" % value
-    end
   end
 end

data/lib/duranged/formatters.rb

@@ -0,0 +1,108 @@
+module Duranged
+  module Formatters
+    PERIODS = [:years, :months, :weeks, :days_after_weeks, :days, :hours, :minutes, :seconds]
+    FORMATTERS = { 's' => -> (pad,with) { pad_value seconds, pad, with },
+                   'm' => -> (pad,with) { pad_value minutes, pad, with },
+                   'h' => -> (pad,with) { pad_value hours, pad, with },
+                   'd' => -> (pad,with) { pad_value days, pad, with },
+                   'D' => -> (pad,with) { pad_value days_after_weeks, pad, with },
+                   'w' => -> (pad,with) { pad_value weeks, pad, with },
+                   'M' => -> (pad,with) { pad_value months, pad, with },
+                   'y' => -> (pad,with) { pad_value years, pad, with } }
+
+    def as_json(options=nil)
+      value
+    end
+
+    def to_h
+      Hash[PERIODS.map do |part|
+        [part, send(part)]
+      end]
+    end
+
+    def to_s
+      ChronicDuration.output(value, format: :long, joiner: ', ').to_s
+    end
+
+    def strfdur(format)
+      str = format.to_s
+
+      # :years(%Y years, ):months(%N months, )%D :days
+      str = strfparts(str)
+
+      # %y %M %w %d %m %s
+      str = strfformatters(str)
+
+      str
+    end
+
+    def to_i
+      value
+    end
+
+    protected
+
+    def strfparts(str)
+      PERIODS.each do |part|
+        while matches = str.match(/:(#{part})(\((.+)\))?/i) do
+          if matches[3]
+            str = strfpart(str, part)
+          else
+            # if no nested format was passed, replace with a singular
+            # or plural part name as appropriate
+            value = send(part) == 1 ? matches[1].to_s.singularize : matches[1].to_s
+
+            str.gsub!(matches[0], value)
+          end
+        end
+      end
+
+      str
+    end
+
+    def strfpart(str, part)
+      matched = parse_match(str)
+      value = send(part) > 0 ? strfdur(matched.dup) : ''
+
+      str.gsub!(":#{part}(#{matched})", value)
+    end
+
+    def strfformatters(str)
+      FORMATTERS.each do |conversion, block|
+        while matches = str.match(/%([-_])?([0-9]+)?(#{conversion})/) do
+          pad_with = matches[1] == '_' ? :space : :zero
+          value = instance_exec(matches[2] || 2, pad_with, &block)
+          value = value.to_i.to_s.lstrip if matches[1] == '-'
+
+          str.gsub!(matches[0], value)
+        end
+      end
+
+      str
+    end
+
+    def pad_value(value, pad=2, with=:zero)
+      send("#{with}_pad".to_sym, value, pad)
+    end
+
+    def zero_pad(value, pad=2)
+      "%0#{pad}d" % value
+    end
+
+    def space_pad(value, pad=2)
+      "%#{pad}d" % value
+    end
+
+    def parse_match(match_str)
+      match_substr = ''
+      depth = 0
+      match_str.chars.to_a.each do |char|
+        depth += 1 if char == '('
+        depth -= 1 if char == ')'
+        break if depth == -1
+        match_substr += char
+      end
+      match_substr
+    end
+  end
+end

data/lib/duranged/occurrence.rb

@@ -35,6 +35,15 @@ module Duranged
       end
     end
 
+    def as_json(options=nil)
+      hash = { occurrences: occurrences }
+      hash[:interval] = interval.as_json(options) if interval
+      hash[:duration] = duration.as_json(options) if duration
+      hash[:range] = range.as_json(options) if range
+      hash
+    end
+    alias_method :to_h, :as_json
+
     def occurrences_string
       case occurrences
       when 0
@@ -48,15 +57,6 @@ module Duranged
       end
     end
 
-    def as_json(options=nil)
-      hash = { occurrences: occurrences }
-      hash[:interval] = interval.as_json(options) if interval
-      hash[:duration] = duration.as_json(options) if duration
-      hash[:range] = range.as_json(options) if range
-      hash
-    end
-    alias_method :to_h, :as_json
-
     def to_s
       return occurrences_string if occurrences == 0
 
@@ -86,21 +86,28 @@ module Duranged
     def strfocc(format)
       str = format.to_s
 
+      str = strfoccurrences(str)
+      str = strfrange(str)
+      str = strfdurint(str)
+
+      str
+    end
+
+    protected
+
+    def strfoccurrences(str)
       while matches = str.match(/:occurrence[s]?/) do
         str.gsub!(matches[0], occurrences.to_s)
       end
-      
+
+      str
+    end
+
+    def strfrange(str)
       if range
         while matches = str.match(/:range(\((.+)\))?/) do
           if matches[2]
-            matched = ''
-            depth = 0
-            matches[2].chars.to_a.each do |char|
-              depth += 1 if char == '('
-              depth -= 1 if char == ')'
-              break if depth == -1
-              matched += char
-            end
+            matched = parse_match(matches[2])
             value = range.strfrange(matched.dup)
             str.gsub!(":range(#{matched})", value)
           else
@@ -110,6 +117,10 @@ module Duranged
         end
       end
 
+      str
+    end
+
+    def strfdurint(str)
       if duration || interval
         while matches = str.match(/:(duration|interval)(\(([^\)]+)\))/) do
           matched = send(matches[1])
@@ -120,5 +131,17 @@ module Duranged
 
       str
     end
+
+    def parse_match(match_str)
+      match_substr = ''
+      depth = 0
+      match_str.chars.to_a.each do |char|
+        depth += 1 if char == '('
+        depth -= 1 if char == ')'
+        break if depth == -1
+        match_substr += char
+      end
+      match_substr
+    end
   end
 end

data/lib/duranged/periods.rb

@@ -0,0 +1,66 @@
+module Duranged
+  module Periods
+    def years
+      (value.to_f / 60 / 60 / 24 / 365.25).to_i
+    end
+
+    def months
+      (seconds_after_years / 60 / 60 / 24 / 30).floor
+    end
+
+    def weeks
+      ((seconds_after_months / 60 / 60 / 24).floor / 7).floor
+    end
+
+    def days_after_weeks
+      (seconds_after_weeks / 60 / 60 / 24).floor
+    end
+
+    def days_after_months
+      (seconds_after_months / 60 / 60 / 24).floor
+    end
+
+    def days
+      # TODO make this a configuration option with the ability to default to :days_after_weeks
+      days_after_months
+    end
+
+    def hours
+      (seconds_after_days / 60 / 60).floor
+    end
+
+    def minutes
+      (seconds_after_hours / 60).floor
+    end
+
+    def seconds
+      seconds_after_minutes.floor
+    end
+
+    protected
+
+    def seconds_after_years
+      value - years.years
+    end
+
+    def seconds_after_months
+      seconds_after_years - months.months
+    end
+
+    def seconds_after_weeks
+      seconds_after_months - weeks.weeks
+    end
+
+    def seconds_after_days
+      seconds_after_months - days.days
+    end
+
+    def seconds_after_hours
+      seconds_after_days - hours.hours
+    end
+
+    def seconds_after_minutes
+      seconds_after_hours - minutes.minutes
+    end
+  end
+end

data/lib/duranged/range.rb

@@ -49,23 +49,11 @@ module Duranged
     alias_method :end_time, :end_at
 
     def +(other)
-      if other.is_a?(Duration) || other.is_a?(Interval)
-        self.class.new(start_at, value + other.value)
-      elsif other.is_a?(Integer)
-        self.class.new(start_at, value + other)
-      else
-        raise ArgumentError, "value must be an Integer, Duranged::Duration or Duranged::Interval"
-      end
+      self.class.new(start_at, to_i + other.to_i)
     end
 
     def -(other)
-      if other.is_a?(Duration) || other.is_a?(Interval)
-        self.class.new(start_at, value - other.value)
-      elsif other.is_a?(Integer)
-        self.class.new(start_at, value - other)
-      else
-        raise ArgumentError, "value must be an Integer, Duranged::Duration or Duranged::Interval"
-      end
+      self.class.new(start_at, to_i - other.to_i)
     end
 
     def to_duration
@@ -89,23 +77,32 @@ module Duranged
     def strfrange(format)
       str = format.to_s
 
+      str = strfstartend(str)
+      str = strfduration(str)
+
+      str
+    end
+
+    def same_day?
+      start_at('%j') == end_at('%j')
+    end
+
+    protected
+
+    def strfstartend(str)
       while matches = str.match(/:(start_at|end_at|)\((([^\)]+))\)/) do
         str.gsub!(matches[0], send(matches[1], matches[2]))
       end
 
+      str
+    end
+
+    def strfduration(str)
       while matches = str.match(/:duration\(([^\)]+)\)/) do
         str.gsub!(matches[0], strfdur(matches[1]))
       end
 
       str
     end
-
-    def call
-      to_s
-    end
-
-    def same_day?
-      start_at('%j') == end_at('%j')
-    end
   end
 end

data/lib/duranged/version.rb

@@ -1,3 +1,3 @@
 module Duranged
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
-require 'duranged'
-require 'rspec'
 require 'coveralls'
 Coveralls.wear!
+require 'duranged'
+require 'rspec'
 
 Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duranged
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-11 00:00:00.000000000 Z
+date: 2015-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: API for working with durations and time ranges.
+description: A set of classes to facilitate working with and formatting durations,
+  intervals, time ranges and occurrences.
 email:
 - mark@markrebec.com
 executables: []
@@ -90,8 +91,10 @@ files:
 - lib/duranged.rb
 - lib/duranged/base.rb
 - lib/duranged/duration.rb
+- lib/duranged/formatters.rb
 - lib/duranged/interval.rb
 - lib/duranged/occurrence.rb
+- lib/duranged/periods.rb
 - lib/duranged/range.rb
 - lib/duranged/version.rb
 - spec/duranged/base_spec.rb
@@ -124,7 +127,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: API for working with durations and time ranges.
+summary: A set of classes to facilitate working with and formatting durations, intervals,
+  time ranges and occurrences.
 test_files:
 - spec/duranged/base_spec.rb
 - spec/duranged/duration_spec.rb