track_list 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 479a619595efec9dc0388637532e62eb2d85f49d1286c5632d14c44d9d45e373
-  data.tar.gz: ce39a80fae12241bce71c8527c9cd83ca0c237473e2fabcd7c22ed2a3a63df3d
+  metadata.gz: 68768df5d84a827b02666436938a4f8f1a55f1bce90ede8a0f9fd339b0ea159b
+  data.tar.gz: ea4ed055dd77e1412e06b68ed660456fdc2ca20e6eeccbe34db9b5d8c84d3ea5
 SHA512:
-  metadata.gz: 8d64d0707d4b68b5471574b88e7b5b4c14fdf1fa49c79c64c1246ba99cd56e848e59e5e305fc02c5ad4aea2c07f5d1f39e00c26e534ba375eb6c7f4f445f8370
-  data.tar.gz: 9f626e37d349ca83a565eeb0a2d60a52dab46be1fd8419b2f4c7369290be48d228807eec3f1fa668299a5082446d5cb5f30f49cae0d7673a032c07688232156f
+  metadata.gz: 5146ca78561029af6bf9f5308704194aec17fbd6e7586c0eb3de36545a80046a14e1f188541678ee4cccb7f68834e58376430c35636fe62c9574a8dac4603df7
+  data.tar.gz: 03ce59b3a00ae00a4bb0581764aa63b06106b5da455d6de59dce2b3ad2ec413f58ae9eea4a672b79a4a9eca2eef3d61bca86454f8c18f4d2e633acbfa30d0e92

data/.gitignore

@@ -1,8 +1,9 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/CHANGELOG.md

@@ -1,23 +1,23 @@
-# Changelog
-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.
+# Changelog
+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.

data/Gemfile

@@ -1,5 +1,6 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in track_list.gemspec
-gemspec
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in track_list.gemspec
+gemspec
+gem 'rubocop', group: 'development'
 gem "taglib-ruby"

data/Gemfile.lock

@@ -1,23 +1,46 @@
 PATH
   remote: .
   specs:
-    track_list (0.2.0)
-      taglib-ruby (~> 0.7)
+    track_list (0.3.0)
+      taglib-ruby (~> 1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.5.0)
-    taglib-ruby (0.7.1)
+    ast (2.4.2)
+    json (2.6.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.32.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    taglib-ruby (1.1.2)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 2.0)
-  rake (~> 10.0)
+  bundler (>= 2.2)
+  rake (~> 13.0)
+  rubocop
   taglib-ruby
   track_list!
 
 BUNDLED WITH
-   2.0.2
+   2.2.3

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Domenic Fiore
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2019 Domenic Fiore
+
+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

@@ -1,77 +1,82 @@
-# TrackList
-
-[![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
-```
-1. Tellin' Lies (0:03:59)
-2. Thick as Thieves (0:03:15)
-3. Lookers (0:03:37)
-4. Midwestern States (0:03:27)
-5. Charlie's Army (0:02:31)
-6. House on Fire (0:03:37)
-7. Black Mass (0:02:52)
-8. Boy Blue (0:03:20)
-9. Bad Catholics (0:02:52)
-10. Your Wild Years (0:03:54)
-11. The Bars (0:04:11)
-12. After the Party (0:03:50)
-13. Livin' Ain't Easy (0:03:26)
-```
-
-## Installation
-
-First, install [TagLib](https://taglib.org/). 
-
-Homebrew: `brew install taglib`
-
-Ubuntu/Debian: `sudo apt install libtag1-dev`
-
-Arch: `sudo pacman -S taglib`
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'track_list'
-```
-
-And then execute:
-
-    $ bundle
-
-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
-
-`tracklist <album directory>`
-
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitLab at https://gitlab.com/DomenicF/track_list/issues.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Track List
+
+[![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 track list 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 track lists or use the predefined one. The predefined one is below. If you'd like to customize this output, scroll down to Configuration.
+
+## Sample Output
+```
+1. Tellin' Lies (0:03:59)
+2. Thick as Thieves (0:03:15)
+3. Lookers (0:03:37)
+4. Midwestern States (0:03:27)
+5. Charlie's Army (0:02:31)
+6. House on Fire (0:03:37)
+7. Black Mass (0:02:52)
+8. Boy Blue (0:03:20)
+9. Bad Catholics (0:02:52)
+10. Your Wild Years (0:03:54)
+11. The Bars (0:04:11)
+12. After the Party (0:03:50)
+13. Livin' Ain't Easy (0:03:26)
+```
+
+## Installation
+
+First, install [TagLib](https://taglib.org/). 
+
+Homebrew: `brew install taglib`
+
+Ubuntu/Debian: `sudo apt install libtag1-dev`
+
+Arch: `sudo pacman -S taglib`
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'track_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install track_list
+
+## Configuration
+
+You can define custom output for your track list. On first run of the program, the program will create a `settings.yaml` file in the `$HOME/.config/track_list` directory.
+
+If you would like to change this location, set the environment variable `TRACKLIST_CONFIG` to where you'd like the file.
+
+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]`
+- `%LENGTH_IN_MILLISECONDS%` - The length of a given audio file in milliseconds.
+- `%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
+
+`tracklist <album directory>`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitLab at https://gitlab.com/DomenicF/track_list/issues.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "track_list"
-
-# 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__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "track_list"
+
+# 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

@@ -1,8 +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
+#!/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/bin/tracklist

@@ -1,41 +1,42 @@
-#!/usr/bin/env ruby
-
-require "track_list"
-require 'getoptlong'
-require 'track_list/template_parser'
-
-opts = GetoptLong.new(
-  [ '--help', '-h', GetoptLong::NO_ARGUMENT ]
-)
-
-
-opts.each do |opt, arg|
-  case opt
-    when '--help'
-      puts <<-EOF
-Usage: tracklist <album-directory>
-    e.g. tracklist "Music/The Menzingers/After the Party"
-
--h, --help:
-   show help
-      EOF
-  end
-end
-
-if ARGV.length != 1
-  puts "Missing album directory (try --help)"
-  exit 0
-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
+#!/usr/bin/env ruby
+
+require "track_list"
+require 'track_list/template_parser'
+require 'getoptlong'
+
+opts = GetoptLong.new(
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT ]
+)
+
+
+opts.each do |opt, arg|
+  case opt
+    when '--help'
+      puts <<-EOF
+Usage: tracklist <album-directory>
+    e.g. tracklist "Music/The Menzingers/After the Party"
+
+-h, --help:
+   show help
+      EOF
+  end
+end
+
+if ARGV.length != 1
+  puts "Missing album directory (try --help)"
+  exit 0
+end
+
+dir = TrackList::DirectoryParser.new(ARGV[0])
+
+template_parser = TrackList::TemplateParser.new
+
+# 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/directory_parser.rb

@@ -1,51 +1,51 @@
-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|
-                files.push(@dir + '/' + file)
-            end
-            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 = []
-            files.each do |filename, index|
-                track = TrackList::TrackParser.new(filename)
-                if track != nil || track != ''
-                    parsed_tracks.push(track)
-                end
-            end
-            return parsed_tracks
-        end
-
-        
-    end
-end
+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|
+                files.push(@dir + '/' + file)
+            end
+            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 = []
+            files.each do |filename, index|
+                track = TrackList::TrackParser.new(filename)
+                if track != nil || track != ''
+                    parsed_tracks.push(track)
+                end
+            end
+            return parsed_tracks
+        end
+
+        
+    end
+end

data/lib/track_list/environment.rb

@@ -0,0 +1,15 @@
+module TrackList
+  class Environment
+    def initialize
+      if ENV.has_value?("TRACKLIST_CONFIG")
+        @config_path = ENV["TRACKLIST_CONFIG"]
+      else
+        @config_path = Dir.home() + '/.config/track_list/settings.yaml'
+      end
+    end
+
+    def get_config_path
+      @config_path
+    end
+  end
+end

data/lib/track_list/template_parser.rb

@@ -1,41 +1,45 @@
-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
+require 'fileutils'
+require 'yaml'
+require 'track_list/environment'
+
+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
+            environment = Environment.new
+            @config_path = environment.get_config_path
+        end
+
+        # Return the config file in a Ruby-readable format.
+
+        def load
+            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))
+                true
+            else
+                false
+            end
+        end
+
+        # Create a default config file with some basic settings.
+
+        def create_default_config
+            config = { "output" => "%TRACK%. %TITLE% (%LENGTH%)" }
+            FileUtils.mkdir_p File.dirname(@config_path)
+            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,30 +1,30 @@
-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
-
-        # 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.
-            seconds = @time % 60
-        
-            # Find the minutes.
-            minutes = (@time / 60) % 60
-        
-            # Find the hours.
-            hours = (@time / 3600)
-        
-            # Format the time.
-            return hours.to_s + ":" + format("%02d", minutes.to_s) + ":" + format("%02d", seconds.to_s)
-        end
-    end
+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
+
+        # 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.
+            seconds = @time % 60
+        
+            # Find the minutes.
+            minutes = (@time / 60) % 60
+        
+            # Find the hours.
+            hours = (@time / 3600)
+        
+            # Format the time.
+            return hours.to_s + ":" + format("%02d", minutes.to_s) + ":" + format("%02d", seconds.to_s)
+        end
+    end
 end

data/lib/track_list/track_parser.rb

@@ -1,64 +1,66 @@
-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?
-            tag = fileref.tag
-            properties = fileref.audio_properties
-            time_conversion = TrackList::TimeConverter.new(properties.length)
-            length = time_conversion.format_time
-
-            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
-
-            return parsed_string
-        end
-      end
-    end
-
-  end
+require 'taglib'
+require 'track_list/environment'
+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?
+            tag = fileref.tag
+            properties = fileref.audio_properties
+            time_conversion = TrackList::TimeConverter.new(properties.length_in_seconds)
+            length = time_conversion.format_time
+
+            template_parser = TrackList::TemplateParser.new
+            template = template_parser.load
+
+            template_strings = {
+              '%TRACK%' => tag.track.to_s,
+              '%TITLE%' => tag.title,
+              '%LENGTH%' => length,
+              '%LENGTH_IN_MILLISECONDS%' => properties.length_in_milliseconds.to_s,
+              '%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
+
+            return parsed_string
+        end
+      end
+    end
+
+  end
 end

data/lib/track_list/version.rb

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

data/lib/track_list.rb

@@ -1,12 +1,12 @@
-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
-end
+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
+end

data/track_list.gemspec

@@ -1,34 +1,34 @@
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "track_list/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "track_list"
-  spec.version       = TrackList::VERSION
-  spec.authors       = ["Domenic Fiore"]
-  spec.email         = ["domenicfiore@gmail.com"]
-
-  spec.summary       = %q{Get the tracklist of a directory.}
-  spec.description   = %q{Output the tracklist of an album from a directory.}
-  spec.homepage      = "https://gitlab.com/DomenicF/track_list"
-  spec.license       = "MIT"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://gitlab.com/DomenicF/track_list"
-  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-
-  # 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('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "bin"
-  spec.executables   = ["tracklist"]
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "taglib-ruby", "~> 0.7"
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-end
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "track_list/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "track_list"
+  spec.version       = TrackList::VERSION
+  spec.authors       = ["Domenic Fiore"]
+  spec.email         = ["domenicfiore@gmail.com"]
+
+  spec.summary       = %q{Get the tracklist of a directory.}
+  spec.description   = %q{Output the tracklist of an album from a directory.}
+  spec.homepage      = "https://gitlab.com/DomenicF/track_list"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/DomenicF/track_list"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["tracklist"]
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "taglib-ruby", "~> 1.1"
+  spec.add_development_dependency "bundler", ">= 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: track_list
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Domenic Fiore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: taglib-ruby
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: Output the tracklist of an album from a directory.
 email:
 - domenicfiore@gmail.com
@@ -72,6 +72,7 @@ files:
 - bin/tracklist
 - lib/track_list.rb
 - lib/track_list/directory_parser.rb
+- lib/track_list/environment.rb
 - lib/track_list/template_parser.rb
 - lib/track_list/time_converter.rb
 - lib/track_list/track_parser.rb
@@ -99,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Get the tracklist of a directory.