gnome-wallpaper-slideshow 0.2

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/gnome-wallpaper-slideshow.rb

@@ -0,0 +1,173 @@
+require 'nokogiri'
+require 'pathname'
+
+# Represents an XML file defining a wallpaper slideshow in GNOME
+#
+# @author Andrew Johnson
+class GnomeWallpaperSlideshow
+  # Create a new GnomeWallpaperSlideshow
+  def initialize(&block)
+    instance_eval(&block) if block_given?
+  end
+
+  # Creates a new wallpaper slideshow
+  # @param [String] filename The path to the new file to create.
+  #   Defaults to slideshow.xml in the current working directory.
+  #   If the file already exists it will be overwritten
+  def create_new_slideshow(filename = "slideshow.xml")
+    @path = Pathname.new filename
+  end
+
+  # Loads an existing wallpaper slideshow
+  # @param [String] filename The path to the slideshow file
+  def load_slideshow(filename)
+    @path = Pathname.new filename
+    load_slideshow_xml
+
+    # Load the content from the XML doc
+    load_start_time
+    load_wallpapers
+  end
+
+  # Gets or sets the start time of the slideshow
+  # @param [Time] time The start time for the slideshow
+  # @return The current start time if one is not given
+  def start_time(time = nil)
+    return @start_time unless time
+
+    @start_time = time
+  end
+
+  # Gets or sets the path of the slideshow XML file
+  # @param [String] filename The path to the new location of the XML file
+  # @return The current path if one is not given
+  def path(filename = nil)
+    return @path unless filename
+
+    @path = Pathname.new filename
+  end
+
+  # Gets the list of wallpapers in this slideshow
+  # @return The list of wallpapers in the slideshow, or the empty list if none exist
+  def wallpapers
+    return @wallpapers = @wallpapers || []
+  end
+
+  # Adds a new wallpaper to the slideshow
+  # @param [GnomeWallpaperSlideshow::Wallpaper] wallpaper The wallpaper to add
+  def add_wallpaper(wallpaper)
+    wallpapers << wallpaper
+  end
+
+  # Removes a wallpaper from the slideshow
+  # @param [String] filename The filename of the wallpaper to remove
+  def remove_wallpaper(filename)
+    wallpapers.delete_if do |wallpaper|
+      wallpaper.filename == filename
+    end
+  end
+
+  # Generates and saves the slideshow XML to the current @path
+  def save_xml
+    return "" if start_time.nil? or wallpapers.none?
+    
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.background {
+        # The start time comes first
+        xml.starttime {
+          xml.year start_time.year
+          xml.month start_time.month
+          xml.day start_time.day
+          xml.hour start_time.hour
+          xml.minute start_time.min
+          xml.second start_time.sec
+        }
+        # Transitions are in pairs of wallpapers
+        wallpapers.each_cons(2) do |transition|
+          # The static tag defines a wallpaper and how long it is displayed
+          xml.static {
+            xml.duration transition.first.duration
+            xml.file transition.first.filename
+          }
+          # The transition tag defines how long the transition between this and the next takes
+          xml.transition {
+            xml.duration transition.first.transition_time
+            xml.from transition.first.filename
+            xml.to transition.last.filename
+          }
+        end
+        # Now insert the last wallpaper and the transition back to the beginning
+        xml.static {
+          xml.duration wallpapers.last.duration
+          xml.file wallpapers.last.filename
+        }
+        xml.transition {
+          xml.duration wallpapers.last.transition_time
+          xml.from wallpapers.last.filename
+          xml.to wallpapers.first.filename
+        }
+      }
+    end
+
+    write_xml builder.to_xml
+  end
+
+  private
+
+  # Writes an XML string to a file
+  # @param [String] xml_string The XML to write out
+  def write_xml(xml_string)
+    File.open(self.path, "w") do |slideshow_file|
+      slideshow_file.write xml_string
+    end
+  end
+
+  # Loads a wallpaper slideshow XML file
+  def load_slideshow_xml
+    File.open(self.path, "r") do |slideshow_file|
+      # We want strict parsing to ensure we are given a valid XML file
+      @xml_doc = Nokogiri::XML(slideshow_file) do |config|
+        config.strict
+      end
+    end
+  end
+
+  # Loads the start time from the XML file
+  def load_start_time
+    year = starttime_xpath_query "year"
+    month = starttime_xpath_query "month"
+    day = starttime_xpath_query "day"
+    hour = starttime_xpath_query "hour"
+    minute = starttime_xpath_query "minute"
+    second = starttime_xpath_query "second"
+
+    start_time Time.local year, month, day, hour, minute, second
+  end
+
+  # Load the wallpapers and transitions from the XML file
+  def load_wallpapers
+    files = wallpaper_xpath_query "//static/file"
+    durations = wallpaper_xpath_query "//static/duration"
+    transitions = wallpaper_xpath_query "//transition/duration"
+
+    @wallpapers = files.zip(durations,transitions).map do |file, duration, transition|
+      GnomeWallpaperSlideshow::Wallpaper.new file, duration, transition
+    end
+  end
+
+  # Performs an XPath query for wallpapers
+  # @param [String] query The XPath query to perform
+  def wallpaper_xpath_query(query)
+    @xml_doc.xpath(query).children.map do |child|
+      child.content
+    end
+  end
+
+  # Performs an XPath query for an element of the starttime
+  # @param [String] field The starttime field to extract
+  def starttime_xpath_query(field)
+    @xml_doc.at_xpath("//starttime/#{field}").children.first.content
+  end
+end
+
+require 'gnome-wallpaper-slideshow/wallpaper'

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

