woah 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2719ba8762336269cf1ec3b13117229a772bb954bbcc9134360df30e7b62665f
-  data.tar.gz: 65b23b7632a6db0add321ed2a86c2c0ea310733d5f1a35ea4394155c57a8ea3a
+  metadata.gz: 1f1640d590890f586e4b4d0f4a05fb83bc47d4e3a444496eaa634def37be851d
+  data.tar.gz: cf163513135e99c8998c317a70bfb120849d15c835164ebcb5f01787db6a8d6e
 SHA512:
-  metadata.gz: 9e12c37e93d46e8add7645b7b5178440f044205cf9e333c86dcfd75f570100cef96df1fe0d1076e08b330d28ffd54e5a1a40653d78a36a4efdb92d3e0cee8a92
-  data.tar.gz: 57b835da89e4967122b33a16b60a446fc6c1d9884e662a508d97d513f56959a87e3787552d891832ce53611ad940b3529e79a0457a1e4ac16258758413e78159
+  metadata.gz: e98ff9bee429818defe3dd9582059cb2949b10cfd1b8c85bdd2c84c8aabac4bf354d84f474d5852cee5261d6e083d52d0b53f86f460aba736dc7d4fb3bb2e3fa
+  data.tar.gz: c956a1ae35bf2a132aab05fbd10a27c72b2da3bd2d73adb5e917e187203dd7e21d191c85506187bd1c40e2f2cda2daf736a76d88a420a45fda0c32fd9dc2f988

data/README.md

@@ -8,7 +8,7 @@ Woah! is a minimal web framework built on Rack. It's primary design goal is to b
 `gem install woah`
 
 ## What now???
-Easy. You're gonna want to extend Woah::Base, which will be your app's, er, base.
+Simple. You're gonna want to extend Woah::Base, which will be your app's, er, base.
 
 ```ruby
 require 'woah'
@@ -55,4 +55,69 @@ end
 
 There's two new blocks here: `before` and `after`. They do things before and after the relevant route gets executed (duh!). This example will increment a counter everytime a page is hit, regardless of what page it is.
 
-More to come.
+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 ||=
+		'<form action="/" method="post">'\
+			'<input type="submit" value="click me please" />'\
+		'</form>'
+	end
+
+	on '/' do
+		@@content
+	end
+
+	on '/', 'POST' do
+		@@content = 'thanks for clicking!'
+	end
+end
+```
+
+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 %{^/greet/(\w+)$} do
+		"oh, hello, I didn't see you there #{match[1]}"
+	end
+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.
+
+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)'
+	end
+
+	on %r{^/pass/(\w+)$} do
+		@password = match[1]
+		'logged in! <a href="/">back to root</a>'
+	end
+
+	after do
+		unless @password && @password == 'penguin'
+			set :status, 403
+			set :body, 'log in first!'
+		end
+	end
+end
+
+MyApp.run!
+```
+
+That's all. Have fun!

data/lib/woah.rb

@@ -2,7 +2,7 @@
 
 require 'rack'
 
-# Woah! is a single-file web framework
+# Woah! is a minimal web framework based on Rack.
 module Woah
 end
 

data/lib/woah/base.rb

@@ -5,53 +5,87 @@ module Woah
 	class Base
 		@@before = nil
 		@@after = nil
-		@@routes = {}
+		@@match_data = nil
+		@@routes = []
 
-		# answer the phone
-		def self.call(env)
-			route = @@routes[[env['REQUEST_URI'], env['REQUEST_METHOD']]]
+		def call(env)
 			@@override = {}
+			@@match_data = nil
 
 			@@before&.call
 
-			return [404, { 'Content-Type' => 'text/html; charset=utf-8' }, 'not found L:'] if route.nil?
+			response = handle_route env
+
+			@@after&.call
 
-			response = route.execute
 			%i[status headers body].each do |r|
 				response[r] = @@override[r] unless @@override[r].nil?
 			end
-			@@after&.call
 
 			response.values
 		end
 
-		# register new routes
-		def self.on(path, method = 'GET', &action)
-			raise 'unknown method' unless %w[DELETE GET HEAD OPTIONS PATCH POST PUT].include? method
-			@@routes[[path, method]] = Route.new(path, method, &action)
-		end
+		private
 
-		# things to do before handling the routes
-		def self.before(&action)
-			@@before = action
-		end
+		def handle_route(env)
+			route = @@routes.select { |r| r.matches?(env['REQUEST_METHOD'], env['REQUEST_URI']) }[0]
 
-		# things to do after handling the routes
-		def self.after(&action)
-			@@after = action
+			if route.nil?
+				return {
+					status: 404,
+					headers: { 'Content-Type' => 'text/html; charset=utf-8' },
+					body: 'not found L:'
+				}
+			end
+
+			@@match_data = route.match_data if route.match_data
+
+			route.execute
 		end
 
-		# override an item in the response
-		def self.set(item, content)
-			unless %i[status headers body].include? item
-				raise 'unknown item ' + item.to_s + ', cannot override'
+		class << self
+			# Get this show on the road.
+			def run!(port = 4422)
+				Rack::Handler.pick(%w[thin webrick]).run new, Port: port
+			end
+
+			# Answer the phone.
+			# Finds a relevant route for the parameters in env,
+			# and builds a response.
+			def call(env)
+				new.call env
 			end
-			@@override[item] = content
-		end
 
-		# get this show on the road
-		def self.run!(port = 4422)
-			Rack::Handler.pick(%w[thin webrick]).run new, Port: port
+			# Register new routes. The optional method argument can be used to specify a method.
+			def on(path, method = 'GET', &action)
+				raise 'unknown method' unless %w[DELETE GET HEAD OPTIONS PATCH POST PUT].include? method
+
+				@@routes.push Route.new(path, method, &action)
+			end
+
+			# Action that will be called before every route.
+			def before(&action)
+				@@before = action
+			end
+
+			# Action that will be called after every route.
+			def after(&action)
+				@@after = action
+			end
+
+			# Override an item in the response.
+			def set(item, content)
+				unless %i[status headers body].include? item
+					raise 'unknown item ' + item.to_s + ', cannot override'
+				end
+
+				@@override[item] = content
+			end
+
+			# Get match data from Regexp routes.
+			def match
+				@@match_data
+			end
 		end
 	end
 end

data/lib/woah/route.rb

@@ -3,12 +3,28 @@
 module Woah
 	# Holds Woah! routes
 	class Route
+		attr_accessor :match_data
+
 		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
+		end
+
+		# Returns true if the combination of method and path matches 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
+			end
 		end
 
+		# Execute this route's actions.
 		def execute
 			status = 200
 			headers = { 'Content-Type' => 'text/html; charset=utf-8' }

data/lib/woah/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module Woah
-	VERSION = '0.0.2'
+	# Woah!'s current version.
+	VERSION = '1.0.0'
 end

data/test/before_after_test.rb

@@ -6,7 +6,7 @@ class BeforeAfterTest < MiniTest::Test
 	end
 
 	def test_get_before
-		@env['REQUEST_URI'] = '/before_after'
+		@env['REQUEST_URI'] = '/before'
 		@env['REQUEST_METHOD'] = 'GET'
 
 		response = TestApp.call @env
@@ -14,9 +14,11 @@ class BeforeAfterTest < MiniTest::Test
 		assert_equal 200, response[0]
 		assert_equal 'chunky', response[2]
 
+		@env['REQUEST_URI'] = '/after'
+
 		response = TestApp.call @env
 
 		assert_equal 200, response[0]
-		assert_equal 'bacon', TestApp.time
+		assert_equal 'bacon', response[2]
 	end
 end

data/test/on_method_test.rb

@@ -19,6 +19,36 @@ class OnMethodTest < MiniTest::Test
 		assert_equal "it's a secret to everybody", response[2]
 	end
 
+	def test_regexp_path
+		TestApp.on %r{^/regex/[0-9]+$} do
+			'heya'
+		end
+
+		@env['REQUEST_URI'] = '/regex/22'
+		@env['REQUEST_METHOD'] = 'GET'
+		response = TestApp.call @env
+
+		assert_equal 200, response[0]
+
+		@env['REQUEST_URI'] = '/regex/seventy'
+		response = TestApp.call @env
+
+		assert_equal 404, response[0]
+	end
+
+	def test_regexp_match_data
+		TestApp.on %r{^/myname/(\w+)$} do
+			'hi there, ' + TestApp.match[1]
+		end
+
+		@env['REQUEST_URI'] = '/myname/Charles'
+		@env['REQUEST_METHOD'] = 'GET'
+		response = TestApp.call @env
+
+		assert_equal 200, response[0]
+		assert_equal 'hi there, Charles', response[2]
+	end
+
 	def test_illegal_method
 		assert_raises RuntimeError do
 			TestApp.on '/', 'BUBBLES' do

data/test/testapp.rb

@@ -4,7 +4,7 @@ require_relative '../lib/woah'
 
 class TestApp < Woah::Base
 	before do
-		@@time = 'chunky'
+		@a = 'chunky'
 	end
 
 	on '/' do
@@ -15,15 +15,15 @@ class TestApp < Woah::Base
 		'got post!'
 	end
 
-	on '/before_after' do
-		@@time
+	on '/before' do
+		@a
 	end
 
-	after do
-		@@time = 'bacon'
+	on '/after' do
+		@b
 	end
 
-	def self.time
-		@@time
+	after do
+		@b = 'bacon'
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: woah
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - knarka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-23 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack