chive 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4557cde95eb14bb3ccb3266b0b7d8433728bc553
-  data.tar.gz: f815d5f6bcdee6da18e226e844b9f6ee01c326f1
+SHA256:
+  metadata.gz: 05000ba5203c4b92f33470a853d4868594ef87e461f0cad2fb976cc9f64ca130
+  data.tar.gz: fefb45d0d3f7eb5d58e1c6bb3ae82d2497d28edf5f6f53c723dbff9c6b69939a
 SHA512:
-  metadata.gz: af2939a8d283bddcec9479074d69dd4fcaef8e93c61683dd4ddd10c62da399dbe9263b2828d288f50039bf5b68a9be03be03e51654a2949da628e9639073cbc2
-  data.tar.gz: c0dc4312b313d63b1f01461b0d22353cf359806ab71f32ac9b031b2c07caf149cc04cbbb9778dea5d14e487c925458e1bc0d09a29cf7fa2e0b7147f21ef2d6a6
+  metadata.gz: f7954067fff93abdc8c26c83bf4a085e52d615eb4a3183d9be6ca2d6c96811204864b649fe4bfa3526e4a4d826a2dcf678f6efdee8f9bfa4cea29a17fa9b4174
+  data.tar.gz: bbe4b4954461d2a7730013ed724bef8b8fa32967ce18977523f595164d899710800132281b130a9e9555914eca431a094a895fe4083e703c173d6382d70b2324

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2016 Fred Snyder
+Copyright 2021 Fred Snyder
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,169 @@
+# Chive
+
+A mountable blog engine for Rails.
+
+## Quick Start
+
+Add this line to your application's Gemfile:
+
+    ```bash
+    gem 'chive'
+    ```
+
+Run the rake task for a complete installation:
+
+    ```bash
+    $ rake chive:complete
+    ```
+
+The complete installation includes Devise for user authentication. Alternatively, you can run `rake chive:install` to get the minimum requirements without Devise.
+
+Next, run the database migrations:
+
+    ```bash
+    $ rake db:migrate
+    ```
+
+If you installed with `rake:complete`, you can seed the database with an example user and article:
+
+    ```bash
+    $ rake db:seed
+    ```
+
+Start the server:
+
+    ```bash
+    $ rails s
+    ```
+
+Browse to `http://localhost:3000/chive`. You should see the article index page.
+
+If you installed with `rake:complete`, go to `http://localhost:3000/users/sign_in` and log in with email `example@example.com` and password `password`.
+
+If you don't have user authentication configured, you'll still be able to test the admin features in development mode. For security purposes, you're required to supply an authentication implementation for the admin pages to work in production.
+
+## Custom Setup
+
+If you want to customize Chive or to integrate it into an existing app, you can follow these steps to get it working.
+
+### Add the gem dependencies to the Gemfile
+
+Install the minimum dependencies:
+
+  ```bash
+  $ rails g chive:dependencies
+  $ bundle install
+  ```
+
+### Install and configure CKEditor
+
+The default:
+
+```bash
+$ rails g chive:ckeditor
+$ rake active_storage:install
+```
+
+The default CKEditor configuration uses ActiveRecord and ActiveStorage to store images and attachments. You can select different options by running `rails g ckeditor:install` instead. See the [CKEditor gem](https://github.com/galetahub/ckeditor) for more information.
+
+To use Chive's default authorization for uploading files through CKEditor, add this line to `config/initializers/ckeditor.rb`:
+
+```ruby
+config.authorize_with :chive
+```
+
+### Generate the initializer
+
+```bash
+rails g chive:initializer
+```
+
+### Install the migrations
+
+```bash
+rake chive:install:migrations
+rake acts_as_taggable_on_engine:install:migrations
+```
+
+### Users
+
+Chive requires a users table for authors. The default installation uses [Devise](https://github.com/heartcombo/devise). To install Devise with Chive's defaults:
+
+```bash
+rails g chive:devise
+```
+
+If you want to use an existing Devise setup or an alternative user system, update `config/initializers/chive.rb` to point to your user model. Note that Chive requires the user model to include a `name` attribute.
+
+### Authentication
+
+If you're using Devise you can get quick and easy authentication with the `use_devise` option in `config/initializers/chive.rb`:
+
+```ruby
+config.use_devise = true
+```
+
+To customize authentication, you'll need to modify the controllers. Add them to your `app/controllers` directory:
+
+```bash
+rails g chive:controllers
+```
+
+### Mounting the engines
+
+The default routes in `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  mount Ckeditor::Engine => '/ckeditor'
+  mount Chive::Engine => "/chive"
+
+  # ...etc.
+end
+```
+
+You can make the blog your home page by changing the `Chive::Engine` path to `/`:
+
+```ruby
+mount Chive::Engine => "/"
+```
+
+## Customizing the Layout
+
+There are a few different options for modifying the look and feel of Chive pages.
+
+The `config.public_layout` setting in `config/initializers/chive.rb` lets you change the layout used by public pages (i.e., `Chive::Articles#index` and `Chive::Articles#show`). This is useful for applying your own style to the main site while still using the standard admin pages for content management.
+
+To modify the views, add them to your `app/views` directory:
+
+```bash
+rails generate chive:views
+```
+
+## Creating Your Own Resource
+
+Another option for customizing your blog is to create a custom resource.
+
+Make your own controller, e.g., `apps/controller/blog_controller.rb`:
+
+```ruby
+class BlogController < Chive::ArticlesController
+  layout 'application'
+end
+```
+
+The `layout` call makes your controller use your `app/views/layout/application` layout instead of the engine's.
+
+Add a new path to `config/routes.rb`:
+
+```ruby
+Rails.application.routes.draw do
+  # ...
+  resources :blog, path: '/blog', controller: 'blog', only: [:index, :show]
+  # ...
+end
+```
+
+The `only: [:index, :show]` option limits the resource to the public pages.
+
+Now you can make your own views at `app/views/blog/index.html.erb` and `app/views/blog/show.html.erb`.

data/Rakefile

@@ -10,28 +10,23 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Chive'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load 'rails/tasks/engine.rake'
 
-
 load 'rails/tasks/statistics.rake'
 
-
-
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 
-
 task default: :test

data/app/assets/config/chive_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/chive .css

data/app/assets/javascript/chive/application.js

@@ -0,0 +1,71 @@
+//= require rails-ujs
+//= require activestorage
+//= require_tree .
+
+//= require jquery3
+//= require popper
+//= require bootstrap-sprockets
+
+/**
+ * Preview an image before upload
+ * 
+ * Example:
+ * 
+ * <%= image_tag 'chive/blank', class: 'image-preview' %>
+ * <%= check_box_tag :delete_preview, 'delete', false, class: 'delete-preview' %>
+ * <%= f.file_field :image, class: 'image-upload', data: {preview: '.image-preview', delete: '.delete-preview' } %>
+ */
+ function readURL(input) {
+   let preview = $(input).attr('data-preview');
+   let deleter = $(input).attr('data-delete');
+
+   if (preview) {
+     if (input.files && input.files[0]) {
+       var reader = new FileReader();
+
+       reader.onload = function (e) {
+         $(preview).attr('src', e.target.result);
+       }
+
+       reader.readAsDataURL(input.files[0]);
+       $(preview).parent().show();
+       $(deleter).show();
+       $(deleter).data('preview', $(preview));
+       $(deleter).data('input', $(input));
+       $('.delete-image').hide();
+     } else {
+       $(preview).parent().hide();
+       $(deleter).hide();
+       $('.delete-image').show();
+     }
+   }
+}
+
+$(function () {
+  $('.image-upload').change(function () {
+    readURL(this);
+  });
+
+  $('.image-upload').each(function (_, input) {
+    readURL(input);
+  });
+
+  $('.delete-preview').click(function (event) {
+    event.preventDefault();
+    $(this).data('input').val('');
+    $(this).data('preview').attr('src', '');
+    $(this).data('preview').parent().hide();
+    $(this).hide();
+    $('.delete-image').show();
+  })
+
+  $('.delete-image').change(function() {
+    if ($(this).find('input').is(':checked')) {
+      $(this).addClass('checked');
+      $('.attached-image').parent().hide();
+    } else {
+      $(this).removeClass('checked');
+      $('.attached-image').parent().show();
+    }
+  });
+});

data/app/assets/javascript/ckeditor/config.js

@@ -0,0 +1,56 @@
+CKEDITOR.editorConfig = function( config )
+{
+  // Define changes to default configuration here. For example:
+  // config.language = 'fr';
+  // config.uiColor = '#AADC6E';
+
+  config.height = 420;
+
+  /* Filebrowser routes */
+  // The location of an external file browser, that should be launched when "Browse Server" button is pressed.
+  config.filebrowserBrowseUrl = "/ckeditor/attachment_files";
+
+  // The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Flash dialog.
+  config.filebrowserFlashBrowseUrl = "/ckeditor/attachment_files";
+
+  // The location of a script that handles file uploads in the Flash dialog.
+  config.filebrowserFlashUploadUrl = "/ckeditor/attachment_files";
+
+  // The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Link tab of Image dialog.
+  config.filebrowserImageBrowseLinkUrl = "/ckeditor/pictures";
+
+  // The location of an external file browser, that should be launched when "Browse Server" button is pressed in the Image dialog.
+  config.filebrowserImageBrowseUrl = "/ckeditor/pictures";
+
+  // The location of a script that handles file uploads in the Image dialog.
+  config.filebrowserImageUploadUrl = "/ckeditor/pictures?";
+
+  // The location of a script that handles file uploads.
+  config.filebrowserUploadUrl = "/ckeditor/attachment_files";
+
+  config.allowedContent = true;
+  config.filebrowserUploadMethod = 'form';
+
+  // Toolbar groups configuration.
+  config.toolbar = [
+    { name: 'document', groups: [ 'mode', 'document', 'doctools' ], items: [ 'Source'] },
+    { name: 'clipboard', groups: [ 'clipboard', 'undo' ], items: [ 'Cut', 'Copy', 'Paste', 'PasteText', 'PasteFromWord', '-', 'Undo', 'Redo' ] },
+    // { name: 'editing', groups: [ 'find', 'selection', 'spellchecker' ], items: [ 'Find', 'Replace', '-', 'SelectAll', '-', 'Scayt' ] },
+    // { name: 'forms', items: [ 'Form', 'Checkbox', 'Radio', 'TextField', 'Textarea', 'Select', 'Button', 'ImageButton', 'HiddenField' ] },
+    { name: 'links', items: [ 'Link', 'Unlink', 'Anchor' ] },
+    { name: 'insert', items: [ 'Image', 'Flash', 'Table', 'HorizontalRule', 'SpecialChar' ] },
+    { name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ], items: [ 'NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote', 'CreateDiv', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock' ] },
+    '/',
+    { name: 'styles', items: [ 'Styles', 'Format', 'Font', 'FontSize' ] },
+    { name: 'colors', items: [ 'TextColor', 'BGColor' ] },
+    { name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ], items: [ 'Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', '-', 'RemoveFormat' ] }
+  ];
+
+  config.toolbar_mini = [
+    { name: 'paragraph', groups: [ 'list', 'indent', 'blocks', 'align', 'bidi' ], items: [ 'NumberedList', 'BulletedList', '-', 'Outdent', 'Indent', '-', 'Blockquote', 'CreateDiv', '-', 'JustifyLeft', 'JustifyCenter', 'JustifyRight', 'JustifyBlock' ] },
+    { name: 'styles', items: [ 'Font', 'FontSize' ] },
+    { name: 'colors', items: [ 'TextColor', 'BGColor' ] },
+    { name: 'basicstyles', groups: [ 'basicstyles', 'cleanup' ], items: [ 'Bold', 'Italic', 'Underline', 'Strike', 'Subscript', 'Superscript', '-', 'RemoveFormat' ] },
+    { name: 'insert', items: [ 'Image', 'Table', 'HorizontalRule', 'SpecialChar' ] }
+  ];
+};

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

@@ -0,0 +1,82 @@
+@import "bootstrap";
+@import "./pagination";
+
+#header {
+  background-color: #f2efe9;
+  color: #543d37;
+  padding: 0.2rem 0;
+  margin-bottom: 2em;
+
+  .header-title {
+    font-size: 180%;
+  }  
+}
+
+.flash {
+  text-align: center;
+  margin-top: -2em;
+  margin-bottom: 2em;
+}
+
+.header-nav {
+  text-align: right;
+
+  .btn {
+    margin-left: 0.5em;
+  }
+}
+
+#footer {
+  padding-top: 1em;
+}
+
+.btn.btn-primary, .btn.btn-outline-primary {
+  min-width: 5rem;
+}
+
+.image-upload-fields img {
+  max-width: 240px;
+  max-height: 240px;
+}
+
+.image-previews {
+  width: 250px;
+  height: 250px;
+
+  .image-container {
+    position: absolute;
+    width: 250px;
+    height: 250px;
+    background-color: #FFF;
+    text-align: center;
+  }
+
+  .delete-image, .delete-preview {
+    position: absolute;
+    margin-left: 230px;
+    margin-top: -10px;
+    width: 32px;
+    height: 32px;
+    background-image: image-url("chive/icon-delete.png");
+    background-position: center;
+    background-repeat: no-repeat;
+    display: none;
+
+    input {
+      visibility: hidden;
+    }
+  
+  }
+
+  .delete-image {
+    z-index: 98;
+  }
+
+  .delete-preview {
+    z-index: 198;
+  }
+
+  .delete-image.checked {
+    background-image: image-url("chive/icon-undo.png");
+  }
+}