episode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e4f2ae42c41aa916a30370e05e9150baa621cbdffcf1e668f8afc81889f91af8
+  data.tar.gz: 2abf7c83c530be2d76497a682e5605370fb57cec86fe066246a840e934ead5ee
+SHA512:
+  metadata.gz: 83caee9209e83b7b02a1085bcb33e6f795652436b2470af80366d5b12a231e25bf69194c43c3f4e09b2bdf72d45f7439a6edda6f26f9e135ef8c2db8d01f3493
+  data.tar.gz: 483aa5505b1fd3db50b94cdc198f120e394c0fde02675d29df1666a4410ae4a5d193a21e8b36c0eeb8508051905664cfce0a9dbaa6ecf45c1f43bbde2496542d

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Maksim Esterkin
+
+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,121 @@
+# Episode (ep)
+Remembers what file in the directory you viewed last time.
+Enumerates all files in the directory and allows to reference them only by a number.
+
+## Installation
+
+#### Using `gem`
+```
+gem install episode
+```
+
+#### Manual
+Clone this repository and add `bin/ep` to your `$PATH`.
+
+## Quick Start
+
+Episode creates `.episode` file in the current directory when you open some file with it. By default it will be looking for `mkv`, `avi` or `mp4` files and will use `mpv` as the viewer. Read [examples](#viewing-different-file-formats) below to see how to change this behavior.
+
+List episodes in the current directory.
+```
+ep
+``` 
+
+Watch episode #7
+```
+ep 7
+```
+
+Watch with VLC
+```
+ep 7 -v vlc
+``` 
+
+Make VLC default player for this directory (add `-g` to make it global)
+```
+ep set viewer vlc
+```
+
+Show config for the current directory
+```
+ep cfg
+```
+
+Show global config
+```
+ep cfg -g
+```
+
+## Usage (`ep help`)
+```
+Usage: ep <command> [options] 
+
+  Quick start:
+    ep ls                     show episodes in the current directory with their indexes
+    ep                        same as `ep ls`
+    ep 7                      play episode #7
+    ep next                   play next episode (or first)
+    ep set viewer vlc -g      use VLC as default video player (by default it's mpv)
+
+  Commands:
+        ls                    List all episodes and their idnexes
+    (s) status                Show information about last view
+    (l) last                  Re-play episode watched last time 
+    (n) next                  Play next episode
+    (p) prev                  Play previous episode (one before 'last') 
+        <number>              Same as `ep no <number>` (i.e. `ep 11`)
+        no <number>           Play episode by number (i.e. `ep no 11`) 
+    (c) cfg                   Display config for the current directory
+        set <param> <value>   Set config parameter (i.e. `ep set last 11`)
+    (r) reset [param]         Reset config parameter (i.e. `ep reset last`)
+    (h) help                  Show this help
+
+  Options for `last`, `next`, `prev`, and `no`:
+    -n, --name                       Show episode name, but don't play it (i.e. `ep -n 11`)
+    -o, --no-update                  Don't update .episode file
+    -v, --viewer <program>           Set viewer
+
+  Options for `cfg`, `set` and `reset`:
+    -g, --global                     Edit (or show) global config ($HOME/.config/episode)
+```
+
+## More Examples
+
+#### Coloring the 'last' pointer
+```
+ep -g set pointer '\u001b[33;1m*\u001b[0m'
+```
+<img src="https://static.hedlx.org/episode_coloring_pointer.png">
+
+#### Purging all `episode` data from the directory
+```
+ep r
+```
+
+#### Restoring global default settings
+```
+ep r -g
+```
+
+#### Viewing different file formats
+
+###### Pictures
+```
+ep set formats png,jpg
+ep set viewer feh
+```
+
+###### PDF
+```
+ep set formats pdf
+ep set viewer zathura
+```
+
+###### Any
+```
+ep set formats ''
+ep set viewer 'hexdump -C'
+
+# Invoking:
+ep next | less
+```

data/bin/ep

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require_relative '../lib/episode'
+
+PROGRAM_NAME = File.basename($PROGRAM_NAME)
+CFG_FILENAME = '.episode'
+CFG_GLOBAL_DIR = ENV['XDG_CONFIG_HOME'] || File.join(ENV['HOME'], '.config')
+CFG_GLOBAL_PATH = File.join(CFG_GLOBAL_DIR, 'episode')
+
+options = {}
+opt_parser = 
+  OptionParser.new do |opts|
+    opts.program_name = 'episode'
+    opts.version = "v#{Episode::VERSION}"
+    opts.banner = <<~EOS
+      Usage: #{PROGRAM_NAME} <command> [options]  
+
+        Quick start:
+          ep ls                     show episodes in the current directory with their indexes
+          ep                        same as `ep ls`
+          ep 7                      play episode #7
+          ep next                   play next episode (or first)
+          ep set viewer vlc -g      use VLC as default video player (by default it's mpv)
+
+        Commands:
+              ls                    List all episodes and their idnexes
+          (s) status                Show information about last view
+          (l) last                  Re-play episode watched last time 
+          (n) next                  Play next episode
+          (p) prev                  Play previous episode (one before 'last') 
+              <number>              Same as `#{PROGRAM_NAME} no <number>` (i.e. `#{PROGRAM_NAME} 11`)
+              no <number>           Play episode by number (i.e. `#{PROGRAM_NAME} no 11`) 
+          (c) cfg                   Display config for the current directory
+              set <param> <value>   Set config parameter (i.e. `#{PROGRAM_NAME} set last 11`)
+          (r) reset [param]         Reset config parameter (i.e. `#{PROGRAM_NAME} reset last`)
+          (h) help                  Show this help
+    EOS
+      
+    opts.separator("\n  Options for `last`, `next`, `prev`, and `no`:")
+
+    opts.on('-n', '--name', "Show episode name, but don't play it (i.e. `#{PROGRAM_NAME} -n 11`)") do
+      options[:name] = true
+    end
+    
+    opts.on('-o', '--no-update', "Don't update .episode file") do
+      options[:update] = false
+    end
+
+    opts.on('-v', '--viewer <program>', 'Set viewer') do |viewer|
+      options[:viewer] = viewer
+    end
+
+    opts.separator("\n  Options for `cfg`, `set` and `reset`:")
+
+    opts.on('-g', '--global', "Edit (or show) global config (#{CFG_GLOBAL_PATH})") do
+      options[:global] = true
+    end
+  end
+
+begin
+  opt_parser.parse!
+
+  case
+  when ARGV[0].nil?
+    command = 'ls'
+    args = []
+  when %w[h help].include?(ARGV[0])
+    $stderr.puts opt_parser.help
+    return
+  when ARGV[0] =~ /^\d+$/
+    command = 'no'
+    args = [ARGV[0]]
+  else
+    command = ARGV[0]
+    args = ARGV[1..]
+  end
+
+  Episode.new(options).public_send(command, *args)
+rescue OptionParser::ParseError => e
+  $stderr.puts <<~EOS
+    Error: #{e.message}
+    Run `#{PROGRAM_NAME} -h` to see the list of available options.
+  EOS
+rescue Episode::NoCommandError => e
+  $stderr.puts <<~EOS
+    Error: Unknown command '#{e.message}'. 
+    Run `#{PROGRAM_NAME} -h` to see the list of available commands.
+  EOS
+rescue Episode::CommandError => e
+  $stderr.puts "Error: #{e.message}"
+end

data/episode.gemspec

@@ -0,0 +1,31 @@
+require_relative "lib/episode"
+
+Gem::Specification.new do |s|
+    s.name = 'episode'
+    s.version = "#{Episode::VERSION}.0.0"
+    s.summary = 'Console assistant app for watching series'
+    s.license = 'MIT'
+    s.description = 'Episode (ep) remembers what file in the directory you viewed last time. Enumerates all files in the directory and allows to reference them only by a number.'
+    s.authors = ['Maksim Esterkin']
+    s.email = 'esterkimx@gmail.com'
+    s.homepage = 'https://github.com/esterkimx/episode'
+
+    s.files = [
+        'lib/episode.rb', 
+        'lib/episode/config.rb',
+        'README.md',
+        'LICENSE.md',
+        'episode.gemspec'
+    ]
+
+    s.required_ruby_version = '>= 2.3.0'
+    s.bindir = 'bin'
+    s.executables = ['ep']
+
+    s.metadata = {
+        'bug_tracker_uri' => 'https://github.com/esterkimx/episode/issues',
+        'documentation_uri' => 'https://github.com/esterkimx/episode/blob/master/README.md',
+        'homepage_uri' => 'https://github.com/esterkimx/episode',
+        'source_code_uri' => 'https://github.com/esterkimx/episode'
+    }
+end

data/lib/episode.rb

@@ -0,0 +1,277 @@
+require 'fileutils'
+require 'time'
+require 'io/console'
+require_relative 'episode/config'
+
+class Episode
+  VERSION = 1
+
+  class NoCommandError < StandardError; end
+  class CommandError < StandardError; end
+
+  def initialize(opts) 
+    @is_name = opts[:name] || false
+    @is_update = opts[:update] != false
+    @is_global = opts[:global] || false
+    @viewer = opts[:viewer]
+  end
+
+  def ls
+    if episodes.empty?
+      raise CommandError, 'No episodes found in the directory'
+    end
+
+    total = episodes.size
+    padding = Math.log10(config.index_from_zero ? total - 1 : total).floor + 1
+
+    episodes.each_with_index do |filename, id|
+      id_fixed = config.index_from_zero ? id : id + 1
+      id_formatted = id_fixed.to_s.rjust(padding, '0')
+      separator = (config.last && id == last_id) ? config.pointer : '|'
+      puts "#{id_formatted} #{separator} #{filename}"
+    end
+  end
+
+  def status
+    puts "#{config.index_from_zero ? last_id : last_id + 1} #{config.pointer} #{config.last}"
+
+    unless config.last_played_at
+      puts 'Time unknown'
+      return
+    end
+
+    seconds_ago = (Time.now - config.last_played_at).floor
+    days_ago = seconds_ago / (3600 * 24)
+    hours_ago = (seconds_ago % (3600 * 24)) / 3600
+    minutes_ago = (seconds_ago % 3600) / 60
+    time_passed = 
+      if seconds_ago < 60
+        "#{seconds_ago} second#{seconds_ago == 1 ? '' : 's'}" 
+      else
+        [
+          days_ago > 0 ? "#{days_ago} day#{days_ago == 1 ? '' : 's'}" : nil,
+          hours_ago > 0 ? "#{hours_ago} hour#{hours_ago == 1 ? '' : 's'}" : nil,
+          minutes_ago > 0 ? "#{minutes_ago} minute#{minutes_ago == 1 ? '' : 's'}" : nil
+        ].compact.join(" ")
+      end
+      
+    puts "#{config.last_played_at} (#{time_passed} ago)" 
+  end
+
+  alias s status
+
+  def last
+    play 
+  end
+
+  alias l last
+
+  def next
+    config.last = config.last ? episode_by_id(last_id + 1) : episodes.first
+    play 
+  end
+
+  alias n next
+
+  def prev
+    config.last = episode_by_id(last_id - 1)
+    play 
+  end
+
+  alias p prev
+
+  def no(n_str)
+    n =
+      begin
+        Integer(n_str.gsub /^0*(\d)/, '\\1') 
+      rescue ArgumentError
+        raise CommandError, <<~EOS
+          Invalid value '#{n_str}'.
+          `no` command expects natural number.
+        EOS
+      end
+    config.last = episode_by_id(n - 1)
+    play
+  end
+
+  def cfg
+    cfg_h = global? ? config.global.to_h : config.to_h
+    cfg_h.each { |param, val| puts "#{param}: #{val}" }
+  end
+
+  alias c cfg
+
+  def set(param, value)
+    unless config.respond_to? param
+      raise CommandError, <<~EOS
+        Unknown config parameter '#{param}'.
+        Run `#{PROGRAM_NAME} cfg` to see the list of available parameters.
+      EOS
+    end
+
+    cfg, cfg_path =
+      if global? 
+        [config.global, CFG_GLOBAL_PATH]
+      else
+        [config, CFG_FILENAME]
+      end
+
+    cfg.send "#{param}=", parse_config_value(param, value)
+    config_save_safe(cfg_path, cfg)
+  rescue NotLocal
+    raise CommandError, "Parameter '#{param}' is not global"
+  end
+
+  def reset(param = nil)
+    cfg_path = global? ? CFG_GLOBAL_PATH : CFG_FILENAME  
+
+    if param.nil?
+      puts "Reset all config parameters (delete #{cfg_path})? (y|N)"
+      FileUtils.rm_f(cfg_path) if 'y' == $stdin.getch
+    else
+      set(param, nil)
+    end
+  end
+
+  alias r reset
+
+  private
+
+  def method_missing(*args)
+    raise NoCommandError, args.first
+  end
+
+  def name?
+    @is_name
+  end
+
+  def update?
+    @is_update
+  end
+
+  def global?
+    @is_global
+  end
+
+  def config
+    return @config if @config
+
+    global_cfg =
+      if File.exists? CFG_GLOBAL_PATH
+        File.open(CFG_GLOBAL_PATH, 'r') { |io| Config.load io }
+      end
+
+    @config = 
+      if File.exists? CFG_FILENAME
+        File.open(CFG_FILENAME, 'r') { |io| Config.load io, global: global_cfg }
+      else
+        Config.new(global: global_cfg)
+      end
+  end
+
+  def viewer
+    @viewer || config.viewer
+  end
+
+  def episodes
+    @episodes ||= 
+      Dir["./*{#{config.formats.join(',')}}"]
+        .select { |path| File.file? path }
+        .map { |path| File.basename(path) }.sort
+  end
+
+  def episode_by_id(id)
+    ep = episodes[id] if id >= 0
+    ep || raise(CommandError, 'Episode not found') 
+  end
+
+  def parse_episode_ref(ref)
+    case
+    when File.file?(ref)
+      ref
+    when ref =~ /^\d+$/
+      ref_i = ref.to_i
+      id = config.index_from_zero ? ref_i : ref_i - 1
+      episode_by_id(id)
+    else
+      raise CommandError, "Can't parse episode reference '#{ref}'"
+    end
+  end
+
+  def last_safe
+    unless config.last
+      raise CommandError, <<~EOS
+        Last episode is undefined.
+        Please run:
+          `#{PROGRAM_NAME} #{config.index_from_zero ? 0 : 1}` or `ep next` -- to watch first episode
+          `#{PROGRAM_NAME} set last <episode-number>` or `#{PROGRAM_NAME} set last <file-name>` -- to define where to start from
+      EOS
+    end
+
+    unless File.file? config.last
+      raise CommandError, <<~EOS
+        '#{config.last}' doesn't exist.
+        To fix it run:
+          `#{PROGRAM_NAME} set last <file-name>` or `#{PROGRAM_NAME} set last <episode-number>` -- to define last file
+          `#{PROGRAM_NAME} reset last` -- to erase erroneous value 
+      EOS
+    end
+
+    config.last
+  end
+
+  def last_id
+    @last_id ||= episodes.find_index(last_safe)
+  end
+
+  def play
+    if name?
+      puts last_safe
+    else
+      $stderr.puts "Viewing #{last_safe}"
+      system(*viewer.split(' '), File.join(config.dir, last_safe))
+    end
+
+    if update?
+      config.last_played_at = Time.now
+      config_save_safe(CFG_FILENAME, config)
+    end
+  end
+
+  def parse_config_value(param, value)
+    return if value.nil?
+
+    case param
+    when 'last'
+      parse_episode_ref(value)
+    when 'index_from_zero'
+      unless %w[true false].include? value
+        raise CommandError, <<~EOS
+          Invalid value '#{value}' for 'index_from_zero'.
+          Should be true or false.
+        EOS
+      end
+      value == "true"
+    when 'last_played_at'
+      begin
+        Time.parse value 
+      rescue ArgumentError
+        raise CommandError, "Can't parse time"
+      end
+    when 'pointer'
+      "\"#{value}\"".undump
+    when 'formats'
+      value.split ','
+    else
+      value
+    end
+  end
+
+  def config_save_safe(path, cfg)
+    File.open(path, 'w') { |io| cfg.save(io) }
+  rescue Errno::EACCES
+    raise CommandError, <<~EOS
+      Failed to save the episode data: can't write to this directory.
+    EOS
+  end
+end

data/lib/episode/config.rb

@@ -0,0 +1,133 @@
+require 'json'
+require 'time'
+
+class Episode
+  DEFAULT_CFG = {
+    viewer: 'mpv',
+    index_from_zero: false,
+    pointer: '*',
+    formats: %w[mkv mp4 avi]
+  }
+
+  class NotLocal < StandardError; end
+
+  class Config
+    attr_writer :viewer
+    attr_writer :index_from_zero
+    attr_writer :pointer
+    attr_writer :formats
+
+    def self.load(io, opts = {})
+      new JSON.parse(io.read, symbolize_names: true).merge(opts)
+    end
+
+    def initialize(opts = {})
+      @global_cfg = opts[:global]
+
+      unless global?
+        @local = 
+          {
+            dir: opts[:dir],
+            last: opts[:last],
+            last_played_at: (Time.parse opts[:last_played_at] rescue nil)
+          }
+      end
+
+      @viewer = opts[:viewer]
+      @index_from_zero = opts[:index_from_zero]
+      @pointer = opts[:pointer]
+      @formats = opts[:formats]
+    end
+
+    def save(io)
+      io.write JSON.pretty_generate(to_h(remove_defaults: true))
+    end
+
+    def to_h(remove_defaults: false)
+      if remove_defaults
+        (@local || {}).merge({ 
+          viewer: @viewer,
+          index_from_zero: @index_from_zero,
+          pointer: @pointer,
+          formats: @formats
+        }).compact
+      else
+        local_h = { 
+          dir: dir,
+          last: last,
+          last_played_at: last_played_at
+        } unless global?
+        
+        (local_h || {}).merge({
+          viewer: viewer,
+          index_from_zero: index_from_zero,
+          pointer: pointer,
+          formats: formats
+        })
+      end
+    end
+
+    def global?
+      @global_cfg.nil?
+    end
+
+    def global
+      @global_cfg 
+    end
+
+    def dir
+      get_local(:dir) { Dir.pwd }
+    end
+
+    def dir=(new_val)
+      set_local :dir, new_val
+    end
+
+    def last
+      get_local :last
+    end
+
+    def last=(new_val)
+      set_local :last, new_val
+    end
+
+    def last_played_at
+      get_local :last_played_at
+    end
+
+    def last_played_at=(new_val)
+      set_local :last_played_at, new_val
+    end
+
+    def viewer
+      @viewer || default(:viewer)
+    end
+
+    def index_from_zero
+      @index_from_zero || default(:index_from_zero)
+    end
+
+    def pointer 
+      @pointer || default(:pointer)
+    end
+
+    def formats
+      @formats || default(:formats)
+    end
+
+    private
+
+    def get_local(param)
+      @local && @local[param] || (block_given? ? yield : default(param))
+    end
+
+    def set_local(param, new_val)
+      raise NotLocal if global?
+      @local[param] = new_val
+    end
+
+    def default(param) 
+      @global_cfg&.public_send(param) || DEFAULT_CFG[param]
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: episode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Maksim Esterkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies: []
+description: Episode (ep) remembers what file in the directory you viewed last time.
+  Enumerates all files in the directory and allows to reference them only by a number.
+email: esterkimx@gmail.com
+executables:
+- ep
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- bin/ep
+- episode.gemspec
+- lib/episode.rb
+- lib/episode/config.rb
+homepage: https://github.com/esterkimx/episode
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/esterkimx/episode/issues
+  documentation_uri: https://github.com/esterkimx/episode/blob/master/README.md
+  homepage_uri: https://github.com/esterkimx/episode
+  source_code_uri: https://github.com/esterkimx/episode
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Console assistant app for watching series
+test_files: []