periodic 1.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 694acb05f38ad1b232aa218884749f8c1971989c
+  data.tar.gz: 5e106d42184155b580315f880c8d4c53c4030b42
+SHA512:
+  metadata.gz: 0ea08bb314c34e90f1eef36b91ecf6e1185a55d787b40f43a389abc6c7d22e2fe5fea17fa9c9c40ee2f0aa5cbbff8ad2c216f9eb54b3f5d591173b849b92bb8a
+  data.tar.gz: 2bc0d3b6258d72ccb15a8da94e417d8a455078bb1738ea711d0cb550af85f09e45ea27081b12ed5518b26fa3455c78138326ac8653cd3f9d523df8f9dd29f63a

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle
+*.gem

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.8.6
+  - 1.9.2
+  - 2.2.1
+  - 2.2.3
+  - 2.3.0
+cache: bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in lamppost.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Chris Kalafarski
+
+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.rdoc

@@ -0,0 +1,50 @@
+= Periodic
+
+
+== Installation
+
+    $ sudo gem sources -a http://gems.github.com
+    $ sudo gem install farski-periodic
+
+== Usage
+
+==== Parser
+
+Periodic will parse out natural language strings representing durations using different units of time, and return the total number of seconds. When using text labels, it will do it's best to look for any of the following units: seconds, minutes, hours, days, weeks, months, years, decades, centuries, millennia. Units can appear in any order in the string, and may appear more than once.
+
+When using a digital format (e.g. 10:30), the parser will default to the smallest sensible units (e.g. 10 minutes 30 seconds), but this can be overridden using the :bias option (e.g. :bias => centuries, 10 centuries 30 decades). Valid options for the :bias are symbols of those units mentioned in the previous paragraph. If a bias is explicitly defined that is too precise for the given string, the smallest sensible unit will be substituted
+
+    >> Periodic.parse('1 minute')
+    => 60
+    >> Periodic.parse('60min')
+    => 3600
+    >> Periodic.parse('1:30')
+    => 90
+    >> Periodic.parse('1:30', :bias => :hours)
+    => 5400
+    
+==== Formatting
+
+The #format method of Periodic::Duration objects lets you format the number of seconds into different units. Any combination of units can be used to express precise values, the the precision is optioned (i.e. 90 seconds can be output as '1 minute' or '1.5 minutes', or '1 minute 30 seconds'). If you use text labels in the format, they can come either before or after the values, and in both cases the resulting string by default will have zero-value value-label pairs removed (e.g. with a value of 30, and a format of '%m minute %s seconds', by default it will print '30 seconds', not '0 minutes 30 seconds'). Pairs can be forced into the result with a '!' before the directive. When using a digital format (like the default '%y:%d:%h:%m:%s'), you should be sure to include all directives between the largest and smallest unit, though it will work even with missing directives.
+
+
+The available directives
+/%s/, /%m/, /%h/, /%d/, /%y/
+  
+    >> Duration.new(125).format
+    => '2:05'
+    >> Duration.new(125).format('%y:%d:!%h:%m:%s')
+    => '00:02:05'
+    >> Duration.new(125).format('%h hours %m minutes %s seconds')
+    => '2 minutes 5 seconds'
+    >> Duration.new(125).format('!%h hours %m minutes %s seconds')
+    => '0 hours 2 minutes 5 seconds'
+    >> Duration.new(125).format('!%h hours %s seconds')
+    => '0 hours 125 seconds'
+
+== TODO
+[ ] plural text labels should automatically be singularized with 1
+
+== COPYRIGHT
+
+Copyright (c) 2008 Chris Kalafarski. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/periodic.rb

@@ -0,0 +1,7 @@
+require "periodic/duration"
+require "periodic/parser"
+
+module Periodic	
+  extend Periodic::Parser
+  extend Periodic::Duration
+end

data/lib/periodic/duration.rb

@@ -0,0 +1,83 @@
+require 'bigdecimal'
+
+module Periodic
+  module Duration
+    module Units
+      TIME = Hash.new
+      TIME[:seconds] = { :factor => 1, :directive => /%s/ }
+      TIME[:minutes] = { :factor => 60, :directive => /%m/ }
+      TIME[:hours] = { :factor => 3600, :directive => /%h/ }
+      TIME[:days] = { :factor => 3600*24, :directive => /%d/ }
+      # TIME[:weeks] = { :factor => 3600*24*7, :directive => /%w/ }
+      # TIME[:months] = { :factor => 3600*24*30, :directive => /%n/ }
+      TIME[:years] = { :factor => 3600*24*365, :directive => /%y/ }
+
+      TIME_ORDER = [:seconds, :minutes, :hours, :days, :years] # not working with weeks and months...
+    end
+
+    def self.sanitize_formatted_string(string)
+      if string.match(/:/) && !string.match(/[a-zA-Z ]/)
+        # add leading zeros where missing...
+        string.gsub!(/!(\d):/, '!0\1:')
+        string.gsub!(/^(\d):/, '0\1:')
+        string.gsub!(/:(\d):/, ':0\1:')
+        string.gsub!(/:(\d):/, ':0\1:') # needs to happen twice??
+        string.gsub!(/:(\d(.\d)*)$/, ':0\1')
+
+        # remove leading zero-value digitals
+        string.sub!(/[0:]*/, '')
+      else
+        # if the string starts with a number we can assume the value-label pairs are like '10 minutes'
+        if string[0,1].match(/\d/) || string[0,1] == "!"
+          string = string.split(/(!?\d[.\d]*[-_:, a-zA-Z]+)/).delete_if{|x| x == ""}.inject(String.new) { |memo, s| memo << ((s.match(/!/) || s.match(/[1-9]/)) ? s : "")  }
+
+        # if starts with a letter we can assume the value-label pairs are like 'minutes: 10'
+        else
+          string = string.split(/([-A-Za-z: ,]+\d[.\d]*)/).delete_if{|x| x == ""}.inject(String.new) { |memo, s| memo << ((s.match(/!/) || s.match(/[1-9]/)) ? s : "")  }
+          string.sub!(/([ ,])*([a-zA-Z]+)/, '\2')
+        end
+
+        # remove leading zero-value digitals
+        string.sub!(/[0:]*/, '')
+      end
+      string.strip.gsub(/!/, '')
+    end
+
+    class Duration
+      def initialize(seconds)
+        @seconds = (seconds.is_a?(Float) ? seconds.to_f : seconds)
+      end
+
+      def format(format = '%y:%d:%h:%m:%s', precision = nil)
+        string, nondirective_units, values, smallest_unit_directive = format, [], Hash.new, nil
+
+        Periodic::Duration::Units::TIME_ORDER.reverse.each_with_index do |unit, i|
+          if format =~ Periodic::Duration::Units::TIME[unit][:directive]
+            values[unit] = send(unit) + nondirective_units.inject(0) { |total, u| total += (send(u) * (Periodic::Duration::Units::TIME[u][:factor] / Periodic::Duration::Units::TIME[unit][:factor])) }
+            smallest_unit_directive = unit
+            nondirective_units.clear
+          else
+            nondirective_units << unit if (send(unit) > 0)
+          end
+
+          # correct for any left over time that's is fractional for all the included units
+          values[smallest_unit_directive] += nondirective_units.inject(0) { |total, u| total += (send(u).to_f * Periodic::Duration::Units::TIME[u][:factor] / Periodic::Duration::Units::TIME[smallest_unit_directive][:factor]) } if (!Periodic::Duration::Units::TIME_ORDER.reverse[i+1] && !nondirective_units.empty?)
+        end
+
+        values[smallest_unit_directive] = case precision
+          when nil then (values[smallest_unit_directive] % 1 == 0) && !@seconds.is_a?(Float) ? values[smallest_unit_directive].to_i : values[smallest_unit_directive]
+          when 0 then values[smallest_unit_directive].to_i
+          else (values[smallest_unit_directive] * (10 ** precision)).round / (10 ** precision).to_f
+        end
+
+        return Periodic::Duration.sanitize_formatted_string(values.inject(string) { |str, data| str.sub!(Periodic::Duration::Units::TIME[data[0]][:directive], data[1].to_s) })
+      end
+
+      Periodic::Duration::Units::TIME_ORDER.each_with_index do |unit, i|
+        define_method("in_" + unit.to_s) { @seconds.to_f / Periodic::Duration::Units::TIME[unit][:factor] }
+        define_method("whole_" + unit.to_s) { (@seconds.to_f / Periodic::Duration::Units::TIME[unit][:factor]).floor }
+        define_method(unit) { ((Periodic::Duration::Units::TIME_ORDER[i+1] ? BigDecimal.new(@seconds.to_f.to_s) % BigDecimal.new(Periodic::Duration::Units::TIME[Periodic::Duration::Units::TIME_ORDER[i+1]][:factor].to_f.to_s) : @seconds.to_f) / Periodic::Duration::Units::TIME[unit][:factor].to_f).send(unit == :seconds ? :to_f : :floor) }
+      end
+    end
+  end
+end

