ecm_links2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cfd985fcb7b31ba7399eb4616e057f5d7c2f5f6f
+  data.tar.gz: 9b533ddd5f8370e4730f4c35ea5bc3d09ae58901
+SHA512:
+  metadata.gz: 397e94f04d56add60388721b9fce4fc98666b06d967000b906a6f60b4835d05f2deb67a5fa122cd844dd0df599994690c06b2bf165e8f313bddf19e664335959
+  data.tar.gz: 72ade06e8be6d457996f46b3c0a5f09b4a7cad5b96c5265658aeed5be252d8c36f838a8013d05d131f4652f60f6d6476529ef9c3341dc65c244703e34dd73995

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Roberto Vasquez Angel
+
+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,52 @@
+= ECM Links 2
+
+= Installation
+
+
+Add it to your gemfile:
+
+  # Gemfile
+  gem 'ecm_links2'
+
+Install your bundle:
+
+  > bundle install
+
+Generate initializer:
+
+  > rails generate ecm:links:install
+
+Generatre the migrations:
+
+  > rake ecm_links_engine:install:migrations
+
+Migrate:
+
+  > rake db:migrate
+
+
+== Optional: Generate locale files
+
+You may want to copy the locales to your app:
+
+  > rails generate ecm:links:locales
+
+= Usage
+
+Use the helper to display the link footer:
+
+  # i.e. app/views/layouts/application.html.erb
+  <%= render_link_footer %>
+
+== Optional: Display a link tree
+
+To display a link tree, you have to add the routes:
+
+  # config/routes.rb
+  Ecm::Links::Routing.routes(self)
+
+This will give you a route to /ecm_links_categories
+
+= License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ECM Links 2'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rails/dummy/tasks'

data/app/controllers/ecm/links/categories_controller.rb

@@ -0,0 +1,11 @@
+module Ecm::Links
+  class CategoriesController < ApplicationController
+    def index
+      @categories = Category.includes(:ecm_links_links).all.decorate
+    end
+
+    def show
+      @category = Category.includes(:ecm_links_links).find(params[:id]).decorate
+    end
+  end
+end

data/app/decorators/ecm/links/category_decorator.rb

@@ -0,0 +1,17 @@
+module Ecm::Links
+  class CategoryDecorator < Draper::Decorator
+    delegate_all
+
+    def ecm_links_links_count_label
+      h.content_tag(:span, ecm_links_links_count, class: 'badge')
+    end
+
+    def locale_label
+      h.content_tag(:span, locale, class: 'label label-info')
+    end
+
+    def tree_name
+      name
+    end
+  end
+end

data/app/helpers/ecm/links/categories_helper.rb

@@ -0,0 +1,5 @@
+module Ecm::Links::CategoriesHelper
+  def render_link_category(link_category, options = {})
+    render link_category
+  end
+end

data/app/helpers/ecm/links/links_helper.rb

@@ -0,0 +1,5 @@
+module Ecm::Links::LinksHelper
+  def render_link(link, options = {})
+    render link
+  end
+end

data/app/helpers/ecm/links_helper.rb

@@ -0,0 +1,7 @@
+module Ecm::LinksHelper
+  def render_link_footer(categories = nil, options = {})
+    categories = Ecm::Links::Category.for_link_footer.all if categories.nil?
+    grouped_categories = categories.group_by(&:link_footer_column)
+    render(:partial => 'ecm/links/link_footer', :locals => { :categories => grouped_categories })
+  end
+end

data/app/models/ecm/links/category.rb

@@ -0,0 +1,102 @@
+require_dependency 'redcloth'
+
+module Ecm::Links
+  class Category < ActiveRecord::Base
+    # associations
+    has_many :ecm_links_links, -> { order(:position) },
+             :class_name => Ecm::Links::Link,
+             :dependent => :destroy,
+             :foreign_key => :ecm_links_category_id
+
+
+    # attributes
+    attr_accessible :depth,
+                    :ecm_links_links_attributes,
+                    :lft,
+                    :link_footer_column,
+                    :locale,
+                    :long_description,
+                    :markup_language,
+                    :name,
+                    :parent_id,
+                    :rgt,
+                    :short_description,
+                    :slug if respond_to? :attr_accessible
+    accepts_nested_attributes_for :ecm_links_links, :allow_destroy => true
+
+    # awesome nested set
+    acts_as_nested_set
+    default_scope { order('lft ASC') }
+
+    # callbacks
+    after_initialize :set_defaults
+
+    # friendly id
+    extend FriendlyId
+    friendly_id :name, :use => [:slugged, :finders]
+
+    # validations
+    validates :locale, :presence => true, :if => Proc.new { |c| c.parent.nil? }
+    validates :locale, :absence => true, :if => Proc.new { |c| !c.parent.nil? }
+    validates :name, :presence => true,
+                     :uniqueness => { :scope => [ :parent_id ] }
+    validates :markup_language, :presence => true,
+                                :inclusion => Configuration.markup_languages.map(&:to_s)
+
+    def human
+      name
+    end
+
+    def to_s
+      human
+    end
+
+    def self.for_actual_locale
+      where(:locale => I18n.locale)
+    end
+
+    def self.for_link_footer
+      where(self.arel_table['link_footer_column'].not_eq(nil)).for_actual_locale
+    end
+
+    def long_description(options = {})
+      options.reverse_merge!(:as => :plain)
+      case options[:as]
+      when :html
+        markup(self[:long_description])
+      else
+        self[:long_description]
+      end
+    end
+
+    def short_description(options = {})
+      options.reverse_merge!(:as => :plain)
+      case options[:as]
+      when :html
+        markup(self[:short_description])
+      else
+        self[:short_description]
+      end
+    end
+
+    private
+
+    def markup(text)
+      case markup_language.to_sym
+      when :textile
+        return unless text
+        RedCloth.new(text).to_html
+      when :none
+        text
+      else
+        raise "Unsupported markup language #{markup_language}"
+      end
+    end
+
+    def set_defaults
+      if self.new_record?
+        self.markup_language ||= Configuration.default_markup_language.to_s
+      end
+    end
+  end
+end

data/app/models/ecm/links/link.rb

@@ -0,0 +1,63 @@
+require_dependency 'redcloth'
+
+class Ecm::Links::Link < ActiveRecord::Base
+  # acts as list
+  acts_as_list :scope => :ecm_links_category
+
+  # associations
+  belongs_to :ecm_links_category,
+             :class_name => Ecm::Links::Category,
+             :counter_cache => :ecm_links_links_count
+
+  # attributes
+  attr_accessible :description,
+                  :ecm_links_category_id,
+                  :markup_language,
+                  :name,
+                  :position,
+                  :url if respond_to? :attr_accessible
+
+  # callbacks
+  after_initialize :set_defaults
+
+  # constants
+  MARKUP_LANGUAGES = %w(markdown textile rdoc)
+
+  # validations
+  validates :name, :presence => true # , :uniqueness => { :scope => [ :ecm_links_category_id ] }
+  validates :url,  :presence => true # , :uniqueness => { :scope => [ :ecm_links_category_id ] }
+  validates :markup_language, :presence  => true,
+                              :inclusion => MARKUP_LANGUAGES
+
+
+  def description(options = {})
+    options.reverse_merge!(:as => :plain)
+    case options[:as]
+    when :html
+      markup(self[:description])
+    else
+      self[:description]
+    end
+  end
+
+  private
+
+
+  def markup(text)
+    case markup_language.to_sym
+    when :textile
+      return unless text
+      RedCloth.new(text).to_html
+    when :none
+      text
+    else
+      raise "Unsupported markup language #{markup_language}"
+    end
+  end
+
+  def set_defaults
+    if self.new_record?
+      self.markup_language ||= 'textile'
+    end
+  end
+end

data/app/views/ecm/links/_link_footer.html.erb

@@ -0,0 +1,14 @@
+<div class="row link-footer">
+  <% Ecm::Links::Configuration.link_footer_columns.times do |column| %>
+    <div class="column-<%= column + 1 %> <%= Ecm::Links::Configuration.link_footer_column_css_classes.join(' ') %>">
+      <% categories[column + 1].each do |c| %>
+        <h4><%= c.name %></h4>
+
+        <% c.ecm_links_links.each do |l| %>
+          <p><%= render partial: 'ecm/links/links/link', locals: { link: l } %></p>
+        <% end %>
+
+      <% end if categories.has_key?(column + 1) %>
+    </div>
+  <% end %>
+</div>

data/app/views/ecm/links/categories/_category.html.erb

@@ -0,0 +1,22 @@
+<div class="link_category category" id="link_category-<%= category.id %>">
+  <h1><%= category.name %></h1>
+
+  <% unless category.long_description.blank? %>
+    <div class="link_categories-description">
+      <p><%= category.long_description %></p>
+    </div>
+  <% end %>
+
+  <div class="list-group">
+    <%= render partial: 'category_in_index', collection: Ecm::Links::CategoryDecorator.decorate_collection(category.descendants), as: :category %>
+  </div>
+
+  <div class="download_category-downloads item_list">
+    <h2><%= Ecm::Links::Category.human_attribute_name(:ecm_links_links) %></h2>
+    <% if category.ecm_links_links.count == 0 %>
+      <p><%= t('ecm.links.category.messages.no_links_available') %></p>
+    <% else %>
+      <%= render partial: 'ecm/links/links/table', locals: { links: category.ecm_links_links } %>
+    <% end %>
+  </div>
+</div>

data/app/views/ecm/links/categories/_category_in_index.html.erb

@@ -0,0 +1,5 @@
+<%= link_to(category, class: "list-group-item left-padding-#{category.depth * 3}", title: category.short_description) do %>
+  <%= category.tree_name %>
+  <%= category.locale_label %>
+  <%= category.ecm_links_links_count_label %>
+<% end %>

data/app/views/ecm/links/categories/index.html.erb

@@ -0,0 +1,5 @@
+<h1><%= Ecm::Links::Category.model_name.human(:count => :other) %></h1>
+
+<div class="list-group">
+  <%= render partial: 'category_in_index', collection: @categories, as: :category %>
+</div>

data/app/views/ecm/links/categories/show.html.erb

@@ -0,0 +1,9 @@
+<%= render @category %>
+
+<div class="well">
+<% if @category.root? %>
+  <%= link_to(t('ecm.links.category.actions.back_to_index'), ecm_links_categories_path, class: 'btn btn-default') if respond_to?(:ecm_links_categories_path) %>
+<% else %>
+  <%= link_to(Ecm::Links::Category.human_attribute_name(:parent), @category.parent, class: 'btn btn-default') %>
+<% end %>
+</div>

data/app/views/ecm/links/links/_link.html.erb

@@ -0,0 +1 @@
+<%= link_to link.name, link.url, { title: link.description } %>

data/app/views/ecm/links/links/_link_in_table.html.erb

@@ -0,0 +1,5 @@
+<tr class="<%= link.class.name.underscore.gsub('/', ' ') %>" id="<%= "#{link.class.name.underscore.gsub('/', '-')}-#{link.to_param}" %>">
+  <td><%= link_to link.name, link.url %></td>
+  <td><%= link_to link.ecm_links_category.human, link.ecm_links_category %></td>
+  <td><%= link.description(as: :html).html_safe %></td>
+</tr>

data/app/views/ecm/links/links/_table.html.erb

@@ -0,0 +1,7 @@
+<div class="table-responsive">
+  <table class="table table-striped table-hover">
+    <tbody>
+      <%= render partial: 'ecm/links/links/link_in_table', collection: links, as: :link %>
+    </tbody>
+  </table>
+</div>

data/config/locales/ecm.links.category.de.yml

