pseudohelp 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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,3 @@
+= Pseudohelp
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,27 @@
+#!/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    = 'Pseudohelp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/pseudohelp/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
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require_tree .

data/app/assets/javascripts/pseudohelp/pseudohelp.js

@@ -0,0 +1,126 @@
+Pseudohelp = {
+  init: function(){
+    jQuery('.pseudo-container section > div:first').toggleClass('visible');
+
+    var type_links = jQuery('.pseudo-container header a');
+    type_links.click(function(e){
+      e.preventDefault();
+
+      type = jQuery(this).text();
+      jQuery('.pseudo-container section > div').removeClass('visible');
+      jQuery('.pseudo-container div.'+type).addClass('visible');
+    });
+
+    var tables = jQuery('.pseudo-container table');
+    jQuery('.pseudo-help-filter').keyup(function() {
+      jQuery.uiTableFilter( tables, this.value );
+    });
+
+    var links_to_help = jQuery('a[href="#pseudo-help"]')
+    links_to_help.click(function(e){
+      e.preventDefault();
+
+      Pseudohelp.toggle();
+    });
+  },
+
+  toggle: function(){
+    jQuery('html').toggleClass('pseudohelp-visible')
+  }
+}
+
+jQuery(function() {
+  Pseudohelp.init();
+});
+
+/*
+ * Copyright (c) 2008 Greg Weber greg at gregweber.info
+ * Dual licensed under the MIT and GPLv2 licenses just as jQuery is:
+ * http://jquery.org/license
+ *
+ * documentation at http://gregweber.info/projects/uitablefilter
+ *
+ * allows table rows to be filtered (made invisible)
+ * <code>
+ * t = $('table')
+ * $.uiTableFilter( t, phrase )
+ * </code>
+ * arguments:
+ *   jQuery object containing table rows
+ *   phrase to search for
+ *   optional arguments:
+ *     column to limit search too (the column title in the table header)
+ *     ifHidden - callback to execute if one or more elements was hidden
+ */
+(function($) {
+  $.uiTableFilter = function(jq, phrase, column, ifHidden){
+    var new_hidden = false;
+    if( this.last_phrase === phrase ) return false;
+
+    var phrase_length = phrase.length;
+    var words = phrase.toLowerCase().split(" ");
+
+    // these function pointers may change
+    var matches = function(elem) { elem.show() }
+    var noMatch = function(elem) { elem.hide(); new_hidden = true }
+    var getText = function(elem) { return elem.text() }
+
+    if( column ) {
+      var index = null;
+      jq.find("thead > tr:last > th").each( function(i){
+        if( $.trim($(this).text()) == column ){
+          index = i; return false;
+        }
+      });
+      if( index == null ) throw("given column: " + column + " not found")
+
+      getText = function(elem){ return $(elem.find(
+        ("td:eq(" + index + ")")  )).text()
+      }
+    }
+
+    // if added one letter to last time,
+    // just check newest word and only need to hide
+    if( (words.size > 1) && (phrase.substr(0, phrase_length - 1) ===
+          this.last_phrase) ) {
+
+      if( phrase[-1] === " " )
+      { this.last_phrase = phrase; return false; }
+
+      var words = words[-1]; // just search for the newest word
+
+      // only hide visible rows
+      matches = function(elem) {;}
+      var elems = jq.find("tbody:first > tr:visible")
+    }
+    else {
+      new_hidden = true;
+      var elems = jq.find("tbody:first > tr")
+    }
+
+    elems.each(function(){
+      var elem = $(this);
+      $.uiTableFilter.has_words( getText(elem), words, false ) ?
+        matches(elem) : noMatch(elem);
+    });
+
+    last_phrase = phrase;
+    if( ifHidden && new_hidden ) ifHidden();
+    return jq;
+  };
+
+  // caching for speedup
+  $.uiTableFilter.last_phrase = ""
+
+  // not jQuery dependent
+  // "" [""] -> Boolean
+  // "" [""] Boolean -> Boolean
+  $.uiTableFilter.has_words = function( str, words, caseSensitive )
+  {
+    var text = caseSensitive ? str : str.toLowerCase();
+    for (var i=0; i < words.length; i++) {
+      if (text.indexOf(words[i]) === -1) return false;
+    }
+    return true;
+  }
+}) (jQuery);

data/app/assets/stylesheets/pseudohelp/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/app/assets/stylesheets/pseudohelp/markup_languages.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/pseudohelp/application_controller.rb

