fiveruns_tuneup_merb 0.5.0

data/LICENSE

@@ -0,0 +1,22 @@
+(The FiveRuns License)
+
+Copyright (c) 2008 FiveRuns Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,70 @@
+= FiveRuns TuneUp panel for Merb
+
+== Requirements
+
+* fiveruns_tuneup_core gem
+* merb-core >= 0.9.5
+* merb-slices >= 0.9.5
+
+== Synopsis
+
+FiveRuns TuneUp for Merb.
+
+See http://blog.fiveruns.com/2008/10/11/fiveruns-tuneup-for-merb for the announcement.
+
+== Installation
+
+1. Install the gem:
+
+  sudo gem install fiveruns_tuneup_merb
+
+2. Add the following to your desired environment file (eg, config/environments/development.rb):
+
+  dependency 'fiveruns_tuneup_merb'
+
+3. Run the following in your Merb.root:
+
+  rake slices:fiveruns_tuneup_merb:install
+
+4. Add the following to your config/router.rb:
+
+  slice FiverunsTuneupMerb
+  
+(If you're already mounting other slices with `all_slices' this step isn't necessary.)
+
+5. Start your app!
+
+== Sharing
+
+To enable run sharing on the http://tuneup.fiveruns.com service, you need to configure the slice with an API key. Create an account at http://tuneup.fiveruns.com/users/new and look at your profile to find your it.
+
+In your environment file (ie, config/environments/development.rb), add the API key:
+
+  Merb::BootLoader.before_app_loads do
+    Merb::Slices.config[:fiveruns_tuneup_merb][:api_key] = 'YOUR-API-KEY'
+  end	
+  
+When you restart your application, a "Share this run" link on the TuneUp panel should appear.
+
+== Supported Browsers
+
+The TuneUp plugin has been tested with the following browsers:
+
+* Firefox 2+
+* Safari 3.1+
+
+== Bugs and Feature Requests
+
+Please let us know if you run into any problems with your application or browser. The plugin uses CSS isolation techniques that could interfere with your HTML or CSS code.
+
+You can contact support at support@fiveruns.com
+  
+== Contributing
+
+Help us make TuneUp better on Merb by contributing via GitHub.
+  http://github.com/fiveruns/fiveruns_tuneup_merb
+  http://github.com/fiveruns/fiveruns_tuneup_core  
+    
+== License
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'merb-core/version'
+require 'merb-core/tasks/merb_rake_helper'
+require 'merb-core/test/tasks/spectasks'
+
+NAME = "fiveruns_tuneup_merb"
+AUTHOR = "FiveRuns Development Team"
+EMAIL = "dev@fiveruns.com"
+HOMEPAGE = "http://tuneup.fiveruns.com/"
+SUMMARY = "Merb Slice that provides the FiveRuns TuneUp Panel (http://tuneup.fiveruns.com)"
+GEM_VERSION = "0.5.0"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'fiveruns_tuneup_merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('fiveruns_tuneup_core')
+  s.add_dependency('merb-slices', '>= 0.9.5')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install FiverunsTuneupMerb as a gem"
+task :install => [:package] do
+  sh %{gem install pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{jruby -S gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+  
+end

data/TODO

@@ -0,0 +1,2 @@
+* Feedback on ORMs
+* Compatibility testing with live Merb apps (1.0)

data/app/controllers/application.rb

@@ -0,0 +1,3 @@
+class FiverunsTuneupMerb::Application < Merb::Controller
+  controller_for_slice
+end

data/app/controllers/runs.rb

@@ -0,0 +1,15 @@
+class FiverunsTuneupMerb::Runs < FiverunsTuneupMerb::Application
+  
+  provides :json
+  
+  def share
+    run_id = Fiveruns::Tuneup::Run.share(params[:slug])
+    result = if run_id
+      {:run_id => run_id}
+    else
+      {:error => "Could not send run.  Please contact support@fiveruns.com if this problem persists."}
+    end
+    render_json result.to_json
+  end
+  
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,64 @@
+module Merb
+  module FiverunsTuneupMerb
+    module ApplicationHelper
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def image_path(*segments)
+        public_path_for(:image, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def javascript_path(*segments)
+        public_path_for(:javascript, *segments)
+      end
+      
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def stylesheet_path(*segments)
+        public_path_for(:stylesheet, *segments)
+      end
+      
+      # Construct a path relative to the public directory
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path relative to the public directory, with added segments.
+      def public_path_for(type, *segments)
+        ::FiverunsTuneupMerb.public_path_for(type, *segments)
+      end
+      
+      # Construct an app-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the host application, with added segments.
+      def app_path_for(type, *segments)
+        ::FiverunsTuneupMerb.app_path_for(type, *segments)
+      end
+      
+      # Construct a slice-level path.
+      # 
+      # @param <Symbol> The type of component.
+      # @param *segments<Array[#to_s]> Path segments to append.
+      #
+      # @return <String> 
+      #  A path within the slice source (Gem), with added segments.
+      def slice_path_for(type, *segments)
+        ::FiverunsTuneupMerb.slice_path_for(type, *segments)
+      end
+      
+    end
+  end
+end

data/app/views/layout/fiveruns_tuneup_merb.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <title>Fresh FiverunsTuneupMerb Slice</title>
+    <link href="<%= public_path_for :stylesheet, 'master.css' %>" type="text/css" charset="utf-8" rel="stylesheet" media="all" />
+    <script src="<%= public_path_for :javascript, 'master.js' %>" type="text/javascript" charset="utf-8"></script>
+  </head>
+  <!-- you can override this layout at slices/fiveruns_tuneup_merb/app/views/layout/fiveruns_tuneup_merb.html.erb -->
+  <body class="fiveruns_tuneup_merb-slice">
+  <div id="container">
+	  <h1>FiverunsTuneupMerb Slice</h1>
+    <div id="main"><%= catch_content :for_layout %></div>
+  </div>
+  </body>
+</html>

data/lib/fiveruns_tuneup_merb/api_key.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module FiverunsTuneupMerb
+    
+  module APIKey
+    
+    def can_share?
+      Fiveruns::Tuneup::Run.api_key? && routed?
+    end
+    
+    def log_share_status
+      if Fiveruns::Tuneup::Run.api_key?
+        Merb.logger.debug "TuneUp is configured for sharing."
+      else
+        Merb.logger.warn "TuneUp is NOT configured for sharing."
+        Merb.logger.warn "You must set Merb::Slices.config[:fiveruns_tuneup_merb][:api_key] to share runs."
+      end
+    end
+    
+  end
+  
+end
+    

data/lib/fiveruns_tuneup_merb/instrumentation.rb

@@ -0,0 +1,193 @@
+require 'pp'
+
+module FiverunsTuneupMerb
+    
+  module Instrumentation
+    
+     def self.pretty(value)
+       CGI.escapeHTML(PP.pp(value, ''))
+     end
+     
+     def self.format_filters(filters)
+       sets = filters.map do |filter, opts|
+         content = if filter.is_a?(Proc)
+           where = filter.inspect[/@(.+)>$/, 1]
+           "Proc at %s with options %s" % [Fiveruns::Tuneup.editor_link_line(where), pretty(opts)]
+         else
+           "%s with options %s" % [pretty(filter), pretty(opts)]
+          end
+         %(<li>%s</li>) % content
+       end
+       "<ul>%s</ul>" % sets.join("\n")
+     end
+     
+     def self.format_sql(query, statement, attributes = nil)
+       values = query.bind_values + (attributes ? attributes.values : [])
+       [statement, "<b>Values:</b> " + CGI.escapeHTML(values.inspect)].join("<br/>")
+     end
+     
+     def self.attrs_for(query)
+       [
+         [ :repository, query.repository.name ],
+         [ :model,      query.model           ],
+         [ :fields,     query.fields          ],
+         [ :links,      query.links           ],
+         [ :conditions, query.conditions      ],
+         [ :order,      query.order           ],
+         [ :limit,      query.limit           ],
+         [ :offset,     query.offset          ],
+         [ :reload,     query.reload?         ],
+         [ :unique,     query.unique?         ]
+       ]
+     end
+     
+     def self.format_query(query)
+       rows = attrs_for(query).map do |set|
+         %(<tr><th>%s</th><td><pre>%s</pre></td></tr>) % set.map { |item|
+           pretty item
+         }
+       end
+       "<table>%s</table>" % rows.join
+     end
+
+     module Merb
+
+       module Controller
+
+         def new(*args, &block)
+           super.extend(Ext)
+         end
+
+         module Ext
+
+           def body
+             if content_type == :html && request.tuneup
+               ::Merb.logger.debug "TuneUp: Saving run and inserting panel into the response"
+               run = Fiveruns::Tuneup::Run.new(request.uri, request.tuneup)
+               run.save
+               Fiveruns::Tuneup.insert_panel(super, run, FiverunsTuneupMerb.can_share?)
+             else
+               super
+             end
+           end
+
+           def render(thing = nil, *args)
+             name = thing ? thing.inspect : nil 
+             Fiveruns::Tuneup.step("Render #{name}", :view) { super }
+           end
+
+           def partial(template, *args)
+             Fiveruns::Tuneup.step("Partial #{template.inspect}", :view) { super }
+           end
+
+           def _call_filters(filters)
+             if filters.empty?
+               super
+             else
+               Fiveruns::Tuneup.step("Filters (#{filters.size})", :controller, 
+                 "Filters Called" => FiverunsTuneupMerb::Instrumentation.format_filters(filters)
+               ) { super }
+             end
+           end
+
+         end
+
+       end
+
+       module Request
+
+         def new(*args, &block)
+           request = super
+           request.extend(Ext)
+           class << request
+             attr_reader :tuneup
+           end
+           request
+         end
+
+         module Ext
+
+           def dispatch_action(klass, action, *args, &block)
+             controller = nil
+             @tuneup = Fiveruns::Tuneup.record do
+               controller = Fiveruns::Tuneup.step "Dispatching #{klass}##{action}", :controller do
+                 super
+               end
+             end
+             # Don't save redirects from panel insertion
+             if controller && controller.headers['Location']
+               ::Merb.logger.debug 'TuneUp: Ignoring redirect.'
+               @tuneup = nil
+             elsif xml_http_request?
+               ::Merb.logger.debug 'TuneUp: Ignoring XHR request.'
+               @tuneup = nil
+             elsif controller.is_a?(FiverunsTuneupMerb::Application)
+               ::Merb.logger.debug 'TuneUp: Ignoring internal request.'
+               @tuneup = nil
+             else
+               ::Merb.logger.info 'TuneUp: Valid request.'
+             end   
+             controller
+           end
+
+         end
+
+       end
+
+     end
+
+     module DataMapper
+
+       module Repository
+
+         def new(*args, &block)
+           super.extend(Ext)
+         end
+
+         module Ext
+
+           def read_many(query)
+             Fiveruns::Tuneup.step("DM Read Many", :model,
+               'Query' => [
+                 FiverunsTuneupMerb::Instrumentation.format_sql(query, adapter.send(:read_statement, query)),
+                 {'Raw Details' => FiverunsTuneupMerb::Instrumentation.format_query(query)}
+               ]
+             ) { super }
+           end
+
+           def read_one(query)
+             Fiveruns::Tuneup.step("DM Read One ", :model,
+               'Query' => [
+                 FiverunsTuneupMerb::Instrumentation.format_sql(query, adapter.send(:read_statement, query)),
+                 {'Raw Details' => FiverunsTuneupMerb::Instrumentation.format_query(query)}
+                ]
+             ) { super }
+           end
+
+           def update(attributes, query)
+             Fiveruns::Tuneup.step("DM Update", :model,
+               'Query' => [
+                 FiverunsTuneupMerb::Instrumentation.format_sql(query, adapter.send(:update_statement, query), attributes),
+                 {'Raw Details' => FiverunsTuneupMerb::Instrumentation.format_query(query)}
+                ]
+             ) { super }
+           end
+
+           def delete(query)
+             Fiveruns::Tuneup.step("DM Delete", :model,
+               'Query' => [
+                 FiverunsTuneupMerb::Instrumentation.format_sql(query, adapter.send(:delete_statement, query)),
+                 {'Raw Details' => FiverunsTuneupMerb::Instrumentation.format_query(query)}
+               ]
+             ) { super }
+           end
+
+         end
+
+       end
+
+     end
+
+   end
+      
+end

data/lib/fiveruns_tuneup_merb/merbtasks.rb

@@ -0,0 +1,106 @@
+namespace :slices do
+  namespace :fiveruns_tuneup_merb do
+  
+    desc "Install FiverunsTuneupMerb"
+    task :install => [:preflight, :setup_directories, :copy_assets, :migrate]
+    
+    desc "Test for any dependencies"
+    task :preflight do # see slicetasks.rb
+    end
+  
+    desc "Setup directories"
+    task :setup_directories do
+      puts "Creating directories for host application"
+      FiverunsTuneupMerb.mirrored_components.each do |type|
+        if File.directory?(FiverunsTuneupMerb.dir_for(type))
+          if !File.directory?(dst_path = FiverunsTuneupMerb.app_dir_for(type))
+            relative_path = dst_path.relative_path_from(Merb.root)
+            puts "- creating directory :#{type} #{File.basename(Merb.root) / relative_path}"
+            mkdir_p(dst_path)
+          end
+        end
+      end
+    end
+    
+    desc "Copy stub files to host application"
+    task :stubs do
+      puts "Copying stubs for FiverunsTuneupMerb - resolves any collisions"
+      copied, preserved = FiverunsTuneupMerb.mirror_stubs!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Copy stub files and views to host application"
+    task :patch => [ "stubs", "freeze:views" ]
+  
+    desc "Copy public assets to host application"
+    task :copy_assets do
+      puts "Copying assets for FiverunsTuneupMerb - resolves any collisions"
+      copied, preserved = FiverunsTuneupMerb.mirror_public!
+      puts "- no files to copy" if copied.empty? && preserved.empty?
+      copied.each { |f| puts "- copied #{f}" }
+      preserved.each { |f| puts "! preserved override as #{f}" }
+    end
+    
+    desc "Migrate the database"
+    task :migrate do # see slicetasks.rb
+    end
+    
+    desc "Freeze FiverunsTuneupMerb into your app (only fiveruns_tuneup_merb/app)" 
+    task :freeze => [ "freeze:app" ]
+
+    namespace :freeze do
+      
+      desc "Freezes FiverunsTuneupMerb by installing the gem into application/gems using merb-freezer"
+      task :gem do
+        begin
+          Object.const_get(:Freezer).freeze(ENV["GEM"] || "fiveruns_tuneup_merb", ENV["UPDATE"], ENV["MODE"] || 'rubygems')
+        rescue NameError
+          puts "! dependency 'merb-freezer' missing"
+        end
+      end
+      
+      desc "Freezes FiverunsTuneupMerb by copying all files from fiveruns_tuneup_merb/app to your application"
+      task :app do
+        puts "Copying all fiveruns_tuneup_merb/app files to your application - resolves any collisions"
+        copied, preserved = FiverunsTuneupMerb.mirror_app!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all views into your application for easy modification" 
+      task :views do
+        puts "Copying all view templates to your application - resolves any collisions"
+        copied, preserved = FiverunsTuneupMerb.mirror_files_for :view
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freeze all models into your application for easy modification" 
+      task :models do
+        puts "Copying all models to your application - resolves any collisions"
+        copied, preserved = FiverunsTuneupMerb.mirror_files_for :model
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+      desc "Freezes FiverunsTuneupMerb as a gem and copies over fiveruns_tuneup_merb/app"
+      task :app_with_gem => [:gem, :app]
+      
+      desc "Freezes FiverunsTuneupMerb by unpacking all files into your application"
+      task :unpack do
+        puts "Unpacking FiverunsTuneupMerb files to your application - resolves any collisions"
+        copied, preserved = FiverunsTuneupMerb.unpack_slice!
+        puts "- no files to copy" if copied.empty? && preserved.empty?
+        copied.each { |f| puts "- copied #{f}" }
+        preserved.each { |f| puts "! preserved override as #{f}" }
+      end
+      
+    end
+    
+  end
+end

data/lib/fiveruns_tuneup_merb/slicetasks.rb

@@ -0,0 +1,18 @@
+namespace :slices do
+  namespace :fiveruns_tuneup_merb do 
+    
+    # add your own fiveruns_tuneup_merb tasks here
+    
+    # implement this to test for structural/code dependencies
+    # like certain directories or availability of other files
+    desc "Test for any dependencies"
+    task :preflight do
+    end
+    
+    # implement this to perform any database related setup steps
+    desc "Migrate the database"
+    task :migrate do
+    end
+    
+  end
+end

data/lib/fiveruns_tuneup_merb/spectasks.rb

@@ -0,0 +1,65 @@
+namespace :slices do
+  namespace :fiveruns_tuneup_merb do
+      
+    desc "Run slice specs within the host application context"
+    task :spec => [ "spec:explain", "spec:default" ]
+    
+    namespace :spec do
+      
+      slice_root = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+      
+      task :explain do
+        puts "\nNote: By running FiverunsTuneupMerb specs inside the application context any\n" +
+             "overrides could break existing specs. This isn't always a problem,\n" +
+             "especially in the case of views. Use these spec tasks to check how\n" +
+             "well your application conforms to the original slice implementation."
+      end
+      
+      Spec::Rake::SpecTask.new('default') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+
+      desc "Run all model specs, run a spec for a specific Model with MODEL=MyModel"
+      Spec::Rake::SpecTask.new('model') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['MODEL'])
+          t.spec_files = Dir["#{slice_root}/spec/models/**/#{ENV['MODEL']}_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/models/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all controller specs, run a spec for a specific Controller with CONTROLLER=MyController"
+      Spec::Rake::SpecTask.new('controller') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/#{ENV['CONTROLLER']}_spec.rb"].sort
+        else    
+          t.spec_files = Dir["#{slice_root}/spec/controllers/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all view specs, run specs for a specific controller (and view) with CONTROLLER=MyController (VIEW=MyView)"
+      Spec::Rake::SpecTask.new('view') do |t|
+        t.spec_opts = ["--format", "specdoc", "--colour"]
+        if(ENV['CONTROLLER'] and ENV['VIEW'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/#{ENV['VIEW']}*_spec.rb"].sort
+        elsif(ENV['CONTROLLER'])
+          t.spec_files = Dir["#{slice_root}/spec/views/**/#{ENV['CONTROLLER']}/*_spec.rb"].sort
+        else
+          t.spec_files = Dir["#{slice_root}/spec/views/**/*_spec.rb"].sort
+        end
+      end
+
+      desc "Run all specs and output the result in html"
+      Spec::Rake::SpecTask.new('html') do |t|
+        t.spec_opts = ["--format", "html"]
+        t.libs = ['lib', 'server/lib' ]
+        t.spec_files = Dir["#{slice_root}/spec/**/*_spec.rb"].sort
+      end
+      
+    end
+    
+  end
+end