twterm 2.5.1 → 2.10.0

data/lib/twterm/list.rb

@@ -1,7 +1,41 @@
 module Twterm
+  # A Twitter list
   class List
-    attr_reader :id, :name, :slug, :full_name, :mode, :description, :member_count, :subscriber_count, :url
+    # Unique ID of the list
+    #
+    # @return [Integer]
+    attr_reader :id
 
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :slug
+
+    # @return [String]
+    attr_reader :full_name
+
+    attr_reader :mode
+
+    # @return [String]
+    attr_reader :description
+
+    # The number of users that are in this list
+    #
+    # @return [Integer]
+    attr_reader :member_count
+
+    # The number of users that subscribe this list
+    #
+    # @return [Integer]
+    attr_reader :subscriber_count
+
+    # @return [String]
+    attr_reader :url
+
+    # @param other [List]
+    #
+    # @return [Boolean]
     def ==(other)
       other.is_a?(self.class) && id == other.id
     end
@@ -11,6 +45,7 @@ module Twterm
       update!(list)
     end
 
+    # @return [self]
     def update!(list)
       @name = list.name
       @slug = list.slug

data/lib/twterm/message_window.rb

@@ -1,23 +1,19 @@
 require 'twterm/subscriber'
 require 'twterm/event/message/abstract_message'
-require 'twterm/event/screen/resize'
 
 module Twterm
   class MessageWindow
-    include Singleton
-    include Curses
     include Subscriber
 
-    def initialize
-      @window = stdscr.subwin(1, stdscr.maxx, stdscr.maxy - 2, 0)
+    # @param window [Curses::Window]
+    def initialize(window)
+      @window = window
       @queue = Queue.new
 
       subscribe(Event::Message::AbstractMessage) do |e|
         queue(e)
       end
 
-      subscribe(Event::Screen::Resize, :resize)
-
       Thread.new do
         while message = @queue.pop # rubocop:disable Lint/AssignmentInCondition:
           show(message)
@@ -34,7 +30,7 @@ module Twterm
 
     def show(message = nil)
       loop do
-        break unless closed?
+        break unless Curses.closed?
         sleep 0.5
       end
 
@@ -72,10 +68,5 @@ module Twterm
       @queue.push(message)
       self
     end
-
-    def resize(_event)
-      @window.resize(1, stdscr.maxx)
-      @window.move(stdscr.maxy - 2, 0)
-    end
   end
 end

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/rest_client.rb

@@ -1,6 +1,4 @@
 require 'concurrent'
-require 'twterm/direct_message'
-require 'twterm/direct_message_manager'
 require 'twterm/publisher'
 require 'twterm/event/message/success'
 
@@ -25,33 +23,6 @@ module Twterm
       end
     end
 
-    def create_direct_message(recipient, text)
-      send_request do
-        rest_client.create_direct_message(recipient.id, text)
-      end.then do |message|
-        msg = direct_message_repository.create(message)
-        direct_message_manager.add(recipient.id, msg)
-        publish(Event::DirectMessage::Fetched.new)
-        publish(Event::Message::Success.new('Your message to @%s has been sent' % recipient.screen_name))
-      end
-    end
-
-    def direct_message_conversations
-      direct_message_manager.conversations
-    end
-
-    def direct_messages_received
-      send_request do
-        rest_client.direct_messages(count: 200).map { |dm| direct_message_repository.create(dm) }
-      end
-    end
-
-    def direct_messages_sent
-      send_request do
-        rest_client.direct_messages_sent(count: 200).map { |dm| direct_message_repository.create(dm) }
-      end
-    end
-
     def destroy_status(status)
       send_request_without_catch do
         rest_client.destroy_status(status.id)
@@ -424,10 +395,6 @@ module Twterm
 
     private
 
-    def direct_message_manager
-      @direct_message_manager ||= DirectMessageManager.new(self)
-    end
-
     def show_error
       proc do |e|
         case e

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 - 1, 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