whatup 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ace83a0aa8e24fb44a1f6900f8cdcaf201e7d8d9661883d1bb0ec8fdadf7fd6
-  data.tar.gz: 56b91c405097272ca64cbf9d78b4c6c02fd8749ce883838369b933b618c53552
+  metadata.gz: 974cf5162247e51601cda75af330d68aa1b9a77a73eb394228a5c4db17966445
+  data.tar.gz: 1a9113486f862c0ff3fc324458572f0e98055cd3459a126b84fc61ae44c90b77
 SHA512:
-  metadata.gz: 1664ad2e6d346c84d4509fe166744e2f863889d59a968f21db9188989eabf87e4e927045530926a51dc80e2ffdd6734f252642fb0b645139b177319399eb97c6
-  data.tar.gz: 4ee3b633248639ff80215487a2d2820fc7e01a5b6b8923574f464b9255de77443febae039cb9e6cfa8444a2c2e649c7a3597ad82de66127039c6e373a2158168
+  metadata.gz: c9c93d48307ac342e04efa0b43a43c7d84d6208be74e87702b2f35c30eae0c01be4d6fca302ee6c691b2e6f4c41af6ea1d64d024f09d735cd503c35419744b1c
+  data.tar.gz: 1fcce685d6b140cb51452fdf299b0190212c42c036aa9821fc9f062ad8387c06d617f9068c52c37c8b877708ec072f01cc070ede433df061cfa161300da02370

data/.rubocop.yml

@@ -3,6 +3,10 @@
 AllCops:
   TargetRubyVersion: 2.4 # Modern Ruby
 
+# !!defined?(RSpec)
+Style/DoubleNegation:
+  Enabled: false
+
 # attr_reader *%i[a b c]
 Lint/UnneededSplatExpansion:
   Enabled: false
@@ -17,6 +21,15 @@ Style/FrozenStringLiteralComment:
   Exclude:
     - 'spec/system_spec.rb'
 
+# For long specs.
+#
+# describe 'some spec'
+#   ...
+# end # describe 'some spec'
+Style/CommentedKeyword:
+  Exclude:
+    - 'spec/system_spec.rb'
+
 # The default is a bit restrictive
 Metrics/AbcSize:
   Max: 30

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'thor'
+require 'whatup/cli/thor_interactive'
+
+module Whatup
+  module CLI
+    # Server commands
+    class Dm < Thor
+      extend ThorInteractive
+
+      Room = Whatup::Server::Room
+      Client = Whatup::Server::Client
+
+      desc 'msg [NAME]', 'Send a message to [NAME]'
+      def msg 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 'list', 'List your received 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
+      end
+    end
+  end
+end

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

@@ -1,34 +1,22 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'whatup/cli/thor_interactive'
 
 require 'whatup/client/client'
+require 'whatup/cli/commands/interactive/dm'
 
 module Whatup
   module CLI
-    # Any methods of class `Whatup::CLI::Interactive` that rely on instance
-    # variables should be included here
-    COMMANDS = %i[
-      room
-      list
-      exit
-      dmlist
-      dm
-    ].freeze
-
-    require 'whatup/cli/commands/interactive/setup'
-
     # Interactive client commands that are available after connecting
     #
     # This class is run on the server
     class Interactive < Thor
-      prepend InteractiveSetup
+      extend ThorInteractive
 
       Room = Whatup::Server::Room
       Client = Whatup::Server::Client
 
-      attr_accessor *%i[server current_user]
-
       no_commands do
         # Checks whether a given input string is a valid command
         def self.command? msg
@@ -39,7 +27,7 @@ module Whatup
 
         # Parses a client's input into a format suitable for Thor commands
         #
-        # @param [String] msg - the client's message
+        # param [String] msg - the client's message
         def self.parse_input msg
           # Split user input at the first "option"
           cmds, opts = msg&.split /-|--/, 2
