rails_on_rails 0.0.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36958c631c1d24258e9702004ed3508e01cbb96fc73e0a8fc438f144e9e61c3c
+  data.tar.gz: d06ab2bf6e5dcc635cd1b5a9c877456a327cac3d559a2a4e15b7a6c5a9105982
+SHA512:
+  metadata.gz: 297087d5e99077cdb55c44498b2e71dded0ceab7fc6d4e50a0de308d08ba9407fc300c85885dd9c8002f08abaa1e58df3f3bb4c04ac9e1d749624a8f713e9659
+  data.tar.gz: a0de593f1c62b04e9f91a7d076f5dd22ca74188ba6407bcc34ef056ef979e376cca6554202845e0b85a8e6540e28de2161e5a86ea5cc97294e5d2d57907ce918

data/README.md

@@ -0,0 +1,149 @@
+# Rails on Rails
+
+All commands must be execute in your Rails root project directory
+
+## Installation
+Install in your gem file and a global install for this gem
+
+Global Install:
+`gem install rails_on_rails`
+
+Gemfile Install:
+`gem 'rails_on_rails'`
+
+## Gem Dependencies
+- 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 + 1
+If you run into hangups with spring, run `spring stop` before your `rails_on_rails`
+Then `spring server` to resume spring
+
+```
+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
+```
+config.after_initialize do
+    require 'rake'
+    Rails.application.reload_routes!
+    Rails.application.load_tasks
+    Rake::Task["api_documentation:frontend_javascript"].invoke
+end
+```
+
+In your `config/routes.rb` add this route for your documentation page
+```
+resources :documentation, only: :index
+```
+
+## Generate your CRUD Operations for Index, Show, Create, Update, & Destroy
+```
+rails_on_rails model <ModelName> <*rails-model-generate-parameters>
+```
+
+By default all our basic CRUD operations are complete for: Index, Show, Create, Update, & Destroy
+There are other functions you can use as well
+
+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)
+-- like: Like will be a custom where string with a like operator all on all values given the string string format is a json object without curly brackets (Check the docs for your schema's options)
+-- order: Order will be a string passed into order the options are all separated by a comma in querystring (Check the docs for your schema's options)
+
+- Show:
+-- 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)
+
+### 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'
+The second value in the ActiveRecord you would like to use
+When using polymorphoric assocations, it is recommended to use a hash map of types and 
+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
+```
+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
+```
+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`
+```
+rsources :user, except: [:edit, :new] do 
+    collection do 
+        post 'duplicate'
+        post 'bulk_create'
+        post 'bulk_csv_create'
+        put 'bulk_update'
+        delete 'bulk_destroy'
+    end
+end
+```
+
+## 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.
+```
+var csrfHeader = { headers: { 'X-CSRF-Token': null, 'Accept': 'application/json', 'Content-Type': 'application/json' } };
+```
+
+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>`
+
+Anything after and including the question mark is a querystring
+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>
+
+Those options are given in the description for the endpoint you are testing
+
+- Include will grab any associated tables with that endpoint
+- Where will grab data where the options are true
+- Like will grab data where the options are true but can be partially correct for searching
+- 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
+

data/bin/rails_on_rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+
+require 'rails_on_rails'
+Commander.actions(ARGV)

data/lib/autogenerators/bash_commands/generate_controller.sh

@@ -0,0 +1 @@
+rails generate controller $@

data/lib/autogenerators/bash_commands/generate_model.sh

@@ -0,0 +1 @@
+rails generate model $@

data/lib/autogenerators/bash_commands/install_rspec.sh

@@ -0,0 +1 @@
+rails generate rspec:install

data/lib/autogenerators/generator_templates/application_record.txt

@@ -0,0 +1,8 @@
+  def upsert find, create
+    existing = self.find_by(find)
+    if existing
+        self.where(find).update(create).first
+    else
+        self.create(create)
+    end
+  end

data/lib/autogenerators/generator_templates/controller.txt

@@ -0,0 +1,14 @@
+class {{ MODEL }}Controller < GlobalController
+
+  def model 
+    { model: {{ MODEL }} }
+  end
+
+  def default_options
+    {}
+  end
+
+  def render_params
+    handle_params({{ PARAMS }})
+  end
+end

data/lib/autogenerators/generator_templates/test_rspec_controller.txt

@@ -0,0 +1,169 @@
+require "rails_helper"
+
+
+route_name = "{{ API_ROUTE }}"
+config_routes = {
+  index: true,
+  show: true,
+  create: true,
+  update: true,
+  destroy: true,
+}
+
+RSpec.configure {|c| c.before { expect(controller).not_to be_nil }}
+RSpec.describe {{ MODEL }}Controller, type: :request do
+
+  created = nil
+  created_2 = nil
+
+  blacklist = {}
+  associations = get_associations({{ MODEL }}).reject { |e| blacklist[e.to_sym] }
+
+  includes = include_querystrings(associations)
+  wheres = where_querystrings([
+    { id: 1 },
+  ])
+  likes = like_querystrings([
+    { id: 1 },
+  ])
+  order = order_querystrings([
+    'id',
+    'created_at',
+    'updated_at',
+  ])
+
+  pagination_querystrings = concat_all_with_default([
+    includes,
+    wheres,
+    likes,
+    order,
+  ])
+
+  show_querystrings = concat_all_with_default([
+    includes,
+  ])
+
+  if config_routes[:index]
+    pagination_querystrings.each do |val|
+      it "No Auth: Index: No 500 errors" do
+        get "#{route_name}?#{val}"
+        expect(response.status).to be < 500
+      end
+
+      it "Index: No 500 errors" do
+        get "#{route_name}?#{val}", headers: @headers
+        expect(response.status).to be < 500
+      end
+
+      it "Index: Body Format" do
+        get "#{route_name}?#{val}", headers: @headers
+        @resp = JSON.parse(response.body)
+        @check = @resp.is_a?(Hash) && @resp["data"].is_a?(Array) && @resp["count"] >= @resp["data"].length
+        expect(@check).to be true
+      end
+    end
+  end
+
+  if config_routes[:show]
+    show_querystrings.each do |val|
+      it "No Auth: Show: No 500 errors" do
+        get "#{route_name}/1?#{val}"
+        expect(response.status).to be < 500
+      end
+
+      it "Show: No 500 errors" do
+        get "#{route_name}/1?#{val}", headers: @headers
+        expect(response.status).to be < 500
+      end
+
+      it "Show: Body Format" do
+        get "#{route_name}/1?#{val}", headers: @headers
+        @resp = JSON.parse(response.body)
+        @check = @resp.is_a?(Hash)
+        expect(@check).to be true
+      end
+    end
+  end
+
+  if config_routes[:create]
+    it "No Auth: Create: No 500 errors" do
+      post "#{route_name}", params: {}
+      expect(response.status).to be < 500
+    end
+
+    it "Create: No 500 errors" do
+      post "#{route_name}", params: {}, headers: @headers
+      created = JSON.parse(response.body)
+      expect(response.status).to be < 500
+    end
+
+    it "Create: Body Format" do
+      post "#{route_name}", params: {}, headers: @headers
+      @resp = JSON.parse(response.body)
+      created_2 = @resp
+      @check = @resp.is_a?(Hash)
+      expect(@check).to be true
+    end
+  end
+
+  if config_routes[:update]
+    it "No Auth: Update: No 500 errors" do
+      patch "#{route_name}/1", params: {}
+      expect(response.status).to be < 500
+    end
+
+    it "Update: No 500 errors" do
+      patch "#{route_name}/1", params: {}, headers: @headers
+      expect(response.status).to be < 500
+    end
+
+    it "Update: Body Format" do
+      patch "#{route_name}/1", params: {}, headers: @headers
+      @resp = JSON.parse(response.body)
+      @check = @resp.is_a?(Array)
+      expect(@check).to be true
+    end
+
+    it "No Auth: Update: No 500 errors" do
+      put "#{route_name}/1", params: {}
+      expect(response.status).to be < 500
+    end
+
+    it "Update: No 500 errors" do
+      put "#{route_name}/1", params: {}, headers: @headers
+      expect(response.status).to be < 500
+    end
+
+    it "Update: Body Format" do
+      put "#{route_name}/1", params: {}, headers: @headers
+      @resp = JSON.parse(response.body)
+      @check = @resp.is_a?(Array)
+      expect(@check).to be true
+    end
+  end
+
+  if config_routes[:destroy]
+    it "No Auth: Destroy: No 500 errors" do
+      past = created ? created.symbolize_keys : { id: 6 }
+      id = past[:id]
+      delete "#{route_name}/#{id}"
+      expect(response.status).to be < 500
+    end
+
+    it "Destroy: No 500 errors" do
+      past = created ? created.symbolize_keys : { id: 6 }
+      id = past[:id]
+      delete "#{route_name}/#{id}", headers: @headers
+      expect(response.status).to be < 500
+    end
+
+    it "Destroy: Body Format" do
+      past = created_2 ? created_2.symbolize_keys : { id: 7 }
+      id = past[:id]
+      delete "#{route_name}/#{id}", headers: @headers
+      @resp = response.body
+      @check = @resp == ''
+      expect(@check).to be true
+    end
+  end
+end

data/lib/autogenerators/generator_templates/test_seeder.txt

@@ -0,0 +1,45 @@
+require 'faker'
+
+def upsert find, create
+  existing = {{ MODEL }}.find_by(find)
+  if existing
+      {{ MODEL }}.where(find).update(create).first
+  else
+      {{ MODEL }}.create(create)
+  end
+end
+
+time = 5
+
+black_list = {
+  id: true,
+  created_at: true,
+  updated_at: true,
+}
+
+columns = {{ MODEL }}.columns_hash.map do |key, val| 
+  { key: key.to_sym, data_type: val.type } 
+end.select { |e| !black_list[e[:key]] }
+
+array = []
+time.times do 
+  obj = columns.each_with_object({}) do |e, acc|
+    key = e[:key]
+    if e[:data_type] == :string
+      acc[key] = Faker::Lorem.sentence.to_s
+    elsif  e[:data_type] == :datetime
+      acc[key] = DateTime.now
+    elsif  e[:data_type] == :integer
+      acc[key] = 1
+    elsif  e[:data_type] == :boolean
+      acc[key] = false
+    elsif  e[:data_type] == :text
+      acc[key] = Faker::Lorem.paragraph.to_s
+    end
+  end
+  array.push(obj)
+end
+
+array.each_with_index do |e, i|
+  upsert({ id: i + 1 }, e)
+end

data/lib/autogenerators/handlers/controller.rb

@@ -0,0 +1,28 @@
+require_relative '../../utils/rails_methods.rb'
+
+MODEL_NAME = ARGV[0]
+MODEL_PARAMS = ARGV
+MODEL_PARAMS.shift
+
+MODEL_SNAKE_CASE = MODEL_NAME.underscore
+
+system("bash #{__dir__}/../bash_commands/generate_model.sh #{MODEL_NAME} #{MODEL_PARAMS.join(' ')}")
+system("bash #{__dir__}/../bash_commands/generate_controller.sh #{MODEL_SNAKE_CASE} --no-assets --no-view-specs --no-helper")
+
+controller_path = "#{Dir.pwd}/app/controllers/#{MODEL_SNAKE_CASE}_controller.rb"
+template_path = "#{__dir__}/../generator_templates/controller.txt"
+
+read_file = File.open(template_path, 'r:UTF-8', &:read)
+length = MODEL_PARAMS.length
+
+PARAMS_STRING = MODEL_PARAMS.map do |item|
+  str = ''
+  key, type = item.split(':')
+  str += type == 'references' ? "[:#{key}, " + "#{key.split('_').map(&:capitalize!).join('')}]" : ":#{key}"
+  str
+end.join(', ')
+
+read_file = read_file.gsub! '{{ MODEL }}', MODEL_NAME
+read_file = read_file.gsub! '{{ PARAMS }}', PARAMS_STRING
+
+File.write(controller_path, read_file)