spotify_cli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a93c8d7acb6f93eefab2b17060138117e082f4f
-  data.tar.gz: fbc188ee0e6998184d9998ad6b4be26123eb0b9a
+  metadata.gz: 0471a10bcc93c07d50e44f8d8cf461d6c608d269
+  data.tar.gz: 4d9001552b8b6eddb50c72929a20f990ecebdba6
 SHA512:
-  metadata.gz: 72252574e4d32d05a11b61070606a57feb174741a33e1f2d6821c865d5b624e60bc271107646bd5e362cb076925e9b8025252be14b1a5109af5ca8f9a1aa424a
-  data.tar.gz: fab08a382150b0f93c33c63fd64f35ea7400d51d3bfbde238dcb5fdff0278020ae52ab6951fbbcabd686c18bd406e3c509417e4d71f0f85ddab82dc474c60b36
+  metadata.gz: d02251db2948e80df216d0423e1e3d75301167b6291123579814910e3710f06dac38848304269bb89a213eecdcc09bc5fc39cdb9459c5ac03259e7e6fd035e5a
+  data.tar.gz: 558017104ac1d61029fc01df0b904a9a680028be37176d99f04272203c7b44cd4c59242fe26c9457d9afc8702880d6adacb90f68a8d56594e39791da91274e28

data/lib/spotify_cli/api.rb

@@ -1,68 +1,56 @@
 require 'spotify_cli/app'
-require 'helpers/doc'
 
 module SpotifyCli
   class Api
     PLAY = "▶"
     STOP = "◼"
-
     SPOTIFY_SEARCH_API = "https://api.spotify.com/v1/search"
 
     class << self
-      doc <<-EOF
-      Changes to the next song
-
-      {{bold:Usage:}}
-        {{command:spotify next}}
-      EOF
+      # Changes to the next song
+      #
+      # Usage:
+      #   - spotify next
       def next
         puts "Playing next song"
         SpotifyCli::App.next!
       end
 
-      doc <<-EOF
-      Changes to the previous song
-
-      {{bold:Usage:}}
-        {{command:spotify previous}}
-      EOF
+      # Changes to the previous song
+      #
+      # Usage:
+      #   - spotify previous
       def previous
         puts "Playing previous song"
         SpotifyCli::App.prev!
       end
 
-      doc <<-EOF
-      Sets the position in the song
-
-      {{bold:Usage:}}
-        {{command:spotify set_pos 60}}
-      EOF
+      # Sets the position in the song
+      #
+      # Usage:
+      #   - spotify set_pos 60
       def set_pos
         puts "Setting position to #{ARGV[1]}"
         SpotifyCli::App.set_pos!(ARGV[1])
       end
 
-      doc <<-EOF
-      Replays the current song
-
-      {{bold:Usage:}}
-        {{command:spotify replay}}
-      EOF
+      # Replays the current song
+      #
+      # Usage:
+      #   - spotify replay
       def replay
         puts "Restarting song"
         SpotifyCli::App.replay!
       end
       
-      doc <<-EOF
-      Play/Pause the current song, or play a specified artist,
-      track, album, or uri
-      
-      {{bold:Usage:}}
-        {{command:spotify play artist [name]}}
-        {{command:spotify play track [name]}}
-        {{command:spotify play album [name]}}
-        {{command:spotify play uri [spotify uri]}}
-      EOF
+      # Play/Pause the current song, or play a specified artist,
+      # track, album, or uri
+      #
+      # Usage:
+      #   - spotify play artist [name]
+      #   - spotify play track [name]
+      #   - spotify play album [name]
+      #   - spotify play uri [spotify uri]
       def play_pause
         args = ARGV[1..-1]
 
@@ -92,25 +80,21 @@ module SpotifyCli
         status
       end
 
-      doc <<-EOF
-      Pause/stop the current song
-
-      {{bold:Usage:}}
-        {{command:spotify pause}}
-        {{command:spotify stop}}
-      EOF
+      # Pause/stop the current song
+      #
+      # Usage:
+      #   - spotify pause
+      #   - spotify stop
       def pause
         SpotifyCli::App.pause!
         status
       end
 
