whatup 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a2ccfe87d331ab0f316dce065f81de75aef2f2d870a1f83ed467d05b52ebdc
-  data.tar.gz: 990c58f0f6eaf19fe4032c33493d3f18ea7359318e182c15fb14e06390531b1a
+  metadata.gz: 4f618bbf5b44743049617a2a4af44444716b2f5caf2f6b698dfded679bd1eff5
+  data.tar.gz: 803106014c08fb0d54163d559f7568597c45726c74ba96654b6074d8a4ed27d1
 SHA512:
-  metadata.gz: 6a7025e077088cfda1f83ac5587be14628e07deb4c91eb01a66e884baed2523f563b6dcb329d02e408f984ad5aa42d2bb76de8755d060a9aa2f9dd1f86c8d90b
-  data.tar.gz: 8f0c1ae31f64922a223d23ffcd3e2d8a2555b6cb1e029505cb4389ff0bc0832e1cf406751486195792684fc7ecea654b4906aa08a5ae7ee649356dfa8745efca
+  metadata.gz: 3ad1f0ba64cc60f7962fad49e09fa7e926560b7d84c993e4b3550d5cdb41a0173b25f59e0302d54542b67ec9a275faeea04af8418a42d2796ee2ce16eba1d23d
+  data.tar.gz: 239e524850f5ca8c8c2591b23a7ed6fa7969ae6847c55c18e4e4e567e3849b5cec7cb8fe986c06eaf2ce8496b0d6217a3a698b99eec537df08b4e98f6c75b36c

data/.rubocop.yml

@@ -32,7 +32,7 @@ Style/CommentedKeyword:
 
 # The default is a bit restrictive
 Metrics/AbcSize:
-  Max: 30
+  Max: 40
 
 # The default is a bit restrictive
 Metrics/ClassLength:
@@ -43,12 +43,13 @@ Lint/AmbiguousRegexpLiteral:
   Enabled: false
 
 Metrics/BlockLength:
+  Max: 40
   Exclude:
     - 'whatup.gemspec'
     - 'spec/**/*_spec.rb'
 
 Metrics/MethodLength:
-  Max: 20 # 10 is a bit too low
+  Max: 40 # 10 is a bit too low
 
 # Don't type unneccesary ()
 Style/MethodDefParentheses:

data/README.md

@@ -28,8 +28,8 @@ brief instructions.
 $ whatup
 
 Commands:
+  whatup -v, --version   # Output the version
   whatup client ...      # Perform client commands