@@ -0,0 +1,4 @@
+module Pseudohelp
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/pseudohelp/markup_languages_controller.rb

@@ -0,0 +1,6 @@
+require_dependency "pseudohelp/application_controller"
+
+module Pseudohelp
+  class MarkupLanguagesController < ApplicationController
+  end
+end

data/app/helpers/pseudohelp/application_helper.rb

@@ -0,0 +1,4 @@
+module Pseudohelp
+  module ApplicationHelper
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Pseudohelp</title>
+  <%= stylesheet_link_tag    "pseudohelp/application", :media => "all" %>
+  <%= javascript_include_tag "pseudohelp/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/pseudohelp/_help.html.erb

@@ -0,0 +1,51 @@
+<div class="pseudo-backdrop" id="pseudo-backdrop"></div>
+<div class="pseudo-container" id="pseudo-help">
+  <header>
+    <ul>
+      <li class="search">
+        <input class="pseudo-help-filter" value="" placeholder="search" />
+      </li>
+      <% Pseudohelp.configuration.formats.each do |format| %>
+        <li class="<%= format %>">
+          <a href="#<%= format %>"><%= format %></a>
+        </li>
+      <% end %>
+    </ul>
+  </header>
+  <section>
+    <% Pseudohelp.configuration.help.each do |documentation_type, sections| %>
+      <div class="<%= documentation_type %>">
+        <table>
+          <% if sections %>
+            <% sections.each do |section_header, input_output| %>
+              <tr>
+                <th colspan="2"><%= section_header %></th>
+              </tr>
+              <% input_output.each do |description, in_out| %>
+                <tr data-description="<%= description %>">
+                  <td>
+                    <code><%= in_out['input'] %></code>
+                  </td>
+                  <td>
+                    <% if in_out.key? 'output' %>
+                      <%= in_out['output'].html_safe %>
+                    <% else %>
+                      <%= Pseudohelp.compile(documentation_type, in_out['input']) %>
+                    <% end %>
+                  </td>
+                </tr>
+              <% end %>
+            <% end %>
+          <% end %>
+        </table>
+      </div>
+    <% end %>
+  </section>
+  <footer>
+    <p>
+      <a href="https://github.com/jayroh/pseudohelp" target="_blank">pseudohelp</a>
+      is a work in progress. fork and contribute on
+      <a href="https://github.com/jayroh/pseudohelp" target="_blank">github</a>.
+    </p>
+  </footer>
+</div>

data/config/pseudohelp/bbcode.yml

