devise-better_routes 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/rails_app/db/*.sqlite3
+spec/rails_app/log
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise-better_routes.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Toru KAWAMURA
+
+MIT License
+
+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/README.md

@@ -0,0 +1,76 @@
+# Devise::BetterRoutes
+
+Better routes patch for Devise
+
+## One of the issues of Devise
+
+    # config/routes.rb
+    devise_for :users
+
+Devise makes the following registration routes:
+
+           user_registration POST   /users(.:format)         devise/registrations#create
+       new_user_registration GET    /users/sign_up(.:format) devise/registrations#new
+    cancel_user_registration GET    /users/cancel(.:format)  devise/registrations#cancel
+      edit_user_registration GET    /users/edit(.:format)    devise/registrations#edit
+                             PATCH  /users(.:format)         devise/registrations#update
+                             PUT    /users(.:format)         devise/registrations#update
+                             DELETE /users(.:format)         devise/registrations#destroy
+
+These routes have a few problems.
+
+* These confuse the resource which represents "all users" and the resource which represents "myself"
+* What is the "registrations" which does not correspond to URL?
+
+## Solution
+
+`#create` and `#new` are the actions for all users.
+The rest are the actions for myself.
+
+Therefore, it should make two distinct resources.
+
+
+Using this gem makes the following routes:
+
+                  users POST   /users(.:format)               users#create
+               new_user GET    /users/new(.:format)           users#new
+    cancel_current_user GET    /current_user/cancel(.:format) current_users#cancel
+      edit_current_user GET    /current_user/edit(.:format)   current_users#edit
+           current_user PATCH  /current_user(.:format)        current_users#update
+                        PUT    /current_user(.:format)        current_users#update
+                        DELETE /current_user(.:format)        current_users#destroy
+
+And also makes delegating URL helpers, such as `new_registration_path` -> `new_user_path`.
+Default views of Devise just work fine.
+
+(However, you should not use `registration` helper anymore because a registration resource does not exist.)
+
+Then you can create two controllers as follows:
+
+    # app/controllers/users_controller.rb
+    class UsersController < Devise::RegistrationsController
+    end
+
+    # app/controllers/current_users_controller.rb
+    class CurrentUsersController < Devise::RegistrationsController
+    end
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'devise-better_routes'
+
+And then execute:
+
+    $ bundle
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/devise-better_routes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise/better_routes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'devise-better_routes'
+  spec.version       = Devise::BetterRoutes::VERSION
+  spec.authors       = ['Toru KAWAMURA']
+  spec.email         = ['tkawa@4bit.net']
+  spec.description   = %q{Better routes patch for Devise}
+  spec.summary       = %q{Better routes patch for Devise}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'devise', '>= 3.0.0.rc'
+  spec.add_dependency 'rails', '>= 4.0.0.rc1'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/devise/better_routes.rb

@@ -0,0 +1,72 @@
+require 'devise'
+require 'action_dispatch'
+require 'active_support'
+require 'devise/better_routes/version'
+
+module Devise
+  module Controllers
+    module UrlHelpers
+      def self.override_registration_helpers!(registration_routes = nil)
+        helper_mappings = {
+          new_registration: 'new_#{scope}',
+          edit_registration: 'edit_current_#{scope}',
+          cancel_registration: 'cancel_current_#{scope}'
+        }
+        [:path, :url].each do |path_or_url|
+          class_eval <<-URL_HELPERS, __FILE__, __LINE__ + 1
+            def registration_#{path_or_url}(resource_or_scope, *args)
+              scope = Devise::Mapping.find_scope!(resource_or_scope)
+              if respond_to?(:controller_name) && controller_name == "current_\#{scope.to_s.pluralize}"
+                send("current_\#{scope}_#{path_or_url}", *args)
+              else
+                send("\#{scope.to_s.pluralize}_#{path_or_url}", *args)
+              end
+            end
+          URL_HELPERS
+          helper_mappings.each do |old_name, new_name|
+            method = "#{old_name}_#{path_or_url}"
+            class_eval <<-URL_HELPERS, __FILE__, __LINE__ + 1
+              def #{method}(resource_or_scope, *args)
+                scope = Devise::Mapping.find_scope!(resource_or_scope)
+                send("#{new_name}_#{path_or_url}", *args)
+              end
+            URL_HELPERS
+          end
+        end
+      end
+      override_registration_helpers!(Devise::URL_HELPERS[:registration])
+
+      def self.run_generate_hooks!
+        self.override_registration_helpers!(Devise::URL_HELPERS[:registration])
+      end
+    end
+  end
+
+  def self.regenerate_helpers!
+    Devise::Controllers::UrlHelpers.remove_helpers!
+    Devise::Controllers::UrlHelpers.generate_helpers!
+    Devise::Controllers::UrlHelpers.run_generate_hooks!
+  end
+end
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      protected
+        def devise_registration(mapping, controllers)
+          path, as, @scope[:path], @scope[:as] = @scope[:path], @scope[:as], nil, nil
+          current_resource_name = mapping.path_names["current_#{mapping.singular}".to_sym]
+          resources mapping.path, only: [:create, :new]
+          resource current_resource_name, only: [:edit, :update, :destroy] do
+            get :cancel
+          end
+        ensure
+          @scope[:path], @scope[:as] = path, as
+        end
+    end
+  end
+end
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.uncountable %w( my me )
+end

data/lib/devise/better_routes/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module BetterRoutes
+    VERSION = "0.0.1"
+  end
+end

data/spec/devise/better_routes_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe Devise::BetterRoutes do
+  it 'expect to have a version number' do
+    expect(Devise::BetterRoutes::VERSION).not_to be_nil
+  end
+
+  context 'routing' do
+    include RSpec::Rails::RoutingExampleGroup
+    describe 'users' do
+      it 'routes to users#create' do
+        expect(post('/users')).to route_to('users#create')
+      end
+      it 'routes to users#new' do
+        expect(get('/users/new')).to route_to('users#new')
+      end
+      it 'routes to current_users#cancel' do
+        expect(get('/current_user/cancel')).to route_to('current_users#cancel')
+      end
+      it 'routes to current_users#edit' do
+        expect(get('/current_user/edit')).to route_to('current_users#edit')
+      end
+      it 'routes to current_users#update' do
+        expect(put('/current_user')).to route_to('current_users#update')
+        #expect(patch('/current_user')).to route_to('current_users#update')
+      end
+      it 'routes to current_users#destroy' do
+        expect(delete('/current_user')).to route_to('current_users#destroy')
+      end
+    end
+
+    describe 'rails_programmers' do
+      it 'routes to rails_programmers#create' do
+        expect(post('/rails_programmers')).to route_to('rails_programmers#create')
+      end
+      it 'routes to rails_programmers#new' do
+        expect(get('/rails_programmers/new')).to route_to('rails_programmers#new')
+      end
+      it 'routes to current_rails_programmers#cancel' do
+        expect(get('/current_rails_programmer/cancel')).to route_to('current_rails_programmers#cancel')
+      end
+      it 'routes to current_rails_programmers#edit' do
+        expect(get('/current_rails_programmer/edit')).to route_to('current_rails_programmers#edit')
+      end
+      it 'routes to current_rails_programmers#update' do
+        expect(put('/current_rails_programmer')).to route_to('current_rails_programmers#update')
+        #expect(patch('/current_rails_programmer')).to route_to('current_rails_programmers#update')
+      end
+      it 'routes to current_rails_programmers#destroy' do
+        expect(delete('/current_rails_programmer')).to route_to('current_rails_programmers#destroy')
+      end
+    end
+  end
+
+  context 'URL helpers' do
+    include Rails.application.routes.url_helpers
+    include Devise::Controllers::UrlHelpers
+    describe 'users' do
+      specify { expect(users_path).to eq '/users' }
+      specify { expect(new_user_path).to eq '/users/new' }
+      specify { expect(cancel_current_user_path).to eq '/current_user/cancel' }
+      specify { expect(edit_current_user_path).to eq '/current_user/edit' }
+      specify { expect(current_user_path).to eq '/current_user' }
+      it 'registration_path is delegated to users_path' do
+        expect(registration_path(:user)).to eq users_path
+      end
+      it 'registration_path is delegated to current_user_path on current_users' do
+        instance_eval { def controller_name; 'current_users' end }
+        expect(registration_path(:user)).to eq current_user_path
+        instance_eval { undef controller_name }
+      end
+      it 'new_registration_path is delegated to new_user_path' do
+        expect(new_registration_path(:user)).to eq new_user_path
+      end
+      it 'cancel_registration_path is delegated to cancel_current_user_path' do
+        expect(cancel_registration_path(:user)).to eq cancel_current_user_path
+      end
+      it 'edit_registration_path is delegated to edit_current_user_path' do
+        expect(edit_registration_path(:user)).to eq edit_current_user_path
+      end
+    end
+
+    describe 'rails_programmers' do
+      specify { expect(rails_programmers_path).to eq '/rails_programmers' }
+      specify { expect(new_rails_programmer_path).to eq '/rails_programmers/new' }
+      specify { expect(cancel_current_rails_programmer_path).to eq '/current_rails_programmer/cancel' }
+      specify { expect(edit_current_rails_programmer_path).to eq '/current_rails_programmer/edit' }
+      specify { expect(current_rails_programmer_path).to eq '/current_rails_programmer' }
+      it 'registration_path is delegated to rails_programmers_path' do
+        expect(registration_path(:rails_programmer)).to eq rails_programmers_path
+      end
+      it 'registration_path is delegated to current_rails_programmer_path on current_rails_programmers' do
+        instance_eval { def controller_name; 'current_rails_programmers' end }
+        expect(registration_path(:rails_programmer)).to eq current_rails_programmer_path
+        instance_eval { undef controller_name }
+      end
+      it 'new_registration_path is delegated to new_rails_programmer_path' do
+        expect(new_registration_path(:rails_programmer)).to eq new_rails_programmer_path
+      end
+      it 'cancel_registration_path is delegated to cancel_current_rails_programmer_path' do
+        expect(cancel_registration_path(:rails_programmer)).to eq cancel_current_rails_programmer_path
+      end
+      it 'edit_registration_path is delegated to edit_current_rails_programmer_path' do
+        expect(edit_registration_path(:rails_programmer)).to eq edit_current_rails_programmer_path
+      end
+    end
+  end
+end

data/spec/rails_app/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__)
+
+RailsApp::Application.load_tasks

data/spec/rails_app/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/rails_app/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/spec/rails_app/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/spec/rails_app/app/controllers/current_rails_programmers_controller.rb

@@ -0,0 +1,2 @@
+class CurrentRailsProgrammersController < Devise::RegistrationsController
+end

data/spec/rails_app/app/controllers/current_users_controller.rb

@@ -0,0 +1,2 @@
+class CurrentUsersController < Devise::RegistrationsController
+end

data/spec/rails_app/app/controllers/rails_programmers_controller.rb

@@ -0,0 +1,2 @@
+class RailsProgrammersController < Devise::RegistrationsController
+end

data/spec/rails_app/app/controllers/users_controller.rb

@@ -0,0 +1,2 @@
+class UsersController < Devise::RegistrationsController
+end

data/spec/rails_app/app/helpers/application_helper.rb

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

data/spec/rails_app/app/models/rails_programmer.rb

@@ -0,0 +1,3 @@
+class RailsProgrammer < User
+  devise :registerable
+end

data/spec/rails_app/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  devise :registerable
+end

data/spec/rails_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>RailsApp</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>