smc-get 0.1.0

data/lib/smc_get/cui_commands/command.rb

@@ -0,0 +1,81 @@
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  module CUICommands
+    
+    #Class for invalid command-line argument errors.
+    class InvalidCommandline < Errors::SmcGetError
+    end
+    
+    #This is the superclass of all CUI commands. To make your own command,
+    #subclass it an overwrite ::help, ::summary, #parse and #execute.
+    class Command
+      
+      #The string returned from this method will be displayed to the
+      #user if he issues <tt>smc-get help YOURCOMMAND</tt>.
+      def self.help
+        "(nothing known)"
+      end
+      
+      #One-line summary of the command that shows up in the COMMANDS
+      #section of <tt>smc-get help</tt>. Should not be longer than 78
+      #characters due to automatic indentation. You may have to insert
+      #tabs to make it displaycorrectly; make sure to check the result by
+      #issueing <tt>smc-get help</tt>.
+      def self.summary
+        ""
+      end
+      
+      #Creates a new instance of this command. Do not override this, or
+      #call at least +super+.
+      def initialize(args)
+        parse(args)
+      end
+      
+      #This method gets all commandline options relevant for this subcommand
+      #passed in the +args+ array. You should parse them destructively, i.e.
+      #after you finished parsing, +args+ should be an empty array.
+      #Set instance variables to save data.
+      #
+      #Note that SmcGet is not set up when this method is called, so you
+      #cannot to things like <tt>Package.new</tt>.
+      def parse(args)
+        raise(NotImplementedError, "#{__method__} has to be overriden in a subclass!")
+      end
+      
+      #Execute the command. You can use the instance variables set in #parse.
+      #The method gets passed the parsed contents of smc-get's configuration
+      #files and commandline parameters; you can use this to make your command
+      #configurable via the configuration file, but make sure that
+      #1. The keys you use for your configuration don't already exist,
+      #2. options specified on the commandline take precedence over values
+      #   set in the configuration file and
+      #3. you <b>do not alter</b> the hash.
+      def execute(config)
+        raise(NotImplementedError, "#{__method__} has to be overriden in a subclass!")
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/smc_get/cui_commands/getinfo.rb

@@ -0,0 +1,91 @@
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  module CUICommands
+    
+    class GetinfoCommand < Command
+      
+      def self.help
+        <<HELP
+USAGE: #{File.basename($0)} getinfo [-r] PACKAGE
+
+Retrieves information about PACKAGE.
+
+OPTIONS:
+\r-r\t--remote\tForces getinfo to do a remote lookup.
+
+The default behaviour is to do a local lookup if the
+package is already installed.
+HELP
+      end
+      
+      def self.summary
+        "getinfo\tGet information on a package."
+      end
+      
+      def parse(args)
+            CUI.debug("Parsing #{args.count} args for getinfo.")
+        raise(InvalidCommandline, "No package given.") if args.empty?
+        @force_remote = false
+        
+        while args.count > 1
+          arg = args.shift
+          case arg
+          when "-r", "--remote" then @force_remote = true
+          else
+            raise(InvalidCommandline, "Invalid argument #{arg}.")
+          end
+        end
+        #The last command-line arg is the package
+        @pkg_name = args.shift
+      end
+      
+      def execute(config)
+            CUI.debug("Executing getinfo.")
+        pkg = Package.new(@pkg_name)
+        #Get the information
+        info = if pkg.installed? and !@force_remote
+          puts "[LOCAL PACKAGE]"
+          pkg.spec
+        else
+          puts "[REMOTE PACKAGE]"
+          pkg.getinfo
+        end
+        #Now output the information
+        puts "Title: #{info['title']}"
+        if info['authors'].count == 1
+          puts "Author: #{info['authors'][0]}"
+        else
+          puts 'Authors:'
+          info['authors'].each do |author|
+            puts "  - #{author}"
+          end
+        end
+        puts "Difficulty: #{info['difficulty']}"
+        puts "Description: #{info['description']}"
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/smc_get/cui_commands/help.rb

