id3tag 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c00ecdfdd2c6e53e5664831502753b5210a67098223bcfdb2805b9ab7958cd
-  data.tar.gz: aba76b6019b3be742ddd51a2a024b90fefc59dfd1f645589f5f4a18b4da0dc60
+  metadata.gz: 622d36527a37667a879b10d57e1375687d961461c51fe9bdd57637f8911b797d
+  data.tar.gz: 0a10600c4a862998e60334795481c839814637a2d34a32e387245d7c5648cddb
 SHA512:
-  metadata.gz: 85af215ef04e69deac371b5e9dea9c1bf401f01763794ae3f319be55ce09b6aa7fd67228fca0d62bfd956d4e8a445d173d985eecd4177462fa0b7a8aeae6aa3e
-  data.tar.gz: d3fdb4e68b97b3dfffb013d544b6feeeb56b1d9277d5ec6407fa3327837e1e8b5148c849e419ab0b18bccd8b003e5e2d01b0cca437a6216b8c3f55b88634d559
+  metadata.gz: 681cea3d65d268544530e47096994732ebcc533a476e7bc843f50d6ad18eb7f77e4b7a81cc012a36f49cd063176a2a2cd37f77193c32eeb4e69e03fa8b511749
+  data.tar.gz: a7aea6358d52bca1d416cafeafdca93a797df5f91273528961a22b0658b46e6f9c0684806dbdbc22757961ab3012fe8bf7731bdab804e57bd2a2a3521fc0b09d

data/README.md

@@ -60,9 +60,9 @@ You can inspect tag by calling `frame_ids` to see available frame ids or `frames
 
 ## Configuration
 
-It is also possible to provide configuration and overwrite default behaviour.
- 
+
 ```ruby
+# Configuration could be set using a block syntax.
 ID3Tag.configuration do |c|
 
   # This way you can avoid Encoding::InvalidByteSequenceError when tag contains invalid data.
@@ -76,6 +76,29 @@ ID3Tag.configuration do |c|
   c.v2_tag_read_limit = 1048576 # 1 megabyte
   
 end
+
+ID3Tag.configuration.v2_tag_read_limit # 1048576
+
+ID3Tag.configuration.v2_tag_read_limit = 1024
+
+ID3Tag.configuration.v2_tag_read_limit # 1024
+
+
+# In case you would like to set configuration temporally you could use `local_configuration` method.
+# Within this block you can read and modify configuration and it wont affect global or layers above.
+
+ID3Tag.local_configuration do
+  ID3Tag.configuration.v2_tag_read_limit # 1024
+  ID3Tag.configuration.v2_tag_read_limit = 9999
+  # ...
+  ID3Tag.configuration.v2_tag_read_limit # 9999 
+end
+
+ID3Tag.configuration.v2_tag_read_limit # 1024
+
+ID3Tag.reset_configuration # Resets global configuration to defaults
+
+ID3Tag.configuration.v2_tag_read_limit # 0
 ```
 
 

data/lib/id3tag.rb

@@ -1,4 +1,6 @@
 require "stringio"
+require "singleton"
+require "id3tag/configuration_struct"
 require "id3tag/configuration"
 require "id3tag/synchsafe_integer"
 require "id3tag/audio_file"
@@ -42,15 +44,16 @@ module ID3Tag
   end
 
   class << self
-    def configuration
-      @configuration ||= reset_configuration
-      yield @configuration if block_given?
-      @configuration
+    def configuration(&blk)
+      ID3Tag::Configuration.configuration(&blk)
     end
 
-    def reset_configuration(configuration = ID3Tag::Configuration.new)
-      raise ArgumentError, "Passed argument must be a ID3Tag::Configuration class object" unless configuration.is_a?(ID3Tag::Configuration)
-      @configuration = configuration
+    def local_configuration(&blk)
+      ID3Tag::Configuration.local_configuration(&blk)
+    end
+
+    def reset_configuration
+      ID3Tag::Configuration.reset
     end
   end
 end

data/lib/id3tag/configuration.rb

@@ -1,11 +1,46 @@
 module ID3Tag
   class Configuration
+    ResetError = Class.new(StandardError)
+    include Singleton
+    StackItem = Struct.new(:configuration)
+
+    class << self
+      def local_configuration(&blk)
+        instance.send(:local_configuration, &blk)
+      end
+
+      def configuration
+        value = instance.instance_variable_get(:@stack).last&.configuration || instance.instance_variable_get(:@global_configuration)
+        yield value if block_given?
+        value
+      end
+
+      def reset
+        instance.send(:reset)
+      end
+    end
+
+    def local_configuration
+      stack_item = StackItem.new((@stack.last&.configuration || @global_configuration).dup)
+      stack_backup = @stack.dup
+      @stack << stack_item
+      begin
+        yield stack_item.configuration
+      ensure
+        @stack.replace stack_backup
+      end
+    end
+
+    private
+
     def initialize
-      @string_encode_options = {}
-      @v2_tag_read_limit = 0
+      @stack = []
+      reset
     end
 
-    attr_accessor :string_encode_options
-    attr_accessor :v2_tag_read_limit
+    def reset
+      raise ResetError, "Configuration cannot be reset within local_configuration block" if @stack.size > 0
+      @global_configuration = ConfigurationStruct.new
+    end
   end
 end

data/lib/id3tag/configuration_struct.rb

@@ -0,0 +1,11 @@
+module ID3Tag
+  class ConfigurationStruct
+    def initialize
+      @string_encode_options = {}
+      @v2_tag_read_limit = 0
+    end
+
+    attr_accessor :string_encode_options
+    attr_accessor :v2_tag_read_limit
+  end
+end

data/lib/id3tag/version.rb

@@ -1,3 +1,3 @@
 module ID3Tag
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: id3tag
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Krists Ozols
@@ -122,6 +122,7 @@ files:
 - lib/id3tag.rb
 - lib/id3tag/audio_file.rb
 - lib/id3tag/configuration.rb
+- lib/id3tag/configuration_struct.rb
 - lib/id3tag/encoding_util.rb
 - lib/id3tag/frame_id_advisor.rb
 - lib/id3tag/frames/util/genre_names.rb