-  whatup hello           # Says hello
   whatup help [COMMAND]  # Describe available commands or one specific command
   whatup server ...      # Perform server commands
 ```

data/lib/whatup/cli/cli.rb

@@ -11,9 +11,15 @@ module Whatup
   module CLI
     # Top-level command class
     class CLI < Thor
-      desc 'hello', 'Says hello'
-      def hello
-        say "Hello!\n", :cyan
+      map %w[-v --version] => :version
+      option :version,
+             aliases: '-v',
+             type: :boolean,
+             desc: 'Show version',
+             default: true
+      desc '-v, --version', 'Output the version'
+      def version
+        say Whatup::VERSION
       end
 
       # Subcommands are defined below, but are implemented in `commands/`

data/lib/whatup/cli/commands/interactive/dm.rb

@@ -10,6 +10,7 @@ module Whatup
       extend ThorInteractive
 
       Room = Whatup::Server::Room
+      Message = Whatup::Server::Message
       Client = Whatup::Server::Client
 
       desc 'msg [NAME]', 'Send a message to [NAME]'
@@ -29,17 +30,14 @@ module Whatup
         say "That user doesn't exist!"
       end
 
-      desc 'list', 'List your received messages'
+      desc 'list', 'List your direct messages'
       def list
         say 'Your direct messages:'
-        msgs = current_user.received_messages.map do |msg|
-          <<~MSG
-            From: #{msg.sender.name}
-
-            #{msg.content}
-          MSG
-        end.join('-' * 10)
-        say msgs
+        say \
+          Message.where(sender: current_user)
+          .or(Message.where(recipient: current_user))
+          .map(&:to_s)
+                 .join('-' * 10)
       end
     end
   end

data/lib/whatup/cli/commands/interactive/interactive.rb

@@ -51,7 +51,7 @@ module Whatup
       end
 
       desc 'room [NAME]', 'Create and enter chatroom [NAME]'
-      def room name # rubocop:disable Metrics/AbcSize
+      def room name
         if room = Room.find_by(name: name)
           current_user.puts <<~MSG
             Entering #{room.name}... enjoy your stay!
@@ -84,23 +84,6 @@ module Whatup
         MSG
       end
 
-      desc 'dm [NAME]', 'Send a direct message to [NAME]'
-      def dm name
-        if recepient = Client.find_by(name: name)
-          say <<~MSG
-            Sending a direct message to #{name}...
-
-            The message can span multiple lines.
-
-            Type `.exit` when you're ready to send it.
-          MSG
-          current_user.composing_dm = recepient
-          return
-        end
-
-        say "That user doesn't exist!"
-      end
-
       desc 'exit', 'Closes your connection with the server'
       def exit
         current_user.exit!

data/lib/whatup/cli/commands/server.rb

@@ -8,12 +8,21 @@ module Whatup
   module CLI
     # Server commands
     class Server < Thor
-      option :port, type: :numeric, default: 9_001
+      option :port,
+             type: :numeric,
+             default: 9_001,
+             desc: 'The port to run the server on'
+      option :verbose,
+             aliases: '-v',
+             type: :boolean,
+             desc: 'Enable verbose output',
+             default: false
       desc 'start', 'Starts a server instance'
       long_desc <<~DESC
         Starts a server instance running locally on the specified port.
       DESC
       def start
+        ENV['WHATUP_LOG_LEVEL'] = 'DEBUG' if options[:verbose]
         Whatup::Server::Server.new(port: options[:port]).start
       end
     end

data/lib/whatup/server/db_init.rb

@@ -2,35 +2,43 @@
 
 require 'whatup'
 require 'whatup/server/redirection'
+require 'whatup/server/logger'
 
 module Whatup
   module Server
     module DbInit
       extend Redirection
+      extend WhatupLogger
 
       class << self
-        # Sets up our database, deleting all existing data.
         def setup_db!
+          log.debug { 'Setting up database ...' }
+
           db = "#{Dir.home}/.whatup.db"
-          SQLite3::Database.new(db) unless File.exist?(db)
+
+          if File.exist?(db)
+            log.debug { "Using existing database `#{db}" }
+          else
+            log.debug { "Creating new database `#{db}" }
+            SQLite3::Database.new(db)
+          end
 
           ActiveRecord::Base.establish_connection adapter: 'sqlite3',
                                                   database: db
 
-          ActiveRecord::Base.connection.execute <<~SQL
+          truncate_sql = <<~SQL
             DROP TABLE IF EXISTS clients_rooms;
             DROP TABLE IF EXISTS clients;
             DROP TABLE IF EXISTS messages;
             DROP TABLE IF EXISTS rooms;
           SQL
+          log.debug { "Truncating existing data ...\n#{truncate_sql}" }
+          ActiveRecord::Base.connection.execute truncate_sql
 
-          if Whatup.testing?
-            # We silence output here, so that tests don't get cluttered
-            redirect(stdout: StringIO.new) { create_tables! }
-            return
+          StringIO.new.tap do |io|
+            redirect(stdout: io) { create_tables! }
+            log.debug { "Creating tables ...\n#{io&.string}" }
           end
-
-          create_tables!
         end
 
         private
@@ -40,14 +48,17 @@ module Whatup
             create_table :clients, force: true do |t|
               t.string :name
               t.references :room
+              t.timestamps
             end
             create_table :messages, force: true do |t|
               t.string :content
               t.references :sender
               t.references :recipient
