Chitter solo challenge

Gemfile

@@ -12,6 +12,7 @@ group :test do
   gem 'rspec'
   gem 'simplecov', require: false
   gem 'simplecov-console', require: false
+  gem 'timecop'
 end
 
 group :development, :test do

Gemfile.lock

@@ -18,6 +18,8 @@ GEM
     mini_mime (1.1.1)
     mustermann (1.1.1)
       ruby2_keywords (~> 0.0.1)
+    nokogiri (1.12.3-arm64-darwin)
+      racc (~> 1.4)
     nokogiri (1.12.3-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.20.1)
@@ -78,11 +80,13 @@ GEM
     terminal-table (3.0.1)
       unicode-display_width (>= 1.1.1, < 3)
     tilt (2.0.10)
+    timecop (0.9.5)
     unicode-display_width (2.0.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -93,6 +97,7 @@ DEPENDENCIES
   simplecov
   simplecov-console
   sinatra
+  timecop
 
 RUBY VERSION
    ruby 3.0.2p107

README.md

@@ -1,66 +1,42 @@
-## Chitter Challenge
+# Chitter
 
-* Challenge time: until the end of the day
-* Feel free to use google, your notes, books etc but please work on your own
-* Please raise a pull request when you start this challenge, and keep pushing updates as and when you make commits throughout the day
-* There is _no expectation_ to finish all or any of the user stories, please use this time to reflect on where you feel you are with the skill and what may support your learning.
-* If you get blocked, please reflect on what blocked you and any strategies you adopted that helped you make progress.
+Chitter is a databased backed web application that allows a user to view and post messages (peeps).
 
-We are going to write a small Twitter clone that will allow the users to post messages to a public stream.
+## Getting started
 
-## Set up
+```
+git clone https://github.com/olliefreeman94/chitter-challenge-apprenticeships.git
+```
 
 To setup the database:
 
 * Connect to psql
 * Create the database using the psql command `CREATE DATABASE chitter;`
-* Connect to the database using the psql command `\c chitter`;
-* Run the query we have saved in the file 01_create_chitter_table.sql
-* Populate your table with a row by running `INSERT INTO peeps (message) values ('This is a peep!');`
-
-To check you have everything set up ok, please take a look at the peeps table inside the chitter database. You should see one row in there.  
+* Connect to the database using the psql command `\c chitter`
+* Run the query saved in 01_create_chitter_table.sql
+* Run the query saved in 02_add_date_to_peeps.sql
 
 To setup the test database:
 * Connect to psql
-* Create the database using the psql
-command `CREATE DATABASE chitter_test;`;
+* Create the database using the psql command `CREATE DATABASE chitter_test;`
 * Connect to the database using the psql command `\c chitter_test`
-* Run the query we have saved in the file 01_create_chitter_table.sql
-
-* `bundle install`
-* `rspec`
-
-You should see 1 passing test.
-
-## User stories
+* Run the query saved in 01_create_chitter_table.sql
+* Run the query saved in 02_add_date_to_peeps.sql
 
 ```
-As a Maker
-So that I can see what people are doing
-I want to see all the messages (peeps)
-in a browser
+bundle install
 ```
 
-```
-As a Maker
-So that I can let people know what I am doing  
-I want to post a message (peep) to chitter
-```
+## Usage
 
 ```
-As a Maker
-So that I can see when people are doing things
-I want to see the date the message was posted
+rackup
 ```
-(Hint the database table will need to change to store the date too)
+
+Navigate to `http://localhost:9292/`
+
+## Running tests
 
 ```
-As a Maker
-So that I can easily see the latest peeps
-I want to see a list of peeps in reverse chronological order
-```
-```
-As a Maker
-So that I can find relevant peeps
-I want to filter on a specific keyword
+rspec
 ```

app.rb

@@ -1,9 +1,38 @@
 require 'sinatra/base'
+require_relative './lib/peep'
 
 class Chitter < Sinatra::Base
   get '/test' do
     'Test page'
   end
 
+  get '/' do
+    erb :index
+  end
+
+  get '/peeps' do
+    @peeps = Peep.all
+    erb :'peeps/index'
+  end
+
+  post '/peeps' do
+    Peep.add(message: params[:message], date: params[:date])
+    redirect '/peeps'
+  end
+
+  get '/peeps/new' do
+    erb :'peeps/new'
+  end
+
+  get '/peeps/search' do
+    erb :'peeps/search'
+  end
+
+  get '/peeps/filtered' do
+    @peeps = Peep.filter(params[:keyword])
+    @view_all_button = 1
+    erb :'peeps/index'
+  end
+
   run! if app_file == $0
 end

challenge_outline.md

@@ -0,0 +1,66 @@
+## Chitter Challenge
+
+* Challenge time: until the end of the day
+* Feel free to use google, your notes, books etc but please work on your own
+* Please raise a pull request when you start this challenge, and keep pushing updates as and when you make commits throughout the day
+* There is _no expectation_ to finish all or any of the user stories, please use this time to reflect on where you feel you are with the skill and what may support your learning.
+* If you get blocked, please reflect on what blocked you and any strategies you adopted that helped you make progress.
+
+We are going to write a small Twitter clone that will allow the users to post messages to a public stream.
+
+## Set up
+
+To setup the database:
+
+* Connect to psql
+* Create the database using the psql command `CREATE DATABASE chitter;`
+* Connect to the database using the psql command `\c chitter`;
+* Run the query we have saved in the file 01_create_chitter_table.sql
+* Populate your table with a row by running `INSERT INTO peeps (message) values ('This is a peep!');`
+
+To check you have everything set up ok, please take a look at the peeps table inside the chitter database. You should see one row in there.  
+
+To setup the test database:
+* Connect to psql
+* Create the database using the psql
+command `CREATE DATABASE chitter_test;`;
+* Connect to the database using the psql command `\c chitter_test`
+* Run the query we have saved in the file 01_create_chitter_table.sql
+
+* `bundle install`
+* `rspec`
+
+You should see 1 passing test.
+
+## User stories
+
+```
+As a Maker
+So that I can see what people are doing
+I want to see all the messages (peeps)
+in a browser
+```
+
+```
+As a Maker
+So that I can let people know what I am doing  
+I want to post a message (peep) to chitter
+```
+
+```
+As a Maker
+So that I can see when people are doing things
+I want to see the date the message was posted
+```
+(Hint the database table will need to change to store the date too)
+
+```
+As a Maker
+So that I can easily see the latest peeps
+I want to see a list of peeps in reverse chronological order
+```
+```
+As a Maker
+So that I can find relevant peeps
+I want to filter on a specific keyword
+```

db/migrations/02_add_date_to_peeps.sql

@@ -0,0 +1 @@
+ALTER TABLE peeps ADD COLUMN date DATE;

lib/peep.rb

@@ -0,0 +1,50 @@
+require 'pg'
+
+class Peep
+
+  attr_reader :id, :message, :date
+
+  def initialize(id:, message:, date:)
+    @id = id
+    @message = message
+    @date = date
+  end
+
+  def self.all
+    if ENV['ENVIRONMENT'] == 'test'
+      connection = PG.connect(dbname: 'chitter_test')
+    else
+      connection = PG.connect(dbname: 'chitter')
+    end
+
+    result = connection.exec("SELECT * FROM peeps ORDER BY date DESC")
+    result.map { |peep| Peep.new(id: peep['id'], message: peep['message'], date: peep['date']) }
+  end
+
+  def self.add(message:, date:)
+    if ENV['ENVIRONMENT'] == 'test'
+      connection = PG.connect(dbname: 'chitter_test')
+    else
+      connection = PG.connect(dbname: 'chitter')
+    end
+
+    result = connection.exec_params(
+      "INSERT INTO peeps (message, date) VALUES($1, $2) RETURNING id, message, date;",
+      [message, date]
+      ).first
+    Peep.new(id: result['id'], message: result['message'], date: result['date'])
+  end
+
+  def self.filter(keyword)
+    if ENV['ENVIRONMENT'] == 'test'
+      connection = PG.connect(dbname: 'chitter_test')
+    else
+      connection = PG.connect(dbname: 'chitter')
+    end
+
+    result = connection.exec(
+      "SELECT * FROM peeps WHERE message ILIKE '%#{keyword}%' ORDER BY date DESC"
+      )
+    result.map { |peep| Peep.new(id: peep['id'], message: peep['message'], date: peep['date']) }
+  end
+end

notes.txt

@@ -0,0 +1,13 @@
+Next steps
+- review format in which date is displayed to user
+- add validation to forms
+- consolidate helper classes into one file?
+- merge or link '/' and 'peeps' routes?
+- pathing between routes
+
+Additional features
+- record time as well as date
+- message character limit validation
+- cf. Bookmark Manager extensions,
+    e.g. update (inc. logging?), delete, user authentication
+- equivilent of Twitter #

spec/database_helpers.rb

@@ -0,0 +1,7 @@
+require 'pg'
+
+def persisted_data(id:)
+  connection = PG.connect(dbname: 'chitter_test')
+  result = connection.query("SELECT * FROM peeps WHERE id = #{id};")
+  return result.first
+end

spec/features/creating_messages_spec.rb

@@ -0,0 +1,13 @@
+require 'timecop'
+
+feature 'adding a new message' do
+  scenario 'a user can add a message to Chitter' do
+    Timecop.freeze(Time.local(2022, 7, 15)) do
+      visit('/peeps/new')
+      fill_in('message', with: 'Example peep')
+      click_button('Submit')
+    end
+
+    expect(page).to have_content 'Example peep (2022-07-15)'
+  end
+end

spec/features/filtering_messages_spec.rb

@@ -0,0 +1,14 @@
+feature 'filtering messages' do
+  scenario 'a user can filter messages by keyword' do
+    Peep.add(message: 'Banana peep', date: '2022-07-15')
+    Peep.add(message: 'Apple', date: '2022-07-10')
+    Peep.add(message: 'Another banana peep', date: '2022-07-05')
+
+    visit('/peeps/search')
+    fill_in('keyword', with: 'banana')
+    click_button('Search')
+
+    expect(page).to have_content "Banana peep (2022-07-15)"
+    expect(page).to have_content "Another banana peep (2022-07-05)"
+  end
+end

spec/features/pathing_spec.rb

@@ -0,0 +1,43 @@
+feature 'pathing between routes' do
+  scenario 'from homepage user can view all messages' do
+    add_row_to_test_database
+    visit '/'
+    click_button 'View all peeps'
+
+    expect(page).to have_content "This is a peep!"
+  end
+
+  scenario 'from homepage user can add a new message' do
+    visit '/'
+    click_button 'Add a new peep'
+
+    expect(page).to have_content "New peep"
+  end
+
+  scenario "from '/peeps' user can add a new message" do
+    visit '/peeps'
+    click_button 'Add a new peep'
+
+    expect(page).to have_content "New peep"
+  end
+
+  scenario "from '/peeps' user can filter messages by keyword" do
+    visit '/peeps'
+    click_button 'Filter peeps by keyword'
+
+    expect(page).to have_content "Search"
+  end
+
+  scenario 'from filtered search results, user can view all messages' do
+    Peep.add(message: 'Banana peep', date: '2022-07-15')
+    Peep.add(message: 'Apple peep', date: '2022-07-10')
+    visit '/peeps/search'
+    fill_in('keyword', with: 'banana')
+    click_button 'Search'
+
+    click_button 'View all peeps'
+
+    expect(page).to have_content "Apple peep"
+  end
+
+end

spec/features/test_page_spec.rb

@@ -1,4 +1,4 @@
-feature 'Viewing test page' do
+feature 'viewing test page' do
   scenario 'visiting the test page' do
     visit('/test')
     expect(page).to have_content "Test page"