blog_boi 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a456021f5a432830adc986e89735e394c7b33173fcedce3e61a2816f0f0b53d
-  data.tar.gz: 8986ef7e0032f0a6c0441ffa4b1373fa0e58764e48d1f7544313610844ef0037
+  metadata.gz: 31645c10388c99890a39ed3cbc1014c1737342b8a3de3852546385b596b08b2b
+  data.tar.gz: 8f67cc1616593ae250c446eb10543d90214b594cd6e052ee00793405aca26a36
 SHA512:
-  metadata.gz: ea17c3c5344b1a36749734d75b797f6e187a8c8f59d4559b00ee81a9fe413fc2cd47f44f6c0bc1dcf159b5ca916ec362cc958c4b0076268305e9e761b3df0c02
-  data.tar.gz: 4f925f2a73151ce58c697763fdc3d1962541618c20433527be70718b8f814aefe971e40bcd45e3b4ec948844697b481b08209d737d1cab561ae17cf4a6ecd91e
+  metadata.gz: 0b30b08d8e722878e01adbd7628ce0f8bca54227a5897e969ee19912b67879056cc740c69801ed368825a2b2453bf5842c533c31a2cde68a40abfd0e330a14a4
+  data.tar.gz: 060ff5ea76418a59046d97ed749b91a7e82ec40675a015df563f1e31773dade9ffe743342e26c2b97f3b49856217b025369ed6d22a78732190fac90e722ff027

data/README.md

@@ -1,6 +1,10 @@
+By [Charlie Reese](https://charliereese.ca/about) at [Clientelify](https://clientelify.com)
+
 # BlogBoi
 
-BlogBoi is a rails gem / engine that provides out-of-the-box blogging functionality to your rails application
+BlogBoi is a rails gem / engine that provides out-of-the-box blogging functionality to your rails application. 
+
+It requires active_storage for photo upload / storage.
 
 ## Installation
 
@@ -10,8 +14,6 @@ BlogBoi is a rails gem / engine that provides out-of-the-box blogging functional
 gem 'blog_boi', '~> 0'
 ```
 
-_Note: path may move to github and not be relative_
-
 2. Add these lines to your config/application.rb file:
 
 ```ruby
@@ -28,6 +30,7 @@ ActiveStorage::Engine.config
 ```bash
 $ bundle
 $ rake active_storage:install `# If hasn't been run yet`
+$ rake active_storage:update # if upgrading to rails 6
 $ rails blog_boi:install:migrations `# not needed for dummy test application`
 $ rails db:migrate
 ```
@@ -36,12 +39,12 @@ Your storage.yml file should now have this code:
 
 ```
 test:
-  service: Disk
-  root: <%= Rails.root.join("tmp/storage") %>
+	service: Disk
+	root: <%= Rails.root.join("tmp/storage") %>
 
 local:
-  service: Disk
-  root: <%= Rails.root.join("storage") %>
+	service: Disk
+	root: <%= Rails.root.join("storage") %>
 ```
 
 _Note: $ rails railties:install:migrations to copy all new migrations_
@@ -61,18 +64,18 @@ mount BlogBoi::Engine, at: "/blog"
 BlogBoi.author_class = "User" # name of active record model containing authors with property called name (for author's name)
 ```
 
-See lib/blog_boi.rb for all customization options.
+See lib/blog_boi.rb for all customization options (like setting your Blog's meta description / image).
 
 7. Finally, your parent application must define the method `admin_signed_in?`. If you are using Devise, this method may already exist. It should return true if the blog admin is signed in, and false if not. When it returns true, you may create, update, and destroy blog articles. It should be available in controllers and views; it should be defined in ApplicationController, and should be marked a helper method. E.g.
 
 ```
 class ApplicationController < ActionController::Base
 
-  helper_method :admin_signed_in?
+	helper_method :admin_signed_in?
 
-  def admin_signed_in?
-    ...
-  end
+	def admin_signed_in?
+		...
+	end
 
 end
 ```
@@ -91,6 +94,11 @@ To override SCSS bootstrap mixins / styles, add a file in parent application cal
 
 Override the header or footer by placing your own files at `views/layouts/_header` or `views/layouts/_footer`
 
+Further, you can add your own css classes / ids to your markup: 
+- https://kramdown.gettalong.org/quickref.html
+- https://about.gitlab.com/blog/2016/07/19/markdown-kramdown-tips-and-tricks/
+- `{: .cls}`
+
 ## Running tests
 
 - Run all tests other than system: `rake app:test`
@@ -109,9 +117,7 @@ The gem is currently available as open source software under the terms of the [M
 
 ## Contributing
 
-This gem is currently not actively accepting contributions. 
-
-With that in mind, if you'd like to make a fix / change, please create a pull request (and when I have a moment - probably in a couple weeks time - I'll have a look)!
+If you'd like to make a fix / change, please create a pull request; when I have a moment, I'll have a look!
 
 ## Updating gem version (for maintainers)
 
@@ -129,5 +135,8 @@ In `lib/blog_boi/version.rb` update version.
 
 **4. Tag GitHub**
 
+`git add -A`
+`git commit -m "Msg"`
+`git push`
 `git tag -a vX.X.X -m "Msg"`
-`git push --tags`
+`git push --tags`

data/app/assets/javascripts/blog_boi/global.js

@@ -2,12 +2,5 @@
 // All this logic will automatically be available in application.js.
 
 $(function() {
-    adjustMainPadding();
 });
 
-function adjustMainPadding() {
-	var footerHeight = +$('footer.blog-boi-blog').css('height').slice(0,-2);
-	footerHeight += 10;
-
-	$('main.blog-boi').css('padding-bottom', footerHeight + 'px');
-}

data/app/assets/stylesheets/blog_boi/_blog.scss

@@ -9,3 +9,32 @@ main.blog-boi.blog.index {
 	}
 	
 }
+
+main.blog-boi.blog.show {
+
+	div.article-body {
+
+		h1, h2, h3, h4, h5, h6 {
+			margin-bottom: 1rem;
+		}
+
+		h1 {
+			margin-top: 2.5rem;
+			margin-bottom: 1.25rem;
+		}
+
+		h2, h3 {
+			margin-top: 2rem;
+		}
+
+		h4, h5 {
+			margin-top: 1.4rem;
+		}
+
+		h6 {
+			margin-top: 1rem;
+		}
+
+	}
+
+}

data/app/assets/stylesheets/blog_boi/_footer.scss

@@ -1,7 +1,5 @@
 footer.blog-boi-blog {
 	
-	position: fixed;
-	bottom: 0;
 	width: 100%;
 	
-}
+}

data/app/assets/stylesheets/blog_boi/application.scss

@@ -27,6 +27,10 @@ h1, h2, h3, h4, h5, h6 {
 	font-size: 16px !important;
 }
 
+.badge {
+  text-decoration: none;
+}
+
 @media (max-width: 768px) { 
 
 	.border-top-sm-only {

data/app/controllers/blog_boi/application_controller.rb

@@ -21,7 +21,9 @@ module BlogBoi
     end
 
     def create_meta_tags_obj
-    	@meta_tags = {}
+    	@meta_tags = {
+    		image: helpers.image_url(BlogBoi.blog_meta_image)
+    	}
     end
 
   end

data/app/controllers/blog_boi/articles_controller.rb

@@ -9,12 +9,17 @@ module BlogBoi
 
     # GET /articles
     def index
-      @articles = Article.all
+      @articles = Article.all.where({hidden: false})
+      @articles_hidden = Article.all.where({hidden: true})
     end
 
     # GET /articles/1
     def show
-    	@meta_tags[:title] = @article[:title]
+    	@meta_tags = {
+    		title: @article.title,
+    		description: @article.description,
+    		image: @article.image.attached? ? main_app.url_for(@article.image) : nil,
+    	}
     end
 
     # GET /articles/new
@@ -54,7 +59,7 @@ module BlogBoi
 
     # GET /articles/category/cool_category
     def category_index
-    	@articles = Article.with_category_name(params[:category_name])
+    	@articles = Article.with_category_name(params[:category_name]).where(hidden: false)
     	@category_title = params[:category_name].titleize
     	render :index
     end
@@ -71,7 +76,7 @@ module BlogBoi
 
       # Only allow a trusted parameter "white list" through.
       def article_params
-        params.require(:article).permit(:title, :text, :author_name, :category_names, :slug, :description, :image)
+        params.require(:article).permit(:title, :text, :author_name, :category_names, :slug, :description, :image, :hidden)
       end
   end
 end

data/app/views/blog_boi/articles/_article.html.erb

@@ -1,9 +1,9 @@
-<div class="col-12 col-md-9 col-lg-6 d-block mx-auto mt-4">
+<div class="col-12 col-md-9 col-lg-7 d-block mx-auto mt-4">
 
 	<%= render partial: 'category', collection: article.categories %>
 
   <a class="d-block article mt-2" 
-		href="/blog/<%= article.slug %>">
+		href="<%= root_url + article.slug %>">
   	
   	<h2 class="text-blue mb-0">
   		<%= article.title %>		
@@ -15,12 +15,8 @@
 
   	<ul class="list-inline mb-0">
   	
-  		<li class="list-inline-item">
-  			<%= article.author.name %>
-  		</li>
-
-  		<li class="list-inline-item">
-  			<%= article.updated_at.strftime("%B %e, %Y") %>
+  		<li class="list-inline-item text-muted">
+  			by <%= article.author.name %> on <%= article.updated_at.strftime("%B %e, %Y") %>
   		</li>
 
   	</ul>
@@ -38,4 +34,4 @@
 
 	<% end %>
 
-</div>
+</div>

data/app/views/blog_boi/articles/_article_body.html.erb

@@ -1,4 +1,4 @@
-<div class="col-12 mt-5 text-left">
+<div class="col-12 mt-5 text-left article-body">
 	
 	<%= raw @article.markdown_text %>
 

data/app/views/blog_boi/articles/_form.html.erb

@@ -24,11 +24,21 @@
     <%= form.text_field :title, placeholder: 'e.g. Great Title: 3 Reasons Why', class: 'form-control' %>
   </div>
 
+  <div class="field mt-3">
+    <%= form.label :description %>
+    <%= form.text_field :description, placeholder: 'e.g. The 3 reasons why you must use the BlogBoi engine', class: 'form-control' %>
+  </div>
+
   <div class="field mt-3">
     <%= form.label :slug %>
     <%= form.text_field :slug, placeholder: 'e.g. appointment-reminders-for-dentists', class: 'form-control' %>
   </div>
 
+  <div class="field mt-3">
+    <%= form.check_box :hidden %>
+    <%= form.label :hidden %>
+  </div>
+
   <div class="field mt-3">
     <%= form.label :category_names %>
     <%= form.text_field :category_names, placeholder: 'e.g. no-shows, sales growth', class: 'form-control' %>

data/app/views/blog_boi/articles/edit.html.erb

@@ -11,7 +11,7 @@
 				<%= render 'form', article: @article %>
 
 				<div class="mt-3">
-					<%= link_to 'Show', @article %> |
+					<%= link_to 'Show', root_url + @article.slug %> |
 					<%= link_to 'Back', articles_path %>
 				</div>
 				

data/app/views/blog_boi/articles/index.html.erb

@@ -9,12 +9,24 @@
 			<% if is_admin? %>
 
 				<div class="col-12 mt-4">
-					<%= link_to 'New Article', new_article_path, class: 'btn-primary rounded' %>
+					<%= link_to 'New Article', new_article_path, class: 'btn btn-primary rounded' %>
 				</div>
 
 			<% end %>
 			
 			<%= render @articles %>
+
+			<% if is_admin? %>
+
+				<h1 class="text-center col-12 mt-5">Hidden articles:</h1>
+
+				<% @articles_hidden && @articles_hidden.each do |article_hidden| %>
+
+					<%= render 'article', article: article_hidden %>
+
+				<% end %>
+
+			<% end %>
 			
 		</div>
 

data/app/views/blog_boi/articles/show.html.erb

@@ -1,4 +1,4 @@
-<main class="blog-boi blog edit">
+<main class="blog-boi blog show">
 
 	<div class="bg-primary">
 		
@@ -22,11 +22,11 @@
 
 	</div>
 
-	<div class="container mt-md-125-sm-50">
+	<div class="container <%= @article.image.attached? ? 'mt-md-125-sm-50' : '' %>">
 		
 		<div class="row">
 
-			<div class="col-12 col-md-10 col-lg-7 mx-auto text-center mt-4">
+			<div class="col-12 col-md-10 col-lg-7 mx-auto text-center mt-5">
 
 				<div>
 					<%= render partial: 'category', collection: @article.categories %>
@@ -37,8 +37,8 @@
 				</h1>
 
 				<div class="mt-3 text-muted">
-				  <%= @article.author.name %>, 
-				  <%= @article.updated_at.strftime("%B %e, %Y") %>
+				  by <%= @article.author.name %> 
+				  on <%= @article.updated_at.strftime("%B %e, %Y") %>
 				</div>
 
 				<%= render 'article_body' %>

data/app/views/layouts/blog_boi/_footer.html.erb

@@ -1,21 +1,17 @@
-<footer class="blog-boi-blog">
+<footer class="blog-boi-blog pt-5">
 
-	<div class="bg-dark text-white">
+  <div class="container">
 
-		<div class="container">
+    <div class="row">
+      
+      <div class="col-12 py-3 text-center text-muted">
+        
+        <div>© <%= company_name %> <%= Time.current.year %></div>
 
-			<div class="row">
-				
-				<div class="col-12 py-3 text-center">
-					
-					<div>© <%= company_name %> <%= Time.current.year %></div>
+      </div>
 
-				</div>
+    </div>
 
-			</div>
-
-		</div>
-	
-	</div>
+  </div>
 
 </footer>

data/app/views/layouts/blog_boi/_head_meta_tags.html.erb

@@ -1,7 +1,12 @@
-<title><%= @meta_tags[:title] || company_name + ' Blog' %></title>
+<title>
+	<%= @meta_tags[:title] || company_name + ' Blog' %>		
+</title>
 <meta property="og:title" content="<%= @meta_tags[:title] || blog_seo_title %>" />
 
+<meta name="description" content="<%= @meta_tags[:description] || blog_seo_description %>" />
+<meta property="og:description" content="<%= @meta_tags[:description] || blog_seo_description %>" />
+
 <meta property="og:site_name" content="<%= company_name %>" />
+<meta property="og:type" content="article">
 
-<meta name="description" content="<%= @meta_tags[:description] || blog_seo_description %>" />
-<meta property="og:description" content="<%= @meta_tags[:description] || blog_seo_description %>" />
+<meta property="og:image" content="<%= @meta_tags[:image] %>"/>

data/app/views/layouts/blog_boi/_header.html.erb

@@ -16,7 +16,7 @@
 
 				<div class="col-12 col-md-6 col-lg-5 text-primary-light font-weight-light mt-3 mt-md-0">
 					<em>
-						Brought to you by <a href="/" class="text-orange"><%= company_name %></a>, a <%= company_description %>
+						Brought to you by <a href="/" class="text-orange"><%= company_name %></a>, <%= company_description %>
 					</em>
 				</div>
 

data/db/migrate/20191007141852_add_hidden_column_to_articles.rb

@@ -0,0 +1,6 @@
+class AddHiddenColumnToArticles < ActiveRecord::Migration[6.0]
+  def change
+  	add_column :blog_boi_articles, :hidden, :boolean
+  	add_index :blog_boi_articles, :hidden
+  end
+end

data/lib/blog_boi.rb

@@ -3,7 +3,7 @@ require "blog_boi/error_classes"
 
 module BlogBoi
   mattr_accessor :author_class, :company_name, :company_logo_path, :company_description, :blog_description,
-  	:blog_seo_description, :blog_seo_title
+  	:blog_seo_description, :blog_seo_title, :blog_meta_image
 
   class << self
 		def author_class
@@ -20,11 +20,12 @@ module BlogBoi
   
   # Company info
   self.company_name = 'SaaSy'
-  self.company_description = 'business that does xyz'
+  self.company_description = 'A business that does xyz'
   self.company_logo_path = 'blog_boi/logo'
 
   # Blog info
   self.blog_description = 'We help your business reduce no-shows, get more reviews, and increase sales and productivity: detailed tutorials and insight from business owners and experts'
   self.blog_seo_description = blog_description
   self.blog_seo_title = blog_seo_title
+  self.blog_meta_image = 'blog_boi/logo'
 end

data/lib/blog_boi/engine.rb

@@ -6,7 +6,6 @@ module BlogBoi
     require 'jquery-rails'
     require 'rails-ujs'
 
-
 		initializer "blog_boi.assets.precompile" do |app|
 			app.config.assets.precompile += %w( bootstrap_customizer.scss blog_boi/logo.png blog_boi/star.svg )
 		end

data/lib/blog_boi/version.rb

@@ -1,3 +1,3 @@
 module BlogBoi
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blog_boi
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Charlie Reese
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-05 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -56,14 +56,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 5.0.0.alpha1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: 5.0.0.alpha1
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -112,8 +112,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Easily add blogging functionality to your rails project using BlogBoi.
-  WARNING: v0.0.1 and v0.0.2 are not yet stable / production ready.'
+description: Easily add blogging functionality to your rails project using BlogBoi.
 email:
 - j.charles.reese@gmail.com
 executables: []
@@ -169,6 +168,7 @@ files:
 - db/migrate/20190729022622_create_join_table_article_category.rb
 - db/migrate/20190820235901_add_description_to_blog_boi_articles.rb
 - db/migrate/20190911003115_add_slug_to_article.rb
+- db/migrate/20191007141852_add_hidden_column_to_articles.rb
 - db/seeds.rb
 - lib/blog_boi.rb
 - lib/blog_boi/engine.rb
@@ -180,7 +180,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/charliereese/blog_boi
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -195,9 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: BlogBoi is a rails engine for adding blogging functionality to your rails
   project.