aniview 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b35aefbae5c33c60dd90e34e39ba25538fb537d
-  data.tar.gz: f930e37c98cab765b2baaf880e1631e9b8cee308
+  metadata.gz: 827d5b9084b305647f640fd4cf3ba14ce15bcea5
+  data.tar.gz: 3e10b4ccf9d9f02cfee4260921eb7f22ae097339
 SHA512:
-  metadata.gz: 0cb7100a4503b321ebac1a28582d856fc2b536fbae03ffa7dbc3d9bcacb5d5506e3ba8f75871822f749695afff13c9249bee1fc6bdb309c2d0265e366e49cace
-  data.tar.gz: def2061bba9ae07a58886a26a0f8d468632d98623c1d13be405f895651be834e4d737aebc7df084fcf79b5bd44ac274012c264f35bdad467c245078b4428597c
+  metadata.gz: 69a1e2a4ba2c11f38811bb5eb951993f5ea41228796c77f397a9292c2f053993f653b8ecbe614df7c41a9fe3d3a88c481bc8379e73340d0ea580166974c57206
+  data.tar.gz: 6195b01dcd02520fb7119c4b690f2266c0459ea603b96c6eaea03ab9e6aa352314800cac6b6f3052f846306886a409b7772fa0d6534ae2d29f7ad18ff73dbb97

data/README.md

