meshchat 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01c4f397703dbfd3299712e33207dffb16edfdea
-  data.tar.gz: 2679cafaa50569456444ab222dfd976db1dc724c
+  metadata.gz: d133b88895ed07267fb0e6b02806c2ebe998ce59
+  data.tar.gz: b01e8f93f830e3ecc211ff165947479319fd600b
 SHA512:
-  metadata.gz: f660b1820794d8b40657ae757ae54730ed5c605128781d8f6aa49fd57dc6746a3ac6cd3668e6cddef905f76380a1791da6e072117bdc38d08232f9d697c5dc52
-  data.tar.gz: 923524a79e5fd5f858d48d8a2fb8b6cb53d5b770150f88accc5d2a92132c34f3459952258fb1e8652a0dbea0984bef4b02e78dc9f25a255a12e1242bca80d044
+  metadata.gz: 81e2789b1f3ad8d44cfba19a8e736f330e78564743530909c94aa036d5b381749775036754f72af6a40bde5b2ff2856be051d61521230a05346ddfae7c0f0b86
+  data.tar.gz: d6678a4ff966e8e5de7a73057f109e8a41badb5baf12387a13b5190ea083221514cf0619915e3d4302a960b803c515b13853c31b19f4418dd675c8d3d0100008

data/README.md