@@ -0,0 +1,64 @@
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  module CUICommands
+    
+    class HelpCommand < Command
+      
+      def self.help
+        <<EOF
+USAGE: #{File.basename($0)} help [SUBCOMMAND]
+
+Shows help for a special SUBCOMMAND or for #{File.basename($0)} in general.
+EOF
+      end
+      
+      def self.summary
+        "help\t\tGet help on a specific command."
+      end
+      
+      def parse(args)
+            CUI.debug("Parsing #{args.count} args for help.")
+        raise(InvalidCommandline, "Too many arguments.") if args.count > 1
+        @command = args.shift #nil if not given
+      end
+      
+      def execute(config)
+            CUI.debug("Executing help.")
+        if @command
+          sym = :"#{@command.capitalize}Command"
+          if CUICommands.const_defined?(sym)
+            puts CUICommands.const_get(sym).help
+          else
+            puts "#{@command} is not a valid command."
+            return 2
+          end
+        else
+          puts CUI::GENERAL_HELP
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/smc_get/cui_commands/install.rb

@@ -0,0 +1,91 @@
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  module CUICommands
+    
+    class InstallCommand < Command
+      
+      def self.help
+        <<HELP
+USAGE: #{File.basename($0)} install [-r] PACKAGES
+
+Installs one or more packages.
+
+OPTIONS:
+  -r\t--reinstall\tForces a reinstallation of the package.
+HELP
+      end
+      
+      def self.summary
+        "install\tInstall one or more packages."
+      end
+      
+      def parse(args)
+            CUI.debug("Parsing #{args.count} args for install.")
+        raise(InvalidCommandline, "No package given.") if args.empty?
+        @reinstall = false
+        @pkg_names = []
+        
+        until args.empty?
+          arg = args.shift
+          case arg
+          when "--reinstall", "-r" then @reinstall = true
+          else
+            @pkg_names << arg
+            $stderr.puts("Unknown argument #{arg}. Treating it as a package.") if arg.start_with?("-")
+          end
+        end
+      end
+      
+      def execute(config)
+            CUI.debug("Executing install.")
+        @pkg_names.each do |pkg_name|
+          pkg = Package.new(pkg_name)
+          if pkg.installed?
+            if @reinstall
+              puts "Reinstalling #{pkg}."
+            else
+              puts "#{pkg} is already installed. Maybe you want --reinstall?."
+              next
+            end
+          end
+          puts "Installing #{pkg}."
+          #Windows doesn't understand ANSI escape sequences, so we have to
+          #use the carriage return and reprint the whole line.
+          base_str = "\rDownloading %s... (%.2f%%)"
+          pkg.install(config[:max_tries]) do |filename, percent_filename, retrying|
+            if retrying
+              puts "#{retrying.message} Retrying."
+            else
+              print "\r", " " * 80 #Clear everything written before
+              printf(base_str, filename, percent_filename)
+            end
+          end
+          puts
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/smc_get/cui_commands/list.rb

