authorized_rails_scaffolds 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+._*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Morrall
+
+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,101 @@
+# authorized_rails_scaffolds
+
+Replaces Rails and RSpec's default generators with templates taking full advantage of Authentication, Authorization and Test Coverage.
+
+Originally Developed for Devise, CanCan and RSpec, the generated templates can be changed to handle most authorization, authentication and testing solutions with minimal effort.
+
+## Features
+
+### No Namespacing of Models
+
+- Removes the Controller's namespace from the generated Controllers, allowing `rails g scaffold_controller admin/example` to handle `Example` models by default.
+
+### Better RSpec Coverage for generated Controllers and Views
+
+- Standard behaviour is tested to ensure that all code functions as expected
+- Authenticated is tested, to ensure that users are refused access until they have signed in.
+- Authorization is tested, to ensure that users are only able to view content if they have access to it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'authorized_rails_scaffolds', :group => :development
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install authorized_rails_scaffolds
+
+## Usage
+
+`authorized_rails_scaffolds` is a development only gem that adds templates for quickly creating new controllers and views to be displayed primarily viewed with Twitter Bootstrap.
+
+Once you have run all the generators you want, you can remove the gem with no side effects.
+
+### Install Scaffold Templates
+
+`authorized_rails_scaffolds` provides a series of rails generators that replace the default scaffold templates generated by Rails.
+
+The generated Controllers require CanCan to be installed on your system, however it is possible change this behavour by uncommenting out the first line of each generated action manually.
+
+The generated Controller only handles Authorization and assumes Authentication is managed in the Application Controller or is added manually.
+
+You can install the generators by running:
+
+    $ rails generate authorized_rails_scaffolds:install_scaffold
+
+This gem doesn't override the default scaffold.css generated by `rails g scaffold`, however it works best with `rails g scaffold_controller`.
+
+For example:
+
+    rails g model FooBar name:string age:integer date_of_birth:date lunch_time:time programmer:boolean joined_at:datetime
+    rails g scaffold_controller Awesome/FooBar name:string age:integer date_of_birth:date lunch_time:time programmer:boolean joined_at:datetime
+
+### Install Spec Temlates
+
+`authorized_rails_scaffolds` provides a series of rspec generators that replace the default controller and view spec templates generated by RSpec. It will also add a ControllerMacros spec support helper to login and logout users.
+
+The generated specs assume you are have a FactoryGirl factory called `user`.
+
+You can install the generators by running:
+
+    $ rails generate authorized_rails_scaffolds:install_spec
+
+You will need to implement `login_unauthorized_user` and `login_user_with_ability` into your Controller specs.
+
+Installing Scaffold Controllers in Rails (`rails g scaffold_controller`) generates view and controller specs if RSpec is installed as a gem.
+
+## 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
+
+## License
+
+Copyright (c) 2013 Ben Morrall
+
+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 @@
+require "bundler/gem_tasks"

data/authorized_rails_scaffolds.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'authorized_rails_scaffolds/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "authorized_rails_scaffolds"
+  spec.version       = AuthorizedRailsScaffolds::VERSION
+  spec.authors       = ["bmorrall"]
+  spec.email         = ["bemo56@hotmail.com"]
+  spec.description   = %q{Creates scaffolds for Twitter Bootstrap with generated RSpec coverage}
+  spec.summary       = %q{Replaces Rails and RSpec's default generators with templates taking full advantage of Authentication (Devise), Authorization (CanCan) and Test Coverage (RSpec)}
+  spec.homepage      = "https://github.com/bmorrall/authorized_rails_scaffolds"
+  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 'railties', '>= 3.1'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/authorized_rails_scaffolds.rb

@@ -0,0 +1,5 @@
+require "authorized_rails_scaffolds/version"
+
+module AuthorizedRailsScaffolds
+  # Your code goes here...
+end

data/lib/authorized_rails_scaffolds/version.rb

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

data/lib/generators/authorized_rails_scaffolds/install_scaffold/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Installs scaffold templates that take advantage of Devise, CanCan and RSpec.
+
+Example:
+    rails generate authorized_rails_scaffolds:install_templates
+
+    This will create:
+        ERB view templates in lib/erb/scaffold
+        Scaffold controller templates in lib/rails/scaffold_controller

data/lib/generators/authorized_rails_scaffolds/install_scaffold/install_scaffold_generator.rb

@@ -0,0 +1,26 @@
+class AuthorizedRailsScaffolds::InstallScaffoldGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_erb_templates
+    copy_erb_template '_form.html.erb'
+    copy_erb_template 'edit.html.erb'
+    copy_erb_template 'index.html.erb'
+    copy_erb_template 'new.html.erb'
+    copy_erb_template 'show.html.erb'
+  end
+
+  def create_rails_templates
+    copy_rspec_template 'controller.rb'
+  end
+
+  protected
+
+  def copy_erb_template(template_name)
+    copy_file template_name, "lib/templates/erb/scaffold/#{template_name}"
+  end
+
+  def copy_rails_template(template_name)
+    copy_file template_name, "lib/templates/rails/scaffold_controller/#{template_name}"
+  end
+
+end

data/lib/generators/authorized_rails_scaffolds/install_scaffold/templates/_form.html.erb

@@ -0,0 +1,18 @@
+<%- singular_var_name = file_name -%>
+<%- a = singular_table_name.split(file_name, -1)[0..-2].join(file_name) %>
+<%- form_object_vars = a.blank? ? "@#{singular_var_name}" : "[:#{a.split('_').join(', :')}, @#{singular_var_name}]" -%>
+<%%= simple_form_for(<%= form_object_vars %>, :html => { class: 'form-horizontal' }) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit, :class => 'btn-primary' %>
+    <%%= link_to t('.cancel', :default => t("helpers.links.cancel")),
+                <%= index_helper %>_path, :class => 'btn' %>
+  </div>
+<%% end %>

data/lib/generators/authorized_rails_scaffolds/install_scaffold/templates/controller.rb

@@ -0,0 +1,107 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<%- singular_var_name = file_name -%>
+<%- plural_var_name = file_name.pluralize -%>
+<%- local_class_name = class_name.split("::")[-1] -%>
+<%- orm_instance = Rails::Generators::ActiveModel.new singular_var_name -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  load_and_authorize_resource
+
+  # GET <%= route_url %>
+  # GET <%= route_url %>.json
+  def index
+    # @<%= plural_var_name %> = <%= orm_class.all(local_class_name) %>
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json { render <%= key_value :json, "@#{plural_var_name}" %> }
+    end
+  end
+
+  # GET <%= route_url %>/1
+  # GET <%= route_url %>/1.json
+  def show
+    # @<%= singular_var_name %> = <%= orm_class.find(local_class_name, "params[:id]") %>
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json { render <%= key_value :json, "@#{singular_var_name}" %> }
+    end
+  end
+
+  # GET <%= route_url %>/new
+  # GET <%= route_url %>/new.json
+  def new
+    # @<%= singular_var_name %> = <%= orm_class.build(local_class_name) %>
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json { render <%= key_value :json, "@#{singular_var_name}" %> }
+    end
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+    # @<%= singular_var_name %> = <%= orm_class.find(local_class_name, "params[:id]") %>
+  end
+
+  # POST <%= route_url %>
+  # POST <%= route_url %>.json
+  def create
+    # @<%= singular_var_name %> = <%= orm_class.build(local_class_name, "params[:#{singular_var_name}]") %>
+
+    respond_to do |format|
+      if @<%= orm_instance.save %>
+        format.html { redirect_to <%= singular_table_name %>_path(@<%= singular_var_name %>), <%= key_value :notice, "'#{human_name} was successfully created.'" %> }
+        format.json { render <%= key_value :json, "@#{singular_var_name}" %>, <%= key_value :status, ':created' %>, <%= key_value :location, "#{singular_table_name}_path(@#{singular_var_name})" %> }
+      else
+        format.html { render <%= key_value :action, '"new"' %> }
+        format.json { render <%= key_value :json, "@#{orm_instance.errors}" %>, <%= key_value :status, ':unprocessable_entity' %> }
+      end
+    end
+  end
+
+  # PUT <%= route_url %>/1
+  # PUT <%= route_url %>/1.json
+  def update
+    # @<%= singular_var_name %> = <%= orm_class.find(local_class_name, "params[:id]") %>
+
+    respond_to do |format|
+      if @<%= orm_instance.update_attributes("params[:#{singular_var_name}]") %>
+        format.html { redirect_to <%= singular_table_name %>_path(@<%= singular_var_name %>), <%= key_value :notice, "'#{human_name} was successfully updated.'" %> }
+        format.json { head :no_content }
+      else
+        format.html { render <%= key_value :action, '"edit"' %> }
+        format.json { render <%= key_value :json, "@#{orm_instance.errors}" %>, <%= key_value :status, ':unprocessable_entity' %> }
+      end
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  # DELETE <%= route_url %>/1.json
+  def destroy
+    # @<%= singular_var_name %> = <%= orm_class.find(local_class_name, "params[:id]") %>
+    @<%= orm_instance.destroy %>
+
+    respond_to do |format|
+      format.html { redirect_to <%= index_helper %>_url }
+      format.json { head :no_content }
+    end
+  end
+
+  protected
+
+  # Capture any access violations, ensure User isn't unnessisarily redirected to root
+  rescue_from CanCan::AccessDenied do |exception|
+    if params[:action] == 'index'
+      redirect_to root_url, :alert => exception.message
+    else
+      redirect_to <%= index_helper %>_url, :alert => exception.message
+    end
+  end
+
+end
+<% end -%>

data/lib/generators/authorized_rails_scaffolds/install_scaffold/templates/edit.html.erb

@@ -0,0 +1,5 @@
+<%%- model_class = <%= file_name.classify %> -%>
+<div class="page-header">
+  <h1><%%=t '.title', :default => [:'helpers.titles.edit', 'Edit %{model}'], :model => model_class.model_name.human %></h1>
+</div>
+<%%= render :partial => 'form' %>

data/lib/generators/authorized_rails_scaffolds/install_scaffold/templates/index.html.erb

@@ -0,0 +1,52 @@
+<%- singular_var_name = file_name -%>
+<%- plural_var_name = file_name.pluralize-%>
+<%%- model_class = <%= file_name.classify %> -%>
+<div class="page-header">
+  <h1><%%=t '.title', :default => model_class.model_name.human.pluralize %></h1>
+</div>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>&nbsp;</th>
+      <%- attributes.each do |attribute| -%>
+      <th><%%= model_class.human_attribute_name(:<%= attribute.name %>) %></th>
+      <%- end -%>
+      <th><%%= model_class.human_attribute_name(:created_at) %></th>
+      <th><%%=t '.actions', :default => t("helpers.actions") %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <%% @<%= plural_var_name %>.each do |<%= singular_var_name %>| %>
+      <tr class="<%= singular_var_name %>_<%%= <%= singular_var_name%>.id %>">
+        <td class="id-column"><%%= <%= singular_var_name %>.id %></td>
+        <%- if attributes.any? -%>
+        <td class="title-column"><%%= link_to <%= singular_var_name %>.<%= attributes[0].name %>, <%= singular_table_name %>_path(<%= singular_var_name %>) %></td>
+        <%- attributes[1..-1].each do |attribute| -%>
+        <%- if [:datetime, :timestamp, :time, :date].include? attribute.type -%>
+        <td><%%=l <%= singular_var_name %>.<%= attribute.name %><% if attribute.type == :datetime %>, :format => :long<% end %><% if attribute.type == :time %>, :format => :short<% end %> %></td>
+        <%- else -%>
+        <td><%%= <%= singular_var_name %>.<%= attribute.name %> %></td>
+        <%- end -%>
+        <%- end -%>
+        <%- end -%>
+        <td><%%=l <%= singular_var_name %>.created_at %></td>
+        <td class="table-actions">
+          <%%= link_to t('.edit', :default => t("helpers.links.edit")),
+                      edit_<%= singular_table_name %>_path(<%= singular_var_name %>), :class => 'btn btn-mini', :disabled => !can?(:update, <%= singular_var_name %>) %>
+          <%%= link_to t('.destroy', :default => t("helpers.links.destroy")),
+                      <%= singular_table_name %>_path(<%= singular_var_name %>),
+                      :method => :delete,
+                      :data => { :confirm => t('.confirm', :default => t("helpers.links.confirm", :default => 'Are you sure?')) },
+                      :class => 'btn btn-mini btn-danger',
+                      :disabled => !can?(:destroy, <%= singular_var_name %>) %>
+        </td>
+      </tr>
+    <%% end %>
+  </tbody>
+</table>
+
+<%% if can?(:create, <%= file_name.classify %>) %>
+  <%%= link_to t('.new', :default => t("helpers.links.new")),
+            new_<%= singular_table_name %>_path,
+            :class => 'btn btn-primary' %>
+<%% end %>

data/lib/generators/authorized_rails_scaffolds/install_scaffold/templates/new.html.erb

@@ -0,0 +1,5 @@
+<%%- model_class = <%= file_name.classify %> -%>
+<div class="page-header">
+  <h1><%%=t '.title', :default => [:'helpers.titles.new', 'New %{model}'], :model => model_class.model_name.human %></h1>
+</div>
+<%%= render :partial => 'form' %>

data/lib/generators/authorized_rails_scaffolds/install_scaffold/templates/show.html.erb

@@ -0,0 +1,34 @@
+<%- singular_var_name = file_name -%>
+<%%- model_class = <%= file_name.classify %> -%>
+<div class="page-header">
+  <h1><%%=t '.title', :default => model_class.model_name.human %></h1>
+</div>
+
+<dl class="dl-horizontal item-summary">
+<%- attributes.each do |attribute| -%>
+  <dt><strong><%%= model_class.human_attribute_name(:<%= attribute.name %>) %>:</strong></dt>
+  <%- if [:datetime, :timestamp, :time, :date].include? attribute.type -%>
+  <%% unless @<%= singular_var_name %>.nil? %>
+  <dd><%%=l @<%= singular_var_name %>.<%= attribute.name %><% if attribute.type == :datetime %>, :format => :long<% end %><% if attribute.type == :time %>, :format => :short<% end %> %></dd>
+  <%% end %>
+  <%- else -%>
+  <dd><%%= @<%= singular_var_name %>.<%= attribute.name %> %></dd>
+  <%- end -%>
+<%- end -%>
+</dl>
+
+<div class="form-actions">
+  <%%= link_to t('.back', :default => t("helpers.links.back")),
+              <%= index_helper %>_path, :class => 'btn'  %>
+  <%% if can? :update, @<%= singular_var_name %> %>
+    <%%= link_to t('.edit', :default => t("helpers.links.edit")),
+              edit_<%= singular_table_name %>_path(@<%= singular_var_name %>), :class => 'btn' %>
+  <%% end %>
+  <%% if can? :destroy, @<%= singular_var_name %> %>
+    <%%= link_to t('.destroy', :default => t("helpers.links.destroy")),
+              <%= singular_table_name %>_path(@<%= singular_var_name %>),
+              :method => 'delete',
+              :data => { :confirm => t('.confirm', :default => t("helpers.links.confirm", :default => 'Are you sure?')) },
+              :class => 'act act-danger pull-right' %>
+  <%% end %>
+</div>