-      doc <<-EOF
-      Show the current song
-
-      {{bold:Usage:}}
-        {{command:spotify}}
-        {{command:spotify status}}
-      EOF
+      # Show the current song
+      #
+      # Usage:
+      #   - spotify
+      #   - spotify status
       def status
         stat = SpotifyCli::App.status
 
@@ -137,26 +121,27 @@ module SpotifyCli
         end
       end
 
-      doc <<-EOF
-      Display Help
-
-      {{bold:Usage:}}
-       {{command:spotify help}}
-      EOF
+      # Display Help
+      #
+      # Usage:
+      #  - spotify help
       def help(mappings)
+        require 'method_source'
+
         Dex::UI.frame('Spotify CLI', timing: false) do
           puts "CLI interface for Spotify"
         end
 
         mappings.group_by { |_,v| v }.each do |k, v|
           v.reject! { |mapping| mapping.first == k.to_s }
-          doc = get_doc(self.class, k.to_s).strip_heredoc
+          doc = self.method(k).comment.gsub(/^#\s*/, '')
+          doc = strip_heredoc(doc)
 
           Dex::UI.frame(k, timing: false) do
-            puts puts Dex::UI.resolve_text(doc)
+            puts strip_heredoc(doc)
             next if v.empty?
-            puts Dex::UI.resolve_text("{{bold:Aliases:}}")
-            v.each { |mapping| puts Dex::UI.resolve_text(" - {{info:#{mapping.first}}}") }
+            puts "\nAliases:"
+            v.each { |mapping| puts " - #{mapping.first}" }
           end
         end
       end
@@ -177,6 +162,20 @@ module SpotifyCli
 
         `#{curl_cmd}`.strip.split("\n")
       end
+
+      # The following methods is taken from activesupport
+      #
+      # https://github.com/rails/rails/blob/d66e7835bea9505f7003e5038aa19b6ea95ceea1/activesupport/lib/active_support/core_ext/string/strip.rb
+      #
+      # All credit for this method goes to the original authors.
+      # The code is used under the MIT license.
+      #
+      # Strips indentation by removing the amount of leading whitespace in the least indented
+      # non-empty line in the whole string
+      #
+      def strip_heredoc(str)
+        str.gsub(/^#{str.scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
+      end
     end
   end
 end

data/lib/spotify_cli/app.rb

@@ -1,101 +1,135 @@
 module SpotifyCli
   class App
-    def self.state
-      oascript('tell application "Spotify" to player state as string')
-    end
+    class << self
+      # Return the state Spotify is in.
+      # Either "playing" or "paused"
+      #
+      # @return state [String]
+      #
+      def state
+        oascript('tell application "Spotify" to player state as string')
+      end
 
-    def self.status
-      artist = oascript('tell application "Spotify" to artist of current track as string')
-      album = oascript('tell application "Spotify" to album of current track as string')
-      track = oascript('tell application "Spotify" to name of current track as string')
-      duration = oascript(<<-EOF)
-        tell application "Spotify"
-        set durSec to (duration of current track / 1000) as text
-        set tM to (round (durSec / 60) rounding down) as text
-        if length of ((durSec mod 60 div 1) as text) is greater than 1 then
-            set tS to (durSec mod 60 div 1) as text
-        else
-            set tS to ("0" & (durSec mod 60 div 1)) as text
-        end if
-        set myTime to tM as text & ":" & tS as text
-        end tell
-        return myTime
-      EOF
-      position = oascript(<<-EOF)
-        tell application "Spotify"
-        set pos to player position
-        set nM to (round (pos / 60) rounding down) as text
-        if length of ((round (pos mod 60) rounding down) as text) is greater than 1 then
-            set nS to (round (pos mod 60) rounding down) as text
-        else
-            set nS to ("0" & (round (pos mod 60) rounding down)) as text
-        end if
-        set nowAt to nM as text & ":" & nS as text
-        end tell
-        return nowAt
-      EOF
+      # Return a hash representing the current status of Spotify
+      # Contains state, current artist, current album, current track,
+      # duration of the current track, position in the current track,
+      # percent of the track complete
+      #
+      # @return status [Hash]
+      #
+      def status
+        artist = oascript('tell application "Spotify" to artist of current track as string')
+        album = oascript('tell application "Spotify" to album of current track as string')
+        track = oascript('tell application "Spotify" to name of current track as string')
+        duration = oascript(<<-EOF)
+          tell application "Spotify"
+          set durSec to (duration of current track / 1000) as text
+          set tM to (round (durSec / 60) rounding down) as text
+          if length of ((durSec mod 60 div 1) as text) is greater than 1 then
+              set tS to (durSec mod 60 div 1) as text
+          else
+              set tS to ("0" & (durSec mod 60 div 1)) as text
+          end if
+          set myTime to tM as text & ":" & tS as text
+          end tell
+          return myTime
+        EOF
+        position = oascript(<<-EOF)
+          tell application "Spotify"
+          set pos to player position
+          set nM to (round (pos / 60) rounding down) as text
+          if length of ((round (pos mod 60) rounding down) as text) is greater than 1 then
+              set nS to (round (pos mod 60) rounding down) as text
+          else
+              set nS to ("0" & (round (pos mod 60) rounding down)) as text
+          end if
+          set nowAt to nM as text & ":" & nS as text
+          end tell
+          return nowAt
+        EOF
 
-      {
-        state: state,
-        artist: artist,
-        album: album,
-        track: track,
-        duration: duration,
-        position: position,
-        percent_done: percent_done(position, duration)
-      }
-    end
+        {
+          state: state,
+          artist: artist,
+          album: album,
+          track: track,
+          duration: duration,
+          position: position,
+          percent_done: percent_done(position, duration)
+        }
+      end
 
-    def self.play_pause!
-      oascript('tell application "Spotify" to playpause')
-    end
+      # Play or Pause Spotify
+      #
+      def play_pause!
+        oascript('tell application "Spotify" to playpause')
+      end
 
-    def self.pause!
-      oascript('tell application "Spotify" to pause')
-    end
+      # Pause Spotify
+      #
+      def pause!
+        oascript('tell application "Spotify" to pause')
+      end
 
-    def self.play_uri!(uri)
-      oascript("tell application \"Spotify\" to play track \"#{uri}\"")
-    end
+      # Pause a given URI
+      #
+      # @param uri [String] Spotify URI returned from the API
+      #
+      def play_uri!(uri)
+        oascript("tell application \"Spotify\" to play track \"#{uri}\"")
+      end
 
-    def self.next!
-      oascript('tell application "Spotify" to next track')
-    end
+      # Change to the next song
+      #
+      def next!
+        oascript('tell application "Spotify" to next track')
+      end
 
-    def self.set_pos!(pos)
-      oascript("tell application \"Spotify\" to set player position to #{pos}")
-    end
+      # Change to the previous song
+      #
+      def previous!
+        oascript(<<-EOF)
+        tell application "Spotify"
+            set player position to 0
+            previous track
+        end tell
+        EOF
+      end
 
-    def self.previous!
-      oascript(<<-EOF)
-      tell application "Spotify"
-          set player position to 0
-          previous track
-      end tell
-      EOF
-    end
+      # Set position in song to the given point
+      #
+      # @param pos [Int] Position in seconds
+      #
+      def set_pos!(pos)
+        oascript("tell application \"Spotify\" to set player position to #{pos}")
+      end
 
-    def self.replay!
-      oascript('tell application "Spotify" to set player position to 0')
-    end
+      # Replay the current song from the beginning
+      #
+      def replay!
+        oascript('tell application "Spotify" to set player position to 0')
+      end
 
-    def self.percent_done(position, duration)
-      seconds = ->(parts) do
-        acc = 0
-        multiplier = 1
-        while part = parts.shift
-          acc += part.to_f * multiplier
-          multiplier *= 60
+      private
+
+      def percent_done(position, duration)
+        seconds = ->(parts) do
+          acc = 0
+          multiplier = 1
+          while part = parts.shift
+            acc += part.to_f * multiplier
+            multiplier *= 60
+          end
+          acc
         end
-        acc
+        pos_parts = position.split(':').reverse
+        dur_parts = duration.split(':').reverse
+        seconds.call(pos_parts) / seconds.call(dur_parts)
       end
-      pos_parts = position.split(':').reverse
-      dur_parts = duration.split(':').reverse
-      seconds.call(pos_parts) / seconds.call(dur_parts)
-    end
 
-    def self.oascript(command)
-      `osascript -e '#{command}'`.strip
+      def oascript(command)
+        `osascript -e '#{command}'`.strip
+      end
     end
   end
 end

data/lib/spotify_cli/version.rb

@@ -1,3 +1,3 @@
 module SpotifyCli
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/spotify_cli.rb

@@ -3,6 +3,11 @@ require 'dex/ui'
 require 'spotify_cli/api'
 
 module SpotifyCli
+  # CLI interface for the application
+  # Converts arguments to a mapped command and executes the command
+  #
+  # @param args [Array] CLI arugments
+  #
   def self.call(args)
     mappings = {
       'next' => :next,

data/spotify_cli.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables   = ['spotify']
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'method_source', '~> 0'
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spotify_cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Julian Nadeau
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,6 @@ files:
 - lib/dex/ui/spinner.rb
 - lib/dex/ui/stdout_router.rb
 - lib/dex/ui/terminal.rb
-- lib/helpers/doc.rb
 - lib/spotify_cli.rb
 - lib/spotify_cli/.DS_Store
 - lib/spotify_cli/api.rb
@@ -110,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Spotify Application wrapper for control via command line

data/lib/helpers/doc.rb

@@ -1,62 +0,0 @@
-module MethodAddedHook
-  private
-
-  def method_added(meth)
-    method_added_hook(meth)
-    super
-  end
-
-  def singleton_method_added(meth)
-    method_added_hook(meth)
-    super
-  end
-
-  def method_added_hook(meth)
-    @@__last_defined_doc__ ||= nil
-    return if !defined?(@@__last_defined_doc__) || @@__last_defined_doc__.nil?
-    @@__class_docs__ ||= {}
-    @@__class_docs__[self.to_s] ||= {}
-
-    @@__class_docs__[self.to_s][meth] = @@__last_defined_doc__
-    @@__last_defined_doc__ = nil
-  end
-end
-
-class Module
-  private
-  prepend MethodAddedHook
-
-  def doc(str, meth = nil)
-    return @@__class_docs__[self.to_s][meth] = str if meth
-    @@__last_defined_doc__ = str
-  end
-
-  def defdoc(str, meth, &block)
-    @@__class_docs__[self.to_s][meth] = str
-    define_method(meth, &block)
-  end
-end
-
-module Kernel
-  def get_doc(klass, meth)
-    docs = klass.class_variable_get(:@@__class_docs__)
-    docs[self.to_s][meth.to_sym] if docs && docs[self.to_s]
-  end
-end
-
-
-class String
-  # The following methods is taken from activesupport
-  #
-  # https://github.com/rails/rails/blob/d66e7835bea9505f7003e5038aa19b6ea95ceea1/activesupport/lib/active_support/core_ext/string/strip.rb
-  #
-  # All credit for this method goes to the original authors.
-  # The code is used under the MIT license.
-  #
-  # Strips indentation by removing the amount of leading whitespace in the least indented
-  # non-empty line in the whole string
-  #
-  def strip_heredoc
-    self.gsub(/^#{self.scan(/^[ \t]*(?=\S)/).min}/, "".freeze)
-  end
-end