royw-dvdprofiler2xbmc 0.0.6 → 0.0.8

data/lib/dvdprofiler2xbmc/models/media.rb

@@ -1,10 +1,8 @@
 # == Synopsis
 # Media encapsulates information about a single media file
 class Media
-  attr_reader :media_path, :image_files, :fanart_files, :year, :media_subdirs, :title, :title_with_year
-  attr_accessor :isbn, :imdb_id
-
-  DISC_NUMBER_REGEX = /\.(cd|part|disk|disc)\d+/i
+  attr_reader :media_path, :image_files, :fanart_files, :media_subdirs, :title, :title_with_year, :part, :extension
+  attr_accessor :isbn, :imdb_id, :resolution, :year
 
   def initialize(directory, media_file)
     @media_subdirs = File.dirname(media_file)
@@ -12,13 +10,19 @@ class Media
 
     cwd = File.expand_path(Dir.getwd)
     Dir.chdir(File.dirname(@media_path))
-    @nfo_files = Dir.glob("*.{#{AppConfig[:nfo_extensions].join(',')}}")
-    @image_files = Dir.glob("*.{#{AppConfig[:thumbnail_extension]}}")
-    @fanart_files = Dir.glob("*fanart*}")
+    @nfo_files = Dir.glob("*.{#{AppConfig[:extensions][:nfo]}}")
+    @image_files = Dir.glob("*.{#{AppConfig[:extensions][:thumbnail]}}")
+    @fanart_files = Dir.glob("*#{AppConfig[:extensions][:fanart]}*}")
     Dir.chdir(cwd)
 
-    @year = $1 if File.basename(@media_path) =~ /\s\-\s(\d{4})/
-    @title = find_title(@media_path)
+    components = Media.parse(@media_path)
+    unless components.nil?
+      @year = components[:year]
+      @title = components[:title]
+      @part = components[:part]
+      @extension = components[:extension]
+      @resolution = components[:resolution]
+    end
     @title_with_year = find_title_with_year(@title, @year)
   end
 
@@ -32,11 +36,33 @@ class Media
   #  path_to('nfo') => '/a/b/c.nfo'
   def path_to(type)
     # ditch all extensions (ex, a.b => a, a.cd1.b => a)
-    new_path = File.basename(@media_path, ".*").gsub(DISC_NUMBER_REGEX, '')
-    unless (type == :base) || AppConfig[type].nil?
-      new_path += '.' + AppConfig[type]
+    DvdProfiler2Xbmc.generate_filespec(@media_path, type, :year => @year, :resolution => @resolution)
+  end
+
+  # parse the given filespec into a hash the consists of the
+  # found parts with keys:
+  #  :title       required
+  #  :year        optional
+  #  :part        optional
+  #  :extension   required
+  def self.parse(filespec)
+    result = nil
+    filename = File.basename(filespec)
+    AppConfig[:media_parsers].each do |parser|
+      match_data = parser.regex.match(filename)
+      unless match_data.nil?
+        if((match_data.length - 1) == parser.tokens.length)
+          index = 1
+          result = {}
+          parser.tokens.each do |token|
+            result[token] = match_data[index]
+            index += 1
+          end
+          break
+        end
+      end
     end
-    File.join(File.dirname(@media_path), new_path)
+    result
   end
 
   def to_s
@@ -51,14 +77,7 @@ class Media
 
   # return the media's title extracted from the filename and cleaned up
   def find_title(media_path)
-    # ditch extensions including disc number (ex, a.part2.b => a, a.cd1.b => a)
-    title = File.basename(media_path, ".*").gsub(DISC_NUMBER_REGEX, '')
-    title.gsub!(/\s\-\s\d{4}/, '')  # remove year
-    title.gsub!(/\s\-\s0/, '')      # remove "- 0", i.e., bad year
-    title.gsub!(/\(\d{4}\)/, '')    # remove (year)
-    title.gsub!(/\[.+\]/, '')       # remove square brackets
-    title.gsub!(/\s\s+/, ' ')       # remove multiple whitespace
-    title.strip                     # remove leading and trailing whitespace
+    Media.parse(media_path)[:title] rescue nil
   end
 
   # return the media's title but with the (year) appended

