rack-usermanual 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmFkZDVmY2I0MWNiNWYwNjEzMGI3NzNkYjFmNDQ0MmMwYmJlMGM4ZA==
+    NmJlOWMwYzg4YzkwZjU2MmQwM2JjMTg1OGU1OTdmYjQyNGMyY2RiZg==
   data.tar.gz: !binary |-
-    MGIyY2E5ODMyYzczNTQ4ZjAxNDZlOTJmMzkyNTI2NDAwYTUxNDNhNA==
+    Y2JjYWFjNzhmOGI2NjVhNmU4Mjg1N2Y0MTEwZDU5OTA5ODAwY2IyZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDZlZGJiNzAzMDc2NDk1YjlhM2Q0MTdmNDY0MGU4YWVhN2FhODc5ZWFkMTRh
-    ODE3NzY0YTkwOTdjM2ViZTZhMWQyMTMyZWY5ZmEzNTRiZmU5YzcxOTc2MzU4
-    ZDgwNTg4MjFjNDM4MjBiNDk5YTdjYTFhYTlhZjgyNDMyZWQyYzI=
+    ODQ5OWU2ZDEyZDI1YTcyYjhlZWYzZWVlYzM2NmJkZDYzY2Q2NTg2Zjk4MTM2
+    MDJhZGY4MmQ3ODY0YjJlZGNlY2M3YWMyNTE4ODI4YTEwYjRhMTJlZDRhMDBi
+    NWEyNzc5YTBiNGI2NDEyMDM4ZWVlNTQzNTg0YjYxMzVlOTE5NTc=
   data.tar.gz: !binary |-
-    ZmExMjNiZjFlNGY2MTcxNWVkZDk2OTZjZmNhNjQ0M2VmYzU5MTVmZjcwYTg4
-    N2FlYTA0NDA1ODQ2OWM4MDk0YmU1NzBiYzM4ZmJmMWZmNTEzZmNkMTA4OWZl
-    MzNlNzM2YmFjZTVhMWJhZmIxMTk0MGM4NWM4Y2RhNmZmMTAzMmQ=
+    NTljMDRmM2U5MTI0MzA3ZmUwMDY1NmJlNzU1MGQxZjFiNTIxOGY4MGFjOTlm
+    MDIwYTFiZjI0YzE0MmI0ZmNkNTI0N2QyNTcwNjdmZWY2M2NkZWYxYzE2YmMz
+    NzY1OTgxYzI2OWQxZWM4MWU3ZWI4NTE1Y2QwOWQyODRkMGNlOTA=

data/README.md

@@ -1,5 +1,4 @@
-Rack Usermanual
-================
+# Rack Usermanual
 
 ![Build status](https://travis-ci.org/chrismdp/rack-usermanual.png)   ![Code climate](https://codeclimate.com/github/chrismdp/rack-usermanual.png)
 
@@ -7,8 +6,7 @@ Want to embed your cucumber features directly into your project as a User manual
 
 See an example here: [http://online.soltrader.net/help/game-manual/combat](http://online.soltrader.net/help/game-manual/combat)
 
-Installation
-------------
+## Installation
 
 ```
 gem install rack-usermanual
@@ -16,45 +14,52 @@ gem install rack-usermanual
 
 (or add it to your bundle.)
 
-Usage
------
+## Usage
 
-To use, add the following to your Rack app:
+
+### Rack
+
+To use, add the following to your Rack::Builder instance:
 
 ```
 # Choose whatever url endpoint you like.
 map "/help" do
   use Rack::Usermanual,
-    # `sections`: Sections of the manual: human readable name together
-    # with a path to a folder containing the features.
     :sections => {
       "Game manual" => 'features/docs/game-manual',
       "API documentation" => 'features/docs/api-documentation'
     },
-    # `index`: Markdown to display on the index page of the help.
-    :index => 'features/docs/README.md',
-    # `views`: Look in here for the layout: layout.erb, layout.haml etc.
-    :views => File.join(Dir.pwd, 'views')
+    :index => 'features/docs/README.md'
 end
 ```
 
-Or with Rails, you can do something like this in `config/routes.rb`:
+### Rails
+
+Inside your `config/routes.rb`:
 
 ```
-match "/help" => Rack::Usermanual.new(self, :sections => ... }
+  mount Rack::Usermanual.new(nil, :index => 'README.rdoc', :sections => ...), :at => '/help'
 ```
 
 (I'm not quite sure about the best way to pass options with rails - clarifications welcome!)
 
 Then start your app and point your browser to `/help` and your features should be displayed for you.
 
-Caveats
--------
+### Options
+
+These are the options you can pass to the app:
+
+  * `sections`: Sections of the manual: human readable name together with a path to a folder containing the features.
+  * `index`: Markdown file to display on the index page of the help. Required.
+  * `layout`: the path from the root of your app to the layout you want to use. Uses `views/layout.haml` as the default.
+
+## Caveats
+
+The app will use the layout that you have given, but for Rails you might need to provide a custom layout as rails helpers such as `stylesheet_link_tag` currently don't work (Pull requests welcome!)
 
-The app will use the layout that you have in layout.{erb,haml} in whichever folder you specify. The CSS in the views is based on bootstrap: you might need to style your features slightly differently to get them to work in the way that you want. In the future it may be possible to completely override the views with your own.
+The CSS in the views is based on bootstrap: you might need to provide style your features slightly differently to get them to work in the way that you want. If you need more CSS classes, do submit pull requests to get them.
 
-Contributing
-------------
+## Contributing
 
 We work on pull requests. If you have an idea for something you'd like to contribute, here's how to do it:
 

data/lib/rack/usermanual/app.rb

@@ -4,27 +4,33 @@ require 'stringio'
 require 'json'
 require 'sinatra'
 require 'kramdown'
+require 'haml'
 
 module Rack
   class Usermanual < Sinatra::Base
     VERSION = "0.1.0"
 
+    set :views, ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'views'))
+
     def initialize(app, options)
       super(app)
       @sections = options[:sections]
       @index = options[:index]
-      @main_views = options[:views]
+
+      layout = options[:layout] || 'views/layout.haml'
+
+      path = ::File.dirname(layout)
+      extension = ::File.extname(layout)
+      file = ::File.basename(layout, extension)
+
+      @render_options = {
+        :layout => file.to_sym,
+        :layout_options => { :views => path },
+        :layout_engine => extension[1..-1].to_sym
+      }
     end
 
     helpers do
-      def find_template(views, name, engine, &block)
-        new_views = [
-          ::File.expand_path(::File.join(::File.dirname(__FILE__), '..', '..', '..', 'views')),
-          @main_views
-        ].flatten.compact
-        Array(new_views).each { |v| super(v, name, engine, &block) }
-      end
-
       def h(text)
         Rack::Utils.escape_html(text)
       end
@@ -46,7 +52,7 @@ module Rack
     end
 
     get '/?' do
-      haml :index
+      haml :index, @render_options
     end
 
     def get_feature(path, page)
@@ -73,7 +79,7 @@ module Rack
 
       @raw, @json = get_feature(path, @page)
 
-      haml :page
+      haml :page, @render_options
     end
   end
 end

data/rack-usermanual.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "rack-usermanual"
-  s.version     = "0.1.1"
+  s.version     = "0.2.0"
   s.authors     = ["Chris Parsons"]
   s.email       = ["chris.p@rsons.org"]
   s.homepage    = "http://github.com/chrismdp/rack-usermanual"

data/spec/fixtures/layout.haml

@@ -0,0 +1,2 @@
+Just for testing
+= yield

data/spec/usermanual_spec.rb

@@ -5,7 +5,7 @@ describe Rack::Usermanual do
   include Rack::Test::Methods
 
   def app
-    Rack::Usermanual.new(nil, :sections => {'My section' => 'spec/fixtures/features/my-section'})
+    Rack::Usermanual.new(nil, :layout => 'spec/fixtures/layout.haml', :sections => {'My section' => 'spec/fixtures/features/my-section'})
   end
 
   it "grabs a file from the features folder" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-usermanual
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Parsons
@@ -126,6 +126,7 @@ files:
 - lib/rack/usermanual/app.rb
 - rack-usermanual.gemspec
 - spec/fixtures/features/my-section/test.feature
+- spec/fixtures/layout.haml
 - spec/spec_helper.rb
 - spec/usermanual_spec.rb
 - views/_menu.haml
@@ -157,6 +158,7 @@ specification_version: 4
 summary: Rack endpoint to serve your cucumber features as a user manual
 test_files:
 - spec/fixtures/features/my-section/test.feature
+- spec/fixtures/layout.haml
 - spec/spec_helper.rb
 - spec/usermanual_spec.rb
 has_rdoc: