grape-starter 1.6.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0e8dbdcdf0bc8ec707834a2a55a2c36826c316d82a45f7f8c219e1ec4361f37
-  data.tar.gz: 21d235ca4a99f447965c8cf9a765bfaabca150f74a493ee332fb60aa137ce7fd
+  metadata.gz: 8d9f7ca7efc30bff48e6f765786b43a6cfd6d2c1c68d93063bbab89c4042bb5d
+  data.tar.gz: 1ecd2c9a8ce6eeebd94ed79a5e08bb81328c327a361750ca6ae1aff8578281ef
 SHA512:
-  metadata.gz: c54cbaf4ce481b619e621c733a6b16bd1582761a297e4380de381773c837d3a0894a472f6e45bf451ad702fa5ca8fe1d0abcf8c067f31844d5eb75532cfec7cf
-  data.tar.gz: df826306d1964ed1f2a58f87353cfb03b6f86bb084b0cb70e14639b04748d18986e5d971be420efb12919b82a28042cf8e1147e0c938eb5a52c0ef4ed44694ae
+  metadata.gz: baa02a26a233adc4f6edd6afe687356b99d29ef59071a170cf6183fb257be59254d7c2bb2e04bcf63bd67e8978e46c6a261cbb71319340ebeedacee3a8427f22
+  data.tar.gz: 43a5e2557d01d84bccc0cf91e5d7c52446b86572a2343d19ce2d905172b01b5c83bbf085d04d646e7cf6faf01b5466e0f47912323c32433981b693b5ff1bfad1

data/.github/workflows/pipeline.yml

@@ -1,7 +1,8 @@
 name: Pipeline
 on:
   pull_request:
-    types: [assigned, opened, edited, synchronize, reopened]
+    branches:
+      - 'master'
   push:
     branches:
       - 'master'
@@ -23,9 +24,11 @@ jobs:
   rspec:
     runs-on: ubuntu-latest
     needs: ['rubocop']
+    env:
+      RACK_ENV: test
     strategy:
       matrix:
-        ruby-version: ['3.0', '3.1', '3.2', head]
+        ruby-version: ['3.1', '3.2', head]
 
     steps:
     - uses: actions/checkout@v3

data/.gitignore

@@ -10,3 +10,7 @@ pkg/
 template/Gemfile.lock
 grape-starter.md
 tmp
+api/
+.vscode
+spec/fixtures/pmm.json
+spec/fixtures/nested.json

data/.rubocop.yml

@@ -12,6 +12,7 @@ AllCops:
     - '**/template/api/**'
     - grape-starter.gemspec
     - template/spec/spec-helper.rb
+    - api/**/*
   UseCache: true
   NewCops: enable
   TargetRubyVersion: 3.2
@@ -25,6 +26,9 @@ Layout/IndentationWidth:
 Layout/LineLength:
   Max: 120
 
+Lint/MissingSuper:
+  Enabled: false
+
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
@@ -32,13 +36,16 @@ Metrics/BlockLength:
 Metrics/AbcSize:
   Max: 20
 
+Metrics/ClassLength:
+  Max: 120
+
 Metrics/MethodLength:
   Max: 20
 
 Naming/AccessorMethodName:
   Exclude:
-    - 'lib/starter/templates/files.rb'
-    - 'lib/starter/templates/endpoints.rb'
+    - 'lib/starter/builder/files.rb'
+    - 'lib/starter/builder/endpoints.rb'
 
 Style/AsciiComments:
   Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,38 @@
 ### NEXT
 
