how_to 0.0.1

data/app/views/how_to/faq/show.html.erb

@@ -0,0 +1,294 @@
+<% content_for :head do %>
+    <%= javascript_include_tag 'how_to/jquery.scrollTo.min' %>
+    <%= javascript_include_tag 'how_to/jquery.localScroll.min' %>
+    <%= javascript_include_tag 'how_to/jquery.treeview' %>
+    <%= stylesheet_link_tag 'how_to/jquery.treeview' %>
+<% end %>
+
+<div class="faq_content" id="faq_content" style="padding: 0">
+  <div id="wrapper" class="">
+    <div class="span8">
+      <div id="primary">
+        <% HowTo::Section.with_content.ordered.each do |section| %>
+
+            <h3 id="<%= dom_id(section) %>"><%= section.name %></h3>
+            <ul class="section_menu">
+              <% section.contents.each do |content| %>
+                  <li>
+                    <%= link_to content.title.html_safe, "##{dom_id(content)}" %>
+                  </li>
+              <% end %>
+            </ul>
+
+            <dl class="faq">
+              <% section.contents.each do |content| %>
+                  <dt id="<%= dom_id(content) %>">
+                    <%= content.title.html_safe %>
+                  </dt>
+                  <dd>
+                    <%= content.description.html_safe %>
+                  </dd>
+              <% end %>
+            </dl>
+        <% end %>
+      </div>
+
+    </div>
+    <div class="span4">
+      <div id="sidebar">
+        <div id="sidebar_content" class="section_menu">
+          <h3>Select Category</h3>
+
+          <div id="sidetreecontrol"><a href="?#">Collapse All</a> | <a href="?#">Expand All</a></div>
+          <%= sorted_nested_li(HowTo::Section.active, :order, "id='tree_root'") do |section| %>
+              <% if section.contents_count > 0 %>
+                  <%= link_to section.name, "##{dom_id(section)}" %>
+              <% else %>
+                  <%= section.name %>
+              <% end %>
+          <% end %>
+        </div>
+      </div>
+    </div>
+
+  </div>
+
+</div>
+
+<script type="text/javascript">
+    $(document).ready(function () {
+        $('.container').removeClass('container').addClass('container-fluid');
+        $('.row').removeClass('row').addClass('row-fluid');
+
+
+        $.localScroll.defaults.axis = 'xy';
+
+        /**
+         * NOTE: I use $.localScroll instead of $('#navigation').localScroll() so I
+         * also affect the >> and << links. I want every link in the page to scroll.
+         */
+        $.localScroll({
+            target: '#faq_content', // could be a selector or a jQuery object too.
+            queue: true,
+            duration: 1000,
+            hash: true,
+            onBefore: function (e, anchor, $target) {
+                $(anchor).css('paddingTop', $('#sidebar').offset().top + 'px');
+                // The 'this' is the settings object, can be modified
+            },
+            onAfter: function (anchor, settings) {
+                // The 'this' contains the scrolled element (#content)
+            }
+        });
+        $.localScroll();
+
+        $("#tree_root").treeview({
+            collapsed: true,
+            animated: "medium",
+            control: "#sidetreecontrol",
+            persist: "location"
+        });
+    });
+
+</script>
+
+<style type="text/css">
+    body {
+        direction: ltr;
+    }
+
+    .faq_content .row-fluid {
+        background: #eee;
+    }
+
+    .faq_content {
+        font: 14px/24px helvetica, arial, sans-serif;
+        color: #666666;
+        padding-left: 20px !important;
+    }
+
+    .faq_content a:focus {
+        outline: 1px dotted;
+    }
+
+    .faq_content hr {
+        border: 0 #ccc solid;
+        border-top-width: 1px;
+        clear: both;
+        height: 0;
+    }
+
+    .faq_content h1 {
+        font-size: 25px;
+        line-height: 25px;
+        font-family: 'Myriad Pro', Helvetica, Arial, sans-serif;
+    }
+
+    .faq_content h2 {
+        font-size: 23px;
+        line-height: 23px;
+    }
+
+    .faq_content h3 {
+        font-size: 20px;
+        line-height: 21px;
+    }
+
+    .faq_content h4 {
+        font-size: 19px;
+        line-height: 19px;
+    }
+
+    .faq_content h5 {
+        font-size: 17px;
+        line-height: 17px;
+    }
+
+    .faq_content h6 {
+        font-size: 15px;
+        line-height: 15px;
+    }
+
+    .faq_content h1, .faq_content h2, .faq_content h3, .faq_content h4, .faq_content h5, .faq_content h6 {
+        color: #000000;
+    }
+
+    .faq_content ol {
+        list-style: decimal;
+    }
+
+    .faq_content ul {
+        list-style: disc;
+    }
+
+    .faq_content li {
+        margin-left: 15px;
+    }
+
+        /** BASIC STYLING **/
+
+    .faq_content  div#wrapper {
+        /*width: 960px;*/
+        margin: 0 auto;
+        position: relative;
+    }
+
+    .faq_content  div#primary {
+        margin-top: 10px;
+
+    }
+
+    .faq_content  h1#title {
+        text-align: center;
+        font-size: 50px;
+        line-height: 70px;
+        margin-top: 20px;
+    }
+
+    .faq_content a {
+        color: #0986e3;
+    }
+
+    .faq_content ul.section_menu {
+        background: #EDEDED;
+        padding: 10px 0px;
+        margin: 0 !important;
+    }
+
+    .faq_content dl.faq {
+        margin-bottom: 30px;
+    }
+
+    .faq_content dl.faq dt {
+        font-weight: bold;
+        color: #000000;
+        padding: 15px 0 5px 0;
+        display: block;
+    }
+
+    .faq_content dl.faq dd {
+        padding-bottom: 25px;
+        border-bottom: 1px solid #cccccc;
+        display: block;
+    }
+
+    .faq_content #sidebar {
+
+    }
+
+    .faq_content #sidebar_content {
+        position: fixed;
+        /*top: 0px;*/
+        /* just used to show how to include the margin in the effect */
+        width: 31.5%;
+    }
+
+    .faq_content #sidebar_content ul li {
+        list-style: none;
+        margin: 0px 5px;
+    }
+
+    .faq_content #sidebar_content .treeview ul {
+        background: none;
+    }
+
+    .faq_content #sidebar_content.fixed {
+        position: fixed;
+        top: 0;
+        width: 30.5%;
+    }
+
+        /************************************/
+    .content-wapper {
+        position: relative;
+    }
+
+    .welcome ul {
+        padding: 0;
+        margin: 0;
+    }
+
+    .welcome ul li {
+        list-style: none;
+        display: inline;
+
+    }
+
+    body.rtl {
+        direction: rtl;
+    }
+
+        /*************Bootstrap property**********/
+    .rtl .row-fluid [class*="span"], .rtl .navbar .brand {
+        float: right !important;
+    }
+
+    .rtl .pull-right {
+        float: left;
+    }
+
+        /*************Bootstrap property**********/
+
+    .rtl  .faq_content .row-fluid {
+        background: #eee;
+    }
+
+    .rtl  .faq_content {
+        font: 14px/24px helvetica, arial, sans-serif;
+        color: #666666;
+        padding-right: 20px !important;
+        padding-left: 0 !important;
+    }
+
+    .rtl  .faq_content li {
+        margin-right: 15px;
+    }
+
+    .rtl  .faq_content dl.faq dt {
+        font-weight: bold;
+        color: #000000;
+        padding: 15px 0 5px 0;
+        display: block;
+    }
+</style>
+

