opushon 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 651d12bd2b0f56b85c3cc5a5a5de3b1d2caf285b
-  data.tar.gz: 9eac2b5b7e0dce96c0db5ac5aaa26d860263dd53
+  metadata.gz: 7a3cb8fd9120b42f1f8c2158cc41c7e740bb659c
+  data.tar.gz: d6363f7c674d0efbfd668a8e10164e9623f2ab82
 SHA512:
-  metadata.gz: aa3758fb3d93c9ddc489541a392d54c54400e226562e97bd03ef5a832cb28646e5a4dbc917ba081e7a777b1a208a6842534df5d0d503d363c0679f477c298a3b
-  data.tar.gz: 43e02e8f85644870cdc5ae64615c529227c39e913ebe48c9700c2a39b1b3990699db32cd699ac794697960a6b46c144612fdf63a47fbcba5f93950fb329f1ff9
+  metadata.gz: 5889b5b0437163ec429e62377c13e30efd404b6fa1816d203b13655a9e658d4f6ea3efdb161feadebf6982403f2f6f2b94b04f2b40775c74e730c013e0283fd6
+  data.tar.gz: c475f71d712b5a3bb4c10ebf73ef5eaa912857a8049bbfa3e3b6d1d29883fabe884064ce1fc55a95eb4883e99345ce7c6357d9ce2d688838106f1d4bad6d9bfa

data/Rakefile

@@ -14,5 +14,4 @@ namespace :test do
   end
 end
 
-task(:doc_stats) { ruby '-S yard stats' }
-task default: [:test, :doc_stats]
+task default: :test

data/VERSION.semver

@@ -1 +1 @@
-0.0.1
+0.1.0

data/lib/opushon/error/min_is_greater_than_max_error.rb

@@ -0,0 +1,8 @@
+require_relative 'base_error'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Raised if min is greater than max.
+  class MinIsGreaterThanMaxError < BaseError
+  end
+end

data/lib/opushon/error/minlen_is_longer_than_maxlen_error.rb

@@ -0,0 +1,8 @@
+require_relative 'base_error'
+
+# Namespace for the Opushon library.
+module Opushon
+  # Raised if min is greater than the default value.
+  class MinlenIsLongerThanMaxlenError < BaseError
+  end
+end

data/lib/opushon/instance.rb

@@ -1,4 +1,3 @@
-require_relative 'option'
 require_relative 'option_object'
 require_relative 'verb'
 require 'json'
@@ -8,19 +7,20 @@ module Opushon
   # Parse a Opushon string in opushon.
   class Instance
     def initialize(opushon)
-      o = JSON.load opushon
+      o = JSON.parse(opushon, symbolize_names: true)
 
       unless o.is_a?(Hash)
         fail SyntaxError
       end
 
-      unless o.keys.map(&:to_sym).to_set.subset? VERBS
+      unless o.keys.to_set.subset? VERBS
         fail VerbError
       end
 
       @options = {}
       o.each do |verb, option_object|
-        @options.update verb => OptionObject.new(verb, option_object)
+        option_object_sym = JSON.parse(option_object.to_json, symbolize_names: true)
+        @options.update verb => OptionObject.new(option_object_sym)
       end
     end
 
@@ -30,14 +30,5 @@ module Opushon
     def to_h
       Hash[@options.each { |k,v| @options[k] = v.to_h }]
     end
-
-    # Runs all the validations within the current context.
-    #
-    # @return [Boolean] Returns true if no errors are found, false otherwise.
-    #
-    # @api public
-    def valid?(verb, example)
-      @options.fetch(verb.to_s).valid? example
-    end
   end
 end

data/lib/opushon/option_object.rb

@@ -1,56 +1,36 @@
-require_relative 'attribute'
-require_relative 'verb'
+require_relative 'parameter'
 
 # Namespace for the Opushon library.
 module Opushon
   # Parse a Opushon string in opushon.
   class OptionObject
-    def initialize(verb, members)
-      @verb           = verb
-      @title          = members.delete('title')         { '' }
-      @description    = members.delete('description')   { '' }
+    def initialize( title:        '',
+                    description:  '',
+                    parameters:   {},
+                    examples:     {} )
 