data/lib/dvdprofiler2xbmc/models/tmdb_profile.rb

@@ -90,23 +90,11 @@ class TmdbProfile
       xml = self.to_xml
       unless xml.blank?
         AppConfig[:logger].debug { "saving #{filespec}" }
-        save_to_file(filespec, xml)
+        DvdProfiler2Xbmc.save_to_file(filespec, xml)
       end
     rescue Exception => e
       AppConfig[:logger].error "Unable to save tmdb profile to #{filespec} - #{e.to_s}"
     end
   end
 
-  def save_to_file(filespec, data)
-    new_filespec = filespec + AppConfig[:new_extension]
-    File.open(new_filespec, "w") do |file|
-      file.puts(data)
-    end
-    backup_filespec = filespec + AppConfig[:backup_extension]
-    File.delete(backup_filespec) if File.exist?(backup_filespec)
-    File.rename(filespec, backup_filespec) if File.exist?(filespec)
-    File.rename(new_filespec, filespec)
-    File.delete(new_filespec) if File.exist?(new_filespec)
-  end
-
 end

data/lib/dvdprofiler2xbmc/models/xbmc_info.rb

@@ -3,7 +3,7 @@
 #
 # Usage:
 #
-# profile = XbmcInfo.new(media.path_to(:nfo_extension))
+# profile = XbmcInfo.new(media.path_to(:nfo))
 #
 # profile.movie['key'] = 'some value'
 # puts profile.movie['key']
@@ -58,7 +58,7 @@ class XbmcInfo
         xml = self.to_xml
         unless xml.blank?
           AppConfig[:logger].info { "updated #{@nfo_filespec}"}
-          save_to_file(@nfo_filespec, xml)
+          DvdProfiler2Xbmc.save_to_file(@nfo_filespec, xml)
         end
       end
     rescue Exception => e
@@ -83,18 +83,6 @@ class XbmcInfo
     end
   end
 
-  def save_to_file(filespec, data)
-    new_filespec = filespec + AppConfig[:new_extension]
-    File.open(new_filespec, "w") do |file|
-      file.puts(data)
-    end
-    backup_filespec = filespec + AppConfig[:backup_extension]
-    File.delete(backup_filespec) if File.exist?(backup_filespec)
-    File.rename(filespec, backup_filespec) if File.exist?(filespec)
-    File.rename(new_filespec, filespec)
-    File.delete(new_filespec) if File.exist?(new_filespec)
-  end
-
   # has any of the data changed?
   def dirty?
     result = false

data/lib/dvdprofiler2xbmc/views/cli.rb

@@ -1,5 +1,6 @@
+require File.join(File.dirname(__FILE__), 'config_editor')
 require 'commandline/optionparser'
-include CommandLine
+# include CommandLine
 
 # Command Line interface for the Dvdprofiler2Xbmc application.
 # All application output is via AppConfig[:logger] so we have
@@ -36,10 +37,21 @@ module Dvdprofiler2xbmc
         # parse the command line
         options = setup_parser()
         od = options.parse(arguments)
+        run_editor = !AppConfig.exist?
 
         setup_app_config(od, logger)
+        run_editor = true unless AppConfig.valid?
 
-        unless od["--help"] || od["--version"]
+        logger.info(AppConfig.to_s) if  od["--show_config"]
+
+        if run_editor || od["--edit_config"]
+          editor = ConfigEditor.new
+          editor.execute
+        end
+
+        skip_execution = false
+        %w(--help --version --show_config --edit_config).each {|flag| skip_execution = true if od[flag] || run_editor}
+        unless skip_execution
           # create and execute class instance here
           app = DvdProfiler2Xbmc.instance
           app.execute
@@ -65,7 +77,6 @@ module Dvdprofiler2xbmc
       reinitialize_logger(logger, od["--quiet"], od["--debug"])
       AppConfig.load
       AppConfig.save
-      AppConfig[:imdb_query] = !od["--no_imdb_query"]
       AppConfig[:logfile] = od['--output'] if od['--output']
       AppConfig[:logfile_level] = od['--output_level'] if od['--output_level']
       reinitialize_logger(logger, od["--quiet"], od["--debug"])
@@ -80,7 +91,7 @@ module Dvdprofiler2xbmc
     # Setup the command line option parser
     # Returns:: OptionParser instances
     def self.setup_parser()
-      options = OptionParser.new()
+      options = CommandLine::OptionParser.new()
 
       # flag options
       [
@@ -95,8 +106,12 @@ module Dvdprofiler2xbmc
           :opt_description => "This usage information"
         },
         {
-          :names           => %w(--no_imdb_query -n),
-          :opt_description => 'Do not query IMDB.com'
+          :names           => %w(--show_config -s),
+          :opt_description => "This is the current configuration information"
+        },
+        {
+          :names           => %w(--edit_config -e),
+          :opt_description => "Edit the current configuration information"
         },
         {
           :names           => %w(--quiet -q),
@@ -114,7 +129,7 @@ module Dvdprofiler2xbmc
           :names           => %w(--reports -r),
           :opt_description => 'Display reports only.  Do not do any updates.'
         }
-      ].each { |opt| options << Option.new(:flag, opt) }
+      ].each { |opt| options << CommandLine::Option.new(:flag, opt) }
 
       # non-flag options
       [
@@ -123,16 +138,16 @@ module Dvdprofiler2xbmc
           :argument_arity  => [1,1],
           :arg_description => 'logfile',
           :opt_description => 'Write log messages to file. Default = no log file',
-          :opt_found       => OptionParser::GET_ARGS
+          :opt_found       => CommandLine::OptionParser::GET_ARGS
         },
         {
           :names           => %w(--output_level -l),
           :argument_arity  => [1,1],
           :arg_description => 'level',
           :opt_description => 'Output logging level: DEBUG, INFO, WARN, ERROR. Default = INFO',
-          :opt_found       => OptionParser::GET_ARGS
+          :opt_found       => CommandLine::OptionParser::GET_ARGS
         }
-      ].each { |opt| options << Option.new(opt) }
+      ].each { |opt| options << CommandLine::Option.new(opt) }
 
       options
     end

data/lib/dvdprofiler2xbmc/views/config_editor.rb

