rss-reader 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 91651a5c206fb1a61bf999096c56371739054035f3159b24d35be455c6c3240a
+  data.tar.gz: 2f61494a072baa0e3eb0f36d75ecd91b6c96758acf94cc1846ce3af16ec8e1f0
+SHA512:
+  metadata.gz: 2c6e70a3269a5b89e6d7a06453ffc2d490db113210154e4f053d171e3e1ac37fd0572e4e1d5d40de43f651297a635356ff41740319d23dd139ba50d700f817dd
+  data.tar.gz: b38b14167613eb6c76f2f4c4c7b11444912a2720daff9a11ac414d263dc67a88c03b4b455171915bf65a709d9b3634d65e5af267d2b7e3fb6e25aa7a698b731f

data/README.md

@@ -0,0 +1,24 @@
+# RSS Reader
+
+CLI RSS reader by Ruby lang
+
+## 安装
+
+`gem install rss-reader`
+
+## 使用
+
+启动
+
+`rss-reader`
+
+查看帮助
+
+`h` 或者 `help`
+
+
+## 订阅链接
+
+编辑 `~/subscribe-rss.list` 格式（目前只支持 RSS 格式订阅）
+
+`#` 是注释符号

data/exe/rss-reader

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative '../lib/client'
+RssClient.new.run

data/lib/client.rb

