timeparser 0.0.1 → 0.0.2

data/Gemfile

@@ -3,5 +3,7 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in timeparser.gemspec
 gemspec
 
-gem 'rspec'
-gem 'simplecov'
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end

data/Rakefile

@@ -5,3 +5,6 @@ desc "Run all examples"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w[--color]
 end
+
+
+task :default => :spec

data/Readme.md

@@ -0,0 +1,56 @@
+Timeparser
+==========
+
+Allows you to parse times from a string using a treetop grammar. It's pretty basic.
+
+Example
+-------
+
+    Timeparser.parse("1h20m").to_i # => 80
+    Timeparser.parse("1h20m").hours # => 1
+    Timeparser.parse("1h20m").hours(:up) # => 2
+    Timeparser.parse("1h40m").hours(:down) # => 1
+    Timeparser.parse("1h20m").minutes # => 80
+
+Installation
+------------
+
+Before installing this or another Gem I highly recommend using RVM and that you create a .rvmrc file for your project.
+
+    touch .rvmrc && echo "rvm use 1.9.2-p270@yourproject --create" > .rvmrc
+
+Install the gem:
+
+    gem install timeparser
+
+or add it to your Gemfile if you are using Bundler (recommended)
+
+    gem 'timeparser'
+
+and then run
+
+    bundle
+
+
+Usage
+-----
+
+    Timeparser.parse('your time information')
+
+will return a Timeparser::Time instance. If you need the accumulated minutes that were parsed out of the string call the #to_i or #minutes methods.
+
+The Time instance also knows about hours, which you can access through the #hours method. #hours takes an argument which allows you to round up the hours based on the minutes. Default is rounding down.
+
+
+Run the specs
+-------------
+
+    git clone git://github.com/the-architect/timeparser.git
+    cd timeparser
+    bundle install
+    rake
+
+You can view the coverage info generated by simplecov by opening the generated files after you ran the tests.
+
+    open coverage/index.html
+

data/lib/timeparser/parser.rb

@@ -0,0 +1,19 @@
+require 'polyglot'
+require 'treetop'
+Treetop.load File.join(File.dirname(__FILE__), 'timeparsing.treetop')
+
+module Timeparser
+  class Parser
+    def parser
+      @parser ||= TimeparsingParser.new
+    end
+
+    def parse(string)
+      if result = parser.parse(string.strip)
+        Time.new(result.value)
+      else
+        Time.new(0)
+      end
+    end
+  end
+end

data/lib/timeparser/time.rb

@@ -0,0 +1,24 @@
+module Timeparser
+  class Time
+    def initialize(minutes)
+      @minutes = minutes.to_i
+    end
+
+    def to_i
+      minutes
+    end
+
+    def hours(round = nil)
+      case round
+        when :up
+          (minutes.to_f / 60.0).ceil
+        else
+          (minutes.to_f / 60.0).to_i
+      end
+    end
+
+    def minutes
+      @minutes
+    end
+  end
+end

data/lib/timeparser/timeparsing.treetop

@@ -1,15 +1,31 @@
 grammar Timeparsing
+
   rule root
-    (dot_seperated / hours / minutes)*
+    (times / whitespace)*
+    {
+      def value
+        elements.inject(0) do |akk, e|
+          akk += e.value
+          akk
+        end
+      end
+    }
+  end
+
+  rule times
+    dot_seperated / hours / minutes / other_stuff
     {
       def value
-        self.elements.inject(0) {|akk, e| akk += e.value; akk }
+        elements.inject(0) do |akk, e|
+          akk += e.value
+          akk
+        end
       end
     }
   end
 
   rule dot_seperated