-- your contributions
+- contributions
+
+### v2.0.0 / 2023-10-21 Imports OApi specs
+
+- [(#38)](https://github.com/LeFnord/grape-starter/pull/38) Handles nested body [LeFnord](https://github.com/LeFnord)
+- [(#38)](https://github.com/LeFnord/grape-starter/pull/38) Handle parameters from request body [LeFnord](https://github.com/LeFnord)
+- [(#37)](https://github.com/LeFnord/grape-starter/pull/37) Ignores possible version segments in path [LeFnord](https://github.com/LeFnord)
+- Sets min ruby to 3.1 [LeFnord](https://github.com/LeFnord)
+- [(#36)](https://github.com/LeFnord/grape-starter/pull/36) Handle Parameters [LeFnord](https://github.com/LeFnord)
+- Avoids duplicated mount points. [LeFnord](https://github.com/LeFnord)
+- Small code smells [LeFnord](https://github.com/LeFnord)
+- Sets next version to 2.0.0 [LeFnord](https://github.com/LeFnord)
+- [(#31)](https://github.com/LeFnord/grape-starter/pull/31) Import OAPI spec [LeFnord](https://github.com/LeFnord)
+- Fix for Dockerfile smell DL3020 [#35](https://github.com/LeFnord/grape-starter/pull/35) [Giovanni Rosa](https://github.com/grosa1)
+
+### v1.6.2 / 2023-03-12
+
+- [(#34)](https://github.com/LeFnord/grape-starter/pull/34) Makes Names a class [LeFnord](https://github.com/LeFnord)
+- Re-organises libe files. [LeFnord](https://github.com/LeFnord)
+- Minor clean up. [LeFnord](https://github.com/LeFnord)
+
+### v1.6.1 / 2023-02-17 -> yanked
+
+### v1.6.0 / 2023-02-13
+
+- [(#33)](https://github.com/LeFnord/grape-starter/pull/33) Replaces Thin by Puma [LeFnord](https://github.com/LeFnord)
+- Minor lint fix. [LeFnord](https://github.com/LeFnord)
+- [(#32)](https://github.com/LeFnord/grape-starter/pull/32) Uses Zeitwerk for loading [LeFnord](https://github.com/LeFnord)
+
+### v1.5.2 / 2023-02-11
+
+- Upgrades action. [LeFnord](https://github.com/LeFnord)
+- Uses ruby 3.2 [LeFnord](https://github.com/LeFnord)
 
 ### v1.5.1 / 2021-12-28
 
@@ -47,7 +79,7 @@
 - Changes ruby.yml to use 2.7 [LeFnord](https://github.com/LeFnord)
 - Prepare release 1.2.4 [LeFnord](https://github.com/LeFnord)
 - Respects froozen string stuff. [LeFnord](https://github.com/LeFnord)
-- Updates Ruby and deps. (#23) [LeFnord](https://github.com/LeFnord)
+- [(#23)](https://github.com/LeFnord/grape-starter/pull/23) Updates Ruby and deps [LeFnord](https://github.com/LeFnord)
 - Create ruby.yml [LeFnord](https://github.com/LeFnord)
 
 - Fixes gems for sequel. [LeFnord](https://github.com/LeFnord)
@@ -55,8 +87,8 @@
 
 ### v1.2.3 / 2019-12-15
 
-- Removes require pry. [LeFnord](LeFnord) closes [!21](https://github.com/LeFnord/grape-starter/issues/21)
-- [#22](https://github.com/LeFnord/grape-starter/pull/22) - accomodate activerecord 6.0 (#22) [Ignacio Carrera](https://github.com/nachokb)
+- Removes require pry. [LeFnord](https://github.com/LeFnord) closes [!21](https://github.com/LeFnord/grape-starter/issues/21)
+- [#22](https://github.com/LeFnord/grape-starter/pull/22) - accomodate activerecord 6.0 [#22](https://github.com/LeFnord/grape-starter/pull/22) [Ignacio Carrera](https://github.com/nachokb)
 
 ### v1.2.2 / 2019-02-28
 

data/README.md

@@ -1,6 +1,17 @@
 [![Pipeline](https://github.com/LeFnord/grape-starter/actions/workflows/pipeline.yml/badge.svg?branch=master)](https://github.com/LeFnord/grape-starter/actions/workflows/pipeline.yml)
 [![Gem Version](https://badge.fury.io/rb/grape-starter.svg)](https://badge.fury.io/rb/grape-starter)
 
+- [Why the next one?](#why-the-next-one)
+- [Usage](#usage)
+  - [Install it](#install-it)
+  - [Create a new project](#create-a-new-project)
+  - [Add resources](#add-resources)
+  - [Import OAPI spec \[WIP\]](#import-oapi-spec-wip)
+  - [Remove a resource](#remove-a-resource)
+- [Contributing](#contributing)
+  - [Adding a new ORM template](#adding-a-new-orm-template)
+- [License](#license)
+
 
 # Grape Starter
 
@@ -9,20 +20,24 @@ Is a tool to help you to build up a skeleton for a [Grape](http://github.com/rub
 
 ![ReDoc demo](doc/re-doc.png)
 
+
+
+
 ## Why the next one?
 
 - build up a playground for your ideas, prototypes, testing behaviour … whatever
 - ~~no assumtions about~~ you can choose, if you want to use a backend/ORM, ergo no restrictions, only a pure grape/rack skeleton with a nice documentation
 
+
 ## Usage
 
-#### Install it
+### Install it
 ```
 $ gem install grape-starter
 ```
 
 
-#### Create a new project
+### Create a new project
 ```
 $ grape-starter new awesome_api
 ```
@@ -32,9 +47,7 @@ with following options:
 -p foobar, --prefix=foobar # sets the prefix of the API (default: none)
 -o sequel, --orm=sequel    # create files for the specified ORM, available: sequel, activerecord (ar) (default: none)
 ```
-
 This command creates a folder named `awesome_api` containing the skeleton. With following structure:
-
 ```
 ├── <Standards>
 ├── api
@@ -88,7 +101,7 @@ the documentation of it under: [http://localhost:9292/doc](http://localhost:9292
 More could be found in [README](template/README.md).
 
 
-#### Add resources
+### Add resources
 ```
 $ grape-starter add foo [http methods]
 ```
@@ -117,7 +130,24 @@ If the `orm` switch `true`, the lib class would be created as child class of a s
 so for example for Sequel, it would be wirtten: `Foo < Sequel::Model` instead of `Foo`, hereby the using ORM would be taken from the configuration, which was stored by project creation.
 
 
-#### Remove a resource
+### Import OAPI spec [WIP]
+```
+$ grape-starter import path/to/spec
+```
+to create an API based on the spec.
+
+##### To Dos:
+
+- [x] read spec an create per namespace a file with defined endpoint
+- [x] read path parameter
+  - [x] requires it in param block
+  - [x] specify it
+- [x] handle query parameter -> check it
+- [x] handle body parameter -> check it
+- [ ] add description block
+
+
+### Remove a resource
 ```
 $ grape-starter rm foo
 ```
@@ -128,6 +158,7 @@ to remove previous generated files for a resource.
 
 Any contributions are welcome on GitHub at https://github.com/LeFnord/grape-starter.
 
+
 ### Adding a new ORM template
 
 To add an new ORM, it needs following steps:
@@ -168,6 +199,7 @@ To add an new ORM, it needs following steps:
 2. An additional switch in the [`Starter::Orms.build`](https://github.com/LeFnord/grape-starter/blob/ef45133e6d2254efee06ae4f17ede2fc5c06bebb/lib/starter/builder/orms.rb#L7-L18) and [`Starter::Names.lib_klass_name`](https://github.com/LeFnord/grape-starter/blob/ef45133e6d2254efee06ae4f17ede2fc5c06bebb/lib/starter/builder/names.rb#L13-L24) methods to choose the right template.
 3. An entry in the description of the [`new` command](https://github.com/LeFnord/grape-starter/blob/fa62c8a2ff72f984144b2336859d3e0b397398bd/bin/grape-starter#L28), when it would be called with `-h`
 
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](LICENSE).

data/bin/grape-starter

@@ -73,7 +73,7 @@ command :add do |c|
       builder_options = global_options.merge(set: set).merge(options)
       created_files = Starter::Build.add!(resource, builder_options)
 
-      `bundle exec rubocop -a #{created_files.join(' ')}`
+      `bundle exec rubocop --only Layout -a #{created_files.join(' ')}`
       $stdout.puts "added resource: #{resource}"
     rescue => e
       exit_now! e
@@ -97,6 +97,23 @@ command :rm do |c|
   end
 end
 
+desc 'Adds resources from given OAPI spec'
+long_desc 'Import YAML or JSON OAPI specification given by path argument'
+arg_name 'path'
+command :import do |c|
+  c.action do |_global_options, _options, args|
+    path = args.first
+    exit_now! 'no path given' if path.blank?
+    exit_now! "file under #{path} not exists" unless File.exist?(path)
+
+    created_files = Starter::Import.do_it!(path)
+
+    `bundle exec rubocop --only Layout -a #{created_files.join(' ')}`
+  rescue => e
+    exit_now! e
+  end
+end
+
 
 pre do |_global, _command, _options, _args|
   # Pre logic here

data/grape-starter.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.7'
+  spec.required_ruby_version = '>= 3.1'
 
   spec.add_dependency 'gli', '~> 2.20'
   spec.add_dependency 'activesupport', '>= 6', '< 8'

data/lib/starter/build.rb

@@ -2,9 +2,9 @@
 
 module Starter
   class Build
-    extend Builder::BaseFile
-    extend Templates::Files
-    extend Templates::Endpoints
+    extend Shared::BaseFile
+    extend Builder::Files
+    extend Builder::Endpoints
 
     class << self
       attr_reader :prefix, :resource, :entity,
@@ -28,7 +28,7 @@ module Starter
         @resource = name
         @destination = destination
         @prefix = options[:p] # can be nil
-        @naming = Starter::Builder::Names.new(@resource)
+        @naming = Starter::Names.new(@resource)
 
         FileUtils.copy_entry source, destination
 
@@ -64,7 +64,7 @@ module Starter
         @force = options[:force]
         @entity = options[:entity]
         @orm = options[:orm]
-        @naming = Starter::Builder::Names.new(@resource)
+        @naming = Starter::Names.new(@resource)
 
         Orms.add_migration(@naming.klass_name, resource.downcase) if @orm
         save_resource
@@ -115,7 +115,7 @@ module Starter
       #
       # creates a new file in lib folder as namespace, includind the version
       def add_namespace_with_version
-        new_lib = File.join(destination, 'lib', @naming.base_file_name)
+        new_lib = File.join(destination, 'lib', @naming.resource_file)
         FileOps.write_file(new_lib, base_namespace_file.strip_heredoc)
       end
 

data/lib/starter/builder/activerecord.rb

@@ -9,7 +9,7 @@ module Starter
         'ActiveRecord::Base'
       end
 
-      def initializer
+      def initializer # rubocop:disable Metrics/MethodLength
         <<-FILE.strip_heredoc
         # frozen_string_literal: true
 

data/lib/starter/{templates → builder}/endpoints.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Starter
-  module Templates
+  module Builder
     # defining the endpoints -> http methods of a resource
     module Endpoints
       def crud

data/lib/starter/{templates → builder}/files.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Starter
-  module Templates
+  module Builder
     module Files
       # API template for resource
       def api_file

data/lib/starter/builder/sequel.rb

@@ -37,7 +37,7 @@ module Starter
         FILE
       end
 
-      def rakefile
+      def rakefile # rubocop:disable Metrics/MethodLength
         <<-FILE.strip_heredoc
         # Sequel migration tasks
         namespace :db do

data/lib/starter/import.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'yaml'
+
+module Starter
+  class Import
+    extend Shared::BaseFile
+
+    class << self
+      def do_it!(path)
+        spec = load_spec(path)
+        create_files_from(spec)
+      end
+
+      def load_spec(path)
+        return nil if path.blank?
+
+        spec = case File.extname(path)[1..]
+               when 'yaml', 'yml'
+                 YAML.load_file(path)
+               when 'json'
+                 JSON.load_file(path)
+               end
+
+        Importer::Specification.new(spec:)
+      end
+
+      def create_files_from(spec)
+        spec.namespaces.each_with_object([]) do |(name_of, paths), memo|
+          @naming = Starter::Names.new(name_of)
+
+          #   1. build content for file
+          namespace = Starter::Importer::Namespace.new(
+            naming: @naming,
+            paths: paths,
+            components: spec.components
+          )
+
+          break if ENV['RACK_ENV'] == 'test'
+
+          #   2. create endpoint file
+          FileOps.write_file(@naming.api_file_name, namespace.content)
+          memo << @naming.api_file_name
+
+          #   3. add mountpoint
+          add_mount_point
+        end
+      end
+    end
+  end
+end

data/lib/starter/importer/namespace.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: false
+
+module Starter
+  module Importer
+    class Namespace
+      attr_accessor :naming, :paths, :components
+
+      def initialize(naming:, paths:, components:)
+        @naming = naming
+        @paths = paths
+        @components = components
+      end
+
+      def content
+        <<-FILE.strip_heredoc
+        # frozen_string_literal: true
+
+        module Api
+          module Endpoints
+            class #{@naming.klass_name} < Grape::API
+              namespace #{namespace} do
+                #{endpoints.join("\n")}
+              end
+            end
+          end
+        end
+        FILE
+      end
+
+      private
+
+      def namespace
+        @namespace ||= naming.version_klass ? "'#{naming.origin}'" : ":#{naming.resource.downcase}"
+      end
+
+      def endpoints
+        paths.map do |path, verbs|
+          segment = prepare_route(path)
+          verbs.keys.each_with_object([]) do |verb, memo|
+            next unless allowed_verbs.include?(verb)
+
+            if (parameters = verbs[verb]['parameters'].presence)
+              params_block = params_block(parameters)
+              memo << params_block
+            end
+            memo << "#{verb} '#{segment}' do\n  # your code comes here\nend\n"
+          end
+        end
+      end
+
+      def prepare_route(path)
+        params = path.scan(/\{(\w+)\}/)
+        if params.empty?
+          path
+        else
+          path.gsub('{', ':').gsub('}', '')
+        end
+      end
+
+      def params_block(params)
+        params_block = "params do\n"
+        params.each_value do |param|
+          params_block << "  #{param.to_s}\n" # rubocop:disable Lint/RedundantStringCoercion
+        end
+        params_block << 'end'
+      end
+
+      def allowed_verbs
+        %w[get put post delete]
+      end
+    end
+  end
+end

data/lib/starter/importer/nested_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: false
+
+module Starter
+  module Importer
+    class NestedParams < Parameter
+      def initialize(name:, definition:)
+        @kind = :body
+        @nested = []
+        @name = name
+        @definition = definition
+      end
+    end
+  end
+end

data/lib/starter/importer/parameter.rb

@@ -0,0 +1,180 @@
+# rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ClassLength
+# frozen_string_literal: false
+
+module Starter
+  module Importer
+    class Parameter
+      class Error < StandardError; end
+
+      attr_accessor :kind, :name, :definition, :nested
+
+      def initialize(definition:, components: {})
+        @nested = []
+        @kind = validate_parameters(definition:, components:)
+        prepare_attributes(definition:, components:)
+      end
+
+      def to_s
+        return serialized_object if nested?
+
+        serialized
+      end
+
+      def nested?
+        @nested.present?
+      end
+
+      # initialize helper
+      #
+      def validate_parameters(definition:, components:)
+        return :direct if definition.key?('name')
+        return :ref if definition.key?('$ref') && components.key?('parameters')
+        return :body if definition.key?('content')
+
+        raise Error, 'no valid combination given'
+      end
+
+      def prepare_attributes(definition:, components:) # rubocop:disable Metrics/MethodLength
+        case kind
+        when :direct
+          @name = definition['name']
+          @definition = definition.except('name')
+        when :ref
+          found = components.dig(*definition['$ref'].split('/')[2..])
+          @name = found['name']
+          @definition = found.except('name')
+
+          if (value = @definition.dig('schema', '$ref').presence)
+            @definition['schema'] = components.dig(*value.split('/')[2..])
+          end
+        when :body
+          definition['in'] = 'body'
+          schema = definition['content'] ? definition['content'].values.first['schema'] : definition
+          if schema.key?('$ref')
+            path = schema['$ref'].split('/')[2..]
+
+            @name, @definition = handle_body(definition:, properties: components.dig(*path))
+            @name ||= path.last
+          else
+            @name, @definition = handle_body(definition:, properties: schema)
+            @name = nested.map(&:name).join('_') if @name.nil? && nested?
+          end
+        end
+      end
+
+      def handle_body(definition:, properties:) # rubocop:disable Metrics/MethodLength
+        if simple_object?(properties:)
+          name = properties['properties'].keys.first
+          type = properties.dig('properties', name, 'type') || 'array'
+          subtype = properties.dig('properties', name, 'items', 'type')
+          definition['type'] = subtype.nil? ? type : "#{type}[#{subtype}]"
+
+          properties.dig('properties', name).except('type').each { |k, v| definition[k] = v }
+          definition['type'] = 'file' if definition['format'].presence == 'binary'
+
+          [name, definition]
+        elsif object?(definition:) # a nested object -> JSON
+          definition['type'] = properties['type'].presence || 'JSON'
+          return [nil, definition] if properties.nil? || properties['properties'].nil?
+
+          properties['properties'].each do |nested_name, nested_definition|
+            nested_definition['required'] = required?(properties, nested_name)
+            nested = NestedParams.new(name: nested_name, definition: nested_definition)
+            nested.prepare_attributes(definition: nested.definition, components: {})
+            nested.name = nested_name
+            @nested << nested
+          end
+
+          [self.name, definition]
+        else # others
+          [nil, properties ? definition.merge(properties) : definition]
+        end
+      end
+
+      # handle_body helper, check/find/define types
+      #
+      def object?(definition:)
+        definition['type'] == 'object' ||
+          definition['content']&.keys&.first&.include?('application/json')
+      end
+
+      def simple_object?(properties:)
+        list_of_object?(properties:) &&
+          properties['properties'].length == 1
+      end
+
+      def list_of_object?(properties:)
+        properties&.key?('properties')
+      end
+
+      def required?(property, name)
+        return false unless property['required']
+
+        property['required'].is_a?(Array) ? property['required'].include?(name) : property['required']
+      end
+
+      # to_s helper
+      #
+      def serialized_object
+        definition.tap do |foo|
+          foo['type'] = foo['type'] == 'object' ? 'JSON' : foo['type']
+        end
+
+        parent = NestedParams.new(name: name, definition: definition)
+        entry = "#{parent} do\n"
+        nested.each { |n| entry << "    #{n}\n" }
+        entry << '  end'
+        if entry.include?("format: 'binary', type: 'File'")
+          entry.sub!('type: JSON', 'type: Hash')
+          entry.sub!(", documentation: { in: 'body' }", '')
+          entry.gsub!(", in: 'body'", '')
+        end
+
+        entry
+      end
+
+      def serialized
+        type = definition['type'] || definition['schema']['type']
+        type.scan(/\w+/).each { |x| type.match?('JSON') ? type : type.sub!(x, x.capitalize) }
+
+        if type == 'Array' && definition.key?('items')
+          sub = definition.dig('items', 'type').to_s.capitalize
+          type = "#{type}[#{sub}]"
+        end
+
+        entry = definition['required'] ? 'requires' : 'optional'
+        entry << " :#{name}"
+        entry << ", type: #{type}"
+        doc = documentation
+        entry << ", #{doc}" if doc
+
+        entry
+      end
+
+      def documentation
+        @documentation ||= begin
+          tmp = {}
+          tmp['desc'] = definition['description'] if definition.key?('description')
+          if definition.key?('in') && !(definition['type'] == 'File' && definition['format'] == 'binary')
+            tmp['in'] = definition['in']
+          end
+
+          if definition.key?('format')
+            tmp['format'] = definition['format']
+            tmp['type'] = 'File' if definition['format'] == 'binary'
+          end
+
+          documentation = 'documentation:'
+          documentation.tap do |doc|
+            doc << ' { '
+            content = tmp.map { |k, v| "#{k}: '#{v}'" }
+            doc << content.join(', ')
+            doc << ' }'
+          end
+        end
+      end
+    end
+  end
+end
+
+# rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/ClassLength

data/lib/starter/importer/specification.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Starter
+  module Importer
+    class Specification
+      class Error < StandardError; end
+
+      attr_accessor :openapi, :info,
+                    :paths, :components, :webhooks
+
+      def initialize(spec:)
+        # mandatory
+        @openapi = spec.fetch('openapi')
+        @info = spec.fetch('info')
+
+        # in contrast to the spec, paths are required
+        @paths = spec.fetch('paths').except('/').sort.to_h
+
+        # optional -> not used atm
+        @components = spec.fetch('components', false)
+        @webhooks = spec.fetch('webhooks', false)
+      end
+
+      def namespaces
+        validate_paths
+
+        @namespaces ||= paths.keys.each_with_object({}) do |path, memo|
+          namespace, rest_path = segmentize(path)
+
+          memo[namespace] ||= {}
+          memo[namespace][rest_path] = prepare_verbs(paths[path])
+        end
+      end
+
+      private
+
+      def validate_paths
+        raise Error, '`paths` empty … nothings to do' if paths.empty?
+        raise Error, 'only template given' if paths.keys.one? && paths.keys.first.match?(%r{/\{\w*\}})
+      end
+
+      def segmentize(path)
+        segments = path.split('/').delete_if(&:empty?)
+        ignore = segments.take_while { |x| x =~ /(v)*(\.\d)+/ || x =~ /(v\d)+/ || x == 'api' }
+        rest = segments - ignore
+
+        [rest.shift, rest.empty? ? '/' : "/#{rest.join('/')}"]
+      end
+
+      def prepare_verbs(spec) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        path_params = nil
+        spec.each_with_object({}) do |(verb, content), memo|
+          if verb == 'parameters'
+            path_params = content
+            next
+          end
+
+          memo[verb] = content
+          next unless content.key?('parameters') || content.key?('requestBody') || path_params
+
+          parameters = ((content['parameters'] || path_params || []) + [content['requestBody']]).compact
+
+          memo[verb]['parameters'] = parameters.each_with_object({}) do |definition, para|
+            parameter = Parameter.new(definition:, components:)
+            para[parameter.name] = parameter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/starter/names.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Starter
+  class Names
+    attr_accessor :resource, :origin, :version_klass
+
+    def initialize(resource)
+      @version_klass = false
+      @origin = resource
+      @resource = if resource.match?(/([[:digit:]][[:punct:]])+/)
+                    @version_klass = true
+                    digit = resource.scan(/\d/).first.to_i - 1
+                    letter = ('a'..'z').to_a[digit]
+                    "#{letter}_#{resource.tr('.', '_')}"
+                  else
+                    resource
+                  end
+    end
+
+    def klass_name
+      return @resource.classify if version_klass
+
+      for_klass = @resource.tr('-', '/')
+      singular? ? for_klass.classify : for_klass.classify.pluralize
+    end
+
+    # rubocop:disable Style/StringConcatenation
+    def resource_file
+      @resource.tr('/', '-').downcase + '.rb'
+    end
+    # rubocop:enable Style/StringConcatenation
+
+    def resource_spec
+      resource_file.gsub(/.rb$/, '_spec.rb')
+    end
+
+    # entry in api/base.rb
+    def mount_point
+      "    mount Endpoints::#{klass_name}\n"
+    end
+
+    # endpoints file
+    def api_file_name
+      File.join(Dir.getwd, 'api', 'endpoints', resource_file)
+    end
+
+    # entities file
+    def entity_file_name
+      File.join(Dir.getwd, 'api', 'entities', resource_file)
+    end
+
+    # lib file
+    def lib_file_name
+      File.join(Dir.getwd, 'lib', 'models', resource_file)
+    end
+
+    # model entry in lib file
+    def lib_klass_name
+      return klass_name unless @orm
+
+      case Starter::Config.read[:orm]
+      when 'sequel'
+        extend(Starter::Builder::Sequel)
+        "#{klass_name} < #{model_klass}"
+      when 'activerecord', 'ar'
+        extend(Starter::Builder::ActiveRecord)
+        "#{klass_name} < #{model_klass}"
+      else
+        klass_name
+      end
+    end
+
+    # resource spec
+    def api_spec_name
+      File.join(Dir.getwd, 'spec', 'requests', resource_spec)
+    end
+
+    # lib spec
+    def lib_spec_name
+      File.join(Dir.getwd, 'spec', 'lib', 'models', resource_spec)
+    end
+
+    def singular?
+      @resource.singularize.inspect == @resource.inspect
+    end
+  end
+end

data/lib/starter/{builder → shared}/base_file.rb

@@ -1,23 +1,25 @@
 # frozen_string_literal: true
 
 module Starter
-  module Builder
+  module Shared
     module BaseFile
       # add it in api base
       def add_mount_point
-        FileOps.call!(@naming.api_base_file_name) { |content| add_to_base(content) }
+        FileOps.call!(base_file_path) { |content| add_to_base(content) }
       end
 
       # adding mount point to base class
       def add_to_base(file)
-        occurence = file.scan(/(\s+mount\s.*?\n)/).last.first
+        occurence = file.scan(/(\s+mount\s.*?\n)/).map(&:first).join
+        return if occurence.include?(@naming.mount_point.strip)
+
         replacement = occurence + @naming.mount_point
         file.sub!(occurence, replacement)
       end
 
       # removes in api base
       def remove_mount_point
-        FileOps.call!(@naming.api_base_file_name) { |content| remove_from_base(content) }
+        FileOps.call!(base_file_path) { |content| remove_from_base(content) }
       end
 
       # removes mount point from base class
@@ -39,8 +41,11 @@ module Starter
 
       # get api base file as string
       def base_file
-        file = File.join(Dir.getwd, 'api', 'base.rb')
-        FileOps.read_file(file)
+        FileOps.read_file(base_file_path)
+      end
+
+      def base_file_path
+        File.join(Dir.getwd, 'api', 'base.rb')
       end
     end
   end

data/lib/starter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Starter
-  VERSION = '1.6.2'
+  VERSION = '2.0.0'
 end

data/lib/starter.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require 'awesome_print'
-require 'active_support'
-require 'active_support/core_ext/string'
+require 'active_support/all'
 require 'zeitwerk'
 
 loader = Zeitwerk::Loader.for_gem

data/template/.rubocop.yml

@@ -25,3 +25,6 @@ Style/AsciiComments:
 
 Style/Documentation:
   Enabled: false
+
+Style/RedundantArrayConstructor:
+  Enabled: false

data/template/Dockerfile

@@ -4,7 +4,7 @@ FROM ruby:3
 ENV NODE_ENV='development'
 ENV RACK_ENV='development'
 
-ADD . /dummy
+COPY . /dummy
 WORKDIR /dummy
 
 COPY Gemfile Gemfile.lock ./

data/template/Gemfile

@@ -5,7 +5,7 @@ source 'http://rubygems.org'
 # Server stuff
 gem 'puma'
 
-gem 'rack'
+gem 'rack', '< 3.0'
 gem 'rack-cors'
 
 # API stuff

data/template/config/boot.rb

@@ -2,7 +2,7 @@
 
 require 'rubygems'
 require 'bundler/setup'
-require 'active_support'
+require 'active_support/all'
 
 Bundler.require :default, ENV.fetch('RACK_ENV', nil)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 2.0.0
 platform: ruby
 authors:
 - LeFnord
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-12 00:00:00.000000000 Z
+date: 2023-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -112,16 +112,21 @@ files:
 - lib/starter.rb
 - lib/starter/build.rb
 - lib/starter/builder/activerecord.rb
-- lib/starter/builder/base_file.rb
-- lib/starter/builder/names.rb
+- lib/starter/builder/endpoints.rb
+- lib/starter/builder/files.rb
 - lib/starter/builder/sequel.rb
 - lib/starter/config.rb
 - lib/starter/file_ops.rb
+- lib/starter/import.rb
+- lib/starter/importer/namespace.rb
+- lib/starter/importer/nested_params.rb
+- lib/starter/importer/parameter.rb
+- lib/starter/importer/specification.rb
+- lib/starter/names.rb
 - lib/starter/orms.rb
 - lib/starter/rake/grape_tasks.rb
 - lib/starter/rspec/request_specs.rb
-- lib/starter/templates/endpoints.rb
-- lib/starter/templates/files.rb
+- lib/starter/shared/base_file.rb
 - lib/starter/version.rb
 - template/.gitignore
 - template/.rubocop.yml
@@ -164,14 +169,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Creates a Grape Rack skeleton

data/lib/starter/builder/names.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-module Starter
-  module Builder
-    class Names
-      def initialize(resource)
-        @resource = resource
-      end
-
-      def klass_name
-        for_klass = prepare_klass
-        singular? ? for_klass.classify : for_klass.classify.pluralize
-      end
-
-      # rubocop:disable Style/StringConcatenation
-      def base_file_name
-        @resource.tr('/', '-').downcase + '.rb'
-      end
-      # rubocop:enable Style/StringConcatenation
-
-      def api_base_file_name
-        File.join(Dir.getwd, 'api', 'base.rb')
-      end
-
-      def base_spec_name
-        base_file_name.gsub(/.rb$/, '_spec.rb')
-      end
-
-      # entry in api/base.rb
-      def mount_point
-        "    mount Endpoints::#{klass_name}\n"
-      end
-
-      # endpoints file
-      def api_file_name
-        File.join(Dir.getwd, 'api', 'endpoints', base_file_name)
-      end
-
-      # entities file
-      def entity_file_name
-        File.join(Dir.getwd, 'api', 'entities', base_file_name)
-      end
-
-      # lib file
-      def lib_file_name
-        File.join(Dir.getwd, 'lib', 'models', base_file_name)
-      end
-
-      # model entry in lib file
-      def lib_klass_name
-        return klass_name unless @orm
-
-        case Starter::Config.read[:orm]
-        when 'sequel'
-          extend(Starter::Builder::Sequel)
-          "#{klass_name} < #{model_klass}"
-        when 'activerecord', 'ar'
-          extend(Starter::Builder::ActiveRecord)
-          "#{klass_name} < #{model_klass}"
-        else
-          klass_name
-        end
-      end
-
-      # resource spec
-      def api_spec_name
-        File.join(Dir.getwd, 'spec', 'requests', base_spec_name)
-      end
-
-      # lib spec
-      def lib_spec_name
-        File.join(Dir.getwd, 'spec', 'lib', 'models', base_spec_name)
-      end
-
-      def singular?
-        @resource.singularize.inspect == @resource.inspect
-      end
-
-      private
-
-      def prepare_klass
-        @resource.tr('-', '/')
-      end
-    end
-  end
-end