@@ -0,0 +1,144 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative './core'
+require 'readline'
+
+LIST = %w[
+  help
+  clear
+  quit
+  exit
+  update
+  reset
+  channel
+].sort
+
+HELP_DOC = <<~HELP
+  Help:
+    help/h:    \t print help message
+    clear/c:   \t clear screen
+    quit/exit: \t quit
+    exit:      \t quit
+    update:    \t update all channel data
+    reset/r:   \t channel list
+    q:         \t quit current view
+
+  Config:
+    ~/subscribe-rss.list
+
+HELP
+comp = proc { |s| LIST.grep(/^#{Regexp.escape(s)}/) }
+Readline.completion_append_character = ' '
+Readline.completion_proc = comp
+
+# RSS Client
+class RssClient
+  # rubocop:disable Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/AbcSize,Metrics/BlockLength,Metrics/PerceivedComplexity
+  def initialize
+    @rss = nil
+    @channel_index = -1
+    @item_index = -1
+    @debug = false
+    init_rss
+  end
+
+  def init_rss
+    puts 'RSS Reader'.green
+    puts 'loading....'.green
+    @rss = RSSManager.new
+    system('clear')
+    render
+  end
+
+  def render
+    # TODO: index check & catch
+    if @channel_index == -1 && @item_index == -1
+      # render channels list
+      puts '[RSS Reader]'.blue
+      puts '----'
+      puts @rss.channel_titles
+    elsif @channel_index >= 0 && @item_index == -1
+      # render channel item list
+      puts "[Channel] #{@rss.channel_title_by_index(@channel_index)}".blue
+      puts '----'
+      puts @rss.channel_items(@channel_index)
+    elsif @channel_index >= 0 && @item_index >= 0
+      # render item content
+      channel = @rss.channels[@channel_index]
+      content = channel.content_by_index(@item_index)
+      Utils.display_by_reader(content)
+      @item_index = -1
+    end
+  end
+
+  def reset_index
+    @channel_index = -1
+    @item_index = -1
+  end
+
+  def back_index
+    reset_index
+  end
+
+  def print_index
+    return unless @debug
+
+    puts "@channel_index: #{@channel_index}"
+    puts "@item_index: #{@item_index}"
+  end
+
+  def update_channels
+    puts 'Updating channels ... '.green
+    @rss.update_channels
+    puts "Updated #{Time.now}".green
+  end
+
+  def run
+    loop do
+      line = Readline.readline('> ', true)
+      break if line.nil? || line == 'quit'
+
+      line = line.strip
+      case line
+      when 'quit', 'exit'
+        exit 0
+      when 'h', 'help'
+        puts HELP_DOC
+      when /(\d+)/
+        index = ::Regexp.last_match(1)
+        index = index.strip.to_i
+        if @channel_index >= 0
+          @item_index = index if index >= 0 && index < @rss.channels[@channel_index].items.length
+        elsif index >= 0 && index < @rss.channels.length
+          @channel_index = index
+        end
+        print_index
+        render
+      when 'c', 'clear'
+        puts 'clear channel'
+        system('clear')
+        print_index
+        render
+      when 'r', 'reset'
+        puts 'reset channel'
+        reset_index
+        print_index
+        render
+      when 'q'
+        back_index
+        print_index
+        system('clear')
+        render
+      when 'update'
+        update_channels
+        print_index
+        render
+      else
+        # do nothing
+        print_index
+        puts 'nothing happened...'
+      end
+    end
+  end
+end

data/lib/core.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require_relative './patch'
+require_relative './utils'
+require 'rss'
+require 'open-uri'
+require 'async'
+
+# RSS Channel class
+class RSSChannel
+  attr_accessor :feed
+
+  def initialize(channel_url)
+    @channel_url = channel_url
+    @feed = nil
+
+    fetch_channel
+  end
+
+  def fetch_channel
+    URI.open(@channel_url) do |rss|
+      @feed = RSS::Parser.parse(rss)
+      # Utils.display_by_reader(@feed)
+    end
+  rescue OpenURI::HTTPError
+    puts "[Request Error] #{@channel_url}"
+  end
+
+  def items
+    items = []
+    @feed.items.each_with_index do |item, index|
+      items.push "#{"[#{index}]".green} #{Utils.url_text(item.title.to_s.dark_green, item.link)}"
+    end
+    items
+  end
+
+  def open_url_by_index(index)
+    item = @feed.items[index]
+    Utils.open_url(item.link)
+  end
+
+  def description_by_index(index)
+    item = @feed.items[index]
+    item.description
+  end
+
+  def content_by_index(index)
+    Utils.html_to_text(description_by_index(index))
+  end
+end
+
+# RSS Manager: Core Channel Manager Class
+class RSSManager
+  attr_accessor :channels, :current_channel_index
+
+  def initialize
+    config_file = File.join(ENV['HOME'], 'subscribe-rss.list')
+    unless File.exist?(config_file)
+      File.open(config_file, 'w') do |f|
+        f << 'https://www.ruby-lang.org/en/feeds/news.rss'
+      end
+    end
+    @channel_config_path = config_file
+    @channel_urls = []
+    @channels = []
+
+    init_pipeline
+  end
+
+  def load_channel_urls
+    channel_lines = File.open(@channel_config_path).readlines.map(&:strip)
+    @channel_urls = channel_lines.filter do |x|
+      x != '' && x.index('#') != 0
+    end
+    @channel_urls
+  end
+
+  def init_channels
+    @channel_urls.each do |channel_url|
+      @channels.push(RSSChannel.new(channel_url))
+    end
+  end
+
+  def update_channels
+    time_start = Time.now
+    async_fetch
+    time_end = Time.now
+    puts "use: #{time_end - time_start}"
+  end
+
+  def sync_fetch
+    # use: 6.022412
+    @channels.each(&:fetch_channel)
+  end
+
+  def async_fetch
+    # use: 2.854694
+    Async do |task|
+      @channels.each do |ch|
+        task.async do
+          ch.fetch_channel
+        end
+      end
+    end
+  end
+
+  def init_pipeline
+    load_channel_urls
+    init_channels
+    update_channels
+  end
+
+  def channel_titles
+    titles = []
+    @channels.each_with_index do |x, index|
+      titles.push "#{"[#{index}]".green} #{x.feed.channel.title.to_s.blue} (#{x.feed.channel.items.length}) \n"
+    end
+    titles
+  end
+
+  def channel_title_by_index(channel_index)
+    channel = @channels[channel_index]
+    channel.feed.channel.title
+  end
+
+  def channel_by_index(channel_index)
+    @channels[channel_index]
+  end
+
+  def channel_items(channel_index = 0)
+    @channels[channel_index].items
+  end
+end
+
+# rss_atom = RSSChannel.new('https://www.ruby-lang.org/en/feeds/news.rss')
+# rss_atom.open_url_by_index(1)
+# puts rss_atom.content_by_index(1)
+#
+# m = RSSManager.new
+# puts m.channel_titles
+# first = m.channel_by_index(1)
+# puts first.items

data/lib/patch.rb

@@ -0,0 +1,56 @@
+require 'colorize'
+
+class String
+  def red = colorize(self, "\e[1m\e[31m")
+  def green = colorize(self, "\e[1m\e[32m")
+  def dark_green = colorize(self, "\e[32m")
+  def yellow = colorize(self, "\e[1m\e[33m")
+  def blue = colorize(self, "\e[1m\e[34m")
+  def dark_blue = colorize(self, "\e[34m")
+  def purple = colorize(self, "\e[35m")
+  def dark_purple = colorize(self, "\e[1;35m")
+  def cyan = colorize(self, "\e[1;36m")
+  def dark_cyan = colorize(self, "\e[36m")
+  def pure = colorize(self, "\e[0m\e[28m")
+  def bold = colorize(self, "\e[1m")
+  def colorize(text, color_code) = "#{color_code}#{text}\e[0m"
+end
+
+class String
+  def mv_up(n = 1)
+    cursor(self, "\033[#{n}A")
+  end
+
+  def mv_down(n = 1)
+    cursor(self, "\033[#{n}B")
+  end
+
+  def mv_fw(n = 1)
+    cursor(self, "\033[#{n}C")
+  end
+
+  def mv_bw(n = 1)
+    cursor(self, "\033[#{n}D")
+  end
+
+  def cls_upline
+    cursor(self, "\e[K")
+  end
+
+  def cls
+    # cursor(self, "\033[2J")
+    cursor(self, "\e[H\e[2J")
+  end
+
+  def save_position
+    cursor(self, "\033[s")
+  end
+
+  def restore_position
+    cursor(self, "\033[u")
+  end
+
+  def cursor(text, position)
+    "\r#{position}#{text}"
+  end
+end

data/lib/utils.rb

@@ -0,0 +1,27 @@
+require 'tty-link'
+require 'nokogiri'
+
+module Utils
+  def self.url_text(text, url)
+    TTY::Link.link_to(text, url)
+  end
+
+  def self.html_to_text(html_text)
+    Nokogiri::HTML(html_text).text
+  end
+
+  def self.display_by_reader(content)
+    system("echo '#{content}' | less")
+  end
+
+  def self.open_url(url)
+    cmd = case RbConfig::CONFIG['host_os']
+          when /mswin|mingw|cygwin/ then 'start '
+          when /darwin/ then 'open '
+          when /linux|bsd/ then 'xdg-open '
+          else raise 'No OS detected'
+          end
+
+    system cmd + url
+  end
+end

data/rss-reader.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name        = 'rss-reader'
+  s.version     = '1.0.0'
+  s.summary     = 'RSS Reader!'
+  s.description = 'A simple cli RSS Reader'
+  s.authors     = ['Mark24']
+  s.email       = 'mark.zhangyoung@gmail.com'
+  s.files       = ['lib/*.rb']
+  s.homepage    =
+    'https://github.com/Mark24Code/rss-reader'
+  s.license = 'MIT'
+
+  s.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  s.bindir = 'exe'
+  s.executables = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+  s.add_dependency 'async', '~> 2.6'
+  s.add_dependency 'colorize', '~> 1.1.0'
+  s.add_dependency 'nokogiri', '~> 1.15.4'
+  s.add_dependency 'rss', '~> 0.3.0'
+  s.add_dependency 'tty-link', '~> 0.1.1'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: rss-reader
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark24
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: async
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !ruby/object:Gem::Dependency
+  name: rss
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: tty-link
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+description: A simple cli RSS Reader
+email: mark.zhangyoung@gmail.com
+executables:
+- rss-reader
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- exe/rss-reader
+- lib/client.rb
+- lib/core.rb
+- lib/patch.rb
+- lib/utils.rb
+- rss-reader.gemspec
+homepage: https://github.com/Mark24Code/rss-reader
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: RSS Reader!
+test_files: []