blog_boi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9edccc6733c4fd1af893fd5f01ee68ee9f47a9d44a35fa1c67f9024314607552
-  data.tar.gz: 9521dcbf140d316907f8b26dd64470e10b8726bd9068f627ae05c3f73dffedd8
+  metadata.gz: 4a456021f5a432830adc986e89735e394c7b33173fcedce3e61a2816f0f0b53d
+  data.tar.gz: 8986ef7e0032f0a6c0441ffa4b1373fa0e58764e48d1f7544313610844ef0037
 SHA512:
-  metadata.gz: cc9ed6b88e1041a55f2a6f79878d0602e4e7129a1196d76022662c09081480921c6bf0a8864778c0d467bb67a140cd6e8a8a35e0984569f9aea43cd729484ed4
-  data.tar.gz: 9fc77ff8add34fa38b08b4828ffec34241742e3e092a2b483f4c5832c5292c8aae0bda1c316439ef92c5ca6334b09e30d157807e942bddb6bcf31f66cc22ae0e
+  metadata.gz: ea17c3c5344b1a36749734d75b797f6e187a8c8f59d4559b00ee81a9fe413fc2cd47f44f6c0bc1dcf159b5ca916ec362cc958c4b0076268305e9e761b3df0c02
+  data.tar.gz: 4f925f2a73151ce58c697763fdc3d1962541618c20433527be70718b8f814aefe971e40bcd45e3b4ec948844697b481b08209d737d1cab561ae17cf4a6ecd91e

data/README.md

@@ -2,9 +2,7 @@
 
 BlogBoi is a rails gem / engine that provides out-of-the-box blogging functionality to your rails application
 
-WARNING: v0.0.1 and v0.0.2 are not yet stable / production ready
-
-## A) Installation
+## Installation
 
 1. Add this line to your application's Gemfile:
 
@@ -65,20 +63,27 @@ BlogBoi.author_class = "User" # name of active record model containing authors w
 
 See lib/blog_boi.rb for all customization options.
 
-## B) Running tests
+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.
 
-- 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?
+```
+class ApplicationController < ActionController::Base
 
-**B.1 Test coverage**
+  helper_method :admin_signed_in?
 
-Exists in `coverage` folder in root directory.
+  def admin_signed_in?
+    ...
+  end
 
-To view in a browser, execute from root directory: `open coverage/index.html`
+end
+```
+
+## View partial hooks
+
+List of view partial hooks that are rendered if they exist in parent application:
 
-## C) Custom style / SCSS
+- `layouts/blog_boi/head_extension`: (for adding html to head of blog_boi application layout in `layouts/blog_boi/application`)
+
+## 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
@@ -86,36 +91,43 @@ 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`
 
-## D) Other useful commands
+## 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`
 
-- `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`
+**Test coverage**
+
+Exists in `coverage` folder in root directory.
+
+To view in a browser, execute from root directory: `open coverage/index.html`
 
-## E) License
+## License
 
 The gem is currently available as open source software under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## F) Contributing
+## 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)!
 
-## G) Updating gem version (for maintainers)
+## Updating gem version (for maintainers)
 
-**G.1 Update version**
+**1. Update version**
 
 In `lib/blog_boi/version.rb` update version.
 
-**G.2 Build gem**
+**2. Build gem**
 
 `gem build blog_boi.gemspec`
 
