chive 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 319fc8fbbe5dbe162fbc819f5738ffbe0c9551a7
+  data.tar.gz: 219e250200ad0c5de4b31d666bce7634eb839dc3
+SHA512:
+  metadata.gz: ac21d9c09065691e0119bc3fd5326fd767c3f0c42f41c0704685ed837aa6f277a42be3f8dc95b0b92da12235f57d980560f54887b6c22ad5bfafe66bf6adb274
+  data.tar.gz: 5e8008e6e91c9a786efbe704d4e5d66639ecb0013b03156e2a6c44f5653df3ad135a40c1879b4a663c64c817bd511fe00524f31c93b08b03c2e225cb10e6b8d6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Fred Snyder
+
+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.rdoc

@@ -0,0 +1,93 @@
+= Chive
+
+A mountable blog engine for Rails.
+
+*This project is still in early development.*
+
+== Features
+
+* Configurable publication and expiration dates
+* Paginated archives
+* Automated article summaries
+* RSS feed
+
+== Installation
+
+Add chive and will_paginate to your Gemfile:
+
+    gem 'chive', git: 'https://github.com/castwide/chive'
+    gem 'will_paginate'
+
+Run the migrations:
+
+    $ rails chive:install:migrations
+    $ rake db:migrate
+
+Add the Chive engine to config/routes.rb:
+
+    mount Chive::Engine, at: "/blog"
+
+== Configuration
+
+See config/initializers/chive.rb for configuration options.
+
+== Adding an RSS Feed
+
+Add the feed to config/routes.rb:
+
+    get '/rss' => 'chive/articles#feed', defaults: { format: 'rss' }
+
+== Editing Views
+
+Chive provides a generator for copying its views to your Rails app:
+
+    $ rails generate chive:views
+
+This will add the following views to your app:
+
+* chive/articles/index.html.erb   - The blog's home page
+* chive/articles/show.html.erb    - The view for individual articles
+* chive/articles/feed.rss.builder - The RSS feed
+* chive/articles/_list.html.erb   - A brief article listing
+
+== Adding a List of Articles to Views
+
+There are two basic ways to include a list of articles in your views and
+layouts.
+
+=== 1. The List Partial
+
+Add the list partial to any view with the render method:
+
+    render partial: 'chive/articles/list'
+    
+See "Editing Views" above to customize the list.
+
+=== 2. The article_list Helper Method
+
+You can also code your own listings into any view with the article_list method.
+Here's a simple example:
+
+    <% article_list.each do |article| %>
+      <p>
+        Title: <%= article.title %><br/>
+        Link: <%= link_to article_path(article) %>
+      </p>
+    <% end %>
+
+==== article_list Arguments
+
+===== Limit
+
+The maximum number of articles to select. Example:
+
+    article_list(limit: 5)
+
+== Administration
+
+The simplest option for administration is to add the chive_admin gem to your
+project.
+
+Chive is designed to be as simple and as modular as possible, so chive_admin
+is not required. You can build your own control panel or integrate Chive into
+an existing one instead.

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Chive'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_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/javascripts/chive/application.js

