peek-a-view 0.0.2

data/.gitignore

@@ -0,0 +1,14 @@
+*~
+*.orig
+*.bak
+.rvmrc
+.idea
+.bundle/
+.rake_t_cache
+log/*.log
+pkg/
+Gemfile.lock
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in peek-a-view.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Michael Schuerig, <michael@schuerig.de>
+
+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,59 @@
+# PeekAView
+
+Experimental software ahead! Use with caution, if at all.
+
+## What?
+
+This gem provides a Rails engine adds functionality to an application
+to show any of its views with stubbed data.
+
+## Why?
+
+To get to a certain page in your application you may have to jump
+through more hoops than is convenient. Or it might be complicated to
+set up the necessary data. Or it may require external services to do
+something interesting. Or you want to run a validator on all your
+pages without being bothered by a login.
+
+## How?
+
+Declare a dependency on this gem in your Gemfile
+
+    gem 'peek-a-view'
+
+Mount the PeekAView engine in config/routes.rb
+
+    if Rails.env.development? || Rails.env.test?
+      mount PeekAView::Engine => '/peek-a-view'
+    end
+
+Write view definitions in {spec|test}/peek_a_view.rb like this
+
+    PeekAView.configure do |config|
+      # Define stubbing methods or use the ones you already have for your tests.
+      def stub_article
+        ...
+      end
+
+      config.all_views do |v|
+        v.current_user = User.new
+      end
+
+      config.view 'articles/index' do |v|
+        v.articles = (1..10).map { |i| stub_article }
+      end
+
+      config.view 'articles/new', 'articles/edit' do |v|
+        v.params  = { id: '1' } # needed for URL generation
+        v.article = stub_article
+      end
+    end
+
+Start your rails application and point your browser at
+
+    http://localhost:3000/peek-a-view/
+
+If everything went well, you see a list of links to your views.
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PeekAView'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/controllers/peek_a_view/views_controller.rb

@@ -0,0 +1,80 @@
+module PeekAView
+  class ViewsController < ActionController::Base
+
+    def index
+      PeekAView.load_stubs
+      @views = config.views.keys.sort
+      render template: '/peek_a_view/views/index'
+    end
+
+    def show
+      PeekAView.load_stubs
+
+      if (view = find_view)
+        render_template(view, params)
+      else
+        render text: "No such template", status: :not_found
+      end
+    end
+
+
+    def url_options
+      # Substitute stubbed params for URL generation.
+      { _path_segments: @params }
+    end
+
+    hide_action :url_options
+
+    private
+
+    def config
+      PeekAView::Engine.config.peek_a_view
+    end
+
+    def find_view
+      config.views[params[:view]]
+    end
+
+    def render_template(view, params)
+      flash[:alert]  = params[:flash_alert]
+      flash[:notice] = params[:flash_notice]
+
+      template = view.template
+
+      stub_instance_variables_for!(view, variant: params[:variant])
+      render template: template, layout: find_layout(view)
+    end
+
+    def _prefixes
+      return super unless params[:action] == 'show'
+      # Fake the path prefix for partials specified only with a relative path.
+      # As we are not rendering them with their expected controller, we need
+      # to make sure they can be found.
+      [File.dirname(params[:view])]
+    end
+
+    def find_layout(view)
+      layout = params[:layout]
+      case layout
+      when 'true', true
+        'application'
+      when 'false', false
+        false
+      when nil
+        view.layout
+      else
+        layout
+      end
+    end
+
+    def stub_instance_variables_for!(view, options)
+      view.variables(options).each do |attr, value|
+        instance_variable_set("@#{attr}", value)
+        self.singleton_class.tap do |c|
+          c.send(:attr_reader, attr) unless c.method_defined?(attr) # Don't overwrite an existing method.
+          c.send(:helper_method, attr)
+        end
+      end
+    end
+  end
+end

data/app/views/peek_a_view/views/index.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Peek-a-View</title>
+</head>
+<body>
+<ul>
+    <% @views.each do |v| %>
+      <li>
+          <%= link_to v, peek_a_view_engine.view_path(v) %>
+      </li>
+    <% end %>
+</ul>
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,6 @@
+PeekAView::Engine.routes.draw do
+  scope module: 'peek_a_view' do
+    get '/' => 'views#index', as: 'views'
+    get '/*view' => 'views#show', as: 'view'
+  end
+end

data/lib/peek-a-view.rb

@@ -0,0 +1 @@
+require 'peek_a_view'

data/lib/peek_a_view.rb

@@ -0,0 +1,30 @@
+require 'peek_a_view/engine'
+require 'peek_a_view/configuration'
+
+module PeekAView
+  STUBS_FILE = 'peek_a_view.rb'
+
+  class << self
+
+    def configure # :yields: config
+      yield config
+    end
+
+    def load_stubs
+      config.load_stubs
+    end
+
+    private
+
+    def config
+      PeekAView::Engine.config.peek_a_view
+    end
+  end
+end
+
+PeekAView.configure do |c|
+  c.stubs_path = [
+    File.join('spec', PeekAView::STUBS_FILE),
+    File.join('test', PeekAView::STUBS_FILE)
+  ]
+end

data/lib/peek_a_view/configuration.rb

@@ -0,0 +1,48 @@
+require 'active_support/ordered_options'
+require 'peek_a_view/view'
+
+module PeekAView
+  class Configuration < ActiveSupport::OrderedOptions
+    def initialize(*)
+      super
+      clear_stubs!
+    end
+
+    def stubs_file
+      Array(stubs_path).map { |p| File.join(Rails.root, p) }.find { |p| File.file?(p) }
+    end
+
+    def load_stubs
+      clear_stubs!
+      if (file = stubs_file)
+        load file
+      else
+        raise "No peek-a-view definitions found." # TODO proper exception class
+      end
+    end
+
+    def clear_stubs!
+      @views  = { }
+      @common = []
+    end
+
+    def view(*names, &block) # :yields: a view object
+      raise ArgumentError, "A view must have a least one name." unless names.length > 0
+      names.each do |name|
+        (@views[name] ||= PeekAView::View.new(name, @common)).tap do |view|
+          view.record(block)
+        end
+      end
+    end
+
+    def all_views(&block) # :yields: a common view object
+      @common.tap do |common|
+        @common << block
+      end
+    end
+
+    def views
+      @views
+    end
+  end
+end

data/lib/peek_a_view/engine.rb

@@ -0,0 +1,7 @@
+require 'peek_a_view/configuration'
+
+module PeekAView
+  class Engine < ::Rails::Engine
+    config.peek_a_view = PeekAView::Configuration.new
+  end
+end

data/lib/peek_a_view/version.rb

@@ -0,0 +1,3 @@
+module PeekAView
+  VERSION = "0.0.2"
+end

data/lib/peek_a_view/view.rb

@@ -0,0 +1,43 @@
+module PeekAView
+  class View < ActiveSupport::OrderedOptions
+    def initialize(name, common_block = nil)
+      @name       = name
+      self.params = nil # just to initialize params
+      @blocks = []
+      record(common_block) if common_block
+    end
+
+    def record(block)
+      @blocks << block
+    end
+
+    def template
+      super || @name
+    end
+
+    def layout
+      'application' # TODO be smarter
+    end
+
+    def params=(new_params)
+      *controller, action = template.split('/')
+      augmented = (new_params || { }).reverse_merge(
+        controller: controller.join('/'),
+        action:     action
+      )
+      super(augmented)
+      augmented
+    end
+
+    def fixture(name)
+      fixture_dir = Rails.root + 'spec/fixtures/peek_a_view' # TODO config
+      file = File.join(fixture_dir, name)
+      File.read(file)
+    end
+
+    def variables(options = {})
+      @blocks.flatten.each { |block| block.call(self, options) }
+      self
+    end
+  end
+end

data/lib/tasks/views.rake

@@ -0,0 +1,9 @@
+namespace :views do
+
+  #desc "Show a view in a browser (options: TEMPLATE, LAYOUT, FLASH_NOTICE, FLASH_ALERT, BROWSER, PORT)"
+  #task :show => :environment do
+  #  # FIXME Is there a way to avoid this?
+  #  Dir[Rails.root + "app/models/**/*.rb"].each { |f| require f }
+  #
+  #end
+end

data/peek-a-view.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/peek_a_view/version', __FILE__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |gem|
+  gem.name        = "peek-a-view"
+  gem.version     = PeekAView::VERSION
+  gem.authors     = ["Michael Schuerig"]
+  gem.email       = ["michael@schuerig.de"]
+  gem.homepage    = ""
+  gem.summary     = "Look at your Rails views without bothering the application"
+  gem.description = "Show views using stubbed data."
+  gem.license     = 'MIT'
+
+  gem.files      = `git ls-files`.split($\)
+  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_runtime_dependency "rails", "~> 3.2.6"
+end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby1.9.1
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/peek-a-view/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'