lines-engine 0.1.3

data/app/models/lines/article.rb

@@ -0,0 +1,117 @@
+# {Article}s are the core of the lines blog. 
+# 
+# An {Article} must have on or more {Author}s through {Authorable}.
+# 
+# An article extends FriendlyId to provide meaningful slugs instead of the usual id value. 
+# 
+# Slugs are unique and contain the article's title. A incremental numerical value
+# is added to the slug title if the it already exists in the database.
+
+require 'kaminari'
+require 'acts-as-taggable-on'
+require 'carrierwave'
+require 'carrierwave/orm/activerecord'
+require 'friendly_id'
+
+module Lines
+  class Article < ActiveRecord::Base
+    extend FriendlyId
+    friendly_id :title, use: [:slugged, :history, :finders]
+
+    # Relations
+    has_many :pictures
+    has_many :authorables
+    has_many :authors, through: :authorables
+
+    attr_accessor :hero_image_file
+    accepts_nested_attributes_for :pictures, :authors
+
+
+    # Mount Carrierwave uploaders
+    mount_uploader :hero_image, HeroImageUploader
+    mount_uploader :document, DocumentUploader
+
+    # Pagination and tagging
+    paginates_per CONFIG[:articles_per_page]
+    acts_as_taggable
+
+    # Validations
+    validates :title, :content, :author_ids, :published_at, presence: true
+    validate :one_image_selected
+
+    # Callbacks
+    after_save :update_used_images, :refresh_sitemap
+
+    # Model Scopes
+    scope :published, -> { where(published: true).order("featured DESC, published_at DESC") }
+
+    # Predifined hero images.
+    # Images are loaded from the <tt>public/heroes</tt> directory
+    HERO_IMAGES = CONFIG[:hero_images]
+
+    # Returns URL of selected image from HERO_IMAGES array
+    def short_hero_image_url
+      "#{self.short_hero_image}"
+    end
+
+    # Returns array of images used in content
+    def used_images
+      result = content.scan(/!\[.*\]\(.*\/image\/(\d.*)\/.*\)/)
+      image_ids = result.nil? ? nil : result.map{ |i| i[0].to_i }.uniq
+      image_ids
+    end
+
+    # Returns the url for the hero image
+    def image_url
+      self.hero_image? ? self.hero_image.url : self.short_hero_image
+    end
+
+    # Returns value of subtitle
+    def sub_title
+      read_attribute(:sub_title) || ''
+    end
+
+  private
+
+    # Finds images used in an articles content and associates each
+    # image to the blog article
+    def update_used_images
+      ActionController::Base.new.expire_fragment(self)
+      image_ids = self.used_images
+      if !image_ids.nil?
+        Picture.where(id: image_ids).each do |picture|
+          picture.update_attributes(article_id: self.id)
+        end
+      end
+    end
+
+    # Refreshes the sitemap and pings the search engines
+    def refresh_sitemap
+      if self.published
+        if Rails.env == 'production' && ENV["CONFIG_FILE"]
+          SitemapGenerator::Interpreter.run(config_file: ENV["CONFIG_FILE"])
+          SitemapGenerator::Sitemap.ping_search_engines 
+        end
+      end
+    end
+
+    # Validates if either a predefined hero image is selected or a custom hero
+    # image uploaded. 
+    def one_image_selected
+      if both_images_selected || no_image_selected
+        errors[:base] << 'You have to either select an image or upload one.'
+      end
+    end
+
+    # Returns true if both a hero image is uploaded and a predefined hero image is selected
+    def both_images_selected
+      hero_image.present? && short_hero_image.present?
+    end
+
+    # Returns false if no hero image is selected or uploaded
+    def no_image_selected
+      !hero_image.present? && !short_hero_image.present?
+    end
+
+  end
+end

data/app/models/lines/author.rb

@@ -0,0 +1,41 @@
+# Each {Article} must have one or more {Author}s. 
+# 
+# An {Author} is unrelated to the currently logged in user. This allows to publish
+# {Article}s by guest authors that don't need an own user account
+
+module Lines
+  class Author < ActiveRecord::Base
+      
+    # Relations
+    has_many :authorables
+    has_many :articles, through: :authorables
+    
+    # Validations
+    validates :name, :email, :description, presence: true
+
+    # Callbacks
+    before_destroy :check_for_articles
+
+    # Returns the first name 
+    def first_name
+    	self.name.split(" ").first
+    end
+
+    # Returns the last name
+    def last_name
+    	self.name.split(" ").last
+    end
+
+    private
+
+      # Return false if an author has associated articles. 
+      # This check is called before destroying an author to prevent leaving articles
+      # without an associated author.
+      def check_for_articles
+        if articles.count > 0
+          errors[:base] << "cannot delete author with existing blog articles"
+          return false
+        end
+      end
+  end
+end

data/app/models/lines/authorable.rb

@@ -0,0 +1,8 @@
+# {Authorable} associates one or more {Author}s to one or more {Article}s.
+
+module Lines
+  class Authorable < ActiveRecord::Base
+    belongs_to :author
+    belongs_to :article, touch: true
+  end
+end

data/app/models/lines/picture.rb

@@ -0,0 +1,25 @@
+# The content of an {Article} can contain multiple pictures.
+# Pictures are associated to an article through parsing the articles
+# content and extracting the ids of the used images.
+
+require 'carrierwave'
+require 'carrierwave/orm/activerecord'
+
+module Lines  
+  class Picture < ActiveRecord::Base
+    # Associations    
+    belongs_to :article, touch: true
+
+    # Mount carrierwave picture uploader
+    mount_uploader :image, PictureUploader
+
+    # Callbacks
+    before_create :default_name
+
+    # Returns the default name fo a picture
+    def default_name
+      self.name ||= File.basename(image.filename, '.*').titleize if image
+    end
+
+  end
+end

data/app/models/lines/user.rb

@@ -0,0 +1,36 @@
+# {User}s are the administrators of a blog. 
+# Since there is no interface to manage users, they have to be modified via
+# Rails console. 
+# 
+# Examples:
+#   rails c
+#   # Create a new user:
+#   User.create(email: 'mail@example.com', password: 'ultrasekret')
+#   # Find a specific user and modify:
+#   u = User.where(email: 'mail@example.com')
+#   u.email = 'new@example.com'
+#   u.password = 'newsecret'
+#   u.save
+
+module Lines
+
+  class User < ActiveRecord::Base
+    # use bcrypt-ruby to encrypt passwords
+    has_secure_password validations: false
+    validates :password, length: { minimum: 6 }, allow_blank: false
+    validates :password, presence: true, on: :create
+
+    # Validations
+    validates :password, length: { minimum: 6 }, if: :validate_password?
+    validates :email, uniqueness: true, presence: true
+
+    
+    private 
+      # Returns +true+ if a password is submitted
+      def validate_password?
+        password.present?
+      end
+
+  end
+
+end

data/app/uploaders/document_uploader.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+# Carrierwave uploader for docuemnts.
+class DocumentUploader < CarrierWave::Uploader::Base
+
+  storage :file
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  def root
+    Rails.root.join 'public/'
+  end
+end

data/app/uploaders/hero_image_uploader.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+# CarrierWave uploader for hero images.
+class HeroImageUploader < CarrierWave::Uploader::Base
+
+  include CarrierWave::RMagick
+
+  # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
+  # include Sprockets::Helpers::RailsHelper
+  # include Sprockets::Helpers::IsolatedHelper
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  process :resize_to_limit => [960, 960]
+
+  # Returns URL for image-asset
+  def default_url
+    "/assets/heroes/" + [filename].compact.join('_')
+  end
+
+  def root
+    Rails.root.join 'public/'
+  end
+
+end

data/app/uploaders/picture_uploader.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+# CarrierWave uploader for +Picture+ model. 
+class PictureUploader < CarrierWave::Uploader::Base
+
+  include CarrierWave::RMagick
+
+  # Include the Sprockets helpers for Rails 3.1+ asset pipeline compatibility:
+  # include Sprockets::Helpers::RailsHelper
+  # include Sprockets::Helpers::IsolatedHelper
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Generates +preview+ version.
+  version :preview do
+    resize_to_limit(100, 100)
+  end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  def extension_white_list
+    %w(jpg jpeg gif png)
+  end
+  
+  def root
+    Rails.root.join 'public/'
+  end
+end

data/app/views/layouts/lines/_messages.html.erb

@@ -0,0 +1,8 @@
+<% flash.each do |name, msg| %>
+  <% if msg.is_a?(String) %>
+    <div class="alert alert-<%= name == :notice ? "success" : "error" %>">
+      <a class="close" data-dismiss="alert">&#215;</a>
+      <%= content_tag :div, msg, id: "flash_#{name}" %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/layouts/lines/admin.html.erb

@@ -0,0 +1,33 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= content_for?(:title) ? yield(:title) : "Lines" %></title>
+    <meta name="description" content="">
+    <meta name="author" content="">
+    <%= stylesheet_link_tag    "lines/admin", media: "all" %>
+    <%= javascript_include_tag "lines/admin" %>
+    <%= csrf_meta_tags %>
+    <%= yield(:head) %>
+  </head>
+  <body>
+    <%#= render 'shared/navigation' %>
+
+    <div id="main" role="main">
+      <div class="container">
+        <div class="content">
+           <div class="row">
+            <div class="span12">
+              <div class="spacer"></div>
+              <%= render 'layouts/lines/messages' %>
+              <%= yield %>
+            </div>
+          </div>
+          <footer>
+          </footer>
+        </div>
+      </div> <!--! end of .container -->
+    </div> <!--! end of #main -->
+  </body>
+</html>

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

@@ -0,0 +1,45 @@
+<!doctype html>
+<html class="no-js">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <meta charset="UTF-8" />
+  <meta name="author" content="<%= CONFIG[:meta_author] %>" />
+  <meta name="revisit-after" content="3 days" />
+  <meta name="robots" content="index,follow" />
+  <%= display_meta_tags site: CONFIG[:title_short] %>
+  <meta name="geo.position" CONTENT="<%= CONFIG[:geo_position] %>">
+  <meta name="geo.placename" CONTENT="<%= CONFIG[:geo_address] %>">
+  <meta name="viewport" content="width=device-width, minimum-scale=1, maximum-scale=1" />
+  <link rel="icon" href="/favicon.png" type="image/png" />
+  <%= yield :head %>
+  <%= stylesheet_link_tag    "lines/application", media: "all" %>
+  <%= javascript_include_tag "lines/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<% if current_user %>
+  <%= render_navbar { "" } %>
+  <div class="spacer"></div>
+<% end %>
+<div id="pagewrap">
+  <a id="top"></a>
+  <div id="meta">
+    <div id="meta_content">
+      <div id="logo">
+          <a href="/"><img src="<%= CONFIG[:logo] %>" alt="Logo Lines" /></a>
+      </div>
+      <div id="lines">
+        <%= CONFIG[:short_description] %>
+      </div>
+    </div>
+  </div>
+
+  <div id="content">
+    <%= yield %>
+  </div>
+
+  <%= render 'lines/shared/footer' %>
+
+</div>
+</body>
+</html>

data/app/views/layouts/lines/preview.html.erb

@@ -0,0 +1,16 @@
+<!doctype html>
+<html class="no-js">
+<head>
+  <meta name="viewport" content="width=device-width, minimum-scale=1, maximum-scale=1" />
+  <title>Lines</title>
+  <%= stylesheet_link_tag    "lines/application", media: "all" %>
+  <%= javascript_include_tag "lines/application" %>
+</head>
+<body>
+<div id="pagewrap">
+  <div id="content">
+    <%= yield %>
+  </div>
+</div>
+</body>
+</html>

data/app/views/lines/admin/articles/_form.html.erb