@@ -0,0 +1,49 @@
+Paragraphs:
+  paragraphs:
+    input: |
+      Each line break
+      is replaced with an html break.
+
+      So there aren't real "paragraphs"
+
+Quotes:
+  quote:
+    input: '[quote]Someone said this.[/quote]'
+  quote (named):
+    input: '[quote=John]John said this.[/quote]'
+
+Links:
+  Link:
+    input: 'Link to [url=http://google.com]google[/url]'
+
+Images:
+  Image:
+    input: 'Image [img]/assets/pseudohelp/corgi.jpg[/img]'
+
+Text Formatting:
+  bold:
+    input: '[b]Bold[/b]'
+  italic:
+    input: '[i]Italic[/i]'
+  underline:
+    input: '[u]Underline[/u]'
+  strike-through:
+    input: '[s]strike through[/s]'
+  delete:
+    input: '[del]Delete[/del]'
+  insert:
+    input: '[ins]Insert[/ins]'
+  font size:
+    input: '[size=14]Large![/size]'
+  font color:
+    input: '[color=red]red red red[/color]'
+
+Lists:
+  Unordered List:
+    input: |
+      [list] [*]Item 1 [*]Item 2 [/list]
+
+For More Information:
+  Go To:
+    input: |
+      Further bbcode documentation can be found [url=http://en.wikipedia.org/wiki/BBCode]here[/url]

data/config/pseudohelp/markdown.yml

@@ -0,0 +1,100 @@
+Headers and Paragraphs:
+  h1 h2 h5:
+    input: |
+      # Level 1 Header (H1)
+      ## Level 2 Header (H2)
+      ##### Level 5 Header (H5)
+
+  paragraphs:
+    input: |
+      One or more consecutive lines of text separated by one or more blank lines.
+
+      This is another paragraph.
+
+  line-breaks:
+    input: |
+      To create a line break  
+      end a line in a  
+      paragraph with two  
+      or more spaces.
+
+Lists:
+  unordered lists:
+    input: |
+      * Red
+      * Green
+      * Blue
+  ordered lists:
+    input: |
+      1. Bird
+      2. McHale
+      3. Parish
+  definition lists:
+    input: |
+      Term
+      : Definition
+
+Emphasis:
+  Italics:
+    input: |
+      I am *emphasized*.
+      And _so am I_.
+  Bold:
+    input: |
+      I am **bold**.
+      And __so am I__.
+
+Links:
+  Inline links:
+    input: 'This is [an example](http://example.com/ "Optional Title") link.'
+  Automatic links:
+    input: |
+      <http://example.com/>
+      <address@example.com>
+
+Code:
+  Code block:
+    input: |
+      This is a normal paragraph.
+
+      ```ruby
+      @posts = Post.where(published: true)
+      ```
+  Inline code:
+    input: 'Talking about `@some_inline = "code"` here.'
+
+Tables:
+  Table:
+    input: |
+      | Header 1    | Header 2   |
+      | ----------- | ---------- |
+      | Row1 Cell1  | Row1 Cell2 |
+      | Row2 Cell1  | Row2 Cell2 |
+
+Images:
+  Image:
+    input: |
+      ![A corgi](/assets/pseudohelp/corgi.jpg "Awwwww")
+
+Literal Characters:
+  Escape with a backslash:
+    input: |
+      \\
+      \`
+      \*
+      \_
+      \{\
+      \[\]
+      \(\)
+      \#
+      \+
+      \-
+      \.
+      \!
+      \:
+      \|
+
+For More Information:
+  Go To:
+    input: |
+      Further markdown documentation can be found [here](http://daringfireball.net/projects/markdown/syntax)

data/config/pseudohelp/textile.yml

@@ -0,0 +1,94 @@
+Headers and Paragraphs:
+  h1 h2 h5:
+    input: |
+      h1. Level 1 Header (H1)
+
+      h2. Level 2 Header (H2)
+
+      h5. Level 5 Header (H5)
+
+  paragraphs:
+    input: |
+      One or more consecutive lines of text separated by one or more blank lines.
+
+      This is another paragraph.
+
+  line-breaks:
+    input: |
+      Line breaks are converted
+      to html breaks.
+
+  blockquotes:
+    input: |
+      They said:
+
+      bq. Something profound!
+
+      ... and I was stunned.
+
+  extended quote:
+    input: |
+      bq.. Starting the quote
+
+      continuing the quote
+
+      p. New paragraph
+
+Links:
+  Link:
+    input: |
+      For more "click here":http://textile.thresholdstate.com/
+
+Emphasis:
+  Emphasis:
+    input: |
+      _emphasis_
+  Italics:
+    input: |
+      __italicized__
+  Strong:
+    input: |
+      *strong*
+  Bold:
+    input: |
+      **bold**
+  Citation:
+    input: |
+      ??citation??
+  Deleted Text:
+    input: |
+      -deleted text-
+  Inserted Text:
+    input: |
+      +inserted text+
+  Superscript:
+    input: |
+      Some ^superscript^
+  Subscript:
+    input: |
+      Some ~subscript~
+  Code:
+    input: |
+      Inline code @var goes = 'here';@
+
+Lists:
+  Unordered List:
+    input: |
+      * Item 1
+      * Item 2
+      * Item 3
+  Ordered List:
+    input: |
+      # One
+      # Two
+      # Three
+
+Images:
+  Image:
+    input: |
+      !/assets/pseudohelp/corgi.jpg!
+
+For More Information:
+  Go To:
+    input: |
+      Further textile documentation can be found "here":http://textile.thresholdstate.com/

data/config/routes.rb

@@ -0,0 +1,2 @@
+Pseudohelp::Engine.routes.draw do
+end

data/lib/pseudohelp.rb

@@ -0,0 +1,11 @@
+require 'pseudohelp/engine'
+require 'pseudohelp/configuration'
+require 'pseudohelp/bbcode'
+require 'pseudohelp/markdown'
+require 'pseudohelp/textile'
+
+module Pseudohelp
+  def self.compile(type, input)
+    "Pseudohelp::#{type.to_s.camelize}::Compiler".constantize.call(input)
+  end
+end

data/lib/pseudohelp/bbcode.rb

@@ -0,0 +1,19 @@
+module Pseudohelp
+  class Bbcode
+    class << self
+      def documentation_hash
+        YAML.load_file(File.join(File.dirname(__FILE__),'../../config/pseudohelp/bbcode.yml'))
+      end
+    end
+
+    class Compiler
+      require 'bb-ruby'
+
+      class << self
+        def call(text)
+          BBRuby.to_html(text).html_safe
+        end
+      end
+    end
+  end
+end

data/lib/pseudohelp/configuration.rb

@@ -0,0 +1,59 @@
+module Pseudohelp
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration = Configuration.new
+
+    if block_given?
+      yield configuration
+    end
+
+    self.configuration
+  end
+
+  def self.configuration
+    @configuration || self.configure
+  end
+
+  class Configuration
+    attr_accessor :compilers, :extra_help
+
+    def compilers=(new_compilers)
+      @new_compilers = new_compilers
+    end
+
+    def compilers
+      @compilers ||= default_compilers.merge(@new_compilers)
+    end
+
+    # * * *
+
+    def extra_help
+      @extra_help ||= {}
+    end
+
+    def formats
+      @formats ||= [:bbcode, :markdown, :textile]
+    end
+
+    def help
+      @help ||= {
+        bbcode: Pseudohelp::Bbcode.documentation_hash,
+        markdown: Pseudohelp::Markdown.documentation_hash,
+        textile: Pseudohelp::Textile.documentation_hash
+      }.deep_merge(extra_help) # .sort
+    end
+
+    private
+
+    def default_compilers
+      {
+        bbcode: Pseudohelp::Bbcode::Compiler,
+        markdown: Pseudohelp::Markdown::Compiler,
+        textile: Pseudohelp::Textile::Compiler
+      }
+    end
+  end
+end

data/lib/pseudohelp/engine.rb

@@ -0,0 +1,5 @@
+module Pseudohelp
+  class Engine < ::Rails::Engine
+    isolate_namespace Pseudohelp
+  end
+end

data/lib/pseudohelp/markdown.rb

@@ -0,0 +1,22 @@
+module Pseudohelp
+  class Markdown
+    class << self
+      def documentation_hash
+        YAML.load_file(File.join(File.dirname(__FILE__),'../../config/pseudohelp/markdown.yml'))
+      end
+    end
+
+    class Compiler
+      class << self
+        def call(text)
+          markdown = Redcarpet::Markdown.new(Redcarpet::Render::HTML, {
+            tables: true,
+            fenced_code_blocks: true,
+            strikethrough: true
+          })
+          markdown.render(text).html_safe
+        end
+      end
+    end
+  end
+end

data/lib/pseudohelp/textile.rb

@@ -0,0 +1,17 @@
+module Pseudohelp
+  class Textile
+    class << self
+      def documentation_hash
+        YAML.load_file(File.join(File.dirname(__FILE__),'../../config/pseudohelp/textile.yml'))
+      end
+    end
+
+    class Compiler
+      class << self
+        def call(text)
+          RedCloth.new(text).to_html.html_safe
+        end
+      end
+    end
+  end
+end

data/lib/pseudohelp/version.rb

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

data/lib/tasks/pseudohelp_tasks.rake

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification 
+name: pseudohelp
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joel Oliveira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 3
+        - 2
+        - 0
+        version: 3.2.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bb-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: redcarpet
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Provides a view partial to display documentation on the bbcode, markdown and textile flavors of text markup.
+email: 
+- joel.oliveira@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/controllers/pseudohelp/markup_languages_controller.rb
+- app/controllers/pseudohelp/application_controller.rb
+- app/helpers/pseudohelp/application_helper.rb
+- app/assets/stylesheets/pseudohelp/application.css
+- app/assets/stylesheets/pseudohelp/markup_languages.css
+- app/assets/images/pseudohelp/corgi.jpg
+- app/assets/javascripts/pseudohelp/pseudohelp.js
+- app/assets/javascripts/pseudohelp/application.js
+- app/views/layouts/pseudohelp/application.html.erb
+- app/views/pseudohelp/_help.html.erb
+- config/pseudohelp/markdown.yml
+- config/pseudohelp/textile.yml
+- config/pseudohelp/bbcode.yml
+- config/routes.rb
+- lib/pseudohelp.rb
+- lib/tasks/pseudohelp_tasks.rake
+- lib/pseudohelp/version.rb
+- lib/pseudohelp/markdown.rb
+- lib/pseudohelp/engine.rb
+- lib/pseudohelp/bbcode.rb
+- lib/pseudohelp/configuration.rb
+- lib/pseudohelp/textile.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://joeloliveira.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Quick drop-in pseudo-markup documentation
+test_files: []
+