vidibus-timecode 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+Gemfile.lock
+*.gem
+.bundle
+rdoc
+coverage

data/.rspec

@@ -0,0 +1 @@
+--format nested

data/.travis.yml

@@ -0,0 +1 @@
+script: "bundle exec rspec spec --format progress"

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andre Pankratz
+
+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,67 @@
+= 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.

data/Rakefile

@@ -0,0 +1,25 @@
+require "bundler"
+require "rdoc/task"
+require "rspec"
+require "rspec/core/rake_task"
+
+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.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << "--charset=utf-8"
+end
+
+task :default => :rcov

data/lib/vidibus-timecode.rb

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

data/lib/vidibus/timecode.rb

@@ -0,0 +1,66 @@
+module Vidibus
+  class Timecode
+    VERSION = "0.1.0"
+
+    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}$/
+
+    class Error < StandardError; end
+    class InputError < Error; end
+    class FormatError < Error; end
+
+    def initialize(*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")
+    end
+
+    def time
+      @time ||= parse_timecode
+    end
+
+    protected
+
+    def process_input
+      if @input.is_a?(Time)
+        @time = @input
+      elsif @input.is_a?(String)
+        @timecode = @input
+        time # trigger parsing of timecode for validation
+      else
+        raise_input_error
+      end
+    end
+
+    def extract_options!(args)
+      args.last.is_a?(Hash) and args.last.instance_of?(Hash) ? args.pop : {}
+    end
+
+    def parse_timecode
+      if m = timecode.match(REGEXP)
+        year = m[1] || Time.now.strftime("%Y")
+        month = m[2] || Time.now.strftime("%m")
+        day = m[3]
+        hour = m[4].to_i
+        minute = m[5].to_i
+
+        Time.local(year, month, day, hour, minute).tap do |time|
+          time.in_time_zone if time.respond_to?(:in_time_zone)
+        end
+      else
+        raise(FormatError)
+      end
+    end
+
+    def raise_input_error
+      raise(InputError, "Please provide Time or Timecode input.")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rubygems"
+require "rspec"
+require "rr"
+require "vidibus-timecode"
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

data/spec/vidibus/timecode_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe "Vidibus::Timecode" do
+  let(:timecode) {"2011/12/07@21:00"}
+  let(:time) {Time.parse("2011-12-07 21:00")}
+
+  describe "initializing" do
+    it "should require arguments" do
+      expect {Vidibus::Timecode.new}.to raise_error(Vidibus::Timecode::InputError, "Please provide Time or Timecode input.")
+    end
+
+    it "should accept a Time" do
+      expect {Vidibus::Timecode.new(time)}.not_to raise_error(Vidibus::Timecode::InputError)
+    end
+
+    it "should accept a Timecode string" do
+      expect {Vidibus::Timecode.new(timecode)}.not_to raise_error(Vidibus::Timecode::InputError)
+    end
+
+    it "should raise an FormatError for invalid Timecode input" do
+      expect {Vidibus::Timecode.new("2011/12/07")}.to raise_error(Vidibus::Timecode::FormatError)
+    end
+  end
+
+  describe "#time" do
+    let(:this) {Vidibus::Timecode.new(timecode)}
+
+    it "should return time input" do
+      Vidibus::Timecode.new(time).time.should === time
+    end
+
+    it "should try to use Rails' #in_time_zone by default" do
+      mock.any_instance_of(Time).in_time_zone
+      this.time
+    end
+
+    it "should return a local time object by default" do
+      this.time.should eql(time.localtime)
+    end
+  end
+
+  describe "#timecode" do
+    let(:this) {Vidibus::Timecode.new(time)}
+
+    it "should return the timecode input" do
+      Vidibus::Timecode.new(timecode).timecode.should === timecode
+    end
+
+    it "should return the timecode of a given time" do
+      this.timecode.should eql(timecode)
+    end
+  end
+
+  # describe "speed test" do
+  #   let(:iterations) {100000}
+  #   let(:year) {2011}
+  #   let(:month) {12}
+  #   let(:day) {7}
+  #   let(:hour) {21}
+  #   let(:minute) {4}
+  #   let(:time) {Time.local(year, month, day, hour, minute)}
+  #
+  #   it "of Time.local" do
+  #     iterations.times do
+  #       Time.local(year, month, day, hour, minute)
+  #     end
+  #   end
+  #
+  #   it "of Time.parse" do
+  #     iterations.times do
+  #       Time.parse("#{year}-#{month}-#{day} #{hour}:#{minute}")
+  #     end
+  #   end
+  #
+  #   it "of rescuing a failed method call" do
+  #     iterations.times do
+  #       begin
+  #         time.invalid
+  #       rescue NoMethodError
+  #         time
+  #       end
+  #     end
+  #   end
+  #
+  #   it "of checking #respond_to?" do
+  #     if time.respond_to?(:invalid)
+  #       time.invalid
+  #     else
+  #       time
+  #     end
+  #   end
+  # end
+end

data/vidibus-timecode.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path("../lib/", __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require "vidibus/timecode"
+
+Gem::Specification.new do |s|
+  s.name        = "vidibus-timecode"
+  s.version     = Vidibus::Timecode::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = "Andre Pankratz"
+  s.email       = "andre@vidibus.com"
+  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.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "vidibus-timecode"
+
+  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 "rspec", "~> 2"
+  s.add_development_dependency "rr"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification 
+name: vidibus-timecode
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andre Pankratz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+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: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.rdoc
+- 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: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: vidibus-timecode
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Timecodes are a simple, yet powerful way to notate times.
+test_files: []
+