add spec

Author: yrlu

.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0', '3.1']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run unit + integration tests
+        run: bundle exec rake spec

.github/workflows/gempush.yml

@@ -1,32 +1,54 @@
-name: jsonapi-swagger
+name: Release
 
 on:
-  pull_request:
-    branches:
-      - master
   push:
-    branches:
-      - master
+    tags:
+      - 'v*'
+  workflow_dispatch:
 
 jobs:
-  build:
-    name: Build + Publish
+  test:
+    name: Test (Ruby ${{ matrix.ruby }})
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0', '3.1']
 
     steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        version: 2.6.x
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run unit + integration tests
+        run: bundle exec rake spec
+
+  publish:
+    name: Publish to RubyGems
+    runs-on: ubuntu-latest
+    needs: test
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+
+      - name: Build gem
+        run: gem build jsonapi-swagger.gemspec
+
+      - name: Publish gem
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem push jsonapi-swagger-*.gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_AUTH_TOKEN }}

Rakefile

@@ -1,4 +1,11 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  # RSpec not available in all environments.
+end
 task default: :spec

jsonapi-swagger.gemspec

@@ -22,6 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'activesupport', '>= 5.2', '< 7.0'
+  spec.add_development_dependency 'i18n', '>= 0.7', '< 2.0'
   spec.add_development_dependency 'rubocop', '~> 0.67'
   spec.add_development_dependency 'rswag', '~>2.0'
 end

spec/integration/swagger_generator_spec.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+require 'erb'
+require 'fileutils'
+require 'ostruct'
+require 'tmpdir'
+
+module Rails
+  module Generators
+    class NamedBase
+      class << self
+        attr_accessor :_source_root, :_destination_root
+
+        def desc(*) = nil
+
+        def source_root(path = nil)
+          self._source_root = path if path
+          _source_root
+        end
+
+        def destination_root(path = nil)
+          self._destination_root = path if path
+          _destination_root
+        end
+      end
+
+      def initialize(name)
+        @name = name
+      end
+
+      def file_name
+        @name.to_s.underscore
+      end
+
+      def class_path
+        []
+      end
+
+      def template(src, dest)
+        src_path = File.join(self.class.source_root, src)
+        out_path = File.join(self.class.destination_root, dest)
+        FileUtils.mkdir_p(File.dirname(out_path))
+        File.write(out_path, ERB.new(File.read(src_path), trim_mode: '-').result(binding))
+      end
+    end
+  end
+end
+
+require 'jsonapi/swagger/json'
+require 'jsonapi/swagger/resource'
+require 'jsonapi/swagger/resources/jsonapi_resource'
+require 'generators/jsonapi/swagger/swagger_generator'
+
+RSpec.describe Jsonapi::SwaggerGenerator do
+  around do |example|
+    Dir.mktmpdir('jsonapi-swagger-spec') do |dir|
+      described_class.destination_root(dir)
+      example.run
+    end
+  end
+
+  before do
+    stub_const('JSONAPI', Module.new)
+    stub_const('JSONAPI::Resource', Class.new)
+
+    stub_const('User', Class.new)
+    User.define_singleton_method(:columns) do
+      [
+        OpenStruct.new(name: 'id', type: :integer, null: false, comment: 'ID'),
+        OpenStruct.new(name: 'name', type: :string, null: true, comment: 'Name')
+      ]
+    end
+
+    relation = OpenStruct.new(class_name: 'Company', table_name: 'companies')
+    relation.define_singleton_method(:belongs_to?) { true }
+
+    resource = Class.new(JSONAPI::Resource) do
+      def self._attributes = { id: nil, name: nil }
+      def self._relationships = { company: OpenStruct.new(class_name: 'Company', table_name: 'companies') }
+      def self.sortable_fields = [:name]
+      def self.creatable_fields = [:name]
+      def self.updatable_fields = [:name]
+      def self.filters = { name: {} }
+      def self.mutable? = true
+    end
+
+    # Ensure relationship object has belongs_to? and table_name.
+    resource._relationships[:company].define_singleton_method(:belongs_to?) { true }
+
+    stub_const('UserResource', resource)
+
+    Jsonapi::Swagger.config do |c|
+      c.use_rswag = false
+      c.base_path = '/api'
+      c.file_path = 'v1/swagger.json'
+    end
+  end
+
+  it 'generates swagger JSON via template' do
+    gen = described_class.new('User')
+    gen.create_swagger_file
+
+    out = File.join(described_class.destination_root, 'swagger', 'v1', 'swagger.json')
+    expect(File.exist?(out)).to eq(true)
+
+    json = JSON.parse(File.read(out))
+    expect(json['swagger']).to eq('2.0')
+    expect(json['basePath']).to eq('/api')
+    expect(json['paths']).to include('/users')
+    expect(json['paths']).to include('/users/{id}')
+    expect(json['paths']['/users']).to include('post')
+  end
+end

spec/jsonapi/swagger/config_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jsonapi::Swagger do
+  it 'provides defaults' do
+    expect(described_class.version).to eq('2.0')
+    expect(described_class.info).to eq({ title: 'API V1', version: 'V1' })
+    expect(described_class.file_path).to eq('v1/swagger.json')
+    expect(described_class.use_rswag).to eq(false)
+    expect(described_class.attribute_default).to eq({ type: :string, nullable: true, comment: nil })
+  end
+
+  it 'allows configuration via block' do
+    described_class.config do |c|
+      c.version = '2.1'
+      c.info = { title: 'API', version: 'V2' }
+      c.file_path = 'v2/swagger.json'
+      c.base_path = '/api'
+      c.use_rswag = true
+    end
+
+    expect(described_class.version).to eq('2.1')
+    expect(described_class.info).to eq({ title: 'API', version: 'V2' })
+    expect(described_class.file_path).to eq('v2/swagger.json')
+    expect(described_class.base_path).to eq('/api')
+    expect(described_class.use_rswag).to eq(true)
+  end
+end

spec/jsonapi/swagger/json_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'tempfile'
+
+RSpec.describe Jsonapi::Swagger::Json do
+  describe '#parse_doc' do
+    it 'returns an empty hash if file does not exist' do
+      json = described_class.new('nope/swagger.json')
+      expect(json.parse_doc).to eq({})
+    end
+
+    it 'returns an empty hash if content is not JSON' do
+      file = Tempfile.new(['swagger', '.json'])
+      file.write('not-json')
+      file.flush
+
+      json = described_class.new(file.path)
+      expect(json.parse_doc).to eq({})
+    ensure
+      file.close!
+    end
+
+    it 'parses valid JSON' do
+      file = Tempfile.new(['swagger', '.json'])
+      file.write('{"paths":{}}')
+      file.flush
+
+      json = described_class.new(file.path)
+      expect(json.parse_doc).to eq({ 'paths' => {} })
+    ensure
+      file.close!
+    end
+  end
+end

spec/jsonapi/swagger/resource_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Jsonapi::Swagger::Resource do
+  before do
+    stub_const('JSONAPI', Module.new)
+    stub_const('JSONAPI::Resource', Class.new)
+    stub_const('JSONAPI::Serializable', Module.new)
+    stub_const('JSONAPI::Serializable::Resource', Class.new)
+    stub_const('FastJsonapi', Module.new)
+    stub_const('FastJsonapi::ObjectSerializer', Class.new)
+  end
+
+  it 'wraps JSONAPI::Resource subclasses' do
+    klass = Class.new(JSONAPI::Resource) do
+      def self._attributes = { id: {}, name: {} }
+      def self._relationships = {}
+      def self.sortable_fields = []
+      def self.creatable_fields = []
+      def self.updatable_fields = []
+      def self.filters = {}
+      def self.mutable? = false
+    end
+    stub_const('UserResource', klass)
+
+    wrapper = described_class.with('User')
+    expect(wrapper).to be_a(Jsonapi::Swagger::JsonapiResource)
+    expect(wrapper.attributes).to eq({ id: {}, name: {} })
+  end
+
+  it 'wraps JSONAPI::Serializable::Resource subclasses' do
+    klass = Class.new(JSONAPI::Serializable::Resource) do
+      def self.type_val = :users
+      def self.attribute_blocks = { id: nil, name: nil }
+      def self.relationship_blocks = { company: nil }
+      def self.link_blocks = {}
+    end
+    stub_const('SerializableUser', klass)
+
+    wrapper = described_class.with('User')
+    expect(wrapper).to be_a(Jsonapi::Swagger::SerializableResource)
+    expect(wrapper.attributes).to eq({ id: nil, name: nil })
+    expect(wrapper.relationships.keys).to eq([:company])
+  end
+
+  it 'wraps FastJsonapi::ObjectSerializer subclasses' do
+    klass = Class.new(FastJsonapi::ObjectSerializer) do
+      def self.attributes_to_serialize = { id: {}, name: {} }
+      def self.relationships_to_serialize = {}
+    end
+    stub_const('UserSerializer', klass)
+
+    wrapper = described_class.with('User')
+    expect(wrapper).to be_a(Jsonapi::Swagger::FastJsonapiResource)
+    expect(wrapper.attributes).to eq({ id: {}, name: {} })
+  end
+
+  it 'raises when no supported resource is found' do
+    expect { described_class.with('User') }.to raise_error(Jsonapi::Swagger::Error, /not support/i)
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'json'
+
+require 'active_support'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/string/inflections'
+
+require 'i18n'
+I18n.enforce_available_locales = false if I18n.respond_to?(:enforce_available_locales=)
+
+require 'jsonapi/swagger'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.order = :random
+  Kernel.srand config.seed
+end