railspp 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12d4c74ed0ac4e2d6342bcdd8319d96e078c162a76aa422de2fab510e1bce423
+  data.tar.gz: c121223b43c6c248fa8066d8311a40526979729282f546764bbb36f51d9d03cd
+SHA512:
+  metadata.gz: a99075325a3cbeaa265eca334eb94b7827c572b129d5f1e49de13034535e5af35f450f795b0369a31924dfa743d7e343eaa1de093dae8706db44ae5f068fe5e3
+  data.tar.gz: beb144dee9e25d7876ca01f66a9e966f304b27de13f1de50f935d44c51ca3ab04af085983d8c19f284b000479f9652a1ad90ace189c8dd7ed89f86a93d9f2b81

data/README.md

@@ -0,0 +1,168 @@
+# Rails++
+
+Autogenerate your CRUD operations with Swagger like API documentation
+
+## Requirements
+
+Rails version >= 5
+Ruby version >= 2.5
+
+## Installation
+
+In your gem file
+
+```ruby
+gem 'railspp'
+```
+
+In your terminal
+
+```bash
+gem isntall railspp
+```
+
+## CLI Commands
+
+Your command CLI command bin path is `railspp`
+
+<!-- ![CLI DOCUMENTATION](./docs/command_list.png) -->
+
+## Getting Started
+
+For existing project use Git and keep all the
+changes from the initialize method while keeping your changes as well.
+
+Example:
+Create a new project and then initialize.
+
+```bash
+rails new (project-name)
+cd (project-name)
+#  Install dependency in gem file and globally
+railspp init
+```
+
+Run the initialize command to get started:
+
+```bash
+railspp init
+```
+
+Run the model command to generate a migration, model, and completed controller:
+
+This controller is overwritable when you declare the same method name in it's controller class.
+
+```bash
+railspp model (model-name)
+```
+
+Update your migration and model file. Then declare your routes with `resources`.
+The controller has all api resources completed by default. These will fail if your migration and
+model are not completed. And your routes are not defined.
+
+Steps to do after:
+
+- Update model file
+- Update migration file
+- Define your routes with resources
+
+Run the make_test command to make unit tests:
+
+```bash
+railspp make_test (resource-route-name)
+```
+
+After your tests are completed. Update your update and create request bodies
+based on the controller's `params.permit`. Add the keys available to your request body.
+If you have special headers like "Authorization" add those to the public
+variable `@headers` in that file.
+
+Steps to do after:
+
+- Update request body based on the controller's permitted keys
+- Update your headers for all the requests
+
+```bash
+
+```
+
+## API Documentation
+
+There are Swagger-like API Documentation that requires no configuration.
+This was created on your initialize command. This docs with regenerate the javascript
+on API route changes.
+
+The API documentation lives on your web route '/documentation'
+Run the server and listen to url:
+
+`http://localhost:3000/documentation`
+
+For more information on the API docs check out the details here: [Autogenerated API Documentation Docs](./docs/API_DOCUMENTATION.md)
+
+## Gloabl Controller
+
+All of your CRUD operations were created in the GlobalController.
+The GlobalController gets your model based on the class name of the controller.
+Do not change the class name of the generated controller.
+
+All methods are overwritable but have the functionality complete by default.
+Restrict the routes you want accessible through the apiResource declaration.
+Update the tests for ignoring the routes that do not exist.
+
+By Default these methods are created:
+
+- index
+- show
+- store
+- update
+- destroy
+
+There are many querystrings available in the index method.
+These contain options like:
+
+- include=(associated model names comma separated)
+- where=(key:value rows comma separated and key value pairs are semi-colon separated)
+- order=(key:(DESC||ASC) rows comma separated and key DESC/ASC pairs semi-colon separated)
+- limit=(amount returned the default is 25)
+- offset=(number_to_skip in rows)
+- page=(which page the default is 1)
+
+For more information about the Global Controller check out the details here: [Global Controller Docs](./docs/GLOBAL_CONTROLLER.md)
+
+## Unit tests
+
+By default the tests check the format of the response and the status code.
+You must provide request params for your store method and update method based
+on the params options in your model. They are at the top of the file with TODOS.
+There are tests for the querystrings. That you can update. The include
+querystring test must be updated based on your schema.
+
+The tests cover all querystrings with the same successful data format as default index currently.
+
+Test cover:
+
+Index:
+
+- status_code = 200
+- json_format = { data: (array), count: (integer) }
+
+Show:
+
+- status_code = 200
+- json_format = { id: (integer) }
+
+Create:
+
+- status_code = 201
+- json_format = { id: (integer) }
+
+Update:
+
+- status_code = 200
+- json_format = { id: (integer) }
+
+Destroy:
+
+- status_code = 204
+
+For more information about the Unit Tests check out the details here: [Generated Unit Test Docs](./docs/RAILSUNIT.md)

data/bin/railspp

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'railspp'
+
+if RailsPlusPlus.check_directory
+    RailsPlusPlus.run_command(ARGV)
+else
+    puts RailsPlusPlus.error_string
+end

data/lib/commands/initialize.rb

@@ -0,0 +1,67 @@
+require_relative '../utils/strings.rb'
+
+
+class InitializeCommand < MoreUtils
+    class << self
+
+        def run *args
+            lookup = flag_lookup(args)
+
+            # Add Initializers
+            cors_template = get_file_str("#{this_dir}/../templates/rack_cors_initializer.txt")
+            write_file("#{root}/config/initializers/rack_cors.rb", cors_template)
+
+            adi_template = get_file_str("#{this_dir}/../templates/api_documentation_initializer.txt")
+            write_file("#{root}/config/initializers/api_documentation_js.rb", adi_template)
+
+            # Add Controllers
+            dc_template = get_file_str("#{this_dir}/../templates/documentation_controller.txt")
+            write_file("#{root}/app/controllers/documentation_controller.rb", dc_template)
+
+            gc_template = get_file_str("#{this_dir}/../templates/global_controller.txt")
+            write_file("#{root}/app/controllers/global_controller.rb", gc_template)
+
+            # Add Concerns
+            ehc_template = get_file_str("#{this_dir}/../templates/exception_handler.txt")
+            write_file("#{root}/app/controllers/concerns/exception_handler.rb", ehc_template)
+
+            resp_template = get_file_str("#{this_dir}/../templates/response.txt")
+            write_file("#{root}/app/controllers/concerns/response.rb", resp_template)
+
+            # Add Service
+            system("mkdir -p #{root}/app/services")
+            aps_template = get_file_str("#{this_dir}/../templates/api_documentation_service.txt")
+            write_file("#{root}/app/services/api_documentation_service.rb", aps_template)
+
+            # Add Views
+            system("mkdir -p #{root}/app/views/documentation")
+            dihtml_template = get_file_str("#{this_dir}/../templates/documentation.index.erb.txt")
+            write_file("#{root}/app/views/documentation/index.html.erb", dihtml_template)
+
+            dlhtml_template = get_file_str("#{this_dir}/../templates/documentation.layout.erb.txt")
+            write_file("#{root}/app/views/layouts/documentation.html.erb", dlhtml_template)
+            
+            # Update Routes
+            unless lookup[:"skip-routes"]
+                routes_template = get_file_str("#{this_dir}/../templates/routes_documentation.txt")
+                routes_file = get_file_str("#{root}/config/routes.rb")
+                routes_arr = routes_file.split("\n")
+                last_end_line = last_end_index(routes_arr)
+
+                new_routes = routes_arr.slice(0, last_end_line).join("\n") + "\n#{routes_template}\nend\n"
+                write_file("#{root}/config/routes.rb", new_routes)
+            end
+
+            puts "Your project has been initialized."
+        end
+
+        def last_end_index arr
+            arr.each_with_index.inject(0) do |acc, (e, i)|
+                acc = i if /(end)/.match(e)
+                acc
+            end
+        end
+
+    end
+
+end

data/lib/commands/make_test.rb

@@ -0,0 +1,12 @@
+require_relative '../utils/strings.rb'
+
+
+class MakeTestCommand < MoreUtils
+    class << self
+
+        def run *args
+
+        end
+
+    end
+end

data/lib/commands/model.rb

@@ -0,0 +1,36 @@
+require_relative '../utils/strings.rb'
+
+
+class ModelCommand < MoreUtils
+    class << self
+
+        def run *args
+            lookup = flag_lookup(args)
+            arguments = get_args(args)
+
+            if arguments.length < 2
+                puts "Enter a valid model generation command."
+                return 
+            end
+
+            model_name = arguments[0].camelcase
+            others = arguments[1..-1]
+
+            system("rails generate model #{model_name} #{others.join(' ')}")
+
+            api_version_path = lookup[:"api-version"] || 'api/v1'
+            system("mkdir -p #{root}/app/controllers/#{api_version_path}")
+
+            controller_prefix = api_version_path.split('/').map { |e| e.downcase.capitalize }.join('::')
+            controller_name = controller_prefix + '::' + model_name
+
+            controller_temp =  get_file_str("#{this_dir}/../templates/controller.txt")
+            controller_regex = '{{ CONTROLLER_NAME }}'
+            controller_str = controller_temp.gsub(controller_regex, controller_name)
+            write_file("#{root}/app/controllers/#{api_version_path}/#{model_name.underscore}_controller.rb", controller_str)
+
+            puts "#{model_name} model, migration, and controller has been generated."
+        end
+
+    end
+end

data/lib/help/documentation.rb

@@ -0,0 +1,30 @@
+require_relative '../utils/strings.rb'
+
+class DocumentationHelpCommand < MoreUtils
+    class << self
+
+        def run descriptions
+            puts "#{ascii_art}
+Rails Plus Plus Version: #{gem_version}
+
+Rails Plus Plus: Command Line Interface to make your life easier.
+=> The Rails Plus Plus command is 'railspp'. To blast this project into the fifth dimension.
+=> Use '--help' on any of the commands listed below for more details.
+
+List of commands:
+#{descriptions}
+"
+        end
+
+        def ascii_art
+"______      _ __                 
+| ___ \\    (_) |      _     _   
+| |_/ /__ _ _| |___ _| |_ _| |_ 
+|    // _` | | / __|_   _|_   _|
+| |\\ \\ (_| | | \\__ \\ |_|   |_|  
+\\_| \\_\\__,_|_|_|___/                       
+"
+        end
+
+    end
+end

data/lib/help/initialize.rb

@@ -0,0 +1,21 @@
+class InitializeHelpCommand
+    class << self
+
+        def run *args
+            puts "Options:
+
+You have the availability to skip portions of the 
+initialize command.
+
+If you would like to skip the initial route nmespace use:
+
+--skip-routes
+
+Run to initialize your project:
+'railspp initialize'
+"
+        end
+
+    end
+end
+

data/lib/help/make_test.rb

@@ -0,0 +1,13 @@
+class MakeTestHelpCommand
+    class << self
+
+        def run *args
+            puts "No Options available. 
+
+Run to generate railspp tests your generated controllers:
+'railspp make_test (resource-prefix)'
+"
+        end
+
+    end
+end

data/lib/help/model.rb

@@ -0,0 +1,30 @@
+class ModelHelpCommand
+    class << self
+
+        def run
+            puts "Options:
+You have the abliity to enter an api-version through namespaces.
+You can generate your controller in your nmespace directory.
+By default the value is 'api/v1'
+
+Enter your namespace directory-path from controllers directory without
+a starting '/' in this option.
+
+    --api-version=(namespace-directory-path-from-controllers-directory)
+
+Example:
+
+--api-version=api/v2
+
+Same command as:
+rails generate model <model-name> 
+
+With your generated controller
+
+Run to generate your model, migration, and controller:
+'railspp model (model-name) (models-options) (your-api-version-flag)'
+"
+        end
+
+    end
+end

data/lib/railspp.rb

@@ -0,0 +1,78 @@
+require_relative './commands/initialize.rb'
+require_relative './commands/make_test.rb'
+require_relative './commands/model.rb'
+require_relative './help/documentation.rb'
+require_relative './help/initialize.rb'
+require_relative './help/make_test.rb'
+require_relative './help/model.rb'
+require_relative './utils/strings.rb'
+
+
+class RailsPlusPlus < MoreUtils
+  class << self
+
+    def error_string
+      'ERROR: Must make railspp commands in the rails root directory'
+    end
+
+    def check_directory
+      File.file?(root + '/bin/rails')
+    end
+
+    def run_command arguments
+
+      is_help = arguments.select { |e| e == '--help' || e == '-h' }.length > 0
+      command_name = arguments[0]
+      passable_args = arguments[1..-1]
+      lookup = is_help ? command_name_help_lookup : command_name_lookup
+      command_exists = !command_name.nil? && !lookup[command_name.to_sym].nil?
+
+      if command_exists
+        command_class = lookup[command_name.to_sym]
+        command_class.run(*passable_args)
+      else
+        DocumentationHelpCommand.run(descriptions.join("\n"))
+      end
+    end
+
+    private
+
+    def command_name_lookup
+      {
+        i: InitializeCommand,
+        init: InitializeCommand,
+        initialize: InitializeCommand,
+        m: ModelCommand,
+        model: ModelCommand,
+        make_test: MakeTestCommand,
+        mt: MakeTestCommand,
+      }
+    end
+
+    def command_name_help_lookup
+      {
+        i: InitializeHelpCommand,
+        init: InitializeHelpCommand,
+        initialize: InitializeHelpCommand,
+        m: ModelHelpCommand,
+        model: ModelHelpCommand,
+        make_test: MakeTestHelpCommand,
+        mt: MakeTestHelpCommand,
+      }
+    end
+
+    def descriptions
+      [
+        '- i => Initialize your project',
+        '- init => Initialize your project',
+        '- initialize => Initialize your project',
+        '- m => Generate your CRUD model, controller, and migration',
+        '- model => Generate your CRUD model, controller, and migration',
+        '- make_test => Generate your resource unit test',
+        '- mt => Generate your resource unit test'
+      ]
+    end
+
+  end
+end
+

data/lib/templates/api_documentation_initializer.txt

@@ -0,0 +1,4 @@
+Rails.application.config.after_initialize do
+    Rails.application.reload_routes!
+    APIDocumentationService.generate_js_file()
+end

data/lib/templates/api_documentation_service.txt

@@ -0,0 +1,206 @@
+class APIDocumentationService
+  class << self
+    def generate_js_file
+        all_routes = get_api_routes
+        documentation_js_str = all_routes.map { |e| handle_js_for_route(e) }.join("\n")
+
+        File.open(output_path, "w+") { |f| f.write(documentation_js_str) }
+    end
+
+    def namespaces
+        # Blacklist namespaces
+        [:api]
+    end
+
+    def docs_namespaces
+        namespaces.each_with_object({}) do |item, acc| 
+          acc[item] = true
+          acc
+        end
+    end
+
+    def get_api_routes
+        get_all_routes.select do |e|
+          path_array = e[:route].split('/')
+          path_array.length > 1 && docs_namespaces[path_array[1].to_sym]
+        end
+    end
+
+    def camelize_route route
+        camel_route = route[:route].split('/').reject { |e| e == '' }.map { |e| /\:/.match(e) ? e.gsub!(':', '') + 'Param' : e }.map { |e| e.capitalize }.join('')
+        route[:method].downcase + camel_route
+    end
+
+    private
+    
+        def output_path
+            __dir__ + '/../../app/assets/javascripts/documentation.js'
+        end
+
+        def get_all_routes
+            Rails.application.routes.routes.map { |e| { route: e.path.spec.to_s.split('(')[0], method: e.verb } }.map { |e| e[:route] && e[:method] ? e.merge(camel_cased: camelize_route(e)) : e }.select { |e| e[:route] }
+        end
+
+        def handle_js_for_route route
+            camel_cased = route[:camel_cased]
+            javascript_string = ''
+            javascript_string += "window.#{camel_cased} = function() {
+                var allData = {
+                  method: '#{route[:method]}',
+                  route: '#{route[:route]}',
+                };
+                var paramList = document.getElementById('#{camel_cased}ParamsForm') && document.getElementById('#{camel_cased}ParamsForm').elements ? document.getElementById('#{camel_cased}ParamsForm').elements : [];
+                var headerList = document.getElementById('#{camel_cased}HeadersForm') && document.getElementById('#{camel_cased}HeadersForm').elements ? document.getElementById('#{camel_cased}HeadersForm').elements : [];
+                
+                var headerObject = {};
+                var tempHeaderKey = null;
+                for (var i = 0; i < headerList.length; i++) {
+                    var eleHeader = headerList[i].value;
+                    if (i % 2 !== 0 && tempHeaderKey) {
+                        headerObject[tempHeaderKey] = eleHeader;
+                        tempHeaderKey = null;
+                    } else {
+                        tempHeaderKey = eleHeader;
+                    }
+                }
+          
+                var hasHeaders = Object.keys(headerObject).length > 0;
+                var headers = { headers: headerObject };
+        
+                var paramObject = {};
+                var tempParamKey = null;
+                for (var i = 0; i < paramList.length; i++) {
+                  var eleParam = paramList[i].value;
+                  if (i % 2 !== 0) {
+                    paramObject[':' + tempParamKey] = eleParam;
+                    tempParamKey = null;
+                  } else {
+                    tempParamKey = eleParam;
+                  }
+                }
+                
+                var routeName = allData.route.split('/').map(function(e) { return paramObject[e] ? paramObject[e] : e; }).join('/');
+                
+                if (allData.method !== 'GET') {
+                var bodyDataType = document.getElementById('#{camel_cased}DataType') && document.getElementById('#{camel_cased}DataType').value ? document.getElementById('#{camel_cased}DataType').value : false;
+                var formBoolean = bodyDataType === 'Form Data';
+                
+                var bodyElements = [];
+                var bodyRawElements = document.getElementById('#{camel_cased}BodyForm') && document.getElementById('#{camel_cased}BodyForm').elements ? document.getElementById('#{camel_cased}BodyForm').elements : [];
+                for (var i = 0; i < bodyRawElements.length; i++) {
+                  var eleParam = bodyRawElements[i].files ? bodyRawElements[i].files[0] : (bodyRawElements[i].value || null);
+                  bodyElements.push(eleParam);
+                }
+                bodyElements = bodyElements.filter(function(e) {
+                  return !!e;
+                });
+                
+                var bodyObject = bodyDataType === 'Form Data' ? new FormData() : {};
+                var tempBodyKey = null;
+                bodyElements.forEach(function(e, i) {
+                    if (i % 2 !== 0) {
+                      if (formBoolean) {
+                        bodyObject.append(tempBodyKey, e);
+                        tempBodyKey = null;
+                      } else {
+                        bodyObject[tempBodyKey] = e;
+                        tempBodyKey = null;
+                      }
+                    } else {
+                      if (formBoolean) {
+                        tempBodyKey = e;
+                      } else {
+                        bodyObject[e] = null;
+                        tempBodyKey = e;
+                      }
+                    }
+                  });
+                }
+                
+                var qsElements = [];
+                var qsRawElements = document.getElementById('#{camel_cased}QSForm') && document.getElementById('#{camel_cased}QSForm').elements ? document.getElementById('#{camel_cased}QSForm').elements : [];
+                for (var i = 0; i < qsRawElements.length; i++) {
+                  var eleParam = qsRawElements[i].value || null;
+                  qsElements.push(eleParam);
+                }
+                
+                qsElements = qsElements.filter(function(e) { return !!e; });
+                
+                var qsObject = {};
+                var tempQSKey = null;
+                qsElements.forEach(function(e, i) {
+                  if (i % 2 !== 0) {
+                    qsObject[tempQSKey] = e;
+                    tempQSKey = null;
+                  } else {
+                    qsObject[e] = null;
+                    tempQSKey = e;
+                  }
+                });
+                
+                var qsLength = Object.keys(qsObject).length;
+                var querystring = qsLength > 0 ? '?' : '';
+
+                var qsCount = 0;
+                var qsArray = [];
+                if (querystring === '?') {
+                  for (var qs in qsObject) {
+                    if (qs && qsObject[qs]) {
+                      qsArray.push(qs + '=' + qsObject[qs]);
+                    }
+                  }
+                }
+
+                querystring += qsArray.join('&');
+                
+                var args = allData.method === 'GET' || allData.method === 'DELETE' ? [routeName + querystring, headers] : [routeName + querystring, bodyObject, headers];
+                if (!hasHeaders) args.pop();
+                var resultElement = document.getElementById('#{camel_cased}-results');
+                
+                axios[allData.method.toLowerCase()](...args)
+                  .then(function(resp) {
+                    if (resp.status <= 300) {
+                      resultElement.innerText = JSON.stringify(resp.data, null, 4);
+                    } else {
+                      resultElement.innerText = JSON.stringify(resp.data, null, 4);
+                    }
+                  })
+                  .catch(function(err) {
+                    var error_ajax = err && err.response && err.response.data ? err.response.data : err;
+                    resultElement.innerText = JSON.stringify(error_ajax, null, 4);
+                  });
+                };
+                "
+                
+                  javascript_string += "window.#{camel_cased}NewBody = function() {
+                  var ele = document.getElementById('#{camel_cased}BodyForm');
+                  ele.innerHTML += '<div class=\"d-flex f-row\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter key\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter value\"></div>';
+                };
+                
+                "
+                
+                  javascript_string += "window.#{camel_cased}NewBodyFile = function() {
+                  var ele = document.getElementById('#{camel_cased}BodyForm');
+                  ele.innerHTML += '<div class=\"d-flex f-row\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter key\"><input class=\"w-100 m-1 form-control\" type=\"file\" multiple accept=\"*/*\" placeholder=\"Enter value\"></div>';
+                };
+                
+                "
+                
+                  javascript_string += "window.#{camel_cased}NewQS = function() {
+                  var ele = document.getElementById('#{camel_cased}QSForm');
+                  ele.innerHTML += '<div class=\"d-flex f-row\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter key\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter value\"></div>';
+                };
+                "
+
+                javascript_string += "window.#{camel_cased}NewHeader = function() {
+                  var ele = document.getElementById('#{camel_cased}HeadersForm');
+                  ele.innerHTML += '<div class=\"d-flex f-row\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter key\"><input class=\"w-100 m-1 form-control\" type=\"text\" placeholder=\"Enter value\"></div>';
+                };
+
+                ";
+
+                javascript_string
+        end
+
+  end
+end

data/lib/templates/controller.txt

@@ -0,0 +1,2 @@
+class {{ CONTROLLER_NAME }}Controller < GlobalController
+end

data/lib/templates/documentation.index.erb.txt

@@ -0,0 +1,129 @@
+<div class="header p-3 bg-dark card-shadow d-flex flex-row justify-content-between">
+    <div class="d-flex flex-row">
+        <a href='/' class="h-100">
+            <img class="d-flex flex-column align-items-center justify-content-center" src="https://s3-us-west-1.amazonaws.com/manoftech/ruby.png" alt="" height='50' width='50' />
+        </a>
+        <h1 class="h1 h-100 align-items-center text-white ml-3">API Documentation</h1>
+    </div>
+    <a class="d-flex align-items-center cursor-pointer">
+        <h2 class="h5 text-white" onclick="goBack()">Go Back</h2>
+    </a>
+</div>
+
+<div class="card-body p-3 w-100 p-1">
+    <% @all_routes.each do |data| %>
+        <div class="card card-outline-secondary w-100 flex-respond-row card-shadow">
+            <div class="col-xs-12 col-sm-12 col-md-12 col-lg-6 col-xl-6 p-1 card-shadow">
+                <div class='card-header <%= "#{data[:route_header]}" %>'>
+                    <span class="mr-1"><%= data[:method] %>:</span>
+                    <span><%= data[:route] %></span>
+                </div>
+                <div class="card-body p-2 w-100" style="max-height: 550px; overflow: auto;">
+                    <% if data[:middleware] && data[:middleware].length > 0 %>
+                        <h2 class="h5">Middleware Used:</h2>
+                        <ul>
+                            <% data[:middleware].each do |ware| %>
+                                <li class="h6"><%= "#{ware}" %></li>
+                            <% end %>
+                        </ul>
+                    <% end %>
+
+                    <h2 class="h5">Description:
+                        <ul>
+                          <% data[:description].each do |ware| %>
+                                <li class="h6"><%= "#{ware}" %></li>
+                            <% end %>
+                        </ul>
+                    </h2>
+
+                    <div class="d-flex f-row w-100">
+                        <h2 class="w-100 h6">Headers:</h2>
+                        <button class="<%= "#{data[:submit_button_color]} rounded-circle" %>" onclick="<%= "#{data[:submit_button_color]}NewHeader()" %>">+</button>
+                    </div>
+                    <div class="d-flex f-row w-100">
+                        <form id="<%= data[:camel_cased] %>HeadersForm" class="w-100">
+                                <div class="d-flex f-row">
+                                    <input type="text" class="w-100 m-1 d-flex f-row form-control" placeholder="Enter key">
+                                    <input  type="text" class="w-100 m-1 form-control" placeholder="Enter value">
+                                </div>
+                        </form>
+                    </div>
+
+                    <% if data[:allow_params] %>
+                        <div class="d-flex f-row w-100">
+                            <h2 class="w-100 h6">Params:</h2>
+                        </div>
+                        <div class="d-flex f-row w-100">
+                            <form id="<%= "#{data[:camel_cased]}ParamsForm" %>" class="w-100">
+                                <%= data[:params].each do |param| %>
+                                    <div class="d-flex f-row">
+                                        <input id="<%= "#{data[:camel_cased]}-#{param}" %>" type="text" class="w-100 m-1 d-flex f-row form-control" value="<%= "#{param}" %>">
+                                        <input id="<%= "#{data[:camel_cased]}-#{param}-value" %>" type="text" class="w-100 m-1 form-control" placeholder="Enter value">
+                                    </div>
+                                <% end %>
+                            </form>
+                        </div>
+                    <% else %>
+                        <span></span>
+                    <% end %>
+                    <% if data[:allow_body] %>
+                        <div class="d-flex f-row w-100">
+                            <h2 class="w-100 h6">Body:</h2>
+                            <button class="<%= "#{data[:submit_button_color]} rounded mr-2" %>" onclick="<%= "#{data[:camel_cased]}NewBodyFile()" %>">Add File</button>
+                            <button class="<%= "#{data[:submit_button_color]} rounded-circle" %>" onclick="<%= "#{data[:camel_cased]}NewBody()" %>">+</button>
+                        </div>
+                        <div class="d-flex f-row w-100">
+                            <form id='<%= "#{data[:camel_cased]}BodyForm" %>'class='w-100'>
+                                <div class='d-flex f-row'>
+                                    <input type='text' class='w-100 m-1 form-control' placeholder='Enter key'>
+                                    <input type='text' class='w-100 m-1 form-control' placeholder='Enter value'>
+                                </div>
+                            </form>
+                        </div>
+                    <% else %> 
+                        <span></span>
+                    <% end %>
+                    <div class="d-flex f-row w-100">
+                        <h2 class="w-100 h6">Querystrings: </h2>
+                        <button class="<%= "#{data[:submit_button_color]} rounded-circle" %>" onclick="<%= "#{data[:camel_cased]}NewQS()" %>">+</button>
+                    </div>
+                    <div class="d-flex f-row w-100">
+                        <form id='<%= "#{data[:camel_cased]}QSForm" %>' class="w-100">
+                            <div class="d-flex f-row">
+                                <input type="text" class="w-100 m-1 form-control" placeholder="Enter key">
+                                <input type="text" class="w-100 m-1 form-control" placeholder="Enter value">
+                            </div>
+                        </form>
+                    </div>
+                    <% if data[:allow_body] %>
+                        <h2 class="h6">Body Data Type:</h2>
+                        <select id="<%= "#{data[:camel_cased]}DataType" %>" class='form-control'>
+                            <option value=''></option>
+                            <option value='JSON'>JSON</option>
+                            <option value='Form Data'>Form Data</option>
+                        </select>
+                    <% else %>
+                        <span></span>
+                    <% end %>
+                    <div class="w-100 mt-2">
+                        <button class="<%= "#{data[:submit_button_color]} w-100" %>" onclick="<%= "#{data[:camel_cased]}()" %>">Submit</button>
+                    </div>
+                </div>
+            </div>
+            <div class="col-xs-12 col-sm-12 col-md-12 col-lg-6 col-xl-6 p-1 card-shadow p-1">
+                <div class="card-header">
+                    <h2 class="h5">Sample Data</h2>
+                </div>
+                <div class='card-body' style="max-height: 550px; overflow: auto;">
+                    <code style="overflow: auto; display: block;">
+                        <span id="<%= "#{data[:camel_cased]}-results" %>" style="white-space: pre;"></span>
+                    </code>
+                </div>
+            </div>
+        </div>
+    <% end %>
+</div>
+
+
+<script>function goBack() { window.history.back(); }</script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/axios/0.18.0/axios.min.js"></script>

data/lib/templates/documentation.layout.erb.txt

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Automatic API Docs</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+    <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0/css/bootstrap.min.css" integrity="sha384-Gn5384xqQ1aoWXA+058RXPxPg6fy4IWvTNh0E263XmFcJlSAwiGgFAW/dAiS6JXm" crossorigin="anonymous">
+    <style>.flex-respond-row {display: flex !important;flex-direction: column !important;}@media (min-width: 992px) {.flex-respond-row {display: flex !important;flex-direction: row !important;}}.card-shadow {box-shadow: 0 7px 14px 0 rgba(50,50,93,.1), 0 3px 6px 0 rgba(0,0,0,.07);}.cursor-pointer{ cursor: pointer !important; }</style>
+  </head>
+
+  <body style="width: 100%; overflow-x: hidden;">
+    <%= yield %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </body>
+</html>

data/lib/templates/documentation_controller.txt

@@ -0,0 +1,52 @@
+class DocumentationController < ApplicationController
+
+    def index
+        @all_routes = get_api_array
+        render template: 'documentation/index', layout: 'documentation'
+    end
+
+    private
+
+        def get_api_array
+            get_api_routes.map { |e| get_api_object(e) }
+        end
+
+        def get_api_object route_hash
+            {
+                method: route_hash[:method],
+                route: route_hash[:route],
+                params: get_params(route_hash[:route]),
+                middleware: ['Not Available'],
+                route_header: "text-white bg-#{get_method_color(route_hash[:method])}",
+                submit_button_color: "btn btn-outline-#{get_method_color(route_hash[:method])}",
+                camel_cased: camelize_route(route_hash),
+                allow_params: route_hash[:route].split(':').length > 1,
+                allow_body: route_hash[:method] != 'GET',
+                description: ['No Description available'],
+            }
+        end
+
+        def get_method_color method
+            lookup = {
+                GET: 'success',
+                POST: 'info',
+                PATCH: 'warning',
+                PUT: 'warning',
+                DELETE: 'danger',
+            }
+            lookup[method.to_sym] || 'light'
+        end
+
+        def get_params route
+            route.split('/').select { |e| /\:/.match(e) }.map { |e| e.split(':')[1] }
+        end
+
+        def camelize_route route
+            APIDocumentationService.camelize_route(route)
+        end
+
+        def get_api_routes
+            APIDocumentationService.get_api_routes
+        end
+
+end

data/lib/templates/exception_handler.txt

@@ -0,0 +1,19 @@
+module ExceptionHandler 
+    extend ActiveSupport::Concern
+
+    included do
+        rescue_from ActiveRecord::RecordNotFound do |e|
+            render_json({ error: e.message }, :not_found)
+        end
+        rescue_from ActiveRecord::RecordInvalid do |e|
+            render_json({ error: e.message }, :unprocessable_entity)
+        end
+        rescue_from ActiveRecord::ActiveRecordError do |e|
+            render_json({ error: e.message }, :bad_request)
+        end
+        rescue_from ActionController::InvalidAuthenticityToken do |e|
+            render_json({ error: e.message }, :forbidden)
+        end
+    end
+
+end

data/lib/templates/global_controller.txt

@@ -0,0 +1,190 @@
+class GlobalController < ApplicationController
+
+    include Response
+    include ExceptionHandler
+
+    def default_per_page
+        25
+    end
+
+    def model
+        self.class.to_s.split('::').select { |e| /Controller/.match(e) }.first.chomp('Controller').singularize.constantize
+    end
+
+    def index
+        resp = index_response
+        past_pages = resp[:last_page] < resp[:current_page]
+        error = { error: 'Past the amount of pages available' }
+        render_json(past_pages ? error : index_response, past_pages ? 400 : 200)
+    end
+
+    def show
+        data = model.find(params[:id] || 0)
+        render_json(data, 200)
+    end
+
+    def create
+        data = model.create(create_params)
+        render_json(data, 201)
+    end
+
+    def update
+        data = model.where(params[:id] || 0).update(update_params).first
+        render_json(data, 200)
+    end
+
+    def destroy
+        model.destroy(params[:id] || 0)
+        render_json(nil, 204)
+    end
+
+    def bulk_csv_create
+        data = model.create(csv_to_json)
+        render_json(data, 201)
+    end
+
+    def bulk_create
+        data = model.create(bulk_create_params)
+        render_json(data, 201)
+    end
+
+    def bulk_update
+        data = model.where(id: bulk_update_params[:id]).update(bulk_update_params)
+        render_json(data, 201)
+    end
+
+    def bulk_destory
+        model.where(id: bulk_destroy_params)
+        render_json(nil, 204)
+    end
+
+    private
+
+        def csv_to_json param_key = :file, separated_by = ','
+            lines = params[param_key].split("\n")
+            keys = lines[0].split(separated_by)
+            rows = lines.slice(1).map { |e| e.split(separated_by) }
+            rows.map { |e| e.each_with_index.inject({}) { |acc, (e, i)| acc.merge("#{keys[i]}": e) } }
+        end
+
+        def create_params
+            bl = array_to_hash(black_list_create)
+            params.permit(*get_model_key.reject { |e| bl[e.to_sym] })
+        end
+
+        def update_params
+            bl = array_to_hash(black_list_update)
+            params.permit(*get_model_key.reject { |e| bl[e.to_sym] })
+        end
+
+        def bulk_create_params
+            params.permit(bulk: get_model_key)
+        end
+
+        def bulk_update_params
+            params.permit(bulk: get_model_key)
+        end
+
+        def bulk_destroy_params
+            params.permit(bulk: [:id])
+        end
+
+        def black_list_create
+            [:id, :created_at, :updated_at]
+        end
+
+        def black_list_update
+            [:id, :created_at, :updated_at]
+        end
+
+        def array_to_hash array
+            array.each_with_object({}) do |e, acc|
+                acc[e] = true
+                acc
+            end
+        end
+
+        def handle_pagination
+            limit = (params[:limit] || default_per_page).to_i
+            offset = (params[:offset] || 0).to_i
+            page = (params[:page] || 1).to_i
+
+            data = model.limit(limit).offset(offset).offset((page - 1) * limit)
+            data = data.where(get_where) if params[:where]
+            data = data.includes(*get_includes) if params[:include]
+            data = data.order(get_order) if params[:order]
+            data = data.all
+            data
+        end
+
+        def handle_pagination_count
+            data = model
+            data = data.where(get_where) if params[:where]
+            data.count
+        end
+
+        def index_response
+            page = (params[:page] || 1).to_i
+            per_page = (params[:limit] || default_per_page).to_i
+            total = handle_pagination_count
+            path = request.original_url
+            path_path = add_pg_qs(path)
+            last = (total / per_page.to_f).ceil
+            nxt = (page + 1) > last ? nil : (page + 1)
+            prev = (page - 1) == 0 ? nil : (page - 1)
+            last = last == 0 ? 1 : last
+            data = handle_pagination
+            data_first = data.first
+            data_last = data.last
+
+            {
+                data: data,
+                to: data_first ? data_first.id : nil,
+                from: data_last ? data_last.id : nil,
+                total: total,
+                path: path,
+                current_page: page,
+                per_page: per_page,
+                last_page: last,
+                first_page_url: path_path + '1',
+                last_page_url: path_path + last.to_s,
+                next_page_url: nxt ? (path_path + nxt.to_s) : nil,
+                prev_page_url: prev ? (path_path + prev.to_s) : nil,
+            }
+        end
+
+        def add_pg_qs str
+            has_qs = /\?/.match(str)
+            return "#{str}?page=" unless has_qs
+            before_qs, after = str.split('?')
+            after_qs = after.split('&').reject { |e| /page\=/.match(e) }
+            after_qs.push('page=')
+            "#{before_qs}?#{after_qs.join('&')}"
+        end
+
+        def get_includes
+            comma_separated(params[:include]).map(&:to_sym)
+        end
+
+        def get_order
+            params[:order].split(',').flat_map { |e| e.split(':') }.join(' ')
+        end
+
+        def get_where
+            arrays = params[:where].split(',').map { |e| e.split(':') }
+            arrays.inject({}) do |acc, item|
+                key, val = item
+                acc[key] = val
+                acc
+            end
+        end
+
+        def comma_separated key
+            params[:key].split(',')
+        end
+
+        def get_model_key
+            model.columns.map { |e| e.name.to_sym }
+        end
+
+end

data/lib/templates/rack_cors_initializer.txt

@@ -0,0 +1,6 @@
+Rails.application.config.middleware.insert_before 0, Rack::Cors do
+    allow do
+      origins '*'
+      resource '*', headers: :any, methods: [:get, :post, :patch, :put, :delete, :options]
+    end
+end

data/lib/templates/response.txt

@@ -0,0 +1,7 @@
+module Response
+
+    def render_json data, status
+        render json: data, status: status
+    end
+
+end

data/lib/templates/routes_documentation.txt

@@ -0,0 +1,10 @@
+  resources :documentation, only: :index
+  
+  namespace :api do
+    # Add API Routes here
+
+    # For API version 1
+    namespace :v1 do
+        
+    end
+  end

data/lib/templates/routes_namespace.txt

@@ -0,0 +1,10 @@
+  resources :documentation, only: :index
+  
+  namespace :api do
+    # Add API Routes here
+
+    # For API version 1
+    namespace :v1 do
+        
+    end
+  end

data/lib/utils/strings.rb

@@ -0,0 +1,61 @@
+class String
+
+    def underscore
+        self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+
+    def camelcase
+        self.split(/(?=[A-Z])|(_)/)
+            .reject { |e| e == '_' }
+            .map(&:capitalize)
+            .join('')
+    end
+
+end
+
+class MoreUtils
+    class << self
+
+        def gem_version
+            "0.0.3"
+        end
+
+        def get_file_str path
+            File.open(path, 'r:UTF-8', &:read)
+        end
+    
+        def write_file path, str
+            File.write(path, str)
+        end
+    
+        def this_dir
+            __dir__
+        end
+    
+        def root
+            Dir.pwd
+        end
+
+        def get_flags arr
+            arr.select { |e| /--/.match(e) }
+        end
+
+        def get_args arr
+            arr.reject { |e| /--/.match(e) }
+        end
+
+        def flag_lookup arr
+            arr.each_with_object({}) do |e, acc|
+                e = e.gsub('--', '')
+                key, val = e.split('=')
+                acc[key.to_sym] = val
+                acc
+            end
+        end
+
+    end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: railspp
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Layne Faler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+description: Scaffolding your CRUD operations
+email: laynefaler@gmail.com
+executables:
+- railspp
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/railspp
+- lib/commands/initialize.rb
+- lib/commands/make_test.rb
+- lib/commands/model.rb
+- lib/help/documentation.rb
+- lib/help/initialize.rb
+- lib/help/make_test.rb
+- lib/help/model.rb
+- lib/railspp.rb
+- lib/templates/api_documentation_initializer.txt
+- lib/templates/api_documentation_service.txt
+- lib/templates/controller.txt
+- lib/templates/documentation.index.erb.txt
+- lib/templates/documentation.layout.erb.txt
+- lib/templates/documentation_controller.txt
+- lib/templates/exception_handler.txt
+- lib/templates/global_controller.txt
+- lib/templates/rack_cors_initializer.txt
+- lib/templates/response.txt
+- lib/templates/routes_documentation.txt
+- lib/templates/routes_namespace.txt
+- lib/utils/strings.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Scaffold your CRUD operations
+test_files: []