vidibus-timecode 0.1.0 → 0.1.1

data/.rspec

@@ -1 +1,2 @@
 --format nested
+--colour

data/Gemfile

@@ -1,4 +1,4 @@
-source :gemcutter
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in vidibus-timecode.gemspec
 gemspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2011 Andre Pankratz
+MIT License
+
+Copyright (c) 2011-2013 Andre Pankratz
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,107 @@
+# Vidibus::Timecode [![](http://travis-ci.org/vidibus/vidibus-timecode.png)](http://travis-ci.org/vidibus/vidibus-timecode)
+
+Timecodes are a simple, yet powerful way to notate times.
+
+This gem is part of [Vidibus](http://vidibus.org), an open source toolset for building distributed (video) applications.
+
+
+## Installation
+
+Add `gem "vidibus-timecode"` to your Gemfile. Then call `bundle install` on your console.
+
+
+## Usage
+
+A timecode instance requires at least one parameter. Valid inputs are time objects and timecode strings:
+
+```ruby
+Vidibus::Timecode.new(Time.now)
+Vidibus::Timecode.new("2011/12/07@21:00")
+```
+
+A timecode instance provides two methods, `timecode` and `time`:
+
+```ruby
+Vidibus::Timecode.new(Time.now).timecode
+# => "2011/12/07@21:00"
+
+Vidibus::Timecode.new("2011/12/07@21:00").time
+# => Wed Dec 07 21:00:00 +0100 2011
+```
+
+
+## Syntax
+
+Timecodes may be used to describe single, definite times or multiple, even random times. Each timecode is
+comprised of a date and a time part, joined by "@": `#{date}@#{time}`
+
+As shown above, a timecode object may represent a single time:
+
+```ruby
+"2011/12/07@21:00" # Wed Dec 07 21:00:00 +0100 2011
+```
+
+But timecodes may also be used to define repeating times, like cron. Timcode will return the next future time:
+
+```ruby
+"7@21:00" # next 7th of a month, e.g. Thu Jul 07 21:00:00 +0200 2011
+```
+
+
+### Examples
+
+Some syntax examples:
+
+```ruby
+# each 7th of every month at 21:00
+"7@21"
+
+# each 7th of every month at 21:00
+"7@21:00"
+
+# each 7th of december every year at 21:00
+"12/7@21:00"
+
+# on 7th of december 2011 at 21:00
+"2011/12/07@21:00"
+```
+
+
+### More Examples (not implemented yet)
+
+In the future Vidibus::Timecode will be able to handle collections, ranges and random times:
+
+```ruby
+# on 7th and 23rd of december 2011 at 21:00
+"2011/12/07+23@21:00"
+
+# from 7th to 23rd of december 2011 at 21:00
+"2011/12/07-23@21:00"
+
+# on 7th or 23rd of december 2011 at 21:00
+"2011/12/07,23@21:00"
+
+# on one day between 7th and 23rd of december 2011 at 21:00
+"2011/12/07~23@21:00"
+
+# from 7th to 23rd of november and from 7th to 23rd of december 2011 at 21:00
+"2011/11+12/07-23@21:00"
+
+# between 7th and 23rd of november or december 2011 at 21:00
+"2011/11,12/07-23@21:00"
+```
+
+
+## TODO
+
+* Allow range input
+* Allow list input
+* Allow precision option: `:miliseconds`
+* Make precision `:seconds` default
+* Add method `explain` to print timecode in words
+* Allow timecodes without date or time: `"@21" # everyday at 21:00`
+
+
+## Copyright
+
+© 2011 Andre Pankratz. See LICENSE for details.

data/Rakefile

@@ -8,18 +8,10 @@ Bundler::GemHelper.install_tasks
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "vidibus/timecode"
 
-RSpec::Core::RakeTask.new(:rcov) do |t|
-  t.pattern = "spec/**/*_spec.rb"
-  t.rcov = true
-  t.rcov_opts = ["--exclude", "^spec,/gems/"]
-end
-
 Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = "rdoc"
-  rdoc.title = "vidibus-sysinfo #{Vidibus::Timecode::VERSION}"
+  rdoc.title = "vidibus-timecode #{Vidibus::Timecode::VERSION}"
   rdoc.rdoc_files.include("README*")
   rdoc.rdoc_files.include("lib/**/*.rb")
   rdoc.options << "--charset=utf-8"
 end
-
-task :default => :rcov

data/lib/vidibus-timecode.rb

@@ -1,2 +1 @@
-require "time"
 require "vidibus/timecode"

data/lib/vidibus/timecode.rb

@@ -1,25 +1,29 @@
 module Vidibus
   class Timecode
-    VERSION = "0.1.0"
+    VERSION = '0.1.1'
 
     YEAR_REGEXP = /(\d{3,4}(?:[,\-]\d{3,4})?)/
     MONTH_REGEXP = /(\d{1,2}(?:[,\-]\d{1,2})?)/
     DAY_REGEXP = /(\d{1,2}(?:[,\-]\d{1,2})?)/
     TIME_REGEXP = /(\d{1,2}(?:[,\-]\d{1,2})?)/
-    REGEXP = /^(?:#{YEAR_REGEXP}\/)?(?:#{MONTH_REGEXP}\/)?#{DAY_REGEXP}@#{TIME_REGEXP}(?:\:#{TIME_REGEXP}){0,2}$/
+    REGEXP = /^(?:#{YEAR_REGEXP}\/)?(?:#{MONTH_REGEXP}\/)?#{DAY_REGEXP}@#{TIME_REGEXP}(?:\:#{TIME_REGEXP})?(?:\:#{TIME_REGEXP})?$/
 
     class Error < StandardError; end
     class InputError < Error; end
     class FormatError < Error; end
 
     def initialize(*args)
-      options = extract_options!(args)
+      @options = extract_options!(args) || {}
       @input = args.first or raise_input_error
       process_input
     end
 
     def timecode
-      @timecode ||= @time.strftime("%Y/%m/%d@%H:%M")
+      @timecode ||= begin
+        format = '%Y/%m/%d@%H:%M'
+        format << ':%S' if @options[:precision].to_s == 'seconds'
+        @time.strftime(format)
+      end
     end
 
     def time
@@ -50,8 +54,9 @@ module Vidibus
         day = m[3]
         hour = m[4].to_i
         minute = m[5].to_i
+        second = m[6].to_i
 
-        Time.local(year, month, day, hour, minute).tap do |time|
+        Time.local(year, month, day, hour, minute, second).tap do |time|
           time.in_time_zone if time.respond_to?(:in_time_zone)
         end
       else

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$:.unshift File.expand_path('../../', __FILE__)
 
 require "rubygems"
 require "rspec"

data/spec/vidibus/timecode_spec.rb

@@ -10,15 +10,16 @@ describe "Vidibus::Timecode" do
     end
 
     it "should accept a Time" do
-      expect {Vidibus::Timecode.new(time)}.not_to raise_error(Vidibus::Timecode::InputError)
+      expect {Vidibus::Timecode.new(time)}.not_to raise_error
     end
 
     it "should accept a Timecode string" do
-      expect {Vidibus::Timecode.new(timecode)}.not_to raise_error(Vidibus::Timecode::InputError)
+      expect {Vidibus::Timecode.new(timecode)}.not_to raise_error
     end
 
     it "should raise an FormatError for invalid Timecode input" do
-      expect {Vidibus::Timecode.new("2011/12/07")}.to raise_error(Vidibus::Timecode::FormatError)
+      expect {Vidibus::Timecode.new("2011/12/07")}.
+        to raise_error(Vidibus::Timecode::FormatError)
     end
   end
 
@@ -37,6 +38,15 @@ describe "Vidibus::Timecode" do
     it "should return a local time object by default" do
       this.time.should eql(time.localtime)
     end
+
+    context 'with seconds' do
+      let(:time) { Time.parse('2011-12-07 21:00:39') }
+      let(:timecode) { '2011/12/07@21:00:39' }
+
+      it "should return the timecode of a given time" do
+        this.time.should eql(time.localtime)
+      end
+    end
   end
 
   describe "#timecode" do
@@ -49,6 +59,16 @@ describe "Vidibus::Timecode" do
     it "should return the timecode of a given time" do
       this.timecode.should eql(timecode)
     end
+
+    context 'with precision: :seconds' do
+      let(:time) { Time.parse('2011-12-07 21:00:39') }
+      let(:timecode) { '2011/12/07@21:00:39' }
+      let(:this) { Vidibus::Timecode.new(time, precision: :seconds) }
+
+      it "should return the timecode of a given time" do
+        this.timecode.should eql(timecode)
+      end
+    end
   end
 
   # describe "speed test" do

data/vidibus-timecode.gemspec

@@ -14,6 +14,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/vidibus/vidibus-timecode"
   s.summary     = "Timecodes are a simple, yet powerful way to notate times."
   s.description = "Timecodes may be used to describe single, definite times or multiple, even random times."
+  s.license     = 'MIT'
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "vidibus-timecode"
@@ -21,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "rdoc"
-  s.add_development_dependency "rcov"
+  s.add_development_dependency "simplecov"
   s.add_development_dependency "rspec", "~> 2"
   s.add_development_dependency "rr"
 

metadata

@@ -1,165 +1,157 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vidibus-timecode
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Andre Pankratz
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-09 00:00:00 +02:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rcov
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        version: "2"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rr
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-description: Timecodes may be used to describe single, definite times or multiple, even random times.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Timecodes may be used to describe single, definite times or multiple,
+  even random times.
 email: andre@vidibus.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - lib/vidibus-timecode.rb
 - lib/vidibus/timecode.rb
 - spec/spec_helper.rb
 - spec/vidibus/timecode_spec.rb
 - vidibus-timecode.gemspec
-has_rdoc: true
 homepage: https://github.com/vidibus/vidibus-timecode
-licenses: []
-
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: 1613326113527692330
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: vidibus-timecode
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Timecodes are a simple, yet powerful way to notate times.
 test_files: []
-

data/README.rdoc

@@ -1,67 +0,0 @@
-= Vidibus::Timecode
-
-Timecodes are a simple, yet powerful way to notate times.
-
-This gem is part of {Vidibus}[http://vidibus.org], an open source toolset for building distributed (video) applications.
-
-
-== Compatibility
-
-http://travis-ci.org/vidibus/vidibus-timecode.png
-
-Vidibus::Secure is tested against Ruby 1.8.7. {Build History}[http://travis-ci.org/vidibus/vidibus-timecode]
-
-
-== Installation
-
-Add the dependency to the Gemfile of your application:
-
-  gem "vidibus-timecode"
-
-Then call bundle install on your console.
-
-
-== Usage
-
-Timecodes may be used to describe single, definite times or multiple, even random times. Each timecode is
-comprised of a date and a time part, joined by "@":
-  #{date}@#{time}
-
-In it's basic form, a timecode object will return a single time:
-  2011/12/07@21:00  # => Wed Dec 07 21:00:00 +0100 2011
-
-But timecodes may also be used to define repeating times, like cron. Timcode will return the next future time:
-  7@21:00  # => next 7th of a month, e.g. Thu Jul 07 21:00:00 +0200 2011
-  
-When defining a range, Timecode will output a random time within range defined:
-  2011/12/07@21:00-23:55  # => e.g. Wed Dec 07 22:13:45 +0100 2011
-
-Please note: Only the basic for has been implemented already.
-
-
-== Examples
-
-Some usage examples:
-
-  7@21                                # each 7th of each month at 21:00
-  7@21:00                             # each 7th of each month at 21:00
-  12/7@21:00                          # each 7th of each december at 21:00
-  2011/12/07@21:00                    # on 7th of december 2011 at 21:00
-  2011/12/07,23@21:00                 # on 7th and 23rd of december 2011 at 21:00
-  2011/12/07-23@21:00                 # between 7th and 23rd of december 2011 at 21:00
-  2011/11,12/07-23@21:00              # between 7th and 23rd of november and between 7th and 23rd of december 2011 at 21:00
-  2011/11-12/07-23@21:00              # between 7th and 23rd of november or december 2011 at 21:00
-  2011/12/07,2012/01/04@21:00,22:30   # on 7th of december 2011 and on 4th of january 2012 at 21:00 and 22:30
-
-
-== TODO
-
-* Allow range input
-* Allow list input
-* Allow precision option: :seconds or :miliseconds
-* Add method #explain to print timecode in words
-
-
-== Copyright
-
-Copyright (c) 2011 Andre Pankratz. See LICENSE for details.