errgent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11eb97f2e7cb08cb9d4306058e18795da984395d
+  data.tar.gz: 01c11ea3ae1a8ee271748ff28afc7d9203a71f7d
+SHA512:
+  metadata.gz: 93a84710bb755fdf3b558f66fca991ff372e30fdacaeaf5bf4788a5e4f51d59091716047359801b335ae5b0318c78d9c35dff50f16e81762fd69cb6cf1bab60d
+  data.tar.gz: fa3e02d4d75db46fbaf5f6306f5375994185920319fee33980809696de133366c474993208f69933335871355181f1601708bdeffc90b835f61ba120868e11c9

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dmitry Vorotilin
+
+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,33 @@
+# Errgent
+
+Generates error pages using layout, your favorite markup language, basic and url
+helpers or the other stuff you ever used in your templates. Out of the box Rails
+has default error pages, but they're hardly maintained because if you do a
+little change in one, you'll have to fix the others. With errgent you can make
+changes and regenerate all pages at once.
+
+## Installation
+
+    gem 'errgent'
+
+## Usage
+
+I'm pretty sure error pages should be lighter than application layout. Running
+`rake errgent` will generate pages from `layouts/error_page` to public folder
+with names as error codes(by default we generate `500.html`, `403.html`,
+`404.html` and `422.html`). `@code` variable is available for you in the
+template. You can create and customize your own rake task:
+
+    Rake::ErrgentTask.new do |t|
+      t.codes = [500, 404]
+      t.source = 'layouts/your_own'
+      t.destination = 'public/error_%{code}.html'
+    end
+
+You can add generated pages to git index, and regenerate them on demand, or you
+can add `require 'errgent/capistrano'` to `deploy.rb` and it will build pages on
+server.
+
+## License
+
+Errgent is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end
+
+task :default => :test

data/errgent.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'errgent/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'errgent'
+  spec.version       = Errgent::VERSION
+  spec.authors       = 'Dmitry Vorotilin'
+  spec.email         = 'd.vorotilin@gmail.com'
+  spec.description   = 'Errgent generates error pages for your Rails application'
+  spec.summary       = 'Error pages generator'
+  spec.homepage      = 'https://github.com/route/errgent'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'railties', '>= 3.0'
+  spec.add_runtime_dependency 'actionpack', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'minitest', '~> 4.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'tzinfo'
+end

data/lib/errgent/capistrano.rb

@@ -0,0 +1,7 @@
+Capistrano::Configuration.instance.load do
+  after 'deploy:assets:precompile', 'errgent'
+
+  task :errgent do
+    run "cd #{latest_release} && RAILS_ENV=#{rails_env} bundle exec rake errgent"
+  end
+end

data/lib/errgent/engine.rb

@@ -0,0 +1,9 @@
+require 'errgent/task'
+
+module Errgent
+  class Engine < ::Rails::Engine
+    rake_tasks do
+      Rake::ErrgentTask.new
+    end
+  end
+end

data/lib/errgent/renderer.rb

@@ -0,0 +1,23 @@
+module Errgent
+  class Renderer
+    def action_view
+      @action_view ||= begin
+        paths = ActionController::Base.view_paths
+        ActionView::Base.new(paths).tap do |view|
+          view.class_eval do
+            include Rails.application.helpers
+            include Rails.application.routes.url_helpers
+          end
+        end
+      end
+    end
+
+    def render(source, destination, assigns = {})
+      destination = Rails.root.join(destination)
+      File.open(destination, 'w') do |io|
+        action_view.assign(assigns)
+        io.write action_view.render(:template => source)
+      end
+    end
+  end
+end

data/lib/errgent/task.rb

@@ -0,0 +1,40 @@
+require 'rake'
+require 'rake/tasklib'
+
+require 'errgent/renderer'
+
+module Rake
+  class ErrgentTask < Rake::TaskLib
+    attr_reader :name, :renderer
+    attr_accessor :codes, :source, :destination
+
+    def initialize(name = :errgent)
+      @name = name
+      @renderer = Errgent::Renderer.new
+
+      @codes = [500, 403, 404, 422]
+      @source = File.join('layouts', 'error_page')
+      @destination = File.join('public', '%{code}.html')
+
+      yield self if block_given?
+
+      define
+    end
+
+    def define
+      desc 'Generates error pages'
+      task name => :environment do
+        generate_error_pages
+      end
+    end
+
+    private
+
+    def generate_error_pages
+      codes.each do |code|
+        assigns = { :code => code }
+        renderer.render(source, destination % assigns, assigns)
+      end
+    end
+  end
+end

data/lib/errgent/version.rb

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

data/lib/errgent.rb

@@ -0,0 +1 @@
+require 'errgent/engine' if defined?(Rails)