+              t.timestamps
             end
             create_table :rooms, force: true do |t|
               t.string :name
+              t.timestamps
             end
           end
         end

data/lib/whatup/server/logger.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'logger'
+
+require 'colorize'
+
+class Logger
+  class Formatter
+    def call severity, time, _progname, msg
+      color = case severity
+              when 'DEBUG' then :light_magenta
+              when 'INFO' then :light_green
+              when 'WARN' then :light_cyan
+              when 'ERROR' then :light_red
+              when 'FATAL', 'UNKNOWN' then :red
+              end
+
+      "[#{severity.ljust(5, ' ').colorize color}][#{time}]: #{msg}\n"
+    end
+  end
+end
+
+module WhatupLogger
+  # Access a logger, to stdout (for now).
+  #
+  # Uses logging level ENV['WHATUP_LOG_LEVEL'], which can be WARN, INFO, etc
+  def log
+    Logger.new(STDOUT).tap do |logger|
+      if Logger.constants.map(&:to_s).include? ENV['WHATUP_LOG_LEVEL']
+        logger.level = Logger.const_get ENV['WHATUP_LOG_LEVEL']
+      else
+        logger.level = Logger::INFO
+        logger.level = 9001 if Whatup.testing?
+      end
+    end
+  end
+end

data/lib/whatup/server/models/client.rb

@@ -21,7 +21,7 @@ module Whatup
       end
 
       def gets
-        socket.gets
+        socket&.gets
       end
 
       def input!
@@ -55,6 +55,10 @@ module Whatup
         @deleted = true
         destroy!
       end
+
+      def to_s
+        name
+      end
     end
   end
 end

data/lib/whatup/server/models/message.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'tzinfo'
+
 require 'whatup/server/models/application_record'
 
 module Whatup
@@ -7,6 +9,20 @@ module Whatup
     class Message < ApplicationRecord
       belongs_to :recipient, class_name: 'Client'
       belongs_to :sender, class_name: 'Client', foreign_key: 'sender_id'
+
+      TZ = TZInfo::Timezone.get 'America/Detroit' # Central time
+
+      def to_s
+        <<~MSG.gsub '.exit', ''
+          ------------------------------------------------------------
+          From: #{sender.name}
+          To: #{recipient.name}
+          Date: #{TZ.utc_to_local(created_at).to_s :db}
+
+          #{content&.chomp}
+          ------------------------------------------------------------
+        MSG
+      end
     end
   end
 end

data/lib/whatup/server/server.rb

@@ -9,6 +9,7 @@ require 'active_record'
 require 'active_support/core_ext/object/blank'
 
 require 'whatup/server/db_init'
+require 'whatup/server/logger'
 require 'whatup/server/redirection'
 require 'whatup/server/models/client'
 require 'whatup/server/models/message'
@@ -18,9 +19,9 @@ require 'whatup/cli/commands/interactive/interactive'
 module Whatup
   module Server
     class Server # rubocop:disable Metrics/ClassLength
-      include Thor::Shell
       include DbInit
       include Redirection
+      include WhatupLogger
 
       Client = Whatup::Server::Client
 
@@ -49,7 +50,7 @@ module Whatup
       # The server continuously loops, and handle each new client in a separate
       # thread.
       def start
-        say "Starting a server with PID:#{@pid} @ #{@address} ... \n", :green
+        log.info { "Starting a server with PID:#{@pid} @ #{@address} ... \n" }
 
         exit_if_pid_exists!
         connect_to_socket!
@@ -57,7 +58,10 @@ module Whatup
 
         # Listen for connections, then accept each in a separate thread
         loop do
-          Thread.new(@socket.accept) { |client| handle_client client }
+          Thread.new(@socket.accept) do |client|
+            log.info { "Accepted new client: #{client.inspect}" }
+            handle_client client
+          end
         end
       rescue SignalException # In case of ^c
         kill
