bamnet-acts-as-timecode 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Brian Michalski [[http://www.brispace.net]]
+
+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

@@ -0,0 +1,25 @@
+ActsAsTimecode
+==============
+
+A simple plugin to transform a field stored as seconds into a timecode in the format of HH:MM:SS.
+
+The timecode can be set in any of the following formats:
+HH:MM:SS:FF
+HH:MM:SS
+MM:SS
+SS
+
+Frames will be converted to seconds and rounded, based on the :fps value (default fps = 30)
+
+Example
+=======
+
+class Video < ActiveRecord::Base
+  acts_as_timecode :column => :duration
+end
+
+video.timecode = "01:23:45"
+video.duration = 5025
+
+
+Copyright (c) 2009 Brian Michalski, released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_timecode plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_timecode plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsTimecode'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "acts-as-timecode"
+    gemspec.summary = "ActsAsTimecode provides a timecode field, converting a duration to HH:MM:SS:FF"
+    gemspec.email = "bmichalski@gmail.com"
+    gemspec.homepage = "http://www.brispace.net"
+    gemspec.description = "ActsAsTimecode provides a timecode field, converting a duration to HH:MM:SS:FF"
+    gemspec.authors = ["Brian Michalski"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/acts-as-timecode.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts-as-timecode}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brian Michalski"]
+  s.date = %q{2009-06-03}
+  s.description = %q{ActsAsTimecode provides a timecode field, converting a duration to HH:MM:SS:FF}
+  s.email = %q{bmichalski@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "acts-as-timecode.gemspec",
+     "init.rb",
+     "lib/acts_as_timecode.rb",
+     "test/acts_as_timecode_test.rb"
+  ]
+  s.homepage = %q{http://www.brispace.net}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{ActsAsTimecode provides a timecode field, converting a duration to HH:MM:SS:FF}
+  s.test_files = [
+    "test/acts_as_timecode_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+require 'acts_as_timecode'
+ActiveRecord::Base.class_eval { include Acts::Timecode }

data/lib/acts_as_timecode.rb

@@ -0,0 +1,56 @@
+# ActsAsTimecode
+module Acts
+  module Timecode
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  
+    module ClassMethods
+      def acts_as_timecode(options = {})
+        configuration = {:column => "length", :fps => 30}
+        configuration.update(options) if options.is_a?(Hash)
+        class_eval <<-EOV
+        
+          include Acts::Timecode::InstanceMethods
+          def timecode_column
+            '#{configuration[:column]}'
+          end
+          def fps
+            @fps = '#{configuration[:fps]}'.to_f
+          end
+          
+        EOV
+      end
+    end
+  
+    module InstanceMethods
+      def timecode
+        hours = send(timecode_column).to_i/(60*60).to_i
+        rem = send(timecode_column).to_i - hours * (60*60)
+        minutes = rem/(60).to_i
+        rem = rem - minutes * (60)
+        seconds = rem
+        @timecode = "#{hours.to_s.rjust(2,'0')}:#{minutes.to_s.rjust(2,'0')}:#{seconds.to_s.rjust(2,'0')}"
+      end
+ 
+      def timecode=(value)
+        matches = value.split(':')
+        matches.map!{|s| s.to_i} 
+        case matches.length
+        #HH:MM:SS:FF
+        when 4
+          write_attribute(timecode_column, ((matches[0]*60*60) + (matches[1] * 60) + matches[2] + matches[3]/fps).round)
+        #HH:MM:SS
+        when 3
+          write_attribute(timecode_column, (matches[0]*60*60) + (matches[1] * 60) + matches[2])
+        #MM:SS
+        when 2
+          write_attribute(timecode_column, matches[0] * (60) + matches[1])
+        #SS
+        else
+          write_attribute(timecode_column, value)
+        end
+      end
+    end
+  end
+end

data/test/acts_as_timecode_test.rb

@@ -0,0 +1,83 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+ 
+require "#{File.dirname(__FILE__)}/../init"
+ 
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ 
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :vids do |t|
+      t.column :desired, :string
+      t.column :duration, :integer
+      t.column :created_at, :datetime
+      t.column :updated_at, :datetime
+    end
+  end
+end
+ 
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Vid < ActiveRecord::Base
+end
+
+class TimecodeVid < Vid
+  acts_as_timecode :column => :duration
+  
+  def self.table_name() "vids" end
+end
+
+class ActsAsTimecodeTest < Test::Unit::TestCase
+  
+  def setup
+    setup_db
+    TimecodeVid.create! :desired => "00:00:00", :duration => 0
+    TimecodeVid.create! :desired => "00:01:00", :duration => 60
+    TimecodeVid.create! :desired => "00:01:33", :duration => 93
+    TimecodeVid.create! :desired => "25:12:59", :duration => 90779
+  end
+  def teardown
+    teardown_db
+  end
+  
+  def test_getting
+    assert_equal TimecodeVid.find(1).desired, TimecodeVid.find(1).timecode
+    assert_equal TimecodeVid.find(2).desired, TimecodeVid.find(2).timecode
+    assert_equal TimecodeVid.find(3).desired, TimecodeVid.find(3).timecode
+    assert_equal TimecodeVid.find(4).desired, TimecodeVid.find(4).timecode
+  end
+  
+  def test_setting
+    @T2 = TimecodeVid.find(2)
+    @T2.timecode = "00:00:00"
+    
+    assert_not_equal @T2.desired, @T2.duration
+    assert_equal @T2.timecode, TimecodeVid.find(1).desired
+
+    @T3 = TimecodeVid.find(3)
+    @T3.timecode = "00:60:60"
+    @T3.save
+    
+    assert_equal @T3.timecode, "01:01:00"
+    assert_equal @T3.duration, 3660
+    
+    @T3.timecode = "01:05:15:24"
+    #The real value here is 3915.8, but we are working in seconds so we round
+    assert_equal @T3.duration, 3916
+    
+    @T3.timecode = "59:01"
+    assert_equal @T3.timecode, "00:59:01"
+    assert_equal @T3.duration, 3541
+    
+    @T3.timecode = "32"
+    assert_equal @T3.timecode, "00:00:32"
+    assert_equal @T3.duration, 32
+    
+    
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: bamnet-acts-as-timecode
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brian Michalski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ActsAsTimecode provides a timecode field, converting a duration to HH:MM:SS:FF
+email: bmichalski@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- acts-as-timecode.gemspec
+- init.rb
+- lib/acts_as_timecode.rb
+- test/acts_as_timecode_test.rb
+has_rdoc: false
+homepage: http://www.brispace.net
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: ActsAsTimecode provides a timecode field, converting a duration to HH:MM:SS:FF
+test_files: 
+- test/acts_as_timecode_test.rb