video_data 0.1.0 → 0.2.1

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/growl'

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/README.markdown

@@ -27,3 +27,40 @@ Use Rubygems to install video_data:
     video.tags                               # Outputs an array of  active tags
     video[:date]                             # Hash like access to data
     video.to_s                               # Ouputs a human readable string of the video data 
+    video.eye_winged?                        # Dynamic predicates for each tag
+
+## Tests
+
+    $ rake spec
+
+## Documentation
+
+    $ rake rdoc
+
+## Description of Solution
+Decided from the first moment to make it a gem to make it easy to use
+and install.
+I decided to separate in two clases the main responsabilites to
+resolve the problem:
+
+* VideoData::Parser: Read the csv file and get the columns(attributes)
+  and the data. Have a convenient method to get all the videos in the
+  file. Handle convertion of : to _ for tags.
+* VideoData::Video: From the attributes extracted in the parser and
+  the row data define the attributes of the video.
+
+The gotchas are when pairing the attributes and the row data, order
+is vital to associate each value. Some data is saved as is (:videos,
+:date, :celebrity) while each tag is associated to a boolean value.
+
+VideoData::Video has easy access to the data using \#name, \#date,
+\#celebrity and \#tags. Bonus hash-like access is a natural 
+addition given that internally the data is stored in a hash.
+
+So recaping we have VideoData::Parser that reads the file, separates
+the columns and the data, then delegates the pairing of attributes and row
+data to VideoData::Video, finally internally it stores the video data in a Hash.
+
+Brownie points for adding dynamic predicates for each defined tag.
+
+A convenient ::new in the top module to jump start the extraction.

data/Rakefile

@@ -44,6 +44,7 @@ RDoc::Task.new do |rdoc|
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "video_data #{version}"
+  rdoc.main = "README.rdoc"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.1

data/lib/video_data/parser.rb

@@ -1,15 +1,35 @@
 module VideoData
 
+  # Class that handles the extraction of the attributes
+  # and video data from the csv file
   class Parser
+    # The first row of the csv file defines the attributes the videos have.
     attr_reader :attributes
 
+    # Extracts the data inside the csv file given in the +path+
+    # The attributes and data are separated here.
+    # * *Args*    :
+    #   - +path+ The file path to the csv file.
     def initialize(path)
-      raise ArgumentError, "Expected a csv file" unless File.exists?(path)
+      raise ArgumentError, "Expected a csv file" unless File.exists?(path) && path =~ /(.*)\.csv/
       @data = File.read(path)
-      attributes = @data.slice!(/.*?\n/).strip.split(',')
-      @attributes = attributes.collect {|attr| attr.downcase.gsub(/:/, '_').to_sym}
+
+      raw_attributes = @data.slice!(/.*?\n/)
+      raise VideoData::NotAWellFormedCSV unless raw_attributes
+
+      attributes = raw_attributes.strip.split(',')
+      @attributes = attributes.collect do |attr|
+        attr.downcase.gsub(/:/, '_').to_sym
+      end
+
+      [:videos, :date, :celebrity].each do |attr|
+        raise VideoData::NotAWellFormedCSV, "#{attr} column is missing in csv file" unless @attributes.include?(attr)
+      end
     end
 
+    # For each row in the csv file a VideoData::Video is created.
+    # * *Returns* :
+    #   - An array of VideoData::Video objects.
     def videos
       videos = []
       @data.lines do |line|

data/lib/video_data/video.rb

@@ -1,9 +1,27 @@
 module VideoData
+  # Class that represents the data of a video.
+  # Has dynamic predicates for valid tags.
+  # If :eye_winged is a valid tag you can
+  #    video = VideoData.new(attributes, data)
+  #    video.eye_winged?  # Outputs *true* or *false*
   class Video
+    # The defined attributes from the csv file the video data
+    # was extacted.
     attr_reader :attributes
 
+    # From the attributes and the row line a VideoData::Video is created
+    # * *Args*    :
+    #   - +attributes+ The attributes defined in the csv file. The
+    #   order is vital to match attributes and values.
+    #   - +data+ The row line that has all the video data in csv format
     def initialize(attributes, data)
       @attributes = attributes
+
+      @all_tags = attributes.dup
+      [:videos, :date, :celebrity].each do |attr|
+        @all_tags.delete attr
+      end
+
       video_data = data.strip.split(',')
 
       @data = {}
@@ -22,18 +40,25 @@ module VideoData
       end
     end
 
+    # Name of the video
     def name
       @data[:videos]
     end
 
+    # Date of the video
     def date
       @data[:date]
     end
 
+    # Celebrity of the video. Can be an empty string
     def celebrity
       @data[:celebrity]
     end
 