-      @query_string   = {}
-      query_string    = members.delete('query_string')  { Hash.new }
-      query_string.each do |key, properties|
-        @query_string.update key => Attribute.new(properties)
-      end
+      @title          = title.to_s
+      @description    = description.to_s
 
-      @parameters     = {}
-      parameters      = members.delete('parameters')    { Hash.new }
-      parameters.each do |key, properties|
-        @parameters.update key => Attribute.new(properties)
-      end
+      @input_params   = Parameter::Input.load parameters.fetch(:input)   { nil }
+      @output_params  = Parameter::Output.load parameters.fetch(:output) { nil }
 
-      @example        = members.delete('example')       { nil }
+      @input_example  = examples.fetch(:input)                           { nil }
+      @output_example = examples.fetch(:output)                          { nil }
 
-      unless @example.nil?
-        fail InvalidExample unless valid?(@example)
-      end
-
-      @other_settings = members
+      freeze
     end
 
     # Dump option object's members to a hash.
     def to_h
       {
-        'title'         => @title,
-        'description'   => @description,
-        'query_string'  => @query_string.each { |k,v| @query_string[k] = v.to_h },
-        'parameters'    => @parameters.each   { |k,v| @parameters[k]   = v.to_h },
-        'example'       => @example
-      }.merge(@other_settings)
-    end
-
-    # Runs all the validations within the current context.
-    #
-    # @return [Boolean] Returns true if no errors are found, false otherwise.
-    def valid?(example)
-      unless VERBS.include?(@verb.to_sym)
-        fail VerbError
-      end
-
-      true
+        title:        @title,
+        description:  @description,
+        parameters: { input:  @input_params,
+                      output: @output_params },
+        examples:   { input:  @input_example,
+                      output: @output_example }
+      }
     end
   end
 end

data/lib/opushon/parameter/base.rb

@@ -0,0 +1,47 @@
+require_relative File.join '..', 'type'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Parameter
+    # Abstract class.
+    class Base
+      def self.load(input_or_output_params)
+        if input_or_output_params.nil?
+          @input_or_output_params = nil
+        else
+          @input_or_output_params = {}
+
+          input_or_output_params.each do |key, properties|
+            properties_sym = JSON.parse(properties.to_json, symbolize_names: true)
+            @input_or_output_params.update key.to_sym => new(properties_sym).to_h
+          end
+        end
+
+        @input_or_output_params
+      end
+
+      def initialize( title:              '',
+                      description:        '',
+                      nullifiable:        true,
+                      type:               'string', **type_properties )
+
+        @title        = title.to_s
+        @description  = description.to_s
+        @nullifiable  = nullifiable
+        @type         = Type.const_get(type.capitalize).new(type_properties)
+
+        freeze
+      end
+
+      # Dump attribute's properties to a hash.
+      def to_h
+        {
+          title:        @title,
+          description:  @description,
+          nullifiable:  @nullifiable,
+          type:         @type.to_sym
+        }
+      end
+    end
+  end
+end

data/lib/opushon/parameter/input.rb

@@ -0,0 +1,34 @@
+require_relative 'base'
+require_relative File.join '..', 'restricted_value'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Parameter
+  # Parse a Opushon input.
+    class Input < Base
+      def initialize( query_string:       true,
+                      restricted_values:  nil,
+                      title:              '',
+                      description:        '',
+                      nullifiable:        true,
+                      type:               'string', **type_properties )
+
+        @query_string       = query_string
+        @restricted_values  = RestrictedValue.load_list(restricted_values)
+
+        @title        = title.to_s
+        @description  = description.to_s
+        @nullifiable  = nullifiable
+        @type         = Type.const_get(type.capitalize).new(type_properties)
+      end
+
+      # Dump attribute's properties to a hash.
+      def to_h
+        {
+          query_string:       @query_string,
+          restricted_values:  @restricted_values
+        }.merge(super).merge(@type.constraints)
+      end
+    end
+  end
+end

data/lib/opushon/parameter/output.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Parameter
+    # Parse a Opushon output.
+    class Output < Base
+    end
+  end
+end

data/lib/opushon/parameter.rb

@@ -0,0 +1,9 @@
+module Opushon
+  # Namespace for parameters parsing.
+  module Parameter
+  end
+end
+
+Dir[File.join File.dirname(__FILE__), 'parameter', '*.rb'].each do |filename|
+  require_relative filename
+end

data/lib/opushon/restricted_value.rb

@@ -0,0 +1,35 @@
+# Namespace for the Opushon library.
+module Opushon
+  # Parse a Opushon string in opushon.
+  class RestrictedValue
+    attr_reader :value
+
+    def self.load_list(restricted_values)
+      return if restricted_values.nil?
+
+      restricted_values.map do |restricted_value|
+        new(JSON.parse(restricted_value.to_json, symbolize_names: true)).to_h
+      end
+    end
+
+    def initialize( title:        '',
+                    description:  '',
+                    value:          )
+
+      @title        = title.to_s
+      @description  = description.to_s
+      @value        = value
+
+      freeze
+    end
+
+    # Dump instance's opushon to a hash.
+    def to_h
+      {
+        title:        @title,
+        description:  @description,
+        value:        @value
+      }
+    end
+  end
+end

data/lib/opushon/type/array.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Type
+    # The type number.
+    class Array < Base
+    end
+  end
+end

data/lib/opushon/type/base.rb

@@ -3,15 +3,22 @@ module Opushon
   module Type
     # Abstract class.
     class Base
-      def default
-        nil
+      def initialize(*)
+        freeze
       end
 
       def to_h
         {
-          'default' => default,
-          'type'    => self.class.name.split('::').last.downcase
-        }
+          type: to_sym
+        }.merge(constraints)
+      end
+
+      def to_sym
+        self.class.name.split('::').last.downcase
+      end
+
+      def constraints
+        {}
       end
     end
   end

data/lib/opushon/type/boolean.rb

@@ -5,9 +5,6 @@ module Opushon
   module Type
     # The type boolean.
     class Boolean < Base
-      def default
-        false
-      end
     end
   end
 end

data/lib/opushon/type/hash.rb

@@ -0,0 +1,10 @@
+require_relative 'base'
+
+# Namespace for the Opushon library.
+module Opushon
+  module Type
+    # The type number.
+    class Hash < Base
+    end
+  end
+end

data/lib/opushon/type/number.rb

@@ -5,22 +5,24 @@ module Opushon
   module Type
     # The type number.
     class Number < Base
-      def initialize(constraints)
-        @min  = constraints.delete('min')   { nil }
-        @max  = constraints.delete('max')   { nil }
-        @step = constraints.delete('step')  { nil }
-      end
+      def initialize( min: nil,
+                      max: nil )
+
+        if !min.nil? && !max.nil?
+          fail MinIsGreaterThanMaxError if min > max
+        end
+
+        @min = min
+        @max = max
 
-      def default
-        0
+        freeze
       end
 
-      def to_h
-        super.merge({
-          'min'   => @min,
-          'max'   => @max,
-          'step'  => @step
-        })
+      def constraints
+        {
+          min: @min,
+          max: @max
+        }
       end
     end
   end

data/lib/opushon/type/string.rb

@@ -5,22 +5,27 @@ module Opushon
   module Type
     # The type string.
     class String < Base
-      def initialize(constraints)
-        @minlen  = constraints.delete('minlen')   { nil }
-        @maxlen  = constraints.delete('maxlen')   { nil }
-        @pattern = constraints.delete('pattern')  { nil }
-      end
+      def initialize( minlen:   nil,
+                      maxlen:   nil,
+                      pattern:  nil )
+
+        if !minlen.nil? && !maxlen.nil?
+          fail MinlenIsLongerThanMaxlenError if minlen > maxlen
+        end
+
+        @minlen   = minlen
+        @maxlen   = maxlen
+        @pattern  = pattern
 
-      def default
-        ''
+        freeze
       end
 
-      def to_h
-        super.merge({
-          'minlen'  => @minlen,
-          'maxlen'  => @maxlen,
-          'pattern' => @pattern
-        })
+      def constraints
+        {
+          minlen:   @minlen,
+          maxlen:   @maxlen,
+          pattern:  @pattern
+        }
       end
     end
   end

data/lib/opushon/verb.rb

@@ -1,5 +1,3 @@
-require 'set'
-
 Dir[File.join File.dirname(__FILE__), 'verb', '*.rb'].each do |filename|
   require_relative filename
 end

data/lib/opushon/version.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 # Namespace for the Opushon library.
 module Opushon
   # Gem version

data/opushon.gemspec

@@ -16,6 +16,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler',    '~> 1.7'
   spec.add_development_dependency 'minitest',   '~> 5'
   spec.add_development_dependency 'rake',       '~> 10.0'
-  spec.add_development_dependency 'yard',       '~> 0.8'
   spec.add_development_dependency 'coveralls',  '~> 0.7'
 end

data/spec/opushon/parameter/input_spec.rb

@@ -0,0 +1,161 @@
+require_relative 'spec_helper'
+
+describe Opushon::Parameter::Input do
+  subject do
+    Opushon::Parameter::Input
+  end
+
+  describe '.load' do
+    it 'MUST return the hash' do
+      params = {
+        foo: subject.new(title: 'Foo').to_h,
+        bar: subject.new(title: 'Bar').to_h
+      }
+
+      subject.load(params).must_equal({
+        foo: subject.new(title: 'Foo').to_h,
+        bar: subject.new(title: 'Bar').to_h
+      })
+    end
+  end
+
+  describe '.new' do
+    describe '#to_h' do
+      describe 'default params' do
+        describe 'default type' do
+          it 'MUST return the hash' do
+            o = subject.new
+
+            o.to_h.must_equal(title:              '',
+                              description:        '',
+                              type:               'string',
+                              nullifiable:        true,
+                              query_string:       true,
+                              restricted_values:  nil,
+                              minlen:             nil,
+                              maxlen:             nil,
+                              pattern:            nil)
+          end
+        end
+
+        describe 'string type' do
+          it 'MUST return the hash' do
+            o = subject.new(type: 'string')
+
+            o.to_h.must_equal(title:              '',
+                              description:        '',
+                              type:               'string',
+                              nullifiable:        true,
+                              query_string:       true,
+                              restricted_values:  nil,
+                              minlen:             nil,
+                              maxlen:             nil,
+                              pattern:            nil)
+          end
+        end
+
+        describe 'number type' do
+          it 'MUST return the hash' do
+            o = subject.new(type: 'number')
+
+            o.to_h.must_equal(title:              '',
+                              description:        '',
+                              type:               'number',
+                              nullifiable:        true,
+                              query_string:       true,
+                              restricted_values:  nil,
+                              min:                nil,
+                              max:                nil)
+          end
+        end
+
+        describe 'boolean type' do
+          it 'MUST return the hash' do
+            o = subject.new(type: 'boolean')
+
+            o.to_h.must_equal(title:              '',
+                              description:        '',
+                              type:               'boolean',
+                              nullifiable:        true,
+                              query_string:       true,
+                              restricted_values:  nil)
+          end
+        end
+
+        describe 'array type' do
+          it 'MUST return the hash' do
+            o = subject.new(type: 'array')
+
+            o.to_h.must_equal(title:              '',
+                              description:        '',
+                              type:               'array',
+                              nullifiable:        true,
+                              query_string:       true,
+                              restricted_values:  nil)
+          end
+        end
+
+        describe 'hash type' do
+          it 'MUST return the hash' do
+            o = subject.new(type: 'hash')
+
+            o.to_h.must_equal(title:              '',
+                              description:        '',
+                              type:               'hash',
+                              nullifiable:        true,
+                              query_string:       true,
+                              restricted_values:  nil)
+          end
+        end
+      end
+    end
+
+    describe 'random example' do
+      it 'MUST return the hash' do
+        o = subject.new(
+          description:        'State of the issues to return.',
+          type:               'boolean',
+          query_string:       false,
+          nullifiable:        true,
+          restricted_values:  [
+            {
+              value: "open",
+              title: "Open"
+            },
+            {
+              value: "closed",
+              title: "Closed"
+            },
+            {
+              value: "all",
+              title: "All"
+            }
+          ]
+        )
+
+        o.to_h.must_equal(title:              '',
+                          description:        'State of the issues to return.',
+                          type:               'boolean',
+                          nullifiable:        true,
+                          query_string:       false,
+                          restricted_values:  [
+                            {
+                              title:        'Open',
+                              description:  '',
+                              value:        'open'
+                            },
+                            {
+                              title:        'Closed',
+                              description:  '',
+                              value:        'closed'
+                            },
+                            {
+                              title:        'All',
+                              description:  '',
+                              value:        'all'
+                            }
+                          ])
+      end
+    end
+  end
+end