ecm_references2 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0eec12851cb4a8cc1568d3cd8b91b9cf9d47cd7
+  data.tar.gz: 5ef621a651dbbc89498d513e28279461fc0e8298
+SHA512:
+  metadata.gz: 78478ab24ab14599ed662a892f5ebd2cee1d23e3595201a84a797c946372929b07c48c4610a0df1c1640d0cfbb23cb89c465c1efb96b4e1947d71e60b4574d41
+  data.tar.gz: e38a50bbc36a352de7faf6c3c25b97658f23f720ac0ef374af125f3d3a2f91934b69984c15549c15a582e45d2b16f652400874a9de536ea820b850927e0f2af3

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,47 @@
+= ECM References 2 Module
+
+This project rocks and uses MIT-LICENSE.
+
+= Installation
+
+Add it to your Gemfile:
+
+    # Gemfile
+    gem 'ecm_references2'
+
+Add the initializer:
+
+    rails g ecm:references:install
+
+Add the migrations:
+
+    rake ecm_references_engine:install:migrations
+    rake db:migrate
+
+Add the routes:
+
+    # config/routes.rb
+    Ecm::References::Routing.routes(self)
+
+
+= Running tests
+
+    gem install bundler
+    bundle
+    cd spec/dummy && rake db:migrate RAILS_ENV=test && cd ../..
+    guard
+
+= FAQ
+
+Q: Bundling fails installing RedCloth with message "Failed to build native extension..../home/vagrant/.rvm/rubies/ruby-2.2.3/lib/ruby/2.2.0/mkmf.rb:456:in `try_do': The compiler failed to generate an executable file. (RuntimeError) You have to install development tools first.". What can I do?
+
+A: Install libgmp-dev:
+
+    sudo apt-get install -y libgmp-dev
+    
+
+Q: Tests fail with message "Paperclip::Errors::CommandNotFoundError: Could not run the `identify` command. Please install ImageMagick.". What can I do?
+
+A: Install imagemagick:
+
+    sudo apt-get install -y imagemagick

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 References 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/admin/ecm_references_categories.rb

@@ -0,0 +1,92 @@
+ActiveAdmin.register Ecm::References::Category do
+  menu parent: proc { I18n.t('ecm.references.active_admin.menu') }.call
+
+  permit_params :description,
+                :locale,
+                :markup_language,
+                :name,
+                :parent_id,
+                :slug
+
+  # Nested set settings
+  config.sort_order = 'lft_asc'
+  sortable_tree_member_actions
+
+  form do |f|
+    f.inputs do
+      f.input :parent, as: :select, collection: nested_set_options(Ecm::References::Category, f.object) { |c| "#{'    ' * c.depth}• #{c}".html_safe }
+    end # f.inputs
+
+    f.inputs do
+      f.input :locale, as: :select, collection: I18n.available_locales.map(&:to_s)
+      f.input :name
+      f.input :description
+    end # f.inputs
+
+    f.inputs do
+      f.input :markup_language, as: :select, collection: Ecm::References::Configuration.markup_languages.map(&:to_s)
+    end # f.inputs
+
+    f.actions
+  end # form
+
+  index as: :nested_set do
+    selectable_column
+    sortable_tree_columns
+    sortable_tree_indented_column :name
+    column :locale
+    column :reference_count
+    column :created_at
+    column :updated_at
+    actions
+  end # index
+
+  show title: :to_s do
+    panel Ecm::References::Category.human_attribute_name(:description) do
+      ecm_references_category.description
+    end # panel
+
+    panel Ecm::References::Category.human_attribute_name(:children) do
+      table_for ecm_references_category.descendants, i18n: Ecm::References::Category do
+        sortable_tree_columns
+        sortable_tree_indented_column :name
+        column :locale
+        column :reference_count
+        column :created_at
+        column :updated_at
+        column do |child|
+          link_to(I18n.t('active_admin.view'), [:admin, child], class: 'member_link view_link') +
+            link_to(I18n.t('active_admin.edit'), [:edit, :admin, child], class: 'member_link edit_link')
+        end
+      end # table_for
+    end # panel
+
+    panel Ecm::References::Category.human_attribute_name(:references) do
+      table_for ecm_references_category.references, i18n: Ecm::References::Reference do
+        sortable_columns
+        column :preview_picture do |reference|
+          image_tag(reference.preview_picture_image_url(:small_thumb)) unless reference.preview_picture_image_url(:small_thumb).nil?
+        end
+        column :name
+        column :published
+        column :created_at
+        column :updated_at
+        column do |child|
+          link_to(I18n.t('active_admin.view'), [:admin, child], class: 'member_link view_link') +
+            link_to(I18n.t('active_admin.edit'), [:edit, :admin, child], class: 'member_link edit_link')
+        end
+      end # table_for
+    end # panel
+  end # show
+
+  sidebar Ecm::References::Category.human_attribute_name(:details), only: :show do
+    attributes_table_for ecm_references_category do
+      row :parent
+      row :name
+      row :locale
+      row :reference_count
+      row :created_at
+      row :updated_at
+    end
+  end # sidebar
+end # ActiveAdmin.register Ecm::References::Category

data/app/admin/ecm_references_references.rb

@@ -0,0 +1,78 @@
+ActiveAdmin.register Ecm::References::Reference do
+  menu parent: proc { I18n.t('ecm.references.active_admin.menu') }.call
+
+  permit_params :attached_pictures_attributes,
+                :category,
+                :ecm_categories_category_id,
+                :description,
+                :markup_language,
+                :name,
+                :published,
+                pictures_attributes: [
+                  :description,
+                  :image,
+                  :markup_language,
+                  :name
+                ]
+
+  # List settings
+  sortable_member_actions
+
+  form do |f|
+    f.inputs do
+      f.input :category, as: :select,
+                         collection: nested_set_options(Ecm::References::Category) { |c| "#{'    ' * c.depth}• #{c}".html_safe },
+                         prompt: ''
+    end # f.inputs
+
+    f.inputs do
+      f.input :name
+      f.input :description
+      f.input :published, as: :boolean
+    end # f.inputs
+
+    f.inputs do
+      f.input :markup_language, as: :select, collection: Ecm::References::Configuration.markup_languages.map(&:to_s)
+    end # f.inputs
+
+    form_inputs_for_pictureable(f)
+
+    f.actions
+
+    #    f.inputs do
+    #      span do f.object.errors.inspect end
+    #    end
+  end # form
+
+  index do
+    selectable_column
+    column :preview_picture do |reference|
+      image_tag(reference.preview_picture_image_url(:small_thumb)) unless reference.preview_picture_image_url(:small_thumb).nil?
+    end
+    column :category
+    column :name
+    column :published
+    column :created_at
+    column :updated_at
+    actions
+  end # index
+
+  show title: :to_s do
+    panel Ecm::References::Reference.human_attribute_name(:description) do
+      ecm_references_reference.description
+    end # panel
+
+    panel_for_pictureable
+  end # show
+
+  sidebar Ecm::References::Reference.human_attribute_name(:details), only: :show do
+    attributes_table_for ecm_references_reference do
+      row :category
+      row :name
+      row :published
+      row :markup_language
+      row :created_at
+      row :updated_at
+    end
+  end # sidebar
+end # ActiveAdmin.register Ecm::References::Reference

data/app/assets/stylesheets/ecm_references.css.less

@@ -0,0 +1,7 @@
+/*
+ *= require ecm_pictures
+ */
+
+.reference-preview {
+  margin-bottom: 20px;
+}

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

@@ -0,0 +1,11 @@
+module Ecm::References
+  class CategoriesController < Configuration.base_controller.constantize
+    def index
+      @categories = Category.with_public_visibility.page(params[:page]).per(5)
+    end
+
+    def show
+      @category = Category.with_public_visibility.find(params[:id])
+    end
+  end
+end

data/app/controllers/ecm/references/references_controller.rb

@@ -0,0 +1,11 @@
+module Ecm::References
+  class ReferencesController < Configuration.base_controller.constantize
+    def index
+      @references = Reference.with_public_visibility.page(params[:page]).per(5)
+    end
+
+    def show
+      @reference = Reference.with_public_visibility.find(params[:id])
+    end
+  end
+end

data/app/models/ecm/references.rb

@@ -0,0 +1,5 @@
+module Ecm::References
+  def self.table_name_prefix
+    'ecm_references_'
+  end
+end

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

