guider_cms 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5eb810b2be18c92e39eafdb0ec9927124a5fbe94e1c444333687857499edb523
+  data.tar.gz: 41e3722062e82b595fe50e9db2304020f375c71f3ee77c2cc67ed340d8d634f4
+SHA512:
+  metadata.gz: 3e1ba2758f3faf0a2062104e863d78a7356025fd36d079ac3e6178f6179937da21dd4bdddcf4cc67a33d0092d30dfd2b3da80cedeba0b23ba04c1e6b6e920552
+  data.tar.gz: 2d6dff252c094005189a4356128dbba933ef6890606765930557be015fbacd98145f4280bdc4551c84adab005fc4036580bd2a955241f9ab02a2ef75159036c6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Minat Silvester
+
+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,133 @@
+# GuiderCms
+GuiderCms is a plugin which provides CMS functionality for multiple root origins  
+Is Rack Based  
+Based on MVC using rails engines  
+Allows you to have a CMS for multiple purposes  
+Supports for categories and subcategories for all root origin
+
+
+## Prerequisite
+***Please Ensure you have active_storage, action_text and closure_tree gem set up in your application***
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'guider_cms'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install guider_cms
+```
+to generate the initializer file run
+```bash
+$ rails g guider_cms:install
+```
+
+In config/initializers/guider.rb set the name of your primary user model
+```ruby
+  GuiderCms.author_class = "YOUR_USER_MODEL_CLASS"
+```
+
+then to generate all the migration files
+```bash
+$ rails guider_cms:install:migrations
+```
+
+then finally create the tables
+```bash
+$ rails db:migrate
+```
+
+Once all that is done mount the engine in your main application in config/routes.rb
+```ruby
+  mount GuiderCms::Engine => "/"
+```
+***Be sure to mount the engine at "/" and not any other path***
+
+in app/models/your_user_model.rb, add
+This is done to create the association between the user and articles table
+```ruby
+has_many :guider_cms_articles , class_name: 'GuiderCms::Article', foreign_key: :author_id  
+```
+
+in your main application app/controllers/application_controller.rb
+add these two functions
+```ruby
+def current_user
+  if user is logged_in
+    @current_user = the user object
+  else
+    @current_user = nil  
+  end  
+end
+
+
+def is_guider_admin
+  if some condition to access guider functionality
+    @is_guider_admin = true
+  else
+    @is_guider_admin = false  
+  end  
+end  
+```
+
+***If you are using a engine or library that already provides a current_user method, then you can avoid declaring it seperately***
+
+in app/views/layout/application.html.erb include
+```html
+  <%= stylesheet_link_tag  "guider_cms/application", media: "all" %>
+```
+this includes all the css for the engine
+
+***You need atleast one root category to start working in guiderCMS***  
+Root categories can be things used to represent top of the any cms system  
+eg: Blogs, Articles, etc.  
+To start, navigate to guider_home_page
+```ruby
+  guider_home_path
+```
+This part will ask you to create a new root category if none exists, Then you will have to create categories that come under this root visiting home path again will take you right there
+
+## Routing
+Consider you have a root category called "Blogs"  
+And in Blogs you have categories such as Computer science and Artificial Intelligence  
+Here Computer Science and Artificial Intelligence are main categories in Root Blogs  
+Main categories can have subcategories, such as Artificial Intelligence can have subcategories such as machine learning  
+
+So your root blogs is arranged in this way  
+- Blogs
+  - Computer Science
+  - Artificial Intelligence
+    - Machine Learning
+
+To visit the home/index page:
+```ruby
+guider_home_path
+```
+To view index for specific root category:
+```ruby
+content_new_back_path(root: "Blogs")
+```
+To view index for specific root and selected category:
+```ruby
+contents_path(root: "Blogs", selected_category: "Artificial Intelligence")
+```
+the same for subcategory among the main categories
+```ruby
+contents_path(root: "Blogs", selected_category: "Machine Learning")
+```
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is 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    = 'GuiderCms'
+  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/guider_cms_manifest.js

@@ -0,0 +1,4 @@
+//= link_directory ../stylesheets/guider_cms .css
+//= link_directory ../images/guider_cms .png
+//= link guider_cms/up.png
+//= link guider_cms/down.png

data/app/assets/stylesheets/guider_cms/application.css

@@ -0,0 +1,78 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+ .card-horizontal {
+    display: flex;
+    flex: 1 1 auto;
+}
+
+ .card-img-top {
+    width: 100%;
+    height: 10vw;
+}
+
+ .grid-style{
+    padding-top: 15px;
+    padding-bottom: 25px;
+    border-radius: 12px;
+    margin-bottom: 10px;
+    background-color: #3CB371;
+    color: white;
+  }
+
+
+ .grid-style:hover{
+   background-color: #2E8B57;
+ }
+
+ /*
+  .grid-style:hover{
+    background-color: #3CB371;
+    color: white;
+  } */
+
+ .grid-link{
+   color: black;
+ }
+
+ .grid-link:hover{
+   text-decoration: none;
+   color: #3CB371;
+ }
+
+ .listing-links{
+   color: black
+ }
+
+ .listing-active-links{
+   color: #3CB371;
+ }
+
+ .essesntial-links{
+   color: black;
+ }
+
+ .essesntial-links:hover{
+   color: #3CB371;
+ }
+
+ .listing-links:hover{
+   color: black
+ }
+
+ .listing-active-links:hover{
+   color: #3CB371;
+ }

data/app/assets/stylesheets/guider_cms/articles.css

@@ -0,0 +1,18 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+
+
+.card-columns {
+  @include media-breakpoint-only(xl) {
+    column-count: 5;
+  }
+  @include media-breakpoint-only(lg) {
+    column-count: 4;
+  }
+  @include media-breakpoint-only(sm) {
+    column-count: 4;
+  }
+}

data/app/assets/stylesheets/guider_cms/categories.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/guider_cms/current_user_articles.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/guider_cms/subcategories.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}

data/app/controllers/guider_cms/application_controller.rb

@@ -0,0 +1,6 @@
+module GuiderCms
+  class ApplicationController < ::ApplicationController
+    # protect_from_forgery with: :exception
+    layout 'application'
+  end
+end

data/app/controllers/guider_cms/articles_controller.rb

@@ -0,0 +1,232 @@
+require_dependency "guider_cms/application_controller"
+
+module GuiderCms
+  class ArticlesController < ApplicationController
+    include GuiderCms::ArticlesHelper
+    before_action :set_article, only: [:edit, :update, :destroy, :edit_article_position_one_backward, :edit_article_position_one_forward]
+    # before_action :is_guider_assesible, only: [:new, :edit, :update, :destroy]
+    # before_action :is_correct_user, only: [:edit, :update, :destroy]
+    # GET /articles
+
+
+    def index
+      @root = params[:root]
+      @is_guider_admin = is_guider_admin
+      @current_user = current_user
+      @selected_category = params[:selected_category]
+      if @root.nil?
+        @root_category = Category.where(is_root_category: true).first
+        if @root_category.nil?
+          redirect_to new_optimized_category_path, alert: "Create a root category first"
+        else
+          @root = @root_category.classification
+          if @selected_category.nil?
+            @selected_category_class = @root_category
+          end
+        end
+        @children_category = @root_category.children.order(:id)
+      else
+        @root_category = Category.find_by(classification: @root) || Category.find_by(slug: @root)
+        if @selected_category.nil?
+          @selected_category_class = @root_category
+        else
+          @selected_category_class = Category.find_by(classification: @selected_category) || Category.find_by(slug: @selected_category)
+        end
+        @children_category = @root_category.children.order(:id)
+      end
+      if @root_category.view_type == "menu" || @root_category.view_type == "ordered list"
+        if @root_category.articles == [] && @root_category.children != []
+          @selected_category_class = @root_category.children.first
+        end
+      end
+      if @root_category.view_type == "ordered list"
+        if @root_category.children == []
+          redirect_to new_optimized_category_path, notice: "Create a new category under #{@root_category.classification}"
+        end
+      end
+      if @root_category.view_type == "blog grid" || @root_category.view_type == "blog list"
+        @categories = category_options_array_for_article(nil, [], @root_category.id, 0)
+        @articles_id = []
+
+        @categories.each do |category|
+          @required_category_class = Category.find_by(classification: category[0].gsub('&nbsp;', ''))
+          @required_category_class.articles.each do |article|
+            @articles_id.append(article.id)
+          end
+        end
+        @articles = Article.where(id: @articles_id).order(updated_at: :desc).page params[:page]
+
+        # @articles = Article.all.order(created_at: :desc).page params[:page]
+      end
+    end
+
+
+    # GET /articles/1
+    def show
+      @article = Article.friendly.find(params[:id])
+      @coming_from = params[:action_from]
+      @root = params[:root]
+      @selected_category = params[:selected_category]
+      if Category.find_by(classification: @root).nil?
+        @root_category = Category.find_by(slug: @root)
+      else
+        @root_category = Category.find_by(classification: @root)
+      end
+      if @selected_category.nil?
+        @selected_category = @root
+        @selected_category_class = @root_category
+      else
+        if Category.find_by(classification: @selected_category).nil?
+          @selected_category_class = Category.find_by(slug: @selected_category)
+        else
+          @selected_category_class = Category.find_by(classification: @selected_category)
+        end
+      end
+    end
+
+    # GET /articles/new
+    def new
+
+      if current_user && is_guider_admin
+
+        @root = params[:root]
+        @article = Article.new
+        if @root.nil?
+          redirect_to guider_home_path
+        else
+          if Category.find_by(classification: @root).nil?
+            @root_category = Category.find_by(slug: @root)
+          else
+            @root_category = Category.find_by(classification: @root)
+          end
+
+        end
+      else
+        redirect_to content_new_back_path(root: @root_category.slug || @root_category.classification)
+      end
+
+    end
+
+    # GET /articles/1/edit
+    def edit
+      if current_user && current_user.id != @article.author_id
+        redirect_to guider_home_path
+      else
+        @root = params[:root]
+        @categories = Category.all
+        @selected_category = Category.friendly.find(@article.category_id)
+        if @selected_category.parent.nil?
+          @root_category = @selected_category
+        else
+          @root_category = @selected_category.ancestors.last
+        end
+      end
+    end
+
+    # POST /articles
+    def create
+      @categories = Category.all
+      @article = Article.new(article_params)
+
+
+      @selected_category = Category.find(@article.category_id)
+      @root_category = @selected_category.ancestors.last
+
+      @article.author_id = current_user.id
+
+      if @article.save
+        if @root_category.nil?
+          redirect_to content_new_back_path(root: @selected_category.slug || @selected_category.classification)
+        else
+          redirect_to content_path(@article, root: @root_category.slug || @root_category.classification, selected_category: @selected_category.slug || @selected_category.classification), notice: 'Article was successfully created.'
+        end
+        # redirect_to guider_home_path
+      else
+        render :new
+      end
+    end
+
+    # PATCH/PUT /articles/1
+    def update
+
+      category_id = @article.id
+      if @article.update(article_params)
+        req_category_id = @article.id || category_id
+        @selected_category_class = Category.find(req_category_id)
+        @root_category = @selected_category_class.ancestors.last
+        # redirect_to user_articles_path, notice: 'Article was successfully updated.'
+        if @root_category.nil?
+          redirect_to content_new_back_path(root: @selected_category.slug || @selected_category.classification)
+        else
+          redirect_to content_path(@article, root: @root_category.slug || @root_category.classification, selected_category: @selected_category_class.slug || @selected_category_class.classification), notice: 'Article was successfully created.'
+        end
+
+        # redirect_to guider_home_path
+
+      else
+        render :edit
+      end
+    end
+
+    def edit_article_position_one_backward
+      root = params[:root]
+      selected_category = params[:selected_category]
+      @article.move_higher
+      if selected_category == ""
+        redirect_to content_new_back_path(root: root)
+      else
+        redirect_to contents_path(root: root, selected_category: selected_category)
+      end
+    end
+
+    def edit_article_position_one_forward
+      root = params[:root]
+      selected_category = params[:selected_category]
+      @article.move_lower
+      if selected_category == ""
+        redirect_to content_new_back_path(root: root)
+      else
+        redirect_to contents_path(root: root, selected_category: selected_category)
+      end
+    end
+
+    # DELETE /articles/1
+    def destroy
+      if @article.author_id == current_user.id or is_guider_admin
+        @article.destroy
+        redirect_to guider_home_path, notice: 'Article was successfully destroyed.'
+      else
+        redirect_to guider_home_path, alert: "Cannot do that"
+      end
+    end
+
+    private
+      # Use callbacks to share common setup or constraints between actions.
+      def is_correct_user
+        @article = Article.find(params[:id])
+        if current_user.id != @article.author_id
+          redirect_to root_path
+        end
+      end
+
+      def is_guider_assesible
+        # puts(current_user)
+        if current_user and is_guider_admin?
+          redirect_to root_path
+        end
+      end
+
+      def set_article
+        if Article.friendly.find(params[:id]).nil?
+          @article = Article.find_by(slug: params[:id])
+        else
+          @article = Article.friendly.find(params[:id])
+        end
+      end
+
+      # Only allow a trusted parameter "white list" through.
+      def article_params
+        params.require(:article).permit(:title, :description, :body, :category_id, :author_id, :header_image, :root, :keywords)
+      end
+  end
+end