@@ -0,0 +1,80 @@
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  module CUICommands
+    
+    class ListCommand < Command
+      
+      def self.help
+        <<EOF
+USAGE: #{File.basename($0)} list [PACKAGE]
+
+If PACKAGE is given, lists all files installed by PACKAGE. Otherwise,
+all installed packages are listed accompanied by their installation
+date in the format YY-MM-DD HH:MM, where the time is given on a
+24-hour clock.
+EOF
+      end
+      
+      def self.summary
+        "list\t\tLists all installed packages or files installed by a package. "
+      end
+      
+      def parse(args)
+            CUI.debug("Parsing #{args.count} args for list.")
+        raise(InvalidCommandline, "Too many arguments.") if args.count > 1
+        @pkg_name = args.shift #nil if not specified
+      end
+      
+      def execute(config)
+        CUI.debug("Executing help.")
+        if Package.installed_packages.empty?
+          puts "No packages installed."
+        else
+          if @pkg_name
+            pkg = Package.new(@pkg_name)
+            puts "Files installed for #{pkg}:"
+            info = pkg.spec
+            puts
+            puts "Levels:"
+            puts info["levels"].join("\n")
+            puts
+            puts "Music:"
+            puts info.has_key?("music") ? info["music"].join("\n") : "(None)"
+            puts
+            puts "Graphics:"
+            puts info.has_key?("graphics") ? info["graphics"].join("\n") : "(None)"
+          else
+            printf("%-38s | %-38s\n", "Package", "Installation date")
+            print("-" * 39, "+", "-" * 40, "\n")
+            Package.installed_packages.each do |pkg|
+              printf("%-38s | %-38s\n", pkg.name, pkg.spec_file.mtime.strftime("%d-%m-%Y %H:%M"))
+            end
+          end
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/smc_get/cui_commands/search.rb

@@ -0,0 +1,109 @@
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+module SmcGet
+  
+  module CUICommands
+    
+    class SearchCommand < Command
+      
+      def self.help
+        <<HELP
+USAGE: #{File.basename($0)} search [-a][-d][-D][-l][-L][-p][-t] QUERY
+
+Searches the local or remote repository for packages. QUERY is assumed
+to be a regular expression.
+
+OPTIONS:
+  -a\t--authors\tSearch the author list.
+  -d\t--description\tSearch the package descriptions.
+  -D\t--difficulty\tSearch the 'difficulty' fields.
+  -l\t--only-local\tOnly search local packages. Default is to search remotely.
+  -L\t--levels\tSearch for specific level names.
+  -p\t--pkgname\tSearch the package files' names.
+  -t\t--title\t\tSearch the packages' full titles.
+  
+  
+If you don't specify which fields to use, --pkgname is assumed as it performs
+best if used alone.
+HELP
+      end
+      
+      def self.summary
+        "search\tSearch for a package."
+      end
+      
+      def parse(args)
+            CUI.debug("Parsing #{args.count} args for search.")
+        raise(InvalidCommandline, "No query given.") if args.empty?
+        @search_fields = []
+        @only_local = false
+        
+        while args.count > 1
+          arg = args.shift
+          case arg
+          when "-l", "--only-local" then @only_local = true
+          when "-t", "--title" then @search_fields << :title
+          when "-d", "--description" then @search_fields << :description
+          when "-a", "--authors" then @search_fields << :authors
+          when "-D", "--difficulty" then @search_fields << :difficulty
+          when "-L", "--levels" then @search_fields << :levels
+          when "-p", "--pkgname" then @search_fields << :pkgname
+          else
+            raise(InvalidCommandline, "Invalid argument #{arg}.")
+          end
+        end
+        #If no search fields were specified, default to :pkgname, because
+        #it causes the least network traffic.
+        @search_fields << :pkgname if @search_fields.empty?
+        #The last command-line arg is the search query
+        @query = Regexp.new(args.shift)
+      end
+      
+      def execute(config)
+            CUI.debug("Executing search.")
+        result = SmcGet::Package.search(@query, @search_fields, @only_local)
+        return 2 if result.empty?
+        result.each do |pkg|
+          #We need to check the only_local option here, because the level
+          #version in the repository may be newer than that one installed
+          #locally. pkg.installed? wouldn't have telled us that.
+          spec = if @only_local
+            puts "[LOCAL PACKAGE]"
+            pkg.spec
+          else
+            puts "[REMOTE PACKAGE]"
+            pkg.getinfo
+          end
+          puts "Package title:     #{spec["title"]}"
+          puts "Real package name: #{pkg.name}"
+          puts "Authors:           #{spec["authors"].join(",")}"
+          puts "Difficulty:        #{spec["difficulty"]}"
+          puts "Description:"
+          puts spec["description"]
+          puts
+        end
+      end
+      
+    end
+    
+  end
+  
+end