@@ -76,9 +80,9 @@ module Whatup
       #
       # @return [Whatup::Server::Room] The created room
       def new_room! clients: [], name:
-        room = Room.create! name: name, clients: clients
-        @rooms << room
-        room
+        Room.create!(name: name, clients: clients).tap do |room|
+          @rooms << room
+        end
       end
 
       private
@@ -87,15 +91,22 @@ module Whatup
       #
       # @param client [Whatup::Server::Client] The client
       #
-      # rubocop:disable Metrics/MethodLength
-      def handle_client client
+      def handle_client client # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/LineLength
         client = create_new_client_if_not_existing! client
 
         # Loop forever to maintain the connection
         loop do
           @clients.reject! &:deleted
 
-          Thread.current.exit if client.deleted
+          if client.deleted
+            log.debug do
+              <<~OUT
+                Client `#{client.name}` has been deleted.
+                #{'Killing'.colorize :red} this thread."
+              OUT
+            end
+            Thread.current.exit
+          end
 
           if client.composing_dm?
             handle_dm client
@@ -106,28 +117,31 @@ module Whatup
           # Wait until we get a valid command. This takes as long as the client
           # takes.
           msg = client.input! unless Whatup::CLI::Interactive.command?(msg)
+          log.info { "#{client.name.colorize :light_blue}> #{msg}" }
 
-          puts "#{client.name}> #{msg}"
-
-          begin
-            # Send the output to the client
-            redirect stdin: client.socket, stdout: client.socket do
+          # Send the output to the client
+          redirect stdin: client.socket, stdout: client.socket do
+            begin
               # Invoke the cli using the provided commands and options.
               run_thor_command! client: client, msg: msg
+            rescue RuntimeError,
+                   ArgumentError,
+                   Thor::InvocationError,
+                   Thor::UndefinedCommandError => e
+              log.info do
+                "#{client.name.colorize :red}> #{e.class}: #{e.message}"
+              end
+              client.puts case e.class.to_s
+                          when 'RuntimeError'
+                            'Invalid input or unknown command'
+                          else
+                            e.message
+                          end
             end
-          rescue RuntimeError,
-                 Thor::InvocationError,
-                 Thor::UndefinedCommandError => e
-            puts e.message
-            client.puts 'Invalid input or unknown command'
-          rescue ArgumentError => e
-            puts e.message
-            client.puts e.message
           end
           msg = nil
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Handles inputing direct messages
       #
@@ -137,18 +151,20 @@ module Whatup
         msg = StringIO.new
         loop do
           input = client.input!
-          puts "#{client.name}> #{input}"
+          log.info { "#{client.name.colorize :light_blue}> #{input}" }
           msg.puts input
           if input == '.exit'
             client.puts "Finished dm to `#{client.composing_dm.name}`."
             break
           end
         end
-        client.composing_dm
-              .received_messages << Message.new(
-                sender: client,
-                content: msg.string
-              )
+        Message.create!(sender: client, content: msg.string).tap do |m|
+          client.composing_dm.received_messages << m
+          log.debug do
+            "Created new message (id = #{m.id}) from `#{client}` to" \
+            "`#{client.composing_dm}`"
+          end
+        end
         client.composing_dm = nil
       end
 
@@ -163,7 +179,7 @@ module Whatup
                              .select do |c|
                                client.room.clients.pluck(:id).include? c.id
                              end
-          puts "#{client.name}> #{input}"
+          log.info { "#{client.name.colorize :light_blue}> #{input}" }
           if input == '.exit'
             client.puts "Exited `#{client.room.name}`."
             audience.each { |c| c.puts "#{client.name}> LEFT" }
@@ -185,7 +201,18 @@ module Whatup
       #
       # @return [Whatup::Server::Client] The created client
       def create_new_client_if_not_existing! client
