swag 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3730514a48c593969d65e0aade3f9bf8815dfb95
-  data.tar.gz: 758d3304a1a983fc7524ffee0922f9159ecd646e
+  metadata.gz: 09b2a6509fa9e6cfecd0f8c3a23a1471d46b6533
+  data.tar.gz: 0cc410a101873e72f5cf5273643c791e95a1d95f
 SHA512:
-  metadata.gz: 3587fa2c131e746227ca579033b04e8e91ff57d698ce30c0daa419ed83c3ca3ae124fbddabb64997d74817807264a1ea0b30b32cc6911a5c8d32e79019e43e99
-  data.tar.gz: c5cd06424ba1437643174145a57c60b4c6b02123591ff93e0da7489bf9f0e83a63c16bf443166869dce6d2976e253ca92ff05cbf8543b041b8dc2e6084b35ae0
+  metadata.gz: 6d85e83d050badd528c08134088c228efc6150da7ec3ae7d3961edbfdeb310eeab8716c647053c31445075fcae1dbecf5e23859ab4e74da740701d94b85416f8
+  data.tar.gz: 6b2df6f230f22b788b05af90acb9b5ec03e164f6c09ac9333ac417ad77ea608503e57003cf41b10002baf69dd449a77b3acd09c1377c4c9a850246f18739e914

data/lib/Swag.rb

@@ -0,0 +1,88 @@
+require_relative 'SwagHelper.rb'
+
+class Swag
+
+	@helper = SwagHelper.new
+
+	def initialize
+	end
+
+	def self.hi
+    	puts "Swag, world."
+	end
+
+	# verifies rails directory
+	def self.check
+		puts "Checking your directory: #{Dir.pwd}"
+    	if File.exist?("bin/rails")
+    		puts "Rails App detected. Proceeding."
+    	else
+    		puts "You must be in a Rails root directory for Swag to work. Aborting."
+    		abort
+    	end
+	end
+
+	# checks that app/controllers can be read
+	def self.checkControllers
+    	puts "Checking controllers."
+		begin
+			Dir.foreach("app/controllers") do |c|
+					puts "Found #{c}"
+				end
+    		rescue => ex
+    			puts "Error while reading controllers."
+					puts ex.inspect
+					puts ex.backtrace
+		end # end begin
+	end # end checkControllers
+
+	# writes specific controller's routes (helper for self.writePaths)
+	# 'controllerName' is the controller's name, 'doc' is the open File
+	def self.analyzeController(controllerName, doc)
+		puts "Analyzing controller: #{controllerName}"
+
+		# edits the controller name for use in the File
+		nameSliced = controllerName.slice(0..(controllerName.index('_') -1))
+		doc << "  /#{nameSliced}:\n"
+
+		File.open("app/controllers/#{controllerName}", 'r') do |c|
+			@show = false
+			c.each_line do |line|
+				if line.include? "def index"
+					@helper.doIndex(controllerName, doc)
+				elsif line.include? "def create"
+					@helper.doCreate(controllerName, doc)
+				elsif line.include? "def show"
+					@show = true
+				end
+			end # end each_line do block
+			if @show
+				@helper.doShow(nameSliced, controllerName, doc)
+			end
+		end # end File.open do block (File is closed automatically)
+	end # end analyzeController
+
+	# lists controller paths by reading app/controllers directory
+	def self.writePaths
+    	puts "Writing paths."
+		begin
+			# creates directory for swag to use
+			Dir.mkdir("swagGem") unless File.exists?("swagGem")
+
+			doc = File.open("swagGem/api.yml", 'w')
+			doc << "info: Generated with Swag.\n"
+			doc << "paths:\n"
+			Dir.foreach("app/controllers") do |c|
+				unless (c == "." || c == ".." || c == "concerns" ||
+					c == "application_controller.rb")
+					analyzeController(c, doc)
+				end
+			end
+	  	doc.close
+			rescue => ex
+				puts "Error while writing paths."
+				puts ex.inspect
+				puts ex.backtrace
+		end # end begin block
+	end # end writePaths
+end # end Class

data/lib/SwagHelper.rb

@@ -0,0 +1,32 @@
+class SwagHelper
+
+  def initialize
+  end
+
+  # writes config info to YAML doc
+  def doConfig(doc)
+    # open config file (make one if it doesn't exist)
+    # read line-by-line
+    # write relevant information to doc
+    doc << "info: Generated with Swag.\n"
+    doc << "paths:\n"
+  end
+
+  # prints index info to open YAML File 'doc'
+  def doIndex(controllerName, doc)
+    puts "#{controllerName} contains index"
+    doc << "    get:\n"
+    doc << "      description:\n"
+  end
+
+  def doCreate(controllerName, doc)
+    puts "#{controllerName} contains new"
+    doc << "    post:\n"
+    doc << "      description:\n"
+  end
+
+  def doShow(nameSliced, controllerName, doc)
+    puts "#{controllerName} contains show"
+    doc << "  /#{nameSliced}/:id\n"
+  end
+end # end class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Ethan Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-04 00:00:00.000000000 Z
+date: 2015-08-05 00:00:00.000000000 Z
 dependencies: []
 description: |-
   A gem with which to generate YAML from a Rails app. Currently
@@ -20,7 +20,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/swag
-- lib/swag.rb
+- lib/Swag.rb
+- lib/SwagHelper.rb
 homepage: http://rubygems.org/gems/swag
 licenses:
 - ''

data/lib/swag.rb

@@ -1,79 +0,0 @@
-class Swag
-	def initialize
-	end
-	def self.hi
-    	puts "Swag, world."
-	end
-
-	# verifies rails directory
-	def self.check
-		puts "Checking your directory: #{Dir.pwd}"
-    	if File.exist?("bin/rails")
-    		puts "Rails App detected. Proceeding."
-    	else
-    		puts "You must be in a Rails root directory for Swag to work. Aborting."
-    		abort
-    	end
-	end
-
-	# checks that app/controllers can be read
-	def self.checkControllers
-    	puts "Checking controllers."
-		begin
-		Dir.foreach("app/controllers") do |c|
-				puts "Found #{c}"
-		end
-    	rescue => ex
-    		puts "Error while reading controllers."
-			puts ex.inspect
-			puts ex.backtrace
-		end
-	end
-
-	# writes specific controller's routes (helper for self.writePaths)
-	# 'name' is the controller's name, 'doc' is the open YAML File to write to
-	def self.analyzeController(controllerName, doc)
-		puts "Analyzing controller: #{controllerName}"
-		# controller = File.open("app/controllers/#{controllerName}", 'r')
-		nameSliced = controllerName.slice(0..(controllerName.index('_') -1))
-		doc << "  /#{nameSliced}:\n"
-		File.open("app/controllers/#{controllerName}", 'r') do |c|
-			@show = false
-			c.each_line do |line|
-				if line.include? "def index"
-					puts "#{controllerName} contains index"
-					doc << "    get:\n"
-					doc << "      description:\n"
-				elsif line.include? "def create"
-					puts "#{controllerName} contains new"
-					doc << "    post:\n"
-					doc << "      description:\n"
-				elsif line.include? "def show"
-					@show = true
-				end
-			end # end each_line do block
-			if @show
-				puts "#{controllerName} contains show"
-				doc << "  /#{nameSliced}/:id\n"
-			end
-		end # end File.open do block
-		puts "Closed file." # closed automatically
-	end
-
-	# lists controller paths by reading app/controllers directory
-	def self.writePaths
-    	puts "Writing paths."
-		begin
-		doc = File.open("doc.yml", 'w')
-		doc << "info: Generated with Swag.\n"
-		doc << "paths:\n"
-		Dir.foreach("app/controllers") do |c|
-			unless (c == "." || c == ".." || c == "concerns" ||
-				c == "application_controller.rb")
-				analyzeController(c, doc)
-			end
-		end
-	  doc.close
-		end
-	end
-end