-**G.3 Push gem**
+**3. Push gem**
 
 `gem push blog_boi-X.X.X.gem` (replace X's with version)
 
-**G.4 Tag GitHub**
+**4. Tag GitHub**
 
 `git tag -a vX.X.X -m "Msg"`
 `git push --tags`

data/app/controllers/blog_boi/application_controller.rb

@@ -4,12 +4,14 @@ module BlogBoi
     before_action :create_meta_tags_obj
 
     # TBU
-  	def is_admin
-  		if true 
+  	def authenticate_admin
+  		if !defined?(admin_signed_in?) 
+  			raise BlogBoi::MethodNotImplementedByParentApplication, "admin_signed_in?"
+  		elsif admin_signed_in?
   			true
   		else
   			redirect_to root_path
-  		end 
+  		end
   	end
 
     protected

data/app/controllers/blog_boi/articles_controller.rb

@@ -4,7 +4,7 @@ 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 :authenticate_admin, only: [:new, :create, :edit, :update, :destroy]
     before_action :set_categories
 
     # GET /articles

data/app/controllers/blog_boi/comments_controller.rb

@@ -2,7 +2,7 @@ require_dependency "blog_boi/application_controller"
 
 module BlogBoi
   class CommentsController < ApplicationController
-  	before_action :set_categories, :is_admin
+  	before_action :set_categories, :authenticate_admin
 
   	def create
 		  @article = Article.find(params[:article_id])

data/app/helpers/blog_boi/application_helper.rb

@@ -1,5 +1,3 @@
-require 'byebug'
-
 module BlogBoi
   
   module ApplicationHelper
@@ -17,9 +15,12 @@ module BlogBoi
 
   	end
 
-  	# TBU
-  	def is_admin
-  		true
+  	def is_admin?
+  		if defined?(admin_signed_in?) 
+  			admin_signed_in?
+  		else
+  			raise BlogBoi::MethodNotImplementedByParentApplication, "admin_signed_in?"
+  		end
   	end
   
   	def controller_action

data/app/helpers/blog_boi/articles_helper.rb

@@ -1,4 +1,7 @@
 module BlogBoi
   module ArticlesHelper
+  	def str_of_authors
+  		BlogBoi.author_class.all.pluck(:name).join(',')
+  	end
   end
 end

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

@@ -28,10 +28,10 @@
 	</div>
 	
 
-	<% if is_admin %>
+	<% if is_admin? %>
 	
 		<div class="mt-2">
-	    <%= link_to 'Show', article %> |
+	    <%= link_to 'Show', article_path(article.slug) %> |
 	    <%= link_to 'Edit', edit_article_path(article) %> |
 	    <%= link_to 'Destroy', article, method: :delete, data: { confirm: 'Are you sure?' } %>	
 		</div>

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

@@ -15,6 +15,8 @@
 	<div class="field mt-3">
 	  <%= form.label :author_name %><br>
 	  <%= form.text_field :author_name, placeholder: 'e.g. Charlie Reese', class: 'form-control' %>
+	  <small class="d-block">Existing authors: <%= str_of_authors %></small>
+	  <small class="d-block"><span class="text-danger">Warning</span>: entering a new name will create a new <%= BlogBoi.author_class || '' %> entry in DB with only name filled in.</small>
 	</div>
 
   <div class="field mt-3">

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

@@ -6,7 +6,7 @@
 		
 		<div class="row">
 
-			<% if is_admin %>
+			<% if is_admin? %>
 
 				<div class="col-12 mt-4">
 					<%= link_to 'New Article', new_article_path, class: 'btn-primary rounded' %>

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

@@ -43,16 +43,17 @@
 
 				<%= render 'article_body' %>
 
-				<% if is_admin %>
+				<div class="mt-5">
+					
+					<% if is_admin? %>
 
-					<div class="mt-5">
-						
 						<%= link_to 'Edit', edit_article_path(@article) %> |
-						<%= link_to 'Back', articles_path %>
 						
-					</div>
-
-				<% end %>
+					<% end %>
+					
+					<%= link_to 'Back', articles_path %>
+	
+				</div>
 
 			</div>
 

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

@@ -10,6 +10,8 @@
   <%= stylesheet_link_tag "blog_boi/application", media: "all" %>
   <%= stylesheet_link_tag "bootstrap_customizer", media: "all" %>
   <%= javascript_include_tag "blog_boi/application" %>
+
+  <%= render 'layouts/blog_boi/head_extension' if lookup_context.exists?('layouts/blog_boi/_head_extension') %>
 </head>
 <body>
 

data/db/migrate/20190729022622_create_join_table_article_category.rb

@@ -1,8 +1,8 @@
 class CreateJoinTableArticleCategory < ActiveRecord::Migration[5.2]
   def change
     create_join_table :blog_boi_articles, :blog_boi_categories do |t|
-      t.index [:article_id, :category_id], name: 'index_blog_boi_article_id_category_id'
-      t.index [:category_id, :article_id], name: 'index_blog_boi_category_id_article_id'
+      t.index [:blog_boi_article_id, :blog_boi_category_id], name: 'index_blog_boi_article_id_category_id'
+      t.index [:blog_boi_category_id, :blog_boi_article_id], name: 'index_blog_boi_category_id_article_id'
     end
   end
 end

data/lib/blog_boi.rb

@@ -1,4 +1,5 @@
 require "blog_boi/engine"
+require "blog_boi/error_classes"
 
 module BlogBoi
   mattr_accessor :author_class, :company_name, :company_logo_path, :company_description, :blog_description,

data/lib/blog_boi/error_classes.rb

@@ -0,0 +1,18 @@
+module BlogBoi
+	
+	class MethodNotImplementedByParentApplication < ::StandardError
+  	attr_reader :method_missing
+
+  	def initialize(method)
+    	@method_missing = method
+
+    	super(
+    		'Parent application must implement the method ' + 
+    		method_missing + 
+    		" - See BlogBoi README for requirement."
+    	)
+  	end
+	
+	end
+
+end

data/lib/blog_boi/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blog_boi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Charlie Reese
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-23 00:00:00.000000000 Z
+date: 2019-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -172,6 +172,7 @@ files:
 - db/seeds.rb
 - lib/blog_boi.rb
 - lib/blog_boi/engine.rb
+- lib/blog_boi/error_classes.rb
 - lib/blog_boi/version.rb
 - lib/tasks/blog_boi_tasks.rake
 homepage: https://github.com/charliereese/blog_boi