data/app/views/how_to/sections/_form.html.erb

@@ -0,0 +1,33 @@
+<%= form_for @section, :html => {:class => 'form-horizontal'} do |f| %>
+    <fieldset>
+      <legend><%= controller.action_name.capitalize %> Section</legend>
+
+      <div class="control-group">
+        <%= f.label :parent_section, :class => 'control-label' %>
+        <div class="controls">
+          <%= f.select :parent_id, nested_set_options(HowTo::Section.active.roots_only.without(@section.id)) { |i| "#{'-' * i.level} #{i.name}" }, {:prompt => 'select'}, :'chosen-enabled' => true %>
+        </div>
+      </div>
+
+      <% I18n.available_locales.each do |locale| %>
+          <div class="control-group">
+            <%= f.label :name, "Name for #{locale}", :class => 'control-label' %>
+            <div class="controls">
+              <%= f.text_field "i18n_#{locale.to_s}_name", :class => 'text_field' %>
+            </div>
+          </div>
+
+      <% end %>
+
+      <div class="control-group">
+        <%= f.label :order, :class => 'control-label' %>
+        <div class="controls">
+          <%= f.text_field :order, :class => 'text_field'%>
+        </div>
+      </div>
+      <div class="form-actions">
+        <%= f.submit nil, :class => 'btn btn-primary' %>
+        <%= link_to 'Cancel', sections_path, :class => 'btn' %>
+      </div>
+    </fieldset>
+<% end %>

