swagger_docs_generator 0.1.2 → 0.2.0.pre.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c5734093ec6f9cbab3b957e7a2a6d90b0d780ae
-  data.tar.gz: 96a39e44e18eadde0f0e0a530c41437d84f00e71
+  metadata.gz: c601e2d531717fc247480909bfb440416f0364c8
+  data.tar.gz: 3b131bc8788fce1976747db08288530a0ea0a2c0
 SHA512:
-  metadata.gz: 00cf5fbd1e2fa923f38f64ef2c8ddd15f3d148682b1967b8d99aa7f6876ab395db61049e5088281b5ba192a89877f996e5a06c7c6a48c50edee01f33573f4127
-  data.tar.gz: 4b8db2dddcc67381a419f5bf84dc54cf32e71253914b6953df2df56ba78a793471b33c926d39d267c241bf700d5e1619feadfc539a0597509871ceb9da6b1d51
+  metadata.gz: 1ca29dec9600509b63aa3f6c738686e715595e79a7f9c66ce313e3711c186a39841e7c7c3a037a1d6c1b8f0117435b0111f57344afb945eb950471c7173bf7b2
+  data.tar.gz: dc05b25092fd2a5f75d3fab0e3ac41d08f2eab1136f4ec98b349ceb19bcd4998f0f40eaa36fbf222c922fc5e868b957241f52a52cf3f678fe3fb7ad2f7bf5337

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in swagger-docs-generator.gemspec

data/README.md

@@ -1,36 +1,68 @@
-# Swagger::Docs::Generator
+# Swagger::Docs::Generator | [![Build Status](https://travis-ci.org/Dev-Crea/swagger-docs-generator.svg?branch=master)](https://travis-ci.org/Dev-Crea/swagger-docs-generator) [![Gem Version](https://badge.fury.io/rb/swagger_docs_generator.svg)](https://badge.fury.io/rb/swagger_docs_generator) [![Inline docs](https://inch-ci.org/github/Dev-Crea/swagger-docs-generator.svg)](https://inch-ci.org/github/Dev-Crea/swagger-docs-generator)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swagger/docs/generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+Generator for Swagger Apps ([Example with theme](https://github.com/Dev-Crea/swagger-ui))
 
-TODO: Delete this and the text above, and describe your gem
+## Menu
 
