diff --git a/.gitignore b/.gitignore index 5fb66c9f0..a35e445cc 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,5 @@ # Ignore master key for decrypting credentials and more. /config/master.key +Gemfile +Gemfile.lock diff --git a/Gemfile b/Gemfile index 7abd44d7a..5e25721a4 100644 --- a/Gemfile +++ b/Gemfile @@ -1,6 +1,6 @@ source "https://rubygems.org" -ruby "3.2.3" +ruby "3.3.0" # Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main" gem "rails", "~> 7.1.2" @@ -66,3 +66,5 @@ group :test do gem "selenium-webdriver" gem "webdrivers" end + +gem 'bootstrap', '~> 5.0.1' diff --git a/Gemfile.lock b/Gemfile.lock index ac898c77c..b9e794ce8 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -77,11 +77,17 @@ GEM tzinfo (~> 2.0) addressable (2.8.6) public_suffix (>= 2.0.2, < 6.0) + autoprefixer-rails (10.4.16.0) + execjs (~> 2) base64 (0.2.0) bigdecimal (3.1.6) bindex (0.8.1) bootsnap (1.17.1) msgpack (~> 1.2) + bootstrap (5.0.2) + autoprefixer-rails (>= 9.1.0) + popper_js (>= 2.9.2, < 3) + sassc-rails (>= 2.0.0) builder (3.2.4) capybara (3.39.2) addressable @@ -102,6 +108,8 @@ GEM drb (2.2.0) ruby2_keywords erubi (1.12.0) + execjs (2.9.1) + ffi (1.16.3) globalid (1.2.1) activesupport (>= 6.1) i18n (1.14.1) @@ -153,6 +161,7 @@ GEM racc (~> 1.4) nokogiri (1.16.0-x86_64-linux) racc (~> 1.4) + popper_js (2.11.8) psych (5.1.2) stringio public_suffix (5.0.4) @@ -205,6 +214,14 @@ GEM rexml (3.2.6) ruby2_keywords (0.0.5) rubyzip (2.3.2) + sassc (2.4.0) + ffi (~> 1.9) + sassc-rails (2.1.2) + railties (>= 4.0.0) + sassc (>= 2.0) + sprockets (> 3.0) + sprockets-rails + tilt selenium-webdriver (4.10.0) rexml (~> 3.2, >= 3.2.5) rubyzip (>= 1.2.2, < 3.0) @@ -226,6 +243,7 @@ GEM railties (>= 6.0.0) stringio (3.1.0) thor (1.3.0) + tilt (2.3.0) timeout (0.4.1) turbo-rails (1.5.0) actionpack (>= 6.0.0) @@ -260,6 +278,7 @@ PLATFORMS DEPENDENCIES bootsnap + bootstrap (~> 5.0.1) capybara debug importmap-rails @@ -276,7 +295,7 @@ DEPENDENCIES webdrivers RUBY VERSION - ruby 3.2.3p157 + ruby 3.3.0p0 BUNDLED WITH 2.5.5 diff --git a/app/assets/stylesheets/application.css b/app/assets/stylesheets/application.scss similarity index 88% rename from app/assets/stylesheets/application.css rename to app/assets/stylesheets/application.scss index 288b9ab71..c07201e93 100644 --- a/app/assets/stylesheets/application.css +++ b/app/assets/stylesheets/application.scss @@ -13,3 +13,12 @@ *= require_tree . *= require_self */ + + + //Import Bootstrap styles + @import "bootstrap"; + + + body { + background-color: #333; + } \ No newline at end of file diff --git a/app/controllers/articles_controller.rb b/app/controllers/articles_controller.rb new file mode 100644 index 000000000..75bc64925 --- /dev/null +++ b/app/controllers/articles_controller.rb @@ -0,0 +1,70 @@ +# The ArticlesController is responsible for managing the lifecycle of articles in the application. +# It handles the standard CRUD operations: create, read, update, and delete. + +class ArticlesController < ApplicationController + # The 'index' action is responsible for listing all articles in the application. + def index + @articles = Article.search(params[:term]) + end + + # The 'show' action retrieves a single article by its ID and displays it. + def show + @article = Article.find(params[:id]) + end + + # The `new` action initializes a new, unsaved article for the form. + def new + @article = Article.new + end + + # The `create` action attempts to save a new article to the database from the form data. + def create + @article = Article.new(article_params) + + # Set the article's date to the current time if it is not provided. This is to ensure that the article's date is always accurate. +if @article.date.nil? + @article.date = Time.current + end + + # If the article is successfully saved, redirect to the article's page. Otherwise, render the `new` template with the provided errors. + if @article.save + redirect_to articles_path, notice: "Article was successfully created." + else + render :new, status: :unprocessable_entity + end + end + + # The 'edit' action retrieves an existing article by its ID for the form. + def edit + @article = Article.find(params[:id]) + end + + # The `update` action attempts to save changes to an existing article to the database from the form data. + def update + @article = Article.find(params[:id]) + + # Set the article's date to the current time if it is not provided. This is to ensure that the article's date is always accurate. + if @article.update(article_params) + @article.update(date: Time.current) + # If the article is successfully saved, redirect to the article's page. Otherwise, render the `edit` template with the provided errors. + redirect_to @article, notice: "Article was successfully updated." + else + render :edit, status: :unprocessable_entity + end + end + + # The `destroy` action deletes an existing article by its ID from the database. + def destroy + @article = Article.find(params[:id]) + @article.destroy + + redirect_to root_path, status: :see_other + end + + private + + # Strong Parameters: only allow the whitelisted parameters to be used to create/update an article. + def article_params + params.require(:article).permit(:title, :content, :author, :date) + end +end diff --git a/app/helpers/articles_helper.rb b/app/helpers/articles_helper.rb new file mode 100644 index 000000000..296827759 --- /dev/null +++ b/app/helpers/articles_helper.rb @@ -0,0 +1,2 @@ +module ArticlesHelper +end diff --git a/app/javascript/application.js b/app/javascript/application.js index 0d7b49404..ecb58706c 100644 --- a/app/javascript/application.js +++ b/app/javascript/application.js @@ -1,3 +1,7 @@ +//= require bootstrap + +// Added bootstrap to style + // Configure your import map in config/importmap.rb. Read more: https://github.com/rails/importmap-rails -import "@hotwired/turbo-rails" -import "controllers" +import "@hotwired/turbo-rails"; +import "controllers"; diff --git a/app/models/article.rb b/app/models/article.rb new file mode 100644 index 000000000..9cfd53f59 --- /dev/null +++ b/app/models/article.rb @@ -0,0 +1,15 @@ +class Article < ApplicationRecord + # Validate rules checking to see the presence of the title and content. +validates :title, :content, presence: true + +# The `search` class method allows for searching articles by title, content, or author. +# If a search term is provided, it returns all articles where the title, content, or author matches the term. +# If no term is provided, it returns all articles. +def self.search(term) + if term + where('title LIKE ? OR content LIKE ? OR author LIKE ?' , "%#{term}%", "%#{term}%", "%#{term}%") + else + all + end +end +end diff --git a/app/views/articles/_form.html.erb b/app/views/articles/_form.html.erb new file mode 100644 index 000000000..590cbc113 --- /dev/null +++ b/app/views/articles/_form.html.erb @@ -0,0 +1,45 @@ +<%# This is a form partial for articles. It's used in the new and edit views. %> + +
+
+
+ +