-        name     = client.gets.chomp
+        log.debug { 'Creating new client' }
+
+        name = client.gets&.chomp
+
+        if name.nil?
+          log.debug do
+            'New client (currently unknown) has left. ' \
+            "#{'Killing'.colorize :red} this thread."
+          end
+          Thread.current.exit
+        end
+
         rand_num = SecureRandom.random_number(100).to_s.rjust 3, '0'
         name     = name == '' ? "ANON-#{rand_num}" : name
 
@@ -193,6 +220,10 @@ module Whatup
           client.puts 'That name is taken! Goodbye.'
           client.puts 'END'
           client.close
+          log.debug do
+            "Existing name `#{name}` entered. " \
+            "#{'Killing'.colorize :red} this thread"
+          end
           Thread.current.exit
         end
 
@@ -200,16 +231,17 @@ module Whatup
           name: name,
           socket: client
         )
+        log.info { "Created new client `#{name}` ..." }
 
-        puts "#{client.name} just showed up!"
-        client.puts <<~MSG
-          Hello, #{client.name}!
+        client.tap do |c|
+          c.puts <<~MSG
+            Hello, #{client.name}!
 
-          Welcome to whatup.
+            Welcome to whatup.
 
-          To get started, type `help`.
-        MSG
-        client
+            To get started, type `help`.
+          MSG
+        end
       end
 
       # Initialize a new cli class using the initial command and options,
@@ -233,9 +265,11 @@ module Whatup
 
       # Kills the server if a PID for this app exists
       def exit_if_pid_exists!
+        log.debug { "Checking if `#{@pid}` exists ..." }
+
         return unless running?
 
-        say <<~EXIT, :cyan
+        log.info <<~EXIT
           A server appears to already be running!
           Check `#{@pid_file}`.
         EXIT
@@ -246,14 +280,18 @@ module Whatup
       # Connect a new socket for this server to start listening on the specified
       # address and port.
       def connect_to_socket!
+        log.info do
+          "#{'Opening'.colorize :blue} TCP socket at `#{@ip}:#{@port}`"
+        end
         @socket = TCPServer.open @ip, @port
       rescue Errno::EADDRINUSE
-        puts 'Address already in use!'
+        log.error "Address `#{@ip}:#{@port}` is already in use!"
         kill
       end
 
       # Write this process's PID to the PID file
       def write_pid!
+        log.debug { "Writing PID to `#{@pid}`" }
         File.open(@pid_file, 'w') { |f| f.puts Process.pid }
       end
 
@@ -264,8 +302,12 @@ module Whatup
 
       # Kills the server and removes the PID file
       def kill
-        say "Killing the server with PID:#{Process.pid} ...", :red
+        log.info do
+          "#{'Killing'.colorize :red} the server with " \
+          "PID:#{Process.pid} ..."
+        end
         FileUtils.rm_rf @pid_file
+        log.debug { "Removed `#{@pid_file}`." }
         exit
       end
     end

data/lib/whatup/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Whatup
-  VERSION = '0.3.4'
+  VERSION = '0.3.5'
 end

data/whatup.gemspec

@@ -67,7 +67,9 @@ Gem::Specification.new do |spec|
     'activesupport' => '~> 5.2',
     'thor'          => '~> 0.20.3',
     'sqlite3'       => '~> 1.4',
-    'activerecord'  => '~> 5.2'
+    'activerecord'  => '~> 5.2',
+    'tzinfo'        => '~> 1.2',
+    'colorize'      => '~> 0.8.1'
   }.each do |gem, version|
     spec.add_dependency gem, version
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatup
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Mark Delk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -178,6 +178,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
 description: |
   whatup is a simple server-based instant messaging application using TCP
   sockets.
@@ -221,6 +249,7 @@ files:
 - lib/whatup/cli/thor_interactive.rb
 - lib/whatup/client/client.rb
 - lib/whatup/server/db_init.rb
+- lib/whatup/server/logger.rb
 - lib/whatup/server/models/application_record.rb
 - lib/whatup/server/models/client.rb
 - lib/whatup/server/models/message.rb