twterm 2.8.0 → 2.9.0

data/lib/twterm/color_manager.rb

@@ -1,18 +1,17 @@
 module Twterm
   class ColorManager
     include Singleton
-    include Curses
 
     COLORS = [:black, :white, :red, :green, :blue, :yellow, :cyan, :magenta, :transparent]
     CURSES_COLORS = {
-      black: COLOR_BLACK,
-      white: COLOR_WHITE,
-      red: COLOR_RED,
-      green: COLOR_GREEN,
-      blue: COLOR_BLUE,
-      yellow: COLOR_YELLOW,
-      cyan: COLOR_CYAN,
-      magenta: COLOR_MAGENTA,
+      black: Curses::COLOR_BLACK,
+      white: Curses::COLOR_WHITE,
+      red: Curses::COLOR_RED,
+      green: Curses::COLOR_GREEN,
+      blue: Curses::COLOR_BLUE,
+      yellow: Curses::COLOR_YELLOW,
+      cyan: Curses::COLOR_CYAN,
+      magenta: Curses::COLOR_MAGENTA,
       transparent: -1
     }
 

data/lib/twterm/image.rb

@@ -7,6 +7,7 @@ require 'twterm/image/empty'
 require 'twterm/image/horizontal_sequential_image'
 require 'twterm/image/parens'
 require 'twterm/image/string_image'
+require 'twterm/image/underlined'
 require 'twterm/image/vertical_sequential_image'
 
 class Twterm::Image
@@ -14,6 +15,10 @@ class Twterm::Image
     @column, @line = column, line
   end
 
+  def _
+    underlined
+  end
+
   def !
     bold
   end
@@ -101,6 +106,27 @@ class Twterm::Image
     StringImage.new(str)
   end
 
+  # @param items [Array<Symbol>]
+  # @param selected [Symbol]
+  #
+  # @return [Image]
+  def self.toggle_switch(items, selected)
+    items
+      .map do |item|
+        on = item == selected
+        string(item.to_s)
+          .bold(on)
+          .underlined(on)
+      end
+      .intersperse(string(' | '))
+      .reduce(empty) { |acc, x| acc - x }
+      .brackets
+  end
+
+  def underlined(on = true)
+    on ? Underlined.new(self) : self
+  end
+
   def self.whitespace
     string(' ')
   end

data/lib/twterm/image/underlined.rb

@@ -0,0 +1,31 @@
+module Twterm
+  class Image
+    class Underlined < Twterm::Image
+      def initialize(image)
+        @image = image
+      end
+
+      def height
+        image.height
+      end
+
+      def render(window)
+        window.attron(Curses::A_UNDERLINE)
+        image.at(line, column).render(window)
+        window.attroff(Curses::A_UNDERLINE)
+      end
+
+      def to_s
+        "\e[4m#{image}\e[0m"
+      end
+
+      def width
+        image.width
+      end
+
+      private
+
+      attr_reader :image
+    end
+  end
+end

data/lib/twterm/image_builder/user_name_image_builder.rb

@@ -1,6 +1,7 @@
 require 'twterm/image'
 
 module Twterm
+  # @todo Rename to `Presenter`
   module ImageBuilder
     class UserNameImageBuilder
       COLORS = [:red, :blue, :green, :cyan, :yellow, :magenta].freeze

data/lib/twterm/key_mapper.rb

@@ -1,4 +1,4 @@
-require 'toml'
+require 'toml-rb'
 require 'singleton'
 
 require 'twterm/app'
@@ -105,14 +105,12 @@ module Twterm
     end
 
     def load_dict_file!
-      dict = TOML.load_file(dict_file_path, symbolize_keys: true)
-    rescue TOML::ParseError, TOML::ValueOverwriteError => e
+      dict = TomlRB.load_file(dict_file_path, symbolize_keys: true)
+    rescue TomlRB::ParseError => e
       first_line =
         case e
-        when TOML::ParseError
-          "Your key assignments dictionary file (#{dict_file_path}) could not be parsed"
-        when TOML::ValueOverwriteError
-          "Command `#{e.key}` is declared more than once"
+        when TomlRB::ParseError
+          "Your key assignments dictionary file (#{dict_file_path}) could not be parsed:\n#{e.message}"
         end
 
       warn <<-EOS
@@ -132,7 +130,7 @@ Press any key to continue
     end
 
     def save!(mappings)
-      dict = TOML.dump(mappings).gsub("\n[", "\n\n[")
+      dict = TomlRB.dump(mappings).gsub("\n[", "\n\n[")
       File.open(dict_file_path, 'w', 0644) { |f| f.write(dict) }
     end
   end

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

@@ -5,11 +5,10 @@ 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)
+      @window = Curses.stdscr.subwin(1, Curses.stdscr.maxx, Curses.stdscr.maxy - 1, 0)
       @queue = Queue.new
 
       subscribe(Event::Message::AbstractMessage) do |e|
@@ -34,7 +33,7 @@ module Twterm
 
     def show(message = nil)
       loop do
-        break unless closed?
+        break unless Curses.closed?
         sleep 0.5
       end
 
@@ -74,8 +73,8 @@ module Twterm
     end
 
     def resize(_event)
-      @window.resize(1, stdscr.maxx)
-      @window.move(stdscr.maxy - 2, 0)
+      @window.resize(1, Curses.stdscr.maxx)
+      @window.move(Curses.stdscr.maxy - 1, 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/screen.rb

@@ -6,18 +6,18 @@ require 'twterm/subscriber'
 module Twterm
   class Screen
     include Subscriber
-    include Curses
 
     def initialize(app, client)
       @app, @client = app, client
 
-      @screen = init_screen
-      noecho
-      raw
-      curs_set(0)
-      stdscr.keypad(true)
-      start_color
-      use_default_colors
+      @screen = Curses.init_screen
+      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)
@@ -53,6 +53,42 @@ module Twterm
 
     attr_reader :app, :client
 
+    # @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
+
+    # @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
+
     def refresh
       app.tab_manager.refresh_window
       app.tab_manager.current_tab.render
@@ -60,10 +96,10 @@ module Twterm
     end
 
     def resize(event)
-      return if closed?
+      return if Curses.closed?
 
       lines, cols = event.lines, event.cols
-      resizeterm(lines, cols)
+      Curses.resizeterm(lines, cols)
       @screen.resize(lines, cols)
 
       refresh
@@ -72,11 +108,15 @@ module Twterm
     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

@@ -3,7 +3,6 @@ require 'twterm/subscriber'
 
 module Twterm
   class SearchQueryWindow
-    include Curses
     include Singleton
     include Subscriber
 
@@ -12,7 +11,7 @@ module Twterm
     attr_reader :last_query
 
     def initialize
-      @window = stdscr.subwin(1, stdscr.maxx, stdscr.maxy - 1, 0)
+      @window = Curses.stdscr.subwin(1, Curses.stdscr.maxx, Curses.stdscr.maxy - 1, 0)
       @searching_down = true
       @str = ''
       @last_query = ''
@@ -29,7 +28,7 @@ module Twterm
       chars = []
 
       loop do
-        char = getch
+        char = Curses.getch
 
         if char.nil?
           case chars.first
@@ -117,8 +116,8 @@ module Twterm
     attr_reader :window
 
     def resize(_event)
-      window.resize(1, stdscr.maxx)
-      window.move(stdscr.maxy - 1, 0)
+      window.resize(1, Curses.stdscr.maxx)
+      window.move(Curses.stdscr.maxy - 1, 0)
     end
 
     def render(str)

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