railspp 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 437ff81dcb23189dfa9a0aba36d7f354cc88b52223763e43dc96cb352051376c
-  data.tar.gz: 4999dc0e3501275b63c67053b089b89014f6a31c48db8b3a5d22d08b251aacbf
+  metadata.gz: b407a28c73d30980a7d66982621dcdb85fa5e08a49bf39e7ad98efb33dd4ab46
+  data.tar.gz: f2ebc4d1de1011b96f5da1aba75c6b285c0f63b686df3ff57aac63469a672fba
 SHA512:
-  metadata.gz: 025e81527e86528ecbab90cc4fce2160288cbe5cb6001fb2eaf6dd98a7bda24de288f9941f4df4a108a17d2d41207cf5254be8ade1a1467c0d9f2884f847cf16
-  data.tar.gz: 12efabc32329cdf717f2a88fe33dc7a7403edfc618336254a038a4530b3fe3b835e3a71310cc4b27c8d66eb57b0039217547eac1fa777b57d131a631c9756d26
+  metadata.gz: 180e7c08b9988dd129576484d6b3e4e8341dd87e2d6e36d955fa94987db5c5e8c3221061c44c4e18e119ff5b05faf920bbfec8da9aca41ca5cd3ba005a957ee9
+  data.tar.gz: 241a004800dd76cb0408bf7419b7543fdfb5560a2c3668ab055ae5be9463796a2619b7783e3db94f84125a6910261a349c65a5b1bd2ce55a45964f8ea1be0bdb

data/lib/commands/api_docs.rb

@@ -0,0 +1,50 @@
+require_relative '../utils/strings.rb'
+
+
+class ApiDocsCommand < MoreUtils
+  class << self
+
+    def run(*args)
+      lookup = flag_lookup(args)
+
+      # Add Initializers
+      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)
+
+      # 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)
+
+      # Add 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}\n" + routes_arr.slice(last_end_line, routes_arr.length).join("\n")
+      write_file("#{root}/config/routes.rb", new_routes)
+      
+      puts "Added Automatic API documentation to your project."
+    end
+
+    def last_end_index arr
+      arr.each_with_index.inject(0) do |acc, (e, i)|
+        acc = i if /(namespace)/.match(e) && acc == 0
+        acc
+      end
+    end
+
+  end
+end

data/lib/commands/initialize.rb

@@ -11,13 +11,7 @@ class InitializeCommand < MoreUtils
             cors_template = get_file_str("#{this_dir}/../templates/rack_cors_initializer.txt")
             write_file("#{root}/config/initializers/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)
 
@@ -28,22 +22,9 @@ class InitializeCommand < MoreUtils
             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.has_key?(:"skip-routes")
-                routes_template = get_file_str("#{this_dir}/../templates/routes_documentation.txt")
+                routes_template = get_file_str("#{this_dir}/../templates/routes_namespace.txt")
                 routes_file = get_file_str("#{root}/config/routes.rb")
                 routes_arr = routes_file.split("\n")
                 last_end_line = last_end_index(routes_arr)

data/lib/commands/update_version.rb

@@ -13,13 +13,6 @@ class UpdateVersionCommand < MoreUtils
             gc_template = get_file_str("#{this_dir}/../templates/response.txt")
             write_file("#{root}/app/controllers/concerns/response.rb", gc_template)
 
-            # dc_template = get_file_str("#{this_dir}/../templates/documentation_controller.txt")
-            # write_file("#{root}/app/controllers/documentation_controller.rb", dc_template)
-
-            # Add Service
-            # aps_template = get_file_str("#{this_dir}/../templates/api_documentation_service.txt")
-            # write_file("#{root}/app/services/api_documentation_service.rb", aps_template)
-
             puts "Updated your code base for Rails Plus Plus version: #{gem_version}"
         end
 

data/lib/help/api_docs.rb

@@ -0,0 +1,16 @@
+require_relative '../utils/strings.rb'
+
+
+class ApiDocsHelpCommand < MoreUtils
+  class << self
+
+    def run(*args)
+      puts "No Options available
+
+Update your version of rails plus plus in your code base:
+'railspp api_docs'
+"
+    end
+
+  end
+end

data/lib/railspp.rb

@@ -1,7 +1,9 @@
 require_relative './commands/initialize.rb'
+require_relative './commands/api_docs.rb'
 require_relative './commands/model.rb'
 require_relative './commands/make_test.rb'
 require_relative './commands/update_version.rb'
+require_relative './help/api_docs.rb'
 require_relative './help/documentation.rb'
 require_relative './help/initialize.rb'
 require_relative './help/model.rb'
@@ -49,6 +51,8 @@ class RailsPlusPlus < MoreUtils
         make_test: MakeTestCommand,
         uv: UpdateVersionCommand,
         update_version: UpdateVersionCommand,
+        ad: ApiDocsCommand,
+        api_docs: ApiDocsCommand,
       }
     end
 
@@ -63,6 +67,8 @@ class RailsPlusPlus < MoreUtils
         make_test: MakeTestHelpCommand,
         uv: UpdateVersionHelpCommand,
         update_version: UpdateVersionHelpCommand,
+        ad: ApiDocsHelpCommand,
+        api_docs: ApiDocsHelpCommand,
       }
     end
 
@@ -75,6 +81,8 @@ class RailsPlusPlus < MoreUtils
         '- model => Generate your CRUD model, controller, and migration',
         '- mt => Generate a unit test in minitest',
         '- make_test => Generate a unit test in minitest',
+        '- ad => Initialize your api documentation',
+        '- api_docs => Initialize your api documentation',
         '- uv => Update your version of Rails Plus Plus in your code base',
         '- update_version => Update your version of Rails Plus Plus in your code base',
       ]

data/lib/templates/routes.txt

@@ -0,0 +1,8 @@
+  namespace :api, except: [:new, :edit] do
+    # Add API Routes here
+
+    # For API version 1
+    namespace :v1 do
+        
+    end
+  end

data/lib/templates/routes_documentation.txt

@@ -1,10 +1 @@
-  resources :documentation, only: :index
-  
-  namespace :api, except: [:new, :edit] do
-    # Add API Routes here
-
-    # For API version 1
-    namespace :v1 do
-        
-    end
-  end
+  resources :documentation, only: :index

data/lib/templates/routes_namespace.txt

@@ -1,10 +1,8 @@
-  resources :documentation, only: :index
-  
-  namespace :api do
+  namespace :api, except: [:new, :edit] do
     # Add API Routes here
 
     # For API version 1
     namespace :v1 do
         
     end
-  end
+  end

data/lib/utils/strings.rb

@@ -21,7 +21,7 @@ class MoreUtils
     class << self
 
         def gem_version
-            "0.3.3"
+            "0.3.4"
         end
 
         def get_file_str path

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: railspp
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Layne Faler
@@ -61,10 +61,12 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/railspp
+- lib/commands/api_docs.rb
 - lib/commands/initialize.rb
 - lib/commands/make_test.rb
 - lib/commands/model.rb
 - lib/commands/update_version.rb
+- lib/help/api_docs.rb
 - lib/help/documentation.rb
 - lib/help/initialize.rb
 - lib/help/make_test.rb
@@ -82,6 +84,7 @@ files:
 - lib/templates/mini_test_controller.txt
 - lib/templates/rack_cors_initializer.txt
 - lib/templates/response.txt
+- lib/templates/routes.txt
 - lib/templates/routes_documentation.txt
 - lib/templates/routes_namespace.txt
 - lib/utils/strings.rb