@@ -48,8 +36,6 @@ module Whatup
           cmds = cmds&.split(/\s+/)
           opts = opts&.split(/\s+/)
 
-          # `Whatup::CLI::Interactive.new(cmds, opts)` expects arrays, and
-          # a final options hash
           cmds = [] if cmds.nil?
           opts = [] if opts.nil?
 
@@ -57,23 +43,17 @@ module Whatup
         end
       end
 
-      # Don't show app name in command help, i.e, instead of
-      # `app command desc`, use `command desc`
-      def self.banner task, _namespace = false, subcommand = false
-        task.formatted_usage(self, false, subcommand).to_s
-      end
-
       desc 'list', 'Show all connected clients'
       def list
         say 'All connected clients:'
-        @server.clients_except(@current_user).each { |c| say "  #{c.status}" }
-        say "* #{@current_user.status}"
+        server.clients_except(current_user).each { |c| say "  #{c.status}" }
+        say "* #{current_user.status}"
       end
 
       desc 'room [NAME]', 'Create and enter chatroom [NAME]'
       def room name
         if room = Room.find_by(name: name)
-          @current_user.puts <<~MSG
+          current_user.puts <<~MSG
             Entering #{room.name}... enjoy your stay!
 
             Type `.exit` to exit this chat room.
@@ -83,40 +63,27 @@ module Whatup
                 "- #{client.name}\n"
               end.join}
           MSG
-          @current_user.update! room: room
+          current_user.update! room: room
 
-          room.broadcast except: @current_user do
+          room.broadcast except: current_user do
             <<~MSG
-              #{@current_user.name} has arrived! Play nice, kids.
+              #{current_user.name} has arrived! Play nice, kids.
             MSG
           end
 
-          room.clients << @current_user
+          room.clients << current_user
           return
         end
 
-        room = @server.new_room! name: name, clients: [@current_user]
+        room = server.new_room! name: name, clients: [current_user]
 
-        @current_user.puts <<~MSG
+        current_user.puts <<~MSG
           Created and entered #{room.name}... invite some people or something!
 
           Type `.exit` to exit this chat room.
         MSG
       end
 
-      desc 'dmlist', 'List your received messages'
-      def dmlist
-        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
-      end
-
       desc 'dm [NAME]', 'Send a direct message to [NAME]'
       def dm name
         if recepient = Client.find_by(name: name)
@@ -127,7 +94,7 @@ module Whatup
 
             Type `.exit` when you're ready to send it.
           MSG
-          @current_user.composing_dm = recepient
+          current_user.composing_dm = recepient
           return
         end
 
@@ -136,8 +103,16 @@ module Whatup
 
       desc 'exit', 'Closes your connection with the server'
       def exit
-        @current_user.exit!
+        current_user.exit!
       end
