woah 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a7f6211c5dacf60338f865cd7face92231a0cf7e2b2c02301ccb416d5144c0e
-  data.tar.gz: 1c8df2df731ea7c0bb95616a779898ebd355b54da1ee2b01e7155f8a75ac9486
+  metadata.gz: 9301cad20ebaf896c239f25ade186b723f9f01a09493557590fbaff7da1bb610
+  data.tar.gz: 7165d88451d5d03d397e38602818ac2d972b7b4384e6cbaa97dd1419024c9c7c
 SHA512:
-  metadata.gz: 1909f2ef0ea817668f647971dcca48aee227ca5c64f4754ffa4e1fe23f46513868b1219dde364973d1cc2cb3a8a94661a9eba13b54618586714242ff6461afc4
-  data.tar.gz: 53d7572bb39289c0c4d886ab26cb78bd0f09151bc997230dcbf49de29e6b7bc4c133822cf7197100bcd58e64d56b8daa020a0926c06c93ed8bf7e405b3be46bc
+  metadata.gz: aa9663c853c588d9c2bf66f2b2be756233e4b5a76e7d795fe65fdec9adfc1aa0f3619e76693db42a70ab49162aaaa5446b7966114f64438caf7c4fd550d5452e
+  data.tar.gz: b562426f30b5b5a0aa0123a0e34fbfe5ed196d59a8e46dc683e48833dd1f9ae55e828b033fca637329ca9c00921382e9aa64ce612904364ef72658a9dbd247b8

data/README.md

@@ -9,20 +9,22 @@ Woah! is an unobtrusive, (extremely) minimal web framework built on Rack.
 `gem install woah`
 
 ## What do I do with it???
-Simple. You're gonna want to extend Woah::Base, which will be your app's, er, base.
+You're gonna want to extend Woah::Base, which will be your app's, er, base.
 
 ```ruby
 require 'woah'
 
 class MyApp < Woah::Base
 end
+
+MyApp.run!
 ```
 
-Woah, that's easy. Now let's add a route.
+You now have an app that serves 404 errors on every route. Not very useful, so let's extend that.
 
-```ruby
-require 'woah'
+By the way, the lines `require 'woah'` and `MyApp.run!` will always be necessary, but to keep this file a little neater, they'll be omitted in the next examples. Just pretend they're there.
 
+```ruby
 class MyApp < Woah::Base
 	on '/hello' do
 		"hey, what's up"
@@ -30,11 +32,9 @@ class MyApp < Woah::Base
 end
 ```
 
-When someone stumbles upon `/hello` now, they'll be greeted properly. Nice. We call these blocks of code **routes**. There's more types of blocks than just routes though. Check this out:
+When someone stumbles upon `/hello` now, they'll be greeted properly. Nice. These blocks of code are called **routes**. There's more types of blocks than just routes though. Check this out:
 
 ```ruby
-require 'woah'
-
 class MyApp < Woah::Base
 	before do
 		@@num ||= 1
@@ -59,8 +59,6 @@ There's two new blocks here: `before` and `after`. They do things before and aft
 Of course, getting pages isn't everything you can do on the Internet. There's other HTTP verbs as well, like POST. Behold:
 
 ```ruby
-require 'woah'
-
 class MyApp < Woah::Base
 	before do
 		@@content ||=
@@ -84,8 +82,6 @@ As soon as you click the button on `/`, the message on the page will transform.
 Of course, sometimes you want routes to be flexible, and to catch more than one expression. For this, you can use regular expressions instead of strings as your routes, just like this:
 
 ```ruby
-require 'woah'
-
 class MyApp < Woah::Base
 	on %r{^/greet/(\w+)$} do
 		"oh, hello, I didn't see you there #{match[1]}"
@@ -93,13 +89,11 @@ class MyApp < Woah::Base
 end
 ```
 
-Now, visiting `/greet/Socrates` will greet you with your own name. Wonderful. By the way, you may have noticed we're using `%r{}` to delimit our regex, instead of the more common `//`. This is because of how common slashes are in routes, so it's recommended to use this syntax. You can use slashes to delimit your regex though, if you like. I won't judge you.
+Now, visiting `/greet/Socrates` will greet you with your own name. Wonderful. By the way, you may have noticed the regex here is delimited by `%r{}`, instead of the more common `//`. This is because of how common slashes are in routes, so it's recommended to use this syntax. You can use slashes to delimit your regex though, if you like. I won't judge you.
 
 Redirects are possible as well:
 
 ```ruby
-require 'woah'
-
 class MyApp < Woah::Base
 	on '/' do
 		redirect_to '/landing'
@@ -114,8 +108,6 @@ end
 So are cookies:
 
 ```ruby
-require 'woah'
-
 class MyApp < Woah::Base
 	on '/' do
 		cookie 'chunky' || 'no cookie set'
@@ -131,13 +123,11 @@ class MyApp < Woah::Base
 end
 ```
 
-Upon first visiting, this page will tell you there's no cookie set. After visiting `/set` however, it'll display `bacon`, as that is now the content of the `chunky` cookie. Visiting '/del' will delete the cookie again.
+Upon first visiting, this page will tell you there's no cookie set. After visiting `/set` however, it'll display `bacon`, as that is now the content of the `chunky` cookie. Visiting `/del` will delete the cookie again.
 
 We're nearing the end of this little guide already, I'm afraid. However, there's still one more trick you need to see. Look, sometimes, you might disagree with the things Woah! thinks up for you. That's why you can override everything Woah! is about to send, if you so please. Por exemplo:
 
 ```ruby
-require_relative 'lib/woah'
-
 class MyApp < Woah::Base
 	on '/' do
 		'(insert super secret information)'
