opushon 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d478dd02277f97c91f3767f7f3455157b030ba89
-  data.tar.gz: c8470e81def24155c2c1a8588b172ca4024f5c8c
+SHA256:
+  metadata.gz: 24fefd1822417befed8d3b8678ccda2e3f05eb7462617cdfd9bcf1d63302cded
+  data.tar.gz: 057236242425accea1ed1696b370b42cfbeedcf4cfce124734e3f6f0cac75552
 SHA512:
-  metadata.gz: 6b8940675e9f52519378842d28c473342d0ec7a6cb9e9b1ba93f3fd982678119358a546a242817db9a9092a5b26f8a93ea59799dae90e6fbb19d355c8f46a7be
-  data.tar.gz: 5b9dc5cc63f0664c74a04b0af0486d54073b266a6ff348704c0bd9f7a0f7d2da515de75779c712329a06443899315268ba907e67f214e4e2509dd98818fcbdec
+  metadata.gz: 046e40f75c5a8bee027928d7b2af0da0fe00f6bd9d8d8a7732a959e643dbb93a373f7de43c479c4cb98e054eba7cd685a54796f1b55e628f6ab914c7f64f5d38
+  data.tar.gz: 1d95889786e06951548c92680e7a8795d97225839ba6a52aeb89723ac1bf0f8b6fb04fe82f022d1ac293783df6599483323f8b635c46032c20ab7d4503f07291

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,103 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-08-26 13:08:39 +0200 using RuboCop version 0.74.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: TreatCommentsAsGroupSeparators, Include.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'opushon.gemspec'
+
+# Offense count: 24
+# Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/AlignHash:
+  Exclude:
+    - 'lib/opushon/body.rb'
+    - 'lib/opushon/option.rb'
+    - 'lib/opushon/parameter.rb'
+    - 'lib/opushon/request.rb'
+    - 'lib/opushon/response.rb'
+    - 'lib/opushon/restricted_value.rb'
+
+# Offense count: 356
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'test/test_opushon.rb'
+
+# Offense count: 140
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces.
+# SupportedStyles: space, no_space, compact
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideHashLiteralBraces:
+  Exclude:
+    - 'test/test_opushon.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 22
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: braces, no_braces, context_dependent
+Style/BracesAroundHashParameters:
+  Exclude:
+    - 'test/test_opushon.rb'
+
+# Offense count: 3
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/opushon/option.rb'
+    - 'lib/opushon/request.rb'
+    - 'lib/opushon/response.rb'
+
+# Offense count: 356
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'test/test_opushon.rb'
+
+# Offense count: 1
+Style/MixinUsage:
+  Exclude:
+    - 'test/test_opushon.rb'
+
+# Offense count: 136
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'test/test_opushon.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, WordRegex.
+# SupportedStyles: percent, brackets
+Style/WordArray:
+  EnforcedStyle: brackets
+
+# Offense count: 19
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 3537

data/.travis.yml

@@ -1,13 +1,19 @@
 language: ruby
 sudo: false
 cache: bundler
-script: 'bundle exec rake test:coverage --trace'
 before_install:
   - gem install bundler
+script:
+  - bundle exec rubocop
+  - bundle exec rake test
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.5.0
+  - 2.6.2
   - ruby-head
   - jruby-head
