utopia 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 92b8e6466b0a5eea4cb1e6009734e9cea5c76160
-  data.tar.gz: 9854cb98bf4f4ac5794fe19370c3af2e28aec456
+  metadata.gz: 1e43b609f07c8331def9621c56b40b2f9298d35b
+  data.tar.gz: d137536094afd723da06e757ab0112b85dd31c50
 SHA512:
-  metadata.gz: fdc050063c8b3b7ece0d94ee388fec013f52adc0cc2f63f92a7e4bb94eb849a8ecbfb41664a183047475adc88f5959b019077edc5cdbb9061eb8b8a8057a2a60
-  data.tar.gz: 781fe07c015abd3d777f2b4cd0340d43deee4846ca05ec2171c882569bd56add14604cc54ae5276b414dc778be77d2be7c86e90835a4793abb1df52b462b4117
+  metadata.gz: a6513105d8c673492b3f5c4269d6b25d28aab62e95f875c94a78fa48b727784c17c5a53b667c449ca60fdd6db88f04d5556b2f1e8d4f6320321dec3bb3956557
+  data.tar.gz: 79fc5393a3babeea2f1cb03328d551c11dc8166f0693e862855fee02a3e215114282a77e3fd4c353d547efafb86f9a639d80f7a4ad098e93abadc52dd94b34ec

data/.travis.yml

@@ -6,7 +6,7 @@ before_install:
   - git config --global user.name "Samuel Williams"
 rvm:
   - 2.2.4
-  - 2.3.0
+  - 2.3.2
   - ruby-head
   - rbx-3.65
 env: COVERAGE=true BENCHMARK=true

data/README.md

@@ -205,10 +205,6 @@ The controller layer can do more complex operations by prepending modules into i
 		@user = User.find_by_id(@id)
 	end
 
-	before do |request, path|
-		# Always executed, before any controller specific actions are performed.
-	end
-
 	on 'edit' do |request, path|
 		if request.post?
 			@user.update_attributes(request[:user])
@@ -217,10 +213,7 @@ The controller layer can do more complex operations by prepending modules into i
 	
 	otherwise do |request, path|
 		# Executed if no specific named actions were executed.
-	end
-	
-	after do |request, path|
-		# Always executed, after all other controller actions are performed.
+		succeed!
 	end
 
 ### Content

data/documentation/pages/wiki/content.md

@@ -4,4 +4,8 @@ This wiki includes documentation and examples showing how to use Utopia.
 
 - [Development Environment Setup](development-environment-setup/)
 - [Server Setup](server-setup/)
-- [Your first page](your-first-page/)
+- [Your first page](your-first-page/)
+
+## Advanced Topics
+
+- [Rewriting URLs](rewriting-urls/)

data/documentation/pages/wiki/controller.rb

@@ -23,8 +23,6 @@ def read_contents
 end
 
 on '**/edit' do |request, path|
-	puts "Editing..."
-	
 	if request.post?
 		FileUtils.mkdir_p File.dirname(@page_file)
 		File.write(@page_file, request.params['content'])

data/documentation/pages/wiki/rewriting-urls/content.md

@@ -0,0 +1,41 @@
+# Rewriting URLs
+
+The `Controller::Rewrite` layer can match and rewrite requests before they processed. This allows you to have URLs like `/post/15/view` or `/blog/123-pictures-of-my-cat`. The basic rewrite operation is to extract some part of the path prefix. That means that the path is modified before being passed on to the next layer in the controller.
+
+## Permalink Example
+
+In your `controller.rb`:
+
+	prepend Actions, Rewrite
+	
+	rewrite.extract_prefix permalink: /(?<id>\d+)-(?<title>.*)/ do |request, path, match|
+		# The rewrite matched, but there was no valid post, so we fail:
+		fail! unless @post = Post.find(@permalink[:id])
+		
+		# If the path matched, but there was no suffix, we make it default to the post action:
+		if match.post_match.empty?
+			match.post_match.components << "post"
+		end
+	end
+	
+	on 'post' do
+		# You can do further processing here.
+		fail! unless @post.published?
+		
+		@comments = @post.comments.first(5)
+	end
+
+	on 'edit' do
+		# You can do further processing here.
+		fail! unless @current_user&.editor?
+	end
+
+In your `post.xnode`, as an example:
+
+	<page>
+		<heading>Post #{attributes[:permalink][:id]} about #{attributes[:permalink][:title]}</heading>
+		
+		<p>#{attributes[:post].content}</p>
+	</page>
+
+Keep in mind, that URLs like `/123-pictures-of-my-cat/edit` will work as expected, and hit the `edit` action of the controller.

data/lib/utopia/controller/actions.rb

@@ -61,6 +61,7 @@ module Utopia
 				def apply(path, index = -1, &block)
 					# ** is greedy, it always matches if possible and matches all remaining input.
 					if match_all = self[WILDCARD_GREEDY] and match_all.callback?
