rubio-radio 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76a2b9f65b8a23dc9b85e85c94815701339e14e3f7fda6d15fd49e2668e5efae
-  data.tar.gz: fa6cb61dda6e988098619c91c4bb32e0d764aaff9cd1b907cbe2207391ca3ced
+  metadata.gz: cfd627d6056a51e35b6ba16a55f6e87ad2e05820ffe16172862c2df5222242b7
+  data.tar.gz: 0bbdcb38795e7a55e00a0699bc0a30e5e2f53ed6b0a0defcaf43d81b0ea641c3
 SHA512:
-  metadata.gz: bc3eaa0c4894f9924d7acfa63e8d877b51c93096996f17351927dcd03b4c8cf2c5b0d02a014d8c8655df8b734be6bda824dd07c27b36766b3459e82b4e861bc9
-  data.tar.gz: 2b044184d2978cbe1686c78a5453b01fc66530df583703bf20a390b86d4d35a5676749564cc3436a068e328f90239aef459d0c86e1362a626aa08561faf9c8c9
+  metadata.gz: 4d6682d2602e24709eabcf65f1110acaf04b6f543e516775f6b9b29661e1c886fbf3c3d647a7e33cba78b159a044aa42a823de0e1046b1cf37b749b778e98907
+  data.tar.gz: d5c4ae797ab9d3985fdeb56c135738f545226dcb0eb5ca199624a17d72a645f4ee4abfbdb0687492099edfa75137527e658d78f2df0414e737e55b5969304ea5

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+## 0.0.4
+
+- Upgrade to glimmer-dsl-libui v0.5.18
+- Replace `table` with new `refined_table` having pagination and filtering support across all columns (including language column)
+- Request the top 10,000 radio stations upon starting the app
+- Command option `--count` for configuring count of top radio stations (`10_000` by default)
+- Command option `--per-page` for number of rows per page to display
+- Command option `--page-count` for displaying page count ("of PAGE_COUNT pages")
+- Command option `--width` for initial window width
+- Command option `--height` for initial window height
+- Command option `--no-menu` to remove the top menu bar and save screen space when not needed (on Mac it is always on because the menu bar does not take application screen space)
+- Help menu About menu item to display message box with application license
+- If `--per-page` is specified and `--height` is not specified, attempt to calculate intial window height for each platform automatically based on number of rows per page
+
+## 0.0.3
+
+- Fix bug
+
+## 0.0.2
+
+- Support Mac and Windows
+
+## 0.0.1
+
+- Initial implementation of rubio-radio

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020 kojix2
+Copyright (c) 2022 kojix2
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,27 +1,120 @@
-# Rubio
+# rubio-radio
+[![Gem Version](https://badge.fury.io/rb/rubio-radio.svg)](https://badge.fury.io/rb/rubio-radio)
 
-![img](https://user-images.githubusercontent.com/5798442/171986696-24bedc38-3811-4c62-a5ad-89c09d015c8a.png)
+Linux
+
+![linux screenshot](screenshots/rubio-radio-linux.png)
+
+Mac
+
+![mac screenshot](screenshots/rubio-radio-mac.png)
+
+Windows
+
+![windows screenshot](screenshots/rubio-radio-windows.png)
 
 :bowtie: Alpha
-## installation
 
-Requirements : [cvlc](https://github.com/videolan/vlc)
+## Installation
+
+### Requirements:
+
+**[VLC](https://github.com/videolan/vlc)**
+
+`rubio` uses the `vlc -I dummy` as the audio playback backend.
+
+On Mac, it is recommended that you install VLC via [Homebrew](https://brew.sh/) to ensure the `vlc` command is added to the PATH environment variable automatically:
+
+```
+brew install vlc
+```
+
+On Windows, install VLC using the [Windows installer](https://www.videolan.org/vlc/download-windows.html), and then add the installed VLC app directory to the PATH environment variable (e.g. `C:\Program Files (x86)\VideoLAN\VLC`) to make the `vlc` command available.
+
+### Ruby Gem:
 
 ```
 gem install rubio-radio
 ```
+
 ## Usage
 
+Run with this command:
+
 ```
 rubio
 ```
 
-Default player is `cvlc`. But you can use any command line player that can take URL of radio station as its first argument.
+The top 10,000 [Radio Browser](https://www.radio-browser.info/) stations are displayed by default. But, you can customize the count (note that currently, there are only about 32,000 [Radio Browser](https://www.radio-browser.info/) stations total).
+
+```
+rubio --count 20000
+```
+
+Default player is `vlc -I dummy`. But, you can use any command line player that can take URL of radio station as its first argument.
 
 ```
 rubio --backend mpg123
 ```
 
+Learn more about `rubio` options:
+
+```
+rubio --help
+```
+
+```
+Usage: rubio [options]
+        --vlc [STR]         use VLC interface STR on the backend [dummy]
+        --mpg123            use mpg123 on the backend
+    -b, --backend STR       command to use as backend player ['vlc -I dummy']
+    -c, --count INT         number of stations to fetch from radio-browser [10000]
+        --per-page INT      number of stations per page [20]
+        --[no-]page-count   show/hide page count
+    -w, --width INT         main window width
+    -h, --height INT        main window height
+        --[no-]menu         show/hide menu
+        --debug             output status of monitored threads
+        --help              show this help message
+        --version           show the rubio version number
+```
+
+Examples:
+
+```
+rubio --vlc              # `vlc -I rc` (interactive command line interface)
+rubio --mpg123           # `rubio --backend mpg123`
+rubio --count 1000       # Displays the top 1,000 Radio Browser stations
+```
+
+Small Screen Example:
+
+```
+rubio --per-page 6 --no-menu
+```
+
+![small screen linux screenshot](screenshots/rubio-radio-linux-example-small.png)
+
+Page Count Example:
+
+```
+rubio --page-count
+```
+
+![page count mac screenshot](screenshots/rubio-radio-mac-example-page-count.png)
+
+## Links
+
+* [Ruby](https://github.com/ruby/ruby)
+  * spawn
+* [Radio Browser](https://www.radio-browser.info/)
+  * [Radio Browser API](https://de1.api.radio-browser.info/)
+* [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui)
+
+## Change Log
+
+[CHANGELOG.md](CHANGELOG.md)
+
 ## LICENSE
 
-MIT
+[MIT](LICENSE.txt)

data/TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+N/A

data/exe/rubio

@@ -2,29 +2,49 @@
 # frozen_string_literal: true
 
 require 'rubio'
-
 require 'optparse'
-backend = 'cvlc'
-debug = false
+
+options = { backend: 'vlc -I dummy' }
+
 opt = OptionParser.new
-opt.on('--vlc') { backend = 'cvlc' }
-opt.on('--mpg123') { backend = 'mpg123' }
-opt.on('--backend CMD') { |b| backend = b }
-opt.on('--debug') { debug = true }
-opt.on('--help') do
+opt.summary_width = 23
+opt.on('--vlc [STR]', 'use VLC interface STR on the backend [dummy]') do |i|
+  i ||= 'dummy'
+  options[:backend] = "vlc -I #{i}"
+end
+opt.on('--mpg123', 'use mpg123 on the backend') { options[:backend] = 'mpg123' }
+opt.on('-b', '--backend STR', String, 'command to use as backend player [\'vlc -I dummy\']') do |b|
+  options[:backend] = b
+end
+opt.on('-c', '--count INT', Numeric, 'number of stations to fetch from radio-browser [10000]') do |c|
+  options[:radio_station_count] = c
+end
+opt.on('--per-page INT', Numeric, 'number of stations per page [20]') { |c| options[:table_per_page] = c }
+opt.on('--[no-]page-count', TrueClass, 'show/hide page count') { |b| options[:show_page_count] = b }
+opt.on('-w', '--width INT', Numeric, 'main window width') { |w| options[:initial_width] = w }
+opt.on('-h', '--height INT', Numeric, 'main window height') { |h| options[:initial_height] = h }
+opt.on('--[no-]menu', TrueClass, 'show/hide menu') { |b| options[:visible_menu] = b }
+opt.on('--debug', 'output status of monitored threads') { options[:debug] = true }
+opt.on('--help', 'show this help message') do
   puts opt
   exit
 end
-opt.on('--version') do
+opt.on('--version', 'show the rubio version number') do
   puts Rubio::VERSION
   exit
 end
-opt.parse!(ARGV)
 
-radio = Rubio::Radio.new(backend, debug: debug)
 begin
-  radio.launch
+  opt.parse!(ARGV)
+rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption => e
+  puts e.message
+  puts opt
+  exit
+end
+
+begin
+  Rubio::Radio.launch(**options)
 rescue StandardError => e
-  radio&.player&.stop_all
+  Rubio::Radio.launched_application&.player&.stop_all
   raise e
 end

data/lib/rubio/player.rb

@@ -4,7 +4,7 @@ module Rubio
   class Player
     attr_accessor :backend, :pid, :thr, :status, :history
 
-    def initialize(backend = 'cvlc')
+    def initialize(backend = OS.linux? ? 'cvlc' : 'vlc -I rc')
       raise unless backend.is_a?(String)
 
       @backend = backend
@@ -25,11 +25,11 @@ module Rubio
     end
 
     def play(url)
-      # do not include spaces in the command line
+      # Do not include spaces in the command line
       # if a space exist :
       #   * sh -c command url # this process with @pid will be killed
       #   * cmmand url        # will not be killd because pid is differennt
-      # if no space : command url
+      # if no space :
       #   * cmmand url        # will be killed by @pid
       raise if url.match(/\s/)
 
@@ -42,7 +42,7 @@ module Rubio
     def stop
       return unless alive?
 
-      r = Process.kill(:TERM, pid)
+      r = Process.kill(OS.windows? ? :KILL : :TERM, pid)
       @thr = nil
       @pid = nil
       r
@@ -50,7 +50,7 @@ module Rubio
 
     def stop_all
       @history.each do |pid, thr|
-        Process.kill(:TERM, pid) if thr.alive?
+        Process.kill(OS.windows? ? :KILL : :TERM, pid) if thr.alive?
       end
     end
   end

data/lib/rubio/radio.rb

@@ -4,40 +4,109 @@ require 'glimmer-dsl-libui'
 
 module Rubio
   class Radio
-    include Glimmer
+    include Glimmer::LibUI::Application
+
+    options :backend, :initial_width, :initial_height
+    option :radio_station_count, default: 10_000
+    option :debug, default: false
+    option :visible_menu, default: true
+    option :show_page_count, default: false
+    option :table_per_page, default: 20
 
     attr_reader :stations, :player
 
-    def initialize(backend, debug: false)
-      @stations_all, @table = RadioBrowser.topvote(1000)
+    before_body do
+      @stations_all, @table = RadioBrowser.topvote(radio_station_count)
       @stations = @stations_all.dup
       @station_uuid = nil
       @player = Player.new(backend)
+      @initial_width = (initial_width || 400).to_i
+      @initial_height = (initial_height || calculate_initial_height).to_i
 
       monitor_thread(debug)
     end
 
-    def monitor_thread(debug)
-      Glimmer::LibUI.timer(1) do
-        p @player.history if debug
-        next if @station_uuid.nil? || @player.alive?
+    body do
+      radio_menu_bar
 
-        message_box("player '#{@player.backend}' stopped!", @player.thr.to_s)
-        stop_uuid(@station_uuid)
-        @station_uuid = nil
-        true
+      window('Rubio', @initial_width, @initial_height) do
+        vertical_box do
+          horizontal_box do
+            @station_table = refined_table(
+              table_columns: {
+                'Play' => { button: {
+                  on_clicked: lambda { |row|
+                    station = @station_table.paginated_model_array[row]
+                    select_station(station)
+                  }
+                } },
+                'name' => :text,
+                'language' => :text
+              },
+              model_array: stations,
+              per_page: table_per_page.to_i,
+              visible_page_count: show_page_count
+            )
+          end
+        end
+
+        on_closing do
+          @player.stop_all
+        end
+      end
+    end
+
+    def radio_menu_bar
+      return unless OS.mac? || visible_menu
+
+      menu('Radio') do
+        menu_item('Stop') do
+          on_clicked do
+            stop_uuid(@station_uuid)
+            @station_uuid = nil
+          end
+        end
+
+        if OS.mac?
+          about_menu_item do
+            on_clicked do
+              about_message_box
+            end
+          end
+        end
+
+        quit_menu_item do
+          on_clicked do
+            @player.stop_all
+          end
+        end
+      end
+
+      menu('Help') do
+        menu_item('About') do
+          on_clicked do
+            about_message_box
+          end
+        end
       end
     end
 
-    def selected_station_at(idx)
-      raise unless idx.is_a?(Integer)
+    def about_message_box
+      license = begin
+        File.read(File.expand_path('../../LICENSE.txt', __dir__))
+      rescue StandardError
+        ''
+      end
+      product = "rubio-radio #{Rubio::VERSION}"
+      message_box(product, "#{product}\n\n#{license}")
+    end
 
-      station_uuid = stations[idx].stationuuid
+    def select_station(station)
+      station_uuid = station.stationuuid
       stop_uuid(@station_uuid)
       if @station_uuid == station_uuid
         @station_uuid = nil
-      else
-        play_uuid(station_uuid)
+      elsif play_uuid(station_uuid)
         @station_uuid = station_uuid
       end
     end
@@ -48,7 +117,7 @@ module Rubio
         @player.play(station.url)
       rescue StandardError => e
         message_box(e.message)
-        raise e
+        return false
       end
       station.playing = true
     end
@@ -61,44 +130,31 @@ module Rubio
       station.playing = false
     end
 
-    def launch
-      window('Rubio', 400, 200) do
-        vertical_box do
-          horizontal_box do
-            stretchy false
-            search_entry do |se|
-              on_changed do
-                filter_value = se.text
-                if filter_value.empty?
-                  @stations.replace @stations_all.dup
-                else
-                  @stations.replace(@stations_all.filter do |row_data|
-                    row_data.name.downcase.include?(filter_value.downcase)
-                  end)
-                end
-              end
-            end
-          end
-          horizontal_box do
-            table do
-              button_column('Play') do
-                on_clicked do |row|
-                  selected_station_at(row)
-                end
-              end
-              text_column('name')
-              text_column('language')
-              cell_rows <= [self, :stations]
-            end
-          end
-        end
-        on_closing do
-          @player.stop_all
-        end
-      end.show
+    private
+
+    def calculate_initial_height
+      if OS.linux?
+        107 + (visible_menu ? 26 : 0) + 24 * table_per_page.to_i
+      elsif OS.mac? && OS.host_cpu == 'arm64'
+        90 + 24 * table_per_page.to_i
+      elsif OS.mac?
+        85 + 19 * table_per_page.to_i
+      else # Windows
+        95 + 19 * table_per_page.to_i
+      end
     end
 
-    private
+    def monitor_thread(debug)
+      Glimmer::LibUI.timer(1) do
+        p @player.history if debug
+        next if @station_uuid.nil? || @player.alive?
+
+        message_box("player '#{@player.backend}' stopped!", @player.thr.to_s)
+        stop_uuid(@station_uuid)
+        @station_uuid = nil
+        true
+      end
+    end
 
     def uuid_to_station(uuid)
       idx = @table[uuid]

data/lib/rubio/station.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 module Rubio
-  BaseStation = Struct.new(:stationuuid, :name, :language, :url)
-
-  class Station < BaseStation
-    attr_accessor :playing
+  Station = Struct.new(:stationuuid, :name, :language, :url, :play) do
+    attr_reader :playing
 
     def initialize(*args, **kwargs)
       super(*args, **kwargs)
-      @playing = false
+      self.playing = false
     end
 
-    def play
-      @playing ? '■' : '▶'
+    def playing=(value)
+      self.play = value ? '■' : '▶'
+      @playing = value
     end
   end
 end

data/lib/rubio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubio
-  VERSION = '0.0.1'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: rubio-radio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - kojix2
+- Andy Maleh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.18
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.18
 description: Rubio is a simple radio player written in Ruby.
 email:
 - 2xijok@gmail.com
@@ -32,8 +33,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
+- TODO.md
 - exe/rubio
 - lib/rubio.rb
 - lib/rubio/player.rb