twterm 2.1.0 → 2.2.0

data/lib/twterm/event/notification/list_member_added.rb

@@ -0,0 +1,33 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class ListMemberAdded < AbstractNotification
+        # @param [Twterm::List] list
+        def initialize(list)
+          @list = list
+        end
+
+        # @return [String] notification body
+        def body
+          list.description
+        end
+
+        # @return [String] notification title
+        def title
+          "You've been added to #{list.full_name}"
+        end
+
+        # @return [String] notification url
+        def url
+          list.url
+        end
+
+        private
+
+        attr_reader :list
+      end
+    end
+  end
+end

data/lib/twterm/event/notification/mention.rb

@@ -0,0 +1,35 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class Mention < AbstractNotification
+        # @param [Twterm::Status] status
+        # @param [Twterm::User] user
+        def initialize(status, user)
+          @status = status
+          @user = user
+        end
+
+        # @return [String] notification body
+        def body
+          status.text
+        end
+
+        # @return [String] notification title
+        def title
+          "@#{user.screen_name} has replied to your tweet"
+        end
+
+        # @return [String] notification url
+        def url
+          status.url
+        end
+
+        private
+
+        attr_reader :status, :user
+      end
+    end
+  end
+end

data/lib/twterm/event/notification/quote.rb

@@ -0,0 +1,35 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class Quote < AbstractNotification
+        # @param [Twterm::Status] status
+        # @param [Twterm::User] user
+        def initialize(status, user)
+          @status = status
+          @user = user
+        end
+
+        # @return [String] notification body
+        def body
+          status.text
+        end
+
+        # @return [String] notification title
+        def title
+          "@#{user.screen_name} has quoted your tweet"
+        end
+
+        # @return [String] notification url
+        def url
+          status.url
+        end
+
+        private
+
+        attr_reader :status, :user
+      end
+    end
+  end
+end

data/lib/twterm/event/notification/retweet.rb

@@ -0,0 +1,35 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class Retweet < AbstractNotification
+        # @param [Twterm::Status] status
+        # @param [Twterm::User] user
+        def initialize(status, user)
+          @status = status
+          @user = user
+        end
+
+        # @return [String] notification body
+        def body
+          status.text
+        end
+
+        # @return [String] notification title
+        def title
+          "@#{user.screen_name} has retweeted your tweet"
+        end
+
+        # @return [String] notification url
+        def url
+          status.url
+        end
+
+        private
+
+        attr_reader :status, :user
+      end
+    end
+  end
+end

data/lib/twterm/key_mapper/abstract_key_mapper.rb

@@ -23,6 +23,10 @@ module Twterm
         @mappings[key]
       end
 
+      def self.commands
+        self::DEFAULT_MAPPINGS.keys
+      end
+
       def to_h
         @dict
       end
@@ -49,10 +53,6 @@ module Twterm
           raise NoSuchKey.new(key)
         end
       end
-
-      def self.commands
-        self::DEFAULT_MAPPINGS.keys
-      end
     end
   end
 end

data/lib/twterm/list.rb

@@ -1,6 +1,6 @@
 module Twterm
   class List
-    attr_reader :id, :name, :slug, :full_name, :mode, :description, :member_count, :subscriber_count
+    attr_reader :id, :name, :slug, :full_name, :mode, :description, :member_count, :subscriber_count, :url
 
     def ==(other)
       other.is_a?(self.class) && id == other.id
@@ -19,6 +19,7 @@ module Twterm
       @description = list.description.is_a?(Twitter::NullObject) ? '' : list.description
       @member_count = list.member_count
       @subscriber_count = list.subscriber_count
+      @url = list.url
 
       self
     end

data/lib/twterm/message_window.rb

@@ -0,0 +1,81 @@
+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)
+      @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)
+          sleep 3
+          show
+        end
+      end
+    end
+
+    def show_info(message)
+      @queue.push(Event::Message::Info.new(message))
+      self
+    end
+
+    def show(message = nil)
+      loop do
+        break unless closed?
+        sleep 0.5
+      end
+
+      @window.clear
+
+      if message.is_a?(Event::Message::AbstractMessage)
+        fg_color, bg_color =
+          case message
+          when Event::Message::Error
+            [:white, :red]
+          when Event::Message::Info
+            [:black, :cyan]
+          when Event::Message::Success
+            [:black, :green]
+          when Event::Message::Warning
+            [:black, :yellow]
+          end
+
+        @window.with_color(fg_color, bg_color) do
+          @window.setpos(0, 0)
+          @window.addstr(' ' * @window.maxx)
+          @window.setpos(0, 1)
+          time = message.time.strftime('[%H:%M:%S]')
+          body = message.body.gsub("\n", ' ')
+          @window.addstr("#{time} #{body}")
+        end
+      end
+
+      @window.refresh
+    end
+
+    private
+
+    def queue(message)
+      @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/notification_backend/abstract_notification_backend.rb

@@ -0,0 +1,16 @@
+module Twterm
+  module NotificationBackend
+    # @abstract
+    class AbstractNotificationBackend
+      # @abstract
+      # @param [Twterm::Event::Notification::AbstractNotification] _notification a notification to show
+      def notify(_notification)
+        raise NotImplementedError, '`notify` method must be implemented'
+      end
+
+      private
+
+      attr_reader :app
+    end
+  end
+end

data/lib/twterm/notification_backend/inline_backend.rb

@@ -0,0 +1,20 @@
+require 'curses'
+
+require 'twterm/event/message/info'
+require 'twterm/notification_backend/abstract_notification_backend'
+require 'twterm/publisher'
+
+module Twterm
+  module NotificationBackend
+    class InlineBackend < AbstractNotificationBackend
+      include Publisher
+
+      # @param [Twterm::Event::Notification::AbstractNotification] notification
+      # @return [void]
+      def notify(notification)
+        message = Event::Message::Info.new(notification.fallback)
+        publish(message)
+      end
+    end
+  end
+end

data/lib/twterm/notification_backend/terminal_notifier_backend.rb

@@ -0,0 +1,23 @@
+require 'terminal-notifier'
+
+require 'twterm/notification_backend/abstract_notification_backend'
+
+module Twterm
+  module NotificationBackend
+    class TerminalNotifierBackend < AbstractNotificationBackend
+      # @param [Twterm::Event::Notification::AbstractNotification] notification notification to display via terminal-notifier
+      def notify(notification)
+        opts = {
+          title: 'twterm',
+          subtitle: notification.title,
+          group: Process.pid,
+          sound: 'Purr',
+        }
+
+        opts[:open] = notification.url unless notification.url.nil?
+
+        TerminalNotifier.notify(notification.body, opts)
+      end
+    end
+  end
+end

data/lib/twterm/notification_backend/tmux_backend.rb

@@ -0,0 +1,17 @@
+require 'shellwords'
+
+require 'twterm/notification_backend/abstract_notification_backend'
+
+module Twterm
+  module NotificationBackend
+    class TmuxBackend < AbstractNotificationBackend
+      # @param [Twterm::Event::Notification::AbstractNotification] notification notification to display in tmux status line
+      # @return [void]
+      def notify(notification)
+        `tmux set-option display-time 3000`
+        `tmux set-option message-style fg=black,bg=green`
+        `tmux display #{Shellwords.escape(" [twterm] #{notification.fallback.gsub("\n", ' ')}")}`
+      end
+    end
+  end
+end

data/lib/twterm/notification_dispatcher.rb

@@ -0,0 +1,36 @@
+require 'twterm/event/notification/abstract_notification'
+require 'twterm/notification_backend/inline_backend'
+require 'twterm/notification_backend/terminal_notifier_backend'
+require 'twterm/notification_backend/tmux_backend'
+require 'twterm/subscriber'
+
+module Twterm
+  class NotificationDispatcher
+    include Subscriber
+
+    # @param [Twterm::Preferences] preferences
+    def initialize(preferences)
+      @preferences = preferences
+
+      @backends = {
+        inline: NotificationBackend::InlineBackend.new,
+        terminal_notifier: NotificationBackend::TerminalNotifierBackend.new,
+        tmux: NotificationBackend::TmuxBackend.new,
+      }
+
+      subscribe(Event::Notification::AbstractNotification) { |n| dispatch(n) }
+    end
+
+    private
+
+    attr_reader :backends, :preferences
+
+    # @param [Twterm::Notification::AbstractNotification] notification notification to dispatch to backends
+    # @return [void]
+    def dispatch(notification)
+      backends.keys.each do |key|
+        backends[key].notify(notification) if preferences[:notification_backend, key]
+      end
+    end
+  end
+end

data/lib/twterm/persistable_configuration_proxy.rb

@@ -0,0 +1,82 @@
+require 'toml'
+
+module Twterm
+  class PersistableConfigurationProxy
+    # @param [Twterm::AbstractPersistableConfiguration] instance A configuration to persist
+    # @param [String] filepath File path to persist the given configuration
+    def initialize(instance, filepath)
+      @instance = instance
+      @filepath = filepath
+    end
+
+    def [](*args)
+      instance.[](*args)
+    end
+
+    def []=(*args)
+      instance.[]=(*args)
+      persist!
+    end
+
+    def self.getc
+      system('stty raw -echo')
+      STDIN.getc
+    ensure
+      system('stty -raw echo')
+    end
+
+    # Loads a configuration file from and returns a proxy.
+    # Falls back to the default value when the specified file does not exist.
+    #
+    # @param [Class] klass Must be a subclass of {Twterm::AbstractPersistableConfiguration}
+    # @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)
+      new(klass.new(config), filepath).migrate!
+    rescue Errno::ENOENT
+      new(klass.default, filepath)
+    rescue TOML::ParseError, TOML::ValueOverwriteError => e
+      msg =
+        case e
+        when TOML::ParseError
+          "Your configuration file could not be parsed"
+        when TOML::ValueOverwriteError
+          "`#{e.key}` is declared more than once"
+        end
+
+      warn <<-EOS
+\e[1mCould not load the configuration file: #{filepath}\e[0m
+(#{msg})
+
+Falling back to the default key assignments
+
+Check the syntax and edit the file manually,
+or remove it and launch twterm again to restore
+
+Press any key to continue
+  EOS
+
+      getc
+
+      new(klass.default, filepath)
+    end
+
+    # @return [self]
+    def migrate!
+      instance.complete_missing_items!
+      persist!
+
+      self
+    end
+
+    private
+
+    attr_reader :filepath, :instance
+
+    def persist!
+      hash = TOML.dump(instance.to_h).gsub("\n[", "\n\n[")
+      File.open(filepath, 'w', 0644) { |f| f.write(hash) }
+    end
+  end
+end