+						# It's possible in this callback that path is modified.
 						matched = true; yield(match_all)
 					end
 					
@@ -112,6 +113,13 @@ module Utopia
 			end
 			
 			module ClassMethods
+				def self.extended(klass)
+					klass.instance_eval do
+						@actions = nil
+						@otherwise = nil
+					end
+				end
+				
 				def actions
 					@actions ||= Action.new
 				end
@@ -124,19 +132,23 @@ module Utopia
 					actions.define(Path.split(first) + path, options, &block)
 				end
 				
+				def otherwise(&block)
+					@otherwise = block
+				end
+				
 				def dispatch(controller, request, path)
 					if @actions
-						@actions.apply(path.components) do |action|
+						matched = @actions.apply(path.components) do |action|
 							controller.instance_exec(request, path, &action.callback)
-						end || controller.otherwise(request, path)
+						end
+					end
+					
+					if @otherwise and !matched
+						controller.instance_exec(request, path, &@otherwise)
 					end
 				end
 			end
 			
-			# TODO: Test this functionality and confirm working. Document.
-			def otherwise(request, path)
-			end
-			
 			# Given a request, call associated actions if at least one exists.
 			def process!(request, path)
 				# puts "Actions\#process!(..., #{path.inspect})"

data/lib/utopia/controller/rewrite.rb

@@ -35,23 +35,6 @@ module Utopia
 			end
 			
 			class Rule
-				def initialize(arguments, block)
-					@arguments = arguments
-					@block = block
-					
-					self.freeze
-				end
-				
-				def freeze
-					@arguments.freeze
-					@block.freeze
-					
-					super
-				end
-				
-				attr :arguments
-				attr :block
-				
 				def apply_match_to_context(match_data, context)
 					match_data.names.each do |name|
 						context.instance_variable_set("@#{name}", match_data[name])
@@ -60,14 +43,14 @@ module Utopia
 			end
 			
 			class ExtractPrefixRule < Rule
-				def initialize(arguments, block)
-					@matcher = Path::Matcher.new(arguments)
-					
-					super
+				def initialize(patterns, block)
+					@matcher = Path::Matcher.new(patterns)
+					@block = block
 				end
 				
 				def freeze
 					@matcher.freeze
+					@block.freeze
 					
 					super
 				end
@@ -94,8 +77,8 @@ module Utopia
 				
 				attr :rules
 				
-				def extract_prefix(**arguments, &block)
-					@rules << ExtractPrefixRule.new(arguments, block)
+				def extract_prefix(**patterns, &block)
+					@rules << ExtractPrefixRule.new(patterns, block)
 				end
 				
 				def apply(context, request, path)

data/lib/utopia/path.rb

@@ -82,6 +82,10 @@ module Utopia
 			super
 		end
 		
+		def empty?
+			@components.empty?
+		end
+		
 		def self.root
 			self.new([''])
 		end

data/lib/utopia/path/matcher.rb

@@ -70,18 +70,21 @@ module Utopia
 				
 				named_parts = {}
 				
-				@patterns.each_with_index do |(key, matcher), index|
+				@patterns.each_with_index do |(key, pattern), index|
 					component = components[index]
 					
-					if matcher.is_a? Class
-						return nil unless value = coerce(matcher, component)
+					if pattern.is_a? Class
+						return nil unless value = coerce(pattern, component)
 						
 						named_parts[key] = value
-					elsif matcher
-						return nil unless matcher === component
-						
-						named_parts[key] = component
+					elsif pattern
+						if result = pattern.match(component)
+							named_parts[key] = result
+						else
+							return nil
+						end
 					else
+						# Ignore this part:
 						named_parts[key] = component
 					end
 				end

data/lib/utopia/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "1.9.0"
+	VERSION = "1.9.1"
 end

data/spec/utopia/path/matcher_spec.rb

@@ -52,12 +52,12 @@ module Utopia::Path::MatcherSpec
 		
 		it "should match regexps" do
 			path = Utopia::Path['users/20/edit']
-			matcher = Utopia::Path::Matcher[users: 'users', id: Integer, action: String]
+			matcher = Utopia::Path::Matcher[users: /users/, id: Integer, action: String]
 			
 			match_data = matcher.match(path)
 			expect(match_data).to_not be_falsey
 			
-			expect(match_data[:users]).to be == 'users'
+			expect(match_data[:users].to_s).to be == 'users'
 			expect(match_data[:id]).to be == 20
 			expect(match_data[:action]).to be == 'edit'
 		end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -204,6 +204,7 @@ files:
 - documentation/pages/wiki/controller.rb
 - documentation/pages/wiki/development-environment-setup/content.md
 - documentation/pages/wiki/edit.xnode
+- documentation/pages/wiki/rewriting-urls/content.md
 - documentation/pages/wiki/server-setup/content.md
 - documentation/pages/wiki/show.xnode
 - documentation/pages/wiki/your-first-page/content.md
@@ -394,7 +395,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Utopia is a framework for building dynamic content-driven websites.