format_parser 0.21.1 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 916f22d0efd27a6e32065b50c51a4a482664c344669aa1f9586769ccf2be7b06
-  data.tar.gz: 3fd1b2ba7285ca69bb8d4c14c9f83e4001b55fee7e85332d97cbdbd36620597f
+  metadata.gz: 13d1f2a3748d62b027f80b1d6c46f8d087ddfc9cbeadeb62b330fa397797b847
+  data.tar.gz: eea08816482a939538aa1400ba6ca29af864f33ac12d960cbad8806d0e13a9c8
 SHA512:
-  metadata.gz: df680824b240f15df52fbc6c14d44f9b5fb99a93fb69cf191db6027a9871115f5e3e5bbaec48751853683b01b8e87b4266b0bbfb23700901910f2ce0f8da1137
-  data.tar.gz: d944a5db3fb2e1d06435b10bfc6aa0651312b45393180b08cf7a7f0b6237a0804b90a216cdeaf770e50de1af5bf31234f987e6fabc0e72bcb682e59a87cf2e7a
+  metadata.gz: d21c310453155285236e3469ad9980df4d408b00b989fa5a9ed330f39c0c4f5a65ebfb84a79d7f9d7c9761c9dbf27958b8b44a5e8176f79cbf340b011279a0c0
+  data.tar.gz: 0e8949ac9c1ac6624f27539fe33f52c28c7e5b9c2cce83d9c752372653e35c0231d9a087cff88c9ea87585eaa7dcd8d6878a1345b5b914554d4a5691f11dce60

data/.gitignore

@@ -58,3 +58,6 @@ Gemfile.lock
 
 # OSX Files
 .DS_Store
+
+# rspec examples
+spec/examples.txt

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.22.0
+* Adds option `stringify_keys: true` to #as_json methods (fix #151)
+
 ## 0.21.1
 * MPEG: Ensure parsing does not inadvertently return an Integer instead of Result|nil
 * MPEG: Scan further into the MPEG file than previously (scan 32 1KB chunks)

data/README.md