@@ -0,0 +1,13 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/chive/articles.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,15 @@
+/*
+ * 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/chive/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/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+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; }
+
+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;
+  padding-bottom: 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;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/app/controllers/chive/application_controller.rb

@@ -0,0 +1,8 @@
+module Chive
+  class ApplicationController < ::ApplicationController
+    protect_from_forgery with: :exception
+    config.to_prepare do
+      ApplicationController.helper Chive::ArticlesHelper
+    end
+  end
+end

data/app/controllers/chive/articles_controller.rb

@@ -0,0 +1,21 @@
+require_dependency "chive/application_controller"
+
+module Chive
+  class ArticlesController < ApplicationController
+
+    def index
+      @articles = Article.where('published_at <= ? AND (expired_at >= ? OR expired_at IS NULL)', DateTime.now, DateTime.now).order(published_at: :desc).paginate(page: params[:page], per_page: Chive.per_page)
+    end
+
+    def show
+      @article = Article.find_by(slug: params[:slug])
+    end
+
+    def feed
+      @articles = Article.where('published_at <= ? AND (expired_at >= ? OR expired_at IS NULL)', DateTime.now, DateTime.now).order(published_at: :desc).limit(Chive.per_page)
+      respond_to do |format|
+        format.rss { render layout: false }
+      end
+    end
+  end
+end

data/app/helpers/chive/application_helper.rb

@@ -0,0 +1,7 @@
+module Chive
+  module ApplicationHelper
+    def article_list limit: 10, partial: 'chive/articles/list'
+      Article.where('published_at <= ? AND (expired_at >= ? OR expired_at IS NULL)', DateTime.now, DateTime.now).order(published_at: :desc).limit(limit)
+    end
+  end
+end

data/app/helpers/chive/articles_helper.rb

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

data/app/models/chive/article.rb

@@ -0,0 +1,37 @@
+module Chive
+  class Article < ActiveRecord::Base
+    self.per_page = 10
+    belongs_to :author, class_name: 'User'
+    
+    after_initialize :set_default_autosummary, :if => :new_record?
+    before_save :set_published_at, :set_slug, :generate_summary
+    
+    def to_param
+      slug
+    end
+    
+    def byline
+      custom_byline || author.email
+    end
+    
+    private
+    def set_default_autosummary
+      self.autosummary = Chive.default_autosummary || false
+    end
+    def set_published_at
+      self.published_at = DateTime.now if self.published_at.nil?
+    end
+    def set_slug
+      # TODO Slugs need to be unique
+      self.slug = self.title.parameterize if self.slug.nil?
+    end
+    def generate_summary
+      if self.autosummary?
+        html = Nokogiri::HTML(self.body)
+        para = html.css('p').first
+        puts para
+        self.summary = para.inner_html
+      end
+    end
+  end
+end

data/app/views/chive/articles/_list.html.erb

@@ -0,0 +1,9 @@
+<% if article_list.length > 0 %>
+  <ul>
+    <% article_list.each do |article| %>
+      <li>
+        <%= link_to article.title, chive.article_path(article) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/chive/articles/feed.rss.builder

@@ -0,0 +1,18 @@
+xml.instruct! :xml, :version => "1.0" 
+xml.rss :version => "2.0" do
+  xml.channel do
+    xml.title "Your Blog Title"
+    xml.description "A blog about software and chocolate"
+    xml.link chive.articles_url
+
+    for article in @articles
+      xml.item do
+        xml.title article.title
+        xml.description article.summary
+        xml.pubDate article.published_at.to_s(:rfc822)
+        xml.link chive.article_url(article)
+        xml.guid chive.article_url(article)
+       end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+<h1>Articles</h1>
+
+<section>
+  <%= will_paginate @articles %>
+  <% @articles.each do |article| %>
+    <article>
+      <h2><%= link_to article.title, article_path(article) %></h2>
+      <address>by <%= article.byline %> on <%= article.published_at %></address>
+      <p>
+		<%= raw article.summary %>
+		<%= link_to 'Read more', article_path(article) %>
+	  </p>
+    </article>
+  <% end %>
+</section>

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

@@ -0,0 +1,7 @@
+<section>
+  <article>
+    <h1><%= @article.title %></h1>
+    <address>by <%= @article.byline %> on <%= @article.published_at %></address>
+    <%= raw @article.body %>
+  </article>
+</section>

data/app/views/layouts/chive/not_application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Chive</title>
+  <%= stylesheet_link_tag    "chive/application", media: "all" %>
+  <%= javascript_include_tag "chive/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Chive::Engine.routes.draw do
+  get '/', to: 'articles#index', as: 'articles'
+  get '/:slug', to: 'articles#show', as: 'article', slug: :slug
+end

data/db/migrate/20161206165907_create_chive_articles.rb

@@ -0,0 +1,14 @@
+class CreateChiveArticles < ActiveRecord::Migration
+  def change
+    create_table :chive_articles do |t|
+      t.string :title
+      t.text :body
+      t.string :slug
+      t.string :byline
+      t.datetime :published_at, null: false
+      t.datetime :expired_at, null: true
+      
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20161210080215_add_summary_to_articles.rb

@@ -0,0 +1,5 @@
+class AddSummaryToArticles < ActiveRecord::Migration
+  def change
+    add_column :chive_articles, :summary, :text
+  end
+end

data/db/migrate/20161214233605_add_autosummary_to_articles.rb

@@ -0,0 +1,5 @@
+class AddAutosummaryToArticles < ActiveRecord::Migration
+  def change
+    add_column :chive_articles, :autosummary, :boolean
+  end
+end

data/db/migrate/20161215020443_add_author_to_articles.rb

@@ -0,0 +1,5 @@
+class AddAuthorToArticles < ActiveRecord::Migration
+  def change
+    add_column :chive_articles, :author_id, :integer, index: true
+  end
+end

data/db/migrate/20161215021624_change_byline_to_custom_byline_in_articles.rb

@@ -0,0 +1,5 @@
+class ChangeBylineToCustomBylineInArticles < ActiveRecord::Migration
+  def change
+    rename_column :chive_articles, :byline, :custom_byline
+  end
+end

data/lib/chive/engine.rb

@@ -0,0 +1,10 @@
+module Chive
+  class Engine < ::Rails::Engine
+    isolate_namespace Chive
+    initializer 'chive.action_controller' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper Chive::ApplicationHelper
+      end
+    end
+  end
+end

data/lib/chive/version.rb

@@ -0,0 +1,3 @@
+module Chive
+  VERSION = "0.0.1"
+end

data/lib/chive.rb

@@ -0,0 +1,14 @@
+require "chive/engine"
+
+module Chive
+  # TODO Testing Devise style configuration
+  class << self
+    attr_accessor :slug_style
+    attr_accessor :default_autosummary
+    attr_accessor :per_page
+    attr_accessor :date_format
+  end
+  def self.setup
+    yield self
+  end
+end

data/lib/generators/chive/views_generator.rb

@@ -0,0 +1,8 @@
+module Chive
+  class ViewsGenerator < Rails::Generators::Base
+    source_root Chive::Engine.root
+    def generate_views
+      directory File.join('app', 'views', 'chive'), File.join(Rails.root, 'app', 'views', 'chive')
+    end
+  end
+end

data/lib/tasks/chive_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :chive do
+#   # Task goes here
+# end

data/test/chive_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ChiveTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Chive
+  end
+end

data/test/controllers/chive/articles_controller_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+module Chive
+  class ArticlesControllerTest < ActionController::TestCase
+    setup do
+      @article = chive_articles(:one)
+      @routes = Engine.routes
+    end
+
+    test "should get index" do
+      get :index
+      assert_response :success
+      assert_not_nil assigns(:articles)
+    end
+
+    test "should get new" do
+      get :new
+      assert_response :success
+    end
+
+    test "should create article" do
+      assert_difference('Article.count') do
+        post :create, article: { body: @article.body, title: @article.title }
+      end
+
+      assert_redirected_to article_path(assigns(:article))
+    end
+
+    test "should show article" do
+      get :show, id: @article
+      assert_response :success
+    end
+
+    test "should get edit" do
+      get :edit, id: @article
+      assert_response :success
+    end
+
+    test "should update article" do
+      patch :update, id: @article, article: { body: @article.body, title: @article.title }
+      assert_redirected_to article_path(assigns(:article))
+    end
+
+    test "should destroy article" do
+      assert_difference('Article.count', -1) do
+        delete :destroy, id: @article
+      end
+
+      assert_redirected_to articles_path
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// 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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>