@@ -155,8 +145,6 @@ class MyApp < Woah::Base
 		end
 	end
 end
-
-MyApp.run!
 ```
 
 That's all. Have fun!

data/lib/woah/base.rb

@@ -5,13 +5,13 @@ module Woah
 	class Base
 		@@before = nil
 		@@after = nil
-		@@match_data = nil
+		@@match = nil
 		@@request = nil
 		@@routes = []
 
 		def initialize
 			@@override = {}
-			@@match_data = nil
+			@@match = nil
 			@@response = nil
 		end
 
@@ -25,7 +25,7 @@ module Woah
 
 			@@before&.call
 
-			@@response = resolve_route env['REQUEST_METHOD'], env['REQUEST_URI']
+			@@response = resolve_route env['REQUEST_URI'], env['REQUEST_METHOD']
 
 			@@after&.call
 
@@ -46,7 +46,10 @@ module Woah
 		end
 
 		# Resolves and executes a round
-		def resolve_route(method, path)
+		# @param path [String, Regexp] the path to respond to
+		# @param method [String] the HHTP method to use
+		# @return [Hash] the route's response
+		def resolve_route(path, method)
 			route = @@routes.select { |r| r.matches?(method, path) }[0]
 
 			if route.nil?
@@ -57,22 +60,28 @@ module Woah
 				}
 			end
 
-			@@match_data = route.match_data if route.match_data
+			@@match = route.match if route.match
 
 			route.execute
 		end
 
 		class << self
+			# Forwards to a new instance's #call method
 			def call(env)
 				new.call env
 			end
 
 			# Get this show on the road.
+			# @host [String] the host to use
+			# @port [Integer] the port to use
 			def run!(host = '0.0.0.0', port = 4422)
 				Rack::Handler.pick(%w[thin puma]).run new, Host: host, Port: port
 			end
 
-			# Register new routes. The optional method argument can be used to specify a method.
+			# Register new routes. The optional method argument can be used to specify a method
+			# @param path [String, Regexp] the path to respond to
+			# @param method [String] the HHTP method to use
+			# @raise [ArgumentError] if `method` is not a valid HTTP method
 			def on(path, method = 'GET', &action)
 				unless %w[DELETE GET HEAD OPTIONS PATCH POST PUT].include? method
 					raise ArgumentError, 'Unknown method'
@@ -81,19 +90,22 @@ module Woah
 				@@routes.push Route.new(path, method, &action)
 			end
 
-			# Action that will be called before every route.
+			# Takes a block that will be executed after every route
 			def before(&action)
 				@@before = action
 			end
 
-			# Action that will be called after every route.
+			# Takes a block that will be executed after every route
 			def after(&action)
 				@@after = action
 			end
 
 			# Redirect to another route.
+			# @param path [String, Regexp] the path to redirect to
+			# @param method [String] the HTTP method to use
+			# @return [String] the redirect's body
 			def redirect_to(path, method = 'GET')
-				result = new.resolve_route method, path
+				result = new.resolve_route path, method
 
 				%i[status headers].each do |r|
 					set r, result[r]
@@ -103,6 +115,9 @@ module Woah
 			end
 
 			# Override an item in the response.
+			# @param item [:status, :headers, :body] the item to be overriden
+			# @param content the content to override the item with
+			# @raise [ArgumentError] if item is outside the range of accepted values
 			def set(item, content)
 				unless %i[status headers body].include? item
 					raise ArgumentError, "Unknown item #{item}, cannot override"
@@ -112,8 +127,9 @@ module Woah
 			end
 
 			# Set or read cookies
-			# Value should be either: nil, to read a cookie; a string, to set a cookie; or :delete, to
-			# delete a cookie
+			# Depending on the type of `value`, respectively reads, deletes, or sets a cookie
+			# @param key [String] the name of the cookie
+			# @param value [nil, :delete, String]
 			def cookie(key, value = nil)
 				# Read cookie
 				if value.nil?
@@ -139,12 +155,12 @@ module Woah
 				end
 			end
 
-			# Get match data from Regexp routes.
+			# Returns the value of class attribute match
 			def match
-				@@match_data
+				@@match
 			end
 
-			# Get request object
+			# Returns the value of class attribute request
 			def request
 				@@request
 			end

data/lib/woah/route.rb

@@ -1,30 +1,34 @@
 # frozen_string_literal: true
 
 module Woah
-	# Holds Woah! routes
+	# A Woah! routes
 	class Route
-		attr_accessor :match_data
+		attr_accessor :match
 
 		def initialize(path, method, &action)
 			raise 'only strings and regexps are valid paths' unless [String, Regexp].include? path.class
 			@path = path
 			@method = method
 			@action = action
-			@match_data = nil
+			@match = nil
 		end
 
-		# Returns true if the combination of method and path matches this route.
+		# Checks if a given route is the same as this one
+		# @param path [String, Regexp] the path to redirect to
+		# @param method [String] the HTTP method to use
+		# @return [Boolean] true if given method and path match this route
 		def matches?(method, path)
 			case @path
 			when String
 				@method == method && @path == path
 			when Regexp
-				@match_data = @path.match path
-				@method == method && @match_data
+				@match = @path.match path
+				@method == method && @match
 			end
 		end
 
 		# Execute this route's actions.
+		# @return [Hash] the route's response
 		def execute
 			status = 200
 			headers = { 'Content-Type' => 'text/html; charset=utf-8' }

data/lib/woah/version.rb

@@ -2,5 +2,5 @@
 
 module Woah
 	# Woah!'s current version.
-	VERSION = '1.2.0'
+	VERSION = '1.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woah
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - knarka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-14 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack