sinatra-web-inspector 0.4.0.a

data/README.md

@@ -0,0 +1,29 @@
+Sinatra::WebInspector
+=====================
+
+The WebInspector allowes you to inspect a running [Sinatra](http://sinatrarb.com) app.
+Just browse http://localhost:4567/\_\_inspect\_\_
+
+When used with BigBand, it will – per default – only be activated in development mode.
+
+BigBand
+-------
+
+Sinatra::WebInspector is part of the [BigBand](http://github.com/rkh/big_band) stack.
+Check it out if you are looking for other fancy Sinatra extensions.
+
+Usage
+-----
+
+Classic style:
+
+    require "sinatra"
+    configure(:development) { require "sinatra/webinspector" }
+
+Modular style:
+
+    require "sinatra/base"
+    require "sinatra/webinspector"
+    class Foo < Sintra::Base
+      configure(:development) { register Sintra::WebInspector }
+    end

data/lib/sinatra/web_inspector.rb

@@ -0,0 +1,180 @@
+require "sinatra/base"
+require "sinatra/sugar"
+require "sinatra/compass"
+require "haml"
+require "monkey"
+
+module Sinatra
+
+  # The WebInspector allowes you to inspect a running Sinatra app.
+  # Just browse http://localhost:4567/\_\_inspect\_\_
+  module WebInspector
+
+    attr_reader :middleware 
+
+    class Middleware < Sinatra::Base
+
+      attr_accessor :sinatra_app
+      use_in_file_templates! __FILE__
+      register BasicExtensions
+      set :app_file, __FILE__
+      
+      # If this is a git project, then it returns the path to the .git directory.
+      def git_directory
+        @git_directory ||= root_glob(".{,.,./..,./../..}/.git").first
+      end
+      
+      # Whether or not this is a git project.
+      def git?
+        !!git_directory
+      end
+      
+      # Figures out some URLs to public git hosts by parsing the remote urls from the git config.
+      # Currently detects: GitHub, Codaset and Gitorious.
+      def git_remotes
+        @git_remotes ||= (File.read(git_directory / :config).scan(/\s*url\s*=\s*(.*)\n/).flatten.collect do |url|
+          case url
+          when %r{(github.com)[:/](.+)/(.+)/?\.git$}  then [$3, "GitHub",    "http://#$1/#$2/#$3", "http://#$1"]
+          when %r{(codaset.com)[:/](.+)/(.+)?\.git$}  then [$3, "Codaset",   "http://#$1/#$2/#$3", "http://#$1"]
+          when %r{(gitorious.org)[:/](.+)/.+/?\.git$} then [$2, "Gitorious", "http://#$1/#$2",     "http://#$1"]
+          end
+        end).compact
+      end
+      
+      # Recent git log.
+      def git_log
+        @git_format ||= begin
+          line = ["<a href='mailto:%ae'>%an</a>", "%s", "<date>%ai</date>"].map { |e| "<td>#{e}</td>" }.join
+          "<tr>#{line}</tr>"
+        end
+        %x[git log -50 --pretty=format:"#{@git_format}"]
+      end
+
+      # webinspector stylesheet.
+      get "/__inspect__/screen.css" do
+        content_type 'text/css', :charset => 'utf-8'
+        sass :stylesheet, ::Compass.sass_engine_options
+      end
+
+      # Route for inspection. Currently we display all information on a single page. In case the amount of data
+      # increases, we might split this on multiple pages. Also, this would ease hooking own data into the front-end.
+      get "/__inspect__/?" do
+        ruby_env = %w[RUBY_VERSION RUBY_DESCRIPTION RUBY_PATCHLEVEL RUBY_PLATFORM RUBY_ENGINE RUBY_ENGINE_VERSION]
+        ruby_env.map! { |var| [var, eval("#{var}.inspect if defined? #{var}")] }
+        haml :inspect, {}, :ruby_env => ruby_env
+      end
+
+    end
+
+    def self.registered(klass)
+      klass.register Sugar
+      klass.register AdvancedRoutes
+      klass.use(Middleware) { |m| m.sinatra_app = klass }
+    end
+
+  end
+  
+  register WebInspector
+  
+end
+
+__END__
+
+@@layout
+!!!
+%html
+  %head
+    %meta{:charset=>"utf-8"}/
+    %link{:rel => "stylesheet", :href => "/__inspect__/screen.css", :type => "text/css"}/
+    %title= "#{sinatra_app.name}.inspect"
+  %body
+    %header
+      %h1= "#{sinatra_app.name}.inspect"
+      Generated on
+      %date= Time.now
+      %nav
+        %a{:href => "/__inspect__/#routes"     } Routes
+        %a{:href => "/__inspect__/#extensions" } Extensions
+        %a{:href => "/__inspect__/#middleware" } Middleware
+        %a{:href => "/__inspect__/#system"     } System
+        - if git?
+          %a{:href => "/__inspect__/#git_log"  } Git Log
+    %article
+      !=yield
+    %footer
+      powered by
+      %a{:href => "http://www.sinatrarb.com"} Sinatra
+      and
+      %a{:href => "http://github.com/rkh/big_band"} BigBand
+
+@@stylesheet
+
+
+@@inspect
+
+%a{ :name => "routes" }
+%h2 Routes
+%table
+  %tr
+    %th Verb
+    %th Pattern
+    %th File
+    %th Keys
+    %th Conditions
+  - sinatra_app.each_route do |route|
+    %tr
+      %td= route.verb
+      %td= route.pattern.inspect
+      %td
+        - if route.file?
+          = route.file
+          %i= "(line #{route.line})" if route.line 
+      %td= route.keys.map { |e| e.inspect }.join ", "
+      %td= route.conditions.map { |e| e.inspect }.join ", "
+
+%a{ :name => "extensions" }
+%h2 Extensions
+%table
+  %tr
+    %th Extension
+    %th Status
+  - sinatra_app.extensions.each do |extension|
+    %tr
+      %td= extension.name
+      %td= extension.status if extension.respond_to? :status
+
+%a{ :name => "middleware" }
+%h2 Middleware
+%table
+  %tr
+    %th Middleware
+    %th Arguments
+    %th Block Given
+  - sinatra_app.middleware.each do |name, arguments, block|
+    %tr
+      %td= name
+      %td= arguments.map { |e| e.inspect }.join ", "
+      %td= block ? "yes" : "no"
+
+%a{ :name => "system" }
+%h2 System
+%table
+  %tr
+    %th Variable
+    %th Value
+  - ruby_env.each do |key, value|
+    %tr
+      %td= key
+      %td= value
+
+- if git?
+  %a{ :name => "git_log" }
+  %h2 Recent Git Log
+  - git_remotes.each do |name, service, url, service_url|
+    .note Visit <a href="#{url}">#{name}</a> on <a href="#{service_url}">#{service}</a>.
+  %table
+    %tr
+      %th Author
+      %th Subject
+      %th Date
+    != git_log

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-web-inspector
+version: &id001 !ruby/object:Gem::Version 
+  version: 0.4.0.a
+platform: ruby
+authors: 
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-15 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: monkey-lib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra-sugar
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra-advanced-routes
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra-compass
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+description: Web inspector for sinatra (part of BigBand).
+email: konstantin.mailinglists@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sinatra/web_inspector.rb
+- README.md
+has_rdoc: yard
+homepage: http://github.com/rkh/sinatra-web-inspector
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Web inspector for sinatra (part of BigBand).
+test_files: []
+