data/app/views/how_to/sections/edit.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'form' %>

data/app/views/how_to/sections/index.html.erb

@@ -0,0 +1,24 @@
+<h1>Sections</h1>
+<table class="table table-striped">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Content count</th>
+      <th>Actions</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @sections.each do |section| %>
+      <tr>
+        <td><%= link_to section.name, section_path(section) %></td>
+        <td><%= section.contents_count %></td>
+        <td>
+          <%= link_to 'Edit', edit_section_path(section), :class => 'btn btn-mini' %>
+          <%= link_to 'Destroy', section_path(section), :method => :delete, :confirm => 'Are you sure?', :class => 'btn btn-mini btn-danger' %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= link_to 'New', new_section_path, :class => 'btn btn-primary' %>

data/app/views/how_to/sections/new.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'form' %>

data/app/views/how_to/sections/show.html.erb

@@ -0,0 +1,18 @@
+<h1>Section</h1>
+
+<p>
+  <b>Name</b><br>
+  <%= @section.name %>
+</p>
+
+<p>
+  <b>Active</b><br>
+  <%= @section.active %>
+</p>
+
+
+<div class="form-actions">
+  <%= link_to 'Back', sections_path, :class => 'btn'  %>
+  <%= link_to 'Edit', edit_section_path(@section), :class => 'btn' %>
+  <%= link_to 'Delete', section_path(@section), :method => 'delete', :confirm => 'Are you sure?', :class => 'btn btn-danger' %>
+</div>

data/app/views/layouts/how_to/_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/how_to/_navigation.html.erb

@@ -0,0 +1,13 @@
+<%= link_to "Home", root_path, :class => 'brand' %>
+<% if can_manage_how_to? %>
+    <ul class="nav">
+
+      <li>
+        <%= link_to 'Sections', :sections %>
+      </li>
+
+      <li>
+        <%= link_to 'Contents', :contents %>
+      </li>
+    </ul>
+<% end %>

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

@@ -0,0 +1,37 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/html">
+<head>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title><%= content_for?(:title) ? yield(:title) : "App_Name" %></title>
+  <meta name="description" content="<%= content_for?(:description) ? yield(:description) : "App_Name" %>">
+  <%= stylesheet_link_tag "how_to/application", :media => "all" %>
+  <%= javascript_include_tag "how_to/application" %>
+  <%= csrf_meta_tags %>
+  <%= yield(:head) %>
+</head>
+<body class="<%= controller_name %> <%= action_name %>">
+<header class="navbar navbar-fixed-top">
+  <nav class="navbar-inner">
+    <div class="container">
+      <%= render 'layouts/how_to/navigation' %>
+    </div>
+  </nav>
+</header>
+<section class="content-wapper">
+  <div id="main" role="main" class="clearfix">
+    <div class="container-fluid">
+      <div class="content">
+        <div class="row-fluid">
+          <div class="span12">
+            <%= render 'layouts/how_to/messages' %>
+            <%= yield %>
+          </div>
+        </div>
+        <footer>
+        </footer>
+      </div>
+    </div>
+  </div>
+</section>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+HowTo::Engine.routes.draw do
+  resources :sections
+
+  resources :contents
+  root :to => "faq#show"
+end

data/db/migrate/20130602053453_create_how_to_sections.rb

@@ -0,0 +1,24 @@
+class CreateHowToSections < ActiveRecord::Migration
+  def change
+    create_table :how_to_sections do |t|
+      t.integer :parent_id
+      t.boolean :active  , default: true
+      t.integer :sub_sections_count, default: 0
+      t.integer :contents_count, default: 0
+      t.integer :order, default: 0
+      t.integer :lft
+      t.integer :rgt
+      t.integer :depth
+
+      t.timestamps
+    end
+
+    create_table :how_to_section_translations do |t|
+      t.integer :how_to_section_id
+      t.string :locale
+      t.string :name
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20130602054608_create_how_to_contents.rb

@@ -0,0 +1,19 @@
+class CreateHowToContents < ActiveRecord::Migration
+  def change
+    create_table :how_to_contents do |t|
+      t.integer :section_id
+      t.integer :order , default: 0
+      t.boolean :active, default: true
+      t.timestamps
+    end
+
+    create_table :how_to_content_translations do |t|
+      t.integer :how_to_content_id
+      t.string :locale
+      t.string :title
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/how_to/config_generator.rb

@@ -0,0 +1,16 @@
+module HowTo
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      desc <<DESC
+Description:
+    Copies HowTo configuration file to your application's initializer directory.
+DESC
+
+      def copy_config_file
+        template 'how_to_config.rb', 'config/initializers/how_to_config.rb'
+      end
+    end
+  end
+end

data/lib/generators/how_to/layout_generator.rb

@@ -0,0 +1,18 @@
+module HowTo
+  module Generators
+
+    class LayoutGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views/layouts/how_to', __FILE__)
+
+      desc <<DESC
+Description:
+    Copies HowTo layout file to your application's /views/layouts/how_to directory.
+DESC
+      def generate_partial
+        copy_file "application.html.erb", "app/views/layouts/how_to/#{HowTo.config.layout_name}.html.erb"
+        copy_file "_navigation.html.erb", "app/views/layouts/how_to/_navigation.html.erb"
+        copy_file "_messages.html.erb", "app/views/layouts/how_to/_messages.html.erb"
+      end
+    end
+  end
+end

data/lib/generators/how_to/templates/how_to_config.rb

@@ -0,0 +1,22 @@
+HowTo.configure do |config|
+  #to enable rich text editor make the following line uncommented with the value true
+  #HowTo uses mercury  <https://github.com/jejacks0n/mercury> for rich text editor
+  #You have to install mercury to your application
+  #config.rich_text_enabled = false
+
+  #in your application controller:
+  # def authorize_to_manage_how_to
+  #  redirect_to :somewhere_else unless <condition>
+  # end
+  #
+  #config.authorization_method_to_manage = :authorize_to_manage_how_to!
+  #
+  # if you want to set some permission to vew the how to then you can set a method name and define it as like  authorization_method_to_manage
+  #  def allowed_to_view_how_to
+  #    redirect_to main_app.root_path, :notice => t('notifications.admin_section_access_error') unless current_user
+  #  end
+  #config.authorization_method_to_view = nil #nil allows everybody to vew the how lo page
+
+  #this method should return true/false
+  #config.permitted_to_manage_how_to = :permitted_to_manage_how_to?
+end

data/lib/generators/how_to/view_generator.rb

@@ -0,0 +1,18 @@
+module HowTo
+  module Generators
+
+    class ViewGenerator < Rails::Generators::Base
+      source_root File.expand_path('../../../../app/views/how_to', __FILE__)
+
+      desc <<DESC
+Description:
+    Copies HowTo view (show.html.erb) file to your application's /views/how_to directory.
+DESC
+      def generate_view
+        copy_file "faq/show.html.erb", "app/views/how_to/faq/show.html.erb"
+      end
+
+    end
+
+  end
+end

data/lib/how_to/config.rb

@@ -0,0 +1,28 @@
+require 'active_support/configurable'
+
+module HowTo
+
+  def self.configure(&block)
+    yield @config ||= HowTo::Configuration.new
+  end
+
+  # Global settings for HowTo
+  def self.config
+    @config
+  end
+
+  class Configuration #:nodoc:
+    include ActiveSupport::Configurable
+    config_accessor :rich_text_enabled
+    config_accessor :authorization_method_to_manage
+    config_accessor :authorization_method_to_view
+    config_accessor :permitted_to_manage_how_to
+  end
+
+  configure do |config|
+    config.rich_text_enabled = false
+    config.authorization_method_to_manage = 'authorize_to_manage_how_to'
+    config.authorization_method_to_view = nil
+    config.permitted_to_manage_how_to = 'permitted_to_manage_how_to?'
+  end
+end

data/lib/how_to/engine.rb

@@ -0,0 +1,6 @@
+module HowTo
+  class Engine < ::Rails::Engine
+    isolate_namespace HowTo
+
+  end
+end

data/lib/how_to/version.rb

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

data/lib/how_to.rb

@@ -0,0 +1,5 @@
+require "how_to/engine"
+require "how_to/config"
+
+module HowTo
+end

data/lib/tasks/how_to_tasks.rake

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

data/test/dummy/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in how_to.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+
+# jquery-rails is used by the dummy application
+gem 'mercury-rails'
+gem 'sqlite3'
+