twterm 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a822edd0e5719ca957ab183b1859bd6ec01113ca
-  data.tar.gz: ecec2ab95f599a575226d0a3239f1b93ef63a4f9
+SHA256:
+  metadata.gz: bce2d4276a631793204a44044b38afaa43f02d2c16bcc6daf68653288d1c5e12
+  data.tar.gz: e1307f6b9623eb96f2659406377888283d5a912fd30caf0d20737852a62e9b9c
 SHA512:
-  metadata.gz: 1608685c830f8f614bc6549b498c271b7851deb05ee2e7054b62857ff89dae64f0d17f9f3d1fc22338493644aa35c9d4beb78c7ee2f6054eecd939108255d216
-  data.tar.gz: f188471c3974d031c257b2a6fd9169926d1350b663d4b71ce4ee180d20e6d63a2a61657c1755e019c01ca38f1402493d386b53cb4e4e90b752051969e184ecf0
+  metadata.gz: 43c9cce69344a7e7cc8107793bc79f133ffe1ff134ec422eacbae4ae449661c0b57e7f6b15a241bb5d69db4c58d6bc22065badc9b85f1203bc29e130d8711fb9
+  data.tar.gz: fdad1dfb3aff8e7f66a94d00db63e5bd3d1e274072c17664e23ebb3de0a38dc26ebc2f9229f8172b14e84c1d71971cea05aba7ca9133eb7f537f03c33dbc8508

data/.travis.yml

@@ -5,5 +5,8 @@ rvm:
   - 2.2
   - 2.3.0
   - 2.4.0
+  - 2.5.0
 
-script: bundle exec rspec
+before_install: gem update --system
+
+script: bundle exec rubocop --parallel --fail-level warning && bundle exec rspec

data/lib/twterm.rb

@@ -26,7 +26,7 @@ require 'twterm/extensions/string'
 require 'twterm/search_query_window'
 require 'twterm/friendship'
 require 'twterm/list'
-require 'twterm/notifier'
+require 'twterm/message_window'
 require 'twterm/screen'
 require 'twterm/scheduler'
 require 'twterm/status'

data/lib/twterm/abstract_persistable_configuration.rb

@@ -0,0 +1,118 @@
+module Twterm
+  # @abstract
+  class AbstractPersistableConfiguration
+    # @param [Hash<Symbol, Object>] configuration A hash object to initialize configuration
+    def initialize(configuration = {})
+      @configuration = configuration
+    end
+
+    # Gets a value associated to the given key.
+    # @abstract
+    def [](*)
+      raise NotImplementedError, '`#[]` method must be implemented'
+    end
+
+    # Sets the given value to the given key.
+    # @abstract
+    def []=(*)
+      raise NotImplementedError, '`#[]=` method must be implemented'
+    end
+
+    # Returns the default instance for the configuration.
+    # @abstract
+    def self.default
+      raise NotImplementedError, '`.default` method must be implemented'
+    end
+
+    # @return [Boolean]
+    def self.has_same_structure?
+      true
+    end
+
+    # @return [self]
+    def complete_missing_items!
+      traverse(self.class.default.to_h) do |path, default_value|
+        value = dig(configuration, path)
+
+        if value.nil? || !(dig!(self.class.structure, path) === value)
+          bury!(path, default_value)
+        end
+      end
+
+      self
+    end
+
+    # Converts to a hash object.
+    #
+    # @abstract
+    # @return [Hash] Configuration as a hash
+    def to_h
+      raise NotImplementedError, '`#to_h` method must be implemented'
+    end
+
+    # A tree-like object representing the structure of the configuration.
+    # Each node must respond to {#===} method which determines whether a value is acceptable.
+    #
+    # @abstract
+    # @return [Hash] A tree-like hash object
+    def self.structure
+      raise NotImplementedError, '`.structure` method must be implemented'
+    end
+
+    private
+
+    attr_reader :configuration
+
+    def bury!(path, value)
+      go = lambda do |hash, rest_path|
+        k, *ks = rest_path
+
+        if ks.empty?
+          hash[k] = value
+        else
+          hash[k] = {} unless hash[k].is_a?(Hash)
+          go.call(hash[k], ks)
+        end
+      end
+
+      go.call(configuration, path)
+
+      configuration
+    end
+
+    def dig(hash, path)
+      k, *ks = path
+      ks.empty? ? hash[k] : dig(hash[k], ks)
+    rescue NoMethodError
+      nil
+    end
+
+    def dig!(hash, path)
+      k, *ks = path
+      ks.empty? ? hash[k] : dig(hash[k], ks)
+    rescue NoMethodError
+      raise ArgumentError, "path #{path} not found for hash #{hash}"
+    end
+
+    # Traverses tree-like {Hash} object and calls the given block on every node with its path
+    #
+    # @yieldparam [Array<Symbol>] path the path of the current node
+    # @yieldparam [Object] v the value of the current node
+    # @yieldreturn [void]
+    def traverse(tree, &f)
+      go = lambda do |subtree, current_path|
+        subtree.each do |k, v|
+          path = [*current_path, k]
+
+          if v.is_a?(Hash)
+            go.call(v, path)
+          else
+            f.call(path, v)
+          end
+        end
+      end
+
+      go.call(tree, [])
+    end
+  end
+end

data/lib/twterm/app.rb

@@ -2,7 +2,12 @@ require 'curses'
 
 require 'twterm/completion_manager'
 require 'twterm/direct_message_composer'
+require 'twterm/environment'
 require 'twterm/event/screen/resize'
+require 'twterm/message_window'
+require 'twterm/notification_dispatcher'
+require 'twterm/persistable_configuration_proxy'
+require 'twterm/preferences'
 require 'twterm/repository/direct_message_repository'
 require 'twterm/repository/friendship_repository'
 require 'twterm/repository/hashtag_repository'
@@ -17,10 +22,20 @@ module Twterm
   class App
     include Publisher
 
-    attr_reader :screen
+    attr_reader :environment, :preferences, :screen
 
     DATA_DIR = "#{ENV['HOME']}/.twterm".freeze
 
+    def initialize
+      @environment = Environment.new
+      @preferences = Preferences.default
+    end
+
+    def load_preferences_from_file!
+      @preferences = PersistableConfigurationProxy
+        .load_from_file!(Preferences, "#{DATA_DIR}/preferences.toml")
+    end
+
     def completion_manager
       @completion_manager ||= CompletionManager.new(self)
     end
@@ -50,11 +65,16 @@ module Twterm
 
       Auth.authenticate_user(config) if config[:user_id].nil?
 
+      load_preferences_from_file!
+
       KeyMapper.instance
 
       @screen = Screen.new(self, client)
 
       SearchQueryWindow.instance
+      MessageWindow.instance
+
+      @notification_dispatcher = NotificationDispatcher.new(preferences)
 
       timeline = Tab::Statuses::Home.new(self, client)
       tab_manager.add_and_show(timeline)

data/lib/twterm/environment.rb

@@ -0,0 +1,38 @@
+require 'terminal-notifier'
+
+module Twterm
+  class Environment
+    def initialize
+      @uname = `uname`.strip
+
+      @terminal_notifier_available = TerminalNotifier.available?
+      @with_eog = system('which eog 2>&1 >/dev/null')
+      @with_tmux = system('which tmux 2>&1 >/dev/null') && !ENV['TMUX'].nil?
+      @with_qlmanage = system('which qlmanage 2>&1 >/dev/null')
+    end
+
+    def darwin?
+      @uname == 'Darwin'
+    end
+
+    def linux?
+      @uname == 'Linux'
+    end
+
+    def terminal_notifier_available?
+      @terminal_notifier_available
+    end
+
+    def with_eog?
+      @with_eog
+    end
+
+    def with_qlmanage?
+      @with_qlmanage
+    end
+
+    def with_tmux?
+      @with_tmux
+    end
+  end
+end

data/lib/twterm/event/message/abstract_message.rb

@@ -0,0 +1,23 @@
+require 'twterm/event/base'
+
+module Twterm
+  module Event
+    module Message
+      class AbstractMessage < Twterm::Event::Base
+        attr_reader :time
+
+        def initialize(message)
+          super(CGI.unescapeHTML(message))
+
+          @time = Time.now
+        end
+
+        def fields
+          {
+            body: String
+          }
+        end
+      end
+    end
+  end
+end

data/lib/twterm/event/message/error.rb

@@ -0,0 +1,10 @@
+require 'twterm/event/message/abstract_message'
+
+module Twterm
+  module Event
+    module Message
+      class Error < AbstractMessage
+      end
+    end
+  end
+end

data/lib/twterm/event/message/info.rb

@@ -0,0 +1,10 @@
+require 'twterm/event/message/abstract_message'
+
+module Twterm
+  module Event
+    module Message
+      class Info < AbstractMessage
+      end
+    end
+  end
+end

data/lib/twterm/event/message/success.rb

@@ -0,0 +1,10 @@
+require 'twterm/event/message/abstract_message'
+
+module Twterm
+  module Event
+    module Message
+      class Success < AbstractMessage
+      end
+    end
+  end
+end

data/lib/twterm/event/message/warning.rb

@@ -0,0 +1,10 @@
+require 'twterm/event/message/abstract_message'
+
+module Twterm
+  module Event
+    module Message
+      class Warning < AbstractMessage
+      end
+    end
+  end
+end

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

@@ -3,23 +3,28 @@ require 'twterm/event/base'
 module Twterm
   module Event
     module Notification
-      class AbstractNotification < Twterm::Event::Base
-        attr_reader :time
-
-        def initialize(message)
-          super(CGI.unescapeHTML(message))
+      # @abstract
+      class AbstractNotification < Event::Base
+        # @abstract
+        # @return [String] notification body
+        def body
+          raise NotImplementedError, '`body` must be implemented'
+        end
 
-          @time = Time.now
+        # @return [String] a fallback text
+        def fallback
+          "#{title}: #{body}"
         end
 
-        def fields
-          {
-            message: String
-          }
+        # @abstract
+        # @return [String] notification title
+        def title
+          raise NotImplementedError, '`fallback` must be implemented'
         end
 
-        def color
-          raise NotImplementedError, 'color method must be overridden'
+        # @return [String, nil] notification URL
+        def url
+          nil
         end
       end
     end

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

@@ -0,0 +1,30 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class DirectMessage < AbstractNotification
+        # @param [Twterm::DirectMessage] message
+        # @param [Twterm::User] user
+        def initialize(message, user)
+          @message = message
+          @user = user
+        end
+
+        # @return [String] notification body
+        def body
+          message.text
+        end
+
+        # @return [String] notification title
+        def title
+          "@#{user.screen_name} has sent you a message"
+        end
+
+        private
+
+        attr_reader :message, :user
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class Like < 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 liked 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/follow.rb

@@ -0,0 +1,33 @@
+require 'twterm/event/notification/abstract_notification'
+
+module Twterm
+  module Event
+    module Notification
+      class Follow < AbstractNotification
+        # @param [Twterm::User] user
+        def initialize(user)
+          @user = user
+        end
+
+        # @return [String] notification body
+        def body
+          user.description
+        end
+
+        # @return [String] notification title
+        def title
+          "@#{user.screen_name} has followed you"
+        end
+
+        # @return [String] notification url
+        def url
+          user.url
+        end
+
+        private
+
+        attr_reader :user
+      end
+    end
+  end
+end