media_type 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1d94978527d35ad0c0ecdb1fbf78cb1b2cec4cd
+  data.tar.gz: 4d367eb5e0ae97c1ae9c8eb91866e7741fad1b9f
+SHA512:
+  metadata.gz: 74e29e05cfa760d018cf5bc5a7f4f033fb824a430910629bf9b00ef2c85bd28e13255c0860e937ff0e5768371e859b311972b1d65ea7f87b949b348c983fc829
+  data.tar.gz: bfae5e8c5d33b4c1e276cb8763c60a26bba204c819c8144c671ca2cc79218253b39e7406dbcad7972ca4d2af24823c325f599812a7070a9a12d84fc5e0ea08e6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in media_type.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alyssa Ross
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# MediaType
+
+A tiny library for parsing and generating Internet Media Types (AKA MIME types).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'media_type'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install media_type
+
+## Usage
+
+### Parsing a Media Type
+
+```ruby
+media_type = MediaType.parse("application/vnd.adobe.xdp+xml; charset=utf-8")
+media_type.type #=> "application"
+media_type.tree #=> "vnd"
+media_type.subtype #=> "adobe.xdp"
+media_type.suffix #=> "xml"
+media_type.parameters #=> {"charset"=>"utf-8"}
+```
+
+To disable parameter parsing and leave the parameters as a string,
+set the `parse_parameters` option to `false`:
+
+```ruby
+media_type = MediaType.parse("text/plain; charset=US-ASCII", parse_parameters: false)
+media_type.parameters #=> " charset=US-ASCII"
+```
+
+### Generating a Media Type
+
+```ruby
+media_type = MediaType.new
+media_type.type = "application"
+media_type.tree = "vnd"
+media_type.subtype = "adobe.xdp"
+media_type.suffix = "xml"
+media_type.parameters = { "charset" => "utf-8" }
+media_type.to_s #=> "application/vnd.adobe.xdp+xml; charset=utf-8"
+```
+
+### Comparing Media Types
+
+The `MediaType` class allows you to check whether two media types are
+*semantically equal*, even if they aren't equal strings.
+
+```ruby
+type1 = MediaType.parse('text/html; charset="utf-8"')
+type2 = MediaType.parse('text/html; charset=utf-8')
+type1 == type2 #=> true
+```
+
+## Contributing
+
+1. [Fork it](https://github.com/[my-github-username]/media_type/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+---
+
+[ ![Codeship Status for alyssais/media_type](https://codeship.com/projects/36ec2d70-622e-0132-f3b2-3a888924fd85/status)](https://codeship.com/projects/52003)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/media_type.rb

@@ -0,0 +1,75 @@
+class MediaType < Struct.new(:type, :tree, :subtype, :suffix, :parameters)
+  VERSION = "1.0.2"
+  MATCHER = /\A([^\/]+)\/(?:([^\.\+;]+)\.)?([^\s\+;]+)(?:\+([^\s;]+))?\s*(?:;(.*))?\Z/
+
+  def initialize(*args)
+    if args.length == 1 && (hash = args.first).is_a?(Hash)
+      symbolized_hash = hash.map { |k, v| [k.to_sym, v] }.to_h
+      super(*symbolized_hash.values_at(*self.class.members))
+    else
+      super
+    end
+  end
+
+  def self.parse(string, parse_parameters: true)
+    components = string.match(MATCHER)[1..-1]
+    if parse_parameters
+      components[-1] = parse_params(components[-1])
+    end
+    new(*components)
+  end
+
+  def self.parse_params(string)
+    return nil if string.nil?
+    components = string.split(/(?<!\\)"/) # seperate quoted strings
+    components.map!.with_index do |element, i|
+      if i.even? # not inside a quoted string
+        element.split(?;).
+                map(&:strip).
+                reject(&:empty?).
+                map { |s| s.split(?=).map(&:strip) } # seperate keys and values
+      else # inside a quoted string
+        element.gsub(/\\(.)/, '\1') # remove escapes
+      end
+    end
+    components.flatten! # now 1D array of strings, alternating key/value
+    components.each_slice(2).to_h
+  end
+
+  def self.encode_params(params)
+    params.map do |key, value|
+      value = %("#{value.gsub(?", '\"')}") if value[/["\s]/]
+      "#{key}=#{value}"
+    end.join("; ")
+  end
+
+  def to_s
+    string = "#{type}/"
+    string << "#{tree}." if tree
+    string << subtype
+    string << "+#{suffix}" if suffix
+    string << "; #{string_parameters.gsub(/\A\s+/, "")}" if parameters
+    string
+  end
+
+  def inspect
+    "#<#{self.class}:#{to_s}>"
+  end
+
+  def ==(other)
+    return false unless other.kind_of? MediaType
+    [self, other].map do |type|
+      hash = type.to_h
+      hash[:parameters] &&= type.parsed_parameters
+      hash
+    end.inject(:==)
+  end
+
+  def string_parameters
+    parameters.is_a?(Hash) ? self.class.encode_params(parameters) : parameters
+  end
+
+  def parsed_parameters
+    parameters.is_a?(Hash) ? parameters : self.class.parse_params(parameters)
+  end
+end

data/media_type.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'media_type'
+
+Gem::Specification.new do |spec|
+  spec.name          = "media_type"
+  spec.version       = MediaType::VERSION
+  spec.authors       = ["Alyssa Ross"]
+  spec.email         = ["hi@alyssa.is"]
+  spec.summary       = %q{A library for parsing and generating Internet Media (MIME) Types}
+  spec.homepage      = "https://github.com/alyssais/media_type"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/fixtures.yml

@@ -0,0 +1,57 @@
+text/html:
+  type: text
+  subtype: html
+
+application/vnd.oasis.opendocument.text:
+  type: application
+  tree: vnd
+  subtype: oasis.opendocument.text
+
+image/svg+xml:
+  type: image
+  subtype: svg
+  suffix: xml
+
+text/plain; charset=US-ASCII:
+  type: text
+  subtype: plain
+  parameters:
+    charset: US-ASCII
+
+application/vnd.etsi.asic-s+zip:
+  type: application
+  tree: vnd
+  subtype: etsi.asic-s
+  suffix: zip
+
+text/vnd.abc; charset=utf-8:
+  type: text
+  tree: vnd
+  subtype: abc
+  parameters:
+    charset: utf-8
+
+message/example ; foo=bar ; hello=" \"; world "; key= value:
+  type: message
+  subtype: example
+  parameters:
+    foo: bar
+    hello: ' "; world '
+    key: value
+
+application/vnd.adobe.xdp+xml; charset=utf-8:
+  type: application
+  tree: vnd
+  subtype: adobe.xdp
+  suffix: xml
+  parameters:
+    charset: utf-8
+
+application/vnd.adobe.xdp+xml ; charset=utf-8:
+  type: application
+  tree: vnd
+  subtype: adobe.xdp
+  suffix: xml
+  parameters:
+    charset: utf-8
+

data/spec/media_type_spec.rb

@@ -0,0 +1,104 @@
+require 'yaml'
+require 'spec_helper'
+
+fixtures = YAML.load_file("#{File.dirname(__FILE__)}/fixtures.yml")
+
+describe MediaType do
+  it "has a version number" do
+    expect(MediaType::VERSION).not_to be nil
+  end
+
+  describe "#to_h" do
+    fixtures.each do |string, orig|
+      it "reproduces #{string} hash" do
+        hash = MediaType.new(orig).to_h
+        [:type, :tree, :subtype, :suffix, :parameters].each do |key|
+          expect(hash).to have_key(key)
+          expect(hash[key]).to eq orig[key.to_s]
+        end
+      end
+    end
+  end
+
+  describe "#parse" do
+    context "with parse_parameters enabled" do
+      fixtures.each do |string, hash|
+        it "correctly parses #{string}" do
+          type = MediaType.parse(string)
+          [:type, :tree, :subtype, :suffix, :parameters].each do |key|
+            expect(type.send(key)).to eq hash[key.to_s]
+          end
+        end
+      end
+    end
+
+    context "with parse_parameters disabled" do
+      fixtures.each do |string, hash|
+        it "correctly parses #{string}" do
+          type = MediaType.parse(string, parse_parameters: false)
+          [:type, :tree, :subtype, :suffix].each do |key|
+            expect(type.send(key)).to eq hash[key.to_s]
+          end
+          expect(type.parameters).to eq string.split(?;, 2)[1]
+        end
+      end
+    end
+  end
+
+  describe "#==" do
+    context "when types are equal" do
+      input1 = %{text/html ; charset=utf-8}
+      input2 = %{text/html; charset="utf-8"}
+      [true, false].repeated_permutation(2) do |parse1, parse2|
+        context "with parse_parameters set to #{parse1} for input1 and #{parse2} for input2" do
+          it "returns true" do
+            type1 = MediaType.parse(input1, parse_parameters: parse1)
+            type2 = MediaType.parse(input2, parse_parameters: parse2)
+            expect(type1).to eq type2
+          end
+        end
+      end
+    end
+
+    context "when types are not equal" do
+      it "returns false" do
+        expect(MediaType.parse("text/html")).not_to eq MediaType.parse("image/png")
+      end
+    end
+  end
+
+  describe "#to_s" do
+    context "with hash parameters" do
+      fixtures.each do |string, _|
+        it "reproduces #{string}" do
+          type = MediaType.parse(string)
+          expect(MediaType.parse(type.to_s)).to eq type
+        end
+      end
+    end
+
+    context "with string parameters" do
+      fixtures.each do |string, _|
+        it "reproduces an equivalent to #{string}" do
+          type = MediaType.parse(string, parse_parameters: false)
+          expect(MediaType.parse(type.to_s)).to eq type
+        end
+      end
+    end
+  end
+
+  describe "#inspect" do
+    it "is correctly formatted" do
+      type = MediaType.parse("text/html")
+      expect(type.inspect).to eq "#<MediaType:text/html>"
+    end
+  end
+
+  describe "#parsed_parameters" do
+    context "when value is nil" do
+      it "returns nil" do
+        expect(MediaType.new.parsed_parameters).to be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'media_type'

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: media_type
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Alyssa Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- hi@alyssa.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/media_type.rb
+- media_type.gemspec
+- spec/fixtures.yml
+- spec/media_type_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alyssais/media_type
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A library for parsing and generating Internet Media (MIME) Types
+test_files:
+- spec/fixtures.yml
+- spec/media_type_spec.rb
+- spec/spec_helper.rb
+has_rdoc: