rails_on_rails 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79e060621e3223010ebd62ec76daa8665c3402c7ef72816735eb5f4d6555ce85
-  data.tar.gz: 2d744aaa383e59b2b7f591acb1f74e255b50903e839fb4b7d17646310c50087d
+  metadata.gz: d4e1d585f063847ecd96cba21db767aa8e1bc343e86506c9c60a14fcdabce366
+  data.tar.gz: bbe7ab73544abbfa3de3ea52c2df30d5b3fc60722adf1e611b6ab38d9dd94b26
 SHA512:
-  metadata.gz: '08aa1c5d9426b1dfe99ca25d17361d6544fce8c063ef71422ff37b9c4a854e56566a4d7ccf3e513f951d177eaee535071ed4bd9c11867dd8eb7197f3a1150ad9'
-  data.tar.gz: a46fe0a29071cc99ee39b8039e7fd3ab14369062c05a0e0a60e44dbf7ac0ca18d93226be380eb90666fd8763e91037a44c541c83ae7ef793455eee9f94771407
+  metadata.gz: ca9f9534cb03121ece937f26c0c7f40dd6b2c7929adfffcf9a3f6c8c787331d7b480e50c9aadaffaa6794f4fd81f548d2830d11b8a718f9c4377f6f1b19eb666
+  data.tar.gz: 4808d351d2102d30732b8ee9771677891f40c75590480eb6b32d964b14b90f44407c23bab5f10e7e57f05053d15e9a8288266bcf6c0c6acebcdb0cd2ee3712d1

data/README.md

@@ -7,7 +7,15 @@ The global controller file has changed
 
 All commands must be execute in your Rails root project directory
 
+## Gem Dependencies
+
+- Ruby Version )= 2.5
+- Rails Version 5: `gem 'rails', '~) 5'`
+- Rails Rspec Version )= 3.8: `gem 'rspec-rails', '~) 3.8'`
+- Faker Version )= 1.9: `gem 'faker', '~) 1.9'`
+
 ## Installation
+
 Install in your gem file and a global install for this gem
 
 Global Install:
@@ -16,30 +24,21 @@ Global Install:
 Gemfile Install:
 `gem 'rails_on_rails'`
 
-## Gem Dependencies
-- Ruby Version >= 2.5
-- Rails Version 5: `gem 'rails', '~> 5'`
-- Rails Rspec Version >= 3.8: `gem 'rspec-rails', '~> 3.8'`
-- Faker Version >= 1.9: `gem 'faker', '~> 1.9'`
+## Initialize your project with Rails on Rails
 
-## Initialize your project with Rails + 1
 If you run into hangups with spring, run `spring stop` before your `rails_on_rails`
 Then `spring server` to resume spring
 
-```
+```bash
 rails new tutorial
 cd tutorial
-
-# Check to make sure your initial rails database is setup correctly
-# Check to make sure your initial rails setup is fully functional
-# Make sure rails_on_rails is install in your gem file
-
 rails_on_rails init
 ```
 
 Before running the server add this initializer for the API Documentation
 in your `config/application.rb` add this inside of your Rails::Apllication inherited class
-```
+
+```ruby
 config.after_initialize do
     require 'rake'
     Rails.application.reload_routes!
@@ -49,7 +48,8 @@ end
 ```
 
 In your `config/routes.rb` add this route for your documentation page
-```
+
+```ruby
 resources :documentation, only: :index
 ```
 
@@ -58,24 +58,21 @@ But instead generates a controller for your model with unit tests to test the fu
 and update a model assocations.
 
 ## CLI Commands
-Rails on Rails: Command Line Interface to make your life easier.
-=> The Rails on Rails command is 'rails_on_rails'. To blast this project into the fifth dimension.
-=> Use '--help' or '-h on any of the commands listed below for more details.
 
-List of commands:
-=> i - Setup your initial Rails on Rails project
-=> init - Setup your initial Rails on Rails project
-=> model - Generate a new model migration, fully operational controller, and unit tests for that controller
-=> test:seeder - Generate a test seeder for your model
-=> test:spec - Generate a test spec for your controller
+![alt text](./docs/CLI_Commands.png)
+
+All these commands have `--help` flags with more descriptions on it's functionality.
+
+[For more details on the generated CLI Commands](./docs/API_DOCUMENTATION.md)
 
 ## Generate your CRUD Operations for Index, Show, Create, Update, & Destroy
+
 The `rails_on_rails model` command which has the same paramters as `rails g model`
 But instead generates a controller for your model with unit tests to test the fully operationality controller after you declare your routes
 and update a model assocations.
 
-```
-rails_on_rails model <ModelName> <*native-rails-model-generate-parameters>
+```bash
+rails_on_rails model (ModelName) (*native-rails-model-generate-parameters)
 ```
 
 By default all our basic CRUD operations are complete for: Index, Show, Create, Update, & Destroy
@@ -86,6 +83,7 @@ With your default CRUD operations you have many tools at your deposible
 For all of your options, you can see all the available options in the API docs based on our schema in for that model
 
 ### Querystring paramters
+
 - Index:
 -- include: Include will grab any associated tables with that endpoint separated by a comma (Check the docs for your schema's options)
 -- where: Where will be a custom where hash the string string format is a json object without curly brackets (Check the docs for your schema's options)
@@ -97,6 +95,7 @@ For all of your options, you can see all the available options in the API docs b
 -- where: Where will be a custom where hash the string string format is a json object without curly brackets (Check the docs for your schema's options)
 
 ### Body paramters
+
 All values except id, created_at, updated_at, or deleted_at are available by default you have the available to overwrite everything
 We use a custom method instead of params.permits
 For associated keys like 'user_id' provide an array with the first value being a symbol for the assocation ':user'
@@ -105,20 +104,26 @@ When using polymorphoric assocations, it is recommended to use a hash map of typ
 the value being the ActiveReord you provide in your schema with the search key being the string_type in the database
 
 ### Bonus Methods
+
 - bulk_create: Create multiple rows the paramter is 'bulk' which is an array of create hashes
-```
+
+```ruby
 params[:bulk] = [{ first_name: 'Mr. Robot' },{ first_name: 'Elloit }]
 ```
+
 - bulk_update: Update multiple rows the paramter is 'bulk' which is a hash of ids with the update hash
+
+```ruby
+params[:bulk] = { 1 =) { name: 'Luke Skywalker' }, 2 =) { name: 'Darth Vader' } }
 ```
-params[:bulk] = { 1 => { name: 'Luke Skywalker' }, 2 => { name: 'Darth Vader' } }
-```
+
 - bulk_destroy: Destroy multiple rows the paramter is 'ids' which is an array of ids
 - duplicate: Create a deep clone of any row in the database with all of it's assocations included the param is 'id' the table is for the controller associated to it
 - bulk_csv_create: Create multiple rows the paramter is 'file' which is a csv file separated by commas and the first line is keys and the rest of values all separated by commas
 
 #### Declaring bonus methods in `config/routes.rb`
-```
+
+```ruby
 resources :user, except: [:edit, :new] do 
     collection do 
         post 'duplicate'
@@ -130,21 +135,24 @@ resources :user, except: [:edit, :new] do
 end
 ```
 
-## API Documentation 
+## API Documentation
+
 The API Documentation requires CORS on your server, please set that up for all options for the web.
 Also setup your file uploads (multipart) to be independent of erb templating
 
 For custom headers that you may add in the future update the `lib/api_documentation.rake`
 Line 48: is where you can update the needed headers for your axios ajax requests.
-```
+
+```javascript
 var csrfHeader = { headers: { 'X-CSRF-Token': null } };
 ```
 
 By default only json formats are unaccept for RESTful API JSON formatting
 
 ### Querystring parameters
+
 A querystring in the url looks like this
-`<protocol>://<host-name>/<path-name></path-name>?<querystring-key>=<querystring-value>&<querystring-key>=<querystring-value>`
+`(protocol)://(host-name)/(path-name)(/path-name)?(querystring-key)=(querystring-value)&(querystring-key)=(querystring-value)`
 
 Anything after and including the question mark is a querystring
 You chain multiple querystring options spaced with '&'
@@ -152,11 +160,11 @@ You chain multiple querystring options spaced with '&'
 The API Docs do the string maniplication for you under the hood.
 
 The options for our API are:
-  /* key = value */
-  - include = <include-options-separated-by-a-comma>
-  - where = <where-options-separated-by-a-comma>
-  - like = <like-options-separated-by-a-comma>
-  - order = <order-options-separated-by-a-comma>
+
+- include = (include-options-separated-by-a-comma)
+- where = (where-options-separated-by-a-comma)
+- like = (like-options-separated-by-a-comma)
+- order = (order-options-separated-by-a-comma)
 
 Those options are given in the description for the endpoint you are testing
 
@@ -166,28 +174,35 @@ Those options are given in the description for the endpoint you are testing
 - Order will grab the data in the order you request
 
 ### Body parameters
+
 Body parameters are the key and value pairs you send in a request
 Those options are available as well
 Keeping the same key-value pair input UI with different functionality
 Under the 'Body' title
 
 ### Path parameters
+
 Path parameters are the key and value pairs you send in a request through the url
 Keeping the same key-value pair input UI however other the value will be in the url
 Under the 'Param' title
 
 ### Body Data Type option
+
 This dropdown is only used for file uploads by default they are set to JSON
 Use 'Form Data' for file uploads
 
+[For more details on the generated API Documentation](./docs/API_DOCUMENTATION.md)
+
 ## RSpec Unit Tests
 
 ### Authenicated Routes
+
 In your support file there is a called auth_helper. auth_helper.rb contains a login method.
 You can enter your own login endpoint here and pass in any needed params with email and password as an example
 so you can test authenicated routes with a JSON Web Token in your headers
 
 ### Test Database Seeders
+
 The database seeders that are generated are a template that work for most types of schemas.
 For custom schemas that may have unique constraints or unique behaviors. You can set a conditional to 
 search for the unique column name and set a value for it to satsify your unique needs.
@@ -195,14 +210,20 @@ search for the unique column name and set a value for it to satsify your unique
 These seeders are only for your test database with randomized data from faker
 
 ### Controller Specs
+
 The controller spec has tests for the generated controller. After you declare your routes, you can restrict the 
 tests for the routes you declare. The config_routes hash at the top will toggle those tests on or off because on what you set.
 By default all tests are true.
 Tests only cover basic CRUD resources: index, show, create, update, and destroy
 
-## GlobalController
+[For more details on the generated RSpec testing](./docs/RSPEC_CONTROLLER_TESTS.md)
+
+## Global Controller
+
 There are many helpful util functions in the global controller at your deposal.
 You can inherit the GlobalController instead of ApplicationController for your new controllers.
 This gives you both the default Rails controller functionality and all these utils
 
-In the autogeneration we utilize inheritance as much as posssible for cleaner controllers
+In the autogeneration we utilize inheritance as much as posssible for cleaner controllers
+
+[For more details on the Global Controller](./docs/GLOBAL_CONTROLLER.md)

data/lib/autogenerators/generator_templates/controller.txt

@@ -1,3 +1,2 @@
-class {{ MODEL }}Controller < GlobalController
-
+class {{ MODEL }}Controller < {{ GLOBAL_CONTROLLER }}
 end

data/lib/autogenerators/handlers/controller.rb

@@ -1,12 +1,14 @@
 require_relative '../../utils/rails_methods.rb'
 
 SKIP_MODEL = true?(ARGV[0])
-MODEL_NAME = ARGV[1]
+V2_GLOBAL = true?(ARGV[1])
+MODEL_NAME = ARGV[2]
 MODEL_PARAMS = ARGV
-2.times { |i| MODEL_PARAMS.shift }
+3.times { |i| MODEL_PARAMS.shift }
 
 MODEL_SNAKE_CASE = MODEL_NAME.underscore
 MODEL_CAMEL_CASE = MODEL_NAME.camelize
+GLOBAL_CONTROLLER = V2_GLOBAL ? 'V2::GlobalController' : 'GlobalController'
 
 system("bash #{__dir__}/../bash_commands/generate_model.sh #{MODEL_CAMEL_CASE} #{MODEL_PARAMS.join(' ')}") if !SKIP_MODEL
 system("bash #{__dir__}/../bash_commands/generate_controller.sh #{MODEL_SNAKE_CASE} --no-assets --no-view-specs --no-helper")
@@ -17,5 +19,6 @@ template_path = "#{__dir__}/../generator_templates/controller.txt"
 read_file = File.open(template_path, 'r:UTF-8', &:read)
 
 read_file = read_file.gsub! '{{ MODEL }}', MODEL_CAMEL_CASE
+read_file = read_file.gsub! '{{ GLOBAL_CONTROLLER }}', GLOBAL_CONTROLLER
 
 File.write(controller_path, read_file)

data/lib/autogenerators/rails_templates/api_documentation.rake

@@ -63,7 +63,7 @@ namespace :api_documentation do
       
       var routeName = allData.route.split('/').map(e => paramObject[e] ? paramObject[e] : e).join('/');
       
-      if (allData.method !== 'GET' || allData.method !== 'DELETE') {
+      if (allData.method !== 'GET') {
       var bodyDataType = document.getElementById('#{camelCased}DataType') && document.getElementById('#{camelCased}DataType').value ? document.getElementById('#{camelCased}DataType').value : false;
       var formBoolean = bodyDataType === 'Form Data';
       
@@ -132,7 +132,7 @@ namespace :api_documentation do
         }
       }
       
-      var args = allData.method === 'GET' || allData.method === 'DELETE' ? [routeName + querystring, csrfHeader] : [routeName + querystring, bodyObject, csrfHeader];
+      var args = allData.method === 'GET' ? [routeName + querystring, csrfHeader] : [routeName + querystring, bodyObject, csrfHeader];
       var resultElement = document.getElementById('#{camelCased}-results');
       
       axios[allData.method.toLowerCase()](...args)

data/lib/autogenerators/rails_templates/documentation_controller.rb

@@ -99,7 +99,7 @@ class DocumentationController < ApplicationController
         submitButtonColor: submit_button_color,
         camelCased: camel_cased,
         allowParams: temp_route.split(':').length > 1,
-        allowBody: method == 'GET' ? false : method != 'DELETE',
+        allowBody: method != 'GET',
         description: description,
       }
     end

data/lib/constants/cli_constants.rb

@@ -36,8 +36,11 @@ List of commands:
             "This command runs the same as 'rails generate model --help'.
             
 Use the parameters in 'rails generate model' to generate your CRUD operators.
+AVR only Option:
+--v2=true => Add GlobalController version v2
+
 Optional flag options are:
---no-model => Do not generate a model in this command
+--no-model=true => Do not generate a model in this command
 --skip=<options-separated-by-a-comma-for-multiple-options>
     Skip Options:
 #{opts.join("\n")}

data/lib/constants/options.rb

@@ -2,7 +2,7 @@ class CLIOptions
     class <<self
 
         def gem_version
-            "0.1.2"
+            "0.1.3"
         end
 
         def ascii_art

data/lib/rails_on_rails.rb

@@ -77,6 +77,7 @@ class Commander < CLIOptions
                 all_action_methods = [:generate_test_seeder, :generate_test_rspec]
                 skip_options = options[:skip]
                 no_model = !options[:"no-model"].nil?
+                v2 = !options[:"v2"].nil?
                 skipping = {}
                 if skip_options
                     skipping = skip_options.split(',').flat_map { |e| skip_model_controller_options[e.to_sym] }.select { |e| e.nil? == false }.each_with_object({}) do |e, acc|
@@ -86,7 +87,7 @@ class Commander < CLIOptions
                 end
                 all_action_methods = all_action_methods.reject { |e| skipping[e].nil? == false }
                 path = __dir__ + '/autogenerators/handlers/controller.rb'
-                system("ruby #{path} #{no_model} #{arguments.join(' ')}")
+                system("ruby #{path} #{no_model} #{v2} #{arguments.join(' ')}")
                 all_action_methods.each { |e| method(e).call(*args) }
                 puts "Finished generating model and controller for #{args[2]}"
             end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_on_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Aidan Miles
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A scaffolding tool for your Rails projects!