spanner-lfittl 0.0.3

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    spanner-lfittl (0.0.3)
+      activesupport
+      spanner-lfittl
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.3)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rspec
+  spanner-lfittl!

data/README.rdoc

@@ -0,0 +1,24 @@
+= Spanner
+
+Easy way to parse natural language time spans as periods expressed in seconds. Supports float point notions of spans as well.
+
+== Usage
+
+  require 'spanner'
+  
+  Spanner.parse('1s')
+  => 1
+  
+  Spanner.parse('23 hours 12 minutes')
+  => 83520
+  
+  Spanner.format(83520)
+  => '23 hours 12 minutes'
+  
+== Authors
+
+Original author:
+Joshua Hull <joshbuddy@gmail.com>
+
+Newer contributions:
+Lukas Fittl <lukas@fittl.com>

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake'
+
+require 'rspec/core/rake_task'
+$:.push File.expand_path("../lib", __FILE__)
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "spanner-lfittl"
+    s.description = s.summary = "Natural language time span parsing & formatting"
+    s.email = "lukas@fittl.com"
+    s.homepage = "http://github.com/lfittl/spanner"
+    s.authors = ["Lukas Fittl", "Joshua Hull"]
+    s.files = FileList["[A-Z]*", "{lib,spec}/**/*"]
+    s.add_dependency 'activesupport'
+    s.add_development_dependency 'jeweler'
+    s.add_development_dependency 'rake'
+    s.add_development_dependency 'rspec'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Run 'bundle install'."
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/lib/spanner.rb

@@ -0,0 +1,115 @@
+require 'date'
+require 'active_support/inflector'
+
+class Spanner
+
+  ParseError = Class.new(RuntimeError)
+
+  def self.parse(str, opts = nil)
+    Spanner.new(opts).parse(str)
+  end
+  
+  def self.format(distance, opts = nil)
+    Spanner.new(opts).format(distance)
+  end
+  
+  attr_reader :value, :raise_on_error, :from
+  
+  def initialize(opts)
+    @value = value
+    @on_error = opts && opts.key?(:on_error) ? opts[:on_error] : :raise
+    @length_of_month = opts && opts[:length_of_month]
+    
+    @from = if opts && opts.key?(:from)
+      case opts[:from]
+      when :now
+        Time.new.to_i
+      else 
+        opts[:from].to_i
+      end
+    else
+      0
+    end
+  end
+  
+  def self.days_in_month(year, month)
+    (Date.new(year, 12, 31) << (12-month)).day
+  end
+  
+  def length_of_month
+    @length_of_month ||= Spanner.parse("#{Spanner.days_in_month(Time.new.year, Time.new.month)} days")
+  end
+  
+  def error(err)
+    if on_error == :raise
+      raise ParseError.new(err)
+    end
+  end
+  
+  def parse(value)
+    parts = []
+    part_contextualized = nil
+    value.to_s.scan(/[\+\-]?(?:\d*\.\d+|\d+)|[a-z]+/i).each do |part|
+      part_as_float = Float(part) rescue nil
+      if part_as_float
+        parts << part_as_float
+        part_contextualized = nil
+      else
+        if part_contextualized
+          error "Part has already been contextualized with #{part_contextualized}"
+          return nil
+        end
+        
+        if parts.empty?
+          parts << 1
+        end
+        
+        # part is context
+        multiplier = case part
+        when 's', 'sec', 'second', 'seconds'  then 1
+        when 'h', 'hour', 'hours', 'hrs'      then 3600
+        when 'm', 'min', 'minute', 'minutes'  then 60
+        when 'd', 'day', 'days'               then 86_400
+        when 'w', 'wks', 'week', 'weeks'      then 604_800
+        when 'months', 'month', 'M'           then length_of_month
+        when 'years', 'year', 'y'             then 31_556_926
+        when /\As/                            then 1
+        when /\Am/                            then 60
+        when /\Ah/                            then 3600
+        when /\Ad/                            then 86_400
+        when /\Aw/                            then 604_800
+        when /\AM/                            then length_of_month
+        when /\Ay/                            then 31_556_926
+        end
+        
+        part_contextualized = part
+        parts << (parts.pop * multiplier) if multiplier
+      end
+    end
+    
+    if parts.empty?
+      nil
+    else
+      value = parts.inject(from) {|s, p| s += p}
+      value.ceil == value ? value.ceil : value
+    end
+  end
+  
+  def format(distance)
+    parts = {}
+    parts[:years], distance = distance.divmod(31_556_926)
+    parts[:months], distance = distance.divmod(length_of_month)
+    parts[:weeks], distance = distance.divmod(604_800)
+    parts[:days], distance = distance.divmod(86_400)
+    parts[:hours], distance = distance.divmod(3600)
+    parts[:minutes], parts[:seconds] = distance.divmod(60)
+    
+    output = []
+    parts.each do |name, value|
+      next if value == 0
+      name = name.to_s.singularize if value.between?(-1, 1)
+      output << "%d %s" % [value, name]
+    end
+    output.join(" ")
+  end
+end

data/spec/spanner_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Spanner do
+  
+  it "should return nil for empty strings" do
+    Spanner.parse('').should be_nil
+  end
+
+  it "should assume seconds" do
+    Spanner.parse('1').should == 1
+    Spanner.parse(1).should == 1
+  end
+
+  #simple
+  { '.5s' => 0.5, '1s' => 1, '1.5s' => 1.5, '1m' => 60, '1.5m' => 90, '1d' => 86400, '1.7233312d' => 148895.81568, '1M' => Spanner.days_in_month(Time.new.year, Time.new.month) * 24 * 60 * 60 }.each do |input, output|
+    it "should parse #{input} and return #{output}" do
+      Spanner.parse(input).should == output
+    end
+  end
+
+  #complex
+  { '1m23s' => 83, '3h20min' => 3600*3+20*60 }.each do |input, output|
+    it "should parse #{input} and return #{output}" do
+      Spanner.parse(input).should == output
+    end
+  end
+  
+  #singular
+  { '1 day' => 3600*24, '5 day' => 3600*24*5, '1 hour' => 3600 }.each do |input, output|
+    it "should parse #{input} and return #{output}" do
+      Spanner.parse(input).should == output
+    end
+  end
+  
+  it "should let you set the length of a month" do
+    Spanner.parse("4 months", :length_of_month => 1234).should == 4936
+  end
+  
+  it "should accept time as from option" do
+    now = Time.new
+    Spanner.parse('23s', :from => now).should == now.to_i + 23
+  end
+
+  it "should accept special :now as from option" do
+    Spanner.parse('23s', :from => :now).should == Time.new.to_i + 23
+  end
+end
+
+describe Spanner, "format" do
+  { 3600*24 => '1 day', 3600*24*5 => '5 days', 3620 => '1 hour 20 seconds', 175814631 => '5 years 6 months 3 weeks 1 day 16 hours 20 minutes 1 second' }.each do |input, output|
+    it "should format #{input} as #{output}" do
+      Spanner.format(input).should == output
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'rspec'
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'spanner'

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: spanner-lfittl
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Lukas Fittl
+- Joshua Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-07 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spanner-lfittl
+  requirement: &2152789000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152789000
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152788380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152788380
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152787660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152787660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152787160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152787160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152786500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152786500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152785780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152785780
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152784800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152784800
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &2152784200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2152784200
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152783360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152783360
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152782160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152782160
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152780400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152780400
+description: Natural language time span parsing & formatting
+email: lukas@fittl.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/spanner.rb
+- spec/spanner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: http://github.com/lfittl/spanner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Natural language time span parsing & formatting
+test_files: []