+
+      desc 'dm ...', 'Perform direct message commands'
+      long_desc <<~DESC
+        Perform direct message commands.
+
+        See `dm help [CMD] for more info about specific commands.
+      DESC
+      subcommand 'dm', Dm
     end
   end
 end

data/lib/whatup/cli/thor_interactive.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+# Allows us to use variables passed into a Thor class's `config[:locals]`
+# Allows us to call the variables passed into `config[:locals]` as methods
+# in our cli classes
+module ThorInstanceVariableHook
+  def method_missing method, *args, &block
+    var = instance_variable_get(:@_initializer).last[:locals][method]
+    return var unless var.nil?
+
+    super
+  end
+
+  def respond_to_missing? name, include_private = false
+    super
+  end
+end
+
+module ThorInteractive
+  # Don't show app name in command help, i.e, instead of
+  # `app command desc`, use `command desc`
+  def banner task, _namespace = false, subcommand = false
+    task.formatted_usage(self, false, subcommand).to_s
+  end
+
+  # Include the instance variable to method hook in our cli classes
+  def self.extended base
+    base.send :include, ThorInstanceVariableHook
+  end
+end

data/lib/whatup/server/db_init.rb

@@ -9,6 +9,7 @@ module Whatup
       extend Redirection
 
       class << self
+        # Sets up our database, deleting all existing data.
         def setup_db!
           db = "#{Whatup.root}/db/whatup.db"
           SQLite3::Database.new(db) unless File.exist?(db)
@@ -23,7 +24,13 @@ module Whatup
             DROP TABLE IF EXISTS rooms;
           SQL
 
-          redirect(stdout: StringIO.new) { create_tables! }
+          if Whatup.testing?
+            # We silence output here, so that tests don't get cluttered
+            redirect(stdout: StringIO.new) { create_tables! }
+            return
+          end
+
+          create_tables!
         end
 
         private

data/lib/whatup/server/redirection.rb

@@ -4,6 +4,9 @@ module Whatup
   module Server
     module Redirection
       # Reroutes stdin and stdout inside a block
+      #
+      # @param [IO#write] stdin - will redirect stdin to this
+      # @param [IO#write] stdout - will redirect stdout to this
       def redirect stdin: $stdin, stdout: $stdout
         original_stdin  = $stdin
         original_stdout = $stdout

data/lib/whatup/server/server.rb

@@ -26,6 +26,10 @@ module Whatup
 
       attr_reader *%i[ip port address clients pid pid_file rooms]
 
+      # @param ip [String] The ip address to run the server on
+      # @param port [Integer] The port to run the server on
+      #
+      # @return [Whatup::Server::Server] The created server
       def initialize ip: 'localhost', port:
         @ip = ip
         @port = port
@@ -53,26 +57,24 @@ module Whatup
 
         # Listen for connections, then accept each in a separate thread
         loop do
-          Thread.new(@socket.accept) do |client|
-            case handle_client client
-            when :exit
-              client.puts 'bye!'
-              Thread.kill Thread.current
-            end
-          end
+          Thread.new(@socket.accept) { |client| handle_client client }
         end
       rescue SignalException # In case of ^c
         kill
       end
 
-      def find_client_by name:
-        @clients.select { |c| c.name == name }&.first
-      end
-
+      # @param client [Whatup::Server::Client] The client to not retrieve
+      #
+      # @return [Array<Whatup::Server::Client>] All currently connected clients
+      #   except for `client`
       def clients_except client
         @clients.reject { |c| c == client }
       end
 
+      # @param clients [Array<Whatup::Server::Client>] Room's inital clients
+      # @param name [String] The room's name
+      #
+      # @return [Whatup::Server::Room] The created room
       def new_room! clients: [], name:
         room = Room.create! name: name, clients: clients
         @rooms << room
@@ -83,6 +85,8 @@ module Whatup
 
       # Receives a new client, then continuously gets input from that client
       #
+      # @param client [Whatup::Server::Client] The client
+      #
       # rubocop:disable Metrics/MethodLength
       def handle_client client
         client = create_new_client_if_not_existing! client
@@ -125,6 +129,10 @@ module Whatup
       end
       # rubocop:enable Metrics/MethodLength
 
+      # Handles inputing direct messages
+      #
+      # @param client [Whatup::Server::Client] `client` is the sender of
+      #   the message, and `client.composing_dm` is the recipient.
       def handle_dm client
         msg = StringIO.new
         loop do
@@ -144,6 +152,10 @@ module Whatup
         client.composing_dm = nil
       end
 
+      # Handles chatting.
+      #
+      # @param client [Whatup::Server::Client] The client. `client` is assumed
+      #   to already belong to a room
       def handle_chatting client
         loop do
           input = client.input!
@@ -166,6 +178,10 @@ module Whatup
       # If no username is provided (i.e, blank), it assigns a random, anonymous
       # username in the format `ANON-xxx`, where `xxx` is a random number upto
       # 100, left-padded with zeros.
+      #
+      # @param client [TCPSocket] The client connection
+      #
+      # @return [Whatup::Server::Client] The created client
       def create_new_client_if_not_existing! client
         name     = client.gets.chomp
         rand_num = SecureRandom.random_number(100).to_s.rjust 3, '0'
@@ -194,22 +210,26 @@ module Whatup
         client
       end
 
+      # Initialize a new cli class using the initial command and options,
+      # and then set any instance variables, since Thor will create a new
+      # class instance when it's invoked.
+      #
+      # This achieve the same effect as
+      # `Whatup::CLI::Interactive.start(args)`, but allows us to set
+      # instance variables on the cli class.
+      #
+      # @param client [Whatup::Server::Client]
       def run_thor_command! client:, msg:
-        # Initialize a new cli class using the initial command and options,
-        # and then set any instance variables, since Thor will create a new
-        # class instance when it's invoked.
         cmds, opts = Whatup::CLI::Interactive.parse_input msg
-        Whatup::CLI::Interactive.new(cmds, opts).tap do |c|
-          c.server = self
-          c.current_user = client
-
-          # This _should_ achieve the same effect as
-          # `Whatup::CLI::Interactive.start(args)`, but allows us to set
-          # instance variables on the cli class.
-          c.invoke c.args.first, c.args.drop(1)
-        end
+        cli = Whatup::CLI::Interactive.new(
+          cmds,
+          opts,
+          locals: {server: self, current_user: client} # config
+        )
+        cli.invoke cli.args.first, cli.args.drop(1)
       end
 
+      # Kills the server if a PID for this app exists
       def exit_if_pid_exists!
         return unless running?
 
@@ -221,21 +241,26 @@ module Whatup
         kill
       end
 
+      # Connect a new socket for this server to start listening on the specified
+      # address and port.
       def connect_to_socket!
-        @socket = TCPServer.open @port
+        @socket = TCPServer.open @ip, @port
       rescue Errno::EADDRINUSE
         puts 'Address already in use!'
         kill
       end
 
+      # Write this process's PID to the PID file
       def write_pid!
         File.open(@pid_file, 'w') { |f| f.puts Process.pid }
       end
 
+      # @return [Bool] Whether or not a PID for this app exists
       def running?
         File.file? @pid_file
       end
 
+      # Kills the server and removes the PID file
       def kill
         say "Killing the server with PID:#{Process.pid} ...", :red
         FileUtils.rm_rf @pid_file

data/lib/whatup/version.rb

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

data/lib/whatup.rb

@@ -8,7 +8,13 @@ module Whatup
   class Error < StandardError
   end
 
+  # @return [String] The full path to application root
   def self.root
     Dir.pwd
   end
+
+  # @return [Bool] Whether or not the app is running in a test environment
+  def self.testing?
+    !!defined?(RSpec)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whatup
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Delk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -215,9 +215,10 @@ files:
 - lib/whatup.rb
 - lib/whatup/cli/cli.rb
 - lib/whatup/cli/commands/client.rb
+- lib/whatup/cli/commands/interactive/dm.rb
 - lib/whatup/cli/commands/interactive/interactive.rb
-- lib/whatup/cli/commands/interactive/setup.rb
 - lib/whatup/cli/commands/server.rb
+- lib/whatup/cli/thor_interactive.rb
 - lib/whatup/client/client.rb
 - lib/whatup/server/db_init.rb
 - lib/whatup/server/models/application_record.rb

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Whatup
-  module CLI
-    # Implements a `before` hook to set the correct instance variables
-    # before any command methods.
-    #
-    # This is needed, since Thor creates another cli class instance when it is
-    # called with `invoke`, and we need to reassign any variables to the new
-    # cli instance.
-    #
-    # TODO: grab commands dynamically
-    module InteractiveSetup
-      Whatup::CLI::COMMANDS.each do |cmd|
-        define_method cmd do |*args|
-          cli = instance_variable_get(:@_initializer).last[:shell].base
-          @server = cli.server
-          @current_user = cli.current_user
-          super *args
-        end
-      end
-    end
-  end
-end