joofaq 0.0.3 → 0.1.1

data/README.md

@@ -1,6 +1,6 @@
 # Joofaq
 
-TODO: Write a gem description
+Joofaq is a FAQ page template building gem.  In two easy steps you can have a FAQ page up and running on your rails app with questions and sections easily customizable from a yaml file.
 
 ## Installation
 
@@ -8,17 +8,25 @@ Add this line to your application's Gemfile:
 
     gem 'joofaq'
 
-And then execute:
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+After adding joofaq to your Gemfile, run the joofaq gem generator command:
 
-    $ gem install joofaq
+    rails generate joofaq
 
-## Usage
+This will create a faq.yml file in your db/ directory. To add new sections and questions, follow the format shown in the faq.yml:
+
+    First_category_name_here:
+    - subtitle: first_category_subtitle_here
+    - q: question_1_text_here
+      a: answer_1_text_here
+
+Subtitles are optional and you can add as many questions as you need. Remember, this is a yaml file so format (especially indentation) is important for it to work properly.
+
+The generator also created several view files in a new app/views/faq/ directory.  This gives you access to the views so that you can change the styling as you please.
 
-TODO: Write usage instructions here
+You can now view your app's faq at '/faq' (localhost:3000/faq). Can you change this routing in your config/routes.rb file.
 
 ## Contributing
 

data/lib/generators/joofaq/joofaq_generator.rb

@@ -1,23 +1,14 @@
 class JoofaqGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 
-
-  def generate_faq
+  def copy_faq_templates
     copy_file "joofaq.yml", "db/faq.yml"
     copy_file "joofaq/index.html.erb", "app/views/faq/index.html.erb"
     copy_file "joofaq/_qapair.html.erb", "app/views/faq/_qapair.html.erb"
     copy_file "joofaq/_subtitle.html.erb", "app/views/faq/_subtitle.html.erb"
-    create_route
-    add_gem_dependencies
   end
 
-private
-
   def create_route
     route "match '/faq' => 'Faq#index'"
   end
-
-  def add_gem_dependencies
-    gem 'rdiscount', version: '1.6.8'
-  end
 end

data/lib/generators/joofaq/templates/joofaq.yml

@@ -1,11 +1,11 @@
-First Category:
+First_category_name_here:
 - subtitle: first_category_subtitle_here
 - q: question_1_text_here
   a: answer_1_text_here
 - q: question_2_text_here
   a: answer_2_text_here
-Second Category:
+Second_category_name_here:
 - q: question_1_text_here
   a: answer_1_text_here
 - q: question_2_text_here
-  a: Add more using the same format. Subtitle is completely optional
+  a: Add more using the same format. Subtitle is completely optional (delete the line if you are not using one)

data/lib/joofaq.rb

@@ -1,4 +1,5 @@
 require "joofaq/version"
+require 'rdiscount'
 
 module Joofaq
   module Rails

data/lib/joofaq/version.rb

@@ -1,3 +1,3 @@
 module Joofaq
-  VERSION = "0.0.3"
+  VERSION = "0.1.1"
 end

data/testapp/Gemfile

@@ -6,7 +6,7 @@ gem 'rails', '3.2.8'
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
 
 gem 'sqlite3'
-gem 'joofaq'
+gem 'joofaq', path: '../'
 
 # Gems used only for assets and not required
 # in production environments by default.

data/testapp/config/initializers/secret_token.rb

@@ -4,4 +4,4 @@
 # If you change this key, all old signed cookies will become invalid!
 # Make sure the secret is at least 30 characters and all random,
 # no regular words or you'll be exposed to dictionary attacks.
-Testapp::Application.config.secret_token = '56c6e8803a79ac35475f6c4532374861a7825903cb146898692203b2d6f481582fce0f555abb4a65b6f5b0e268e3c549e3c941471b999481e9a466818ab6afd2'
+Testapp::Application.config.secret_token = '982261504353ada7e497c5bafc64dd55eb7c1ad5728aa5a3f8beed18e86792b6600953f383c87eb6b2f27cd119489bb40986cdad92da68eaca7d13c4462f30d6'

data/testapp/config/routes.rb

@@ -1,5 +1,4 @@
 Testapp::Application.routes.draw do
-
   match '/faq' => 'Faq#index'
 
   # The priority is based upon order of creation:

data/testapp/db/faq.yml

@@ -1,11 +1,11 @@
-First Category:
+First_category_name_here:
 - subtitle: first_category_subtitle_here
 - q: question_1_text_here
   a: answer_1_text_here
 - q: question_2_text_here
   a: answer_2_text_here
-Second Category:
+Second_category_name_here:
 - q: question_1_text_here
   a: answer_1_text_here
 - q: question_2_text_here
-  a: Add more using the same format. Subtitle is completely optional
+  a: Add more using the same format. Subtitle is completely optional (delete the line if you are not using one)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: joofaq
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -64,8 +64,6 @@ files:
 - lib/generators/joofaq/templates/joofaq/_qapair.html.erb
 - lib/generators/joofaq/templates/joofaq/_subtitle.html.erb
 - lib/generators/joofaq/templates/joofaq/index.html.erb
-- lib/generators/joofaq/templates/joofaq_controller.rb
-- lib/generators/joofaq/templates/joofaq_model.rb
 - lib/joofaq.rb
 - lib/joofaq/version.rb
 - testapp/.gitignore

data/lib/generators/joofaq/templates/joofaq_controller.rb

@@ -1,4 +0,0 @@
-class JoofaqController < ApplicationController
-  def index
-  end
-end

data/lib/generators/joofaq/templates/joofaq_model.rb

@@ -1,57 +0,0 @@
-class Joofaq
-
-  class Section
-    @attr_list = [:name, :pairs, :items]
-    attr_accessor *@attr_list
-
-    def initialize args
-      @name = args[:name]
-      @items = args[:item].map do |v|
-        if ['subtitle'] == v.keys
-          Subtitle.new v['subtitle']
-        elsif ['q', 'a'] == v.keys
-          QAPair.new q: v['q'], a: v['a']
-        else
-          raise "Item #{v} did not match subtitle or QApair format"
-        end
-      end
-    end
-
-    def name_html; Faq.markdown @name end
-  end
-
-  class Subtitle
-    attr_accessor :str
-
-    def initialize str
-      @str = str
-    end
-
-    def template; 'joofaq/subtitle' end
-    def to_html; Faq.markdown @str end
-  end
-
-  class QAPair
-    @attr_list = [:q, :a]
-    attr_accessor *@attr_list
-
-    def initialize args
-      @q = args[:q]
-      @a = args[:a]
-    end
-
-    def template; 'joofaq/qapair' end
-    def q_html; Faq.markdown @q end
-    def a_html; Faq.markdown @a end
-  end
-
-  class << self
-    def data; data = YAML.load_file 'db/joofaq.yml' end
-    def markdown str
-      RDiscount.new(str).to_html.html_safe
-    end
-    def sections
-      data.map {|k,v| Faq::Section.new name: k, item: v }
-    end
-  end
-end