twterm 2.7.0 → 2.10.2

data/lib/twterm/persistable_configuration_proxy.rb

@@ -1,4 +1,4 @@
-require 'toml'
+require 'toml-rb'
 
 module Twterm
   class PersistableConfigurationProxy
@@ -32,16 +32,16 @@ module Twterm
     # @param [String] filepath File path to load configuration from
     # @return [Twterm::PersistableConfigurationProxy] a configuration proxy
     def self.load_from_file!(klass, filepath)
-      config = TOML.load_file(filepath, symbolize_keys: true)
+      config = TomlRB.load_file(filepath, symbolize_keys: true)
       new(klass.new(config), filepath).migrate!
     rescue Errno::ENOENT
       new(klass.default, filepath)
-    rescue TOML::ParseError, TOML::ValueOverwriteError => e
+    rescue TomlRB::ParseError, TomlRB::ValueOverwriteError => e
       msg =
         case e
-        when TOML::ParseError
+        when TomlRB::ParseError
           "Your configuration file could not be parsed"
-        when TOML::ValueOverwriteError
+        when TomlRB::ValueOverwriteError
           "`#{e.key}` is declared more than once"
         end
 
@@ -75,7 +75,7 @@ Press any key to continue
     attr_reader :filepath, :instance
 
     def persist!
-      hash = TOML.dump(instance.to_h).gsub("\n[", "\n\n[")
+      hash = TomlRB.dump(instance.to_h).gsub("\n[", "\n\n[")
       File.open(filepath, 'w', 0644) { |f| f.write(hash) }
     end
   end

data/lib/twterm/preferences.rb

@@ -1,4 +1,4 @@
-require 'toml'
+require 'toml-rb'
 
 require 'twterm/abstract_persistable_configuration'
 