data/test/errgent_renderer_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+class ErrgentRendererTest < MiniTest::Unit::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  def setup
+    app.initialize!
+    @renderer = Errgent::Renderer.new
+    @renderer.action_view.lookup_context.view_paths = VIEW_PATH
+  end
+
+  def test_renders_given_layout
+    filename = File.join(TMP_PATH, 'given_layout.html')
+
+    @renderer.render('layouts/given_layout', filename)
+
+    assert File.exists?(filename)
+    assert_equal 'Hi, Dmitry!', File.read(filename)
+  end
+
+  def test_assigns_vars
+    filename = File.join(TMP_PATH, 'assigns_vars.html')
+
+    @renderer.render('layouts/assigns_vars', filename, { object: 'you' })
+
+    assert File.exists?(filename)
+    assert_equal 'you', File.read(filename)
+  end
+
+  def test_url_helpers
+    filename = File.join(TMP_PATH, 'url_helpers.html')
+
+    @renderer.render('layouts/url_helpers', filename)
+
+    assert File.exists?(filename)
+    assert_equal '/', File.read(filename)
+  end
+
+  def test_app_helpers
+    filename = File.join(TMP_PATH, 'app_helpers.html')
+
+    @renderer.render('layouts/app_helpers', filename)
+
+    assert File.exists?(filename)
+    assert_equal 'hi_there!', File.read(filename)
+  end
+
+  def test_partials
+    filename = File.join(TMP_PATH, 'partials.html')
+
+    @renderer.render('layouts/partials', filename)
+
+    assert File.exists?(filename)
+    assert_equal 'First', File.read(filename)
+  end
+end

data/test/errgent_task_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class ErrgentTaskTest < MiniTest::Unit::TestCase
+  include ActiveSupport::Testing::Isolation
+
+  def setup
+    app.initialize!
+  end
+
+  def test_customize_settings
+    task = Rake::ErrgentTask.new do |t|
+      t.codes = 'codes'
+      t.source = 'source'
+      t.destination = 'destination'
+    end
+
+    assert_equal 'codes', task.codes
+    assert_equal 'source', task.source
+    assert_equal 'destination', task.destination
+  end
+
+  def test_generate_error_pages
+    filename = File.join(TMP_PATH, 'error_page_%{code}.html')
+    task = Rake::ErrgentTask.new do |t|
+      t.codes = [500, 404]
+      t.destination = filename
+      t.renderer.action_view.lookup_context.view_paths = VIEW_PATH
+    end
+
+    task.send(:generate_error_pages)
+
+    _500, _404 = filename % { :code => 500 }, filename % { :code => 404 }
+    assert File.exists?(_500)
+    assert_equal '500 error!', File.read(_500)
+    assert File.exists?(_404)
+    assert_equal '404 error!', File.read(_404)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'rails'
+require 'action_view'
+require 'action_controller'
+require 'active_support/testing/isolation'
+
+require 'minitest/autorun'
+
+require 'errgent'
+
+class MiniTest::Unit::TestCase
+  VIEW_PATH = File.expand_path('../views', __FILE__)
+  TMP_PATH = File.expand_path('../tmp', __FILE__)
+
+  def app
+    Class.new(Rails::Application).tap do |app|
+      app.configure do
+        config.active_support.deprecation = :notify
+        config.secret_token = 'a966a729a228e5d3edf00997e7b7eab7'
+        config.eager_load = false
+
+        routes {
+          root :to => 'home#index'
+        }
+
+        helpers_module = Module.new do
+          def hi_there
+            'hi_there!'
+          end
+        end
+
+        helpers.send(:include, helpers_module)
+      end
+    end
+  end
+
+  def teardown
+    Dir[File.join(TMP_PATH, '*')].each { |f| File.delete(f) }
+  end
+end

data/test/views/layouts/app_helpers.html.erb

@@ -0,0 +1 @@
+<%= hi_there %>

data/test/views/layouts/assigns_vars.html.erb

@@ -0,0 +1 @@
+<%= @object %>

data/test/views/layouts/error_page.html.erb

@@ -0,0 +1 @@
+<%= @code %> error!

data/test/views/layouts/given_layout.html.erb

@@ -0,0 +1 @@
+Hi, <%= 'Dmi' + 'try' %>!

data/test/views/layouts/partials.html.erb

@@ -0,0 +1 @@
+<%= render 'part/first' %>

data/test/views/layouts/url_helpers.html.erb

@@ -0,0 +1 @@
+<%= root_path %>

data/test/views/part/_first.html.erb

@@ -0,0 +1 @@
+First

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: errgent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dmitry Vorotilin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Errgent generates error pages for your Rails application
+email: d.vorotilin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- errgent.gemspec
+- lib/errgent.rb
+- lib/errgent/capistrano.rb
+- lib/errgent/engine.rb
+- lib/errgent/renderer.rb
+- lib/errgent/task.rb
+- lib/errgent/version.rb
+- test/errgent_renderer_test.rb
+- test/errgent_task_test.rb
+- test/test_helper.rb
+- test/views/layouts/app_helpers.html.erb
+- test/views/layouts/assigns_vars.html.erb
+- test/views/layouts/error_page.html.erb
+- test/views/layouts/given_layout.html.erb
+- test/views/layouts/partials.html.erb
+- test/views/layouts/url_helpers.html.erb
+- test/views/part/_first.html.erb
+homepage: https://github.com/route/errgent
+licenses:
+- MIT
+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.0.0
+signing_key: 
+specification_version: 4
+summary: Error pages generator
+test_files:
+- test/errgent_renderer_test.rb
+- test/errgent_task_test.rb
+- test/test_helper.rb
+- test/views/layouts/app_helpers.html.erb
+- test/views/layouts/assigns_vars.html.erb
+- test/views/layouts/error_page.html.erb
+- test/views/layouts/given_layout.html.erb
+- test/views/layouts/partials.html.erb
+- test/views/layouts/url_helpers.html.erb
+- test/views/part/_first.html.erb