tiki 0.0.1

data/lib/tiki/spec.rb

@@ -0,0 +1,159 @@
+require 'json'
+require_relative './props'
+require_relative './path-item'
+require_relative './components'
+require_relative './server'
+
+using Props
+
+class License
+  props :name, :url
+
+  def initialize(name = nil, url = nil)
+    @name = name
+    @url = url
+  end
+
+  def to_spec
+    props = { name: @name }
+    props[:url] = @url if @url
+    props
+  end
+end
+
+class Contact
+  props :name, :url, :email
+  named_props :url, :email
+  scalar_props :name, :url, :email
+
+  def initialize(name = nil, **named)
+    @name = name
+    named_props named
+  end
+
+  def to_spec
+    scalar_props
+  end
+end
+
+class Info
+  props :title, :version, :description, :terms_of_service
+  scalar_props :title, :version, :description, :terms_of_service
+  object_props :license, :contact
+
+  def initialize(title = nil, version = nil, license: nil)
+    @title = title
+    @version = version
+    @license = License.new license if license
+  end
+
+  def license(name = nil, url = nil, &block)
+    @license = License.new name, url
+    @license.instance_eval(&block) if block
+  end
+
+  def contact(name = nil, **named, &block)
+    @contact = Contact.new name, **named
+    @contact.instance_eval(&block) if block
+  end
+
+  def to_spec
+    props = {}
+    scalar_props props
+    object_props props
+  end
+
+  alias terms terms_of_service
+end
+
+class Spec
+  include ServerMethods
+
+  object_props :info, :components
+  hash_props :paths
+  array_props :servers
+
+  def initialize
+    @paths = []
+  end
+
+  def version(spec_version)
+    @spec_version = spec_version
+  end
+
+  def openapi(spec_version = '3.0.3', &block)
+    @spec_version = spec_version
+    instance_eval(&block)
+  end
+
+  def info(title = nil, version = nil, &block)
+    @info = Info.new title, version
+    @info.instance_eval(&block) if block
+  end
+
+  def path(url, summary = nil, **named, &block)
+    root = PathItemRoot.new @paths
+    parent = root.child url
+    path = PathItem.new parent, summary, **named
+    path.instance_eval(&block) if block
+    parent.add path
+  end
+
+  def components(&block)
+    return unless block
+
+    @components ||= Components.new
+    @components.instance_eval(&block)
+  end
+
+  def to_spec
+    @paths.each do |(url, path_item)|
+      path_item.check_parameters url
+    end
+    props = { openapi: @spec_version }
+    object_props props
+    hash_props props
+    array_props props
+    props
+  end
+end
+
+class PathItemRoot
+  attr_reader :paths
+
+  def initialize(paths)
+    @paths = paths
+  end
+
+  def child(url)
+    PathItemParent.new url, self, []
+  end
+
+  def parameters
+    []
+  end
+end
+
+class PathItemParent
+  def initialize(url, parent, parameters)
+    @url = url
+    @parent = parent
+    @parameters = parameters
+  end
+
+  def child(url, parameters)
+    PathItemParent.new @url + url, self, parameters
+  end
+
+  def add(path_item)
+    @parent.paths.push [@url, path_item]
+  end
+
+  def paths
+    @parent.paths
+  end
+
+  def parameters
+    @parent.parameters + @parameters
+  end
+end

data/lib/tiki/spec.spec.rb

@@ -0,0 +1,65 @@
+require_relative './spec'
+
+describe do
+  describe 'openapi' do
+    describe 'an minimum openapi' do
+      let(:spec) { Spec.new }
+
+      it 'should return a correct spec' do
+        spec.openapi { info 'An OpenAPI', '1.0.0' }
+        expect(spec.to_spec).to eq(
+          {
+            openapi: '3.0.3',
+            info: {
+              title: 'An OpenAPI',
+              version: '1.0.0'
+            },
+            paths: {}
+          }
+        )
+      end
+    end
+  end
+
+  describe 'Info Object' do
+    let(:info) { Info.new }
+
+    describe 'a minimum Info object' do
+      before do
+        info.version '1.0.0'
+        info.title 'An OpenAPI'
+      end
+
+      it 'should return a correct spec' do
+        expect(info.to_spec).to eq(
+          {
+            title: 'An OpenAPI',
+            version: '1.0.0'
+          }
+        )
+      end
+    end
+  end
+
+  describe 'Contact Object' do
+    describe 'a minimum object' do
+      let(:contact) { Contact.new }
+
+      it 'should return a correct spec' do
+        expect(contact.to_spec).to eq({})
+      end
+    end
+
+    describe 'a fully initialized object' do
+      let(:contact) do
+        Contact.new 'Foo Bar', url: 'foo.bar', email: 'foo@bar'
+      end
+
+      it 'should return a correct spec' do
+        expect(contact.to_spec).to eq(
+          { name: 'Foo Bar', url: 'foo.bar', email: 'foo@bar' }
+        )
+      end
+    end
+  end
+end

data/lib/tiki.rb

@@ -0,0 +1,28 @@
+require 'optimist'
+require_relative './tiki/spec'
+require_relative './tiki/list-helpers'
+
+using ListHelpers
+
+def tiki
+  opts = Optimist.options do
+    opt :indir, 'Input directory', default: 'specs'
+    opt :outdir, 'Output directory', type: :string
+    opt :ext, 'Extension of the input files', default: 'oas.rb'
+  end
+
+  indir = opts[:indir]
+  outdir = opts[:outdir] || indir
+  ext = opts[:ext]
+
+  infiles = Dir.glob File.join(indir, "*.#{ext}")
+  puts "Found #{infiles.size} input #{infiles.size == 1 ? 'file' : 'files'}"
+  infiles.each do |infile|
+    outfile = File.join outdir, "#{File.basename(infile, '.rb')}.json"
+    puts "#{infile} -> #{outfile}"
+    spec = Spec.new
+    spec.instance_eval File.read(infile)
+    json = JSON.pretty_generate spec.to_spec
+    File.write outfile, json
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: tiki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kim Dalsgaard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tool for creating and using OpenAPI specs
+email: kim@kimdalsgaard.com
+executables:
+- tiki
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- bin/tiki
+- lib/tiki.rb
+- lib/tiki/components.rb
+- lib/tiki/content.rb
+- lib/tiki/external-documentation.rb
+- lib/tiki/list-helpers.rb
+- lib/tiki/media-type.rb
+- lib/tiki/operation.rb
+- lib/tiki/parameter.rb
+- lib/tiki/path-item.rb
+- lib/tiki/props.rb
+- lib/tiki/reason.rb
+- lib/tiki/reference.rb
+- lib/tiki/request-body.rb
+- lib/tiki/response.rb
+- lib/tiki/response.spec.rb
+- lib/tiki/schema.rb
+- lib/tiki/schema.spec.rb
+- lib/tiki/server.rb
+- lib/tiki/server.spec.rb
+- lib/tiki/spec.rb
+- lib/tiki/spec.spec.rb
+homepage: https://rubygems.org/gems/tiki
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Tiki
+test_files: []