@@ -0,0 +1,102 @@
+module Ecm::References
+  class Category < ActiveRecord::Base
+    self.table_name = 'ecm_references_categories'
+
+    # associations
+    has_many :references, foreign_key: :ecm_categories_category_id,
+                          dependent:   :destroy
+
+    # attributes
+    # attr_accessible :description,
+    #                 :locale,
+    #                 :markup_language,
+    #                 :name,
+    #                 :parent_id,
+    #                 :slug
+
+    # callbacks
+    after_initialize :set_defaults
+    before_validation :set_locale_from_parent
+    before_save :update_locale_on_children!, if: proc { |category| category.locale_changed? }
+
+    # default scope
+    default_scope { order(:lft) }
+
+    # friendly id support
+    extend FriendlyId
+    friendly_id :name, use: [:slugged, :finders]
+
+    # markup support
+    acts_as_markup language: :variable, columns: [:description]
+
+    # nested set support
+    acts_as_nested_set
+
+    # validations
+    validates :locale, inclusion: I18n.available_locales.map(&:to_s), allow_blank: true
+    validate :equality_of_locale_and_parent_locale, if: proc { |category| category.parent.respond_to?(:locale) }
+    validates :markup_language, presence: true,
+                                inclusion: Ecm::References::Configuration.markup_languages.map(&:to_s)
+    validates :name, presence: true,
+                     uniqueness: { scope: [:parent_id] }
+
+    def self.localized
+      where(locale: I18n.locale)
+    end
+
+    def self.with_public_visibility
+      localized
+    end
+
+    def human
+      name
+    end
+
+    def locale=(locale)
+      write_attribute(:locale, locale.to_s) if locale.respond_to?(:to_s)
+    end
+
+    def locale_label(view)
+      view.content_tag(:span, locale, class: 'label label-default')
+    end
+
+    def references_count
+      references.count
+    end
+
+    def references_count_label(view)
+      view.content_tag(:span, references_count, class: 'badge')
+    end
+
+    def to_s
+      name
+    end
+
+    def tree_name
+      name
+    end
+
+    private
+
+    def equality_of_locale_and_parent_locale
+      locale == parent.locale
+    end # def
+
+    def set_defaults
+      if self.new_record?
+        self.markup_language ||= Ecm::References::Configuration.default_markup_language
+      end
+    end # def
+
+    def set_locale_from_parent
+      self.locale = parent.locale if parent.respond_to?(:locale)
+    end # def
+
+    def update_locale_on_children!
+      children.each do |child|
+        child.locale = locale
+        child.save!
+      end
+    end # def
+  end # class Category < ActiveRecord::Base
+end # module Ecm::References

data/app/models/ecm/references/reference.rb

@@ -0,0 +1,83 @@
+module Ecm::References
+  class Reference < ActiveRecord::Base
+    self.table_name = 'ecm_references_references'
+
+    # acts as list
+    acts_as_list scope: :ecm_categories_category
+    default_scope { order('ecm_categories_category_id ASC, position ASC') }
+
+    # acts as published
+    include ActsAsPublished::ActiveRecord
+    acts_as_published
+
+    # associations
+    belongs_to :category,
+               foreign_key: :ecm_categories_category_id
+    has_many :attached_pictures, as: :pictureable,
+                                 class_name: Ecm::Pictures::AttachedPicture,
+                                 inverse_of: :pictureable
+    has_many :pictures, through: :attached_pictures,
+                        class_name: Ecm::Pictures::Picture
+
+    accepts_nested_attributes_for :attached_pictures, allow_destroy: true
+    accepts_nested_attributes_for :pictures, allow_destroy: true
+
+    # attributes
+    # attr_accessible :attached_pictures_attributes,
+    #                 :category,
+    #                 :ecm_categories_category_id,
+    #                 :description,
+    #                 :markup_language,
+    #                 :name,
+    #                 :pictures_attributes
+
+    # callbacks
+    after_initialize :set_defaults
+    #    before_validation do
+    #      self.published = ["published"] # if @attributes.has_key?("published")
+    #    end
+
+    # friendly id support
+    extend FriendlyId
+    friendly_id :name, use: [:slugged, :finders]
+
+    # markup support
+    acts_as_markup language: :variable, columns: [:description]
+
+    # validations
+    validates :ecm_categories_category_id, presence: true
+    validates :markup_language, presence: true,
+                                inclusion: Ecm::References::Configuration.markup_languages.map(&:to_s)
+    validates :name, presence: true,
+                     uniqueness: { scope: [:ecm_categories_category_id] }
+
+    def self.localized
+      joins(:category).where(ecm_references_categories: { locale: I18n.locale })
+    end
+
+    def self.with_public_visibility
+      published.localized
+    end
+
+    def preview_picture
+      pictures.first
+    end
+
+    def preview_picture_image_url(style = nil)
+      preview_picture.image.url(style) if preview_picture.respond_to?(:image) && preview_picture.image.respond_to?(:url)
+    end
+
+    def to_s
+      name
+    end # def
+
+    private
+
+    def set_defaults
+      if self.new_record?
+        self.markup_language ||= Ecm::References::Configuration.default_markup_language
+        self.published = Ecm::References::Configuration.new_references_published_by_default if published_at.nil?
+      end
+    end # def
+  end # class Reference < ActiveRecord::Base
+end # module Ecm::References