swgr2rb 1.0.0

data/lib/scaffold_generator/feature_file_generator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'scaffold_generator_constants'
+
+module Swgr2rb
+  # FeatureFileGenerator generates an example feature file that uses
+  # scaffold's base steps to make a request to one of the endpoints
+  # described by generated endpoint object models.
+  class FeatureFileGenerator
+    def initialize(params)
+      @params = params
+      @filename = generate_filename
+    end
+
+    def generate_feature_file
+      File.open(@filename, 'w') do |file|
+        file.write(generate_lines.join("\n\n"))
+      end
+    end
+
+    private
+
+    def generate_filename
+      File.join(ScaffoldGeneratorConstants::HARNESS_DIR,
+                ScaffoldGeneratorConstants::FEATURES_DIR,
+                @params[:component],
+                ScaffoldGeneratorConstants::FEATURE_FILE_NAME)
+    end
+
+    def generate_lines
+      [generate_tags,
+       generate_feature_name,
+       generate_scenario_name,
+       generate_steps].flatten.compact
+    end
+
+    def generate_tags
+      ScaffoldGeneratorConstants::FF_TAGS.call(@params[:component])
+    end
+
+    def generate_feature_name
+      ScaffoldGeneratorConstants::FF_NAME
+    end
+
+    def generate_scenario_name
+      ScaffoldGeneratorConstants::FF_SCENARIO.call(example_endpoint)
+    end
+
+    def generate_steps
+      ScaffoldGeneratorConstants::FF_STEPS.call(example_endpoint)
+    end
+
+    def example_endpoint
+      all_endpoints = Dir.glob(File.join(@params[:target_dir],
+                                         @params[:component],
+                                         '*.rb'))
+      @example_endpoint ||= all_endpoints.min
+                                         .split('/').last.sub('.rb', '')
+                                         .split('_').map(&:capitalize).join(' ')
+    end
+  end
+end

data/lib/scaffold_generator/scaffold_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require_relative 'feature_file_generator'
+require_relative 'scaffold_generator_constants'
+require_relative '../prototypes/swgr2rb_error'
+
+module Swgr2rb
+  # ScaffoldGenerator generates a scaffold of a testing framework.
+  class ScaffoldGenerator
+    include ScaffoldGeneratorConstants
+
+    class << self
+      def generate_scaffold
+        create_harness_dir
+        copy_scaffold
+      end
+
+      def generate_example_feature_file(params)
+        create_features_component_dir(params)
+        FeatureFileGenerator.new(params).generate_feature_file
+      end
+
+      private
+
+      def create_harness_dir
+        if Dir.exist?(ScaffoldGeneratorConstants::HARNESS_DIR)
+          unless Dir.empty?(ScaffoldGeneratorConstants::HARNESS_DIR)
+            raise Swgr2rbError,
+                  'harness directory already exists and is not empty'
+          end
+        else
+          Dir.mkdir(ScaffoldGeneratorConstants::HARNESS_DIR)
+        end
+      end
+
+      def copy_scaffold
+        FileUtils.cp_r(File.join(File.dirname(__FILE__),
+                                 ScaffoldGeneratorConstants::PATH_TO_ASSETS,
+                                 '.'),
+                       ScaffoldGeneratorConstants::HARNESS_DIR)
+      end
+
+      def create_features_component_dir(params)
+        FileUtils.mkdir_p(File.join(ScaffoldGeneratorConstants::HARNESS_DIR,
+                                    ScaffoldGeneratorConstants::FEATURES_DIR,
+                                    params[:component]))
+      end
+    end
+  end
+end

data/lib/scaffold_generator/scaffold_generator_constants.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Swgr2rb
+  module ScaffoldGeneratorConstants
+    ENDPOINT_MODELS_DIR = 'endpoint_object_models/object_models'
+    FEATURE_FILE_NAME = 'ff001_example.feature'
+    FEATURES_DIR = 'features/component'
+    HARNESS_DIR = 'harness'
+    PATH_TO_ASSETS = '../../assets'
+
+    FF_TAGS = proc { |component| "@component_#{component}\n@ff001" }
+    FF_NAME = 'Feature: Example of JSON schema validation feature file'
+    FF_SCENARIO = proc { |endpoint| "  @ff001_tc01\n  Scenario: Send get request to #{endpoint} endpoint" }
+    FF_STEPS = proc do |endpoint|
+      "    When I send \"get\" request to \"#{endpoint}\"\n"\
+      "    Then the response schema for \"get\" request to \"#{endpoint}\" endpoint should be valid\n"
+    end
+  end
+end

data/lib/swgr2rb.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative 'cli/cli_options_parser'
+require_relative 'endpoint_class_generator/endpoint_classes_generator'
+require_relative 'scaffold_generator/scaffold_generator'
+require_relative 'scaffold_generator/scaffold_generator_constants'
+
+module Swgr2rb
+  # Main is being called from bin/swgr2rb.
+  class Main
+    def initialize(args)
+      @args = args
+    end
+
+    def execute
+      @url, @params = parse_cli_arguments
+      generate_scaffold if @params[:from_scratch]
+      generate_endpoint_object_models
+      generate_example_feature_file if @params[:from_scratch]
+      format_target_dir_with_rubocop
+    end
+
+    private
+
+    def parse_cli_arguments
+      CliOptionsParser.new.parse(@args)
+    end
+
+    def generate_scaffold
+      @params.merge!(target_dir: File.join(ScaffoldGeneratorConstants::HARNESS_DIR,
+                                           ScaffoldGeneratorConstants::ENDPOINT_MODELS_DIR),
+                     update_only: false)
+      puts 'Generating scaffold of the testing framework...'
+      ScaffoldGenerator.generate_scaffold
+    end
+
+    def generate_endpoint_object_models
+      puts "Generating endpoint classes in #{@params[:target_dir]}..."
+      EndpointClassesGenerator.new(@url, @params).generate_endpoint_classes
+    end
+
+    def generate_example_feature_file
+      puts 'Generating example feature file...'
+      ScaffoldGenerator.generate_example_feature_file(@params)
+    end
+
+    def format_target_dir_with_rubocop
+      puts 'Formatting generated endpoint object models with rubocop...'
+      `rubocop -x #{File.join(@params[:target_dir], @params[:component])}`
+      puts 'Done!'
+    end
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: swgr2rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrii Horodnytskyi
+- Margaryta Tyshkevych
+- Tetiana Pavlenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.78'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.78.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+description: 
+email: 
+executables:
+- swgr2rb
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- assets/Gemfile
+- assets/README.md
+- assets/configs/conductor_sender_configs.yaml
+- assets/endpoint_object_models/config_loaders/base_config.rb
+- assets/endpoint_object_models/config_loaders/conductor_config_loader.rb
+- assets/endpoint_object_models/json_validator/json_data_validator.rb
+- assets/endpoint_object_models/json_validator/json_schema_validator.rb
+- assets/endpoint_object_models/json_validator/json_validator.rb
+- assets/endpoint_object_models/loader.rb
+- assets/endpoint_object_models/object_models/base_endpoint_object_model.rb
+- assets/endpoint_object_models/object_models/base_endpoint_object_model_constants.rb
+- assets/endpoint_object_models/object_models/base_endpoint_object_model_methods.rb
+- assets/endpoint_object_models/prototypes/json_schema_data_types.rb
+- assets/endpoint_object_models/prototypes/request.rb
+- assets/features/step_definitions/base_steps.rb
+- assets/features/support/env.rb
+- assets/features/support/instance_variables.rb
+- assets/features/support/world.rb
+- assets/request_sender/conductor_sender/conductor_sender.rb
+- assets/request_sender/conductor_sender/response.rb
+- assets/request_sender/loader.rb
+- bin/swgr2rb
+- lib/cli/cli_options_parser.rb
+- lib/endpoint_class_config_generator/endpoint_class_config.rb
+- lib/endpoint_class_config_generator/endpoint_class_config_generator.rb
+- lib/endpoint_class_config_generator/json_paths_parser_methods.rb
+- lib/endpoint_class_config_generator/json_schema_definitions_parser_methods.rb
+- lib/endpoint_class_generator/endpoint_class_generator.rb
+- lib/endpoint_class_generator/endpoint_classes_generator.rb
+- lib/endpoint_class_generator/ruby_file_generator.rb
+- lib/endpoint_class_generator/ruby_file_generator_constants.rb
+- lib/endpoint_class_generator/schema_module_generator.rb
+- lib/json_fetcher/swagger_json_fetcher.rb
+- lib/prototypes/json_schema_data_types.rb
+- lib/prototypes/swgr2rb_error.rb
+- lib/request_sender/conductor_sender.rb
+- lib/request_sender/request.rb
+- lib/request_sender/response.rb
+- lib/scaffold_generator/feature_file_generator.rb
+- lib/scaffold_generator/scaffold_generator.rb
+- lib/scaffold_generator/scaffold_generator_constants.rb
+- lib/swgr2rb.rb
+homepage: https://github.com/Andry75/swgr2rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Andry75/swgr2rb
+  source_code_uri: https://github.com/Andry75/swgr2rb
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A gem that generates Ruby classes for JSON schema validation of API endpoints
+  based on their Swagger documentation.
+test_files: []