media_types 0.6.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b854726c0783d1e7f27c66a195362a9df615500fb0bc329a935aa589d3451138
-  data.tar.gz: 3699e6ea389a304a2a7970911a39ae269e0705b3283c8b816868f1ba76abc6fa
+  metadata.gz: d034c7e7a7fd3a142dd997efab0d1c3e61f2cbe3170078544f4f456c485ad4ec
+  data.tar.gz: 20dbb0fbdf7e9f93c79575239de5e9a4e2220dbd7d3a0fe1d41145c1b2a97b54
 SHA512:
-  metadata.gz: 05a9e6bb7d2cf222148750830b4efb69fc73a7b955e4a7cf51de6dbe3ed4866187cc498c7b11c8060f0a3dc53eac76fa7bc762049ed6174bdaccc0ea3fa118c7
-  data.tar.gz: c811c45d8ed2355a39f49f924d09a6a3326abe715e86b5ce4634d6a7dc1d2a18c565e6f1f6de60a769aa2fd6a863bd328da82a15ee3a8e6eaded39beab35856d
+  metadata.gz: b589dbf3292df73632d3d8c98b6b73ed2dec08099b64406b4a1ca2c2cbe19b5cf7161efefc2b05c3bff634b03b6056c6a8f4770ac038e559710415bbad663e10
+  data.tar.gz: 2ce0c0747e94f01de399e28cd262b921912097c9bfea2d205abcb11937f116d078366ebcee8a8f0999c12cada9a7b1ce1093ad51d80d397cfc73d5cd145424f8

data/.github/workflows/debian.yml

@@ -0,0 +1,42 @@
+name: Debian
+
+on:
+  push:
+    tags:
+    - '*'
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-18.04
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Install dependencies
+      run: |
+        sudo apt-get update
+        DEBIAN_FRONTEND=noninteractive sudo apt-get --yes install gem2deb bundler ruby-{actionpack,awesome-print,http,minitest,minitest-reporters,oj,simplecov}
+        rm Gemfile.lock || true
+        bundle install --local
+        sudo apt-file update
+    - name: Build
+      run: |
+        bundle exec rake build
+        mkdir debpkg
+        cp pkg/media_types-*.gem media_types.gem
+        #(cd debpkg; gem2tgz media_types.gem)
+        #(cd debpkg; dh-make-ruby media_types-*.tar.gz)
+        #(cd debpkg; dh-make-ruby media_types-*.tar.gz)
+        (cd pkg; gem2deb media_types*.gem)
+        mv pkg/ruby-media-types_*_all.deb ruby-media-types.deb
+    - name: Upload gem
+      uses: actions/upload-artifact@v1
+      with:
+        name: media_types.gem
+        path: media_types.gem
+    - name: Upload deb
+      uses: actions/upload-artifact@v1
+      with:
+        name: ruby-media-types.deb
+        path: ruby-media-types.deb

data/.github/workflows/ruby.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        sudo apt-get update
+        DEBIAN_FRONTEND=noninteractive sudo apt-get install --yes bundler
+        rm Gemfile.lock || true
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -1,10 +1,10 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-.idea/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/

data/CHANGELOG.md

