format_parser 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d0319cf9897c4d253b9b2202ef4d35477cc2d31
-  data.tar.gz: 4ed1a85defea0ae296abe5e553e739e0d555d6e6
+  metadata.gz: 641f97911cf2f5a69318c06525d0360c554d4db0
+  data.tar.gz: 79eaf519017dc996431b7e185a07bf352e52de6d
 SHA512:
-  metadata.gz: cf6c8801dad23ebab67e116d3d3e1da1a718198049d4c039b8abc4a6001b060c32300f69f73a7f35bf708566fbd9856c0d67b1e03300d7f84ad61b57c2a98d08
-  data.tar.gz: d3aae7f141dbd7431f93555b483845579437cc936c7fe4b09a729c782d3ac7b7001e5df7ef27cea7b4fe4eec2b534148b74eec5f69f9dc5dfe563ea38c82c61b
+  metadata.gz: 80398fda150d24e68475e6b6f952d8f6a6f710109727993c73c77e63f42cd61224e5aea5b424981947e238433d9373cbc120afa9f63d4a6040852c5d61a285cf
+  data.tar.gz: 73edb441670ae6032746dde148891b2dabb870b75323614eef6664abcb88ebcc3c3b47c6695f724002b8da5934d6cc50f4fe99ea3f6fb035b9d07486f9640c3f

data/README.md

@@ -41,6 +41,19 @@ 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:
+
+```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}
+```
+
 ## Creating your own parsers
 
 In order to create new parsers, you have to write a method or a  Proc that accepts an IO and performs the

data/lib/attributes_json.rb

@@ -0,0 +1,28 @@
+# Implements as_json as returning a Hash
+# containing the return values of all the
+# reader methods of an object that have
+# associated pair writer methods.
+#
+#   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}
+module FormatParser::AttributesJSON
+
+  # Implements a sane default `as_json` for an object
+  # that accessors defined
+  def as_json(*_maybe_root_option)
+    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|
+      reader_method_name = attr_writer_method_name.to_s.gsub(/\=$/, '')
+      value = public_send(reader_method_name)
+      # When calling as_json on our members there is no need to pass the root: option given to us
+      # by the caller
+      h[reader_method_name] = value.respond_to?(:as_json) ? value.as_json : value
+    end
+  end
+end

data/lib/audio.rb

@@ -1,5 +1,7 @@
 module FormatParser
   class Audio
+    include FormatParser::AttributesJSON
+
     NATURE = :audio
 
     # Type of the file (e.g :mp3)

data/lib/document.rb

@@ -1,5 +1,7 @@
 module FormatParser
   class Document
+    include FormatParser::AttributesJSON
+
     NATURE = :document
 
     attr_accessor :format

data/lib/format_parser.rb

@@ -1,5 +1,7 @@
+require 'set'
+
 module FormatParser
-  require 'set'
+  require_relative 'attributes_json'
   require_relative 'image'
   require_relative 'audio'
   require_relative 'document'

data/lib/format_parser/version.rb

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

data/lib/image.rb

@@ -1,5 +1,7 @@
 module FormatParser
   class Image
+    include FormatParser::AttributesJSON
+
     NATURE = :image
 
     # What filetype was recognized? Will contain a non-ambiguous symbol

data/lib/video.rb

@@ -1,5 +1,7 @@
 module FormatParser
   class Video
+    include FormatParser::AttributesJSON
+
     NATURE = :video
 
     attr_accessor :width_px

data/spec/attributes_json_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe FormatParser::AttributesJSON do
+  it 'returns a hash of all the accessorized properties' 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'
+    expect(instance.as_json).to eq('nature' => 'good', 'foo' => 42, 'bar' => 'abcdef', 'baz' => nil)
+    expect(instance.as_json(root: true)).to eq('nature' => 'good', 'foo' => 42, 'bar' => 'abcdef', 'baz' => nil)
+  end
+
+  it 'is included into file information types' do
+    [
+      FormatParser::Image,
+      FormatParser::Video,
+      FormatParser::Audio,
+      FormatParser::Document
+    ].each do |file_related_class|
+      expect(file_related_class.ancestors).to include(FormatParser::AttributesJSON)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: format_parser
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Noah Berman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ks
@@ -159,6 +159,7 @@ files:
 - README.md
 - Rakefile
 - format_parser.gemspec
+- lib/attributes_json.rb
 - lib/audio.rb
 - lib/care.rb
 - lib/document.rb
@@ -186,6 +187,7 @@ files:
 - lib/read_limiter.rb
 - lib/remote_io.rb
 - lib/video.rb
+- spec/attributes_json_spec.rb
 - spec/care_spec.rb
 - spec/file_information_spec.rb
 - spec/format_parser_spec.rb