radiant-help-extension 1.1.0

data/radiant-help-extension.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "radiant-help-extension"
+
+Gem::Specification.new do |s|
+  s.name        = "radiant-help-extension"
+  s.version     = RadiantHelpExtension::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = RadiantHelpExtension::AUTHORS
+  s.email       = RadiantHelpExtension::EMAIL
+  s.homepage    = RadiantHelpExtension::URL
+  s.summary     = RadiantHelpExtension::SUMMARY
+  s.description = RadiantHelpExtension::DESCRIPTION
+
+  # Define gem dependencies here.
+  # Don't include a dependency on radiant itself: it causes problems when radiant is in vendor/radiant.
+  # s.add_dependency "something", "~> 1.0.0"
+  # s.add_dependency "radiant-some-extension", "~> 1.0.0"
+
+  ignores = if File.exist?('.gitignore')
+    File.read('.gitignore').split("\n").inject([]) {|a,p| a + Dir[p] }
+  else
+    []
+  end
+  s.files         = Dir['**/*'] - ignores
+  s.test_files    = Dir['test/**/*','spec/**/*','features/**/*'] - ignores
+  # s.executables   = Dir['bin/*'] - ignores
+  s.require_paths = ["lib"]
+end

data/spec/controllers/admin/help_controller_spec.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Admin::HelpController do
+  # use Radiant datasets
+  dataset :users
+  
+  before(:each) do
+    login_as :existing
+  end
+  
+  describe "calling index with GET" do
+    it "should render the index template" do
+      get :index
+      response.should render_template('admin/help/index')
+    end
+    
+    it "should assign HelpDocs for all users" do
+      @doc = "/path/to/doc/HELP.rdoc"
+      HelpDoc.stub!(:find_for).with(:all).and_return([@doc])
+      get :index
+      assigns[:docs].should == [@doc]
+    end
+    
+    it "should set the role to 'all' and assign it to the view" do
+      get :index
+      assigns[:role].should == 'all'
+    end
+    
+    it "should get the cms_name from Radiant::Config and assign it to the view" do
+      Radiant::Config.stub!(:[],'admin.title').and_return('Test CMS')
+      get :index
+      assigns[:cms_name].should == 'Test CMS'
+    end
+    
+    it "should find all TextFilters and assign them to the view" do
+      TextFilter.stub!(:descendants).and_return([MarkdownFilter, TextileFilter])
+      get :index
+      assigns[:filters].should == [MarkdownFilter, TextileFilter]
+    end
+    
+    it "should find all Layouts and assign them to the view" do
+      @layout1 = mock_model(Layout)
+      Layout.stub!(:find).with(:all).and_return([@layout1])
+      get :index
+      assigns[:layouts].should == [@layout1]
+    end
+    
+    it "should find the first FileNotFoundPage and assign it to the view" do
+      @page404 = mock_model(Page, :class_name => 'FileNotFoundPage')
+      Page.should_receive(:find).with(:first,{:conditions => {:class_name => 'FileNotFoundPage'}}).and_return(@page404)
+      get :index
+      assigns[:file_not_found_page].should == @page404
+    end
+  end
+  
+  describe "calling extension_doc with GET" do
+    it "should load the role from the params and assign it to the view" do
+      get :extension_doc, :extension_name => 'help', :role => 'developer'
+      assigns[:role].should == 'developer'
+    end
+    
+    it "should set the role to 'all' if none is present in the params and assign it to the view" do
+      @test_path = '/path'
+      HelpDoc.stub!(:find_for).and_return([@test_path])
+      File.stub!(:read).and_return('') # can't read a non-existant path
+      get :extension_doc, :extension_name => 'help'
+      assigns[:role].should == 'all'
+    end
+    
+    it "should find all HelpDocs for the given role and assign them to the view" do
+      @doc1 = "/path/to/test1/HELP_admin.rdoc"
+      @doc2 = "/path/to/test2/HELP_admin.rdoc"
+      File.stub!(:read).and_return('') # can't read a non-existant path
+      HelpDoc.should_receive(:find_for).with("admin").and_return([@doc1,@doc2])
+      HelpDoc.stub!(:find_for).with("admin","test1").and_return([@doc1])
+      get :extension_doc, :extension_name => 'test1', :role => 'admin'
+      assigns[:docs].should == [@doc1,@doc2]
+    end
+    
+    it "should get the doc_name from the URL extension_name and assign it to the view" do
+      get :extension_doc, :extension_name => 'help', :role => 'developer'
+      assigns[:doc_name].should == 'Help'
+    end
+    
+    it "should find the HelpDoc for the given role and extension_name" do
+      @doc1 = "/path/to/test1/HELP_developer.rdoc"
+      @doc2 = "/path/to/test2/HELP_developer.rdoc"
+      File.stub!(:read).and_return('') # can't read a non-existant path
+      HelpDoc.stub!(:find_for).with("developer").and_return([@doc1,@doc2])
+      HelpDoc.should_receive(:find_for).with("developer","test1").and_return([@doc1])
+      get :extension_doc, :extension_name => 'test1', :role => 'developer'
+      assigns[:doc_path].should == @doc1
+    end
+  end
+  
+  describe "calling role with GET" do
+    it "should find the HelpDocs for the given role and assign them to the view" do
+      @doc1 = "/path/to/test1/HELP_admin.rdoc"
+      @doc2 = "/path/to/test2/HELP_admin.rdoc"
+      HelpDoc.should_receive(:find_for).with("admin").and_return([@doc1,@doc2])
+      get :role, :role => 'admin'
+      assigns[:docs].should == [@doc1,@doc2]
+    end
+    
+    it "should redirect to the help index if given no role" do
+      get :role
+      response.should redirect_to(:action => 'index')
+    end
+  end
+end

data/spec/models/help_doc_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe HelpDoc, "given existing extension docs" do
+    
+  before(:all) do
+    @test_ext_name = "help_rspec_test#{rand(1000)}"
+    @test_dir = "#{RAILS_ROOT}/vendor/extensions/#{@test_ext_name}"
+    FileUtils.mkdir(@test_dir)
+    File.open("#{@test_dir}/HELP", 'wb') {|f| f.write('help for all') }
+    File.open("#{@test_dir}/HELP_developer.rdoc", 'wb') {|f| f.write('== Testing
+help for developers in rdoc
+') }
+    File.open("#{@test_dir}/HELP_admin.markdown", 'wb') {|f| f.write('Test
+----
+help for admins in **markdown**
+') }
+    File.open("#{@test_dir}/HELP_imaginary.md", 'wb') {|f| f.write('## Test
+help for non-existent role in **markdown**
+') }
+    File.open("#{@test_dir}/HELP_other.textile", 'wb') {|f| f.write('help for _another_ non-existent role in *textile*
+      ') }
+  end
+  
+  after(:all) do
+    FileUtils.remove_dir(@test_dir)
+  end
+  
+  describe "calling find_for" do
+    
+    it "should fail to find extension docs with no given role type" do
+      lambda { HelpDoc.find_for() }.should raise_error(ArgumentError)
+    end
+    
+    it "should find for all users extension docs named 'HELP' with an optional file extension" do 
+      lambda do 
+        HelpDoc.find_for(:all).each do |doc|
+          raise Exception unless /HELP(\.[\w]+)?$/.match(doc)
+        end
+      end.should_not raise_error(Exception)
+      HelpDoc.find_for(:all).size.should > 0
+    end
+    
+    it "should find extension docs for developers named 'HELP_developer' and end with an optional file extension" do
+      lambda do
+        HelpDoc.find_for(:developer).each do |doc|
+          raise Exception unless /HELP_developer/.match(doc)
+        end
+      end.should_not raise_error(Exception)
+      HelpDoc.find_for(:developer).size.should > 0
+    end
+    
+    it "should find extension docs for admins named 'HELP_admin' and end with an optional file extension" do
+      lambda do
+        HelpDoc.find_for(:admin).each do |doc|
+          raise Exception unless /HELP_admin(\.[\w]+)?$/.match(doc)
+        end
+      end.should_not raise_error(Exception)
+      HelpDoc.find_for(:admin).size.should > 0
+    end
+    
+    it "should find only the given extension's docs when given an extension name" do
+      HelpDoc.find_for(:all, @test_ext_name).size.should == 1
+    end
+    
+  end
+  
+  describe "calling formatted_contents_from" do
+  
+    it "should return formatted contents of a given extension doc in RDoc formatting by default" do
+      test_doc = HelpDoc.find_for(:all, @test_ext_name).first
+      HelpDoc.formatted_contents_from(test_doc).should == "<p>\nhelp for all\n</p>\n"
+    end
+
+    it "should return RDoc formatted contents of a given extension doc ending in '.rdoc'" do
+      test_doc = HelpDoc.find_for(:developer, @test_ext_name).first
+      HelpDoc.formatted_contents_from(test_doc).should == "<h2>Testing</h2>\n<p>\nhelp for developers in rdoc\n</p>\n"
+    end
+
+    it "should return Markdown formatted contents of a given extension doc ending in '.markdown'" do
+      test_doc = HelpDoc.find_for(:admin, @test_ext_name).first
+      HelpDoc.formatted_contents_from(test_doc).should == "<h2>Test</h2>\n<p>help for admins in <strong>markdown</strong></p>\n"
+    end
+
+    it "should return Markdown formatted contents of a given extension doc ending in '.md'" do
+      test_doc = HelpDoc.find_for(:imaginary, @test_ext_name).first
+      HelpDoc.formatted_contents_from(test_doc).should == "<h2>Test</h2>\n<p>help for non-existent role in <strong>markdown</strong></p>\n"
+    end
+
+    it "should return Textile formatted contents of a given extension doc ending in '.textile'" do
+      test_doc = HelpDoc.find_for(:other, @test_ext_name).first
+      HelpDoc.formatted_contents_from(test_doc).should == "<p>help for <em>another</em> non-existent role in <strong>textile</strong></p>"
+    end
+  
+  end
+  
+  it "should call parsed_rdoc and return HTML from RDoc formatted text" do
+    test_doc = HelpDoc.find_for(:developer, @test_ext_name).first
+    HelpDoc.parsed_rdoc(test_doc).should == "<h2>Testing</h2>\n<p>\nhelp for developers in rdoc\n</p>\n"
+  end
+  
+  it "should call parsed_markdown and return HTML from Markdown formatted text" do
+    test_doc = HelpDoc.find_for(:admin, @test_ext_name).first
+    HelpDoc.parsed_markdown(test_doc).should == "<h2>Test</h2>\n<p>help for admins in <strong>markdown</strong></p>\n"
+  end
+  
+  it "should call parsed_textile and return HTML from Textile formatted text" do
+    test_doc = HelpDoc.find_for(:other, @test_ext_name).first
+    HelpDoc.parsed_textile(test_doc).should == "<p>help for <em>another</em> non-existent role in <strong>textile</strong></p>"
+  end
+    
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: radiant-help-extension
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jim Gay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000 Z
+dependencies: []
+description: Help Documentation for Radiant CMS!
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/controllers/admin/help_controller.rb
+- app/helpers/admin/help_helper.rb
+- app/models/help_doc.rb
+- app/views/admin/help/_admin_index.html.haml
+- app/views/admin/help/_designer_index.html.haml
+- app/views/admin/help/_docs_introduction.html.haml
+- app/views/admin/help/_editing.html.haml
+- app/views/admin/help/_extension_docs_list.html.haml
+- app/views/admin/help/_organizing.html.haml
+- app/views/admin/help/_other_index.html.haml
+- app/views/admin/help/_regions.html.haml
+- app/views/admin/help/_scripts.js.erb
+- app/views/admin/help/_styles.html.haml
+- app/views/admin/help/_tag_reference.html.haml
+- app/views/admin/help/developing.html.haml
+- app/views/admin/help/extension_doc.html.haml
+- app/views/admin/help/index.html.haml
+- app/views/admin/help/role.html.haml
+- config/initializers/radiant_config.rb
+- config/locales/en.yml
+- config/routes.rb
+- cucumber.yml
+- features/support/env.rb
+- features/support/paths.rb
+- HELP_developer.rdoc
+- help_extension.rb
+- lib/radiant-help-extension.rb
+- lib/tasks/help_extension_tasks.rake
+- radiant-help-extension.gemspec
+- Rakefile
+- README.md
+- spec/controllers/admin/help_controller_spec.rb
+- spec/models/help_doc_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- TODO
+homepage: https://github.com/saturnflyer/radiant-help-extension
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Help for Radiant CMS
+test_files:
+- spec/controllers/admin/help_controller_spec.rb
+- spec/models/help_doc_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- features/support/env.rb
+- features/support/paths.rb