simpleblog 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f5eae049cc2930e851eaaf6d32a7230932f8b1044276554e856fa21cc3a1875
-  data.tar.gz: 0a690b86338a7dd6d2f6697c619c5db835bcd4a36108ab51920be5b34d5d2a3a
+  metadata.gz: ab03e15d27ae35ba6d80a517e49038cc3a1371b517149731914788a89961baab
+  data.tar.gz: c970ef75bae07476a32c94e978c40751e839a26ea980f00a55e97f3533b9aa09
 SHA512:
-  metadata.gz: c9ea4abd1efd2938941daed5efa33bf8e1d01c388e2491b8e5e426fa68d9f05a219f9e53790371a17e4af32aa1508c8c92f1835edf07734ee2be8d2dd1c4603d
-  data.tar.gz: 4bd09d0b6b58d518c8b75372a8e5b9bbd9bc9d467ce69aebc8b288c780b3d011ea83a40645e47cdbbda3e2aba5f7c6b283905a3ba2ce51399ce4149107ba8492
+  metadata.gz: e19787714a42d112d61c60415f6a8848730c0c67a8997262ea3b138a84c22591448fc23042d0f667775617584b52042f5f5355deb854fbdb8d8693df25ee989f
+  data.tar.gz: d2e504c5375b5d27a19b7d84ad82ad6d4cd1d198aa337011be2a81629ea31c39cb242d638623975cc18dd7d49d9054b627c7934a81570d8d864e46b9846d9b90

data/lib/simpleblog/post.rb

@@ -0,0 +1,30 @@
+class Post
+  def self.build_list_of_posts(posts)
+    posts.map do |id, post_content|
+      Post.new(id, post_content)
+    end
+  end
+
+  attr_reader :id, :post_content
+
+  def initialize(id, post_content)
+    @id = id
+    @post_content = post_content
+  end
+
+  def tags
+    post_content["tags"].gsub(/\s+/, "").split(",")
+  end
+
+  private
+
+  def method_missing(method, *args, &block)
+    if post_content[method.to_s]
+      self.class.define_method(method.to_s) do
+        post_content[method.to_s]
+      end
+
+      send method, *args, &block
+    end
+  end
+end

data/lib/simpleblog/railtie.rb

@@ -0,0 +1,11 @@
+require "pathname"
+
+module Standard
+  class Railtie < Rails::Railtie
+    railtie_name :simpleblog
+
+    rake_tasks do
+      load Pathname.new(__dir__).join("rake.rb")
+    end
+  end
+end

data/lib/simpleblog/rake.rb

@@ -0,0 +1,46 @@
+desc "Install simpleblog basic structure"
+task :"simpleblog:install" do
+  Dir.mkdir("app/posts") unless Dir.exist?("app/posts")
+
+  copy_template_file("app/posts/posts.yml")
+  copy_template_file("app/posts/1.md")
+  copy_template_file("app/posts/2.md")
+
+  copy_template_file("app/controllers/blog_controller.rb")
+  copy_template_file("app/controllers/home_controller.rb")
+
+  Dir.mkdir("app/views/blog") unless Dir.exist?("app/views/blog")
+  Dir.mkdir("app/views/home") unless Dir.exist?("app/views/home")
+
+  copy_template_file("app/views/blog/index.html.erb")
+  copy_template_file("app/views/blog/show.html.erb")
+  copy_template_file("app/views/home/index.html.erb")
+  copy_template_file("app/views/layouts/application.html.erb")
+
+  Dir.mkdir("app/assets/stylesheets/layouts") unless Dir.exist?("app/assets/stylesheets/layouts")
+
+  copy_template_file("app/assets/stylesheets/blog.scss")
+  copy_template_file("app/assets/stylesheets/rouge.scss.erb")
+  copy_template_file("app/assets/stylesheets/layouts/application.scss")
+
+  copy_template_file("app/helpers/blog_helper.rb")
+
+  copy_template_file("config/routes.rb")
+end
+
+def copy_template_file(path)
+  gem_path = File.dirname(__dir__)
+
+  if File.exist?(path)
+    $stdout.puts "#{path} already exist. Do you want to override? (y/n) default: y"
+    input = $stdin.gets.chomp
+
+    return if input == "n"
+
+    p "Overriden: #{path}"
+  else
+    p "Created: #{path}"
+  end
+
+  copy_file("#{gem_path}/simpleblog/template/#{path}", path)
+end

data/lib/simpleblog/template/app/assets/stylesheets/blog.scss

@@ -0,0 +1,3 @@
+p {
+  color: #2E2F30;
+}

data/lib/simpleblog/template/app/assets/stylesheets/layouts/application.scss

@@ -0,0 +1,61 @@
+.header {
+	background-color: #2C3E50;
+	text-align: center;
+	padding: 20px;
+}
+
+.header-inner {
+	width: 760px;
+	margin: auto;
+	display: flex;
+	justify-content: space-between;
+}
+
+.title {
+	text-decoration: none;
+	color: #fff;
+	text-transform: uppercase;
+	font-weight: 500;
+	font-size: 18px;
+}
+
+.link {
+	text-decoration: none;
+	color: #fff;
+	margin-left: 20px;
+	font-size: 16px;
+}
+
+.content {
+	max-width: 760px;
+	margin: 0 auto;
+}
+
+body {
+	font-family: Ubuntu, sans-serif;
+  color: #2c3e50;
+	margin: 0;
+
+	h1 {
+		color: #e74c3c;
+    text-shadow: 1px 1px 1px rgb(150, 150, 150);
+		font-weight: 500;
+    line-height: 1.1;
+	}
+
+	a {
+		color: #428bca;
+    text-decoration: none;
+		margin-right: 4px;
+	}
+}
+
+@media (max-width: 759px) {
+	.header-inner {
+		width: 100%;
+	}
+
+	.content {
+		padding: 0 10px;
+	}
+}

data/lib/simpleblog/template/app/assets/stylesheets/rouge.scss.erb

@@ -0,0 +1,13 @@
+<%= Rouge::Themes::Github.render %>
+
+div.highlight {
+  border-radius: 5px;
+  padding: 5px 10px;
+}
+
+img.markdown-image {
+  margin: 0 auto;
+  display: block;
+  width: 100%;
+  height: auto;
+}

data/lib/simpleblog/template/app/controllers/blog_controller.rb

@@ -0,0 +1,13 @@
+class BlogController < ApplicationController
+  include SimpleBlogHelper
+
+  before_action :set_site_prefix
+
+  def index
+    @posts = SimpleBlog.list_posts(params[:tag], params[:in_progress])
+  end
+
+  def show
+    @post_content_html = SimpleBlog.render_post(params[:id])
+  end
+end

data/lib/simpleblog/template/app/controllers/home_controller.rb

@@ -0,0 +1,12 @@
+class HomeController < ApplicationController
+  before_action :set_site_prefix
+
+  def index
+  end
+
+  private
+
+  def set_site_prefix
+    @title_prefix = "About | "
+  end
+end

data/lib/simpleblog/template/app/helpers/blog_helper.rb

@@ -0,0 +1,5 @@
+module BlogHelper
+  def stringfy_date(date)
+    date.to_date.strftime("%b %d, %Y")
+  end
+end

data/lib/simpleblog/template/app/posts/1.md

@@ -0,0 +1,11 @@
+# My first post using SimpleBlog
+
+**Text**
+
+More text
+
+```bash
+def some_code
+  # TODO: hello
+end
+```

data/lib/simpleblog/template/app/posts/2.md

@@ -0,0 +1,3 @@
+#  Not published post
+
+Blah

data/lib/simpleblog/template/app/posts/posts.yml

@@ -0,0 +1,12 @@
+posts:
+  1:
+    title: My first post using SimpleBlog
+    date: 2022-04-21
+    description: Description of my post
+    tags: sample, programming, tips, template
+  2:
+    title: Not published post
+    date: 2022-04-21
+    description: Description of my post
+    tags: sample, programming, tips, template
+    in_progress: true

data/lib/simpleblog/template/app/views/blog/index.html.erb

@@ -0,0 +1,10 @@
+<% @posts.each do |post| %>
+  <a style="text-decoration: none" href=<%= blog_post_path("#{post.id}-#{post.title.parameterize}") %>>
+    <h1><%= post.title %></h1>
+    <p><%= post.description %></p>
+    <p><%= stringfy_date(post.date) %></p>
+  </a>
+  <% post.tags.each do |tag| %>
+    <a class="tag" href=<%= "#{blog_path}?tag=#{tag}" %>><%= tag %></a>
+  <% end %>
+<% end %>

data/lib/simpleblog/template/app/views/blog/show.html.erb

@@ -0,0 +1 @@
+<%== @post_content_html %>

data/lib/simpleblog/template/app/views/home/index.html.erb

@@ -0,0 +1,14 @@
+<h1>About</h1>
+
+<h3>About me</h3>
+<p>Write an introduction about yourself.</p>
+
+<h3>About this site</h3>
+<p>What do you want to show on your site/blog.</p>
+
+<h3>Contact</h3>
+<a href="https://github.com/YOU" target="_blank">GitHub</a>|
+<a href="https://twitter.com/YOU_" target="_blank">Twitter</a>|
+<a href="https://linkedin.com/in/YOU" target="_blank">Linkedin</a>|
+<a href="https://t.me/YOU" target="_blank">Telegram</a>|
+<a href="mailto:YOU@MAIL.com" target="_blank">Email</a>

data/lib/simpleblog/template/app/views/layouts/application.html.erb

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <% @author = "Your name" %>
+    <title><%= "#{@title_prefix} #{@author}"%></title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+    <%= javascript_include_tag "application", "data-turbo-track": "reload", defer: true %>
+  </head>
+
+  <body>
+    <header class="header">
+      <div class="header-inner">
+        <a href="/" class="title"><%= @author %></a>
+        <nav class="nav">
+          <a class="link" href="<%= about_path %>">About</a>
+          <a class="link" href="<%= blog_path %>">Blog</a>
+        </nav>
+      </div>
+    </header>
+    <div class="content">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/lib/simpleblog/template/config/routes.rb

@@ -0,0 +1,8 @@
+Rails.application.routes.draw do
+  get "blog", to: "blog#index"
+  get "blog/posts/:id", to: "blog#show", as: :blog_post
+
+  get "about", to: "home#index"
+
+  root "home#index"
+end

data/lib/simpleblog.rb

@@ -1,8 +1,16 @@
-require 'redcarpet'
-require 'rouge'
-require_dependency 'rouge/plugins/redcarpet'
+require "redcarpet"
+require "rouge"
+require "rouge/plugins/redcarpet"
+require "simpleblog/post"
+require "simpleblog/railtie" if defined?(Rails) && defined?(Rails::Railtie)
 
-class ArticleHTMLRender < Redcarpet::Render::HTML
+module SimpleBlogHelper
+  def set_site_prefix
+    @title_prefix = "#{params["controller"].capitalize} | "
+  end
+end
+
+class PostHTMLRender < Redcarpet::Render::HTML
   include Rouge::Plugins::Redcarpet
   include ActionView::Helpers::AssetTagHelper
 
@@ -14,28 +22,29 @@ class ArticleHTMLRender < Redcarpet::Render::HTML
     end
   end
 end
+
 class SimpleBlog
-  def self.render_article(id)
-    article_content = File.open("app/articles/#{id.to_i}.md").read
-    markdown = Redcarpet::Markdown.new(ArticleHTMLRender, fenced_code_blocks: true)
+  def self.render_post(id)
+    post_content = File.open("app/posts/#{id.to_i}.md").read
+    markdown = Redcarpet::Markdown.new(PostHTMLRender, fenced_code_blocks: true)
 
-    markdown.render(article_content)
+    markdown.render(post_content)
   end
 
-  def self.list_articles(tag = "", in_progress: "true")
-    articles_yml_result = YAML.load_file("app/articles/articles.yml")["articles"]
-    articles = Article.build_list_of_articles(articles_yml_result)
+  def self.list_posts(tag = "", in_progress = "true")
+    posts_yml_result = YAML.load_file("app/posts/posts.yml")["posts"]
+    posts = Post.build_list_of_posts(posts_yml_result)
 
     if tag.present?
-      articles = articles.filter { |article| article.tags.include?(tag) }
+      posts = posts.filter { |post| post.tags.include?(tag) }
     end
 
-    if in_progress == "true"
-      articles = articles.filter { |article| article.in_progress }
+    posts = if in_progress == "true"
+      posts.filter { |post| post.in_progress }
     else
-      articles = articles.filter { |article| !article.in_progress }
+      posts.filter { |post| !post.in_progress }
     end
 
-    articles.sort_by(&:id).reverse!
+    posts.sort_by(&:id).reverse!
   end
 end

data/simpleblog.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name = "simpleblog"
+  s.version = "1.0.1"
+  s.summary = "Helpers to generate markdown blog pages using Rails"
+  s.description = "Create a simple blog that can be edit with markdown"
+  s.authors = ["Caroline Salib"]
+  s.email = "carolinesalibc@gmail.com"
+  s.files = Dir.glob("{lib}/**/*")
+  s.files += ["simpleblog.gemspec"]
+  s.bindir = "exe"
+  s.executables = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.homepage = "https://rubygems.org/gems/simpleblog"
+  s.metadata = {"source_code_uri" => "https://github.com/carolinesalib/simpleblog"}
+  s.license = "MIT"
+
+  s.add_runtime_dependency "redcarpet"
+  s.add_runtime_dependency "rouge"
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: simpleblog
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Caroline Salib
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
-dependencies: []
+date: 2022-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create a simple blog that can be edit with markdown
 email: carolinesalibc@gmail.com
 executables: []
@@ -17,10 +45,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/simpleblog.rb
+- lib/simpleblog/post.rb
+- lib/simpleblog/railtie.rb
+- lib/simpleblog/rake.rb
+- lib/simpleblog/template/app/assets/stylesheets/blog.scss
+- lib/simpleblog/template/app/assets/stylesheets/layouts/application.scss
+- lib/simpleblog/template/app/assets/stylesheets/rouge.scss.erb
+- lib/simpleblog/template/app/controllers/blog_controller.rb
+- lib/simpleblog/template/app/controllers/home_controller.rb
+- lib/simpleblog/template/app/helpers/blog_helper.rb
+- lib/simpleblog/template/app/posts/1.md
+- lib/simpleblog/template/app/posts/2.md
+- lib/simpleblog/template/app/posts/posts.yml
+- lib/simpleblog/template/app/views/blog/index.html.erb
+- lib/simpleblog/template/app/views/blog/show.html.erb
+- lib/simpleblog/template/app/views/home/index.html.erb
+- lib/simpleblog/template/app/views/layouts/application.html.erb
+- lib/simpleblog/template/config/routes.rb
+- simpleblog.gemspec
 homepage: https://rubygems.org/gems/simpleblog
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/carolinesalib/simpleblog
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -39,6 +86,5 @@ requirements: []
 rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Simpler than a regular Rails blog and more dynamically customizable than
-  a Jekyll blog
+summary: Helpers to generate markdown blog pages using Rails
 test_files: []