revolt 0.8.5 → 0.8.6

data/README

@@ -214,3 +214,33 @@ can be matched or error is produced.
 For more information and options:
 
   rv_rename_level.rb -h
+
+=== rv_add_favorite.rb
+Adds levels as favorites that are given as command line parameters.
+The favorite levels are stored in a regular ascii file
+(default is rv_levels.fav). The favorites file is meant to
+be used in conjuction with rv_remove_extra_levels.rb script,
+so that Re-Volt's track number limit is not exceeded. When
+using favorites file only tracks that are not favorites will
+be given as candidates to remove.
+
+Match options format is similar as rv_find_levels.rb
+
+For more information and options:
+
+  rv_add_favorite.rb -h
+
+=== rv_remove_extra_levels.rb
+Removes levels so that Re-Volt's limit for levels is not exceeded
+(which would cause some of the installed levels to be unplayable).
+The proposed levels for removal are given starting from the oldest
+installed level. The time is taken from the level folders modification
+time.
+
+A favorites file can be used so that those levels specified in the
+favorites file are not given as candidates to delete.
+
+For more information and options:
+
+  rv_remove_extra_levels.rb -h
+  

data/Rakefile

@@ -145,6 +145,7 @@ task "rubyforge-login" => ["rubyforge-setup"] do
   sh "rubyforge login", :verbose => true
 end
 
+desc "Uploads the built packages to RubyForge"
 task "publish-packages" => ["package", "rubyforge-login"] do
   # Upload packages under pkg/ to RubyForge
   # This task makes some assumptions:

data/bin/rv_add_favorite.rb

@@ -0,0 +1,135 @@
+#!/usr/bin/ruby
+require 'optparse'
+require 'pp'
+require 'revolt'
+require 'set'
+
+$FAVORITE_FILE = "rv_levels.fav"
+
+def main
+  cmd = CmdArguments.new(ARGV)
+  ReVolt::Logger.enable if cmd[:debug]
+  levels = ReVolt::Levels.at(cmd[:base])
+  add_levs = []
+
+  levels.each_level do |level|
+    all_matches  = {}
+    nmatches = ReVolt::Util::Matcher.multi(level, cmd[:match], all_matches)
+    if nmatches > 0
+      keyvaluestr = all_matches.map{|(k,v)|"#{k}=#{v}"}.join(', ')
+      add_levs << level
+      puts "%s [%s]" % [level.inspect, keyvaluestr]
+    end
+  end
+  
+  if add_levs.size > 0
+    unless cmd[:force]
+      puts ""
+      print "Add these levels to favorites in file %s? (y/N) " % [cmd[:file]]
+      answer = STDIN.gets.chomp
+      if answer.downcase != 'y'
+        puts "Levels not added to favorites"
+        exit(0)
+      end
+    end
+    
+    favorites = ReVolt::Util::Favorites.new(cmd[:file])
+    
+    add_levs.each do |l, match|
+      level_id = l.id.to_s
+      if favorites.add?(l.id.to_s)
+        puts "Added to favorites %s (%s)" % [l.name, level_id]
+      else        
+        puts "Already exists in favorites, skipping %s (%s)" % [l.name, level_id]
+      end
+    end
+
+    favorites.commit
+  else
+    puts "No matching levels"
+  end
+end
+
+class CmdArguments < Hash
+  include ReVolt::Util::CommonCmdArgs
+  
+  def initialize(cmd)
+    super()
+    
+    self[:all]  = false
+    self[:default_match_with] = :name
+    self[:file] = $FAVORITE_FILE
+      
+    matchstrs   = []
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #$0 [options] [name_match ...]\n"
+      opts.separator ""
+      opts.separator "Adds levels as favorites. The favorites are stored in a file"
+      opts.separator "in current directory unless otherwise specified."
+      opts.separator ""
+      opts.separator "Examples:"
+      opts.separator "  Adds levels to favorites whose name includes temple:"
+      opts.separator "  #$0 temple"  
+
+      opts.separator ""
+      match_help(opts)
+      opts.separator ""
+      
+      opts.separator "Options:"  
+
+      on_match(opts) do |value|
+        matchstrs << value
+      end
+      on_default_match_modifier(opts)
+
+      opts.on('-d', '--debug',
+              'Outputs debug information') do
+        self[:debug] = true
+      end
+
+      opts.on('-f', '--file',
+               'The path to the file containing the favorite levels') do |value|
+         self[:file] = value
+      end
+             
+      on_base_path(opts) do |value|
+        self[:base] = value
+      end
+      
+      opts.on_tail('-h', '--help',
+                   'Display full help and exit') do
+        puts opts
+        
+        exit(0)
+      end
+    end
+  
+    opts.parse!(cmd)
+
+    name_or_id_matches(cmd) do |m|
+      matchstrs << m
+    end
+
+    if matchstrs.size == 0
+      puts "Error: no matches specified\n" 
+      STDERR.puts opts.banner
+      exit 1
+    end
+
+    begin
+      # Create the matcher objects
+      self[:match] = []
+      for m in matchstrs
+        self[:match] << ReVolt::Util::Matcher.parse(m)
+      end
+    rescue ReVolt::Util::Matcher::ParseError => e
+      STDERR.puts e.errstr
+      exit(1)
+    end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
+  end
+end
+
+
+main

data/bin/rv_delete_levels.rb

@@ -46,7 +46,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()
     
-    self[:base]  = ReVolt::Info::path
     self[:force] = false
     self[:default_match_with] = :name
     
@@ -117,6 +116,8 @@ class CmdArguments < Hash
       STDERR.puts e.errstr
       exit(1)
     end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/bin/rv_find_levels.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/ruby
-#
 require 'optparse'
 require 'pp'
 require 'revolt'
@@ -26,7 +25,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()
     
-    self[:base] = ReVolt::Info::path
     self[:default_match_with] = :name
     
     matchstrs   = []
@@ -105,6 +103,8 @@ class CmdArguments < Hash
       STDERR.puts e.errstr
       exit(1)
     end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/bin/rv_info_levels.rb

@@ -45,7 +45,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()
     
-    self[:base] = ReVolt::Info::path
     self[:all]  = false
     self[:default_match_with] = :name
     
@@ -114,6 +113,8 @@ class CmdArguments < Hash
       STDERR.puts e.errstr
       exit(1)
     end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/bin/rv_install_level_urls.rb

@@ -158,7 +158,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()    
     inf_matches = []
-    self[:base] = ReVolt::Info::path
     
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: #$0 [options]\n"
@@ -193,6 +192,8 @@ class CmdArguments < Hash
     end
   
     opts.parse!(cmd)
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/bin/rv_install_levels.rb

@@ -38,7 +38,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()    
     inf_matches = []
-    self[:base] = ReVolt::Info::path
     
     opts = OptionParser.new do |opts|
       opts.banner = "Usage: #$0 [options] package1 [package2 ...]\n"
@@ -68,6 +67,8 @@ class CmdArguments < Hash
       puts opts
       exit(1)
     end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/bin/rv_package_levels.rb

@@ -49,7 +49,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()
     
-    self[:base]  = ReVolt::Info::path
     self[:force] = false
     self[:default_match_with] = :name
     
@@ -123,6 +122,8 @@ class CmdArguments < Hash
       STDERR.puts e.errstr
       exit(1)
     end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/bin/rv_remove_extra_levels.rb

@@ -0,0 +1,168 @@
+#!/usr/bin/ruby
+require 'optparse'
+require 'pp'
+require 'revolt'
+require 'set'
+
+$FAVORITE_FILE = "rv_levels.fav"
+$RV_LEVELS_LIMIT = 255
+
+def main
+  cmd = CmdArguments.new(ARGV)
+  ReVolt::Logger.enable if cmd[:debug]
+  levels = ReVolt::Levels.at(cmd[:base])
+
+  filtered_levels = filter_levels_with_matcher(levels.to_a, cmd[:match])
+
+  levels_to_remove = levels.size - cmd[:limit]
+  if levels_to_remove <= 0
+    puts "Number of installed levels (%d) does not exceed Re-Volt's limit (%d)" % [levels.size, cmd[:limit]]
+    exit(0)    
+  end
+  
+  favorites = ReVolt::Util::Favorites.new(cmd[:file])
+  sorted_levels = sort_levels_by_date(filtered_levels)
+  remove_levs = []
+  sorted_levels.each do |level|
+    if level.custom? && !favorites.include?(level.id) && remove_levs.size < levels_to_remove
+      puts "%s (modified %s)" % [level.inspect, level.path.mtime.localtime.asctime  ]
+      remove_levs << level
+    end
+  end
+  
+  if remove_levs.size > 0
+    unless cmd[:force]
+      puts ""
+      print "Delete these levels? (y/N) "
+      answer = STDIN.gets.chomp
+      if answer.downcase != 'y'
+        puts "Deleting not done"
+        exit(0)
+      end
+    end
+    remove_levs.each do |l, match|
+      puts "Deleting %s (%s)" % [l.name, l.id.to_s]
+      l.delete
+    end
+  else
+    puts "No levels that could be removed"
+  end  
+end
+
+def sort_levels_by_date(levels)
+  levels.sort do |a,b|
+    a.path.mtime <=> b.path.mtime
+  end
+end
+
+def filter_levels_with_matcher(levels, matchers)
+  return levels if matchers.empty?
+
+  filtered_levels = []    
+  levels.each do |level|
+    all_matches  = {}
+    nmatches = ReVolt::Util::Matcher.multi(level, matchers, all_matches)
+    if nmatches > 0
+      keyvaluestr = all_matches.map{|(k,v)|"#{k}=#{v}"}.join(', ')
+      filtered_levels << level
+    end
+  end
+  filtered_levels
+end
+
+def read_favorites(filepath)
+  file = Pathname.new(filepath)
+  
+end
+
+class CmdArguments < Hash
+  include ReVolt::Util::CommonCmdArgs
+  
+  def initialize(cmd)
+    super()
+    
+    self[:all]  = false
+    self[:default_match_with] = :name
+    self[:file] = $FAVORITE_FILE
+    self[:limit] = $RV_LEVELS_LIMIT
+          
+    matchstrs   = []
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #$0 [options] [name_match ...]\n"
+      opts.separator ""
+      opts.separator "Removes levels in somewhat smart way so that there's not too many"
+      opts.separator "levels for Re-Volt to handle. Re-Volt has a limit of 256 installed tracks."
+      opts.separator "By default tries to use a file with favorite list of levels that should never"
+      opts.separator "be removed. Stock tracks are never removed, only custom tracks."
+      opts.separator ""
+      opts.separator "Without arguments levels are removed so that the limit Re-Volt can handle"
+      opts.separator "is not exceeded. If favorites exist they are never removed, otherwise"
+      opts.separator "the oldest levels by their installation directory timestamp are removed"
+      opts.separator ""
+      opts.separator "Examples:"
+      opts.separator "  Removes (non-favorite) levels so that max #{$RV_LEVELS_LIMIT} are installed:"
+      opts.separator "  #$0"  
+      opts.separator "  Removes (non-favorite) levels whose name contains temple that exceed the limit"
+      opts.separator "  #$0 temple"  
+
+      opts.separator ""
+      match_help(opts)
+      opts.separator ""
+      
+      opts.separator "Options:"  
+
+      on_match(opts) do |value|
+        matchstrs << value
+      end
+      on_default_match_modifier(opts)
+
+      opts.on('-d', '--debug',
+              'Outputs debug information') do
+        self[:debug] = true
+      end
+ 
+      opts.on('-f', '--file',
+               'The path to the file containing the favorite levels') do |value|
+         self[:file] = value
+      end
+
+      opts.on('-l', '--limit LIMIT', Integer,
+               "Sets the limit of levels Re-Volt can handle (default is #{$RV_LEVELS_LIMIT})") do |value|
+         self[:limit] = value
+      end
+
+      on_base_path(opts) do |value|
+        self[:base] = value
+      end
+      
+      opts.on_tail('-h', '--help',
+                   'Display full help and exit') do
+        puts opts
+        
+        exit(0)
+      end
+    end
+  
+    opts.parse!(cmd)
+
+    name_or_id_matches(cmd) do |m|
+      matchstrs << m
+    end
+
+    begin
+      # Create the matcher objects
+      self[:match] = []
+      for m in matchstrs
+        self[:match] << ReVolt::Util::Matcher.parse(m)
+      end
+    rescue ReVolt::Util::Matcher::ParseError => e
+      STDERR.puts e.errstr
+      exit(1)
+    end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
+  end
+end
+
+
+main

data/bin/rv_rename_level.rb

@@ -55,7 +55,6 @@ class CmdArguments < Hash
   def initialize(cmd)
     super()
     
-    self[:base]  = ReVolt::Info::path
     self[:force] = false
     
     matchstrs   = []
@@ -132,6 +131,8 @@ class CmdArguments < Hash
       STDERR.puts e.errstr
       exit(1)
     end
+    
+    self[:base] = ReVolt::Info::path if !self[:base]    
   end
 end
 

data/lib/revolt.rb

@@ -7,8 +7,9 @@ require 'revolt/util'
 require 'revolt/util/fs_browser'
 require 'revolt/util/common_cmd_args'
 require 'revolt/util/matcher'
+require 'revolt/util/favorites'
 require 'revolt/args'
 
 module ReVolt
-  VERSION = '0.8.5'
+  VERSION = '0.8.6'
 end

data/lib/revolt/util/favorites.rb

@@ -0,0 +1,74 @@
+require 'revolt/logger'
+
+#module ReVolt; module Util; end; end
+
+module ReVolt::Util
+  # Can be used to maintain favorites file list. Usually not used
+  # directly, but by the utility programs 
+  class Favorites
+    attr :filepath
+  
+    # Initializes the favorites from given file.
+    # If the file exists the contents are read.
+    def initialize(filepath)
+      @filepath = Pathname.new(filepath)
+      @level_ids = []
+      @level_ids_set = Set.new
+      @level_ids_new = []
+      read_favorites if @filepath.exist?
+    end
+    
+    # Returns true if the given level is included
+    # in favorites. Also level id is allowed.
+    def include?(level_or_id)
+      level_id = ReVolt::Level.to_level_id(level_or_id)
+      return @level_ids_set.include?(level_id)
+    end
+    
+    # Adds the given level (or level id) to favorites.
+    # If the level already was in favorites returns 
+    # nil. Otherwise returns the level_id.
+    def add?(level_or_id)
+      level_id = ReVolt::Level.to_level_id(level_or_id)    
+      if @level_ids_set.add?(level_id)
+        @level_ids << level_id
+        @level_ids_new << level_id
+        return level_id
+      end
+      nil
+    end
+    
+    # Commits the changes done to the favorites file.
+    # If no changes have been done, does nothing. If
+    # new levels have been added, those are added to
+    # the favorites file.
+    def commit()
+      commits = 0
+  
+      return 0 if @level_ids_new.size <= 0
+  
+      open(@filepath, 'a') do |file|
+        @level_ids_new.each do |level_id|
+          file.puts        
+          file.print(level_id)
+          commits += 1
+        end    
+      end
+      commits
+    end
+    
+    private
+    def read_favorites()
+      open(@filepath) do |file|
+        file.each do |line|
+          level_id = line.chomp
+          if (!level_id.empty?)
+            level_id = ReVolt::Level.to_level_id(level_id)
+            @level_ids << level_id
+            @level_ids_set.add(level_id)
+          end
+        end
+      end
+    end  
+  end # class Favorites
+end # module

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: revolt
 version: !ruby/object:Gem::Version 
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors: 
 - Arto Jalkanen
@@ -9,14 +9,16 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-30 00:00:00 +03:00
+date: 2008-11-21 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
 description: 
 email: ajalkane@gmail.com
 executables: 
+- rv_remove_extra_levels.rb
 - rv_install_levels.rb
+- rv_add_favorite.rb
 - rv_info_levels.rb
 - rv_package_levels.rb
 - rv_install_level_urls.rb
@@ -28,7 +30,9 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
+- bin/rv_remove_extra_levels.rb
 - bin/rv_install_levels.rb
+- bin/rv_add_favorite.rb
 - bin/rv_info_levels.rb
 - bin/rv_package_levels.rb
 - bin/rv_install_level_urls.rb
@@ -50,6 +54,7 @@ files:
 - test/tc_level_package.rb
 - test/tc_level_installer.rb
 - lib/revolt.rb
+- lib/revolt/util/favorites.rb
 - lib/revolt/util/fs_browser.rb
 - lib/revolt/util/common_cmd_args.rb
 - lib/revolt/util/matcher.rb
@@ -165,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: revolt
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Library for managing Re-Volt game, and some Commandline tools