angband 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9980627b5ac321dc430b1135d6c367aee06a1ddd
+  data.tar.gz: 64b4c433d8d51b9b3e9a9f965af77d1d582f435c
+SHA512:
+  metadata.gz: 1d1ba056d9ba233fef4e04c9380ff668ecd623f92f5d1a63d4226b76e861b9780f0e5db33a288fa9e453c29086a9a93383229e9d3aedb29d74ef2d43967ac5e0
+  data.tar.gz: 398d072a4f0fb5a686e077bb2489b5190cff018384d8d247f62eef1cac7dd6dd7d87fd266bb2c5fddb26df6ff6fa24065e5e3759445e43815620189a7dbcc42e

data/lib/angband/documentation.rb

@@ -0,0 +1,45 @@
+require 'angband/formatter'
+require 'angband/gherkin_finder'
+require 'rack/accept_headers'
+
+module Angband
+  class Documentation
+    def initialize(app)
+      @app = app
+      yield self if block_given?
+    end
+
+    def call(env)
+      response = Rack::AcceptHeaders.new(@app).call(env)
+
+      if options_request?(env) && successful?(response) && !cross_origin_request?(env)
+        features  = Angband::GherkinFinder.new(@files).call(env['PATH_INFO'])
+        formatter = Angband::Formatter.new(env['rack-accept_headers.request'])
+
+        headers, content = formatter.call(features)
+        response[1].merge!(headers)
+        response[2] = [content]
+      end
+
+      response
+    end
+
+    def configure(files)
+      @files = files
+    end
+
+    private
+
+    def cross_origin_request?(env)
+      env['HTTP_ACCESS_CONTROL_REQUEST_METHOD'] || env['HTTP_ACCESS_CONTROL_REQUEST_HEADERS']
+    end
+
+    def options_request?(env)
+      'OPTIONS' == env['REQUEST_METHOD']
+    end
+
+    def successful?(response)
+      200 == response[0].to_i
+    end
+  end
+end

data/lib/angband/formatter.rb

@@ -0,0 +1,33 @@
+require 'mustache'
+
+module Angband
+  class Formatter
+    def initialize(accept_headers)
+      @accept_headers = accept_headers
+    end
+
+    def call(features)
+      case @accept_headers.media_type.best_of(['application/vnd.gherkin', 'text/html'])
+      when 'text/html'
+        [
+          {'Content-Type' => 'text/html'},
+          render('templates/html.mustache', features)
+        ]
+      else
+        [
+          {'Content-Type' => 'application/vnd.gherkin'},
+          render('templates/plain.mustache', features)
+        ]
+      end
+    end
+
+    private
+
+    def render(file, features)
+      Mustache.render(
+        File.read(File.expand_path("../../#{file}", __FILE__)),
+        :features => features
+      ).strip
+    end
+  end
+end

data/lib/angband/gherkin_finder.rb

@@ -0,0 +1,29 @@
+require 'angband/gherkin_listener'
+require 'gherkin/lexer/i18n_lexer'
+
+module Angband
+  class GherkinFinder
+    def initialize(gherkin_files)
+      @gherkin_files = gherkin_files
+    end
+
+    def call(path_info)
+      listener = Angband::GherkinListener.new
+      lexer = Gherkin::Lexer::I18nLexer.new(listener)
+
+      listener.on(:tag) do |tag|
+        @path_matched = true if %r{^#{tag}$} === "@#{path_info}"
+      end
+
+      result = @gherkin_files.map do |file|
+        @path_matched = false
+        gherkin = File.read(file)
+        lexer.scan(gherkin)
+        gherkin if @path_matched
+      end
+
+      result.compact
+    end
+
+  end
+end

data/lib/angband/gherkin_listener.rb

@@ -0,0 +1,18 @@
+module Angband
+  class GherkinListener
+    def initialize
+      @callbacks = {}
+    end
+
+    def on(event, &block)
+      @callbacks[event] = block
+    end
+
+    [:comment, :tag, :feature, :background, :scenario, :scenario_outline, :examples, :step, :doc_string, :row, :eof, :uri, :syntax_error].each do |method|
+      define_method(method) do |*args|
+        callback = @callbacks[method]
+        callback.call(*args) if callback
+      end
+    end
+  end
+end

data/lib/angband/version.rb

@@ -0,0 +1,3 @@
+module Angband
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: angband
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sittercity
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gherkin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.99'
+- !ruby/object:Gem::Dependency
+  name: rack-accept_headers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: 
+email:
+- dev@sittercity.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/angband/documentation.rb
+- lib/angband/formatter.rb
+- lib/angband/gherkin_finder.rb
+- lib/angband/gherkin_listener.rb
+- lib/angband/version.rb
+homepage: http://sittercity.com
+licenses:
+- ISC
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Self-Documenting APIs for Rack applications
+test_files: []