<%= @article.persisted? ? 'Edit Article' : 'New Article' %>

+ <%# Use the form_with helper to start the form. If @article is a new record, this will post to the create action. + If @article is an existing record, this will patch to the update action. %> + <%= form_with model: article, class: 'needs-validation', novalidate: true do |form| %> + + <%# A form group for the author %> +
+ <%= form.label :author, class: 'form-label' %> + <%= form.text_field :author, value: @article.author, class: 'form-control', style: 'color: black;' %> +
+ + <%# A form group for the article title %> +
+ <%= form.label :title, class: 'form-label' %> + <%= form.text_field :title, value: @article.title, class: 'form-control', style: 'color: black;' %> + <% article.errors.full_messages_for(:title).each do |message| %> +
<%= message %>
+ <% end %> +
+ + <%# A form group for the article content %> +
+ <%= form.label :content, class: 'form-label' %> + <%= form.text_area :content, value: @article.content, class: 'form-control', style: 'color: black;' %> + <% article.errors.full_messages_for(:content).each do |message| %> +
<%= message %>
+ <% end %> +
+ + + <%# The form submit button. The button text will be "Create Article" or "Update Article" based on + whether @article is a new record or an existing record. %> +
+ <%= form.submit class: 'btn btn-primary' %> +
+ <% end %> +
+
+
\ No newline at end of file diff --git a/app/views/articles/edit.html.erb b/app/views/articles/edit.html.erb new file mode 100644 index 000000000..449a6da8a --- /dev/null +++ b/app/views/articles/edit.html.erb @@ -0,0 +1,4 @@ +<%# Render the _form partial, passing in the @article instance variable. + The _form partial uses this variable to display the form and populate the fields with the existing article data. %> + +<%= render "form", article: @article %> diff --git a/app/views/articles/index.html.erb b/app/views/articles/index.html.erb new file mode 100644 index 000000000..a7cf8ded1 --- /dev/null +++ b/app/views/articles/index.html.erb @@ -0,0 +1,49 @@ +<%# This is the index view for the articles. It displays a list of all articles. %> + +
+

Shopify Encyclopedia

+
+ +<%# Creates a div class for a container for a search bar%> +
+
+
+ <%= form_with(url: articles_path, method: "get", local: true, class: "mb-3") do %> +
+ <%= text_field_tag(:term, params[:term], class: "form-control", placeholder: "Search", style: "margin-right: 20px;") %> + <%= submit_tag("Search", class: "btn btn-primary") %> +
+ <% end %> +
+
+
+ +
+ <%# Display a link to the new article form %> + <%= link_to 'New Article', new_article_path, class: 'btn btn-success' %> +
+ +
+ <%# Loop over each article in the @articles array %> + <% @articles.each do |article| %> + <%# Creates a bootstrap card class that displays each article in the view separately %> +
+
+
+

<%= article.title %>

+

Author: <%= article.author %>

+

<%= article.content %>

+ <%# Link to the article's show page with a 'Read' button %> + <%= link_to 'Read', article, class: 'btn btn-primary' %> + <%# Link to the article's edit page with an 'Edit' button %> + <%= link_to 'Edit', edit_article_path(article), class: 'btn btn-primary' %> + <%# Link to delete the article with a 'Delete' button. + This will trigger a DELETE HTTP request to /articles/:id. + A confirmation dialog will be displayed before the article is deleted. %> + <%= link_to 'Delete', article_path(article), data: { turbo_method: :delete, turbo_confirm: 'Are you sure?' }, class: 'btn btn-danger' %> +
+
+
+ <% end %> +
+ diff --git a/app/views/articles/new.html.erb b/app/views/articles/new.html.erb new file mode 100644 index 000000000..3b10ef3de --- /dev/null +++ b/app/views/articles/new.html.erb @@ -0,0 +1,3 @@ +<%# Render the _form partial, passing in the @article instance variable. + The _form partial uses this variable to display the form and populate the fields with the existing article data. %> +<%= render "form", article: @article %> diff --git a/app/views/articles/show.html.erb b/app/views/articles/show.html.erb new file mode 100644 index 000000000..eb95187f1 --- /dev/null +++ b/app/views/articles/show.html.erb @@ -0,0 +1,22 @@ +<%# This is the show view for the articles. It displays the details of a single article. %> + +
+
+
+ <%# Display the title of the article %> +

<%= @article.title %>

+ <%# Display the author of the article %> +

Author: <%= @article.author %>

+ <%# Display the date the article was published %> +

Publishing Date: <%= @article.date %>

+ <%# Display the content of the article %> +

<%= @article.content %>

+ <%= link_to 'Edit', edit_article_path(@article), class: 'btn btn-primary' %> + <%# Display a link to delete the article. This will trigger a DELETE HTTP request to /articles/:id. + A confirmation dialog will be displayed before the article is deleted. %> + <%= link_to 'Delete', article_path(@article), data: { turbo_method: :delete, turbo_confirm: 'Are you sure?' }, class: 'btn btn-danger' %> + <%# Display a link to the articles index page %> + <%= link_to 'Back', articles_path, class: 'btn btn-secondary' %> +
+
+
\ No newline at end of file diff --git a/config/routes.rb b/config/routes.rb index a125ef085..c8167edc8 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -7,4 +7,8 @@ # Defines the root path route ("/") # root "posts#index" + root "articles#index" + + # Defines the routes for the articles controller +resources :articles end diff --git a/db/migrate/20240129213444_create_articles.rb b/db/migrate/20240129213444_create_articles.rb new file mode 100644 index 000000000..6cdcb67a8 --- /dev/null +++ b/db/migrate/20240129213444_create_articles.rb @@ -0,0 +1,10 @@ +class CreateArticles < ActiveRecord::Migration[7.1] + def change + create_table :articles do |t| + t.string :title + t.text :body + + t.timestamps + end + end +end diff --git a/db/migrate/20240130005402_rename_body_to_content_in_articles.rb b/db/migrate/20240130005402_rename_body_to_content_in_articles.rb new file mode 100644 index 000000000..a7b10f94e --- /dev/null +++ b/db/migrate/20240130005402_rename_body_to_content_in_articles.rb @@ -0,0 +1,6 @@ +class RenameBodyToContentInArticles < ActiveRecord::Migration[7.1] + def change + rename_column :articles, :body, :content + + end +end diff --git a/db/migrate/20240130010108_add_author_to_articles.rb b/db/migrate/20240130010108_add_author_to_articles.rb new file mode 100644 index 000000000..3fdc9a764 --- /dev/null +++ b/db/migrate/20240130010108_add_author_to_articles.rb @@ -0,0 +1,5 @@ +class AddAuthorToArticles < ActiveRecord::Migration[7.1] + def change + add_column :articles, :author, :string + end +end diff --git a/db/migrate/20240130012020_add_date_to_articles.rb b/db/migrate/20240130012020_add_date_to_articles.rb new file mode 100644 index 000000000..e91d1e2a9 --- /dev/null +++ b/db/migrate/20240130012020_add_date_to_articles.rb @@ -0,0 +1,5 @@ +class AddDateToArticles < ActiveRecord::Migration[7.1] + def change + add_column :articles, :date, :datetime + end +end diff --git a/db/migrate/20240130014508_change_date_default_in_articles.rb b/db/migrate/20240130014508_change_date_default_in_articles.rb new file mode 100644 index 000000000..64e87dc8a --- /dev/null +++ b/db/migrate/20240130014508_change_date_default_in_articles.rb @@ -0,0 +1,9 @@ +class ChangeDateDefaultInArticles < ActiveRecord::Migration[7.1] + def up + change_column :articles, :date, :datetime, default: -> { 'CURRENT_TIMESTAMP' } + end + + def down + change_column :articles, :date, :datetime, default: nil + end +end diff --git a/db/migrate/20240130020815_remove_timestamps_from_articles.rb b/db/migrate/20240130020815_remove_timestamps_from_articles.rb new file mode 100644 index 000000000..9ad768dd4 --- /dev/null +++ b/db/migrate/20240130020815_remove_timestamps_from_articles.rb @@ -0,0 +1,6 @@ +class RemoveTimestampsFromArticles < ActiveRecord::Migration[6.0] + def change + remove_column :articles, :created_at, :datetime + remove_column :articles, :updated_at, :datetime + end +end diff --git a/db/schema.rb b/db/schema.rb new file mode 100644 index 000000000..f593b8097 --- /dev/null +++ b/db/schema.rb @@ -0,0 +1,33 @@ +# This file is auto-generated from the current state of the database. Instead +# of editing this file, please use the migrations feature of Active Record to +# incrementally modify your database, and then regenerate this schema definition. +# +# This file is the source Rails uses to define your schema when running `bin/rails +# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to +# be faster and is potentially less error prone than running all of your +# migrations from scratch. Old migrations may fail to apply correctly if those +# migrations use external dependencies or application code. +# +# It's strongly recommended that you check this file into your version control system. + +ActiveRecord::Schema[7.1].define(version: 2024_01_30_020815) do + create_table "articles", force: :cascade do |t| + t.string "title" + t.text "content" + t.string "status" + t.string "author" + t.datetime "date", default: -> { "CURRENT_TIMESTAMP" } + end + + create_table "comments", force: :cascade do |t| + t.string "commenter" + t.text "body" + t.integer "article_id", null: false + t.datetime "created_at", null: false + t.datetime "updated_at", null: false + t.string "status" + t.index ["article_id"], name: "index_comments_on_article_id" + end + + add_foreign_key "comments", "articles" +end diff --git a/test/controllers/articles_controller_test.rb b/test/controllers/articles_controller_test.rb new file mode 100644 index 000000000..0a82cbb19 --- /dev/null +++ b/test/controllers/articles_controller_test.rb @@ -0,0 +1,7 @@ +require "test_helper" + +class ArticlesControllerTest < ActionDispatch::IntegrationTest + # test "the truth" do + # assert true + # end +end