@@ -1,13 +1,48 @@
-# 0.6.2
+# Changelog
+
+## 2.1.0
+
+- Add `override_suffix` to force a specific suffix
+- Fix all deprecation warnings
+
+## 2.0.1
+
+- Views can now be accessed indifferently.
+- Attribute keys no longer match indifferently.
+- Fixed infinite loop when validating non-hash, non-array items.
+
+## 2.0.0
+
+- Removed ability to set default suffix. All suffixes now default to `+json`.
+- Suffixes are now set for a given view and version instead of as a block.
+- Added `suffix :yoursuffix` command to override the default `:json` suffix.
+- Removed defaults block.
+- Removed registrations block.
+
+## 1.0.0
+
+- Added the ability to do inline tests when defining validations using `assert_pass '<json>'` and `assert_fail '<json>'`.
+- `media_type` has been replaced with `use_name`.
+- It is no longer possible to set a default version. Please use `version <x> do` instead.
+- You no longer need to specify a custom format string. If you set an organisation with `def self.organisation` or set a module wide organisation with `MediaTypes::set_organisation <module>, '<organisation>'` the library will generate identifiers for you.
+- `self.base_format` has been replaced by `identifier_format do |type:, view:, version:, suffix:|`.
+- Added the `empty` validation to mark an empty object as valid.
+- Added the `identifier` function to get the [Media Type Identifier](https://en.wikipedia.org/wiki/Media_type) for the validator.
+- Added `version(x)` and `view(x)` functions.
+- Added an `available_validations` functions that returns all defined validations.
+- Fixed an issue where validations could accidentally merge if defined with a bad `base_format`.
+- Fixed an issue where undefined validations would accept an empty object.
+
+## 0.6.2
 
 - Fix handling empty collections
 
-# 0.6.1
+## 0.6.1
 
 - Fix no `validations` error on `validatable?` (now returns `false`)
 - Update `bundler` to `2.x`
 
-# 0.6.0
+## 0.6.0
 
 - Change default expected type for `attribute` to Object
 - Remove default `actionpack` calls for `.register`
@@ -15,28 +50,28 @@
 - Add integration for registering with `http` (http.rb)
 - Fix stack overflow for cyclic schema
 
-# 0.5.5
+## 0.5.5
 
 - Fix an issue with `attribute(optional:, &block)` not passing `optional:` to the created `collection`.
 
-# 0.5.4
+## 0.5.4
 
 - Fix formatter reworked template when fields are not present
 
-# 0.5.3
+## 0.5.3
 
 - Remove `require 'awesome_print'` in library code as it's marked as a development dependency onlvy
 
-# 0.5.2
+## 0.5.2
 
 - Add requires in files with missing requires
 
-# 0.5.1
+## 0.5.1
 
 - Fix merging optional attributes
 - Change `#inspect` to look like a tree
 
-# 0.5.0
+## 0.5.0
 
 - Change internal representation of key to symbol
 - Change default type from `nil` to `Object`, removing special behaviour for nil
@@ -55,11 +90,11 @@
 - Raise error if `self.base_format` is not available at time of `Dsl.media_type` call
 - Fix `expected_type` guard for arrays, nil, or arrays with nil.
 
-# 0.4.1
+## 0.4.1
 
 - Use strings for `:_links`, matching the other validation keys
 
-# 0.4.0
+## 0.4.0
 
 - Simplify `assert_media_type_format` by dumping views completely
 - Add test for `merge`
@@ -67,59 +102,59 @@
 - Add test for `validatable?`
 - Add block passing to `Scheme.new`
 
-# 0.3.0
+## 0.3.0
 
 - Add `merge` dsl to merge two `Scheme`
 
-# 0.2.6
+## 0.2.6
 
 - Change validation to accept both symbolised and stringified input ánd validations
 
-# 0.2.5
+## 0.2.5
 
 - Add automatic require for `media_types/scheme/any_of`
 
-# 0.2.4
+## 0.2.4
 
 - Change messages for `assert_media_types_registered` to be more informative and consistent
 
-# 0.2.3
+## 0.2.3
 
 - Fix an issue with `Hash#compact` which was introduce in 2.4+. Now works with Ruby 2.3
 
-# 0.2.2
+## 0.2.2
 
 - Fix an issue with `Registrar#versions`
 - Fix link in the gemspec to Github
 
-# 0.2.1
+## 0.2.1
 
-- Fix an issue with `Constructable#valid?` and `Constructable#validate!` 
+- Fix an issue with `Constructable#valid?` and `Constructable#validate!`
 
-# 0.2.0
+## 0.2.0
 
 Breaking changes to update public API and usage
 
- - Remove `Base` class (use `MediaTypes::Dsl` instead)
- - Remove a lot of configuration options as they are deemed unneeded
- - Remove `active_support` dependency
- - Rename `ConstructableMimeType` to `Constructable`
- - Moved global scheme types to `Scheme` as subtype
- - Add `MediaTypes::Dsl`
- - Add `validations` block to capture schemes
- - Add `registrations` block to capture register intent
- - Add `defaults` block to capture mime type defaults
- - Add `MediaTypes.register` class method to call `Mime::Type.register`
- - Add `Registerable` capture class
- - Add type / base setting for `Constructable`
- - Add versioned validations
- - Add forced types of `collection`s
- - Add `attribute` with block
- - Add `EnumerationOfType` for schema typed arrays
- - Add `AnyOf` for scheme enum types
- - Add non-block calls for `Scheme` dsl
- - Add yard documentation to `/docs`
- 
-# 0.1.0
+- Remove `Base` class (use `MediaTypes::Dsl` instead)
+- Remove a lot of configuration options as they are deemed unneeded
+- Remove `active_support` dependency
+- Rename `ConstructableMimeType` to `Constructable`
+- Moved global scheme types to `Scheme` as subtype
+- Add `MediaTypes::Dsl`
+- Add `validations` block to capture schemes
+- Add `registrations` block to capture register intent
+- Add `defaults` block to capture mime type defaults
+- Add `MediaTypes.register` class method to call `Mime::Type.register`
+- Add `Registerable` capture class
+- Add type / base setting for `Constructable`
+- Add versioned validations
+- Add forced types of `collection`s
+- Add `attribute` with block
+- Add `EnumerationOfType` for schema typed arrays
+- Add `AnyOf` for scheme enum types
+- Add non-block calls for `Scheme` dsl
+- Add yard documentation to `/docs`
+
+## 0.1.0
 
 :baby: initial release

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in media_types.gemspec
-gemspec
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in media_types.gemspec
+gemspec

data/Gemfile.lock

@@ -1,109 +1,43 @@
 PATH
   remote: .
   specs:
-    media_types (0.6.2)
+    media_types (2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.3)
-      actionview (= 5.2.3)
-      activesupport (= 5.2.3)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.3)
-      activesupport (= 5.2.3)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
     ansi (1.5.0)