@@ -0,0 +1,12 @@
+# aniview
+command line anime library viewer
+
+![screenshot](https://raw.githubusercontent.com/annacrombie/aniview/master/screenshot.png)
+
+## installation
+### using rubygems
+`gem install aniview`
+
+### Find out more on the wiki
++ [Default Keybingings](https://github.com/annacrombie/aniview/wiki/Default-Keybindings)
++ [Format Strings](https://github.com/annacrombie/aniview/wiki/Format-Strings)

data/lib/aniview.rb

@@ -1,3 +1,4 @@
+require_relative 'aniview/util/error'
 require_relative 'application'
 require_relative 'daemon'
 

data/lib/aniview/interface/pref/pref.rb

@@ -6,166 +6,183 @@ require_relative '../../view/color'
 require_relative '../bridge'
 
 module Aniview
+
   module Interface
+
+    ##
+    ## @brief      Class for preferences.
+    ##
     class Pref < Bridge
 
       include Observable
 
-      def initialize
-        @home = Dir.home
-        @conf = @home + "/.config/aniview"
-    
-        File.open(File.join(File.dirname(__FILE__), "/validate.json"), "r") {
-          |f| @validate = JSON.parse(f.read)
-        }
-    
-        FileUtils.mkdir_p(@conf) unless File.directory?(@conf)
+      attr_accessor :logger
 
-        @pref_file = @conf + "/aniview.json"
+      ##
+      ## @brief      Initializes pref object, with optional logger
+      ##
+      ## @param      logger  The logger
+      ##
+      ## @return     A new pref object
+      ##
+      def initialize(logger: nil)
+        @logger          = logger
+        conf             = Dir.home + "/.config/aniview"
+        @default_file    = File.join(File.dirname(__FILE__), "/defaults.json")
+        @pref_file       = conf + "/aniview.json"
+        validation_file  = File.join(File.dirname(__FILE__), "/validate.json")
+        @validations     = read(validation_file)
 
-        @saving = false
-    
-        defaults should_save: true if not File.exist?(@pref_file)
+        FileUtils.mkdir_p(conf) unless File.directory?(conf)
         load
+        save                    unless File.exist?(@pref_file)
       end
     
-      def parseDir path
-        path = path.gsub("$airing_dir", @pref["airing_dir"])
-        path = path.gsub("$conf_dir", @pref["conf_dir"])
-        path = path.gsub("~", Dir.home)
-
-        return path
-      end
-    
-      def defaults(should_save:false)
-        File.open(File.join(File.dirname(__FILE__), "/defaults.json"), "r") {|f| @pref = JSON.parse(f.read)}
-        save if should_save
+      ##
+      ## @brief      converts a directory like "~/movies" to
+      ##             "/users/shinji/movies/"
+      ##
+      ## @param      path  The path to parse
+      ##
+      ## @return     the parsed directory string
+      ##
+      def parseDir(path)
+        {
+          "$airing_dir" => @pref["airing_dir"],
+          "$conf_dir"   => @pref["conf_dir"],
+          "~"           => Dir.home
+        }.inject(path) { |path, r| path.gsub(r[0], r[1]) }
       end
-    
-      def set(s, val)
-        trail = [s] if s.class == String
-        trail = s   if s.class == Array
-        if valpref(trail, val, @validate)
-          @pref = setpref(trail, val, @pref)
-          save
-          changed
-          notify_observers
-        end
+
+      ##
+      ## @brief      gets a preference
+      ##
+      ## @param      key   The key
+      ##
+      ## @return     the preference at key or nil if there is no such preference
+      ##
+      def get(key)
+        @pref[key] if @pref.key?(key)
       end
     
-      def setpref(trail, destination, map)
-        if trail.length == 1
-          map[trail[0]] = destination
-          return map
-        else
-          
-          blaze = trail[0]
-          map[blaze] = setpref(trail[1..-1], destination, map[blaze])
-          
-        end
-        return map
+      ##
+      ## @brief      Validates and sets a preference
+      ##
+      ## @param      trail        The key or array of keys that specify where
+      ##                          the preference is stored
+      ## @param      destination  The new value for the preference
+      ##
+      ## @return     nil
+      ##
+      def set(trail, destination)
+        trail = [trail] if trail.class == String
+        return unless valid_preference?(trail, destination)
+
+        trail[0...-1].inject(@pref, :fetch)[trail.last] = destination
+        save
+        changed
+        notify_observers
       end
     
-      def valpref(trail, destination, map)
-        
-        if trail.length == 1
-          skeys = [
-            "space",
-            "up",
-            "down",
-            "left",
-            "right",
-            "enter"
-          ]
-    
-          case map[trail[0]]
-            when "key"
-              return false if destination.length != 1 and not skeys.include? destination
-      
-            when "path"
-              destination.split(":").each { |d|
-                return false if not Dir.exist?(parseDir d)
-              }
-      
-            when "color"
-              return false if not Aniview::View::Color.respond_to? destination
-      
-            when "int"
-              return false if not destination.scan(/\D/).empty? and destination.length > 1
-    
-            when "locked"
-              return false
-    
-          end
-    
-          return true
-    
-        else
-          blaze = trail[0]
-          return valpref(trail[1..-1], destination, map[blaze])
+      ##
+      ## @brief      validates a preference
+      ##
+      ## @param      trail        The array of keys that specify where the
+      ##                          preference is stored
+      ## @param      destination  The new value for the preference
+      ##
+      ## @return     true if preference is valid, false otherwise
+      ##
+      def valid_preference?(trail, destination)
+        skeys = [ "space", "up", "down", "left", "right", "enter" ]
+
+        case trail.inject(@validations, :fetch)
+        when "key"
+          destination.length == 1 or skeys.include?(destination)
+        when "path"
+          destination.split(":").map { |d| Dir.exist?(parseDir d) }.reduce { |m, n| m and n }
+        when "color"
+          Aniview::View::Color.respond_to?(destination)
+        when "int"
+          destination.scan(/\D/).empty? and destination.length > 1
+        when "locked"
+          false
+        else 
+          true
         end
       end
-    
-      def get s
-        return @pref[s] if @pref.key?(s)
-      end
 
+      ##
+      ## @brief      gets an array of PrefItems to be displayed in the menu
+      ##
+      ## @return     an array of PrefItems
+      ##
       def items
         ignore = {
           "local_anime" => true,
           "schedule" => true,
         }
-
-        r = {}
-        @pref.each{ |item| 
-          next if ignore.key? item[0]
-          title = item[0]
-          if item[1].class == String
-            val = item[1]
-          elsif item[1].class == Array
-            val = item[1].join(":")
-          elsif item[1].class == Hash
-            item[1].each { |subitem|
-              subtitle = title + "_" + subitem[0]
-              subval   = subitem[1]
-              r.merge!(PrefItem.new(subtitle, subval, []) => [PrefItem.new("", "", [item[0], subitem[0]])])
+        @pref.map{ |title, preference|
+          next if ignore.key? title
+          if preference.class == Hash
+            preference.map { |subtitle, subpreference|
+              PrefItem.new(title + "_" + subtitle, subpreference, [title, subtitle])
             }
-            next
+          else
+            preference = preference.join(":") if preference.class == Array
+            PrefItem.new(title, preference, [title])
           end
-          r.merge!(PrefItem.new(title, val, []) => [ PrefItem.new("", "", [item[0]]) ] )
-        }
-        return r
+        }.flatten.compact
       end
 
+      ##
+      ## @brief      saves the prefs to disk
+      ##
+      ## @return     nil
+      ##
       def save
-        @saving = true
         File.open(@pref_file, "w") { |f| f.write(JSON.pretty_generate(@pref)) }
-        @saving = false
       end
 
-      def saving?
-        @saving
-      end
-      
+      ##
+      ## @brief      loads the prefs from file
+      ##
+      ## @param      file  The file
+      ##
+      ## @return     nil
+      ##
       def load
-        begin
-          #json = ""
-          json = File.open(@pref_file, "r") {|f| f.read}
-          #puts json
-          if json == ""
-            #puts "going to defaults"
-            defaults
-            return
-          end
-          @pref = JSON.parse json
-        rescue JSON::ParserError
-          puts "severe! your preference file #{@pref_file} is corrupted,"
-          puts "please fix the file or delete it to restore defaults"
-          exit
-        end
+        @pref = read(@pref_file) || read(@default_file)
         changed
         notify_observers
       end
+
+      ##
+      ## @brief      reads json from a file
+      ##
+      ## @param      file  The file
+      ##
+      ## @return     parsed json
+      ##
+      def read(file)
+        begin
+          File.open(file, "r") { |f|
+            json = f.read
+            if json.empty?
+              return nil
+            else
+              begin
+                JSON.parse json
+              rescue JSON::ParserError
+                raise Aniview::Error::InvalidPref.new
+              end
+            end
+          }
+        rescue Errno::ENOENT
+          return nil
+        end
+      end
+
     end
   end
 end

data/lib/aniview/util/error.rb

@@ -0,0 +1,9 @@
+module Aniview
+  module Error
+    class InvalidPref < StandardError
+      def initialize(msg="Your preferences file is invalid")
+        super
+      end
+    end
+  end
+end

data/lib/aniview/view/menu.rb

@@ -11,9 +11,11 @@ module Aniview
 
       attr_accessor :visible
 
-      def initialize(refresh_function: :items, interface:, name:, pref:, format:, term:, children: true, visible: false)
+      def initialize(refresh_function: :items, interface:, name:, pref:, format:, term:, children: true, visible: false, logger: nil)
         @attributes       = {}
 
+        @logger = logger
+
         @visible = visible
 
         @refresh_function = refresh_function
@@ -111,7 +113,7 @@ module Aniview
         @items = @interface.send(@refresh_function)
         refreshFormats
         refresh_attributes
-        @expanded = -1 if @items.values[@expanded] == nil
+        @expanded = -1 if @children and @items.values[@expanded] == nil
         fixCursor
         changed
         notify_observers
@@ -132,7 +134,7 @@ module Aniview
         notify_observers
       end
       
-      def resolveSelected(resolve_me=@selected)
+      def resolve_selected(resolve_me=@selected)
         in_expanded=false
         inside = 0
         outside = resolve_me
@@ -274,7 +276,7 @@ module Aniview
         print lo + @cl["m"] + @title_formatted + "\e[K"
     
         #get the resolved start positions
-        resolved_start_position = resolveSelected line_on
+        resolved_start_position = resolve_selected line_on
         outer_index = resolved_start_position["out"]
         inner_index = resolved_start_position["in"]
         
@@ -288,7 +290,7 @@ module Aniview
         while line_on < lines_to_draw
           
           in_outer_region    = ! (line_on >= getLen)
-          in_expanded_region = resolveSelected(line_on)["in_expanded"]
+          in_expanded_region = resolve_selected(line_on)["in_expanded"]
           line               = line_on-offset+1
           selected           = line_on == @selected
     
@@ -311,7 +313,7 @@ module Aniview
       end
     
       def control(key)
-        sel = resolveSelected
+        sel = resolve_selected
         if key == @pref.get("keybindings")["menu_nav_up"]
           moveCursor("up")
         elsif key == @pref.get("keybindings")["menu_nav_down"]

data/lib/aniview/view/prefmenu.rb

@@ -7,10 +7,9 @@ module Aniview
       include Aniview::Util
     
       def customControl(key, sel)
-        return if @items.keys[sel["out"]].attributes["t"] == ""
-        path =  @items.values[sel["out"]][0].path
-        title = @items.keys[sel["out"]].attributes["t"]
-        value = @items.keys[sel["out"]].attributes["v"]
+        path =  @items[sel["out"]].path
+        title = @items[sel["out"]].attributes["t"]
+        value = @items[sel["out"]].attributes["v"]
         if key == "enter"
           newval = Util.readline(@term, title + ":", value)
           @interface.set(path, newval)

data/lib/application.rb

@@ -42,13 +42,14 @@ module Aniview
     #
     def initialize
 
-      #@logger = Logger.new('aniview.log')
-      #@logger.level = Logger::DEBUG
-      
       @term         = Util::Term.new
       
       @pref         = Interface::Pref.new
 
+      @logger = Logger.new(@pref.parseDir(@pref.get("log_file")))
+      @logger.level = Logger::DEBUG
+      @pref.logger = @logger
+
       @mpvbridge    = Interface::MPVBridge.new    @pref
 
       @aio          = Interface::AnimeIO.new      @pref, @mpvbridge
@@ -78,7 +79,8 @@ module Aniview
         pref:             @pref,
         format:           "format_library_unwatched",
         term:             @term,
-        refresh_function: :unwatched
+        refresh_function: :unwatched,
+        logger:           @logger
       )
       @prefmenu = View::PrefMenu.new(
         interface:        @pref,
@@ -86,7 +88,8 @@ module Aniview
         pref:             @pref,
         format:           "format_preferences",
         term:             @term,
-        children:         false
+        children:         false,
+        logger:           @logger
       )
       @delugemenu = View::DelugeMenu.new(
         interface:        @delugec,
@@ -94,7 +97,8 @@ module Aniview
         pref:             @pref,
         format:           "format_torrents",
         term:             @term,
-        children:         false
+        children:         false,
+        logger:           @logger
       )
       @schedulemenu = View::ScheduleMenu.new(
         interface:        @schedule,
@@ -102,7 +106,8 @@ module Aniview
         pref:             @pref,
         format:           "format_schedule",
         term:             @term,
-        children:         false
+        children:         false,
+        logger:           @logger
       )
       @subscriptionmenu = View::SubscriptionMenu.new(
         interface:        @subscription,
@@ -110,7 +115,8 @@ module Aniview
         pref:             @pref,
         format:           "format_subscriptions",
         term:             @term,
-        children:         false
+        children:         false,
+        logger:           @logger
       )
       @term.save.hide_cursor.echo_off 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aniview
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - annacrombie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: streamio-ffmpeg
@@ -137,6 +137,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- "./README.md"
 - "./lib/aniview.rb"
 - "./lib/aniview/client/aniclient.rb"
 - "./lib/aniview/interface/animeio/animefile.rb"
@@ -154,6 +155,7 @@ files:
 - "./lib/aniview/interface/schedule/schedule.rb"
 - "./lib/aniview/interface/schedule/scheduleitem.rb"
 - "./lib/aniview/interface/subscription/subscription.rb"
+- "./lib/aniview/util/error.rb"
 - "./lib/aniview/util/term.rb"
 - "./lib/aniview/util/util.rb"
 - "./lib/aniview/view/aiomenu.rb"