-    [0-9]* ':' [0-9]*
+    (([0-9]* ':' [0-9]*) / (hours ':' minutes))
     {
       def value
         elements[0].text_value.to_i*60 + elements[2].text_value.to_i
@@ -18,7 +34,7 @@ grammar Timeparsing
   end
 
   rule hours
-    ([0-9]* 'h' / 'hours')
+    [0-9]+ ('hours' / 'hrs' / 'h')
     {
       def value
         self.text_value.to_i * 60
@@ -27,7 +43,7 @@ grammar Timeparsing
   end
 
   rule minutes
-    ( [0-9]* "m" / "min" /  "minutes" )
+    [0-9]+ ("minutes" / "min" /  "m")
     {
       def value
         self.text_value.to_i
@@ -35,4 +51,13 @@ grammar Timeparsing
     }
   end
 
+  rule whitespace
+    " "
+    { def value; 0; end }
+  end
+
+  rule other_stuff
+    [a-zA-Z]+
+    { def value; 0; end }
+  end
 end

data/lib/timeparser/version.rb

@@ -1,3 +1,3 @@
 module Timeparser
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/timeparser.rb

@@ -1,16 +1,15 @@
 require "timeparser/version"
-require 'polyglot'
-require 'treetop'
-Treetop.load File.join(File.dirname(__FILE__), 'timeparser/timeparsing.treetop')
+require "timeparser/parser"
+require "timeparser/time"
 
 module Timeparser
-  class Parser
+  class << self
     def parser
-      @parser ||= TimeparsingParser.new
+      @parser ||= Parser.new
     end
 
     def parse(string)
-      parser.parse(string).value
+      parser.parse string
     end
   end
 end

data/spec/lib/time_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Timeparser::Time do
+  it "creates instance" do
+    Timeparser::Time.new(0).should_not be_nil
+  end
+
+  it "should not round hours by default" do
+    Timeparser::Time.new(130).hours.should eql 2
+  end
+
+  it "should round down" do
+    Timeparser::Time.new(130).hours(:down).should eql 2
+  end
+
+  it "should round up" do
+    Timeparser::Time.new(130).hours(:up).should eql 3
+  end
+end

data/spec/lib/timeparser_spec.rb

@@ -5,21 +5,60 @@ describe Timeparser do
     Timeparser::Parser.new.should_not be_nil
   end
 
-  let(:parser){ Timeparser::Parser.new }
+  context "instance methods" do
+    let(:parser){ Timeparser::Parser.new }
 
-  it "parses hours" do
-    parser.parse('1h').should eql 60
-  end
+    it "ignores whitespaces" do
+      parser.parse("  1h  ").to_i.should eql 60
+    end
 
-  it "parses minutes" do
-    parser.parse('1m').should eql 1
-  end
+    it "handles whitespaces in between" do
+      parser.parse('1h 20m').to_i.should eql 80
+    end
+
+    it "parses hours" do
+      parser.parse('1h').to_i.should eql 60
+      parser.parse('2hrs').to_i.should eql 120
+      parser.parse('2hours').to_i.should eql 120
+    end
+
+    it "parses minutes" do
+      parser.parse('1m').to_i.should eql 1
+      parser.parse('20min').to_i.should eql 20
+      parser.parse('120minutes').to_i.should eql 120
+    end
+
+    it "parses hours and minutes" do
+      parser.parse('1h20m').to_i.should eql 80
+    end
+
+    it "parses colon notation" do
+      parser.parse('1:20').to_i.should eql 80
+    end
 
-  it "parses hours and minutes" do
-    parser.parse('1h20m').should eql 80
+    it "parses enhanced colon notation" do
+      parser.parse('1h:20m').to_i.should eql 80
+    end
+
+    it "parses empty string" do
+      parser.parse('').to_i.should eql 0
+    end
+
+    it "parses times within a text" do
+      parser.parse(%Q{The movie was 1h long but the truck was 20m long.}).to_i.should eql 0
+    end
   end
 
-  it "parses dot notation" do
-    parser.parse('1:20').should eql 80
+
+  context "module methods" do
+    it "has instance of parser" do
+      Timeparser.parser.should be_instance_of(Timeparser::Parser)
+    end
+
+    it "should delegate to parser instance" do
+      Timeparser.parser.should_receive(:parse).with('1:20')
+      Timeparser.parse('1:20')
+    end
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timeparser
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: treetop
-  requirement: &70191347829680 !ruby/object:Gem::Requirement
+  requirement: &70111894166920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70191347829680
+  version_requirements: *70111894166920
 description: Parses time information from strings.
 email:
 - marcel.scherf@epicteams.com
@@ -33,9 +33,13 @@ files:
 - .rvmrc
 - Gemfile
 - Rakefile
+- Readme.md
 - lib/timeparser.rb
+- lib/timeparser/parser.rb
+- lib/timeparser/time.rb
 - lib/timeparser/timeparsing.treetop
 - lib/timeparser/version.rb
+- spec/lib/time_spec.rb
 - spec/lib/timeparser_spec.rb
 - spec/spec_helper.rb
 - timeparser.gemspec
@@ -64,5 +68,6 @@ signing_key:
 specification_version: 3
 summary: Parses time information from strings.
 test_files:
+- spec/lib/time_spec.rb
 - spec/lib/timeparser_spec.rb
 - spec/spec_helper.rb