rack-usermanual 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTU5Mzg1NWM1NzFkMzA5Y2RiMDc2OWNhYjBlMzRjZjNjNmM1YzU0MQ==
+    YmFkZDVmY2I0MWNiNWYwNjEzMGI3NzNkYjFmNDQ0MmMwYmJlMGM4ZA==
   data.tar.gz: !binary |-
-    MDE4NDA4NzI1MTcxNDM1Y2IxMTc0NmM2NTYwYjNkZjdkOTgyMTZhZA==
+    MGIyY2E5ODMyYzczNTQ4ZjAxNDZlOTJmMzkyNTI2NDAwYTUxNDNhNA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjVmNDQ2ZmJmNDFlMGQ4NmVlYmRiZWUwYWY5MzA0N2IyNzhkYmYwNzU2OGU4
-    MTRhYzBlZDVlYTMwODIwMWUyYzVjYTBlMTBiNjBiYTY2YjYzMWJjOTQ1OWM0
-    YTI3MDA3ZTc3MjAxYmU2OTkyY2VlYjZlM2ZiY2ZmMDRhYTExM2I=
+    MDZlZGJiNzAzMDc2NDk1YjlhM2Q0MTdmNDY0MGU4YWVhN2FhODc5ZWFkMTRh
+    ODE3NzY0YTkwOTdjM2ViZTZhMWQyMTMyZWY5ZmEzNTRiZmU5YzcxOTc2MzU4
+    ZDgwNTg4MjFjNDM4MjBiNDk5YTdjYTFhYTlhZjgyNDMyZWQyYzI=
   data.tar.gz: !binary |-
-    ZWI2MTI3NDBhODVkM2FiY2E0YjAwMDBjYTU3MDJiYmYzZTU3MzA0OThlN2Iz
-    Y2YyOTQ4ZWMxN2I5ZjliNDlkMzBhNmI0MDQ1YzlkYWE5YmNiNzkxYWNkNmEy
-    OGYwZmFjZjdlOTc3MjBjNWRjYmViMzg5N2IxMWNhYTBhZmFkYWY=
+    ZmExMjNiZjFlNGY2MTcxNWVkZDk2OTZjZmNhNjQ0M2VmYzU5MTVmZjcwYTg4
+    N2FlYTA0NDA1ODQ2OWM4MDk0YmU1NzBiYzM4ZmJmMWZmNTEzZmNkMTA4OWZl
+    MzNlNzM2YmFjZTVhMWJhZmIxMTk0MGM4NWM4Y2RhNmZmMTAzMmQ=

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec

data/README.md

@@ -1,7 +1,23 @@
-Rack::Usermanual
+Rack Usermanual
 ================
 
-This little piece of middleware helps you expose your cucumber features in a readable 'manual-like' style for your users to consume.
+![Build status](https://travis-ci.org/chrismdp/rack-usermanual.png)   ![Code climate](https://codeclimate.com/github/chrismdp/rack-usermanual.png)
+
+Want to embed your cucumber features directly into your project as a User manual? Here's a gem to do it.
+
+See an example here: [http://online.soltrader.net/help/game-manual/combat](http://online.soltrader.net/help/game-manual/combat)
+
+Installation
+------------
+
+```
+gem install rack-usermanual
+```
+
+(or add it to your bundle.)
+
+Usage
+-----
 
 To use, add the following to your Rack app:
 
@@ -22,11 +38,23 @@ map "/help" do
 end
 ```
 
-Then start your app and point your browser to `/help` and your features should be displayed for you!
+Or with Rails, you can do something like this in `config/routes.rb`:
+
+```
+match "/help" => Rack::Usermanual.new(self, :sections => ... }
+```
+
+(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
+-------
 
 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.
 
-## 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

@@ -29,6 +29,10 @@ module Rack
         Rack::Utils.escape_html(text)
       end
 
+      def humanize(word)
+        word.capitalize.gsub(/[-_]/, ' ')
+      end
+
       def replace_start(sentence)
         {
           /^given / => 'Assume ',
@@ -49,7 +53,9 @@ module Rack
       sio = StringIO.new
       json_formatter = Gherkin::Formatter::JSONFormatter.new(sio)
       parser = Gherkin::Parser::Parser.new(json_formatter)
-      raw = ::File.read("#{path}/#{page}.feature")
+      filepath = "#{path}/#{page}.feature"
+      halt 404 unless ::File.exist?(filepath)
+      raw = ::File.read(filepath)
       parser.parse(raw, uri, 0)
       json_formatter.done
       [raw, JSON.parse(sio.string)]

data/rack-usermanual.gemspec

@@ -1,10 +1,9 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
-require "rack/usermanual"
 
 Gem::Specification.new do |s|
   s.name        = "rack-usermanual"
-  s.version     = Rack::Usermanual::VERSION
+  s.version     = "0.1.1"
   s.authors     = ["Chris Parsons"]
   s.email       = ["chris.p@rsons.org"]
   s.homepage    = "http://github.com/chrismdp/rack-usermanual"

data/views/_menu.haml

@@ -7,4 +7,4 @@
       - features.each do |fn|
         - name = ::File.basename(fn, '.feature')
         %li
-          %a{:href => "/help/#{::File.basename(path)}/#{name}"}= name.capitalize.gsub(/[-_]/, ' ')
+          %a{:href => "/help/#{::File.basename(path)}/#{name}"}= humanize(name)

data/views/page.haml

@@ -1,6 +1,6 @@
 %h4.page-header
   %a{:href => '/help'} Help & support
-  == » #{@human_name} » #{@page.capitalize}
+  == » #{@human_name} » #{humanize(@page)}
 
 .container
   .row

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-usermanual
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Chris Parsons
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md