tomograph 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c457270d6d9ab0b7d23c4af643248636f3fe9b3f673858700505ab55ee31716f
-  data.tar.gz: d089a1f21d1ab2e739854f962eff9e0e7fcdc3cdb631a595f84a328afc016823
+  metadata.gz: 6b82305a8afc3940fb54799c20a96c71685f1950addb5b0413572bb3ca6e5c2f
+  data.tar.gz: eddef2bcfd9ba3f22d3cf4511e0e7ce6a32c28992e0c022602c499210b72c2a1
 SHA512:
-  metadata.gz: 4f31296ba8532f93e0f89f881e0c0aa07a3a2a2752d2f6764be9ac6bf0ee5a8e1103b4f5bc2eb9b8ef0472f70432acaec379d2b914338fefed6f8e7c2842f3d3
-  data.tar.gz: b54f9a273905b2e7d3bd2d91777f46fc5c626dec43124abf6a3b5fed85a63e3ec63e21568498e6f072ab48020a58e6c833ab89a2ef7bf2692acc184c614cb6d4
+  metadata.gz: 4843bb38871e842c26f63c6af9ac1d87fd5f153a56255c1b3d070eb35686c08b84c8279bf900d9dd4a0cf38fb9daff3b905bb58285e169c118ad7d36c7855b8c
+  data.tar.gz: 3df3afd4cc5064d767dad8640f156bd39972a728927621ac740f332609b21a3533be36d71099208f527e7d290970ab0e59814bc5d00239135687e2015a9e8b9d

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+### 3.0.1 - 2020-10-14
+
+* removed
+  * delete apib_path [#31](https://github.com/funbox/tomograph/issues/31)
+  * delete drafter_4_apib_path [#32](https://github.com/funbox/tomograph/issues/32)
+  * replace drafter_yaml_path with drafter_4_yaml_path [#33](https://github.com/funbox/tomograph/issues/33)
+  * delete crafter_apib_path [#34](https://github.com/funbox/tomograph/issues/34)
+  * delete multi_json [#35](https://github.com/funbox/tomograph/issues/35)
+
 ### 3.0.0 - 2020-08-27
 
 * features

data/README.md

@@ -31,15 +31,15 @@ $ gem install tomograph
 ```ruby
 require 'tomograph'
 
-tomogram = Tomograph::Tomogram.new(apib_path: '/path/to/doc.apib')
+tomogram = Tomograph::Tomogram.new(drafter_yaml_path: '/path/to/doc.yaml')
 ```
 
 ### Command line tool
 
-CLI allows you to convert files from API Blueprint or API Elements to JSON Schema.
+CLI allows you to convert files from API Elements to JSON Schema.
 
 ```bash
-tomograph doc.apib doc.json
+tomograph doc.yaml doc.json
 ```
 
 There is also support for documents pre-parsed by [drafter](https://github.com/apiaryio/drafter) versions 3 and 4, or `crafter`. 
@@ -236,10 +236,6 @@ Example output:
 
 You can specify API prefix and path to the spec using one of the possible formats:
 
-```ruby
-Tomograph::Tomogram.new(prefix: '/api/v2', apib_path: '/path/to/doc.apib')
-```
-
 ```ruby
 Tomograph::Tomogram.new(prefix: '/api/v2', drafter_yaml_path: '/path/to/doc.yaml')
 ```
@@ -248,19 +244,15 @@ Tomograph::Tomogram.new(prefix: '/api/v2', drafter_yaml_path: '/path/to/doc.yaml
 Tomograph::Tomogram.new(prefix: '/api/v2', tomogram_json_path: '/path/to/doc.json')
 ```
 
-### `apib_path`
-
-Path to API Blueprint documentation. There must be an installed [drafter](https://github.com/apiaryio/drafter) to parse it.
-
 ### `drafter_yaml_path`
 
 Path to API Blueprint documentation pre-parsed with `drafter` and saved to a YAML file.
 
 ### Drafter v4 & Crafter support
 
-If you are using a `drafter v4`, you should use `drafter_4_apib_path` and `drafter_4_yaml_path` respectively. 
+If you are using a `drafter v4`, you should use `drafter_yaml_path`. 
 
-In case when you want to use `сrafter`, then you should pass these params: `crafter_apib_path`, `crafter_yaml_path`. 
+In case when you want to use `сrafter`, then you should pass `crafter_yaml_path` respectively. 
 
 ### `tomogram_json_path`
 

data/exe/tomograph

@@ -13,10 +13,9 @@ include Methadone::CLILogging
 version Tomograph::VERSION
 description 'Converts API Blueprint to JSON Schema'
 on('-d DRAFTER_VERSION', '--drafter', 'Choose drafter version: crafter or 4. Default: use drafter v.4.')
-on('-f INPUT_FORMAT', '--format', 'Force input format: "apib" or "yaml". Default: detect by file extension.')
 on('--exclude-description', 'Exclude "description" keys.')
 on('--split', 'Split output into files by method.')
-arg :input, 'path/to/doc.apib (API Blueprint) or path/to/doc.yaml (API Elements)'
+arg :input, 'path/to/doc.yaml (API Elements)'
 arg :output, 'path/to/doc.json or path/to/dir if --split is used.'
 
 def prune!(obj, unwanted_key)
@@ -28,26 +27,6 @@ def prune!(obj, unwanted_key)
   end
 end
 
-def guess_format(opt_format, input)
-  case opt_format && opt_format.downcase
-  when 'apib'
-    :apib
-  when 'yaml'
-    :yaml
-  when nil
-    case File.extname(input).downcase
-    when '.apib'
-      :apib
-    when '.yaml', '.yml'
-      :yaml
-    else
-      fail 'Unsupported input file extension!'
-    end
-  else
-    fail 'Unsupported input format!'
-  end
-end
-
 def choose_drafter(opt_parser)
   case opt_parser
   when 'crafter'
@@ -75,31 +54,19 @@ def write_split_json(actions, output)
 end
 
 def write_json(obj, path)
-  json = MultiJson.dump(obj, pretty: true)
+  json = JSON.pretty_generate(obj)
   File.open(path, 'w') do |file|
     file.write(json)
   end
 end
 
 main do |input, output|
-  format = guess_format(options['format'], input)
   version = choose_drafter(options['drafter'])
-  format_key = case format
-               when :apib
-                 if version == :crafter
-                   :crafter_apib_path
-                 else
-                   :drafter_4_apib_path
-                 end
-               when :yaml
-                 if version == :crafter
-                   :crafter_yaml_path
-                 else
-                   :drafter_4_yaml_path
-                 end
-               else
-                 fail NotImplementedError
-               end
+  format_key = {
+                  crafter:   :crafter_yaml_path,
+                  drafter_4: :drafter_yaml_path
+               }[version]
+
   tomogram = Tomograph::Tomogram.new(format_key => input)
   actions = tomogram.to_a.map(&:to_hash)
 

data/lib/tomograph/api_blueprint/crafter/yaml.rb

@@ -6,13 +6,9 @@ module Tomograph
   module ApiBlueprint
     class Crafter
       class Yaml
-        def initialize(prefix, apib_path, drafter_yaml_path)
+        def initialize(prefix, drafter_yaml_path)
           @prefix = prefix
-          @documentation = if apib_path
-                             YAML.safe_load(`drafter #{apib_path}`)
-                           elsif drafter_yaml_path
-                             YAML.safe_load(File.read(drafter_yaml_path))
-                           end
+          @documentation = YAML.safe_load(File.read(drafter_yaml_path))
         end
 
         def groups

data/lib/tomograph/api_blueprint/crafter/yaml/action.rb

@@ -37,8 +37,8 @@ module Tomograph
             end
             return {} unless schema_node
 
-            MultiJson.load(schema_node['content'])
-          rescue MultiJson::ParseError => e
+            JSON.parse(schema_node['content'])
+          rescue JSON::ParserError => e
             puts "[Tomograph] Error while parsing #{e}. skipping..."
             {}
           end

data/lib/tomograph/api_blueprint/drafter_4/yaml.rb

@@ -6,13 +6,9 @@ module Tomograph
   module ApiBlueprint
     class Drafter4
       class Yaml
-        def initialize(prefix, apib_path, drafter_yaml_path)
+        def initialize(prefix, drafter_yaml_path)
           @prefix = prefix
-          @documentation = if apib_path
-                             YAML.safe_load(`drafter #{apib_path}`)
-                           elsif drafter_yaml_path
-                             YAML.safe_load(File.read(drafter_yaml_path))
-                           end
+          @documentation = YAML.safe_load(File.read(drafter_yaml_path))
         end
 
         def groups

data/lib/tomograph/api_blueprint/drafter_4/yaml/action.rb

@@ -37,8 +37,8 @@ module Tomograph
             end
             return {} unless schema_node
 
-            MultiJson.load(schema_node['content'])
-          rescue MultiJson::ParseError => e
+            JSON.parse(schema_node['content'])
+          rescue JSON::ParserError => e
             puts "[Tomograph] Error while parsing #{e}. skipping..."
             {}
           end

data/lib/tomograph/api_blueprint/json_schema.rb

@@ -5,7 +5,7 @@ module Tomograph
     class JsonSchema
       def initialize(prefix, json_schema_path)
         @prefix = prefix
-        @documentation = MultiJson.load(File.read(json_schema_path))
+        @documentation = JSON.parse(File.read(json_schema_path))
       end
 
       def to_tomogram

data/lib/tomograph/tomogram.rb

@@ -1,4 +1,4 @@
-require 'multi_json'
+require 'json'
 require 'tomograph/path'
 require 'tomograph/api_blueprint/json_schema'
 require 'tomograph/api_blueprint/drafter_4/yaml'
@@ -8,13 +8,13 @@ module Tomograph
   class Tomogram
     extend Gem::Deprecate
 
-    def initialize(prefix: '', apib_path: nil, drafter_yaml_path: nil, tomogram_json_path: nil, drafter_4_apib_path: nil, drafter_4_yaml_path: nil, crafter_apib_path: nil, crafter_yaml_path: nil)
+    def initialize(prefix: '', drafter_yaml_path: nil, tomogram_json_path: nil, crafter_yaml_path: nil)
       @documentation = if tomogram_json_path
                          Tomograph::ApiBlueprint::JsonSchema.new(prefix, tomogram_json_path)
-                       elsif crafter_yaml_path || crafter_apib_path
-                         Tomograph::ApiBlueprint::Crafter::Yaml.new(prefix, crafter_apib_path, crafter_yaml_path)
+                       elsif crafter_yaml_path
+                         Tomograph::ApiBlueprint::Crafter::Yaml.new(prefix, crafter_yaml_path)
                        else
-                         Tomograph::ApiBlueprint::Drafter4::Yaml.new(prefix, drafter_4_apib_path, drafter_4_yaml_path)
+                         Tomograph::ApiBlueprint::Drafter4::Yaml.new(prefix, drafter_yaml_path)
                        end
       @prefix = prefix
     end
@@ -29,7 +29,7 @@ module Tomograph
     deprecate :to_hash, 'to_a with method access', 2018, 8
 
     def to_json
-      MultiJson.dump(to_a.map(&:to_hash), pretty: true)
+      JSON.pretty_generate(to_a.map(&:to_hash))
     end
 
     def find_request(method:, path:)

data/lib/tomograph/version.rb

@@ -1,3 +1,3 @@
 module Tomograph
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.1'.freeze
 end

data/tomograph.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'methadone', '~> 2', '>= 2.0.2'
-  spec.add_runtime_dependency 'multi_json', '~> 1.14', '>= 1.14.1'
   spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.1'
   spec.add_development_dependency 'rake', '>= 13.0.1'
   spec.add_development_dependency 'rspec', '~> 3.9', '>= 3.9.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tomograph
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - d.efimov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: methadone
@@ -30,26 +30,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.14.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.14.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +132,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/gempush.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"

data/.github/workflows/gempush.yml

@@ -1,28 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: actions/setup-ruby@v1
-
-    - 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}}