track_list 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c32d55d4cb898bc51d11d9405f0ad05b0f50a6e85813e8efa4ef3ee31f8ece31
-  data.tar.gz: 4ab44145070f803818b6a5c81f3150582a4fb9355b032c09aa0283437bee4196
+  metadata.gz: 479a619595efec9dc0388637532e62eb2d85f49d1286c5632d14c44d9d45e373
+  data.tar.gz: ce39a80fae12241bce71c8527c9cd83ca0c237473e2fabcd7c22ed2a3a63df3d
 SHA512:
-  metadata.gz: 66cd3907f193b343e8547460aebf8254786a6d3f228800cabb51c8a11355dc9fdd0f07d11c6044fb289b85b8541ea207e4ad71b856e679e91ce82102ead7a791
-  data.tar.gz: 8c2ce484fe8c0cdcd954f9b57ec447f79c6004138146fbb0f532646306196c1d8336da48d81ffc192aae023ac24c9c5483b25774b21f16c412f3c30a0cdff8cc
+  metadata.gz: 8d64d0707d4b68b5471574b88e7b5b4c14fdf1fa49c79c64c1246ba99cd56e848e59e5e305fc02c5ad4aea2c07f5d1f39e00c26e534ba375eb6c7f4f445f8370
+  data.tar.gz: 9f626e37d349ca83a565eeb0a2d60a52dab46be1fd8419b2f4c7369290be48d228807eec3f1fa668299a5082446d5cb5f30f49cae0d7673a032c07688232156f

data/CHANGELOG.md

@@ -4,9 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2019-08-09
+- Added custom templating so a user can define what is output to their tracklist.
+- TemplateParser class that helps with reading/writing to a config/template file.
+- Commented code with RDoc.
+- Cleaned up codebase more.
+
+## [0.1.1] - 2019-08-08
+### Fixed
+- Missing ARGV argument no longer throws a fatal error but shows a helpful message instead.
+- Cleaned up codebase a bit.
+
 ## [0.1.0] - 2019-08-08
 ### Added
 - Separation of concerns compared to old codebase. Current codebase is cleaner.
--- TrackParser class that parses a single track.
--- DirectoryParser class that parses a directory, using TrackParser.
--- TimeConverter class that puts seconds into hour:minute:seconds for easy readability on track lengths.
+- TrackParser class that parses a single track.
+- DirectoryParser class that parses a directory, using TrackParser.
+- TimeConverter class that puts seconds into hour:minute:seconds for easy readability on track lengths.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    track_list (0.1.1)
+    track_list (0.2.0)
       taglib-ruby (~> 0.7)
 
 GEM

data/README.md

@@ -1,6 +1,8 @@
 # TrackList
 