@@ -75,6 +75,17 @@ img_info = FormatParser.parse(File.open("myimage.jpg", "rb"))
 JSON.pretty_generate(img_info) #=> ...
 ```
 
+To convert the result to a Hash or a structure suitable for JSON serialization
+
+```ruby
+img_info = FormatParser.parse(File.open("myimage.jpg", "rb"))
+img_info.as_json
+
+# it's also possible to convert all keys to string
+img_info.as_json(stringify_keys: true)
+```
+
+
 ## Creating your own parsers
 
 See the [section on writing parsers in CONTRIBUTING.md](CONTRIBUTING.md#so-you-want-to-contribute-a-new-parser)
@@ -188,7 +199,7 @@ Unless specified otherwise in this section the fixture files are MIT licensed an
 
 ## Copyright
 
-Copyright (c) 2019 WeTransfer. 
+Copyright (c) 2020 WeTransfer.
 
 `format_parser` is distributed under the conditions of the [Hippocratic License](https://firstdonoharm.dev/version/1/2/license.html)
   - See LICENSE.txt for further details.

data/format_parser.gemspec

@@ -39,7 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rake', '~> 12'
   spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'wetransfer_style', '0.5.0'
   spec.add_development_dependency 'parallel_tests'

data/lib/attributes_json.rb

@@ -15,7 +15,12 @@ module FormatParser::AttributesJSON
 
   # Implements a sane default `as_json` for an object
   # that accessors defined
-  def as_json(root: false)
+  #
+  # @param root[Bool] if true, it surrounds the result in a hash with a key
+  #  `format_parser_file_info`
+  # @param stringify_keys[Bool] if true, it transforms all the hash keys to a string.
+  #   The default value is false for backward compatibility
+  def as_json(root: false, stringify_keys: false, **)
     h = {}
     h['nature'] = nature if respond_to?(:nature) # Needed for file info structs
     methods.grep(/\w\=$/).each_with_object(h) do |attr_writer_method_name, h|
@@ -27,6 +32,9 @@ module FormatParser::AttributesJSON
       sanitized_value = _sanitize_json_value(unwrapped_attribute_value)
       h[reader_method_name] = sanitized_value
     end
+
+    h = FormatParser::HashUtils.deep_transform_keys(h, &:to_s) if stringify_keys
+
     if root
       {'format_parser_file_info' => h}
     else

data/lib/format_parser.rb

@@ -5,6 +5,7 @@ require 'measurometer'
 # top-level methods of the library.
 module FormatParser
   require_relative 'format_parser/version'
+  require_relative 'hash_utils'
   require_relative 'attributes_json'
   require_relative 'image'
   require_relative 'audio'

data/lib/format_parser/version.rb

@@ -1,3 +1,3 @@
 module FormatParser
-  VERSION = '0.21.1'
+  VERSION = '0.22.0'
 end

data/lib/hash_utils.rb

@@ -0,0 +1,19 @@
+# based on https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb#L116
+# I chose to copy this method instead of adding activesupport as a dependency
+# because we want to have the least number of dependencies
+module FormatParser
+  class HashUtils
+    def self.deep_transform_keys(object, &block)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), result|
+          result[yield(key)] = deep_transform_keys(value, &block)
+        end
+      when Array
+        object.map { |e| deep_transform_keys(e, &block) }
+      else
+        object
+      end
+    end
+  end
+end

data/lib/parsers/mp3_parser.rb

@@ -47,10 +47,6 @@ class FormatParser::MP3Parser
         h[k] = value if value
       end
     end
-
-    def as_json(*)
-      to_h
-    end
   end
 
   def likely_match?(filename)

data/spec/attributes_json_spec.rb

@@ -140,4 +140,30 @@ describe FormatParser::AttributesJSON do
       JSON.pretty_generate(object_with_attributes_module)
     }.to raise_error(/structure too deep/)
   end
+
+  it 'converts all hash keys to string when stringify_keys: true' do
+    fixture_path = fixtures_dir + '/ZIP/arch_few_entries.zip'
+    fi_io = File.open(fixture_path, 'rb')
+
+    result = FormatParser::ZIPParser.new.call(fi_io).as_json(stringify_keys: true)
+
+    result['entries'].each do |entry|
+      entry.each do |key, _value|
+        expect(key).to be_a(String)
+      end
+    end
+  end
+
+  it 'does not convert hash keys to string when stringify_keys: false' do
+    fixture_path = fixtures_dir + '/ZIP/arch_few_entries.zip'
+    fi_io = File.open(fixture_path, 'rb')
+
+    result = FormatParser::ZIPParser.new.call(fi_io).as_json
+
+    result['entries'].each do |entry|
+      entry.each do |key, _value|
+        expect(key).to be_a(Symbol)
+      end
+    end
+  end
 end

data/spec/hash_utils_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe FormatParser::HashUtils do
+  describe '.deep_transform_keys' do
+    it 'transforms all the keys in a hash' do
+      hash = { aa: 1, 'bb' => 2 }
+      result = described_class.deep_transform_keys(hash, &:to_s)
+
+      expect(result).to eq('aa' => 1, 'bb' => 2)
+    end
+
+    it 'transforms all the keys in a array of hashes' do
+      array = [{ aa: 1, bb: 2 }, { cc: 3, dd: [{c: 2, d: 3}] }]
+      result = described_class.deep_transform_keys(array, &:to_s)
+
+      expect(result).to eq(
+        [{'aa' => 1, 'bb' => 2}, {'cc' => 3, 'dd' => [{'c' => 2, 'd' => 3}]}]
+      )
+    end
+
+    it 'transforms all the keys in a hash recursively' do
+      hash = { aa: 1, bb: { cc: 22, dd: 3 } }
+      result = described_class.deep_transform_keys(hash, &:to_s)
+
+      expect(result).to eq('aa' => 1, 'bb' => { 'cc' => 22, 'dd' => 3})
+    end
+
+    it 'does nothing for an non array/hash object' do
+      object = Object.new
+      result = described_class.deep_transform_keys(object, &:to_s)
+
+      expect(result).to eq(object)
+    end
+
+    it 'returns the last value if different keys are transformed into the same one' do
+      hash = { aa: 0, 'bb' => 2, bb: 1 }
+      result = described_class.deep_transform_keys(hash, &:to_s)
+
+      expect(result).to eq('aa' => 0, 'bb' => 1)
+    end
+  end
+end

data/spec/parsers/mp3_parser_spec.rb

@@ -110,4 +110,32 @@ describe FormatParser::MP3Parser do
       subject.call(StringIO.new(''))
     }.to raise_error(FormatParser::IOUtils::InvalidRead)
   end
+
+  describe '#as_json' do
+    it 'converts all hash keys to string when stringify_keys: true' do
+      fpath = fixtures_dir + '/MP3/Cassy.mp3'
+      result = subject.call(File.open(fpath, 'rb')).as_json(stringify_keys: true)
+
+      expect(
+        result['intrinsics'].keys.map(&:class).uniq
+      ).to eq([String])
+
+      expect(
+        result['intrinsics']['id3tags'].map(&:class).uniq
+      ).to eq([ID3Tag::Tag])
+    end
+
+    it 'does not convert the hash keys to string when stringify_keys: false' do
+      fpath = fixtures_dir + '/MP3/Cassy.mp3'
+      result = subject.call(File.open(fpath, 'rb')).as_json
+
+      expect(
+        result['intrinsics'].keys.map(&:class).uniq
+      ).to eq([Symbol])
+
+      expect(
+        result['intrinsics'][:id3tags].map(&:class).uniq
+      ).to eq([ID3Tag::Tag])
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -8,7 +8,6 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'rspec'
 require 'format_parser'
-require 'pry'
 
 module SpecHelpers
   def fixtures_dir
@@ -19,6 +18,8 @@ end
 RSpec.configure do |c|
   c.include SpecHelpers
   c.extend SpecHelpers # makes fixtures_dir available for example groups too
+  # https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  c.example_status_persistence_file_path = 'spec/examples.txt'
 end
 
 RSpec.shared_examples 'an IO object compatible with IOConstraint' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_parser
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.22.0
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ks
@@ -135,20 +135,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -223,6 +209,7 @@ files:
 - lib/document.rb
 - lib/format_parser.rb
 - lib/format_parser/version.rb
+- lib/hash_utils.rb
 - lib/image.rb
 - lib/io_constraint.rb
 - lib/io_utils.rb
@@ -260,6 +247,7 @@ files:
 - spec/file_information_spec.rb
 - spec/format_parser_inspect_spec.rb
 - spec/format_parser_spec.rb
+- spec/hash_utils_spec.rb
 - spec/io_utils_spec.rb
 - spec/parsers/aiff_parser_spec.rb
 - spec/parsers/bmp_parser_spec.rb
@@ -305,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A library for efficient parsing of file metadata