@@ -0,0 +1,289 @@
+# require 'highline'
+require "highline/import"
+
+# monkey patch HighLine to get rid of the ugly message:
+#  Your answer isn't valid (must match #<Proc:0xb76cb378@/home/royw/views/dvdprofiler2xbmc/lib/dvdprofiler2xbmc/app_config.rb:180>)
+# basically the problem is with inspecting a lambda validator, so just don't do it...
+class HighLine
+  class Question
+    def build_responses(  )
+      append_default unless default.nil?
+      @responses = { :ambiguous_completion =>
+                       "Ambiguous choice.  " +
+                       "Please choose one of #{@answer_type.inspect}.",
+                     :ask_on_error         =>
+                       "?  ",
+                     :invalid_type         =>
+                       "You must enter a valid #{@answer_type}.",
+                     :no_completion        =>
+                       "You must choose one of " +
+                       "#{@answer_type.inspect}.",
+                     :not_in_range         =>
+                       "Your answer isn't within the expected range " +
+                       "(#{expected_range}).",
+                     :not_valid            =>
+                       "Your answer isn't valid " +
+                       (@validate.kind_of?(Proc) ?
+                       '' : "(must match #{@validate.inspect}).")
+                   }.merge(@responses)
+    end
+  end
+end
+
+class ConfigEditor
+
+  def initialize
+  end
+
+  def execute
+    @saved_interrupt_message = DvdProfiler2Xbmc.interrupt_message
+    DvdProfiler2Xbmc.interrupt_message = ''
+    report_invalid_config_items
+    begin
+      AppConfig[:logger].info('Configuration Editor')
+
+      fields = AppConfig.navigation.collect do |page|
+        page.values.flatten.select do|field|
+          AppConfig.data_type[field]
+        end
+      end.flatten.uniq.compact
+      while(field = menu_select('field', fields))
+        begin
+          edit_field(field)
+        rescue
+        end
+      end
+      if agree("Save? yes/no") {|q| q.default = 'yes'}
+        AppConfig.save
+      end
+    rescue
+    end
+    DvdProfiler2Xbmc.interrupt_message = @saved_interrupt_message
+  end
+
+  def report_invalid_config_items
+    buf = []
+    AppConfig.validate.each do |field, value|
+      unless AppConfig.validate[field].call(AppConfig.config[field])
+        buf << field
+      end
+    end
+    unless buf.empty?
+      say 'The following config items are not valid and need to be changed:'
+      buf.each {|line| say "  #{line}"}
+    end
+  end
+
+  def edit_field(field)
+    result = true
+    while(result)
+      field_header(field)
+
+      choose do |menu|
+        menu.prompt = "Please select: "
+        menu.index = :number
+        menu.index_suffix = ') '
+        menu.choice(:quit, 'Quit') {result = false}
+        case AppConfig.data_type[field]
+        when :BOOLEAN
+          menu.choice(:true, 'True') {AppConfig.config[field] = true}
+          menu.choice(:false, 'False') {AppConfig.config[field] = false}
+        else
+          menu.choice(:default, 'Default') {AppConfig.config[field] = AppConfig.initial[field]}
+          if AppConfig.data_type[field].to_s =~ /^ARRAY/
+            menu.choice(:add, 'Add') {array_add(field)}
+            menu.choice(:delete, 'Delete') {array_delete(field)}
+          elsif AppConfig.data_type[field].to_s =~ /^HASH/
+            menu.choice(:add, 'Add') {hash_add(field)}
+            menu.choice(:delete, 'Delete') {hash_delete(field)}
+          else
+            menu.choice(:edit, 'Edit') {object_edit(field)}
+          end
+        end
+      end
+    end
+    result
+  end
+
+  def field_header(field)
+    say "\n"
+    say "-------------------------------"
+    say field
+    say "\n"
+    say AppConfig.help[field]
+    say "\n"
+    say "Default:"
+    say prettify(AppConfig.initial[field])
+    say "\n"
+    say "Current:"
+    say prettify(AppConfig.config[field])
+    say "\n"
+  end
+
+  def object_edit(field)
+    value = data_type_editor(field, AppConfig.data_type[field], AppConfig.initial[field])
+    AppConfig.config[field] = value unless value.nil?
+  end
+
+  def hash_add(field)
+    value = data_type_editor(field, AppConfig.data_type[field], AppConfig.initial[field])
+    if value =~ /([^,]+)\s*,\s*(\S.*)/
+      AppConfig.config[field][$1.strip] = $2.strip
+    end
+  end
+
+  def hash_delete(field)
+    choose do |menu|
+      menu.prompt = "Please select to remove: "
+      menu.index = :number
+      menu.index_suffix = ') '
+      menu.choice(:quit, 'Quit') {result = false}
+      values = []
+      AppConfig.config[field].each do |key, value|
+        values << "#{key} => #{value}"
+      end
+      menu.choices(*values) do |value, details|
+        if value =~ /(.*\S)\s+=>/
+          AppConfig.config[field].delete($1)
+        end
+      end
+    end
+  end
+
+  def array_add(field)
+    value = data_type_editor(field, AppConfig.data_type[field], AppConfig.initial[field])
+    AppConfig.config[field] += [value].flatten unless value.nil?
+    AppConfig.config[field].uniq!
+  end
+
+  def array_delete(field)
+    choose do |menu|
+      menu.prompt = "Please select to remove: "
+      menu.index = :number
+      menu.index_suffix = ') '
+      menu.choice(:quit, 'Quit') {result = false}
+      menu.choices(*AppConfig.config[field]) do |extension, details|
+        AppConfig.config[field].delete(extension)
+      end
+    end
+  end
+
+  def prettify(obj)
+    str = obj.pretty_inspect
+    if obj.kind_of? Mash
+      str = obj.to_hash.pretty_inspect
+    end
+    if obj.kind_of? Array
+      str = obj.inspect
+    end
+    if obj.kind_of? Hash
+      key_length = 0
+      obj.keys.each do |key|
+        key_length = key.length if key.length > key_length
+      end
+      buf = []
+      obj.each do |key,value|
+        buf << sprintf("%-#{key_length}.#{key_length}s => %s", key, value)
+      end
+      str = buf.join("\n")
+    end
+    str
+  end
+
+  def data_type_editor(field, data_type, default_value=nil)
+    value = nil
+    case data_type
+    when :BOOLEAN
+      value = agree("Set #{field} to true: ") do |q|
+        q.default = (default_value ? 'yes' : 'no') unless default_value.nil?
+      end
+    when :FILESPEC
+      value = ask('New filespec: ') do |q|
+#         q.answer_type = File
+        q.validate = AppConfig.validate_item[field] unless AppConfig.validate_item[field].nil?
+        q.confirm = false
+        q.default = default_value unless default_value.nil?
+      end
+    when :PATHSPEC
+      value = ask('New pathspec: ') do |q|
+#         q.answer_type = Pathname
+#         q.validate = lambda { |v| File.exist?(v) && File.directory?(v) }
+        q.validate = AppConfig.validate_item[field] unless AppConfig.validate_item[field].nil?
+        q.confirm = false
+        q.default = default_value unless default_value.nil?
+      end
+    when :PERMISSIONS
+      value = ask('New value (octal): ') do |q|
+#         q.validate = lambda { |v| (v.to_i(8) >= 0) && (v.to_i(8) <= 07777) }
+        q.validate = AppConfig.validate_item[field] unless AppConfig.validate_item[field].nil?
+        q.default = default_value unless default_value.nil?
+      end
+    when :ARRAY_OF_STRINGS
+      value = ask('New values or a blank line to quit: ') do |q|
+        q.gather = ''
+        q.validate = AppConfig.validate_item[field] unless AppConfig.validate_item[field].nil?
+        # note, can not have both gather and default as there is no way to
+        # terminate the input loop
+      end
+    when :ARRAY_OF_PATHSPECS
+      # note, can not have both gather and default as there is no way to
+      # terminate the input loop
+      value = ask('New pathspecs or a blank line to quit: ') do |q|
+        q.gather = ''
+#         q.validate = lambda { |v| v.empty? || (File.exist?(v) && File.directory?(v)) }
+        q.validate = AppConfig.validate_item[field] unless AppConfig.validate_item[field].nil?
+      end
+    when :HASH_FIXED_SYMBOL_KEYS_STRING_VALUES
+    when :HASH_STRING_KEYS_STRING_VALUES
+      value = ask('New value as key,value: ') do |q|
+#         q.default = default_value unless default_value.nil?
+      end
+    else
+      value = ask('New value: ')
+    end
+    value
+  end
+
+  VALUE_LENGTH = 60
+
+  def menu_select(name, values)
+    result = false
+    say("\n#{name.capitalize} Selection")
+    choose do |menu|
+      menu.prompt = "Please select #{name}: "
+      menu.index = :number
+      menu.index_suffix = ') '
+      menu.choice(:quit, 'Quit') {result = false}
+      menu.choices(*(values.collect{|v| field_name_choice(v)})) do |command, details|
+        result = command.split(" ").first
+      end
+    end
+    result
+  end
+
+  def field_name_choice(value)
+    value_str = sprintf("%-#{VALUE_LENGTH}.#{VALUE_LENGTH}s", first_line(value))
+    if AppConfig.config[:color_enabled]
+      color = 'green'
+      unless AppConfig.validate[value].nil?
+        color = 'red' unless AppConfig.validate[value].call(AppConfig.config[value])
+      end
+      value_str = "<%= color('#{value_str}', :#{color})%>"
+    end
+    str = sprintf("%20s  %s", value, value_str)
+    str
+  end
+
+  def first_line(value)
+    config_value = AppConfig.config[value]
+    if config_value.kind_of? Mash
+      config_value = config_value.to_hash
+    end
+    str = [config_value.inspect].flatten.first.split("\n").first
+    if str.length > VALUE_LENGTH
+      str = str[0..(VALUE_LENGTH - 4)] + '...'
+    end
+    str
+  end
+
+end