-This program aims to provide an easy way to get a tracklist for an album in your terminal, or you could use it in your own program if you wish. At the moment, there is a pre-defined format that should work for importing tracklists into MusicBrainz easily. Customizable output is a future goal of this project.
+[![Gem Version](https://badge.fury.io/rb/track_list.svg)](https://badge.fury.io/rb/track_list)
+
+This program aims to provide an easy way to get a tracklist for an album in your terminal, or you could use it in your own program if you wish. Define your own custom template to output your tracklists or use the predefined one. The predefined one is below. If you'd like to customize this output, scroll down to Configuration.
 
 ## Sample Output
 ```
@@ -43,6 +45,23 @@ Or install it yourself as:
 
     $ gem install track_list
 
+## Configuration
+
+You can define custom output for your tracklist. On first run of the program, the program will create a .track_list.yaml file in your home directory. The default output is as follows:
+
+`output: "%TRACK%. %TITLE% (%LENGTH%)"`
+
+You can change this string with the following tags to format it the way you want it:
+- `%TRACK%` - The track number of a given audio file.
+- `%TITLE%` - The title tag of a given audio file.
+- `%LENGTH%` - The length of a given audio file in `[hours:minutes:seconds]`
+- `%ARTIST%` - The artist tag of a given audio file.
+- `%ALBUM%` - The album tag of a given audio file.
+- `%YEAR%` - The year tag of a given audio file.
+- `%GENRE%` - The genre tag of a given audio file.
+- `%COMMENT%` - The comment tag of a given audio file.
+
+If a tag does not exist, you should see an empty space in the output. If you are getting some sort of error, please file an issue.
 
 ## Usage
 

data/bin/tracklist

@@ -2,13 +2,8 @@
 
 require "track_list"
 require 'getoptlong'
+require 'track_list/template_parser'
 
-# 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
 opts = GetoptLong.new(
   [ '--help', '-h', GetoptLong::NO_ARGUMENT ]
 )
@@ -33,7 +28,14 @@ if ARGV.length != 1
 end
 
 dir = TrackList::DirectoryParser.new(ARGV[0])
+template_parser = TrackList::TemplateParser.new('~/.track_list.yaml')
+
+# Let's create a default config file if one does not exist.
+unless template_parser.config_exists?
+  template_parser.create_default_config
+end
 
+# Loop over each track and output to terminal.
 dir.parse.each do |track|
   puts track.parse if track.parse.is_a? String
 end

data/lib/track_list.rb

@@ -2,6 +2,10 @@ require 'track_list/version'
 require 'track_list/track_parser'
 require 'track_list/directory_parser'
 require 'track_list/time_converter'
+require 'track_list/template_parser'
+require 'yaml'
+
+# This module defines the base of our program.
 
 module TrackList
   class Error < StandardError; end

data/lib/track_list/directory_parser.rb

@@ -1,11 +1,25 @@
 require 'track_list/track_parser'
 
 module TrackList
+
+    # This class is a helper to parse through an entire directory of tracks
+    # and return an array of parsed, formatted tracks.
+
     class DirectoryParser
+
+        # When initializing the class, pass in a directory with audio files
+        # to be parsed.
+        #
+        # @param [String] dir The directory to be parsed.
+
         def initialize(dir)
             @dir = dir
         end
 
+        # This method gets a list of files to be parsed.
+        #
+        # @return [Array] Files to be parsed.
+
         def list
             files = []
             Dir.foreach(@dir) do |file|
@@ -14,6 +28,12 @@ module TrackList
             return files
         end
 
+        # This method does the bulk of the work. It loops over each of the files we
+        # got in +self.list+ and returns an array of +TrackList::TrackParser+ objects
+        # to be looped over elsewhere.
+        #
+        # @return [Array] of +TrackList::TrackParser+ objects.
+
         def parse
             files = self.list.sort
             parsed_tracks = []
@@ -28,4 +48,4 @@ module TrackList
 
         
     end
-end
+end

data/lib/track_list/template_parser.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+module TrackList
+
+    # A helper class to read/write a config file.
+
+    class TemplateParser
+
+        # Pass in a file path to read/write the config file.
+
+        def initialize(config_path)
+            @config_path = config_path
+        end
+
+        # Return the config file in a Ruby-readable format.
+
+        def load
+            return YAML.load(File.open(File.expand_path(@config_path)))
+        end
+
+        # Check if the config file already exists.
+
+        def config_exists?
+            if (File.exist?(File.expand_path(@config_path)))
+                return true
+            else
+                return false
+            end
+        end
+
+        # Create a default config file with some basic settings.
+
+        def create_default_config
+            config = { "output" => "%TRACK%. %TITLE% (%LENGTH%)" }
+            out_file = File.new(File.expand_path(@config_path), 'w')
+            out_file.puts(config.to_yaml)
+            out_file.close
+        end
+
+    end
+end

data/lib/track_list/time_converter.rb

@@ -1,21 +1,29 @@
 module TrackList
+
+    # A helper class to convert an audio track's length in seconds to a more readable format.
+
     class TimeConverter
+
+        # Pass in an integer of seconds to this class.
+
         def initialize(time)
             @time = time
         end
 
-        # https://www.codethought.com/2010/01/seconds-minutes-hours-converting-time-units-in-ruby/
+        # This method formats the time into a readable format.
+        # See: https://www.codethought.com/2010/01/seconds-minutes-hours-converting-time-units-in-ruby/
+
         def format_time
-            #find the seconds
+            # Find the seconds.
             seconds = @time % 60
         
-            #find the minutes
+            # Find the minutes.
             minutes = (@time / 60) % 60
         
-            #find the hours
+            # Find the hours.
             hours = (@time / 3600)
         
-            #format the time
+            # Format the time.
             return hours.to_s + ":" + format("%02d", minutes.to_s) + ":" + format("%02d", seconds.to_s)
         end
     end

data/lib/track_list/track_parser.rb

@@ -1,13 +1,30 @@
 require 'taglib'
 require 'track_list/time_converter'
+require 'track_list/template_parser'
 
 module TrackList
+  ##
+  # The purpose of this class is to parse a single track and return a formatted
+  # string.
+
   class TrackParser
 
+    ##
+    # When initializing the class, you must pass in a file path to the +track+
+    # you want parsed. 
+    #
+    # @param [String] track The track to be parsed.
+    
     def initialize(track)
         @track = track
     end
 
+    ##
+    # The bulk of the work is done in this method. Calling this method returns
+    # a parsed track in a formatted string. 
+    #
+    # @return [String] if valid audio file.
+    
     def parse
         TagLib::FileRef.open(@track) do |fileref|
           unless fileref.null?
@@ -16,9 +33,28 @@ module TrackList
             time_conversion = TrackList::TimeConverter.new(properties.length)
             length = time_conversion.format_time
 
-            #@tracks[tag.track] = "#{tag.track}. #{tag.title} (#{length})"
+            template_parser = TrackList::TemplateParser.new('~/.track_list.yaml')
+            template = template_parser.load
+
+            template_strings = {
+              '%TRACK%' => tag.track.to_s,
+              '%TITLE%' => tag.title,
+              '%LENGTH%' => length,
+              '%ARTIST%' => tag.artist,
+              '%ALBUM%' => tag.album,
+              '%YEAR%' => tag.year.to_s,
+              '%GENRE%' => tag.genre,
+              '%COMMENT%' => tag.comment 
+            }
+
+            parsed_string = ''
+
+            template_strings.each do |key, val|
+              if template['output'].include? key
+                parsed_string = template['output'].gsub!(key, val)
+              end
+            end
 
-            parsed_string = "#{tag.track}. #{tag.title} (#{length})"
             return parsed_string
         end
       end

data/lib/track_list/version.rb

@@ -1,3 +1,3 @@
 module TrackList
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: track_list
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Domenic Fiore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -72,6 +72,7 @@ files:
 - bin/tracklist
 - lib/track_list.rb
 - lib/track_list/directory_parser.rb
+- lib/track_list/template_parser.rb
 - lib/track_list/time_converter.rb
 - lib/track_list/track_parser.rb
 - lib/track_list/version.rb