aldous 1.0.0

data/examples/basic_todo/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/examples/basic_todo/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require spec_helper

data/examples/basic_todo/.ruby-version

@@ -0,0 +1,2 @@
+2.2.0
+

data/examples/basic_todo/Gemfile

@@ -0,0 +1,52 @@
+source 'https://rubygems.org'
+
+ruby '2.2.0'
+
+gem 'aldous', path: '../../'
+
+gem 'rails', '4.2.0'
+gem 'sqlite3'
+gem 'bcrypt', '~> 3.1.7'
+
+gem 'slim-rails'
+gem 'sass-rails', '~> 5.0'
+gem 'coffee-rails', '~> 4.1.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'autoprefixer-rails'
+gem 'kaminari'
+#gem 'handlebars_assets'
+
+gem 'configatron'
+gem 'yajl-ruby', require: 'yajl/json_gem'
+
+gem 'dalli'
+
+gem 'awesome_print'
+gem 'cancancan', '~> 1.10'
+
+group :development, :test do
+  gem 'pry-rails'
+  gem 'pry-byebug'
+  gem 'spring'
+  gem 'spring-commands-rspec'
+  gem 'rspec-rails'
+  gem 'annotate'
+end
+
+group :test do
+  gem 'capybara'
+  gem 'poltergeist'
+  gem 'timecop'
+  gem 'database_cleaner'
+  gem 'webmock'
+end
+
+group :development do
+  gem 'foreman'
+  gem 'quiet_assets'
+  gem 'thin'
+end
+
+group :development, :staging do
+  gem 'faker'
+end

data/examples/basic_todo/Procfile

@@ -0,0 +1 @@
+web: bin/rails server -p ${PORT}

data/examples/basic_todo/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/examples/basic_todo/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__)
+
+Rails.application.load_tasks

data/examples/basic_todo/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/examples/basic_todo/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/examples/basic_todo/app/controller_actions/base_action.rb

@@ -0,0 +1,24 @@
+class BaseAction < ::Aldous::ControllerAction
+  def default_view_data
+    {
+      current_user: current_user,
+      current_ability: current_ability,
+    }
+  end
+
+  def preconditions
+    [Shared::EnsureUserNotDisabledPrecondition]
+  end
+
+  def default_error_respondable
+    Defaults::ServerErrorView
+  end
+
+  def current_user
+    @current_user ||= FindCurrentUserService.perform(session).user
+  end
+
+  def current_ability
+    @current_ability ||= Ability.new(current_user)
+  end
+end

data/examples/basic_todo/app/controller_actions/base_precondition.rb

@@ -0,0 +1,2 @@
+class BasePrecondition < ::Aldous::Controller::Action::Precondition
+end

data/examples/basic_todo/app/controller_actions/home_controller/show.rb

@@ -0,0 +1,8 @@
+class HomeController::Show < BaseAction
+  def perform
+    return build_view(Todos::IndexRedirect) if current_user
+
+    build_view(Home::ShowView)
+  end
+end
+

data/examples/basic_todo/app/controller_actions/shared/ensure_user_not_disabled_precondition.rb

@@ -0,0 +1,9 @@
+class Shared::EnsureUserNotDisabledPrecondition < BasePrecondition
+  delegate :current_user, :current_ability, to: :action
+
+  def perform
+    if current_user && current_user.disabled && !current_ability.can?(:manage, :all)
+      return build_view(Defaults::ForbiddenView, errors: ['Your account has been disabled'])
+    end
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ins_controller/create.rb

@@ -0,0 +1,24 @@
+class SignInsController::Create < BaseAction
+  def perform
+    return build_view(Todos::IndexRedirect) if current_user
+    return build_view(Defaults::BadRequestView, status: :bad_request, errors: [user_params.error_message]) unless user_params.fetch
+    return build_view(SignIns::NewView, status: :not_found) unless user
+
+    if user.authenticate(user_params.fetch[:password])
+      SignInService.perform!(session, user)
+      build_view(Todos::IndexRedirect)
+    else
+      build_view(SignIns::NewView, status: :unprocessable_entity, errors: ["Incorrect credentials"])
+    end
+  end
+
+  private
+
+  def user_params
+    @user_params ||= ::SignInsController::UserParams.build(params)
+  end
+
+  def user
+    @user ||= User.where(email: user_params.fetch[:email]).first
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ins_controller/destroy.rb

@@ -0,0 +1,9 @@
+class SignInsController::Destroy < BaseAction
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+
+    SignOutService.perform!(session)
+
+    build_view(Home::ShowRedirect)
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ins_controller/new.rb

@@ -0,0 +1,7 @@
+class SignInsController::New < BaseAction
+  def perform
+    return build_view(Todos::IndexRedirect) if current_user
+
+    return build_view(SignIns::NewView)
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ins_controller/user_params.rb

@@ -0,0 +1,9 @@
+class SignInsController::UserParams < Aldous::Params
+  def permitted_params
+    params.require(:user).permit(:email, :password)
+  end
+
+  def error_message
+    'Missing param :user'
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ups_controller/create.rb

@@ -0,0 +1,23 @@
+class SignUpsController::Create < BaseAction
+  def perform
+    return build_view(Todos::IndexRedirect) if current_user
+    return build_view(Defaults::BadRequestView, errors: [user_params.error_message]) unless user_params.fetch
+
+    if create_user_result.success?
+      SignInService.perform!(session, create_user_result.user)
+      build_view(Todos::IndexRedirect)
+    else
+      build_view(SignUps::NewView)
+    end
+  end
+
+  private
+
+  def create_user_result
+    @create_user_result ||= CreateUserService.perform(user_params.fetch)
+  end
+
+  def user_params
+    @user_params ||= ::SignUpsController::UserParams.build(params)
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ups_controller/new.rb

@@ -0,0 +1,7 @@
+class SignUpsController::New < BaseAction
+  def perform
+    return build_view(Todos::IndexRedirect) if current_user
+
+    return build_view(SignUps::NewView)
+  end
+end

data/examples/basic_todo/app/controller_actions/sign_ups_controller/user_params.rb

@@ -0,0 +1,9 @@
+class SignUpsController::UserParams < Aldous::Params
+  def permitted_params
+    params.require(:user).permit(:email, :password)
+  end
+
+  def error_message
+    'Missing param :user'
+  end
+end

data/examples/basic_todo/app/controller_actions/todos/all_completed_controller/destroy.rb

@@ -0,0 +1,17 @@
+class Todos::AllCompletedController::Destroy < BaseAction
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+
+    if todos.destroy_all
+      build_view(Todos::IndexRedirect)
+    else
+      build_view(Defaults::ServerErrorView, errors: ['Unable to delete completed todos'])
+    end
+  end
+
+  private
+
+  def todos
+    @todo ||= Todo.where(user_id: current_user.id).where(done: true)
+  end
+end

data/examples/basic_todo/app/controller_actions/todos/completed_controller/create.rb

@@ -0,0 +1,29 @@
+class Todos::CompletedController::Create < BaseAction
+  def default_view_data
+    super.merge({todo: todo})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+    return build_view(Todos::NotFoundView, todo_id: todo_id) unless todo
+    return build_view(Defaults::ForbiddenView) unless current_ability.can?(:update, todo)
+
+    todo.done = true
+
+    if todo.save
+      build_view(Todos::IndexRedirect)
+    else
+      build_view(Defaults::ServerErrorView, errors: ["Unable to mark todo completed"])
+    end
+  end
+
+  private
+
+  def todo
+    @todo ||= Todo.where(id: todo_id).first
+  end
+
+  def todo_id
+    params[:todo_id]
+  end
+end

data/examples/basic_todo/app/controller_actions/todos_controller/create.rb

@@ -0,0 +1,26 @@
+class TodosController::Create < BaseAction
+  def default_view_data
+    super.merge({todo: todo})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+    return build_view(Defaults::BadRequestView, errors: [todo_params.error_message]) unless todo_params.fetch
+
+    if todo.save
+      build_view(Todos::IndexRedirect)
+    else
+      build_view(Todos::NewView)
+    end
+  end
+
+  private
+
+  def todo
+    @todo ||= Todo.new(todo_params.fetch)
+  end
+
+  def todo_params
+    TodosController::TodoParams.build(params)
+  end
+end

data/examples/basic_todo/app/controller_actions/todos_controller/destroy.rb

@@ -0,0 +1,21 @@
+class TodosController::Destroy < BaseAction
+  def default_view_data
+    super.merge({todo: todo})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+    return build_view(Todos::NotFoundView, todo_id: params[:id]) unless todo
+    return build_view(Defaults::ForbiddenView) unless current_ability.can?(:destroy, todo)
+
+    todo.destroy
+
+    build_view(Todos::IndexRedirect)
+  end
+
+  private
+
+  def todo
+    @todo ||= Todo.where(id: params[:id]).first
+  end
+end

data/examples/basic_todo/app/controller_actions/todos_controller/edit.rb

@@ -0,0 +1,19 @@
+class TodosController::Edit < BaseAction
+  def default_view_data
+    super.merge({todo: todo})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+    return build_view(Todos::NotFoundView, todo_id: params[:id]) unless todo
+    return build_view(Defaults::ForbiddenView) unless current_ability.can?(:update, todo)
+
+    build_view(Todos::EditView)
+  end
+
+  private
+
+  def todo
+    @todo ||= Todo.where(id: params[:id]).first
+  end
+end

data/examples/basic_todo/app/controller_actions/todos_controller/index.rb

@@ -0,0 +1,19 @@
+class TodosController::Index < BaseAction
+  def default_view_data
+    super.merge({todos: todos})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+
+    build_view(Todos::IndexView)
+  end
+
+  private
+
+  def todos
+    Todo.where(user_id: current_user.id)
+  end
+end
+
+

data/examples/basic_todo/app/controller_actions/todos_controller/new.rb

@@ -0,0 +1,17 @@
+class TodosController::New < BaseAction
+  def default_view_data
+    super.merge({todo: todo})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+
+    build_view(Todos::NewView)
+  end
+
+  private
+
+  def todo
+    @todo ||= Todo.new(user_id: current_user.id)
+  end
+end

data/examples/basic_todo/app/controller_actions/todos_controller/todo_params.rb

@@ -0,0 +1,9 @@
+class TodosController::TodoParams < Aldous::Params
+  def permitted_params
+    params.require(:todo).permit(:description, :user_id)
+  end
+
+  def error_message
+    'Missing param :todo'
+  end
+end

data/examples/basic_todo/app/controller_actions/todos_controller/update.rb

@@ -0,0 +1,28 @@
+class TodosController::Update < BaseAction
+  def default_view_data
+    super.merge({todo: todo})
+  end
+
+  def perform
+    return build_view(Home::ShowRedirect) unless current_user
+    return build_view(Defaults::BadRequestView, errors: [todo_params.error_message]) unless todo_params.fetch
+    return build_view(Todos::NotFoundView, todo_id: params[:id]) unless todo
+    return build_view(Defaults::ForbiddenView) unless current_ability.can?(:update, todo)
+
+    if todo.update_attributes(todo_params.fetch)
+      build_view(Todos::IndexRedirect)
+    else
+      build_view(Todos::EditView)
+    end
+  end
+
+  private
+
+  def todo
+    @todo ||= Todo.where(id: params[:id]).first
+  end
+
+  def todo_params
+    TodosController::TodoParams.build(params)
+  end
+end

data/examples/basic_todo/app/controller_actions/users_controller/index.rb

@@ -0,0 +1,19 @@
+class UsersController::Index < BaseAction
+  def default_view_data
+    super.merge({users: users})
+  end
+
+  def perform
+    return build_view(Defaults::ForbiddenView) unless current_ability.can?(:index, User)
+
+    build_view(Users::IndexView)
+  end
+
+  private
+
+  def users
+    User.all
+  end
+end
+
+

data/examples/basic_todo/app/controllers/application_controller.rb

@@ -0,0 +1,9 @@
+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
+
+  def view_assigns
+    {}
+  end
+end

data/examples/basic_todo/app/controllers/home_controller.rb

@@ -0,0 +1,5 @@
+class HomeController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :show
+end

data/examples/basic_todo/app/controllers/sign_ins_controller.rb

@@ -0,0 +1,5 @@
+class SignInsController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :new, :create, :destroy
+end

data/examples/basic_todo/app/controllers/sign_ups_controller.rb

@@ -0,0 +1,5 @@
+class SignUpsController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :new, :create
+end

data/examples/basic_todo/app/controllers/todos/all_completed_controller.rb

@@ -0,0 +1,5 @@
+class Todos::AllCompletedController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :destroy
+end

data/examples/basic_todo/app/controllers/todos/completed_controller.rb

@@ -0,0 +1,5 @@
+class Todos::CompletedController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :create
+end

data/examples/basic_todo/app/controllers/todos_controller.rb

@@ -0,0 +1,5 @@
+class TodosController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :index, :new, :create, :edit, :update, :destroy
+end

data/examples/basic_todo/app/controllers/users_controller.rb

@@ -0,0 +1,5 @@
+class UsersController < ApplicationController
+  include Aldous::Controller
+
+  controller_actions :index
+end

data/examples/basic_todo/app/helpers/application_helper.rb

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

data/examples/basic_todo/app/models/ability.rb

@@ -0,0 +1,27 @@
+class Ability
+  include CanCan::Ability
+
+  attr_reader :user
+
+  def initialize(user)
+    @user = user || User.new
+    @user.roles.each { |role| send(role.name.downcase) }
+
+    if @user.roles.size == 0
+      guest
+    end
+  end
+
+  def guest
+  end
+
+  def account_holder
+    can :manage, Todo, user_id: user.id
+    can :create, User
+    can [:read, :update], user
+  end
+
+  def admin
+    can :manage, :all
+  end
+end

data/examples/basic_todo/app/models/role.rb

@@ -0,0 +1,5 @@
+class Role < ActiveRecord::Base
+  has_many :user_roles
+  has_many :users, through: :user_roles
+end
+

data/examples/basic_todo/app/models/todo.rb

@@ -0,0 +1,5 @@
+class Todo < ActiveRecord::Base
+  belongs_to :user
+
+  validates :description, presence: true
+end

data/examples/basic_todo/app/models/user.rb

@@ -0,0 +1,12 @@
+class User < ActiveRecord::Base
+  has_many :todos
+
+  has_many :user_roles
+  has_many :roles, through: :user_roles
+
+  has_secure_password validations: false
+
+  validates :email, presence: true, uniqueness: true
+  validates :password, presence: true
+end
+

data/examples/basic_todo/app/models/user_role.rb

@@ -0,0 +1,5 @@
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :role
+end
+