@@ -0,0 +1,175 @@
+<%= simple_form_for([:admin, @article], id: 'article_form') do |f| %>
+
+  <div class="new-article">
+    <div class="row">
+      <div class="label">
+        <h3><%= f.label :hero_image, "Hero Image" %> <span class="required">*</span></h3>
+      </div>
+      <div class="input">
+        <div class="hero-image" style="background: url('<%= @article.hero_image? ? @article.hero_image : @article.short_hero_image %>'); background-size: cover;">
+          <% if @article.hero_image? %>
+            <%= f.label :hero_image, "Change Image", class: "choose-file" %>
+          <% elsif @article.short_hero_image? %>
+            <%= f.label :hero_image, "Change Image", class: "choose-file" %>
+          <% else %>
+            <%= f.label :hero_image, "Upload Image", class: "choose-file" %>
+          <% end %>
+          <%= f.file_field :hero_image, class: "hero-image-value" %>
+          <%= f.hidden_field :hero_image_file %>
+          <div class="hidden">
+            <%= f.hidden_field :hero_image_cache, class: "hero-image-cache" %>
+            <span id="hero_image_name"><%= (@article.hero_image.filename) if @article.hero_image? %></span>
+          </div>
+        </div>
+      </div>
+      <div class="additional">
+        <div class="short-hero-images-box">
+          <h2>Default images</h2>
+          <div class="short-hero-images">
+            <% Lines::Article::HERO_IMAGES.each_with_index do |h, i| %>
+              <div class="short-hero-image-box">
+                <img src="<%= "/heroes/#{h}" %>" width="115" id="hero_<%= i %>" class="select_image <%= 'selected_image' if ('/heroes/' + h) == @article.short_hero_image %>" />
+              </div>
+            <% end %>
+            <%= f.hidden_field :short_hero_image, class: "short-hero-image-cache" %>
+          </div>
+          <br style="clear: both;" />
+        </div>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3><%= f.label :title, "Title" %> <span class="required">*</span></h3>
+      </div>
+      <div class="input input-text">
+        <%= f.text_field :title, class: "article-title" %>
+      </div>
+      <div class="additional">
+
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3><%= f.label :sub_title, "Subtitle" %></h3>
+      </div>
+      <div class="input input-text">
+        <%= f.text_field :sub_title, class: "article-subtitle" %>
+      </div>
+      <div class="additional">
+
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3><%= f.label :content, "Content" %> <span class="required">*</span></h3>
+      </div>
+      <div class="input input-textarea">
+        <%= f.text_area :content %>
+      </div>
+      <div class="additional">
+        <a href="#formatting_guide" data-toggle="modal" class="btn-formatting-help">&lt;/&gt; Formatting Help</a>
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3>Authors <span class="required">*</span></h3>
+      </div>
+      <div class="input">
+        <%= hidden_field_tag "article[author_ids][]", nil %>
+        <% @author_count = 1 %>
+        <% Lines::Author.all.each do |author| %>
+          <% if (@author_count <= 2) %>
+            <div class="checkbox first-row">
+          <% else %>
+            <div class="checkbox">
+          <% end %>
+            <%= check_box_tag "article[author_ids][]", author.id, @article.author_ids.include?(author.id), id: dom_id(author) %>
+            <label for="<%= dom_id(author) %>" class="checkbox"><span></span><%= author.name %></label>
+          </div>
+          <% @author_count += 1 %>
+        <% end %>
+      </div>
+      <div class="additional">
+        <%= link_to "+ Add new author", new_admin_author_path(), class: "add-new-author" %>
+      </div>
+    </div>
+
+    <hr />
+
+    <div class="row">
+      <div class="label">
+        <h3><%= f.label :gplus_url, "G+ URL" %></h3>
+      </div>
+      <div class="input input-text">
+        <%= f.text_field :gplus_url %>
+      </div>
+      <div class="additional">
+
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3><label>Document</label></h3>
+      </div>
+      <div class="input">
+        <div class="documents">
+          <%= f.label :document, "#{@article.document? ? @article.document.file.filename : 'Choose File' }", class: "choose-files" -%>
+          <%= f.file_field :document, class: "article-document-value" %>
+          <div class="hidden">
+            <%= f.hidden_field :document_cache %>
+            <%= (@article.hero_image.filename) if @article.document? %>
+          </div>
+        </div>
+
+        <% if @article.document? %>
+        <div class="checkbox">
+          <%= f.check_box :remove_document %>
+          <label for="article_remove_document" class="checkbox"><span></span>Delete document</label>
+        </div>
+        <% end %>
+
+      </div>
+      <div class="additional">
+
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3><%= f.label :tag_list, "Tags" %></h3>
+      </div>
+      <div class="input input-text">
+        <%= f.autocomplete_field :tag_list, autocomplete_tag_name_admin_articles_path, :"data-delimiter" => ', ' %>
+      </div>
+      <div class="additional">
+
+      </div>
+    </div>
+
+    <div class="row">
+      <div class="label">
+        <h3>Published at <span class="required">*</span></h3>
+      </div>
+      <div class="input input-text">
+        <%= f.text_field :published_at, value: (@article.published_at || Time.now).strftime("%Y-%m-%d"), 'data-behaviour' => 'datepicker' %>
+      </div>
+      <div class="additional">
+
+      </div>
+    </div>
+
+    <%= render_navbar do %>
+      <%= f.submit "Save Article", class: "btn btn-save-publish" %>
+      <%= link_to "Cancel", admin_articles_path, class: "btn btn-cancel" %>
+    <% end %>        
+
+  </div>
+<% end %>
+
+<%= render 'lines/admin/articles/formatting_guide' %>
+