@@ -0,0 +1,26 @@
+---
+de:
+  activerecord:
+    models:
+      ecm/links/category:
+        one: Link Kategorie
+        other: Link Kategorien
+    attributes:
+      ecm/links/category:
+        name: Name
+        ecm_links_links: Links
+        ecm_links_links_count: Links
+        slug: Freundliche ID
+        created_at: Erstellt am
+        short_description: Kurzbeschreibung
+        updated_at: Aktualisiert am
+        depth: Tiefe
+        lft: Links
+        long_description: Langbeschreibung
+        markup_language: Markup Sprache
+        parent_id: Über Kategorie
+        locale: Sprache
+        rgt: Rechts
+        link_footer_column: Link Footer Spalte
+        children: Unterkategorien
+

data/config/locales/ecm.links.category.en.yml

@@ -0,0 +1,26 @@
+---
+en:
+  activerecord:
+    models:
+      ecm/links/category:
+        one: link category
+        other: link categories
+    attributes:
+      ecm/links/category:
+        name: name
+        ecm_links_links: links
+        ecm_links_links_count: links
+        slug: friendly id
+        created_at: created at
+        short_description: short description
+        updated_at: updated at
+        depth: depth
+        lft: left
+        long_description: long description
+        markup_language: markup language
+        parent_id: parent category
+        locale: language
+        rgt: right
+        link_footer_column: link footer column
+        children: Subcategories
+

data/config/locales/ecm.links.de.yml

@@ -0,0 +1,9 @@
+de:
+  ecm:
+    links:
+      active_admin:
+        menu: Links
+  routes:
+    ecm_links_categories: link-kategorien
+    ecm_links_links: links
+

data/config/locales/ecm.links.en.yml

@@ -0,0 +1,9 @@
+en:
+  ecm:
+    links:
+      active_admin:
+        menu: links
+  routes:
+    ecm_links_categories: link-categories
+    ecm_links_links: links
+

data/config/locales/ecm.links.link.de.yml

@@ -0,0 +1,18 @@
+--- 
+de: 
+  activerecord: 
+    models: 
+      ecm/links/link: 
+        one: Link
+        other: Links
+    attributes: 
+      ecm/links/link: 
+        position: Position
+        name: Name
+        created_at: Erstellt am
+        updated_at: Aktualisiert am
+        url: URL
+        ecm_links_category: Link Kategorie
+        ecm_links_category_id: Link Kategorie
+        markup_language: Markup Sprache
+        description: Beschreibung

data/config/locales/ecm.links.link.en.yml

@@ -0,0 +1,18 @@
+--- 
+en: 
+  activerecord: 
+    models: 
+      ecm/links/link: 
+        one: link
+        other: links
+    attributes: 
+      ecm/links/link: 
+        position: position
+        name: name
+        created_at: created at
+        updated_at: updated at
+        url: url
+        ecm_links_category: link category
+        ecm_links_category_id: link category
+        markup_language: markup language
+        description: description

data/db/migrate/001_create_ecm_links_categories.rb

@@ -0,0 +1,26 @@
+class CreateEcmLinksCategories < ActiveRecord::Migration
+  def change
+    create_table :ecm_links_categories do |t|
+      t.string :locale
+      t.string :name
+      t.text :short_description
+      t.text :long_description
+      t.string :markup_language
+      t.integer :link_footer_column
+
+      # associations
+      t.integer :ecm_links_links_count, :default => 0, :null => false
+
+      # awesome nested set
+      t.integer :lft
+      t.integer :rgt
+      t.integer :parent_id
+      t.integer :depth
+
+      # friendly id
+      t.string :slug
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/002_create_ecm_links_links.rb

@@ -0,0 +1,19 @@
+class CreateEcmLinksLinks < ActiveRecord::Migration
+  def change
+    create_table :ecm_links_links do |t|
+      t.string :name
+      t.string :url
+      t.text :description
+      t.string :markup_language
+
+      # associations
+      t.references :ecm_links_category
+
+      # acts as list
+      t.integer :position
+
+      t.timestamps
+    end
+    add_index :ecm_links_links, :ecm_links_category_id
+  end
+end