-## Installation
+* [How to use](#how-to-use)
+  * [Installation](#installation)
+  * [Usage](#usage)
+* [Development](#development)
+* [Contributing](#contributing)
 
-Add this line to your application's Gemfile:
+
+## How to use
+
+### Installation
+
+Add this line to your application's Gemfile :
 
 ```ruby
 gem 'swagger-docs-generator'
 ```
 
-And then execute:
+And then execute :
 
-    $ bundle
+```linux
+$ bundle
+```
 
-Or install it yourself as:
+Or install it yourself as :
 
-    $ gem install swagger-docs-generator
+```linux
+$ gem install swagger-docs-generator
+```
 
-## Usage
+### Usage
 
-TODO: Write usage instructions here
+Create initializer :
+
+```linux
+rails generator swagger_docs_generator:initializer
+```
+
+Execute rake task for generated `swagger.json` :
+
+```linux
+rake swagger:docs
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger-docs-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/Dev-Crea/swagger-docs-generator. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](http://contributor-covenant.org)
+code of conduct.

data/lib/swagger_docs_generator/info.rb

@@ -5,7 +5,7 @@ module SwaggerDocsGenerator
   # Name to gem
   GEM =           'swagger_docs_generator'
   # Version to gem
-  VERSION =       '0.1.2'
+  VERSION =       '0.2.0'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'bundler/setup'
+require 'swagger_docs_generator'
+require 'json-schema-rspec'
+
+RSpec.configure do |config|
+  # Configure RSpec
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # Add libraries
+  config.include JSON::SchemaMatchers
+
+  # Configure JSON::SchemaMatchers
+  Dir[File.join('spec/support/schemas/', '*.json')].count do |file|
+    json_file = JSON.parse(File.read(file))
+    json_name = File.basename(file, '.json').to_sym
+    config.json_schemas[json_name] = json_file
+  end
+
+  # Exclude request with tag broken
+  config.filter_run_excluding broken: true
+
+  # Customize rspec
+  config.color = true
+end

data/spec/support/examples/configuration.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'variable exist' do |name|
+  it name do
+    expect(variable).not_to be nil
+  end
+end

data/spec/support/examples/generator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples 'method' do |result|
+  it "return #{result}" do
+    expect(method).to eql(result)
+  end
+end

data/spec/support/schemas/swagger.json

@@ -0,0 +1,15 @@
+{
+  "type": "object",
+  "properties": {
+    "swagger": {
+      "type": "string"
+    },
+    "info": {
+      "type": "hash"
+    }
+  },
+  "required": [
+    "swagger",
+    "info"
+  ]
+}

data/spec/swagger_docs_generator/configuration_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/examples/configuration'
+
+describe SwaggerDocsGenerator::Configuration, type: :gem,
+                                              name: :configuration do
+  specify do
+    expect { |config| SwaggerDocsGenerator.configure(&config) }.to yield_control
+  end
+
+  let(:conf) { SwaggerDocsGenerator.configure }
+  let(:variable) { conf.swagger }
+  it_behaves_like 'variable exist', 'swagger'
+end
+
+describe SwaggerDocsGenerator::ConfigurationInfo, type: :gem,
+                                                  name: :configuration_info do
+  let(:conf) { SwaggerDocsGenerator.configure_info }
+  let(:variable) { conf.title }
+  it_behaves_like 'variable exist', 'title'
+  let(:variable) { conf.version }
+  it_behaves_like 'variable exist', 'version'
+end

data/spec/swagger_docs_generator/gem_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe SwaggerDocsGenerator, type: :gem,
+                               name: :constant do
+  it 'has a gem name' do
+    expect(SwaggerDocsGenerator::GEM).not_to be nil
+  end
+
+  it 'has a version number' do
+    expect(SwaggerDocsGenerator::VERSION).not_to be nil
+  end
+
+  it 'has a author' do
+    expect(SwaggerDocsGenerator::AUTHORS).not_to be nil
+  end
+
+  it 'has a email' do
+    expect(SwaggerDocsGenerator::EMAILS).not_to be nil
+  end
+
+  it 'has a summary' do
+    expect(SwaggerDocsGenerator::SUMMARY).not_to be nil
+  end
+
+  it 'has a dscription' do
+    expect(SwaggerDocsGenerator::DESCRIPTION).not_to be nil
+  end
+
+  it 'has a homepage' do
+    expect(SwaggerDocsGenerator::HOMEPAGE).not_to be nil
+  end
+
+  it 'has a license' do
+    expect(SwaggerDocsGenerator::LICENSE).not_to be nil
+  end
+end

data/spec/swagger_docs_generator/generator_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'support/examples/generator'
+
+describe SwaggerDocsGenerator::Generator, type: :gem,
+                                          name: :generator, broken: true do
+  before(:context) do
+    @swag = SwaggerDocsGenerator::Generator.new
+    @swagger_file = @swag.swagger_file
+  end
+
+  context 'File exist' do
+    before(:context) do
+      @swag.generate_swagger_file
+    end
+
+    describe '#generate_swagger_file' do
+      let(:method) { @swag.generate_swagger_file }
+      it_behaves_like 'method', nil
+    end
+
+    it { expect(File.exist?(@swagger_file)).to eql(true) }
+    it { expect(@swagger_file).to match_json_schema(:swagger) }
+
+    after(:context) { File.delete(@swagger_file) }
+  end
+
+  context "File doesn't exist" do
+    it { expect(File.exist?(@swagger_file)).to eql(false) }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0.pre.9
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -129,19 +143,65 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+- !ruby/object:Gem::Dependency
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :runtime
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.3
 description: Generates swagger-ui json file for rails-api
 email:
 - jeremy@dazzl.tv
@@ -185,6 +245,13 @@ files:
 - lib/swagger_docs_generator/parser/parser.rb
 - lib/swagger_docs_generator/railtie.rb
 - lib/tasks/swagger.rake
+- spec/spec_helper.rb
+- spec/support/examples/configuration.rb
+- spec/support/examples/generator.rb
+- spec/support/schemas/swagger.json
+- spec/swagger_docs_generator/configuration_spec.rb
+- spec/swagger_docs_generator/gem_spec.rb
+- spec/swagger_docs_generator/generator_spec.rb
 homepage: https://github.com/Dev-Crea/swagger-docs-generator
 licenses:
 - MIT
@@ -200,12 +267,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Swagger UI json file