alchemy-usermanual 0.9.2

data/app/controllers/alchemy/admin/user_manual_controller.rb

@@ -0,0 +1,11 @@
+module Alchemy
+  module Admin
+    class UserManualController < Alchemy::Admin::BaseController
+
+      def show
+        @manual = UserManual::Creator.new
+      end
+
+    end
+  end
+end

data/app/views/alchemy/admin/user_manual/show.html.erb

@@ -0,0 +1,9 @@
+<% content_for :stylesheets do %>
+  <%= stylesheet_link_tag 'alchemy/user_manual' %>
+<% end %>
+<% content_for :javascripts do %>
+  <%= javascript_include_tag 'alchemy/user_manual' %>
+<% end %>
+<div class="alchemy_user_manual wrapper">
+  <%= raw @manual.html_content %>
+</div>

data/config/authorization_rules.rb

@@ -0,0 +1,5 @@
+authorization do
+  role :admin do
+    has_permission_on :alchemy_admin_user_manual, :to => [:show]
+  end
+end

data/config/initializers/alchemy_module.rb

@@ -0,0 +1,15 @@
+Alchemy::Modules.register_module({
+  name: 'user_manual',
+  engine_name: 'alchemy',
+  navigation: {
+    name: 'modules.user_manual',
+    controller: 'alchemy/admin/user_manual',
+    action: 'show',
+    image: 'alchemy/icon_user_manual.png',
+    sub_navigation: [{
+      name: 'modules.user_manual',
+      controller: 'alchemy/admin/user_manual',
+      action: 'show'
+    }]
+  }
+})

data/config/locales/de.yml

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+---
+de:
+  alchemy:
+    modules:
+        user_manual: Handbuch
+    user_manual:
+      introduction_text: "In diesem Handbuch finden Sie Informationen über die im Content management system verfügbaren [Seitentypen](#page_layouts) und [Elemente](#elements), ganz individuell für Ihre Website. Außerdem erhalten Sie nähere Informationen darüber, wozu die jeweiligen [Seitentypen](#page_layouts) und [Elemente](#elements) dienen und wie sie einzusetzen sind."
+      element_amount: Mögliche Anzahl pro Seite
+      once_per_page: Einmal pro Seite
+      available_elements: Verfügbare Elemente
+      user_manual: Benutzerhandbuch
+      manual_for: "Benutzerhandbuch für %{project_name}"
+      website_structure: "Liste der verfügbaren Seitentypen und der darauf verfügbaren Elemente"
+      page_layout_descriptions: "Beschreibung der Seitentypen"
+      element_descriptions: "Beschreibung der Elemente"
+      properties: Eigenschaften
+      no_description: Keine Beschreibung vorhanden.
+      "true": Ja
+      "false": Nein
+      none: Keine
+      unlimited: Unendlich
+      element_autogenerating: "Automatisch erstellte Elemente beim Anlegen der Seite"
+      uniqueness: "Einmalig verwendbar"
+      layoutpage: "globale Seite"

data/config/locales/en.yml

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+---
+en:
+  alchemy:
+    modules:
+      user_manual: Manual
+    user_manual:
+      introduction_text: "With this user manual you will get informations about your very individual [page types](#page_layouts) and [elements](#elements) available in the content management system. Furthermore you will get details about what the [page types](#page_layouts) and [elements](#elements) are used to and how you use them."
+      element_amount: Possible count per page
+      once_per_page: Once per page
+      available_elements: Available elements
+      user_manual: "User manual"
+      manual_for: "User manual for %{project_name}"
+      website_structure: "Listing of all available page layouts and their elements"
+      page_layout_descriptions: "Description for page layouts"
+      element_descriptions: "Description for elements"
+      properties: Properties
+      no_description: No description available yet.
+      "true": yes
+      "false": no
+      none: None
+      unlimited: Unlimited
+      element_autogenerating: "Autogenerating of elements"
+      uniqueness: "uniquely usable"
+      layoutpage: "global page"

data/config/routes.rb

@@ -0,0 +1,5 @@
+Alchemy::Engine.routes.draw do
+  namespace :admin do
+    get 'usermanual', :to => 'user_manual#show', :as => 'usermanual'
+  end
+end

data/lib/alchemy/user_manual/creator.rb

@@ -0,0 +1,43 @@
+require 'erb'
+require 'github/markdown'
+
+module Alchemy
+  module UserManual
+    class Creator
+      include TemplateHelper
+
+      attr_accessor :name
+
+      def initialize(name = Rails.application.class.parent_name)
+        self.name = name
+        @manual = self
+      end
+
+      def html_content
+        @content ||= GitHub::Markdown.render_gfm(render_content)
+      end
+
+    private
+
+      def template_path
+        File.expand_path("../templates", __FILE__)
+      end
+
+      def ordered_template_files
+        Dir[
+          "#{template_path}/introduction.md.erb",
+          "#{template_path}/page_layouts.md.erb",
+          "#{template_path}/elements.md.erb"
+        ]
+      end
+
+      def render_content
+        render_result = ""
+        ordered_template_files.each do |template|
+          render_result << ERB.new(File.read(template)).result(binding)
+        end
+        render_result
+      end
+    end
+  end
+end

data/lib/alchemy/user_manual/engine.rb

@@ -0,0 +1,21 @@
+module Alchemy
+  module UserManual
+    class Engine < ::Rails::Engine
+      isolate_namespace Alchemy
+      engine_name 'alchemy_user_manual'
+
+      initializer 'alchemy_user_manual.assets' do |app|
+        app.config.assets.precompile += [
+          "alchemy/user_manual.css",
+          "alchemy/user_manual.js"
+        ]
+      end
+
+      def self.add_auth_rules
+        Alchemy::Auth::Engine.get_instance.load(File.join(File.dirname(__FILE__), '../../..', 'config/authorization_rules.rb'))
+      end
+
+      config.to_prepare &method(:add_auth_rules).to_proc
+    end
+  end
+end

data/lib/alchemy/user_manual/helpers/template_helper.rb

@@ -0,0 +1,51 @@
+module Alchemy
+  module UserManual
+    module TemplateHelper
+
+      private
+
+      def translated_element_name(name)
+        I18n.t(name, scope: 'element_names', default: name.humanize)
+      end
+
+      def element_anchor_name(element_name)
+        "element_#{translated_element_name(element_name).parameterize}"
+      end
+
+      def layout_properties(layout)
+        properties = []
+        properties << ["layoutpage", layout["layoutpage"] || "false"]
+        properties << ["uniqueness", layout["unique"] || "false"]
+        properties << ["available_elements", linked_element_collection(layout["elements"]) || "none" ]
+        properties << ["element_autogenerating", linked_element_collection(layout["autogenerate"]) || "none"]
+      end
+
+      def element_properties(element)
+        properties = []
+        properties << ['element_amount', possible_amount_of_element(element)]
+      end
+
+      def property_name(property)
+        I18n.t(property.first, :scope => "user_manual")
+      end
+
+      def property_value(property)
+        I18n.t(property.last, :scope => "user_manual")
+      end
+
+      def linked_element_collection(element_names=[])
+        return if element_names.blank?
+        element_names.map {|e| "[#{translated_element_name(e)}](##{element_anchor_name(e)})" }.join(", ")
+      end
+
+      def possible_amount_of_element(element)
+        if element['unique'].to_s == "true"
+          'once_per_page'
+        else
+          element['amount'].present? ? element['amount'] : 'unlimited'
+        end
+      end
+
+    end
+  end
+end

data/lib/alchemy/user_manual/templates/elements.md.erb

@@ -0,0 +1,13 @@
+## 2. <a name="elements"></a> <%= I18n.t("element_descriptions", :scope => "user_manual") %>
+
+<% Alchemy::Element.descriptions.each do |e| %>
+
+### <a name="<%= element_anchor_name(e.values.first) %>"></a><%= translated_element_name(e.values.first) %>
+
+<%= I18n.t(e.values.first, scope: 'element_hints', default: I18n.t("no_description", :scope => "user_manual")) %>
+
+|<%= element_properties(e).map {|p| "#{property_name(p)}" }.join("|") %>|
+|<%= element_properties(e).map {|p| "---" }.join("|") %>|
+|<%= element_properties(e).map {|p| "#{property_value(p)}" }.join("|") %>|
+
+<% end %>

data/lib/alchemy/user_manual/templates/introduction.md.erb

@@ -0,0 +1,3 @@
+# <%= I18n.t("manual_for", :project_name => @manual.name, :scope => "user_manual") %>
+
+**<%= I18n.t("introduction_text", :scope => "user_manual") %>**

data/lib/alchemy/user_manual/templates/page_layouts.md.erb

@@ -0,0 +1,13 @@
+## 1. <a name="page_layouts"></a> <%= I18n.t("page_layout_descriptions", :scope => "user_manual") %>
+
+<% Alchemy::PageLayout.all.each do |l| %>
+
+### <%= PageLayout.human_layout_name(l["name"]) %>
+
+<%= I18n.t(l.values.first, scope: 'page_layout_hints', default: I18n.t("no_description", :scope => "user_manual")) %>
+
+|<%= layout_properties(l).map {|p| "#{property_name(p)}" }.join("|") %>|
+|<%= layout_properties(l).map {|p| "---" }.join("|") %>|
+|<%= layout_properties(l).map {|p| "#{property_value(p)}" }.join("|") %>|
+
+<% end %>

data/lib/alchemy/user_manual/version.rb

@@ -0,0 +1,5 @@
+module Alchemy
+  module UserManual
+    VERSION = "0.9.2"
+  end
+end

data/lib/alchemy/usermanual.rb

@@ -0,0 +1,9 @@
+require "alchemy_cms"
+require "alchemy/user_manual/engine"
+require "alchemy/user_manual/helpers/template_helper"
+require "alchemy/user_manual/creator"
+
+module Alchemy
+  module UserManual
+  end
+end

data/spec/controllers/admin/user_manual_controller_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+module Alchemy
+  module Admin
+    describe UserManualController do
+      describe "#show" do
+        it "provides an instance of the UserManual::Creator" do
+          controller.send :show
+          expect(assigns :manual).to be_instance_of(UserManual::Creator)
+        end
+      end
+    end
+  end
+end

data/spec/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/spec/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__)
+
+Dummy::Application.load_tasks

data/spec/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 vendor/assets/javascripts of plugins, if any, 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/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,13 @@
+/*
+ * 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 vendor/assets/stylesheets of plugins, if any, 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/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/spec/dummy/app/helpers/application_helper.rb

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

data/spec/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>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/alchemy/elements.yml

@@ -0,0 +1,6 @@
+- name: test_element
+  contents:
+
+- name: another_test_element
+  unique: true
+  contents:

data/spec/dummy/config/alchemy/page_layouts.yml

@@ -0,0 +1,2 @@
+- name: test_page
+  elements: ['test_element', 'another_test_element']

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "alchemy/usermanual"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+