data/lib/periodic/parser.rb

@@ -0,0 +1,59 @@
+module Periodic
+  module Parser
+    def parse(string, options = { :bias => :seconds})
+      return Parseable.new(string, options[:bias]).seconds
+    end
+
+    private
+
+    class  Parseable
+      def initialize(string, bias)
+        @string = string
+        validates_inclusion_of_numeral_in_string
+        @bias = bias
+
+        extract_time_parts_from_string
+      end
+
+      def seconds
+        units = { :seconds => 1, :minutes => 60, :hours => 3600, :days => 3600*24, :weeks => 3600*24*7, :months => 3600*24*30, :years => 3600*24*365.25, :decades => 3600*24*365.25*10, :centuries => 3600*24*365.25*100, :millennia => 3600*24*365.25*1000 }
+        seconds = @time_parts.inject(0) { |total, part| total = total + (part[1] * units[part[0]]) }
+        return seconds % 1 == 0 ? seconds.to_i : seconds
+      end
+
+      private
+
+      def validates_inclusion_of_numeral_in_string
+        raise ArgumentError, "String contains no numbers", caller unless @string.match(/\d/)
+      end
+
+      def digital?
+        @string.match(/:/)
+      end
+
+      def extract_time_parts_from_string
+        @time_parts = Hash.new
+        digital? ? extract_time_parts_from_digital : extract_time_parts_from_text
+      end
+
+      def extract_time_parts_from_digital
+        units = [:seconds, :minutes, :hours, :days, :weeks, :months, :years, :decades, :centuries, :millennia]
+        @string.split(":").reverse.each_with_index do |part, i|
+          @time_parts[units[i + ((units.index(@bias) >= @string.split(":").size) ? units.index(@bias) - @string.split(":").size + 1 : 0)]] = part.to_f
+        end
+      end
+
+      def extract_time_parts_from_text
+        normalize_string
+        units = { :s => :seconds, :m => :minutes, :h => :hours, :d => :days, :w => :weeks, :n => :months, :y => :years, :a => :decades, :c => :centuries, :b => :millennia }
+        @string.split(' ').each { |part| @time_parts[part.match(/([a-z])/) ? units[part.match(/([a-z])/)[1].to_sym] : @bias] = (@time_parts[part.match(/([a-z])/) ? units[part.match(/([a-z])/)[1].to_sym] : @bias]||0) + part.to_f }
+      end
+
+      def normalize_string
+        [/( )/, /(,)/, /(and)/].each{ |m| @string.gsub!(m, '') }
+        @string.gsub!(/(\d)([a-zA-Z]+)/, '\1\2 ')
+        [{:n=>/(mo\w*)/,:b=>/(m\w*l\w*)/,:a=>/(d\w*c\w*)/}, {:m=>/(m\w*)/,:h=>/(h\w*)/,:d=>/(d\w*)/,:w=>/(w\w*)/,:y=>/(y\w*)/,:c=>/(c\w*)/}, {:s=>/(s\w*)/}].each { |set| set.each{ |k,v| @string.gsub!(v, k.to_s) } }
+      end
+    end
+  end
+end

data/lib/periodic/version.rb

@@ -0,0 +1,3 @@
+module Periodic
+  VERSION = "1.2.3"
+end

data/periodic.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "periodic/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "periodic"
+  spec.version       = Periodic::VERSION
+  spec.authors       = ["Chris Kalafarski"]
+  spec.email         = ["chris@farski.com"]
+
+  spec.summary       = "Natural language parser and output formating for durations"
+  spec.description   = "Natural language parser and output formating for durations in Ruby"
+  spec.homepage      = "https://github.com/farski/periodic"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 1.9'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  end
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "test-unit", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "coveralls", "~> 0"
+  spec.add_development_dependency "rubocop", "~> 0"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: periodic
+version: !ruby/object:Gem::Version
+  version: 1.2.3
+platform: ruby
+authors:
+- Chris Kalafarski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Natural language parser and output formating for durations in Ruby
+email:
+- chris@farski.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/periodic.rb
+- lib/periodic/duration.rb
+- lib/periodic/parser.rb
+- lib/periodic/version.rb
+- periodic.gemspec
+homepage: https://github.com/farski/periodic
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Natural language parser and output formating for durations
+test_files: []