ogg_album_tagger 0.1.0 → 0.1.2

data/lib/ogg_album_tagger/ogg_file.rb

@@ -0,0 +1,75 @@
+require 'shellwords'
+require 'set'
+require 'taglib'
+require 'ogg_album_tagger/exceptions'
+require 'ogg_album_tagger/tag_container'
+
+module OggAlbumTagger
+
+# Store the tags of an ogg track.
+#
+# Each tag is associated to a Set of values.
+class OggFile < OggAlbumTagger::TagContainer
+    attr_accessor :path
+
+    # Initialize a TagContainer from an ogg file.
+    def initialize(file)
+        begin
+            h = Hash.new
+
+            TagLib::Ogg::Vorbis::File.open(file.to_s) do |ogg|
+                ogg.tag.field_list_map.each do |tag, values|
+                    h[tag] = Set.new
+                    values.each do |value|
+                        h[tag].add(value.strip)
+                    end
+                end
+            end
+
+            super(h)
+            @path = file
+        rescue Exception => ex
+            STDERR.puts ex
+            raise OggAlbumTagger::ArgumentError, "#{file} does not seems to be a valid ogg file."
+        end
+    end
+
+    # Write the tags in the specified file.
+    def write(file)
+        begin
+            TagLib::Ogg::Vorbis::File.open(file.to_s) do |ogg|
+                tags = ogg.tag
+
+                # Remove old tags
+                tags.field_list_map.keys.each { |t| tags.remove_field(t) }
+
+                # Set new tags (Taglib will write them sorted)
+                @hash.each do |tag, values|
+                    values.sort.each do |v|
+                        tags.add_field(tag, v, false)
+                    end
+                end
+
+                # Save everything
+                ogg.save
+            end
+        rescue Exception
+            raise OggAlbumTagger::ArgumentError, "#{file} cannot be written."
+        end
+    end
+
+    def to_s
+        OggFile.sorted_tags(@hash.keys).map do |tag|
+            OggFile.pp_tag(@hash[tag])
+        end.join "\n"
+    end
+
+    # Sort the tag keys alphabetically, but put METADATA_BLOCK_PICTURE at the end.
+    def self.sorted_tags(tags)
+        a = tags.sort
+        a.delete('METADATA_BLOCK_PICTURE') and a.push('METADATA_BLOCK_PICTURE')
+        block_given? ? a.each { |v| yield v } : a
+    end
+end
+
+end # module OggAlbumTagger

data/lib/ogg_album_tagger/tag_container.rb

@@ -1,151 +1,127 @@
 require 'shellwords'
 require 'set'
 require 'ogg_album_tagger/exceptions'
-require 'taglib'
 
 module OggAlbumTagger
 
-# Store the tags of an ogg track.
+# A TagContainer is basically a hashmap associating a name to a set of string values.
 #
-# Each tag is associated to a Set of values.
+# The keys of the hashmap (aka the tags) are case insensitive (they are stored upcase).
+# A tag cannot be an empty string or containe the "=" or "~" characters.
+# Tags with no values are automatically removed.
 class TagContainer
-	# Initialize a TagContainer from an ogg file.
-	def initialize(file)
-		@hash = Hash.new 
-
-		begin
-			TagLib::Ogg::Vorbis::File.open(file.to_s) do |ogg|
-				ogg.tag.field_list_map.each do |tag, values|
-					prepare_tag(tag.upcase)
-
-					values.each do |value|
-						@hash[tag.upcase].add(value.strip)
-					end
-				end
-			end
-		rescue Exception => ex
-			#STDERR.puts ex
-			raise OggAlbumTagger::ArgumentError, "#{file} does not seems to be a valid ogg file."
-		end
-	end
-
-	# Write the tags in the specified file.
-	def write(file)
-		begin
-			TagLib::Ogg::Vorbis::File.open(file.to_s) do |ogg|
-				tags = ogg.tag
-
-				# Remove old tags
-				tags.field_list_map.keys.each { |t| tags.remove_field(t) }
-
-				# Set new tags (Taglib will write them sorted)
-				@hash.each do |tag, values|
-					values.sort.each do |v|
-						tags.add_field(tag, v, false)
-					end
-				end
-
-				# Save everything
-				ogg.save
-			end
-		rescue Exception => ex
-			#STDERR.puts ex
-			raise OggAlbumTagger::ArgumentError, "#{file} cannot be written."
-		end
-	end
-
-	# Returns a Set containing the values associated to the specified tag.
-	#
-	# If the tag does not exists, returns an empty Set.
-	# Do not use the returned Set to add new tags, use the methods provided by the class.
-	def [](tag)
-		has_tag?(tag) ? @hash[tag.upcase] : Set.new.freeze
-	end
-
-	def first(tag)
-		if has_tag?(tag)
-			return @hash[tag.upcase].first
-		else
-			raise IndexError, "Tag \"#{tag}\" does not exists."
-		end
-	end
-
-	# Check if the specified tag is present in the container.
-	def has_tag? tag
-		@hash.has_key?(tag.upcase)
-	end
-
-	# Check if the tag is valid, otherwise raise an ArgulentError.
-	def valid_tag? tag
-		raise ArgumentError, "Invalid tag." unless tag =~ /^[\x20-\x3C\x3E-\x7D]+$/
-	end
-
-	# If the specified tag is absent from the container, associate an empty Set to it.
-	def prepare_tag tag
-		valid_tag? tag
-		@hash[tag.upcase] = Set.new unless self.has_tag?(tag)
-	end
-
-	# Add some values to the specified tag.
-	# Any previous values will be removed.
-	def set_values(tag, *values)
-		prepare_tag tag
-		@hash[tag.upcase].replace(values)
-	end
-
-	# Add some values to the specified tag.
-	def add_values(tag, *values)
-		prepare_tag tag
-		@hash[tag.upcase].merge(values)
-	end
-
-	# Remove some tags. If no value is specified, the specified tag is removed.
-	def rm_values(tag, *values)
-		valid_tag? tag
-
-		if values.empty? then @hash.delete(tag.upcase)
-		else
-			@hash[tag.upcase].subtract(values)
-			@hash.delete(tag.upcase) if @hash[tag.upcase].empty?
-		end
-	end
-
-	# Returns the list of present tags.
-	def tags
-		@hash.keys
-	end
-
-	# Iterate through the available tags.
-	def each
-		@hash.each { |tag, set| yield(tag, set) }
-	end
-
-	def to_s
-		TagContainer.sorted_tags(@hash.keys).map do |tag|
-			TagContainer.pp_tag(@hash[tag])
-		end.join "\n"
-	end
-
-	# Sort the tag keys alphabetically, but put METADATA_BLOCK_PICTURE at the end.
-	def self.sorted_tags(tags)
-		a = tags.sort
-		a.delete('METADATA_BLOCK_PICTURE') and a.push('METADATA_BLOCK_PICTURE')
-		block_given? ? a.each { |v| yield v } : a
-	end
-
-	# Pretty print an array of values.
-	def self.pp_tag values
-		values_str = values.map { |v| v.to_s.length > 64 ? (v.to_s.slice(0, 64) + '...') : v }
-
-		case values.length
-		when 0 then '- (empty)'
-		when 1 then values_str[0]
-		else sprintf("(%d) [%s]", values.length, values_str.join(', '))
-		end
-	end
-
-	private :prepare_tag
-	private :valid_tag?
+    # Allow to build a TagContainer using the following syntax:
+    #
+    # <tt>t = TagContainer.new artist: "Alice", genre: %w{Pop Rock}, tracknumber: 1, ...</tt>
+    # The values associated to a tag are automatically casted to a String.
+    # Single values are treated as an array of one value.
+    def initialize tags = {}
+        @hash = Hash.new
+
+        tags.each { |tag, values|
+            next if values.nil?
+
+            values = [values] unless values.is_a?(Array) or values.is_a?(Set)
+
+            next if values.empty?
+
+            prepare_tag(tag.to_s.upcase)
+            values.each { |value| @hash[tag.to_s.upcase].add(value.to_s) }
+        }
+    end
+
+    # Returns a Set containing the values associated to the specified tag.
+    #
+    # If the tag does not exists, returns an empty Set.
+    # Do not use the returned Set to add new tags, use the methods provided by the class.
+    def [](tag)
+        has_tag?(tag) ? @hash[tag.upcase] : Set.new.freeze
+    end
+
+    def first(tag)
+        if has_tag?(tag)
+            return @hash[tag.upcase].first
+        else
+            raise IndexError, "Tag \"#{tag}\" does not exists."
+        end
+    end
+
+    # Check if the specified tag is present in the container.
+    def has_tag? tag
+        @hash.has_key?(tag.upcase)
+    end
+
+    # Check if the tag is valid, otherwise raise an ArgumentError.
+    # Valid tags are composed of any character from " " to "}", excluding "=" and "~".
+    def self.valid_tag? tag
+        raise ArgumentError, "Invalid tag." unless tag =~ /^[\x20-\x3C\x3E-\x7D]+$/
+    end
+
+    # If the specified tag is absent from the container, associate an empty Set to it.
+    def prepare_tag tag
+        TagContainer::valid_tag? tag
+        @hash[tag.upcase] = Set.new unless self.has_tag?(tag)
+    end
+
+    # Add some values to the specified tag.
+    # Any previous values will be removed.
+    def set_values(tag, *values)
+        if values.empty?
+            rm_values(tag)
+        else
+            prepare_tag tag
+            @hash[tag.upcase].replace(values)
+        end
+
+        self
+    end
+
+    # Add some values to the specified tag.
+    def add_values(tag, *values)
+        return if values.empty?
+
+        prepare_tag tag
+        @hash[tag.upcase].merge(values)
+
+        self
+    end
+
+    # Remove some tags. If no value is specified, the specified tag is removed.
+    def rm_values(tag, *values)
+        TagContainer::valid_tag? tag
+
+        if values.empty?
+            @hash.delete(tag.upcase)
+        else
+            @hash[tag.upcase].subtract(values)
+            @hash.delete(tag.upcase) if @hash[tag.upcase].empty?
+        end
+
+        self
+    end
+
+    # Returns the list of present tags.
+    def tags
+        @hash.keys
+    end
+
+    # Iterate through the available tags.
+    def each
+        @hash.each { |tag, set| yield(tag, set) }
+    end
+
+    # Pretty print an array of values.
+    def self.pp_tag values
+        values_str = values.map { |v| v.to_s.length > 64 ? (v.to_s.slice(0, 64) + '...') : v }
+
+        case values.length
+        when 0 then '- (empty)'
+        when 1 then values_str[0]
+        else sprintf("(%d) [%s]", values.length, values_str.join(', '))
+        end
+    end
+
+    private :prepare_tag
 end
 
-end
+end # module OggAlbumTagger

data/lib/ogg_album_tagger/version.rb

@@ -1,3 +1,3 @@
 module OggAlbumTagger
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ogg_album_tagger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Cyrille Faucheux
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-01 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: exiftool
   requirement: !ruby/object:Gem::Requirement
@@ -75,8 +103,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/ogg-album-tagger
+- lib/ogg_album_tagger/cli.rb
 - lib/ogg_album_tagger/exceptions.rb
 - lib/ogg_album_tagger/library.rb
+- lib/ogg_album_tagger/ogg_file.rb
 - lib/ogg_album_tagger/picture.rb
 - lib/ogg_album_tagger/tag_container.rb
 - lib/ogg_album_tagger/version.rb
@@ -100,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Interactive edition of ogg tags with support for whole albums.