mchat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3f0aebc0b0bcebdc9caad7172d05d3474fef6b0064023f280401a8736f19fbb6
+  data.tar.gz: dda796643faa8e779b12a9e4ce1714edc4625563848dfef30af3e1e93acd4276
+SHA512:
+  metadata.gz: db62700957058f56b4ad13ea5b4f5d2e7e8b2508316e31365c11bbebf646e6ac7b053f499bf0cdf2f7a096a4c95a69e701b416e2b1eab5bf453f2ab42a55bd47
+  data.tar.gz: 4965daf82bc576a79ac1a05cd86ff925b9daebf4e22ce904a61814af39ae2a91c245a58da436d8e746185ded5b9947d2a74a609fa8058a510c763b95f306ed32

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mchat.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+# gem "rubocop", "~> 1.21"
+
+gem "rainbow"
+
+gem "httparty"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    mchat (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.2)
+    multi_xml (0.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+
+PLATFORMS
+  arm64-darwin-21
+  ruby
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  httparty
+  mchat!
+  minitest (~> 5.0)
+  rainbow
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Mark24Code
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,115 @@
+# Mchat
+
+Mchat is IRC like chat client.
+
+![preview](./assets/preview.png)
+
+This is Mchat client repo, server repo:
+
+* [mchat_server](https://github.com/Mark24Code/mchat_server)
+
+## Installation
+
+install it yourself as:
+
+    $ gem install mchat
+
+## Usage
+
+```ruby
+# enter mchat
+mchat
+
+# /h for help
+/h
+```
+
+
+
+----
+
+# Features
+
+### repl
+
+* [x] repl主流程
+* [x] 命令模块化
+* [x] help 命令
+* [x] channel 命令
+* [x] join 命令
+* [x] name 命令
+* [x] message 命令
+* [x] leave 命令
+* [x] quit 命令
+* [x] clear 命令
+* [x] default mode
+* [x] boss mode
+* [x] 存储 Pstore 实现取代文件
+### timeline
+
+* [x] timeline 独立
+* [x] 支持简单命令
+* [x] hook_quit
+
+### union
+
+* [x] 联合打开screen window
+* [x] 联合关闭
+
+
+### TODO features
+
+* [ ] 密码登录用户，超级管理员
+* [ ] 密码登录channel
+* [x] 创建频道
+* [x] 配置化
+~~* [ ] temp~~
+* [ ] 日志
+~~* [ ] 优化代码，现在太分散~~
+~~* [ ] 是否要实现一个 tail 包装命令~~
+* [x] 打包下载
+* [ ] README update HOWTO
+* [x] 指令插件化
+* [ ] set 命令
+* [ ] 打字机效果(需要单独的渲染，不可以文件输出)
+* [ ] eval 增加连续组合命令
+* [ ] 可以封装在docker里
+* [ ] 合理化初始化参数
+* [ ] config 三个 path 和dir 部分处理
+* [x] cli 关闭通知timeline关闭
+* [ ] 加密消息
+
+
+# mchat_experiment
+
+Private Repo
+
+[mchat_experiment](https://github.com/Mark24Code/mchat_experiment)
+
+## 实验脚本
+
+* module 的模块化写法
+* 进程间 PStore 通信
+  * 模块化
+  * 面向对象实例
+
+* Tempfile 的使用
+* MessageQueue 线程队列的使用
+* 使用 screen & screenrc 创造双屏应用
+
+#### TUI
+
+模拟一个前端基于命令的浏览器
+
+* eventloop 模拟
+* vnode 虚拟dom的模拟：jsx 构建cli界面
+* hooks 模拟
+* lambda_vnode 纯函数式的写法模拟jsx组件
+* repl 时间循环模拟
+* 基于Curses 封的TUI
+* 基于消息队列封装的client
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+# require "rubocop/rake_task"
+
+# RuboCop::RakeTask.new
+
+Rake::TestTask.new(:preview) do |t|
+  system("gem build mchat.gemspec && gem install ./mchat-#{Mchat::VERSION}.gem")
+end
+
+
+task default: %i[test]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "mchat"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/mchat

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require_relative "../lib/mchat/comps/font"
+class String
+  include Mchat::Style
+end
+require_relative "../lib/mchat/comps/user_config"
+class MchatApp
+  include Mchat::UserConfig
+
+  def initialize
+    first_time_use
+    @screenrc_dir = Pathname.new(Dir.home).join('.mchat')
+    @screenrc = Pathname.new(Dir.home).join('.mchat').join('screenrc')
+  end
+
+  def get_screenrc
+    if !screenrc_exist?
+      create_screenrc
+    end
+  end
+  def screenrc_exist?
+    File.exist? @screenrc
+  end
+
+  def create_screenrc
+    require 'fileutils'
+    FileUtils.mkdir_p(@screenrc_dir) unless File.exist?(@screenrc_dir)
+    File.open(@screenrc, 'w') do |f|
+  init_config = %Q(
+  split -v
+
+  screen -t timeline 'mchat_timeline'
+  focus
+  screen -t repl 'mchat_repl'
+  )
+    f << init_config
+    end
+  end
+
+  def run
+    get_screenrc
+
+    # 使用Screen
+
+    # 左边文件读取记录，实现读取的信息流
+    # 右边是命令行，实现输入的控制流
+    # 这样组合来完成应用的交互形态
+
+    # https://www.gnu.org/software/screen/manual/screen.html#Split
+
+    # screenrc 里面写的就是 文档里面的命令
+    # split 是默认上下  split -v 是左右
+    # focus 是永远关注在下一个（cycle来工作的） 对应按键  C-a Tab
+
+    # -c 读取配置
+    system("screen -c #{@screenrc.to_s}")
+  end
+end
+
+
+MchatApp.new.run

data/exe/mchat_repl

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require_relative "../lib/mchat"
+
+repl = Mchat::Repl.new
+
+trap("INT") { repl.quit_command_run }
+
+repl.run

data/exe/mchat_timeline

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+require_relative "../lib/mchat/timeline"
+
+  tl = Mchat::Timeline.new
+
+  trap("INT") { tl.hook_close }
+
+  tl.run

data/exe/mchat_uninstall

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+puts "[mchat] clean config ..."
+system("rm -rf .mchat")
+puts "[mchat] uninstall mchat ..."
+system("gem uninstall mchat")
+
+puts "[mchat] all files have uninstalled. Bye :D"

data/lib/mchat/api.rb

@@ -0,0 +1,131 @@
+require "json"
+require "httparty"
+
+module SafeProtect
+  refine String do
+    def safe
+      json_parse self.strip.dump[1 .. -2]
+    end
+
+    def escape
+      json_parse self.dump[1 .. -2]
+    end
+
+    def unescape
+      "\"#{self}\"".undump
+    end
+  end
+end
+
+using SafeProtect
+
+module Mchat
+
+  module StatusCode
+    # 2000 success
+    Success = 2000
+
+    # 5000 server error
+    # 50xx server machine
+    ServerError = 5000
+    # 51xx logic error
+
+    # 52xx database auth
+    UserHaveExist = 5201 #用户已存在
+    UserNotExist  = 5202
+    # 53xx database data
+    InvalidParams = 5301
+    RecordHaveExist = 5302
+    RecordNotExist = 5303
+  end
+
+  class Request
+    include HTTParty
+
+    def initialize(server)
+      self.class.base_uri server
+      @headers = {"Accept": "application/json"}
+    end
+
+    def json_parse(resp)
+      JSON.parse(resp.body)
+    end
+
+    def server_home
+      json_parse self.class.get("/")
+    end
+
+    def ping_server
+      json_parse self.class.get("/ping")
+    end
+
+    def get_server_timestamp
+      json_parse self.class.get("/timestamp")
+    end
+
+    def conn_server_startup
+      json_parse self.class.get("/startup")
+    end
+
+    def get_channels
+      # 获得 channels列表
+      json_parse self.class.get("/channels")
+    end
+
+    def get_channel(channel_name)
+      # 获得 channels 详情
+      json_parse self.class.get("/channels/#{channel_name}")
+    end
+
+    def create_channel(channel_name)
+      # 创建用户频道
+      json_parse self.class.post("/channels/#{channel_name}")
+    end
+
+    def delete_channel(channel_name)
+      json_parse self.class.delete("/channels/#{channel_name}")
+    end
+
+    def join_channel(channel_name, user_name)
+      json_parse self.class.post(
+        "/channels/#{channel_name}/join",
+        body: { user_name: user_name }.to_json,
+        headers: @headers
+      )
+    end
+
+    def leave_channel(channel_name, user_name)
+      json_parse self.class.post(
+        "/channels/#{channel_name}/leave",
+        body: { user_name: user_name }.to_json,
+        headers: @headers
+      )
+    end
+
+    def ping_channel(channel_name, user_name)
+      json_parse self.class.post(
+        "/channels/#{channel_name}/ping",
+        body: { user_name: user_name }.to_json,
+        headers: @headers
+      )
+    end
+
+    def create_channel_message(channel_name, user_name, content)
+      json_parse self.class.post(
+        "/channels/#{channel_name}/messages",
+        body: {
+          user_name: user_name,
+          content: content
+        }.to_json,
+        headers: @headers
+      )
+    end
+
+    def fetch_channel_message(channel_name)
+      json_parse self.class.get(
+        "/channels/#{channel_name}/messages",
+        headers: @headers
+      )
+    end
+  end
+end

data/lib/mchat/command.rb

@@ -0,0 +1,29 @@
+module Mchat
+  module Command
+    # Class ########################3
+    CommandComps = {}
+    CommandConditions = []
+
+    def self.mount_command(name, mod)
+      CommandComps[name] = mod
+    end
+
+    def self.load_command(name)
+      h = CommandComps
+      unless cmd = h[name]
+        require_relative "./commands/#{name}"
+        raise RodaError, "command #{name} did not mount itself correctly in Mchat::Command" unless cmd = h[name]
+      end
+      cmd
+    end
+
+    def self.install(cmd, *args, &block)
+      cmd = Mchat::Command.load_command(cmd) if cmd.is_a?(Symbol)
+      raise MchatError, "Invalid cmd type: #{cmd.class.inspect}" unless cmd.is_a?(Module)
+
+      include(cmd::InstanceMethods) if defined?(cmd::InstanceMethods)
+      extend(cmd::ClassMethods) if defined?(cmd::ClassMethods)
+      cmd.configure(self, *args, &block) if cmd.respond_to?(:configure)
+    end
+  end
+end

data/lib/mchat/commands/bossmode.rb

@@ -0,0 +1,34 @@
+module Mchat
+  module Command
+    # Command Clear
+    module BossMode
+      def self.configure(repl)
+        CommandConditions.push({
+          name: 'bossmode',
+          description: "b[ossmode]\tclean mchat screen & print fake logs",
+          help_condition: ['bossmode'],
+          help_doc: :bossmode_help_doc,
+          command_condition: ['/bossmode', '/b'],
+          command_run: :bossmode_command_run
+        })
+      end
+      module InstanceMethods
+        def bossmode_help_doc
+        _puts %Q(
+#{"Help: BossMode".style.bold}
+
+command: /bossmode
+explain: clear chat screen and print fake logs. use agan recover messages.
+
+  )
+        end
+
+        def bossmode_command_run(repl = nil)
+          timeline_bossmode
+        end
+      end
+    end
+
+    mount_command :bossmode, BossMode
+  end
+end

data/lib/mchat/commands/channel.rb

@@ -0,0 +1,87 @@
+module Mchat
+  module Command
+    module Channel
+      def self.configure(repl)
+        CommandConditions.push({
+          name: 'channel',
+          description: "ch[annel]\tfind channel list & get channel info",
+          help_condition: ['channel','ch'],
+          help_doc: :channel_help_doc,
+          command_condition: ['/channel', /\/channel (.*)/, '/ch', /\/ch (.*)/],
+          command_run: :channel_command_run
+        })
+      end
+      module InstanceMethods
+        def channel_help_doc
+          _puts %Q(
+#{"Help: Channel".style.bold}
+
+command: /channel <channel_name>
+explain: login the channel
+
+)
+        end
+
+        def channel_command_run(channel_name = nil)
+          if !channel_name
+            # 返回全部节点
+            resp = _api.get_channels
+            all_channels = resp.fetch("data")
+
+            # cli
+            content = "Mchat Channels:\n".style.primary
+            if all_channels.length > 0
+              all_channels.each do |c|
+                content << "* #{c}\n"
+              end
+            else
+              # TODO create channel
+              content << "Opps."
+            end
+
+            content << ""
+            content << "type `/join <channel_name>` to join the channel.\n"
+            _puts content
+
+            # printer
+            _mchat_action("fetch all channels")
+            # _puts2 content
+          else
+            # 指定节点
+            resp = _api.get_channel(channel_name)
+            code = resp.fetch("code")
+
+            if code == StatusCode::RecordNotExist
+              content = "#{"Mchat Channel:".style.primary} #{channel_name}\n"
+              content << "channel not exist. use follow create new channel.\n"
+              content << ">> /channel_new <channel name>"
+              _puts content
+              return
+            else
+              # 存在这个channel
+              data = resp.fetch("data")
+
+              online_users = data["online_users"]
+
+              # cli
+              content = "#{"Mchat Channel:".style.primary} #{channel_name}\n"
+              content << "#{"online users:".style.jade}\n"
+              online_users.each do |c|
+                c = c.split(":").last # name
+                content << "* #{c.style.jade}\n"
+              end
+              content << ""
+              content << "total: #{online_users.length}.\n"
+              _puts content
+
+              # printer
+              _mchat_action("channel #{channel_name} info:")
+              # _puts2 content
+            end
+          end
+        end
+      end
+    end
+    mount_command :channel, Channel
+  end
+end

data/lib/mchat/commands/channel_new.rb

@@ -0,0 +1,61 @@
+module Mchat
+  module Command
+    module ChannelNew
+      def self.configure(repl)
+        CommandConditions.push({
+          name: 'channel_new',
+          description: "channel_new\tcreate new channel",
+          help_condition: ['channel_new'],
+          help_doc: :channel_new_help_doc,
+          command_condition: ['/channel_new', /\/channel_new (.*)/],
+          command_run: :channel_new_command_run
+        })
+      end
+      module InstanceMethods
+        def channel_new_help_doc
+          _puts %Q(
+#{"Help: Channel New".style.bold}
+
+command: /channel_new <new_channel_name>
+explain: create a new channel
+
+)
+        end
+
+        def channel_new_command_run(channel_name = nil)
+          if !channel_name
+            content << "/channel_new <new_channel_name>\n".style.warn
+            content << "new_channel_name should not be nil\n".style.warn
+            _puts content
+          else
+            # 指定节点
+            resp = _api.create_channel(channel_name)
+            code = resp.fetch("code")
+
+            if code == StatusCode::RecordHaveExist
+              content = "#{"Mchat Channel:".style.primary} #{channel_name}\n"
+              content << "channel <#{channel_name}> have exist. use follow create new channel.\n"
+              content << "type `/channel_new <new_channel_name>`"
+              content << "you can also find all channels:"
+              content << "type `/channel`"
+              _puts content
+              return
+            elsif code == StatusCode::Success
+              # 存在这个channel
+              data = resp.fetch("data")
+
+              online_users = data["online_users"]
+
+              # cli
+              _mchat_action("you create channel: #{channel_name}")
+              _puts "create channel: #{channel_name} success. try auto join."
+
+              _dispatch(:join_command_run, channel_name)
+            end
+          end
+        end
+      end
+    end
+    mount_command :channel_new, ChannelNew
+  end
+end