@@ -5,3 +5,15 @@ This is the core functionality for implementing a [mesh-chat](https://github.com
 #Usage
 
 See [Spiced Gracken](https://github.com/NullVoxPopuli/spiced_gracken)
+
+For now, all that needs to be implemented is the Display.
+Take a look at `Display::Base` to see what you need to override.
+
+```ruby
+MeshChat.start(
+  client_name: NAME, # name of your client
+  client_version: VERSION, # version of your client
+  display: ui, # your class of your implementation of `Display::Base`
+  on_display_start: ->{ MeshChat::CLI.check_startup_settings } # optional
+)
+```

data/lib/meshchat.rb

@@ -58,7 +58,8 @@ module MeshChat
     defaults = {
       display: Display::Base,
       client_name: NAME,
-      client_version: VERSION
+      client_version: VERSION,
+      input: CLI::Base
     }
     options = defaults.merge(overrides)
 

data/lib/meshchat/cli.rb

@@ -1,44 +1,48 @@
 require 'meshchat/cli/input'
-require 'meshchat/cli/command'
-require 'meshchat/cli/identity'
-require 'meshchat/cli/irb'
-require 'meshchat/cli/config'
-require 'meshchat/cli/ping'
-require 'meshchat/cli/ping_all'
-require 'meshchat/cli/server'
-require 'meshchat/cli/whisper'
-require 'meshchat/cli/exit'
-require 'meshchat/cli/listen'
-require 'meshchat/cli/stop_listening'
-require 'meshchat/cli/who'
-require 'meshchat/cli/init'
-require 'meshchat/cli/share'
-require 'meshchat/cli/import'
+require 'meshchat/cli/base'
+require 'meshchat/command/base'
+require 'meshchat/command/identity'
+require 'meshchat/command/irb'
+require 'meshchat/command/config'
+require 'meshchat/command/ping'
+require 'meshchat/command/ping_all'
+require 'meshchat/command/server'
+require 'meshchat/command/whisper'
+require 'meshchat/command/exit'
+require 'meshchat/command/listen'
+require 'meshchat/command/stop_listening'
+require 'meshchat/command/who'
+require 'meshchat/command/init'
+require 'meshchat/command/share'
+require 'meshchat/command/import'
+
 
 module MeshChat
   # A user interface is responsible for for creating a client
   # and sending messages to that client
   class CLI
     COMMAND_MAP = {
-      Command::CONFIG => CLI::Config,
-      Command::PING => CLI::Ping,
-      Command::PING_ALL => CLI::PingAll,
-      Command::STOP_LISTENING => CLI::StopListening,
-      Command::SERVERS => CLI::Server,
-      Command::SERVER => CLI::Server,
-      Command::EXIT => CLI::Exit,
-      Command::QUIT => CLI::Exit,
-      Command::LISTEN => CLI::Listen,
-      Command::WHO => CLI::Who,
-      Command::IDENTITY => CLI::Identity,
-      Command::IRB => CLI::IRB,
-      Command::INIT => CLI::Init,
-      Command::SHARE => CLI::Share,
-      Command::IMPORT => CLI::Import,
-      Command::EXPORT => CLI::Share
+      MeshChat::Command::Base::CONFIG => MeshChat::Command::Config,
+      MeshChat::Command::Base::PING => MeshChat::Command::Ping,
+      MeshChat::Command::Base::PING_ALL => MeshChat::Command::PingAll,
+      MeshChat::Command::Base::STOP_LISTENING => MeshChat::Command::StopListening,
+      MeshChat::Command::Base::SERVERS => MeshChat::Command::Server,
+      MeshChat::Command::Base::SERVER => MeshChat::Command::Server,
+      MeshChat::Command::Base::EXIT => MeshChat::Command::Exit,
+      MeshChat::Command::Base::QUIT => MeshChat::Command::Exit,
+      MeshChat::Command::Base::LISTEN => MeshChat::Command::Listen,
+      MeshChat::Command::Base::WHO => MeshChat::Command::Who,
+      MeshChat::Command::Base::IDENTITY => MeshChat::Command::Identity,
+      MeshChat::Command::Base::IRB => MeshChat::Command::IRB,
+      MeshChat::Command::Base::INIT => MeshChat::Command::Init,
+      MeshChat::Command::Base::SHARE => MeshChat::Command::Share,
+      MeshChat::Command::Base::IMPORT => MeshChat::Command::Import,
+      MeshChat::Command::Base::EXPORT => MeshChat::Command::Share
     }
 
 
+    attr_accessor :_input_device
+
     class << self
 
       delegate :server_location, :listen_for_commands,
@@ -46,25 +50,21 @@ module MeshChat
         :check_startup_settings, :create_input, :close_server,
         to: :instance
 
-      def instance
-        @instance ||= new
+      def create(input_klass)
+        @instance = new(input_klass)
       end
 
-      # TODO: extract this for sub commands
-      def autocompletes
-        commands = COMMAND_MAP.map{ |k, v| "/#{k}" }
-        aliases = MeshChat::Node.all.map{ |n| "#{n.alias_name}" }
-        commands + aliases
+      def instance
+        # default input collector
+        @instance ||= new
       end
-
     end
 
 
-    def initialize
-      # Set up auto complete
-      completion = proc{ |s| self.class.autocompletes.grep(/^#{Regexp.escape(s)}/) }
-      Readline.completion_proc = completion
-
+    def initialize(input_klass = nil)
+      input_klass ||= MeshChat::CLI::Base
+      # instantiate the interface with which we are communicated with
+      self._input_device = input_klass.new
       # this will allow our listener / server to print exceptions,
       # rather than  silently fail
       Thread.abort_on_exception = true
@@ -75,7 +75,7 @@ module MeshChat
     end
 
     def process_input
-      msg = get_input
+      msg = _input_device.get_input
       create_input(msg)
     rescue SystemExit, Interrupt
       close_program
@@ -94,11 +94,6 @@ module MeshChat
       Display.error e.backtrace.join("\n").colorize(:red)
     end
 
-
-    def get_input
-      Readline.readline('> ', true)
-    end
-
     def start_server
 
       unless Settings.valid?

data/lib/meshchat/cli/base.rb

@@ -0,0 +1,13 @@
+module MeshChat
+  class CLI
+    class Base
+      # override this to alter how input is gathered
+      #
+      # the returned value of this method should be a whole line / command
+      # that will be passed to MeshChat::CLI.create_input
+      def get_input
+        gets
+      end
+    end
+  end
+end

data/lib/meshchat/cli/input.rb

@@ -9,9 +9,9 @@ module MeshChat
         def create(input)
           klass =
             if is_command(input)
-              CLI::Command
+              Command::Base
             elsif is_whisper?(input)
-              CLI::Whisper
+              Command::Whisper
             else
               # TODO: maybe change this to a chat command?
               CLI::Input

data/lib/meshchat/{cli/command.rb → command/base.rb}

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Command < CLI::Input
+  class Command
+    class Base < CLI::Input
       attr_accessor :_input
 
       # Commands

data/lib/meshchat/{cli → command}/config.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Config < CLI::Command
+  class Command
+    class Config < Command::Base
       def handle
         case sub_command
         when SET

data/lib/meshchat/{cli → command}/exit.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Exit < CLI::Command
+  class Command
+    class Exit < Command::Base
       def handle
         CLI.shutdown
       end

data/lib/meshchat/{cli → command}/identity.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Identity < CLI::Command
+  class Command
+    class Identity < Command::Base
       def handle
         Display.success Settings.identity
       end

data/lib/meshchat/{cli → command}/import.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Import < CLI::Command
+  class Command
+    class Import < Command::Base
       def handle
         if command_valid?
           node = Models::Entry.import_from_file(filename)

data/lib/meshchat/{cli → command}/init.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Init < CLI::Command
+  class Command
+    class Init < Command::Base
       def handle
         if Settings.uid_exists?
           if confirm? 'uid exists, are you sure you want a new identity?'

data/lib/meshchat/{cli → command}/irb.rb

@@ -1,8 +1,8 @@
 module MeshChat
-  class CLI
+  class Command
     # TODO: only include this and awesome_print when booted with
     # debug=true in the config
-    class IRB < CLI::Command
+    class IRB < Command::Base
       def handle
         begin
           code = command_args[1..command_args.length].join(' ')

data/lib/meshchat/{cli → command}/listen.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Listen < CLI::Command
+  class Command
+    class Listen < Command::Base
       def handle
         CLI.start_server
       end

data/lib/meshchat/{cli → command}/ping.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Ping < CLI::Command
+  class Command
+    class Ping < Command::Base
       def handle
         if command_valid?
           msg = Message::Ping.new

data/lib/meshchat/{cli → command}/ping_all.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class PingAll < CLI::Command
+  class Command
+    class PingAll < Command::Base
       def handle
         Node.all.each do |n|
           Net::Client.send(node: n, message: Message::Ping.new)

data/lib/meshchat/{cli → command}/server.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Server < CLI::Command
+  class Command
+    class Server < Command::Base
       ONLINE = 'online'
 
       def handle

data/lib/meshchat/{cli → command}/share.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Share < CLI::Command
+  class Command
+    class Share < Command::Base
       def handle
         Settings.share
       end

data/lib/meshchat/{cli → command}/stop_listening.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class StopListening < CLI::Command
+  class Command
+    class StopListening < Command::Base
       def handle
         CLI.close_server
       end

data/lib/meshchat/{cli → command}/whisper.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Whisper < CLI::Command
+  class Command
+    class Whisper < Command::Base
       def target
         # get first arg
         command

data/lib/meshchat/{cli → command}/who.rb

@@ -1,6 +1,6 @@
 module MeshChat
-  class CLI
-    class Who < CLI::Command
+  class Command
+    class Who < Command::Base
       def handle
         Display.info Node.online.map(&:as_info) || 'no one is online'
       end

data/lib/meshchat/instance.rb

@@ -9,6 +9,7 @@ module MeshChat
       def start(options)
         # calling instance to get things going
         @instance = new(options)
+        @instance.start_input_device(options[:input])
         @instance.start_ui(options[:display], options[:on_display_start])
       end
 
@@ -22,7 +23,7 @@ module MeshChat
       self.client_version = options[:client_version] || MeshChat::VERSION
     end
 
-    # @param [class] klass should be something that implements Display::Base
+    # @param [Class] klass should be something that implements Display::Base
     # @param [Proc] proc what to do when starting the UI
     def start_ui(klass, on_display_start)
       self.display = Display::Manager.new(klass)
@@ -30,5 +31,10 @@ module MeshChat
         on_display_start.call if on_display_start
       end
     end
+
+    def start_input_device(klass)
+      # The CLI is a singleton that takes a method of input
+      MeshChat::CLI.create(klass)
+    end
   end
 end

data/lib/meshchat/version.rb

@@ -1,3 +1,3 @@
 module MeshChat
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: meshchat
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -216,22 +216,23 @@ files:
 - README.md
 - lib/meshchat.rb
 - lib/meshchat/cli.rb
-- lib/meshchat/cli/command.rb
-- lib/meshchat/cli/config.rb
-- lib/meshchat/cli/exit.rb
-- lib/meshchat/cli/identity.rb
-- lib/meshchat/cli/import.rb
-- lib/meshchat/cli/init.rb
+- lib/meshchat/cli/base.rb
 - lib/meshchat/cli/input.rb
-- lib/meshchat/cli/irb.rb
-- lib/meshchat/cli/listen.rb
-- lib/meshchat/cli/ping.rb
-- lib/meshchat/cli/ping_all.rb
-- lib/meshchat/cli/server.rb
-- lib/meshchat/cli/share.rb
-- lib/meshchat/cli/stop_listening.rb
-- lib/meshchat/cli/whisper.rb
-- lib/meshchat/cli/who.rb
+- lib/meshchat/command/base.rb
+- lib/meshchat/command/config.rb
+- lib/meshchat/command/exit.rb
+- lib/meshchat/command/identity.rb
+- lib/meshchat/command/import.rb
+- lib/meshchat/command/init.rb
+- lib/meshchat/command/irb.rb
+- lib/meshchat/command/listen.rb
+- lib/meshchat/command/ping.rb
+- lib/meshchat/command/ping_all.rb
+- lib/meshchat/command/server.rb
+- lib/meshchat/command/share.rb
+- lib/meshchat/command/stop_listening.rb
+- lib/meshchat/command/whisper.rb
+- lib/meshchat/command/who.rb
 - lib/meshchat/config/hash_file.rb
 - lib/meshchat/config/settings.rb
 - lib/meshchat/database.rb
@@ -284,5 +285,6 @@ rubyforge_project:
 rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
-summary: MeshChat-0.5.0
+summary: MeshChat-0.6.0
 test_files: []
+has_rdoc: