errgent 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11eb97f2e7cb08cb9d4306058e18795da984395d
-  data.tar.gz: 01c11ea3ae1a8ee271748ff28afc7d9203a71f7d
+  metadata.gz: 21cda53c106227d17a3b92b51f13264df58354ed
+  data.tar.gz: 3c65683f9aa595db86c712c81e314ebbe128d3bf
 SHA512:
-  metadata.gz: 93a84710bb755fdf3b558f66fca991ff372e30fdacaeaf5bf4788a5e4f51d59091716047359801b335ae5b0318c78d9c35dff50f16e81762fd69cb6cf1bab60d
-  data.tar.gz: fa3e02d4d75db46fbaf5f6306f5375994185920319fee33980809696de133366c474993208f69933335871355181f1601708bdeffc90b835f61ba120868e11c9
+  metadata.gz: 53833f13268f03a79b2854f84dcce20417228e5e3ac77996c25bc040118c6e3d5923980a9b0d80a2925fc51d16806c3d51c843dd5957bb14db358c5600939b8f
+  data.tar.gz: 2804360c95363c5e02c6da4026f17c963feb4c5174fa3b81269b39853def065e878027fb874cffb67a353ecb73e4cac0dd08ac4350c0e432550499ec8fb4f140

data/README.md

@@ -1,32 +1,65 @@
 # 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.
+Gently generate 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 re-generate all pages at once.
 
 ## Installation
 
-    gem 'errgent'
+```ruby
+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:
+`Errgent` ships with rake task that you can run locally or on your server using
+`Capistrano`. In order to generate pages simply run `rake errgent`. By default
+`layouts/error_page` is used as a layout. But you can customize this behaviour
+as many other things creating your own task in `lib/tasks/errgent.rake`:
 
-    Rake::ErrgentTask.new do |t|
-      t.codes = [500, 404]
-      t.source = 'layouts/your_own'
-      t.destination = 'public/error_%{code}.html'
+```ruby
+desc 'Generate error pages'
+task errgent: :environment do
+  renderer = Errgent::Renderer.new(
+    codes: [403, 404, 422, 500], # error codes by default, @code variable is available in layout
+    vars: { name: 'value' }, # variable @name will be available in layout
+    layout: 'layouts/error_page', # where to find your layout by default
+    output: 'public/%s.html' # where to put generated pages by default, %s is the replacement for @code
+  )
+
+  # You can override or define new helpers:
+  renderer.helpers do
+    def current_user
+      nil
+    end
+
+    def logged_in?
+      false
     end