+    # The tags active for the video
+    # * *Returns* :
+    #   -Returns an array of symbols. Each symbol is an active tag in
+    # the video
     def tags
       tags = @data.dup
       [:videos, :date, :celebrity].each do |attr|
@@ -42,20 +67,35 @@ module VideoData
       tags.select { |key,value| value }.keys
     end
 
+    # Hash-like access to the data
+    # * *Args* :
+    #   - +attr+ The attribute to be ouput. Expects a symbol.
     def [](attr)
       @data[attr]
     end
 
+    # Return a human friendly output with the video data.
     def to_s
       video_tags = tags
       last_tag = video_tags.pop if video_tags.size > 1
       output_tags = video_tags.join(', ')
       output_tags += " and #{last_tag}" if last_tag
 
-      "#{@data[:videos]} has a date of #{@data[:date]} and his " +
-        "celebrity is #{@data[:celebrity]}, additionally this video" +
+      artist = celebrity.empty? ? "unknown" : celebrity
+
+      "#{name} has a date of #{date} and his " +
+        "celebrity is #{artist}, additionally this video" +
         " has this list of tags: #{output_tags}"
     end
+
+    # Added dynamic predicates for valid tags.
+    # eg if :eye_winged is a valid tag you can
+    #    video.eye_winged?  # Outputs *true* or *false*
+    def method_missing(m, *args) # :nodoc:
+      attr = m[0..-2].to_sym
+      return @data[attr] if m =~ /(.*)\?/ and @all_tags.include?(attr)
+      raise NoMethodError
+    end
   end
 
 end

data/lib/video_data.rb

@@ -1,9 +1,19 @@
+# The video_data gem helps in the extraction of video data from
+# csv files.
 module VideoData
   class << self
+    # Create a new parser for the given csv file.
+    # * *Args*    :
+    #   - +path+ The file path to the csv file.
+    # * *Returns* :
+    #   - A parser, VideoData::Parser, ready for video data extraction.
     def new(path)
       VideoData::Parser.new(path)
     end
   end
+
+  # Custom exception raised when the csv file isn't in the expect format
+  class NotAWellFormedCSV < StandardError; end
 end
 
 require 'video_data/video'

data/spec/data/bad_data.csv

@@ -0,0 +1,3 @@
+title, datetime, celeb, eye_winged, eye_smoked
+qwenimern, 21-Abr-10, Jack,,
+anqwebovn, 12-May-11,,x,x

data/spec/video_data/parser_spec.rb

@@ -4,29 +4,39 @@ describe VideoData::Parser do
 
   before(:all) do
     path = File.dirname(__FILE__) + '/../data/video_data.csv'
+    @bad_file = File.dirname(__FILE__) + '/../data/video_data'
+    @bad_data = File.dirname(__FILE__) + '/../data/bad_data.csv'
     @parser = VideoData::Parser.new(path)
   end
 
-  describe ".new" do
+  describe "::new" do
 
     it 'should raise an error with zero arguments' do
-      expect{ VideoData::Parser.new }.to raise_error
+      expect{ VideoData::Parser.new }.to raise_error ArgumentError
     end
 
     it 'should raise an error with non-existant csv file' do
-      expect{ VideoData::Parser.new('Idontexist.csv')}.to raise_error ArgumentError
+      expect{ VideoData::Parser.new('Idontexist.csv') }.to raise_error ArgumentError
+    end
+
+    it 'should raise an error with a non csv file' do
+      expect{ VideoData::Parser.new(@bad_file) }.to raise_error ArgumentError
+    end
+
+    it 'should raise an error with bad csv file' do
+      expect{ VideoData::Parser.new(@bad_data) }.to raise_error VideoData::NotAWellFormedCSV
     end
 
   end
 
-  describe ".attributes" do
+  describe "#attributes" do
 
     it 'should return an array of symbols' do
       @parser.attributes.should be_a Array
       @parser.attributes[0].should be_a Symbol
     end
 
-    it "should return tags without ':' has word separator" do
+    it "should return tags without ':' as word separator" do
       @parser.attributes[3].should_not match(/:/)
       @parser.attributes[-1].should_not match(/:/)
     end
@@ -38,7 +48,7 @@ describe VideoData::Parser do
 
   end
 
-  describe ".videos" do
+  describe "#videos" do
     it 'should return an array of VideoData::Videos' do
       @parser.videos.should be_a Array
       @parser.videos[0].should be_a VideoData::Video

data/spec/video_data/video_spec.rb

@@ -7,7 +7,7 @@ describe VideoData::Video do
                    :eye_winged, :eye_effect, :eye_smokey]
   end
 
-  describe ".new" do
+  describe "::new" do
 
     it 'should need two parameters' do
       data = "tSP3Yqqk1Vg,12-Feb-11,Adele,,x,"
@@ -17,7 +17,7 @@ describe VideoData::Video do
 
   end
 
-  describe ".[]" do
+  describe "#[]" do
 
     it 'should return value using Array:Hash-type access' do
       data = "tSP3Yqqk1Vg,12-Feb-11,Adele,,x,"
@@ -51,7 +51,7 @@ describe VideoData::Video do
 
   end
 
-  describe ".tags" do
+  describe "#tags" do
 
     it "should return an array of active tags" do
       data = "tSP3Yqqk1Vg,12-Feb-11,Adele,,x,x"
@@ -65,7 +65,7 @@ describe VideoData::Video do
 
   end
 
-  describe ".to_s" do
+  describe "#to_s" do
 
     it 'should return a string with all the data of the video' do
       data = "tSP3Yqqk1Vg,12-Feb-11,Adele,x,x,x"
@@ -77,7 +77,7 @@ describe VideoData::Video do
 
   end
 
-  describe ".name" do
+  describe "#name" do
 
     it 'should return the name of the video' do
       data = "neYfvPKkXE,22-Aug-10,Alice Cullen,,,"
@@ -87,7 +87,7 @@ describe VideoData::Video do
 
   end
 
-  describe ".date" do
+  describe "#date" do
 
     it 'should return the date of the video' do
       data = "neYfvPKkXE,22-Aug-10,Alice Cullen,,,"
@@ -97,7 +97,7 @@ describe VideoData::Video do
 
   end
 
-  describe ".celebrity" do
+  describe "#celebrity" do
 
     it 'should return the celebrity of the video' do
       data = "neYfvPKkXE,22-Aug-10,Alice Cullen,,,"
@@ -107,4 +107,17 @@ describe VideoData::Video do
 
   end
 
+  describe "dynamic predicates for tags" do
+
+    it 'should have dynamic predicates for tags' do
+      data = "neYfvPKkXE,22-Aug-10,Alice Cullen,x,,"
+      video = VideoData::Video.new(@attributes, data)
+      video.eye_winged?.should raise_error
+      video.eye_winged?.should be_true
+      video.eye_smokey?.should be_false
+      video.eye_effect?.should be_false
+    end
+
+  end
+
 end

data/spec/video_data_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe VideoData do
 
-  describe ".new" do
+  describe "::new" do
 
     it "should return a VideoData::Parser" do
       path = File.dirname(__FILE__) + '/data/video_data.csv'

data/video_data.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "video_data"
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hector E. Gomez Morales"]
+  s.date = "2011-10-10"
+  s.description = "This gem is not for general consumption."
+  s.email = "hectoregm@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".autotest",
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.markdown",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/video_data.rb",
+    "lib/video_data/parser.rb",
+    "lib/video_data/video.rb",
+    "spec/data/bad_data.csv",
+    "spec/data/video_data",
+    "spec/data/video_data.csv",
+    "spec/spec_helper.rb",
+    "spec/video_data/parser_spec.rb",
+    "spec/video_data/video_spec.rb",
+    "spec/video_data_spec.rb",
+    "video_data.gemspec"
+  ]
+  s.homepage = "http://github.com/hectoregm/video_data"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Extract video information from specially formated csv files."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: video_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-09 00:00:00.000000000Z
+date: 2011-10-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70236167737440 !ruby/object:Gem::Requirement
+  requirement: &70243334665840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70236167737440
+  version_requirements: *70243334665840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70236167736340 !ruby/object:Gem::Requirement
+  requirement: &70243334664600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70236167736340
+  version_requirements: *70243334664600
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70236167734700 !ruby/object:Gem::Requirement
+  requirement: &70243334663140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70236167734700
+  version_requirements: *70243334663140
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70236167733560 !ruby/object:Gem::Requirement
+  requirement: &70243334661560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70236167733560
+  version_requirements: *70243334661560
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70236167732460 !ruby/object:Gem::Requirement
+  requirement: &70243334659920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70236167732460
+  version_requirements: *70243334659920
 description: This gem is not for general consumption.
 email: hectoregm@gmail.com
 executables: []
@@ -75,6 +75,7 @@ extra_rdoc_files:
 - README.markdown
 - README.rdoc
 files:
+- .autotest
 - .document
 - .rspec
 - Gemfile
@@ -87,11 +88,13 @@ files:
 - lib/video_data/parser.rb
 - lib/video_data/video.rb
 - spec/data/bad_data.csv
+- spec/data/video_data
 - spec/data/video_data.csv
 - spec/spec_helper.rb
 - spec/video_data/parser_spec.rb
 - spec/video_data/video_spec.rb
 - spec/video_data_spec.rb
+- video_data.gemspec
 homepage: http://github.com/hectoregm/video_data
 licenses:
 - MIT
@@ -107,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2143925689707778406
+      hash: 3094673234282739575
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: