hearken 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 15943a5107f579fc0766e685b8d792414e7a9c0e
-  data.tar.gz: 434056523b9daed4ff637fba7c47dc111eb88761
+SHA256:
+  metadata.gz: 761d514192be6b3c770a1e81f2ac0a72dfe0de27ede2a5e76fd02d61d1058b15
+  data.tar.gz: 22001a8cdd6df13c97e9bbaf79a32822afdcdba15e2504fde2051b0ebcb849ce
 SHA512:
-  metadata.gz: 7bd1fe7362205feee7edec57999a948cd9b1cff4c43a38f1a75fbf76e9cff33fb413a80cce4b3f5bc56db117d9ba90ff60c7f00b59353a65e61f29d3db6bb9d6
-  data.tar.gz: bc4a16fe354735aff6645b75a07a9c9d33a2c286c62a6ddb7e21d14c1aa773116ee6edd0d67b3b89076d6f5ac0f42deb7060ab8384ad6241fbe0a4a773ac412b
+  metadata.gz: 3ba4d3631c06bc18146bfab3b12ad7dd8fbac92c99fd5dc6105fb73019f5a880147a6563353ff3e4ea7e6a41cd4579b8c0bf65167a51fdad219e627a96ae392e
+  data.tar.gz: 83f77b3a824a01bc87c263e1325695174ffdb8772fd1ded3e4712c6280a6e1f94945dc577d13a9a1d65d57cfe0c38b31535989c2e20320f92c63546778f65d7b

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.1.0

data/Gemfile

@@ -1,2 +1,8 @@
 source 'http://rubygems.org'
-gemspec
+
+gemspec
+
+gem "rake"
+gem "rspec"
+gem "rubocop"
+gem "solargraph"

data/Gemfile.lock

@@ -0,0 +1,95 @@
+PATH
+  remote: .
+  specs:
+    hearken (0.1.3)
+      rainbow (~> 2)
+      shell_shock
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    nokogiri (1.13.8-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rainbow (2.2.2)
+      rake
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.1)
+    rubocop (1.36.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    shell_shock (0.0.5)
+    solargraph (0.47.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.11)
+    unicode-display_width (2.3.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  hearken!
+  rake
+  rspec
+  rubocop
+  solargraph
+
+BUNDLED WITH
+   2.3.3

data/{README.rdoc → README.md}

@@ -1,32 +1,27 @@
-= Hearken
+# Hearken
 
-This is a command line shell for queuing and playing music tracks.
+This is a command line shell for queuing music tracks to be played
+by [vlcraptor](https://github.com/markryall/vlcraptor).
 
 It also extracts id3 tags from audio files for faster search.
 
 This may may be platform independent but at this stage has only been used on mac os x
 
-= Usage
+# Usage
 
 Here you sit expectantly in front of a computer at the command line.
 
-== Install
+## Install
 
     gem install hearken
 
-== Dependencies
+## Dependencies
 
 Tags are currently extracted using ffmpeg.  On mac os x, this can be installed easily using brew:
 
     brew install ffmpeg
 
-Tracks are played using sox (afplay is preinstalled on a mac but does not support as many audio formats) which can also be installed with brew:
-
-    brew install sox
-
-Growl notification (as new tracks are played) will work but only if 'growlnotify' is detected on the path.
-
-== Indexing tracks
+## Indexing tracks
 
     hearken_index DIRECTORY
 
@@ -37,15 +32,15 @@ runs will only query tags for new or modified files so will be very fast.
 
 The index can be regenerated while the console is running and reloaded using the 'reload' command.
 
-== Console
+## Console
 
     hearken
 
-This enters an interactive prompt where you can start/stop the player, search and enqueue tracks.
+This enters an interactive prompt where you can search and enqueue tracks.
 
 The queue will be persisted to ~/.hearken/queue
 
-== Commands
+## Commands
 
     ?
 
@@ -55,7 +50,7 @@ will list all commands
 
 will describe the use and purpose of a particular command
 
-== Main commands
+## Main commands
 
     search iver bon
 
@@ -63,39 +58,6 @@ Searches for tracks with 'bon' and 'iver' in the track, artist or album name (th
 
 Results will be displayed and the ids will be added to the clipboard (for convenient pasting to the '+' command).
 
-    + abc-f 123 456
+    enqueue abc-f 123 456
 
 Enqueues tracks with ids abc, abd, abe, abf, 123 and 456
-
-    play
-
-Starts the player
-
-    stop
-
-Stops the player
-
-    next
-
-Stops and restarts the player (which will kill the currently playing track)
-
-    love
-
-Tells last.fm that you love the current track (this will do nothing if last.fm is not configured or the player is
-stopped)
-
-    rm iver bon
-
-Removes any enqueued track with 'bon' and 'iver' in the track, artist or album name
-
-    setup_scrobbling
-
-Runs through a wizard to configure scrobbling to last.fm
-
-    scrobbling on
-
-Turns scrobbling on (has no effect if scrobbling has not been configured)
-
-    scrobbling off
-
-Turns scrobbling off

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hearken"
+
+# 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/hearken

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << ("#{File.dirname(__FILE__)}/../lib")
+
+require "hearken/monkey_violence"
+require "hearken/console"
+
+Hearken::Console.new.push

data/exe/hearken_index

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << ("#{File.dirname(__FILE__)}/../lib")
+
+require "hearken/indexing"
+
+unless ARGV.size == 1
+  puts "usage: hearken_index path_to_directory_containing_music_collection"
+  exit
+end
+
+Hearken::Indexing::Indexer.new(ARGV.shift).execute

data/hearken.gemspec

@@ -1,48 +1,48 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require 'hearken'
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name        = "hearken"
-  s.version     = Hearken::VERSION
-  s.authors     = ["Mark Ryall"]
-  s.email       = ["mark@ryall.name"]
-  s.homepage    = "http://github.com/markryall/hearken"
-  s.summary     = "command line music player"
-  s.description = <<EOF
-A command line tool to enqueue and play music tracks.
+require_relative "lib/hearken"
 
-This also extracts the tags from a collection of folders.
+Gem::Specification.new do |spec|
+  spec.name        = "hearken"
+  spec.version     = Hearken::VERSION
+  spec.authors     = ["Mark Ryall"]
+  spec.email       = ["mark@ryall.name"]
+  spec.homepage    = "http://github.com/markryall/hearken"
+  spec.summary     = "command line music player"
+  spec.description = <<~EOF
+    A command line tool to enqueue and play music trackspec.
 
-This replaces and combines the functionality from a couple of other gems (audio_library and songbirdsh).
-EOF
+    This also extracts the tags from a collection of folderspec.
 
-  s.post_install_message = <<EOF
-Hey - thanks for installing hearken.
+    This replaces and combines the functionality from a couple of other gems (audio_library and songbirdsh).
+  EOF
 
-Before doing anything else, you should index your music collection by running:
+  spec.post_install_message = <<~EOF
+    Hey - thanks for installing hearken.
 
-  hearken_index path_to_your_music_collection
+    Before doing anything else, you should index your music collection by running:
 
-This could take a while if you have a large collection - you should hear some applause when it's done
+      hearken_index path_to_your_music_collection
 
-After that just run hearken to start playing, queueing and rocking out.
-EOF
+    This could take a while if you have a large collection - you should hear some applause when it's done
 
-  s.license = 'MIT'
-  s.rubyforge_project = "hearken"
+    After that just run hearken to start searching for and then queueing tracks.
+  EOF
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
 
-  s.required_ruby_version = '>= 1.9.2'
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  s.add_dependency 'shell_shock', '~>0'
-  s.add_dependency 'rainbow', '~> 2'
-  s.add_dependency 'nokogiri', '~> 1'
-
-  s.add_development_dependency 'rake', '~>0'
-  s.add_development_dependency 'rspec', '~>3'
+  spec.add_dependency "rainbow", "~> 2"
+  spec.add_dependency "shell_shock"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/hearken/command/enqueue.rb

@@ -1,12 +1,37 @@
-require 'hearken/range_expander'
-require 'hearken/command'
-
-class Hearken::Command::Enqueue
-  include Hearken::Command
-  usage '*<id>'
-  help 'enqueues the list of songs with the specified ids'
-  execute do |text|
-    @expander ||= Hearken::RangeExpander.new
-    @expander.expand(text).each {|id| @player.enqueue id }
+# frozen_string_literal: true
+
+require "yaml"
+require "hearken/range_expander"
+
+module Hearken
+  module Command
+    class Enqueue
+      attr_reader :usage, :help
+
+      def initialize(library)
+        @usage = "*<id>"
+        @help = "enqueues the list of songs with the specified ids"
+        @expander = Hearken::RangeExpander.new
+        @library = library
+      end
+
+      def execute(text)
+        `mkdir -p /tmp/queue`
+        count = (Time.now.to_f * 1000).to_i
+        @expander.expand(text).each do |id|
+          @library.with_track id do |track|
+            meta = {
+              title: track.title,
+              artist: track.artist,
+              album: track.album,
+              length: track.time.to_i,
+              path: track.path
+            }
+            File.open("/tmp/queue/#{count}.yml", "w") { |f| f.puts meta.to_yaml }
+            count += 1
+          end
+        end
+      end
+    end
   end
 end

data/lib/hearken/command/reload.rb

@@ -1,7 +1,19 @@
-require 'hearken/command'
+# frozen_string_literal: true
 
-class Hearken::Command::Reload
-  include Hearken::Command
-  help 'reloads the contents of the music library for fast searching'
-  execute {|ignored| @player.library.reload }
-end
+module Hearken
+  module Command
+    class Reload
+      def initialize(library)
+        @library = library
+      end
+
+      def help
+        "reload the contents of the music library for fast searching"
+      end
+
+      def execute(_text)
+        @library.reload
+      end
+    end
+  end
+end

data/lib/hearken/command/search.rb

@@ -1,24 +1,35 @@
-require 'hearken/command'
+# frozen_string_literal: true
 
-class Hearken::Command::Search
-  include Hearken::Command
-  usage '*<word>'
-  help <<EOF
-searches for tracks containing the specified words (in artist, title or album)
-ids are placed on the clipboard for convenient use with +
-EOF
-  execute do |text|
-    terms = text.split(/\W/)
-    matches = []
-    @player.library.reload unless @player.library.tracks
-    matches = []
-    @player.library.tracks.each do |track|
-      if terms.all? {|term| track.search_string.include? term }
-        puts track
-        matches << track.search_id
+module Hearken
+  module Command
+    class Search
+      attr_reader :help
+
+      def initialize(library)
+        @help = <<~EOF
+          searches for tracks containing the specified words (in artist, title or album)
+          ids are placed on the clipboard for convenient use with +
+        EOF
+        @library = library
+      end
+
+      def execute(text)
+        terms = text.split(/\W/)
+        matches = []
+        @library.tracks.each do |track|
+          if terms.all? { |term| track.search_string.include? term }
+            puts track
+            matches << track.search_id
+          end
+        end
+
+        if matches.size < 50
+          IO.popen("pbcopy", "w") { |clipboard| clipboard.print matches.join " " }
+          puts "Found #{matches.size} matches (ids have been placed on clipboard)"
+        else
+          puts "Found #{matches.size} matches"
+        end
       end
     end
-    puts "Found #{matches.size} matches (ids have been placed on clipboard)"
-    IO.popen('pbcopy','w') { |clipboard| clipboard.print matches.join ' ' }
   end
-end
+end

data/lib/hearken/console.rb

@@ -1,38 +1,21 @@
-require 'shell_shock/context'
+# frozen_string_literal: true
 
-require 'hearken'
-require 'hearken/player'
-require 'hearken/preferences'
-require 'hearken/command'
-
-require 'yaml'
+require "hearken/command/enqueue"
+require "hearken/command/reload"
+require "hearken/command/search"
+require "hearken/library"
+require "shell_shock/context"
 
 module Hearken
   class Console
     include ShellShock::Context
 
-    def with name, *aliases
-      aliases << name.to_s if aliases.empty?
-      add_command Command.load(name, @player), *aliases
-    end
-
-    def with_all *names
-      names.each {|name| with name}
-    end
-
     def initialize
-      preferences = Preferences.new
-      @player = Player.new preferences
-      at_exit { @player.stop }
       @prompt = "hearken > "
-      with :status, "'"
-      with :restart, 'next', 'k'
-      with :list, 'ls'
-      with :enqueue, 'add', '+'
-      with :remove, 'rm', '-'
-      with :start, 'play', 'go'
-      with :search, 'find'
-      with_all *%w{reload stop scrobbling shuffle setup_scrobbling recent love profile}
+      library = Hearken::Library.new
+      add_command(Hearken::Command::Enqueue.new(library), "enqueue")
+      add_command(Hearken::Command::Reload.new(library), "reload")
+      add_command(Hearken::Command::Search.new(library), "search")
     end
   end
-end
+end

data/lib/hearken/debug.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 module Hearken
   module Debug
-    def debug message
-      if ENV['DEBUG']
-        puts message 
-      end
+    def debug(message)
+      puts message if ENV["DEBUG"]
     end
 
     def pause
-      if ENV['DEBUG']
+      if ENV["DEBUG"]
         puts "Hit enter to continue"
         gets
       end
     end
   end
-end
+end

data/lib/hearken/indexing/indexer.rb

@@ -1,31 +1,39 @@
-require 'hearken/paths'
-require 'hearken/indexing/persistant_traverser'
+# frozen_string_literal: true
 
-class Hearken::Indexing::Indexer
-  include Hearken::Paths
+require "hearken/paths"
+require "hearken/indexing/persistant_traverser"
 
-  def initialize path
-    create_paths
-    @path = path
-  end
+module Hearken
+  module Indexing
+    class Indexer
+      include Hearken::Paths
 
-  def execute
-    start = Time.now
-    count = 0
-    traverser = Hearken::Indexing::PersistantTraverser.new @path, index_path
+      def initialize(path)
+        create_paths
+        @path = path
+      end
 
-    traverser.each do |audio_file|
-      count += 1
-      show_progress start, count if count % 1000 == 0
-    end
+      def execute
+        start = Time.now
+        count = 0
+        traverser = Hearken::Indexing::PersistantTraverser.new @path, index_path
 
-    show_progress start, count
+        traverser.each do |_audio_file|
+          count += 1
+          show_progress start, count if (count % 1000).zero?
+        end
 
-    system "play -q #{File.dirname(__FILE__)}/../../../media/applause.mp3"
-  end
-private
-  def show_progress start, count
-    elapsed = Time.now-start
-    $stderr.puts "Processed #{count} audio files in #{elapsed} seconds (#{elapsed/count} per file)"
+        show_progress start, count
+
+        system "afplay #{File.dirname(__FILE__)}/../../../media/applause.mp3"
+      end
+
+      private
+
+      def show_progress(start, count)
+        elapsed = Time.now - start
+        warn "Processed #{count} audio files in #{elapsed} seconds (#{elapsed / count} per file)"
+      end
+    end
   end
-end
+end