+  end
+
+  renderer.render
+end
+```
+
+## Capistrano
+
+Since almost all applications use `Asset Pipeline`, the links to stylesheets,
+js or images must be represented with digest in their names. It's barely possible
+to do locally unless you generate assets locally either. That's why `Errgent`
+ships with `Capistrano` task. Just put this to `deploy.rb` or `Capfile` (`~> 2.0`
+and `~> 3.0` supported) and all the pages will be generated after
+`assets:precompile` task on your server during deployment:
+
+```ruby
+require 'errgent/capistrano'
+```
 
-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.
+In other words for development, generate pages locally see how it looks, fix it
+if it needs. Then re-generate them on the server, because development version
+isn't workable in production.
 
 ## License
 

data/Rakefile

@@ -6,4 +6,4 @@ Rake::TestTask.new do |t|
   t.pattern = 'test/*_test.rb'
 end
 
-task :default => :test
+task default: :test

data/errgent.gemspec

@@ -1,15 +1,10 @@
-# 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.version       = '2.0.0'
   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.description   = 'Generate error pages for Rails applications'
   spec.homepage      = 'https://github.com/route/errgent'
   spec.license       = 'MIT'
 

data/lib/errgent.rb

@@ -1 +1,3 @@
-require 'errgent/engine' if defined?(Rails)
+module Errgent
+  require 'errgent/engine' if defined?(Rails)
+end

data/lib/errgent/capistrano.rb

@@ -1,7 +1,8 @@
-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"
+if defined?(Capistrano::VERSION)
+  if Gem::Version.new(Capistrano::VERSION).release >= Gem::Version.new('3.0.0')
+    version = 3
   end
 end
+
+version ||= 2
+require_relative "capistrano/v#{version}"

data/lib/errgent/capistrano/v2.rb

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

data/lib/errgent/capistrano/v3.rb

@@ -0,0 +1,12 @@
+desc 'Generate error pages'
+task :errgent do
+  on roles(:app) do
+    within release_path do
+      with rails_env: fetch(:rails_env) do
+        execute :rake, :errgent
+      end
+    end
+  end
+end
+
+after 'deploy:assets:precompile', 'errgent'

data/lib/errgent/engine.rb

@@ -1,9 +1,5 @@
-require 'errgent/task'
+require 'errgent/renderer'
 
-module Errgent
-  class Engine < ::Rails::Engine
-    rake_tasks do
-      Rake::ErrgentTask.new
-    end
-  end
+class Errgent::Engine < ::Rails::Engine
+  rake_tasks { load 'tasks/errgent.rake' }
 end

data/lib/errgent/renderer.rb

@@ -1,22 +1,34 @@
-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
+class Errgent::Renderer
+  def initialize(options = {})
+    @vars = options[:vars] || {}
+    @codes = options[:codes] || [403, 404, 422, 500]
+    @layout = options[:layout] || 'layouts/error_page'
+    @output = options[:output] || 'public/%s.html'
+  end
+
+  def render
+    @codes.each do |code|
+      File.open(Rails.root.join(@output % code), 'w') do |io|
+        action_view.assign(@vars.merge(code: code))
+        io.write action_view.render(template: @layout)
       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)
+  def helpers(&block)
+    action_view.class_eval(&block)
+  end
+
+  private
+
+  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

data/lib/tasks/errgent.rake

@@ -0,0 +1,4 @@
+desc 'Generate error pages'
+task errgent: :environment do
+  Errgent::Renderer.new.render
+end

data/test/errgent_renderer_test.rb

@@ -1,56 +1,101 @@
 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
+class Errgent::RendererTest < ::MiniTest::Unit::TestCase
+  include ::ActiveSupport::Testing::Isolation
 
   def test_renders_given_layout
-    filename = File.join(TMP_PATH, 'given_layout.html')
+    @layout = 'layouts/given_layout'
+    @output = File.join(TMP_PATH, 'given_layout.html')
 
-    @renderer.render('layouts/given_layout', filename)
+    renderer.render
 
-    assert File.exists?(filename)
-    assert_equal 'Hi, Dmitry!', File.read(filename)
+    assert File.exists?(@output)
+    assert_equal 'Hi, Dmitry!', File.read(@output)
   end
 
   def test_assigns_vars
-    filename = File.join(TMP_PATH, 'assigns_vars.html')
+    @vars = { object: 'you' }
+    @layout = 'layouts/assigns_vars'
+    @output = File.join(TMP_PATH, 'assigns_vars.html')
 
-    @renderer.render('layouts/assigns_vars', filename, { object: 'you' })
+    renderer.render
 
-    assert File.exists?(filename)
-    assert_equal 'you', File.read(filename)
+    assert File.exists?(@output)
+    assert_equal 'you', File.read(@output)
   end
 
   def test_url_helpers
-    filename = File.join(TMP_PATH, 'url_helpers.html')
+    @layout = 'layouts/url_helpers'
+    @output = File.join(TMP_PATH, 'url_helpers.html')
 
-    @renderer.render('layouts/url_helpers', filename)
+    renderer.render
 
-    assert File.exists?(filename)
-    assert_equal '/', File.read(filename)
+    assert File.exists?(@output)
+    assert_equal '/', File.read(@output)
   end
 
   def test_app_helpers
-    filename = File.join(TMP_PATH, 'app_helpers.html')
+    @layout = 'layouts/app_helpers'
+    @output = File.join(TMP_PATH, 'app_helpers.html')
+
+    renderer.render
+
+    assert File.exists?(@output)
+    assert_equal 'hi_there!', File.read(@output)
+  end
+
+  def test_custom_helpers
+    @layout = 'layouts/custom_helpers'
+    @output = File.join(TMP_PATH, 'custom_helpers.html')
+
+    renderer.helpers do
+      def current_user
+        'Dmitry'
+      end
+
+      def role
+        'admin'
+      end
+    end
 
-    @renderer.render('layouts/app_helpers', filename)
+    renderer.render
 
-    assert File.exists?(filename)
-    assert_equal 'hi_there!', File.read(filename)
+    assert File.exists?(@output)
+    assert_equal 'Dmitry = admin', File.read(@output)
   end
 
   def test_partials
-    filename = File.join(TMP_PATH, 'partials.html')
+    @layout = 'layouts/partials'
+    @output = File.join(TMP_PATH, 'partials.html')
+
+    renderer.render
+
+    assert File.exists?(@output)
+    assert_equal 'First', File.read(@output)
+  end
+
+  def test_a_few_error_pages
+    @codes = [404, 500]
+    @layout = 'layouts/a_few_error_pages'
+    @output = File.join(TMP_PATH, '%s.html')
+
+    renderer.render
+
+    assert File.exists?(@output % 404)
+    assert_equal '404', File.read(@output % 404)
+
+    assert File.exists?(@output % 500)
+    assert_equal '500', File.read(@output % 500)
+  end
 
-    @renderer.render('layouts/partials', filename)
+  private
 
-    assert File.exists?(filename)
-    assert_equal 'First', File.read(filename)
+  def renderer
+    @renderer ||= begin
+      options = { codes: @codes || [404], layout: @layout, output: @output, vars: @vars }
+      Errgent::Renderer.new(options).tap do |renderer|
+        renderer.send(:action_view).lookup_context.view_paths = VIEW_PATH
+      end
+    end
   end
 end

data/test/test_helper.rb

@@ -1,10 +1,10 @@
+require 'minitest/autorun'
+
 require 'rails'
 require 'action_view'
 require 'action_controller'
 require 'active_support/testing/isolation'
 
-require 'minitest/autorun'
-
 require 'errgent'
 
 class MiniTest::Unit::TestCase
@@ -19,7 +19,7 @@ class MiniTest::Unit::TestCase
         config.eager_load = false
 
         routes {
-          root :to => 'home#index'
+          root to: 'home#index'
         }
 
         helpers_module = Module.new do
@@ -33,6 +33,10 @@ class MiniTest::Unit::TestCase
     end
   end
 
+  def setup
+    app.initialize!
+  end
+
   def teardown
     Dir[File.join(TMP_PATH, '*')].each { |f| File.delete(f) }
   end

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

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

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

@@ -0,0 +1 @@
+<%= current_user %> = <%= role %>

metadata

@@ -1,106 +1,106 @@
 --- !ruby/object:Gem::Specification
 name: errgent
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-22 00:00:00.000000000 Z
+date: 2014-08-30 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
+description: Generate error pages for Rails applications
 email: d.vorotilin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -108,15 +108,17 @@ files:
 - errgent.gemspec
 - lib/errgent.rb
 - lib/errgent/capistrano.rb
+- lib/errgent/capistrano/v2.rb
+- lib/errgent/capistrano/v3.rb
 - lib/errgent/engine.rb
 - lib/errgent/renderer.rb
-- lib/errgent/task.rb
-- lib/errgent/version.rb
+- lib/tasks/errgent.rake
 - test/errgent_renderer_test.rb
-- test/errgent_task_test.rb
 - test/test_helper.rb
+- test/views/layouts/a_few_error_pages.html.erb
 - test/views/layouts/app_helpers.html.erb
 - test/views/layouts/assigns_vars.html.erb
+- test/views/layouts/custom_helpers.html.erb
 - test/views/layouts/error_page.html.erb
 - test/views/layouts/given_layout.html.erb
 - test/views/layouts/partials.html.erb
@@ -132,28 +134,30 @@ 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
+rubygems_version: 2.2.2
 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/a_few_error_pages.html.erb
 - test/views/layouts/app_helpers.html.erb
 - test/views/layouts/assigns_vars.html.erb
+- test/views/layouts/custom_helpers.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
+has_rdoc: 

data/lib/errgent/task.rb

@@ -1,40 +0,0 @@
-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

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

data/test/errgent_task_test.rb

@@ -1,38 +0,0 @@
-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