From d3dd0ff848b31fbd30abec73b2191c0bc27d474f Mon Sep 17 00:00:00 2001
From: Andrew Tomaka <atomaka@gmail.com>
Date: Mon, 13 Jul 2015 02:14:35 -0400
Subject: [PATCH] Add the subcreddit MVC

Notes on closing subcreddit:

This doesn't seem great.  Would be slightly better if closed could be referenced
as true or false instead of '0' or '1' in the model.  Testing this is a bit
messy, but Tiemcop makes it a bit better.

Notes on subcreddit validations:

This is still not ideal.  For starters, from
http://guides.rubyonrails.org/active_record_validations.html:

"Note that some databases are configured to perform case-insensitive searches
anyway."

It also seems difficult to validate fields that are set in before_save since
validations occur before callbacks.  Revisit this (perhaps friendly_id wll save
us).
---
 Gemfile                                       |   1 +
 Gemfile.lock                                  |   2 +
 .../{tests.coffee => subcreddits.coffee}      |   0
 .../{tests.scss => subcreddits.scss}          |   2 +-
 app/controllers/subcreddits_controller.rb     |  50 ++++++
 app/controllers/tests_controller.rb           |   7 -
 app/models/subcreddit.rb                      |  53 ++++++
 app/views/application/_navbar.html.slim       |  15 +-
 app/views/subcreddits/_form.html.slim         |   8 +
 app/views/subcreddits/edit.html.slim          |   1 +
 app/views/subcreddits/index.html.slim         |   7 +
 app/views/subcreddits/new.html.slim           |   1 +
 app/views/subcreddits/show.html.slim          |   3 +
 app/views/subcreddits/update.html.slim        |   0
 app/views/tests/index.html.slim               |   1 -
 app/views/tests/show.html.slim                |   1 -
 config/routes.rb                              |   7 +-
 .../20150713045745_create_subcreddits.rb      |  12 ++
 db/schema.rb                                  |  13 +-
 .../subcreddits_controller_spec.rb            | 156 ++++++++++++++++++
 spec/factories/subcreddit_factory.rb          |   6 +
 spec/models/subcreddit_spec.rb                | 126 ++++++++++++++
 22 files changed, 450 insertions(+), 22 deletions(-)
 rename app/assets/javascripts/{tests.coffee => subcreddits.coffee} (100%)
 rename app/assets/stylesheets/{tests.scss => subcreddits.scss} (62%)
 create mode 100644 app/controllers/subcreddits_controller.rb
 delete mode 100644 app/controllers/tests_controller.rb
 create mode 100644 app/models/subcreddit.rb
 create mode 100644 app/views/subcreddits/_form.html.slim
 create mode 100644 app/views/subcreddits/edit.html.slim
 create mode 100644 app/views/subcreddits/index.html.slim
 create mode 100644 app/views/subcreddits/new.html.slim
 create mode 100644 app/views/subcreddits/show.html.slim
 create mode 100644 app/views/subcreddits/update.html.slim
 delete mode 100644 app/views/tests/index.html.slim
 delete mode 100644 app/views/tests/show.html.slim
 create mode 100644 db/migrate/20150713045745_create_subcreddits.rb
 create mode 100644 spec/controllers/subcreddits_controller_spec.rb
 create mode 100644 spec/factories/subcreddit_factory.rb
 create mode 100644 spec/models/subcreddit_spec.rb

diff --git a/Gemfile b/Gemfile
index 390be6e..05d558a 100644
--- a/Gemfile
+++ b/Gemfile
@@ -50,4 +50,5 @@ group :test do
   gem 'capybara-webkit'
   gem 'shoulda'
   gem 'simplecov', require: false
+  gem 'timecop'
 end
diff --git a/Gemfile.lock b/Gemfile.lock
index ac3e8b6..016bbb5 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -338,6 +338,7 @@ GEM
     thor (0.19.1)
     thread_safe (0.3.5)
     tilt (1.4.1)
+    timecop (0.7.4)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     uglifier (2.7.1)
@@ -392,6 +393,7 @@ DEPENDENCIES
   spring
   spring-commands-rspec
   sqlite3
+  timecop
   uglifier (>= 1.3.0)
 
 BUNDLED WITH
diff --git a/app/assets/javascripts/tests.coffee b/app/assets/javascripts/subcreddits.coffee
similarity index 100%
rename from app/assets/javascripts/tests.coffee
rename to app/assets/javascripts/subcreddits.coffee
diff --git a/app/assets/stylesheets/tests.scss b/app/assets/stylesheets/subcreddits.scss
similarity index 62%
rename from app/assets/stylesheets/tests.scss
rename to app/assets/stylesheets/subcreddits.scss
index 7e46f05..ed4afca 100644
--- a/app/assets/stylesheets/tests.scss
+++ b/app/assets/stylesheets/subcreddits.scss
@@ -1,3 +1,3 @@
-// Place all the styles related to the Tests controller here.
+// Place all the styles related to the Subcreddits controller here.
 // They will automatically be included in application.css.
 // You can use Sass (SCSS) here: http://sass-lang.com/
diff --git a/app/controllers/subcreddits_controller.rb b/app/controllers/subcreddits_controller.rb
new file mode 100644
index 0000000..256a6f1
--- /dev/null
+++ b/app/controllers/subcreddits_controller.rb
@@ -0,0 +1,50 @@
+class SubcredditsController < ApplicationController
+  before_filter :set_subcreddit, only: [:show, :edit, :update]
+
+  def index
+    @subcreddits = Subcreddit.all
+  end
+
+  def show
+  end
+
+  def new
+    @subcreddit = Subcreddit.new
+  end
+
+  def create
+    @subcreddit = Subcreddit.new(create_subcreddit_params)
+    @subcreddit.owner = current_user
+
+    if @subcreddit.save
+      redirect_to @subcreddit, notice: 'Subcreddit was created!'
+    else
+      render :new
+    end
+  end
+
+  def edit
+  end
+
+  def update
+    if @subcreddit.update(update_subcreddit_params)
+      redirect_to @subcreddit, notice: 'Subcreddit was updated!'
+    else
+      render :edit
+    end
+  end
+
+  private
+
+  def create_subcreddit_params
+    params.require(:subcreddit).permit(:name)
+  end
+
+  def update_subcreddit_params
+    params.require(:subcreddit).permit(:closed)
+  end
+
+  def set_subcreddit
+    @subcreddit = Subcreddit.find_by_slug(params[:id])
+  end
+end
diff --git a/app/controllers/tests_controller.rb b/app/controllers/tests_controller.rb
deleted file mode 100644
index 4faf46f..0000000
--- a/app/controllers/tests_controller.rb
+++ /dev/null
@@ -1,7 +0,0 @@
-class TestsController < ApplicationController
-  def index
-  end
-
-  def show
-  end
-end
diff --git a/app/models/subcreddit.rb b/app/models/subcreddit.rb
new file mode 100644
index 0000000..e481b30
--- /dev/null
+++ b/app/models/subcreddit.rb
@@ -0,0 +1,53 @@
+RESERVED_SLUGS = %w(new edit)
+
+class Subcreddit < ActiveRecord::Base
+  belongs_to :owner, class_name: 'User'
+
+  attr_accessor :closed
+
+  before_save :set_slug
+  before_save :set_closed_at
+
+  validates :name,
+    presence: true,
+    format: /\A(?! )[a-z0-9 ]*(?<! )\z/i,
+    uniqueness: { case_sensitive: false },
+    length: { minimum: 3, maximum: 21 }
+
+  validate :slug_is_not_a_route
+
+  validates :closed,
+    format: /\A[01]?\z/
+
+  def to_param
+    self.slug
+  end
+
+  def closed?
+    self.closed_at != nil
+  end
+
+  private
+
+  def set_slug
+    self.slug = sluggify_name
+  end
+
+  def sluggify_name
+    self.name.downcase.tr(' ', '_')
+  end
+
+  def set_closed_at
+    if closed == '1' && closed_at == nil
+      self.closed_at = Time.now
+    elsif closed == '0' && closed_at != nil
+      self.closed_at = nil
+    end
+  end
+
+  def slug_is_not_a_route
+    if RESERVED_SLUGS.include?(sluggify_name)
+      errors.add(:name, 'cannot be a reserved keyword')
+    end
+  end
+end
diff --git a/app/views/application/_navbar.html.slim b/app/views/application/_navbar.html.slim
index 9a52d66..acb378c 100644
--- a/app/views/application/_navbar.html.slim
+++ b/app/views/application/_navbar.html.slim
@@ -8,10 +8,11 @@
         span.icon-bar
       = link_to 'Creddit', root_path, class: 'navbar-brand'
     .collapse.navbar-collapse
-          ul.nav.navbar-nav.navbar-right
-            - if logged_in?
-              li= link_to 'Sign Out', signout_path
-            - else
-              li= link_to 'Create Account', signup_path
-              li= link_to 'Sign In', signin_path
-
+      ul.nav.navbar-nav
+        li= link_to 'Subcreddits', subcreddits_path
+      ul.nav.navbar-nav.navbar-right
+        - if logged_in?
+          li= link_to 'Sign Out', signout_path
+        - else
+          li= link_to 'Create Account', signup_path
+          li= link_to 'Sign In', signin_path
diff --git a/app/views/subcreddits/_form.html.slim b/app/views/subcreddits/_form.html.slim
new file mode 100644
index 0000000..3cde0b4
--- /dev/null
+++ b/app/views/subcreddits/_form.html.slim
@@ -0,0 +1,8 @@
+= simple_form_for subcreddit do |f|
+  .form-inputs
+    - if subcreddit.new_record?
+      = f.input :name
+    - unless subcreddit.new_record?
+      = f.input :closed, as: :boolean, input_html: { checked: subcreddit.closed? }
+  .form-actions
+    = f.button :submit
diff --git a/app/views/subcreddits/edit.html.slim b/app/views/subcreddits/edit.html.slim
new file mode 100644
index 0000000..34bd8cb
--- /dev/null
+++ b/app/views/subcreddits/edit.html.slim
@@ -0,0 +1 @@
+== render 'form', subcreddit: @subcreddit
diff --git a/app/views/subcreddits/index.html.slim b/app/views/subcreddits/index.html.slim
new file mode 100644
index 0000000..c049f1a
--- /dev/null
+++ b/app/views/subcreddits/index.html.slim
@@ -0,0 +1,7 @@
+= link_to 'Create', new_subcreddit_path
+
+ul
+  - @subcreddits.each do |subcreddit|
+    li
+      = link_to subcreddit.name, subcreddit
+      == " (#{link_to 'Edit', edit_subcreddit_path(subcreddit)})"
diff --git a/app/views/subcreddits/new.html.slim b/app/views/subcreddits/new.html.slim
new file mode 100644
index 0000000..34bd8cb
--- /dev/null
+++ b/app/views/subcreddits/new.html.slim
@@ -0,0 +1 @@
+== render 'form', subcreddit: @subcreddit
diff --git a/app/views/subcreddits/show.html.slim b/app/views/subcreddits/show.html.slim
new file mode 100644
index 0000000..156ddef
--- /dev/null
+++ b/app/views/subcreddits/show.html.slim
@@ -0,0 +1,3 @@
+h1= @subcreddit.name
+- if @subcreddit.closed?
+  = "Board has been closed"
diff --git a/app/views/subcreddits/update.html.slim b/app/views/subcreddits/update.html.slim
new file mode 100644
index 0000000..e69de29
diff --git a/app/views/tests/index.html.slim b/app/views/tests/index.html.slim
deleted file mode 100644
index 0f02584..0000000
--- a/app/views/tests/index.html.slim
+++ /dev/null
@@ -1 +0,0 @@
-= 'tests#index'
diff --git a/app/views/tests/show.html.slim b/app/views/tests/show.html.slim
deleted file mode 100644
index 9606ca0..0000000
--- a/app/views/tests/show.html.slim
+++ /dev/null
@@ -1 +0,0 @@
-= 'tests#show'
diff --git a/config/routes.rb b/config/routes.rb
index de7e608..414bc68 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -1,12 +1,11 @@
 Rails.application.routes.draw do
-  resources :tests, only: [:index, :show]
-
   get 'signup', to: 'users#new', as: :signup
   get 'signin', to: 'user_sessions#new', as: :signin
   get 'signout', to: 'user_sessions#destroy', as: :signout
 
-  resources :users, only: [:new, :create]
+  resources :subcreddits, path: 'c', except: [:destroy]
   resources :user_sessions, only: [:new, :create, :destroy]
+  resources :users, only: [:new, :create]
 
-  root to: 'tests#index'
+  root to: 'subcreddits#index'
 end
diff --git a/db/migrate/20150713045745_create_subcreddits.rb b/db/migrate/20150713045745_create_subcreddits.rb
new file mode 100644
index 0000000..dbc0672
--- /dev/null
+++ b/db/migrate/20150713045745_create_subcreddits.rb
@@ -0,0 +1,12 @@
+class CreateSubcreddits < ActiveRecord::Migration
+  def change
+    create_table :subcreddits do |t|
+      t.references :owner, index: true, foreign_key: true
+      t.string :name
+      t.string :slug
+      t.datetime :closed_at
+
+      t.timestamps null: false
+    end
+  end
+end
diff --git a/db/schema.rb b/db/schema.rb
index ec23418..dd2c75c 100644
--- a/db/schema.rb
+++ b/db/schema.rb
@@ -11,7 +11,18 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20150710040354) do
+ActiveRecord::Schema.define(version: 20150713045745) do
+
+  create_table "subcreddits", force: :cascade do |t|
+    t.integer  "owner_id"
+    t.string   "name"
+    t.string   "slug"
+    t.datetime "closed_at"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+  add_index "subcreddits", ["owner_id"], name: "index_subcreddits_on_owner_id"
 
   create_table "user_sessions", force: :cascade do |t|
     t.integer  "user_id"
diff --git a/spec/controllers/subcreddits_controller_spec.rb b/spec/controllers/subcreddits_controller_spec.rb
new file mode 100644
index 0000000..28daceb
--- /dev/null
+++ b/spec/controllers/subcreddits_controller_spec.rb
@@ -0,0 +1,156 @@
+require 'rails_helper'
+
+describe SubcredditsController, type: :controller do
+  let!(:user) { build(:user) }
+  let(:data) do
+    {
+      name: 'Testing Subcreddit 1'
+    }
+  end
+  before(:each) do
+    allow_any_instance_of(ApplicationController)
+      .to receive(:current_user).and_return(user)
+  end
+
+  describe '#index' do
+    let!(:subcreddits) { 3.times.collect { create(:subcreddit) } }
+
+    it 'should render :index' do
+      get :index
+
+      expect(response).to render_template(:index)
+    end
+
+    it 'should assign all Subcreddits to @subcreddits' do
+      get :index
+
+      expect(assigns(:subcreddits)).to eq(subcreddits)
+    end
+  end
+
+  describe '#show' do
+    let(:subcreddit) { create(:subcreddit) }
+    before(:each) { get :show, id: subcreddit }
+
+    it 'should render :show' do
+      expect(response).to render_template(:show)
+    end
+
+    it 'should assign the Subcreddit to @subcreddit' do
+      expect(assigns(:subcreddit)).to eq(subcreddit)
+    end
+  end
+
+  describe '#new' do
+    it 'should render :new' do
+      get :new
+
+      expect(response).to render_template(:new)
+    end
+
+    it 'should assign new Subcreddit to @subcreddit' do
+      get :new
+
+      expect(assigns(:subcreddit)).to be_a_new(Subcreddit)
+    end
+  end
+
+  describe '#create' do
+    context 'with valid data' do
+      it 'should create a subcreddit' do
+        expect { post :create, subcreddit: data }
+          .to change(Subcreddit, :count).by(1)
+      end
+
+      it 'should redirect to new subcreddit page index' do
+        expect(post :create, subcreddit: data)
+          .to redirect_to(assigns(:subcreddit))
+      end
+
+      it 'should send a notice flash message' do
+        post :create, subcreddit: data
+
+        expect(flash[:notice]).to be_present
+      end
+    end
+
+    context 'with invalid data' do
+      before(:each) { data['name'] = 'Bad name ' }
+
+      it 'should not create a subcreddit' do
+        expect { post :create, subcreddit: data }
+          .to change(Subcreddit, :count).by(0)
+      end
+
+      it 'should render :new' do
+        post :create, subcreddit: data
+
+        expect(response).to render_template(:new)
+      end
+    end
+  end
+
+  describe '#edit' do
+    context 'with valid subcreddit' do
+      let(:subcreddit) { create(:subcreddit) }
+
+      it 'should assign @subcreddit to the existing subcreddit' do
+        get :edit, id: subcreddit
+
+        expect(assigns(:subcreddit)).to eq(subcreddit)
+      end
+
+      it 'should render :edit' do
+        get :edit, id: subcreddit
+
+        expect(response).to render_template(:edit)
+      end
+    end
+  end
+
+  describe '#update' do
+    let(:subcreddit) { create(:subcreddit) }
+    let(:data) do
+      {
+        closed: '1'
+      }
+    end
+
+    context 'wth valid data' do
+      it 'should assign @subcreddit to the existing subcreddit' do
+        put :update, id: subcreddit, subcreddit: data
+
+        expect(assigns(:subcreddit)).to eq(subcreddit)
+      end
+
+      it 'should update the subcreddit' do
+        put :update, id: subcreddit, subcreddit: data
+        subcreddit.reload
+
+        expect(subcreddit.closed_at).to_not eq(nil)
+      end
+
+      it 'should redirect to the subcreddit' do
+        put :update, id: subcreddit, subcreddit: data
+
+        expect(response).to redirect_to(subcreddit_url(subcreddit))
+      end
+
+      it 'should display a notice flash message' do
+        put :update, id: subcreddit, subcreddit: data
+
+        expect(flash[:notice]).to be_present
+      end
+    end
+
+    context 'with invalid data' do
+      before(:each) { data[:closed] = 'bad' }
+
+      it 'should render :edit' do
+        put :update, id: subcreddit, subcreddit: data
+
+        expect(response).to render_template(:edit)
+      end
+    end
+  end
+end
diff --git a/spec/factories/subcreddit_factory.rb b/spec/factories/subcreddit_factory.rb
new file mode 100644
index 0000000..e5fe720
--- /dev/null
+++ b/spec/factories/subcreddit_factory.rb
@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :subcreddit do
+    owner { create(:user) }
+    name { Faker::Team.name.first(21) } # 21 is the max length...brittle
+  end
+end
diff --git a/spec/models/subcreddit_spec.rb b/spec/models/subcreddit_spec.rb
new file mode 100644
index 0000000..987c34d
--- /dev/null
+++ b/spec/models/subcreddit_spec.rb
@@ -0,0 +1,126 @@
+require 'rails_helper'
+
+describe Subcreddit, type: :model do
+  let(:subcreddit) { build(:subcreddit) }
+
+  it { should belong_to(:owner).class_name('User') }
+
+  context 'with valid data' do
+    it 'should be valid' do
+      expect(subcreddit).to be_valid
+    end
+
+    it 'should allow spaces in the name' do
+      subcreddit.name = 'Testing Spaces'
+      expect(subcreddit).to be_valid
+    end
+
+    it 'should sluggify the name' do
+      subcreddit.name = 'Testing Spaces 1'
+      subcreddit.save
+      expect(subcreddit.slug).to eq('testing_spaces_1')
+    end
+
+    it 'should set closed_at if closed is true and closed_at is nil' do
+      Timecop.freeze do
+        subcreddit.closed = '1'
+        subcreddit.save
+        expect(subcreddit.closed_at).to eq(Time.now)
+      end
+    end
+
+    it 'should not change closed_at if closed and closed_at is not nil' do
+      subcreddit.closed_at = Time.now - 3.days
+
+      Timecop.freeze do
+        subcreddit.closed = '1'
+        subcreddit.save
+        expect(subcreddit.closed_at).to_not eq(Time.now)
+      end
+    end
+
+    it 'should clear closed_at if closed is "0"' do
+      subcreddit.closed_at = Time.now
+
+      subcreddit.closed = '0'
+      subcreddit.save
+      expect(subcreddit.closed_at).to eq(nil)
+    end
+  end
+
+  context 'with invalid data' do
+    it 'should not allow a blank name' do
+      subcreddit.name = ''
+
+      expect(subcreddit).to be_invalid
+    end
+
+    it 'should not allow short names' do
+      subcreddit.name = 'a' * 2
+
+      expect(subcreddit).to be_invalid
+    end
+
+    it 'should not allow long names' do
+      subcreddit.name = 'a' * 22
+
+      expect(subcreddit).to be_invalid
+    end
+
+    it 'should only allow acceptable characters in the name' do
+      subcreddit.name = 'Testing!'
+
+      expect(subcreddit).to be_invalid
+    end
+
+    it 'should not be allowed to end with a space' do
+      subcreddit.name = 'Testing '
+
+      expect(subcreddit).to be_invalid
+    end
+
+    it 'should not be allowed to begin with a space' do
+      subcreddit.name = ' Testing'
+
+      expect(subcreddit).to be_invalid
+    end
+
+    it 'should not allow duplicate names' do
+      original = create(:subcreddit)
+      duplicate = build(:subcreddit, name: original.name)
+
+      expect(duplicate).to be_invalid
+    end
+
+    it 'should not allow duplicate names (case insensitive)' do
+      original = create(:subcreddit)
+      duplicate = build(:subcreddit, name: original.name.upcase)
+
+      expect(duplicate).to be_invalid
+    end
+
+    it 'should not use a reserved keyword' do
+      subcreddit.name = 'New'
+
+      expect(subcreddit).to be_invalid
+    end
+  end
+
+  context '#closed?' do
+    let(:subcreddit) { build(:subcreddit) }
+
+    context 'when a subcreddit is closed' do
+      before(:each) { subcreddit.closed_at = Time.now }
+
+      it 'should return true' do
+        expect(subcreddit.closed?).to be(true)
+      end
+    end
+
+    context 'when a subcreddit is open' do
+      it 'should return false' do
+        expect(subcreddit.closed?).to be(false)
+      end
+    end
+  end
+end