valid_route 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f4afca94e7e2a46d340d2474c9f5b12b386ecf37
+  data.tar.gz: dfad34ddb57e360b42cb6f7c6fdc410dde50970f
+SHA512:
+  metadata.gz: c8875fba33475ae9c7733a59127329e2ef89d46370acd6bbd13a2058ee4a164144cec08bb100efa74ae22b47396b9d40b01a1c55c5e461c6c2fc3aab37681f51
+  data.tar.gz: 5d78d64ddad6cdb9f7dc6b65e5b8be6f6fad450ab7c373f0d0ed75dfda7889121c03b2ae8f4970855c290a06ebb950c3395fc919b4fabd09fb51220d1e6397eb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Vince Montalbano
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,19 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/valid_route_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :valid_route do
+#   # Task goes here
+# end

data/lib/valid_route/all.rb

@@ -0,0 +1,2 @@
+require 'valid_route/route_formatter'
+require 'valid_route/route_validator'

data/lib/valid_route/route_formatter.rb

@@ -0,0 +1,36 @@
+module ValidRoute
+	class RouteFormatter
+		def initialize
+			@buffer = []
+		end
+
+		def result
+			@buffer #.compact.uniq
+		end
+
+		def section_title(title)
+		end
+
+		def section(routes)
+			@buffer << array_paths(routes)
+			@buffer.flatten!
+		end
+
+		def header(routes)
+		end
+
+		def no_routes
+			@buffer
+		end
+
+		private
+		def array_paths(routes)
+			regexp = "(.:format)"
+			paths = []
+			routes.map do |r|
+				paths << {path: r[:path].sub(regexp, ""), verb: r[:verb], reqs: r[:reqs] }
+			end
+			paths
+		end
+	end
+end

data/lib/valid_route/route_validator.rb

@@ -0,0 +1,154 @@
+class RouteValidator < ActiveModel::EachValidator
+
+	def initialize(options)
+	  super
+	  scrub_options options
+	end
+
+	def validate_each(record, attribute, value)
+		# Get all Routes
+		inspector = ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes)
+		routes = inspector.format(ValidRoute::RouteFormatter.new)
+
+		routes = scrub_routes routes
+
+		conflicts = check_conflicts routes, record
+
+		
+
+		unless conflicts.empty?
+			record.errors[attribute] << (@options[:message] || "route is taken")
+		end
+	end
+
+	private
+	def check_conflicts(routes, record)
+		
+		# Get the Class of the record we want to validate
+		endpoint = record.class.name.underscore
+
+		conflicts = []
+
+		# Get the list of routes we want to create which may conflict with other routes based off of the controller
+		routes_to_create = []
+		routes.each { |result|
+			routes_to_create.push result if result[:reqs].include?(endpoint)
+		}
+
+
+		# Get all possibly conflicting paths (routes to the same path, unless it's a path for the current controller)
+		possible_conflicts = []
+		routes_to_create.each {|route_to_create|
+			routes.each {|route|
+				unless route == route_to_create
+					parameter = route_to_create[:path].split(/.*?(:[^\/]*)/).last || ""
+					substituted_route = route_to_create[:path].sub(parameter, record.to_param)
+					if (route[:path] == route_to_create[:path]) or (route[:path] == substituted_route)
+						possible_conflicts.push route 
+					end
+				end
+			}
+
+		}
+
+		# if there is an already existing route for a non-show and non-edit action, add it to the list of conflicting paths
+		possible_conflicts.each {|route|
+			routes_to_create.each {|route_to_create|
+				unless (route[:reqs].include?("#show") or route[:reqs].include?("#edit"))
+					parameter = route_to_create[:path].split(/.*?(:[^\/]*)/).last || ""
+					substituted_route = route_to_create[:path].sub(parameter, record.to_param)
+					if (route[:path] == route_to_create[:path]) or (route[:path] == substituted_route)
+						conflicts.push route
+					end
+				end
+			}
+		}
+
+		# Check for existing records of other Classes' Show actions, add it to the conflicting paths if the record at that path already exists
+		possible_conflicts.each {|route|
+			routes_to_create.each {|route_to_create|
+				if route[:reqs].include?("#show") or route[:reqs].include?("#edit")
+					if route[:reqs].include?("/") # is this a namespaced route or anything?
+						route_controller_segments = route[:reqs].split(/^(.*\/)(.*)$/)
+						klass_underscored = route_controller_segments[0] + route_controller_segments[1].singularize
+					else
+						klass_underscored = route[:reqs].slice(/(.*)(#)(.*)/, 1).singularize
+					end
+					klass = klass_underscored.classify.constantize
+					if klass.exists?(record.to_param)
+						conflicts.push route unless klass.find(record.to_param).eql? record
+					end
+					if record.class.exists?(record.to_param)
+						conflicts.push route unless record.class.find(record.to_param).eql? record
+					end
+				end
+			}
+		}
+
+		conflicts
+	end
+
+	def scrub_options(options)
+		unless options[:reserved_routes].nil?
+			options[:reserved_routes].map! { |route_path|
+				route_path = "/" + route_path if route_path[0] != "/"
+			}
+		end
+
+		unless options[:unreserved_routes].nil?
+			options[:unreserved_routes].map! { |route_path|
+				route_path = "/" + route_path if route_path[0] != "/"
+			}
+		end
+	end
+
+	def scrub_routes(routes)
+
+		# Add the additional routes 
+		unless @options[:reserved_routes].nil?
+			@options[:reserved_routes].each { |route_path|
+				# puts "valid_route:110 #{route_path}"
+				routes << {path: route_path, verb: 'GET', reqs: ''}
+			}
+		end
+
+		# Remove unreserved routes
+		unless @options[:unreserved_routes].nil?
+			routes.delete_if { |route|
+				route_included = false
+				@options[:unreserved_routes].each { |route_path|
+					# puts "valid_route:120 #{route[:path]} #{route_path}"
+					route_included = route_included || (route[:path] == route_path)
+				}
+				route_included
+			}
+		end
+
+		# Filter for matching GET requests only
+		routes.delete_if { |route|
+			delete = false
+			delete = route[:verb] != "GET" || delete
+			# delete = route[:reqs].include?("redirect") || delete
+			# delete
+		}
+
+		# Allow redirect paths 
+		routes.each {|route|
+			if route[:reqs].include?("redirect")
+				redirected_path = route[:reqs].slice(/.*redirect\(\d*,\s([^\)]*)\)/, 1)
+				delete_original = false
+				routes.each {|route_to_match|
+					if route_to_match[:path] == redirected_path
+						redirected_route = route.clone
+						redirected_route[:reqs] = route_to_match[:reqs]
+						routes << redirected_route
+						delete_original = true
+					end
+				}
+				routes.delete route if delete_original
+			end
+		}
+
+		routes.compact.flatten.uniq
+	end
+end

data/lib/valid_route/version.rb

@@ -0,0 +1,3 @@
+module ValidRoute
+  VERSION = "0.0.1"
+end

data/lib/valid_route.rb

@@ -0,0 +1 @@
+require 'valid_route/all'

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/others.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/javascripts/pages.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/javascripts/users.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/assets/stylesheets/others.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/pages.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/test/dummy/app/assets/stylesheets/users.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/constraints/page_constraint.rb

@@ -0,0 +1,9 @@
+# http://robotslacker.com/2012/01/rails-3-routes-configuration-dynamic-segments-constraints-and-scope/
+class PageConstraint
+	def initialize
+	end
+
+	def matches?(request)
+		Page.exists?(request.path_parameters[:id])
+	end
+end

data/test/dummy/app/constraints/user_constraint.rb

@@ -0,0 +1,9 @@
+# http://robotslacker.com/2012/01/rails-3-routes-configuration-dynamic-segments-constraints-and-scope/
+class UserConstraint
+	def initialize
+	end
+
+	def matches?(request)
+		User.exists?(request.path_parameters[:id])
+	end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/others_controller.rb

@@ -0,0 +1,58 @@
+class OthersController < ApplicationController
+  before_action :set_other, only: [:show, :edit, :update, :destroy]
+
+  # GET /others
+  def index
+    @others = Other.all
+  end
+
+  # GET /others/1
+  def show
+  end
+
+  # GET /others/new
+  def new
+    @other = Other.new
+  end
+
+  # GET /others/1/edit
+  def edit
+  end
+
+  # POST /others
+  def create
+    @other = Other.new(other_params)
+
+    if @other.save
+      redirect_to @other, notice: 'Other was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PATCH/PUT /others/1
+  def update
+    if @other.update(other_params)
+      redirect_to @other, notice: 'Other was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /others/1
+  def destroy
+    @other.destroy
+    redirect_to others_url, notice: 'Other was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_other
+      @other = Other.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def other_params
+      params.require(:other).permit(:name, :permalink, :content)
+    end
+end

data/test/dummy/app/controllers/pages_controller.rb

@@ -0,0 +1,58 @@
+class PagesController < ApplicationController
+  before_action :set_page, only: [:show, :edit, :update, :destroy]
+
+  # GET /pages
+  def index
+    @pages = Page.all
+  end
+
+  # GET /pages/1
+  def show
+  end
+
+  # GET /pages/new
+  def new
+    @page = Page.new
+  end
+
+  # GET /pages/1/edit
+  def edit
+  end
+
+  # POST /pages
+  def create
+    @page = Page.new(page_params)
+
+    if @page.save
+      redirect_to @page, notice: 'Page was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PATCH/PUT /pages/1
+  def update
+    if @page.update(page_params)
+      redirect_to @page, notice: 'Page was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /pages/1
+  def destroy
+    @page.destroy
+    redirect_to pages_url, notice: 'Page was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_page
+      @page = Page.find_by_permalink(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def page_params
+      params.require(:page).permit(:name, :permalink, :content)
+    end
+end

data/test/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,58 @@
+class UsersController < ApplicationController
+  before_action :set_user, only: [:show, :edit, :update, :destroy]
+
+  # GET /users
+  def index
+    @users = User.all
+  end
+
+  # GET /users/1
+  def show
+  end
+
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+
+  # GET /users/1/edit
+  def edit
+  end
+
+  # POST /users
+  def create
+    @user = User.new(user_params)
+
+    if @user.save
+      redirect_to @user, notice: 'User was successfully created.'
+    else
+      render action: 'new'
+    end
+  end
+
+  # PATCH/PUT /users/1
+  def update
+    if @user.update(user_params)
+      redirect_to @user, notice: 'User was successfully updated.'
+    else
+      render action: 'edit'
+    end
+  end
+
+  # DELETE /users/1
+  def destroy
+    @user.destroy
+    redirect_to users_url, notice: 'User was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_user
+      @user = User.find_by_username(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def user_params
+      params.require(:user).permit(:username, :password, :first_name)
+    end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/others_helper.rb

@@ -0,0 +1,2 @@
+module OthersHelper
+end

data/test/dummy/app/helpers/pages_helper.rb

@@ -0,0 +1,2 @@
+module PagesHelper
+end

data/test/dummy/app/helpers/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelper
+end

data/test/dummy/app/models/other.rb

@@ -0,0 +1,19 @@
+class Other < ActiveRecord::Base
+	# rails g scaffold Other name:string permalink:string content:text
+
+	validates :permalink, :route => { unreserved_routes: ["pages"] }
+
+	validates_format_of :permalink, :without => /^\d/, :multiline => true
+	
+	def self.find(input)
+		input.to_i == 0 ? find_by_permalink(input) : super(input)
+	end
+
+	def self.exists?(input)
+		input.to_i == 0 ? super(permalink: input) : super(input)
+	end
+
+	def to_param  # overridden
+		self.permalink
+	end
+end

data/test/dummy/app/models/page.rb

@@ -0,0 +1,22 @@
+class Page < ActiveRecord::Base
+	# rails g scaffold Page name:string permalink:string content:text slug:string
+
+	# extend FriendlyId
+	# friendly_id :permalink #, use: :slugged
+
+	validates :permalink, :route => {reserved_routes: ["reserved", "tommy"]}
+
+	validates_format_of :permalink, :without => /^\d/, :multiline => true
+	
+	def self.find(input)
+		input.to_i == 0 ? find_by_permalink(input) : super(input)
+	end
+
+	def self.exists?(input)
+		input.to_i == 0 ? super(permalink: input) : super(input)
+	end
+
+	def to_param  # overridden
+		self.permalink
+	end
+end