Article and DevTo Models (#8)

Author: lucianghinda

.reek.yml

@@ -2,5 +2,14 @@ detectors:
   IrresponsibleModule:
     enabled: false
 
+directories:
+  "db/migrate":
+    FeatureEnvy:
+      enabled: false
+    TooManyStatements:
+      enabled: false
+    UncommunicativeVariableName:
+      enabled: false # this is set on false because 't' from migrations are flagged
+
 exclude_paths:
   - test

app/models/concerns/entryable.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Entryable
+	extend ActiveSupport::Concern
+
+	included do
+		has_one :entry, as: :entryable, dependent: :destroy, touch: true
+	end
+end

app/models/dev_to.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DevTo
+	def self.table_name_prefix
+		"dev_to_"
+	end
+end

app/models/dev_to/article.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class DevTo::Article < ApplicationRecord
+	include Entryable
+
+	belongs_to(
+		:author,
+		class_name: "DevTo::Author",
+		foreign_key: "dev_to_author_id",
+		inverse_of: :articles,
+		optional: true
+	)
+
+	validates :title, presence: true
+	validates :published_at, presence: true
+end

app/models/dev_to/author.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class DevTo::Author < ApplicationRecord
+	has_many(
+		:articles,
+		class_name: "DevTo::Article",
+		dependent: :destroy,
+		foreign_key: "dev_to_author_id",
+		inverse_of: :author
+	)
+
+	validates :name, presence: true
+	validates :website_url, presence: true
+	validates :original_unique_id, presence: true
+end

app/models/entry.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Entry < ApplicationRecord
+	delegated_type :entryable, types: %w[Message Comment]
+
+	validates :url, presence: true
+end

db/migrate/20230215023400_create_entries.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class CreateEntries < ActiveRecord::Migration[7.0]
+	def change
+		create_table :entries do |t|
+			t.string :url, null: false
+			t.string :entryable_type, null: false
+			t.integer :entryable_id, null: false
+			t.timestamps
+		end
+
+		add_index :entries, :url
+		add_index :entries, [:entryable_type, :entryable_id]
+	end
+end

db/migrate/20230215024045_create_dev_to_articles.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class CreateDevToArticles < ActiveRecord::Migration[7.0]
+	def change
+		create_table :dev_to_articles do |t|
+			t.string :title, null: false
+			t.string :description, null: true
+			t.datetime :published_at, null: false
+			t.integer :dev_to_author_id, null: true
+			t.json :data
+			t.timestamps
+		end
+
+		add_index :dev_to_articles, :title
+	end
+end

db/migrate/20230215025117_create_dev_to_authors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateDevToAuthors < ActiveRecord::Migration[7.0]
+	def change
+		create_table :dev_to_authors do |t|
+			t.string :username
+			t.string :original_unique_id
+			t.string :name
+			t.string :summary
+			t.string :website_url
+			t.string :profile_image_url
+			t.string :twitter_username
+			t.string :github_username
+			t.json :data
+			t.timestamps
+		end
+	end
+end

db/schema.rb

@@ -0,0 +1,24 @@
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined. If you add columns to the
+# model remove the "{}" from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one:
+  id: 1
+  title: "How to use fixtures"
+  description: "It is all about fixtures"
+  published_at: <%= 5.days.ago.to_fs(:db) %>
+  data: {}
+  created_at: <%= 2.days.ago.to_fs(:db) %>
+  updated_at: <%=  Time.current %>
+
+two:
+  id: 2
+  title: "How to use Ruby"
+  description: "Ruby is a great programming language"
+  published_at: <%= 1.day.ago.to_fs(:db) %>
+  author: kai
+  data: {}
+  created_at: <%= 2.days.ago.to_fs(:db) %>
+  updated_at: <%= Time.current %>

test/fixtures/dev_to/articles.yml

@@ -0,0 +1,31 @@
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined. If you add columns to the
+# model remove the "{}" from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+kai:
+  username: "kai"
+  original_unique_id: "100"
+  name: "Kai Kap"
+  summary: "This is Kay profile"
+  website_url: "https://example.com/kai"
+  profile_image_url: "https://i.pravatar.cc/300"
+  twitter_username: "kai"
+  github_username: "kai"
+  data: {}
+  created_at: <%= Time.current %>
+  updated_at: <%= Time.current %>
+
+ari:
+  username: "ari"
+  original_unique_id: "200"
+  name: "Ari Arison"
+  summary: "This is Ari's profile"
+  website_url: "https://example.com/ari"
+  profile_image_url: "https://i.pravatar.cc/300"
+  twitter_username: "ari"
+  github_username: "ari"
+  data: {}
+  created_at: <%= Time.current %>
+  updated_at: <%= Time.current %>

test/fixtures/dev_to/authors.yml

@@ -0,0 +1,19 @@
+# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+
+# This model initially had no columns defined. If you add columns to the
+# model remove the "{}" from the fixture names and add the columns immediately
+# below each fixture, per the syntax in the comments below
+#
+one:
+  entryable_type: "DevTo::Article"
+  entryable_id: 1
+  url: "https://newsletter.shortruby.com/p/short-ruby-news-edition-29"
+  created_at: <%= 2.days.ago.to_fs(:db) %>
+  updated_at: <%= Time.current %>
+
+two:
+  entryable_type: "DevTo::Article"
+  entryable_id: 2
+  url: "https://newsletter.shortruby.com/p/edition-28"
+  created_at: <%= 2.days.ago.to_fs(:db) %>
+  updated_at: <%= Time.current %>

test/fixtures/entries.yml

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class DevTo::ArticleTest < ActiveSupport::TestCase
+	test "article is valid with title and published_at" do
+		author = dev_to_authors(:kai)
+		dev_to_article = DevTo::Article.new(
+			author:,
+			published_at: 1.day.ago,
+			title: "This is my first article"
+		)
+
+		assert_predicate(
+			dev_to_article,
+			:valid?,
+			"Model should be valid but found: #{dev_to_article.errors.full_messages.join(', ')}"
+		)
+	end
+end

test/models/dev_to/article_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class DevTo::AuthorTest < ActiveSupport::TestCase
+	test "author is valid with name, original_unique_id and website_url" do
+		dev_to_author = DevTo::Author.new(
+			name: "A",
+			original_unique_id: SecureRandom.uuid,
+			website_url: "https://example.com/author"
+		)
+
+		assert_predicate(
+			dev_to_author,
+			:valid?,
+			"Model should be valid but found: #{dev_to_author.errors.full_messages.join(', ')}"
+		)
+	end
+end

test/models/dev_to/author_test.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class EntryTest < ActiveSupport::TestCase
+	test "can create delegated type" do
+		dev_to_article = dev_to_articles(:one)
+		entry = Entry.create(
+			entryable: dev_to_article,
+			url: "https://newsletter.shortruby.com"
+		)
+
+		assert_predicate(
+			entry,
+			:persisted?,
+			"Entry cannot be saved due to the following errors: #{entry.errors.full_messages.join(', ')}"
+		)
+	end
+end