@@ -27,6 +27,9 @@ module Twterm
     # @return [Twterm::Preferences] an instance having the default value
     def self.default
       new({
+        control: {
+          scroll_direction: 'traditional',
+        },
         photo_viewer_backend: {
           browser: true,
           imgcat: false,
@@ -48,8 +51,12 @@ module Twterm
     # @return [Hash]
     def self.structure
       bool = -> x { x == true || x == false }
+      scroll_direction = -> x { x == 'natural' || x == 'traditional' }
 
       {
+        control: {
+          scroll_direction: scroll_direction
+        },
         photo_viewer_backend: {
           browser: bool,
           imgcat: bool,

data/lib/twterm/screen.rb

@@ -1,26 +1,74 @@
 require 'twterm/event/screen/refresh'
-require 'twterm/event/screen/resize'
 require 'twterm/key_mapper'
 require 'twterm/subscriber'
 
 module Twterm
   class Screen
     include Subscriber
-    include Curses
+
+    # @todo Make private
+    # @return [Curses::Window]
+    attr_reader :tab_manager_window
+
+    # @todo Make private
+    # @return [Curses::Window]
+    attr_reader :tab_window
+
+    # @todo Make private
+    # @return [Curses::Window]
+    attr_reader :message_window_window
+
+    # @todo Make private
+    # @return [Curses::Window]
+    attr_reader :search_query_window_window
 
     def initialize(app, client)
       @app, @client = app, client
 
-      @screen = init_screen
-      noecho
-      raw
-      curs_set(0)
-      stdscr.keypad(true)
-      start_color
-      use_default_colors
+      @stdscr = Curses.init_screen
+
+      width = @stdscr.maxx
+      height = @stdscr.maxy
+
+      @tab_manager_window = @stdscr.subwin(1, width, 0, 0)
+      @tab_window = @stdscr.subwin(height - 3, width, 2, 0)
+      @message_window_window = @stdscr.subwin(1, width, height - 2, 0)
+      @search_query_window_window = @stdscr.subwin(1, width, height - 1, 0)
+
+      Curses.noecho
+      Curses.raw
+      Curses.curs_set(0)
+      Curses.stdscr.keypad(true)
+      Curses.start_color
+      Curses.use_default_colors
+      Curses.mousemask(Curses::BUTTON1_CLICKED | 65536 | 2097152)
 
       subscribe(Event::Screen::Refresh) { refresh }
-      subscribe(Event::Screen::Resize, :resize)
+    end
+
+    def resize(lines, cols)
+      return if Curses.closed?
+
+      Curses.resizeterm(lines, cols)
+      @stdscr.resize(lines, cols)
+
+      tab_manager_window.move(0, 0)
+      tab_manager_window.resize(1, cols)
+      tab_manager_window.refresh
+
+      tab_window.move(2, 0)
+      tab_window.resize(lines - 3, cols)
+      tab_window.refresh
+
+      message_window_window.move(cols - 1, 0)
+      message_window_window.resize(1, cols)
+      message_window_window.refresh
+
+      search_query_window_window.move(cols - 1, 0)
+      search_query_window_window.resize(1, cols)
+      search_query_window_window.refresh
+
+      refresh
     end
 
     def respond_to_key(key)
@@ -53,30 +101,60 @@ module Twterm
 
     attr_reader :app, :client
 
-    def refresh
-      app.tab_manager.refresh_window
-      app.tab_manager.current_tab.render
-      MessageWindow.instance.show
+    # @param [Integer, String] key
+    def handle_keyboard_event(key)
+      return if app.tab_manager.current_tab.respond_to_key(key)
+      return if app.tab_manager.respond_to_key(key)
+      respond_to_key(key)
     end
 
-    def resize(event)
-      return if closed?
-
-      lines, cols = event.lines, event.cols
-      resizeterm(lines, cols)
-      @screen.resize(lines, cols)
+    # @param [Curses::MouseEvent] e
+    def handle_mouse_event(e)
+      x = e.x
+      y = e.y
+
+      case e.bstate
+      when Curses::BUTTON1_CLICKED
+        return app.tab_manager.handle_left_click(x, y) if app.tab_manager.enclose?(x, y)
+      when 65536
+        scroll_direction = app.preferences[:control, :scroll_direction]
+
+        case scroll_direction
+        when 'natural'
+          return app.tab_manager.handle_scroll_up(x, y) if app.tab_manager.enclose?(x, y)
+        when 'traditional'
+          return app.tab_manager.handle_scroll_down(x, y) if app.tab_manager.enclose?(x, y)
+        end
+      when 2097152
+        scroll_direction = app.preferences[:control, :scroll_direction]
+
+        case scroll_direction
+        when 'natural'
+          return app.tab_manager.handle_scroll_down(x, y) if app.tab_manager.enclose?(x, y)
+        when 'traditional'
+          return app.tab_manager.handle_scroll_up(x, y) if app.tab_manager.enclose?(x, y)
+        end
+      end
+    end
 
-      refresh
+    def refresh
+      app.tab_manager.refresh_window
+      app.tab_manager.current_tab.render
+      app.message_window.show
     end
 
     def scan
       app.reset_interruption_handler
 
-      key = getch
+      key = Curses.getch
 
-      return if app.tab_manager.current_tab.respond_to_key(key)
-      return if app.tab_manager.respond_to_key(key)
-      respond_to_key(key)
+      if key == Curses::Key::MOUSE
+        e = Curses.getmouse
+
+        handle_mouse_event(e) unless e.nil?
+      else
+        handle_keyboard_event(key)
+      end
     end
   end
 end

data/lib/twterm/search_query_window.rb

@@ -1,23 +1,19 @@
-require 'twterm/event/screen/resize'
 require 'twterm/subscriber'
 
 module Twterm
   class SearchQueryWindow
-    include Curses
-    include Singleton
     include Subscriber
 
     class CancelInput < StandardError; end
 
     attr_reader :last_query
 
-    def initialize
-      @window = stdscr.subwin(1, stdscr.maxx, stdscr.maxy - 1, 0)
+    # @param window [Curses::Window]
+    def initialize(window)
+      @window = window
       @searching_down = true
       @str = ''
       @last_query = ''
-
-      subscribe(Event::Screen::Resize, :resize)
     end
 
     def input
@@ -29,7 +25,7 @@ module Twterm
       chars = []
 
       loop do
-        char = getch
+        char = Curses.getch
 
         if char.nil?
           case chars.first
@@ -114,13 +110,9 @@ module Twterm
 
     private
 
+    # @return [Curses::Window]
     attr_reader :window
 
-    def resize(_event)
-      window.resize(1, stdscr.maxx)
-      window.move(stdscr.maxy - 1, 0)
-    end
-
     def render(str)
       window.clear
       window.setpos(0, 0)

data/lib/twterm/status.rb

@@ -12,6 +12,7 @@ class Twitter::Tweet
 end
 
 module Twterm
+  # A tweet
   class Status
     attr_reader :created_at, :favorite_count, :favorited, :hashtags, :id,
       :in_reply_to_status_id, :media, :retweet_count, :retweeted,
@@ -23,11 +24,13 @@ module Twterm
       other.is_a?(self.class) && id == other.id
     end
 
+    # @todo This should be done in a presenter
     def date
       format = Time.now - @created_at < 86_400 ? '%H:%M:%S' : '%Y-%m-%d %H:%M:%S'
       @created_at.strftime(format)
     end
 
+    # @todo This can be marked as private
     def expand_url!
       sub = -> (x) { @text.sub!(x.url, x.display_url) }
       (@media + @urls).each(&sub)
@@ -69,10 +72,16 @@ module Twterm
       expand_url!
     end
 
+    # Is this status a quote?
+    #
+    # @return [Boolean]
     def quote?
       !quoted_status_id.nil?
     end
 
+    # Is this status a retweet?
+    #
+    # @return [Boolean]
     def retweet?
       !retweeted_status_id.nil?
     end
@@ -93,6 +102,7 @@ module Twterm
       @retweeted = false
     end
 
+    # @return [self]
     def update!(tweet, is_retweeted_status = false)
       @retweet_count = tweet.retweet_count
       @favorite_count = tweet.favorite_count

data/lib/twterm/tab/abstract_tab.rb

@@ -1,26 +1,31 @@
 require 'concurrent'
 
-require 'twterm/event/screen/resize'
 require 'twterm/image'
 require 'twterm/subscriber'
 
 module Twterm
   module Tab
     class AbstractTab
-      include Curses
       include Subscriber
 
-      attr_reader :window, :title
+      # @return [String]
+      attr_reader :title
 
+      # @param other [Twterm::Tab::AbstractTab]
+      #
+      # @return [Boolean]
       def ==(other)
         self.equal?(other)
       end
 
+      # @return [void]
       def close
         unsubscribe
-        window.close
       end
 
+      # A utility method to find a status by its ID
+      #
+      # @return [Concurrent::Promise<Twterm::Status>]
       def find_or_fetch_status(id)
         status = app.status_repository.find(id)
 
@@ -31,6 +36,9 @@ module Twterm
         end
       end
 
+      # A utility method to find a list by their ID
+      #
+      # @return [Concurrent::Promise<Twterm::List>]
       def find_or_fetch_list(id)
         list = app.list_repository.find(id)
 
@@ -41,6 +49,9 @@ module Twterm
         end
       end
 
+      # A utility method to find a user by their id
+      #
+      # @return [Concurrent::Promise<Twterm::User>]
       def find_or_fetch_user(id)
         user = app.user_repository.find(id)
 
@@ -53,10 +64,6 @@ module Twterm
 
       def initialize(app, client)
         @app, @client = app, client
-
-        @window = stdscr.subwin(stdscr.maxy - 5, stdscr.maxx, 3, 0)
-
-        subscribe(Event::Screen::Resize, :resize)
       end
 
       def render
@@ -72,7 +79,7 @@ module Twterm
               end
             end
 
-            view.at(1, 2).render
+            view.render
           end if refreshable?
         end
       end
@@ -88,8 +95,13 @@ module Twterm
 
       private
 
-      attr_reader :app, :client
+      # @return [Twterm::App]
+      attr_reader :app
 
+      # @return [Twterm::Client]
+      attr_reader :client
+
+      # @return [Twterm::Image]
       def image
         Image.string('view method is not implemented')
       end
@@ -98,22 +110,24 @@ module Twterm
         @refresh_mutex ||= Mutex.new
       end
 
+      # @return [Boolean]
       def refreshable?
         !(
           refresh_mutex.locked? ||
-            closed? ||
+            Curses.closed? ||
             app.tab_manager.current_tab.object_id != object_id
         )
       end
 
-      def resize(_event)
-        window.resize(stdscr.maxy - 5, stdscr.maxx)
-        window.move(3, 0)
-      end
-
+      # @return [Twterm::View]
       def view
         View.new(window, image)
       end
+
+      # @todo This method is for transition. `window` should explicitly be obtained on initialization.
+      def window
+        app.screen.tab_window
+      end
     end
   end
 end

data/lib/twterm/tab/new/search.rb

@@ -32,13 +32,13 @@ module Twterm
 
         def invoke_input
           resetter = proc do
-            reset_prog_mode
+            Curses.reset_prog_mode
             sleep 0.1
             publish(Event::Screen::Refresh.new)
           end
 
           input_thread = Thread.new do
-            close_screen
+            Curses.close_screen
             app.completion_manager.set_search_mode!
             puts "\ninput search query"
             query = (readline('> ', true) || '').strip