capybara-remote-viewer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 4366c063b7cea76765fec03f548f0e3e037aec84
+  data.tar.gz: 54726e9078cfa0e27e4d6917872ef51a9277cf2a
+SHA512:
+  metadata.gz: ba8289e4502a9c6f9faf1b2a9ca0b5cf42540f2dfbf66c4539d9fe58b0ed28204cc124122c289d5951d4d4f2225df3118121791c5234e1b506e12d3f51e181e3
+  data.tar.gz: 1980572a2817a26cf4069f58ef8233b08506c52f33c1ad6a09894848ee246c3ea5165053a66b76f55fd4ffc393d5725f3069107389258df44100d3387479fe29

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capybara-remote-viewer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derek Kastner
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# Capybara::Remote::Viewer
+
+Capybara remote viewer runs a server that provides a navigable browser interface
+to the HTML dumps generated by capybara's `save_page` helper. It is especially
+useful if you're developing an app on a remote machine or working within a shell
+that can't open a browser window on your desktop.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capybara-remote-viewer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-remote-viewer
+
+## Usage
+
+### As a stand-alone binary
+
+Start a server with:
+    $ capy-remote
+
+It will start on port 3000 by default and look in the current working directory
+(and all subdirectories) for any .html files to serve.
+
+You can specify a path to a directory containing .html files with the -t option.
+
+You can also specify the port with the -p option.
+
+### With foreman
+
+Add a binstub
+
+    $ bundle binstub capybara-remote-viewer
+
+Add a line to your Procfile
+
+    capy: bin/capy-remote -t tmp -p $PORT
+
+### Interface
+
+All files dumped by capybara with the `save_page` method will automatically
+appear in the viewer interface as they are generated. No need to refresh!
+
+### Optional capybara configuration
+
+Capybara does not clean up after itself when it dumps html files, so as these
+files appear, they will fill up remote viewer's interface with old junk. You can
+tell cucumber to clean these up before each run.
+
+In features/support/capybara.rb:
+
+    AfterConfiguration do |config|
+      Dir.glob(File.expand_path('../../../tmp/capybara/*', __FILE__)).
+        each { |f| FileUtils.rm_f f }
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/capy-remote

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'capybara/remote/viewer/cli'
+
+Capybara::Remote::Viewer::CLI.start(ARGV)

data/capybara-remote-viewer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara/remote/viewer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capybara-remote-viewer"
+  spec.version       = Capybara::Remote::Viewer::VERSION
+  spec.authors       = ["Derek Kastner"]
+  spec.email         = ["dkastner@gmail.com"]
+  spec.description   = %q{View capybara page dumps remotely}
+  spec.summary       = %q{A web server that looks for capybara's saved output and makes them available to remotely connected developers}
+  spec.homepage      = "http://github.com/dkastner/capybara-remote-viewer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'haml'
+  spec.add_dependency 'sinatra'
+  spec.add_dependency 'thor'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec"
+end

data/lib/capybara/remote/viewer/cli.rb

@@ -0,0 +1,27 @@
+require 'thor'
+
+module Capybara
+  module Remote
+    module Viewer
+      class CLI < Thor
+
+        desc 'serve', 'Run the web server'
+        method_option :path, type: :string, default: nil, aliases: '-t',
+          desc: "Path to your app's tmp directory, or any directory containing html files"
+        method_option :port, type: :numeric, default: 3000, aliases: '-p',
+          desc: "Port for the server to listen on"
+        def serve
+          path = options.path || File.join(Dir.pwd, 'tmp')
+
+          require 'capybara/remote/viewer/server'
+
+          Capybara::Remote::Viewer::Server.path = path
+          Capybara::Remote::Viewer::Server.set :port, options.port
+          Capybara::Remote::Viewer::Server.run!
+        end
+
+        default_task :serve
+      end
+    end
+  end
+end

data/lib/capybara/remote/viewer/server.rb

@@ -0,0 +1,56 @@
+require 'sinatra/base'
+require 'haml'
+require 'json'
+
+module Capybara
+  module Remote
+    module Viewer
+      class Server < Sinatra::Base
+
+        def self.path
+          @path
+        end
+        def self.path=(val)
+          @path = val
+        end
+
+        set :views, File.expand_path('../../../../../views', __FILE__)
+        set :public_folder, File.expand_path('../../../../../static', __FILE__)
+
+        def files
+          Dir.glob File.join(Server.path, '**/*.html')
+        end
+
+        def file(id)
+          files.find { |f| f =~ /#{id}.html$/ }
+        end
+
+        def file_path(str)
+          "/files/#{file_name(str)}"
+        end
+
+        def file_name(str)
+          File.basename(str, '.html')
+        end
+
+        get '/' do
+          haml :index, locals: { dir: Server.path, files: files }
+        end
+
+        get '/files' do
+          headers 'Content-Type' => 'application/json'
+
+          list = files.map do |file|
+            { name: file_name(file), url: file_path(file) }
+          end
+
+          { files: list }.to_json
+        end
+
+        get '/files/:id' do
+          File.read file(params['id'])
+        end
+      end
+    end
+  end
+end

data/lib/capybara/remote/viewer/version.rb

@@ -0,0 +1,7 @@
+module Capybara
+  module Remote
+    module Viewer
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/capybara/remote/viewer.rb

@@ -0,0 +1,9 @@
+require "capybara/remote/viewer/version"
+
+module Capybara
+  module Remote
+    module Viewer
+      # Your code goes here...
+    end
+  end
+end

data/spec/capybara/remote/viewer/server_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'rack/test'
+require 'capybara/remote/viewer/server'
+
+describe Capybara::Remote::Viewer::Server do
+  include Rack::Test::Methods
+
+  before(:all) do
+    Capybara::Remote::Viewer::Server.
+      set :path, File.expand_path('../../../../dummy', __FILE__)
+  end
+
+  def app
+    Capybara::Remote::Viewer::Server
+  end
+
+  describe 'GET /' do
+
+    it 'links to existing files' do
+      get '/'
+
+      last_response.body.should =~ %r{<a href='/files/1'>1</a>}
+    end
+    
+  end
+
+  describe 'GET /files/1' do
+
+    it 'displays the content of a capybara dump' do
+      get '/files/1'
+
+      last_response.body.should =~ %r{First dump}
+    end
+
+  end
+
+end
+

data/spec/dummy/Gemfile

@@ -0,0 +1,47 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.1'
+
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 4.0.0'
+
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+
+# Use CoffeeScript for .js.coffee assets and views
+gem 'coffee-rails', '~> 4.0.0'
+
+# See https://github.com/sstephenson/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 1.2'
+
+group :doc do
+  # bundle exec rake doc:rails generates the API under doc/api.
+  gem 'sdoc', require: false
+end
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.1.2'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano', group: :development
+
+# Use debugger
+# gem 'debugger', group: [:development, :test]
+
+gem 'cucumber-rails'

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end