-  - rbx-2
+  - rbx-3
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-3

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Cyril Wack
+Copyright (c) 2014 Cyril Kato
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -3,7 +3,6 @@
 [![Build Status](https://travis-ci.org/cyril/opushon.rb.svg?branch=master)][travis]
 [![Gem Version](https://badge.fury.io/rb/opushon.svg)][gem]
 [![Inline docs](http://inch-ci.org/github/cyril/opushon.rb.svg?branch=master)][inchpages]
-[![Documentation](http://img.shields.io/:yard-docs-38c800.svg)][rubydoc]
 
 > An [Opushon's body](https://github.com/cyril/opushon) parser and emitter.
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
@@ -16,5 +18,4 @@ namespace :test do
   end
 end
 
-task(:doc_stats) { ruby '-S yard stats' }
-task default: [:test, :doc_stats, :rubocop]
+task default: %i[test rubocop]

data/VERSION.semver

@@ -1 +1 @@
-0.2.1
+0.2.2

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'opushon'

data/bin/setup

@@ -1,4 +1,5 @@
 #!/bin/bash
+
 set -euo pipefail
 IFS=$'\n\t'
 

data/lib/opushon/body.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'option'
 
 module Opushon

data/lib/opushon/option.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'request'
 require_relative 'response'
 

data/lib/opushon/parameter.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'restricted_value'
 
 module Opushon
+  # The content of headers, query string and body params MUST be described with
+  #   the keys below. When a key is missing, its default value is assigned.
   class Parameter
     include Virtus.model(strict: true)
 
@@ -10,11 +14,11 @@ module Opushon
     attribute :nullifiable,       Boolean,                default: true,      required: true
     attribute :restricted_values, Array[RestrictedValue],                     required: false
     attribute :example,           BasicObject,                                required: false
-    attribute :minlen,            Fixnum,                                     required: false
-    attribute :maxlen,            Fixnum,                                     required: false
+    attribute :minlen,            Integer,                                    required: false
+    attribute :maxlen,            Integer,                                    required: false
     attribute :pattern,           Regexp,                                     required: false
-    attribute :min,               Fixnum,                                     required: false
-    attribute :max,               Fixnum,                                     required: false
+    attribute :min,               Integer,                                    required: false
+    attribute :max,               Integer,                                    required: false
 
     def to_h
       h = {
@@ -30,7 +34,7 @@ module Opushon
         h.update(
           minlen:   @minlen,
           maxlen:   @maxlen,
-          pattern:  (@pattern.nil? ? nil : @pattern.to_s)
+          pattern:  @pattern&.to_s
         )
       end
 
@@ -40,16 +44,16 @@ module Opushon
           max: @max
         )
       end
+
+      h
     end
 
     private
 
     def maybe_to_a(object)
-      if object.nil?
-        nil
-      else
-        object.map(&:to_h)
-      end
+      return if object.nil?
+
+      object.map(&:to_h)
     end
   end
 end

data/lib/opushon/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'parameter'
 
 module Opushon

data/lib/opushon/response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'parameter'
 
 module Opushon

data/lib/opushon/restricted_value.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module Opushon
+  # If present, the value of restricted_values is an array where each item
+  #   contains a hash.
   class RestrictedValue
     include Virtus.model(strict: true)
 

data/lib/opushon.rb

@@ -1,36 +1,38 @@
+# frozen_string_literal: true
+
 require 'virtus'
 require 'json'
-require_relative File.join 'opushon', 'body'
 
 # Namespace for the Opushon library.
+# Representation of documentations for HTTP APIs.
 #
 # @api private
 module Opushon
-  class << self
-    # Load opushon in to the Ruby data structure.
-    #
-    # @api public
-    #
-    # @example Load the option of a DELETE interface
-    #   load('{"DELETE":{"title":"Delete issues","description":"Remove every issues.","request":{"headers":{},"query_string":{},"body":{}},"response":{"headers":{},"query_string":{},"body":{}}}}')
-    #
-    # @param [String] opushon_string
-    #
-    # @return [Body] the Ruby data structure
-    def load(opushon_string)
-      opushon_hash = JSON.load(opushon_string)
-      Body.new(opushon_hash)
-    end
+  # Load opushon in to the Ruby data structure.
+  #
+  # @api public
+  #
+  # @example Load the option of a DELETE interface
+  #   load('{"DELETE":{"title":"Delete issues","description":"Remove every issues.","request":{"headers":{},"query_string":{},"body":{}},"response":{"headers":{},"query_string":{},"body":{}}}}')
+  #
+  # @param [String] opushon_string
+  #
+  # @return [Body] the Ruby data structure
+  def self.load(opushon_string)
+    opushon_hash = JSON.parse(opushon_string)
+    Body.new(opushon_hash)
+  end
 
-    # Dump Ruby object to a Opushon string.
-    #
-    # @api public
-    #
-    # @param [Body] opushon
-    #
-    # @return [String] the Opushon data representation
-    def dump(opushon)
-      opushon.to_h.to_json
-    end
+  # Dump Ruby object to a Opushon string.
+  #
+  # @api public
+  #
+  # @param [Body] opushon
+  #
+  # @return [String] the Opushon data representation
+  def self.dump(opushon)
+    opushon.to_h.to_json
   end
 end
+
+require_relative File.join('opushon', 'body')

data/opushon.gemspec

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |spec|
   spec.name          = 'opushon'
   spec.version       = File.read('VERSION.semver').chomp
-  spec.authors       = ['Cyril Wack']
+  spec.authors       = ['Cyril Kato']
   spec.email         = ['contact@cyril.email']
 
   spec.summary       = 'A HTTP Opushon parser and emitter'
@@ -16,10 +18,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'virtus',                 '~> 1.0.5'
 
-  spec.add_development_dependency 'bundler',    '~> 1.10'
-  spec.add_development_dependency 'rake',       '~> 10.4'
-  spec.add_development_dependency 'yard',       '~> 0.8'
-  spec.add_development_dependency 'simplecov',  '~> 0.10'
-  spec.add_development_dependency 'rubocop',    '~> 0.33'
-  spec.add_development_dependency 'spectus',    '~> 2.1'
+  spec.add_development_dependency 'bundler',    '~> 2.0'
+  spec.add_development_dependency 'rake',       '~> 12.3'
+  spec.add_development_dependency 'simplecov',  '~> 0.17'
+  spec.add_development_dependency 'rubocop',    '~> 0.74'
+  spec.add_development_dependency 'spectus',    '~> 3.0'
 end

data/pkg_checksum

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'digest/sha2'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opushon
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
-- Cyril Wack
+- Cyril Kato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -30,84 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.33'
+        version: '0.74'
 - !ruby/object:Gem::Dependency
   name: spectus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 description: An Opushon's body parser and emitter.
 email:
 - contact@cyril.email
@@ -116,6 +102,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -156,10 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A HTTP Opushon parser and emitter
 test_files: []
-has_rdoc: