itunes_video 0.2.2 → 0.3.0

data/lib/itunes_video.rb

@@ -1,3 +1,6 @@
+##
+# The entire gem is contained in the Itunes_video class. 
+
 class Itunes_video
 
   require 'pathname'
@@ -5,6 +8,10 @@ class Itunes_video
 
   attr_accessor :id, :kind, :category, :name, :genre, :year, :description, :long_description, :comment, :unplayed, :played_count, :rating, :season_num, :episode_num, :show_name
   
+  ##
+  # The initialize method imports the video into iTunes and returns an iTunes
+  # track ID, which is used to identify the video for the other methods. 
+  
   def initialize(file)
     if !(Pathname.new file).absolute?
       if File.exist?(File.join(FileUtils.pwd, file))
@@ -20,6 +27,10 @@ class Itunes_video
       @id = import.split(" ")[3]
     end
   end
+  
+  ##
+  # Set the 'kind' for the video. 
+  # Must be one of ["tv show", "movie", "music video", "none"]
 
   def kind=(kind)
     kinds = ["tv show", "movie", "music video", "none"]
@@ -33,6 +44,9 @@ class Itunes_video
       end
     end
   end
+  
+  ##
+  # Set the 'category' for the video. 
 
   def category=(category)
     if `osascript -e 'tell application \"iTunes\" to set category of file track id #{@id} to \"#{category}\"'`
@@ -42,7 +56,11 @@ class Itunes_video
     end
   end
 
-  # sets episode name for tv show or movie title for movie
+  ##
+  # Set the 'name' for the video. 
+  # Sets episode name for a video of kind 'tv show' 
+  # Sets movie title for a video of kind 'movie'
+  
   def name=(name)
     if `osascript -e 'tell application \"iTunes\" to set name of file track id #{@id} to \"#{name}\"'` 
       @name = name
@@ -50,6 +68,9 @@ class Itunes_video
       raise "could not set 'name' for video"
     end
   end
+  
+  ##
+  # Set the 'genre' for the video. 
 
   def genre=(genre)
     if `osascript -e 'tell application \"iTunes\" to set genre of file track id #{@id} to \"#{genre}\"'` 
@@ -58,6 +79,10 @@ class Itunes_video
       raise "could not set 'genre' for video"
     end
   end
+  
+  ##
+  # Set the 'year' for the video. 
+  # Must be a four digit number or a string with four numbers. 
 
   def year=(year)
     year = year.to_s
@@ -69,6 +94,9 @@ class Itunes_video
       raise "could not set 'year' for video"
     end
   end
+  
+  ##
+  # Set the 'description' for the video. 
 
   def description=(desc)
     if `osascript -e 'tell application \"iTunes\" to set description of file track id #{@id} to \"#{desc}\"'` 
@@ -78,6 +106,9 @@ class Itunes_video
     end
   end
   
+  ##
+  # Set the 'long description' for the video. 
+  
   def long_description=(long_desc)
     if `osascript -e 'tell application \"iTunes\" to set long description of file track id #{@id} to \"#{long_desc}\"'` 
       @long_description = long_desc
@@ -85,6 +116,9 @@ class Itunes_video
       raise "could not set 'long description' for video"
     end
   end
+  
+  ##
+  # Set the 'comment' for the video. 
 
   def comment=(comment)
     if `osascript -e 'tell application \"iTunes\" to set comment of file track id #{@id} to \"#{comment}\"'` 
@@ -94,9 +128,12 @@ class Itunes_video
     end  
   end
 
+  ##
+  # Set 'uplayed' for the video. 
+  # Must be either 'true' or 'false'
+
   def unplayed=(unplayed)
-    unplayed = unplayed.downcase
-    if !["true", "false"].include? unplayed
+    if ![true, false].include? unplayed
       raise TypeError, "unplayed must be 'true' or 'false'"
     elsif  `osascript -e 'tell application \"iTunes\" to set unplayed of file track id #{@id} to \"#{unplayed}\"'` 
       @unplayed = unplayed
@@ -104,6 +141,9 @@ class Itunes_video
       raise "could not set 'unplayed' for video"
     end
   end
+  
+  ##
+  # Set the 'played count' for the video. 
 
   def played_count=(played_count)
     if `osascript -e 'tell application \"iTunes\" to set played count of file track id #{@id} to #{played_count.to_i}'`
@@ -112,6 +152,10 @@ class Itunes_video
       raise "could not set 'played count' for video"
     end
   end
+  
+  ##
+  # Set the 'rating' for the video. 
+  # Must be a number between 0 and 100.
 
   def rating=(rating)
     if !rating.to_i.between?(0,100)
@@ -122,8 +166,12 @@ class Itunes_video
       raise "could not set 'rating' for video"
     end
   end
-
-  # tv show specific methods
+  
+  # :section: tv show-specific methods
+  
+  ##
+  # Set the 'season number' for a video of type 'tv show'. 
+  
   def season_num=(season_num)
     if `osascript -e 'tell application \"iTunes\" to set season number of file track id #{@id} to #{season_num.to_i}'`
       @season_num = season_num
@@ -132,6 +180,9 @@ class Itunes_video
     end
   end
 
+  ##
+  # Set the 'episode number' for a video of type 'tv show'. 
+  
   def episode_num=(episode_num)
     if `osascript -e 'tell application \"iTunes\" to set episode number of file track id #{@id} to \"#{episode_num.to_i}\"'`
       @episode_num = episode_num
@@ -140,6 +191,9 @@ class Itunes_video
     end
   end
 
+  ##
+  # Set the 'show name' for a video of type 'tv show'. 
+  
   def show_name=(show_name)
     if `osascript -e 'tell application \"iTunes\" to set show of file track id #{@id} to \"#{show_name}\"'` 
       @show_name = show_name

metadata

@@ -1,46 +1,55 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: itunes_video
-version: !ruby/object:Gem::Version
-  version: 0.2.2
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.3.0
 platform: ruby
-authors:
+authors: 
 - Richard Myers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-18 00:00:00.000000000 Z
+
+date: 2013-08-02 00:00:00 Z
 dependencies: []
+
 description: A gem to import and organize your video collection in iTunes. OS X only.
 email: rick.myers@me.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/itunes_video.rb
 homepage: https://rubygems.org/gems/itunes_video
-licenses:
+licenses: 
 - WTFPL
 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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Import and organize videos in iTunes
 test_files: []
+
+has_rdoc: