format_parser 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 641f97911cf2f5a69318c06525d0360c554d4db0
-  data.tar.gz: 79eaf519017dc996431b7e185a07bf352e52de6d
+  metadata.gz: 7a00aab34ab0fd5faeec5fa6069ab81b2d066b14
+  data.tar.gz: 51a4617a89c10524a88879cdabe34dd4ccdb24d3
 SHA512:
-  metadata.gz: 80398fda150d24e68475e6b6f952d8f6a6f710109727993c73c77e63f42cd61224e5aea5b424981947e238433d9373cbc120afa9f63d4a6040852c5d61a285cf
-  data.tar.gz: 73edb441670ae6032746dde148891b2dabb870b75323614eef6664abcb88ebcc3c3b47c6695f724002b8da5934d6cc50f4fe99ea3f6fb035b9d07486f9640c3f
+  metadata.gz: f9865f5245c785756a9ce84a89e2d17f2dbcf15a2172c3399d5112eb2d2f5ad613e233d641b31b47bce04d1d992a25a48d7e495b6025965e6599480c280dc9f6
+  data.tar.gz: 563cc7d7b3c8e6011ecc1d0dff1c245183c8d3da8a04c4669030ab009e6762183689f708f67b8b7ece4d7e2fe793f53771cf2efbcc1d186f473393bd4d76caac

data/README.md

@@ -41,17 +41,11 @@ You can also optimize the metadata extraction by providing hints to the gem:
 FormatParser.parse(File.open("myimage", "rb"), natures: [:video, :image], formats: [:jpg, :png, :mp4], results: :all)
 ```
 
-If you need format_parser to return JSON, you can use `.as_json` to achieve this:
+Return values of all parsers have built-in JSON serialization
 
 ```ruby
-class Foo
-  include AttributesJSON
-  attr_accessor :number_of_bars
-end
-
-the_foo = Foo.new
-the_foo.number_of_bars = 42
-the_foo.as_json #=> {:number_of_bars => 42}
+img_info = FormatParser.parse(File.open("myimage.jpg", "rb"))
+JSON.pretty_generate(img_info) #=> ...
 ```
 
 ## Creating your own parsers

data/lib/attributes_json.rb

@@ -25,4 +25,10 @@ module FormatParser::AttributesJSON
       h[reader_method_name] = value.respond_to?(:as_json) ? value.as_json : value
     end
   end
+
+  # Implements to_json with sane defaults - like
+  # support for `JSON.pretty_generate` vs. `JSON.dump`
+  def to_json(generator_state)
+    generator_state.generate(as_json)
+  end
 end

data/lib/format_parser/version.rb

@@ -1,3 +1,3 @@
 module FormatParser
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/spec/attributes_json_spec.rb

@@ -26,4 +26,27 @@ describe FormatParser::AttributesJSON do
       expect(file_related_class.ancestors).to include(FormatParser::AttributesJSON)
     end
   end
+
+  it 'provides a default implementation of to_json as well' do
+    anon_class = Class.new do
+      include FormatParser::AttributesJSON
+      attr_accessor :foo, :bar, :baz
+      def nature
+        'good'
+      end
+    end
+    instance = anon_class.new
+    instance.foo = 42
+    instance.bar = 'abcdef'
+
+    output = JSON.dump(instance)
+    readback = JSON.parse(output, symbolize_names: true)
+
+    expect(readback).to have_key(:nature)
+
+    # Make sure we support pretty_generate correctly
+    pretty_output = JSON.pretty_generate(instance)
+    standard_output = JSON.dump(instance)
+    expect(pretty_output).not_to eq(standard_output)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_parser
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ks
@@ -230,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A library for efficient parsing of file metadata