dog 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a288fcd6df7bf73823892332fdb68473ee4c38480d6db0225126d08d6aa32fe
+  data.tar.gz: d451489dfc83de0a0858bf5c374dc7ee82c50e913216fcf547a3c541ffaf1aa6
+SHA512:
+  metadata.gz: 93100e702f623c5bc573987f0f661300d0dd5acfe297325ffb41277fba6d0401fdf841cef1684e96ae79c33337081d8cc9f73d9715bc374168cb799b01377cc4
+  data.tar.gz: f47071eb9d5710b24461220ca75ae7ca88f0d9af5261e0627b8ccc8e1c42c046851734cab1529cbf592bfaa96c89014a750d3cc4a5eb835b5a43d1e94c04afe9

data/bin/dog

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'dog'
+require 'optparse'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: dog [options]"
+
+  opts.on("-lTOPIC", "--list=TOPIC", "List the link names in a given topic") do |t|
+    map = Dog::Map.new
+    map.load
+
+    if !map.has_topic?(t)
+      puts "Topic \"#{t}\" not found in map!"
+      exit
+    end
+
+    map.link_names(t).each do |name|
+      puts name
+    end
+    exit
+  end
+
+  opts.on("-h", "--help", "Prints this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+Dog::Viewer.new.view

data/lib/dog/map.rb

@@ -0,0 +1,136 @@
+require 'yaml'
+require 'json'
+
+module Dog
+  class Map
+    attr_accessor :topic_name
+
+    def initialize
+      @map = {"@home" => []}
+      @topic_name = "@home"
+    end
+
+    def name(topic: @topic_name, index:)
+      @map[topic][index]["name"]
+    end
+
+    def path(topic: @topic_name, index:)
+      @map[topic][index]["path"]
+    end
+
+    def count(topic = @topic_name)
+      @map[topic].length
+    end
+
+    def move_up(topic: @topic_name, index:)
+      if index > 0
+        @map[@topic_name][index],
+        @map[@topic_name][index - 1]  =
+        @map[@topic_name][index - 1],
+        @map[@topic_name][index]
+      end
+    end
+
+    def move_down(topic: @topic_name, index:)
+      if index < count(@topic_name) - 1
+        @map[@topic_name][index],
+        @map[@topic_name][index + 1]  =
+        @map[@topic_name][index + 1],
+        @map[@topic_name][index]
+      end
+    end
+
+    def has_topic?(name)
+      @map.has_key?(name)
+    end
+
+    def here
+      @map[@topic_name]
+    end
+
+    def remove_topic(topic = @topic)
+      @map.delete(@topic)
+    end
+
+    def remove_link(topic: @topic_name, name:)
+      here.delete_if do |link|
+        link["name"] == name
+      end
+    end
+
+    def replace(topic: @topic_name, name:, new_name:, new_path:)
+      index = @map[@topic_name].index do |link|
+        link["name"] == name
+      end
+
+      if index
+        here[index] = create_link(new_name, new_path)
+      end
+    end
+
+    def add(topic: @topic_name, name:, path:)
+      @map[@topic_name].push(
+        create_link(name,path)
+      )
+    end
+
+    def navigate( destination )
+      if !@map[destination]
+        @map[destination] = []
+      end
+
+      @topic_name = destination
+    end
+
+    def load
+      begin
+        data = YAML.load_file(MAP_FILENAME)
+        @map = data if data
+      rescue Errno::ENOENT, Errno::ENOTDIR
+        return false
+      end
+      return true
+    end
+
+    def save
+      File.write(MAP_FILENAME, @map.to_yaml)
+    end
+
+    def [](key)
+      @map[key]
+    end
+
+    def find_incoming_links(destination)
+      links = []
+      @map.each do |key, value|
+        value.each do |item|
+          if item["path"] == destination
+            if key == @topic_name
+              links.push(
+                create_link("#{key} (<<)", key)
+              )
+            else
+              links.push(
+                create_link(key, key)
+              )
+            end
+          end
+        end
+      end
+      return links
+    end
+
+    def link_names(topic)
+      @map[topic].map{|l| l["name"]}
+    end
+
+    private
+
+    def create_link(name, path)
+      {
+        "name" => name,
+        "path" => path
+      }
+    end
+  end
+end

data/lib/dog/viewer.rb

@@ -0,0 +1,503 @@
+require 'dog'
+require "curses"
+require "uri"
+require 'digest'
+require 'fileutils'
+require 'yaml'
+require 'json'
+
+include Curses
+
+module Dog
+  class Viewer
+    def initialize
+      @map = Dog::Map.new
+
+      @first_time = @map.load
+      initialize_handlers
+
+      @topic   = Window.new(1,cols,0,0)
+
+      colwidth = (cols/2).ceil + 1
+      @left    = Window.new(lines/3, colwidth, 1, 0)
+      @right   = Window.new(lines/3, colwidth, 1, cols-colwidth)
+
+      @link    = Window.new(1,cols,lines/3+1,0)
+      @preview = Window.new(lines - lines/3 - 3,cols,lines/3+2,0)
+      @status  = Window.new(1,cols,lines-1,0)
+    end
+
+    def initialize_handlers
+      if !load_handlers
+        @link_handlers = {
+          ".txt$" => {
+            "preview" => "cat %%",
+            "open" => "${EDITOR:-vim} %%"
+          },
+          "/$" => {
+            "preview" => "ls -lah %%",
+            "open" => "${EDITOR:-vim} %%"
+          },
+          "^http" => {
+            "preview" => "echo \"WIP!\"",
+            "open" => "lynx %%"
+            # "preview" => ->(x) {
+            #   md5 = Digest::MD5.hexdigest(x)
+            #   uri = URI(x)
+
+            #   if !Dir.exist?("#{Dir.home}/.dog/cache/#{md5}")
+            #     @preview.setpos(0,0)
+            #     @preview.addstr("caching html and loading preview...")
+            #     @preview.refresh
+
+            #     FileUtils.mkdir_p "#{Dir.home}/.dog/cache/#{md5}"
+            #     `wget -P #{Dir.home}/.dog/cache/#{md5} -p -q -k #{x} -U "Mozilla/5.0 (X11; Fedora; Linux x86_64; rv:52.0) Gecko/20100101 Firefox/52.0"`
+            #   end
+
+            #   @preview.setpos(0,0)
+            #   @preview.addstr(`lynx #{Dir.home}/.dog/cache/#{md5}/#{uri.host}/#{uri.path} -dump -force_html`)
+            # },
+            # "open" => ->(x) {
+            #   md5 = Digest::MD5.hexdigest(x)
+            #   uri = URI(x)
+            #   system( "open -a /Applications/Firefox.app #{Dir.home}/.dog/cache/#{md5}/#{uri.host}/#{uri.path}" )
+            # }
+          }
+        }
+      end
+    end
+
+    def load_handlers
+      begin
+        data = YAML.load_file(HANDLERS_FILENAME)
+        @link_handlers = data if data
+      rescue Errno::ENOENT, Errno::ENOTDIR
+        return false
+      end
+      return true
+    end
+
+    def save_handlers
+      File.write(HANDLERS_FILENAME, @link_handlers.to_yaml)
+    end
+
+    def clear_window( window )
+      window.clear
+      if [@topic, @link, @status].include? window
+        window.box(' ', nil, ' ')
+      elsif [@left, @right].include? window
+        window.box(nil, ' ')
+      end
+    end
+
+    def resize
+      colwidth = (cols/2).ceil + 1
+
+      @topic.resize(1, cols)
+      @left.resize(lines/3, colwidth)
+      @right.resize(lines/3, colwidth)
+
+      @link.resize(1, cols)
+      @preview.resize(2*lines/3-2, cols)
+      @status.resize(1, cols)
+
+      @right.move(1, cols-colwidth)
+
+      @link.move(lines/3+1, 0)
+      @preview.move(lines/3+2, 0)
+      @status.move(lines-1, 0)
+
+      @windows.each do |window| window.refresh end
+      navigate( @map.topic_name )
+    end
+
+    def centerx( text = "" )
+      cols/2 - (text&.length || 0)/2
+    end
+
+    def add_menu_item( window, position, text )
+      window.setpos(position, 2)
+      window.attrset( window == @active_window && @active_item == position ? A_STANDOUT : A_NORMAL )
+      window.addstr( text )
+      window.attrset( A_NORMAL )
+    end
+
+    def setup_menu( window, location )
+      clear_window window
+      location&.each_with_index do |link, index|
+        add_menu_item( window, index, link["name"] )
+      end
+      window.refresh
+    end
+
+    def wrap_cursor
+      @active_item = @max_items - 1 if @active_item < 0
+      @active_item = 0 if @active_item >= @max_items
+    end
+
+    def active_link
+      wrap_cursor
+      if @max_items == 0
+        return nil
+      end
+
+      if @active_window == @left
+        @incoming[@active_item]["path"]
+      else
+        @map.path(index: @active_item)
+      end
+    end
+
+    def preview_active_file
+      preview_file( active_link )
+    end
+
+    def move_cursor( dir )
+      @active_item += dir
+
+      wrap_cursor
+
+      preview_active_file
+    end
+
+    def set_topic
+      show(@topic, @map.topic_name)
+    end
+
+    def swap_window
+      if @active_window == @left
+        @active_window = @right
+        @max_items = @map.count
+      else
+        if @incoming.length > 0
+          @active_window = @left
+          @max_items = @incoming.length
+        end
+      end
+      wrap_cursor
+      preview_active_file
+    end
+
+    def set_max_items
+      if @active_window == @left
+        @max_items = @incoming.length
+      else
+        @max_items = @map.count
+      end
+    end
+
+    def navigate( destination )
+      @incoming = @map.find_incoming_links(destination)
+
+      @map.navigate( destination )
+      refresh_display
+    end
+
+    def refresh_display
+      set_topic
+      setup_menu( @left, @incoming )
+      setup_menu( @right, @map.here )
+
+      if ( @incoming.length == 0 )
+        @active_window = @right
+      end
+      set_max_items
+
+      @active_item = 0
+
+      preview_file( active_link )
+    end
+
+    def show( window, text )
+      clear_window window
+
+      if window == @link || window == @topic || window == @status
+        text = " #{text} "
+        window.setpos(0, centerx(text))
+      elsif window == @preview
+        window.setpos(0, 0)
+      else
+        window.setpos(1, 1)
+      end
+
+      window.addstr text
+      window.refresh
+    end
+
+
+    def get_handler( filename )
+      @link_handlers.each do |regex, value|
+        if filename =~ Regexp.new(regex)
+          return value
+        end
+      end
+      return nil
+    end
+
+    def preview_file( filename )
+      if !filename || filename == ""
+        show(@link, "(empty!)")
+        clear_window @preview
+        @preview.refresh
+        return
+      end
+
+      show(@link, filename)
+
+      clear_window @preview
+
+      begin
+        handler = get_handler( filename )
+        if handler
+          @preview.setpos(0,0)
+          @preview.addstr(
+            `#{handler["preview"].gsub('%%',filename)}`
+          )
+        elsif filename[0] == '@'
+          if @map.has_topic?(filename)
+            @preview.setpos(0,0)
+            @preview.addstr(@map.link_names(filename).join("\n"))
+          else
+            @preview.setpos(0,0)
+            @preview.addstr("Topic not found! Open to create.")
+          end
+        else
+          @preview.setpos(0,0)
+          @preview.addstr("No matching preview handler found")
+        end
+      rescue => e
+        @preview.setpos(0,0)
+        @preview.addstr(" Error loading preview for #{filename}!\n#{e}")
+      end
+
+      @preview.refresh
+    end
+
+    def open( filename )
+      begin
+        handler = get_handler( filename )
+        if handler
+          system("#{handler["open"].gsub('%%',filename)}")
+          refresh_display
+        elsif filename[0] == '@'
+          navigate( filename )
+        else
+          @preview.setpos(0,0)
+          @preview.addstr("No matching open handler found")
+        end
+      rescue => e
+        @preview.setpos(0,0)
+        @preview.addstr(" Error opening #{filename}!\n#{e}")
+      end
+    end
+
+    def menu_loop
+      show(@status, "tab - next field | enter - commit | esc - cancel")
+      curs_set(1)
+      while fch = @preview.getch
+        begin
+          case fch
+          when KEY_RESIZE
+            resize
+          when 9
+            @form.driver(REQ_NEXT_FIELD)
+          when KEY_DOWN
+            @form.driver(REQ_NEXT_FIELD)
+          when 353
+            @form.driver(REQ_PREV_FIELD)
+          when KEY_UP
+            @form.driver(REQ_PREV_FIELD)
+          when 10
+            @form.driver(REQ_VALIDATION)
+            @form.unpost
+
+            if @editing
+              @map.replace(
+                name: @map.name(index: @active_item),
+                new_name: @name_field.buffer(0).strip,
+                new_path: @link_field.buffer(0).strip
+              )
+            else
+              @map.add(
+                name: @name_field.buffer(0).strip,
+                path: @link_field.buffer(0).strip
+              )
+            end
+            refresh_display
+            show(@status, "done")
+            break
+          when 127
+            @form.driver(REQ_DEL_PREV)
+          when KEY_LEFT
+            @form.driver(REQ_PREV_CHAR)
+          when KEY_RIGHT
+            @form.driver(REQ_NEXT_CHAR)
+          when 27
+            @form.unpost
+            refresh_display
+            show(@status, "cancelled")
+            break
+          else
+            fch.to_s.each_char do |letter|
+              @form.driver(letter)
+            end
+          end
+        rescue Curses::RequestDeniedError
+        end
+      end
+      curs_set(0)
+    end
+
+
+    def view
+      init_screen
+      start_color
+      curs_set(0)
+      noecho
+      cbreak
+
+      @preview.keypad(true)
+
+      @windows = [@topic, @left, @right, @link, @preview, @status]
+      @windows.each do |window|
+        clear_window window
+      end
+
+      @active_window = @right
+      @active_item = 0
+      @max_items = 0
+      @incoming = []
+
+      @name_field = Field.new( 1, cols - 4, 2, 2, 0, 0 )
+      @name_field.set_back(A_UNDERLINE)
+      @name_field.opts_off(O_BLANK | O_STATIC)
+      @link_field = Field.new( 1, cols - 4, 5, 2, 0, 0 )
+      @link_field.set_back(A_UNDERLINE)
+      @link_field.opts_off(O_BLANK | O_STATIC)
+
+      @form = Form.new( [@name_field, @link_field] )
+      @form.set_win @preview
+
+      @editing = false
+
+
+      refresh_display
+      show(@status, "woof! - press ? for help")
+
+      while ch = @right.getch
+        show(@status, "woof! - press ? for help")
+
+        case ch
+        when KEY_RESIZE
+          resize
+        when 's'
+          @map.save
+          save_handlers
+          show(@status, "saved!")
+        when 'J'
+          if @active_window == @right
+            @map.move_down(index: @active_item)
+            move_cursor( 1 )
+          end
+        when 'K'
+          if @active_window == @right
+            @map.move_up(index: @active_item)
+            move_cursor( -1 )
+          end
+        when 'j'
+          move_cursor( 1 )
+        when 'k'
+          move_cursor( -1 )
+        when 'h'
+          swap_window
+        when 'l'
+          swap_window
+        when ' '
+          open(active_link)
+        when '?'
+          show(@preview, HELP_TEXT)
+        when 'q'
+          break
+        when 'n'
+          clear_window @preview
+          @name_field.set_buffer(0, "")
+          @link_field.set_buffer(0, "")
+          @form.post
+          @preview.setpos(1,0)
+          @preview.addstr("name:")
+          @preview.setpos(4,0)
+          @preview.addstr("link:")
+          @preview.refresh
+          show(@link, "(new link)")
+
+          @editing = false
+
+          @form.driver(REQ_FIRST_FIELD)
+
+          menu_loop
+        when 'e'
+          if @active_window == @right
+            clear_window @preview
+            @name_field.set_buffer(0, @map.name(index: @active_item))
+            @link_field.set_buffer(0, @map.path(index: @active_item))
+            @form.post
+            @preview.setpos(1,0)
+            @preview.addstr("name:")
+            @preview.setpos(4,0)
+            @preview.addstr("link:")
+            @preview.refresh
+            show(@link, "(edit link)")
+
+            @editing = true
+
+            @form.driver(REQ_FIRST_FIELD)
+
+            menu_loop
+          end
+        when 'd'
+          if @active_window == @right
+            clear_window @preview
+            @preview.setpos(1,0)
+            @preview.addstr("really delete link \"#{@map.name(index: @active_item)}\"?")
+            @preview.setpos(3,0)
+            @preview.addstr("y / n")
+            @preview.refresh
+            if @preview.getch == 'y'
+              if active_link[0] == "@" && @map.find_incoming_links( active_link ).length == 1
+                target = @map.path(index: @active_item)
+                clear_window @preview
+                @preview.setpos(1,0)
+                @preview.addstr("this change strands the topic \"#{target}\".")
+                @preview.setpos(2,0)
+                @preview.addstr("do you want to delete that topic, too?")
+                @preview.setpos(3,0)
+                @preview.addstr("y / n")
+                @preview.refresh
+
+                if @preview.getch == 'y'
+                  @map.remove_topic(target)
+                end
+              end
+
+              @map.remove_link(name: @map.name(index: @active_item))
+            end
+            @max_items = @map.here.length
+            wrap_cursor
+            preview_active_file
+          end
+        end
+
+        if @active_window == @left
+          setup_menu( @right, @map.here )
+          setup_menu( @left, @incoming )
+        else
+          setup_menu( @left, @incoming )
+          setup_menu( @right, @map.here )
+        end
+        @status.refresh
+        @active_window.refresh
+      end
+
+    end
+  end
+end

data/lib/dog.rb

@@ -0,0 +1,20 @@
+require 'dog/viewer'
+require 'dog/map'
+
+module Dog
+  MAP_FILENAME = "#{Dir.home}/.dog/map.yaml"
+  HANDLERS_FILENAME = "#{Dir.home}/.dog/handlers.yaml"
+  WELCOME_TEXT = "welcome to dog! this is your home topic. you can create a new link by pressing [n].\n\n try making a link that points to \"@newtopic\" to create a new topic!"
+  HELP_TEXT = <<~EOS
+  hjkl - move cursor
+  space - open link
+  n - new link
+  e - edit link
+  d - delete link
+  K - move link up within topic
+  J - move link down within topic
+  s - save map
+  q - quit
+  ? - show this help!
+  EOS
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: dog
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- scout
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-22 00:00:00.000000000 Z
+dependencies: []
+description: Bookmark and organize local and remote files
+email: scout@bittybunny.com
+executables:
+- dog
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/dog
+- lib/dog.rb
+- lib/dog/map.rb
+- lib/dog/viewer.rb
+homepage: https://rubygems.org/gems/dog
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Digital OrGanizer
+test_files: []