-    awesome_print (1.8.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.5)
-    crass (1.0.4)
-    docile (1.3.1)
-    domain_name (0.5.20180417)
-      unf (>= 0.0.5, < 1.0.0)
-    erubi (1.8.0)
-    http (4.1.1)
-      addressable (~> 2.3)
-      http-cookie (~> 1.0)
-      http-form_data (~> 2.0)
-      http_parser.rb (~> 0.6.0)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
-    http-form_data (2.1.1)
-    http_parser.rb (0.6.0)
-    i18n (1.6.0)
-      concurrent-ruby (~> 1.0)
-    json (2.2.0)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    minitest-ci (3.4.0)
-      minitest (>= 5.0.6)
-    minitest-reporters (1.3.6)
+    awesome_print (1.9.2)
+    builder (3.2.4)
+    docile (1.4.0)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.10.3)
-      mini_portile2 (~> 2.4.0)
-    nokogiri (1.10.3-x64-mingw32)
-      mini_portile2 (~> 2.4.0)
-    oj (3.7.12)
-    public_suffix (3.0.3)
-    rack (2.0.6)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    rake (12.3.2)
-    ruby-progressbar (1.10.0)
-    simplecov (0.16.1)
+    oj (3.13.1)
+    rake (13.0.6)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.5)
-    unf_ext (0.0.7.5-x64-mingw32)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
 
 PLATFORMS
-  ruby
   x64-mingw32
 
 DEPENDENCIES
-  actionpack
   awesome_print
-  bundler (~> 2)
-  http
+  bundler (>= 2)
   media_types!
   minitest (~> 5.0)
-  minitest-ci
   minitest-reporters
   oj
-  rake (~> 12.3)
+  rake (>= 12.0)
   simplecov
 
 BUNDLED WITH
-   2.0.1
+   2.2.7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Derk-Jan Karrenbeld
+
+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.