@@ -0,0 +1,15 @@
+# Represents a wallpaper entry in a slideshow
+class GnomeWallpaperSlideshow::Wallpaper
+  attr_accessor :filename, :duration, :transition_time
+  
+  # Create a new wallpaper
+  # @param [String] filename The path to the image file
+  # @param [Float] duration The length of time this wallpaper will be displayed in seconds
+  # @param [Float] transition_time The amount of time spent transitioning
+  #   to the next wallpaper in seconds
+  def initialize(filename, duration = 1795.0, transition_time = 5.0)
+    @filename = filename
+    @duration = duration
+    @transition_time = transition_time
+  end
+end

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

@@ -0,0 +1,58 @@
+require 'test/unit'
+require 'gnome-wallpaper-slideshow'
+
+class GnomeWallpaperSlideshowTest < Test::Unit::TestCase
+  def test_create_new_slideshow
+    slideshow = GnomeWallpaperSlideshow.new do
+      create_new_slideshow "xml_slideshow.xml"
+    end
+
+    path = Pathname.new "xml_slideshow.xml"
+    assert_equal path, slideshow.path
+  end
+
+  def test_create_new_slideshow_default_arg
+    slideshow = GnomeWallpaperSlideshow.new do
+      create_new_slideshow
+    end
+
+    path = Pathname.new "slideshow.xml"
+    assert_equal path, slideshow.path
+  end
+
+  def test_start_time
+    slideshow = GnomeWallpaperSlideshow.new
+
+    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
+  end
+
+  def test_path
+    slideshow = GnomeWallpaperSlideshow.new
+
+    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
+  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
+
+    assert_equal [], slideshow.wallpapers # Test handling of no wallpapers
+
+    # Test adding wallpapers
+    slideshow.add_wallpaper wallpaper_one
+    slideshow.add_wallpaper wallpaper_two
+
+    assert_equal [wallpaper_one, wallpaper_two], slideshow.wallpapers
+
+    # Test removing wallpapers
+    slideshow.remove_wallpaper wallpaper_one.filename
+
+    assert_equal [wallpaper_two], slideshow.wallpapers
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: gnome-wallpaper-slideshow
+version: !ruby/object:Gem::Version
+  version: '0.2'
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+description: A gem for creating and interacting with the XML files that define wallpaper
+  slideshows in GNOME
+email: andrew@andrewjamesjohnson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gnome-wallpaper-slideshow.rb
+- lib/gnome-wallpaper-slideshow/wallpaper.rb
+- Rakefile
+- test/test-gnome-wallpaper-slideshow.rb
+homepage: https://github.com/ajsquared/gnome-wallpaper-slideshow
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gnome Wallpaper Slideshow
+test_files:
+- test/test-gnome-wallpaper-slideshow.rb
+has_rdoc: