blog_boi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09ac692bef7327594881b23ee820dd5e3ae06550a6473637451e0b4f6590e9bd'
+  data.tar.gz: 464037cdd2cf13aa869203177137aba5d6df3a81036f409cbfe2b7eece2eb16f
+SHA512:
+  metadata.gz: 457d65d6077b50b949c843205ad8e8c7392aa3471154e72dc7e5fcfa6323df272972cff11da62cffa4bf88fead7d65db88401674149a42fa00edabf7b6e139ef
+  data.tar.gz: 719979962e8672cb6706d009e974d75375334fac2f52f61fdaaf94a6f93987f52ddbbc3b02088dacbd9d5ac472e0c39f73a56594d7c058ea41a9efa536a56eb6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# BlogBoi
+
+BlogBoi is a rails gem / engine that provides out-of-the-box blogging functionality to your rails application
+
+## A) Installation
+
+1. Add this line to your application's Gemfile:
+
+```ruby
+gem 'blog_boi', 
+	git: "git@github.com:charliereese/blog_boi.git",
+	tag: "v0.0.1"
+```
+
+_Note: path may move to github and not be relative_
+
+2. Add these lines to your config/application.rb file:
+
+```ruby
+require "active_storage/engine" # If doesn't exist already
+
+ActiveStorage::Engine.config
+.active_storage
+.content_types_to_serve_as_binary
+.delete('image/svg+xml')
+```
+
+3. And then execute:
+
+```bash
+$ bundle
+$ rake active_storage:install `# If hasn't been run yet`
+$ rails blog_boi:install:migrations `# not needed for dummy test application`
+$ rails db:migrate
+```
+
+Your storage.yml file should now have this code:
+
+```
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+```
+
+_Note: $ rails railties:install:migrations to copy all new migrations_
+_Note: to run migrations only for certain engine, rails db:migrate SCOPE=blog_boi. To revert all migrations from blog_boi engine you can run rails db:migrate SCOPE=blog_boi VERSION=0_
+
+4. And then mount the engine in your app's config/routes.rb file:
+
+```ruby
+mount BlogBoi::Engine, at: "/blog"
+```
+
+5. Customize scss colour scheme by creating `stylesheets/bootstrap_customizer.scss`. See example in `test/dummy/app/assets/stylesheets`.
+
+6. And then add the engines configuration options in an initializer file (named blog_boi.rb):
+
+```ruby
+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.
+
+## B) Running tests
+
+- Run all tests other than system: `rake app:test`
+- Run system tests: `rake app:test:system`
+- Run all tests: `rake` or `rake test`
+- In normal rails apps: running single test is possible, but not sure how (or if functionality included out of box for engine). Can also run a particular test method from the test case by providing the -n or --name flag. Can also run an entire directory of tests by providing the path to the directory. I don't think any of this works out of the box for engines. How can I get this to work?
+
+**B.1 Test coverage**
+
+Exists in `coverage` folder in root directory.
+
+To view in a browser, execute from root directory: `open coverage/index.html`
+
+## C) Custom style / SCSS
+
+To override SCSS bootstrap mixins / styles, add a file in parent application called blog_boi/bootstrap_overrides.scss. 
+- See test/dummy app for example
+- https://getbootstrap.com/docs/4.0/getting-started/theming/ for theming examples (any colours you add, like c1, can be used like btn-c1. Very cool)
+
+Override the header or footer by placing your own files at `views/layouts/_header` or `views/layouts/_footer`
+
+## D) Other useful commands
+
+- `rake db:drop db:create db:migrate db:seed` or `db:migrate:reset db:seed` will remove and recreate and reseed db. Avoid using if possible.
+- `rake db:migrate:reset db:seed`
+
+## E) License
+
+The gem is currently private property. It will eventually be made available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BlogBoi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/blog_boi_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/blog_boi .js
+//= link_directory ../stylesheets/blog_boi .css

data/app/assets/images/blog_boi/star.svg

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg width="30px" height="30px" viewBox="0 0 30 30" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+    <!-- Generator: Sketch 57.1 (83088) - https://sketch.com -->
+    <title>Star</title>
+    <desc>Created with Sketch.</desc>
+    <g id="Star" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
+        <polygon fill="#F5A623" points="15 22.5 6.18322122 27.1352549 7.86707613 17.3176275 0.734152256 10.3647451 10.5916106 8.93237254 15 0 19.4083894 8.93237254 29.2658477 10.3647451 22.1329239 17.3176275 23.8167788 27.1352549"></polygon>
+    </g>
+</svg>

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

@@ -0,0 +1,18 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery3
+//= require popper
+//= require bootstrap-sprockets
+//= require rails-ujs
+//= require activestorage
+//= require_tree .

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

@@ -0,0 +1,13 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// 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

@@ -0,0 +1,11 @@
+main.blog-boi.blog.index {
+	
+	a.article {
+	  text-decoration: none;
+	}
+
+	.star {
+		margin-bottom: -29px;
+	}
+	
+}

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

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

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

@@ -0,0 +1,13 @@
+header.blog-boi-blog {
+	
+	img.logo {
+		height: 35px;
+	}
+
+	nav {
+	  flex-wrap: nowrap;
+	  overflow-x: auto;
+	  white-space: nowrap;
+	}
+	
+}

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

@@ -0,0 +1,48 @@
+@import 'blog_boi/_blog';
+@import 'blog_boi/_header';
+@import 'blog_boi/_footer';
+
+[class^="btn"] {
+	padding: 8px;
+	display: inline-block;
+}
+
+h1, h2, h3, h4, h5, h6 {
+	margin-bottom: 0;
+}
+
+.lead {
+	font-size: 18px;
+}
+
+.mb-neg-md-125-sm-50 {
+	margin-bottom: -125px;
+}
+
+.mt-md-125-sm-50 {
+	margin-top: 125px;
+}
+
+.font-16px {
+	font-size: 16px !important;
+}
+
+@media (max-width: 768px) { 
+
+	.border-top-sm-only {
+		border-top: 1px solid white;	
+	}
+
+	.lead {
+		font-size: 16px;
+	}
+
+	.mb-neg-md-125-sm-50 {
+		margin-bottom: -50px;
+	}
+
+	.mt-md-125-sm-50 {
+		margin-top: 50px;
+	}
+	
+}

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

@@ -0,0 +1,7 @@
+// To override, create boostrap_customizer.scss file in parent application 
+// and @import your overrides and then bootstrap
+
+// To see available overrides, check out _variables.scss
+// in Bootstrap source code
+
+$font-family-sans-serif: 'Roboto';

data/app/assets/stylesheets/bootstrap_customizer.scss

@@ -0,0 +1,2 @@
+@import 'blog_boi/bootstrap_overrides';
+@import 'bootstrap';

data/app/controllers/blog_boi/application_controller.rb

@@ -0,0 +1,26 @@
+module BlogBoi
+  class ApplicationController < ::ApplicationController
+    protect_from_forgery with: :exception
+    before_action :create_meta_tags_obj
+
+    # TBU
+  	def is_admin
+  		if true 
+  			true
+  		else
+  			redirect_to root_path
+  		end 
+  	end
+
+    protected
+
+    def set_categories
+    	@categories = Category.all
+    end
+
+    def create_meta_tags_obj
+    	@meta_tags = {}
+    end
+
+  end
+end

data/app/controllers/blog_boi/articles_controller.rb

@@ -0,0 +1,77 @@
+require_dependency "blog_boi/application_controller"
+
+module BlogBoi
+  class ArticlesController < ApplicationController
+    before_action :set_article, only: [:edit, :update, :destroy] 
+    before_action :set_article_by_slug, only: [:show]
+    before_action :is_admin, only: [:new, :create, :edit, :update, :destroy]
+    before_action :set_categories
+
+    # GET /articles
+    def index
+      @articles = Article.all
+    end
+
+    # GET /articles/1
+    def show
+    	@meta_tags[:title] = @article[:title]
+    end
+
+    # GET /articles/new
+    def new
+      @article = Article.new
+    end
+
+    # GET /articles/1/edit
+    def edit
+    end
+
+    # POST /articles
+    def create
+      @article = Article.new(article_params)
+
+      if @article.save
+        redirect_to article_path(@article.slug), notice: 'Article was successfully created.'
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /articles/1
+    def update
+      if @article.update(article_params)
+        redirect_to article_path(@article.slug), notice: 'Article was successfully updated.'
+      else
+        render :edit
+      end
+    end
+
+    # DELETE /articles/1
+    def destroy
+      @article.destroy
+      redirect_to articles_url, notice: 'Article was successfully destroyed.'
+    end
+
+    # GET /articles/category/cool_category
+    def category_index
+    	@articles = Article.with_category_name(params[:category_name])
+    	@category_title = params[:category_name].titleize
+    	render :index
+    end
+
+    private
+      def set_article_by_slug
+      	@article = Article.find_by(slug: params[:id])
+      end
+
+      # Use callbacks to share common setup or constraints between actions.
+      def set_article
+        @article = Article.find(params[:id])
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def article_params
+        params.require(:article).permit(:title, :text, :author_name, :category_names, :slug, :description, :image)
+      end
+  end
+end

data/app/controllers/blog_boi/comments_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "blog_boi/application_controller"
+
+module BlogBoi
+  class CommentsController < ApplicationController
+  	before_action :set_categories, :is_admin
+
+  	def create
+		  @article = Article.find(params[:article_id])
+		  @comment = @article.comments.create(comment_params)
+		  flash[:notice] = "Comment has been created!"
+		  redirect_to articles_path
+		end
+		 
+		private
+		  
+	  def comment_params
+	    params.require(:comment).permit(:text)
+	  end
+
+  end
+end

data/app/helpers/blog_boi/application_helper.rb

@@ -0,0 +1,31 @@
+require 'byebug'
+
+module BlogBoi
+  
+  module ApplicationHelper
+  	
+  	# Iterates over BlogBoi module class variables
+  	# and creates helper methods for them
+
+  	BlogBoi.class_variables.each do |class_var|
+  	
+  		mattr_name = class_var.to_s[2..-1]
+
+  		define_method(mattr_name) do
+  			BlogBoi.send(mattr_name)
+  		end
+
+  	end
+
+  	# TBU
+  	def is_admin
+  		true
+  	end
+  
+  	def controller_action
+  		action_name
+  	end
+
+  end
+
+end

data/app/helpers/blog_boi/articles_helper.rb

@@ -0,0 +1,4 @@
+module BlogBoi
+  module ArticlesHelper
+  end
+end

data/app/helpers/blog_boi/comments_helper.rb

@@ -0,0 +1,4 @@
+module BlogBoi
+  module CommentsHelper
+  end
+end

data/app/jobs/blog_boi/application_job.rb

@@ -0,0 +1,4 @@
+module BlogBoi
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/blog_boi/application_mailer.rb

@@ -0,0 +1,6 @@
+module BlogBoi
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/blog_boi/application_record.rb

@@ -0,0 +1,5 @@
+module BlogBoi
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/blog_boi/article.rb

@@ -0,0 +1,70 @@
+require 'kramdown'
+
+module BlogBoi
+  class Article < ApplicationRecord
+  	attr_writer :category_names, :author_name
+  	
+  	#########################
+		# Associations
+		#########################
+
+  	has_many :comments
+  	has_and_belongs_to_many :categories, foreign_key: "blog_boi_category_id", association_foreign_key: "blog_boi_article_id"
+		belongs_to :author, class_name: BlogBoi.author_class.to_s
+		has_one_attached :image
+		
+		#########################
+		# Before hooks
+		#########################
+
+		before_validation :set_author, :set_categories
+
+		#########################
+		# Scopes
+		#########################
+		
+		scope :with_category_name, lambda { |category_name| 
+			joins(:categories).merge(Category.where({name: category_name}))
+		}
+
+		#########################
+		# Methods
+		#########################
+
+		def read_time
+			length = (self.text.split.length / 200.0).ceil.to_s
+			
+			if length != '1'
+				length + " minutes"
+			else
+				length + " minute"
+			end
+		end
+
+		def author_name
+			@author_name || author && author.name || nil
+		end
+
+		def category_names
+			@category_names || categories.pluck(:name).join(', ')
+		end
+
+		def markdown_text
+			Kramdown::Document.new(text).to_html
+		end
+
+		private
+
+		def set_author
+	    self.author = BlogBoi.author_class.find_or_create_by(name: author_name)
+	  end
+
+	  def set_categories
+	  	self.categories = []
+
+	  	category_names.split(', ').each do |category_name|
+	  		self.categories << Category.find_or_create_by(name: category_name)
+	  	end
+	  end
+  end
+end

data/app/models/blog_boi/category.rb

@@ -0,0 +1,12 @@
+module BlogBoi
+  class Category < ApplicationRecord
+  	#########################
+		# Associations
+		#########################
+  	has_and_belongs_to_many :articles, foreign_key: "blog_boi_article_id", association_foreign_key: "blog_boi_category_id"
+  
+  	#########################
+		# Methods
+		#########################
+  end
+end

data/app/models/blog_boi/comment.rb

@@ -0,0 +1,11 @@
+module BlogBoi
+  class Comment < ApplicationRecord
+  	#########################
+		# Associations
+		#########################
+
+  	#########################
+		# Methods
+		#########################
+  end
+end

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

@@ -0,0 +1,41 @@
+<div class="col-12 col-md-9 col-lg-6 d-block mx-auto mt-4">
+
+	<%= render partial: 'category', collection: article.categories %>
+
+  <a class="d-block article mt-2" 
+		href="/blog/<%= article.slug %>">
+  	
+  	<h2 class="text-blue mb-0">
+  		<%= article.title %>		
+  	</h2>
+  	
+  </a>
+  
+  <div class="mt-2">
+
+  	<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>
+
+  	</ul>
+	
+	</div>
+	
+
+	<% if is_admin %>
+	
+		<div class="mt-2">
+	    <%= link_to 'Show', article %> |
+	    <%= link_to 'Edit', edit_article_path(article) %> |
+	    <%= link_to 'Destroy', article, method: :delete, data: { confirm: 'Are you sure?' } %>	
+		</div>
+
+	<% end %>
+
+</div>

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

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

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

@@ -0,0 +1,7 @@
+<% badge_class ||= nil %>
+
+<a class="badge border border-primary mx-1 text-primary <%= badge_class %>" href="/blog/category/<%= category.name.downcase %>">
+	
+	<%= category.name.capitalize %>
+		
+</a>