gnome-wallpaper-slideshow 0.3 → 0.4

data/Rakefile

@@ -1,7 +1,9 @@
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
+  t.libs.push "lib"
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
 end
 
 desc "Run tests"

data/bin/create-slideshow

@@ -3,6 +3,7 @@
 
 require 'gnome-wallpaper-slideshow'
 require 'gnome-wallpaper-slideshow/wallpaper'
+require 'optparse'
 
 DEFAULT_EXTENSIONS = "jpg,png,jpeg"
 
@@ -13,23 +14,75 @@ def get_absolute_path(file)
   File.expand_path file
 end
 
+# Parse command-line options
+options = {}
 
-if ARGV.length < 3
-  puts "You must specify four arguments: the image directory, the time to display each image in seconds, the transition time in seconds, and the output filename."
-  puts "You may optionally specify a fifth argument: the list of file extensions to include.  If omitted, it will default to #{DEFAULT_EXTENSIONS}"
-  exit 1
+optparse = OptionParser.new do |opts|
+  opts.on('-d', '--dir DIRECTORY', 'directory containing image files') do |sender|
+    options[:dir] = sender
+  end
+
+  opts.on('-t', '--time DURATION', 'amount of time to display each wallpaper in seconds') do |sender|
+    options[:duration] = sender
+  end
+
+  opts.on('-r', '--transition DURATION', 'transition time between wallpapers in seconds') do |sender|
+    options[:transition] = sender
+  end
+
+  opts.on('-f', '--filename FILENAME', 'output filename') do |sender|
+    options[:file] = sender
+  end
+
+  opts.on('-e', '--extensions EXTENSIONS', "comma-separated list of file extensions, defaults to #{DEFAULT_EXTENSIONS}") do |sender|
+    options[:ext] = sender
+  end
+
+  opts.on('-s', '--shuffle', 'Randomly shuffle the order of the wallpapers') do |sender|
+    options[:shuffle] = sender
+  end
+
+  opts.on_tail('-h', '--help', 'Show this message') do
+    puts opts
+    exit
+  end
+end
+
+# Ensure mandatory arguments are present
+begin
+  optparse.parse!
+  mandatory = [:dir, :duration, :transition, :file]
+
+  missing = mandatory.select do |param|
+    options[param].nil?
+  end
+
+  if not missing.empty?
+    puts "Missing options: #{missing.join(', ')}"
+    puts optparse
+    exit
+  end
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument
+  puts $!.to_s
+  puts optparse
+  exit
 end
 
-image_directory = get_absolute_path(ARGV[0])
-time = ARGV[1]
-transition_time = ARGV[2]
-output_filename = ARGV[3]
-extensions = ARGV[4] || DEFAULT_EXTENSIONS
+image_directory = options[:dir]
+time = options[:duration]
+transition_time = options[:transition]
+output_filename = options[:file]
+extensions = options[:ext] || DEFAULT_EXTENSIONS
 
 wallpapers = Dir.glob("#{image_directory}/*.{#{extensions}}").map do |file|
   GnomeWallpaperSlideshow::Wallpaper.new get_absolute_path(file), time, transition_time
 end
 
+# Randomly shuffle the wallpapers if requested
+if options[:shuffle]
+  wallpapers.shuffle!
+end
+
 slideshow = GnomeWallpaperSlideshow.new do
   create_new_slideshow output_filename
   start_time Time.now

data/lib/gnome-wallpaper-slideshow/wallpaper.rb

@@ -12,4 +12,8 @@ class GnomeWallpaperSlideshow::Wallpaper
     @duration = duration
     @transition_time = transition_time
   end
+
+  def ==(other)
+      (self.filename == other.filename) && (self.duration == other.duration) && (self.transition_time == other.transition_time)
+  end
 end

data/test/test-gnome-wallpaper-slideshow.rb

@@ -1,58 +1,146 @@
-require 'test/unit'
+require 'minitest/spec'
+require 'minitest/autorun'
 require 'gnome-wallpaper-slideshow'
 
-class GnomeWallpaperSlideshowTest < Test::Unit::TestCase
-  def test_create_new_slideshow
-    slideshow = GnomeWallpaperSlideshow.new do
+describe GnomeWallpaperSlideshow do
+  before do
+    @slideshow_default = GnomeWallpaperSlideshow.new do
+      create_new_slideshow
+    end
+
+    @slideshow = GnomeWallpaperSlideshow.new do
       create_new_slideshow "xml_slideshow.xml"
+      start_time Time.local 2009,8,4,0,0,0
+      add_wallpaper (GnomeWallpaperSlideshow::Wallpaper.new "test.jpg", 100, 5)
+      add_wallpaper (GnomeWallpaperSlideshow::Wallpaper.new "other.jpg", 500, 3)
     end
 
-    path = Pathname.new "xml_slideshow.xml"
-    assert_equal path, slideshow.path
-  end
+    @slideshow_existing = GnomeWallpaperSlideshow.new
 
-  def test_create_new_slideshow_default_arg
-    slideshow = GnomeWallpaperSlideshow.new do
-      create_new_slideshow
+    # Mock out some methods to avoid reading/writing to disk
+    def @slideshow.write_xml(xml_string)
+      xml_string
+    end
+    
+    def @slideshow_existing.load_slideshow_xml
+      @xml_doc = Nokogiri::XML("<?xml version=\"1.0\"?>
+<background>
+  <starttime>
+    <year>2013</year>
+    <month>1</month>
+    <day>1</day>
+    <hour>00</hour>
+    <minute>00</minute>
+    <second>00</second>
+  </starttime>
+  <static>
+    <duration>100</duration>
+    <file>test.jpg</file>
+  </static>
+  <transition>
+    <duration>5</duration>
+    <from>test.jpg</from>
+    <to>other.jpg</to>
+  </transition>
+  <static>
+    <duration>500</duration>
+    <file>other.jpg</file>
+  </static>
+  <transition>
+    <duration>3</duration>
+    <from>other.jpg</from>
+    <to>test.jpg</to>
+  </transition>
+</background>
+") do |config|
+        config.strict
+      end
     end
 
-    path = Pathname.new "slideshow.xml"
-    assert_equal path, slideshow.path
+    @slideshow_existing.load_slideshow "real_slideshow.xml"
   end
+  
 
-  def test_start_time
-    slideshow = GnomeWallpaperSlideshow.new
+  it "can be created with the default output file" do
+    @slideshow_default.path.must_equal (Pathname.new "slideshow.xml")
+  end
 
-    time = Time.local 2009,8,4,0,0,0
-    
-    assert_equal time, slideshow.start_time(time) # Test setting the time
-    assert_equal time, slideshow.start_time # Test getting the time
+  it "can be created with a specific output file" do
+    @slideshow.path.must_equal (Pathname.new "xml_slideshow.xml")
   end
 
-  def test_path
-    slideshow = GnomeWallpaperSlideshow.new
+  it "can have its output path set" do
+    path = Pathname.new "new_slideshow.xml"
+    @slideshow_default.path path
+    @slideshow_default.path.must_equal path
+  end
 
-    path = Pathname.new "xml_slideshow.xml"
-    assert_equal path, slideshow.path(path) # Test setting the path
-    assert_equal path, slideshow.path # Test getting the path
+  it "can have its start time set" do
+    time = Time.local 2007,5,3,1,0,0
+    @slideshow_default.start_time time
+    @slideshow_default.start_time.must_equal time
+  end
+  
+  it "can be created with a start time" do
+    @slideshow.start_time.must_equal (Time.local 2009,8,4,0,0,0)
   end
 
-  def test_wallpapers
-    slideshow = GnomeWallpaperSlideshow.new
-    wallpaper_one  = GnomeWallpaperSlideshow::Wallpaper.new "test.jpg", 100, 5
-    wallpaper_two  = GnomeWallpaperSlideshow::Wallpaper.new "other.jpg", 500, 3
+  it "can be created with wallpapers" do
+    @slideshow.wallpapers.size.must_equal 2
+    @slideshow.wallpapers.must_equal [(GnomeWallpaperSlideshow::Wallpaper.new "test.jpg", 100, 5), (GnomeWallpaperSlideshow::Wallpaper.new "other.jpg", 500, 3)]
+  end
 
-    assert_equal [], slideshow.wallpapers # Test handling of no wallpapers
+  it "can be created without wallpapers" do
+    @slideshow_default.wallpapers.must_be_empty
+  end
 
-    # Test adding wallpapers
-    slideshow.add_wallpaper wallpaper_one
-    slideshow.add_wallpaper wallpaper_two
+  it "can have wallpapers added" do
+    wallpaper = GnomeWallpaperSlideshow::Wallpaper.new "test.jpg", 100, 5
+    @slideshow_default.add_wallpaper wallpaper
+    @slideshow_default.wallpapers.must_equal [(GnomeWallpaperSlideshow::Wallpaper.new "test.jpg", 100, 5)]
+  end
 
-    assert_equal [wallpaper_one, wallpaper_two], slideshow.wallpapers
+  it "can have wallpapers removed" do
+    @slideshow.remove_wallpaper "test.jpg"
+    @slideshow.wallpapers.must_equal [(GnomeWallpaperSlideshow::Wallpaper.new "other.jpg", 500, 3)]
+  end
 
-    # Test removing wallpapers
-    slideshow.remove_wallpaper wallpaper_one.filename
+  it "can load an existing slideshow file" do
+    @slideshow_existing.path.must_equal (Pathname.new "real_slideshow.xml")
+    @slideshow_existing.start_time.must_equal (Time.local 2013,1,1,0,0,0)
+    @slideshow_existing.wallpapers.must_equal [(GnomeWallpaperSlideshow::Wallpaper.new "test.jpg", "100", "5"), (GnomeWallpaperSlideshow::Wallpaper.new "other.jpg", "500", "3")]
+  end
 
-    assert_equal [wallpaper_two], slideshow.wallpapers
+  it "can write out an xml file" do
+    @slideshow.save_xml.must_equal "<?xml version=\"1.0\"?>
+<background>
+  <starttime>
+    <year>2009</year>
+    <month>8</month>
+    <day>4</day>
+    <hour>0</hour>
+    <minute>0</minute>
+    <second>0</second>
+  </starttime>
+  <static>
+    <duration>100</duration>
+    <file>test.jpg</file>
+  </static>
+  <transition>
+    <duration>5</duration>
+    <from>test.jpg</from>
+    <to>other.jpg</to>
+  </transition>
+  <static>
+    <duration>500</duration>
+    <file>other.jpg</file>
+  </static>
+  <transition>
+    <duration>3</duration>
+    <from>other.jpg</from>
+    <to>test.jpg</to>
+  </transition>
+</background>
+"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnome-wallpaper-slideshow
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-13 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri