stopover 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ef37222ad04c88ef9d17c7d1788a773d2cbd1c5
+  data.tar.gz: 0fde2222512d624748939c8254d86cebec79dbf8
+SHA512:
+  metadata.gz: 099d0ec00dfd65f412d337e034cd2acded7de27b35ed9f9437f6381de3ccd8ad8911ac95e53912bb9d13e2d4cf8d15bf74879f4b185e856918299850be233482
+  data.tar.gz: dff288c3be6d32c99da9cd2709b1e94749406138645098e20e72197d64c5afcc7ce4cfd27b8e05412c326cd3c2d47e2697d7771e1d2816f1971a3e652371f780

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 rono23
+
+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,62 @@
+# Stopover
+
+Generate static pages with the asset pipeline on Rails.
+
+## Installation
+
+Put this line in your Gemfile:
+
+```
+gem 'stopover'
+```
+
+Run the bundle command to install it.
+
+After you install Stopover, you need to run the generator:
+
+```
+rails generate stopover:install
+```
+
+And add to your routes.rb if you want to check pages on your browser:
+
+```
+mount Stopover::Engine, at: '/stopover', as: :stopover if Rails.env.development?
+```
+
+Then visit http://localhost:3000/stopover.
+
+## Usage
+
+Stopover is called after `rake assets:precompile` automatically.
+And for example,  `app/views/stopover/404.html.erb` is compiled to `public/404.html`.
+
+You can also stop the hook with `disable_hook_assets_precompile = true` in [stopover.rb](https://github.com/rono23/stopover/blob/master/lib/generators/stopover/templates/stopover.rb#L5) and call `rake stopover:create` by yourself.
+
+#### Heroku
+
+Using Stopover on Heroku requires settings:
+
+```
+# config/environments/production.rb
+config.action_controller.asset_host = 'https://xxx.herokuapp.com'
+
+# config/initializers/stopover.rb
+config.disable_hook_assets_precompile = false
+```
+
+## Notice
+
+Before deploy, please run `rake assets:precompile` or  `rake stopover:create` and check compiled html in local when created/updated views in stopover.
+Because there are some differences between a browser and rake.
+
+For example, when you are using devise and a view calls `user_signed_in?`, it will return true/false on a browser, but raise an error on rake because of `request.env['warden']` is nil.
+In this case, you can set `current_user` in [stopover.rb](https://github.com/rono23/stopover/blob/master/lib/generators/stopover/templates/stopover.rb#L27) and it is always handled as a guest on both.
+
+## 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,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Stopover'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+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/stopover/application_controller.rb

@@ -0,0 +1,20 @@
+module Stopover
+  class ApplicationController < ActionController::Base
+    include Rails.application.routes.url_helpers
+    include Stopover::CustomMethods
+
+    def self.renderer
+      new.tap do |controller|
+        controller.request  = ActionDispatch::Request.new({})
+        controller.response = ActionDispatch::Response.new
+        controller.params = {}
+      end
+    end
+
+    private
+
+    def _prefixes
+      @_prefixes ||= [Stopover.view_path, 'application']
+    end
+  end
+end

data/app/controllers/stopover/pages_controller.rb

@@ -0,0 +1,13 @@
+require_dependency "stopover/application_controller"
+
+module Stopover
+  class PagesController < ApplicationController
+    def index
+      render text: "Create views in app/views/#{Stopover.view_path} and then you can access #{request.fullpath}FILENAME without an extension."
+    end
+
+    def show
+      render "#{Stopover.view_path}/#{params[:id]}", layout: Stopover.layout_name
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Stopover::Engine.routes.draw do
+  get '/', to: 'pages#index', as: :index
+  get '*id', to: 'pages#show', as: :show
+end

data/lib/generators/stopover/install_generator.rb

@@ -0,0 +1,45 @@
+module Stopover
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :template_engine,
+        type: :string,
+        aliases: '-e',
+        desc: 'Template engine for the views. Available options are "erb", "haml", and "slim".'
+
+      def self.banner
+        <<-BANNER.chomp
+rails g stopover:install
+
+    Copies a layout, template and initializer to your application.
+BANNER
+      end
+
+      desc ''
+      def copy_initializer
+        template 'stopover.rb', 'config/initializers/stopover.rb'
+      end
+
+      def copy_layout
+        layout = "layouts/#{Stopover.layout_name}.html.#{template_engine}"
+        copy_file layout, "app/views/#{layout}"
+      end
+
+      def copy_view
+        view = "404.html.#{template_engine}"
+        copy_file "views/#{view}", "app/views/#{Stopover.view_path}/#{view}"
+      end
+
+      def show_readme
+        readme 'README' if behavior == :invoke
+      end
+
+      private
+
+      def template_engine
+        options[:template_engine].try(:to_s).try(:downcase) || 'erb'
+      end
+    end
+  end
+end

data/lib/generators/stopover/templates/README

@@ -0,0 +1,12 @@
+===============================================================================
+
+Thank you for installing!
+You can change a layout, view path, custom methods etc in config/initializers/stopover.rb.
+
+Add to your routes.rb if you want to check pages on your browser:
+
+  mount Stopover::Engine, at: '/stopover', as: :stopover if Rails.env.development?
+
+Then visit http://localhost:3000/stopover.
+
+===============================================================================

data/lib/generators/stopover/templates/layouts/stopover.html.erb

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= content_for :title %></title>
+    <%= stylesheet_link_tag 'application', media: 'all' %>
+    <%= javascript_include_tag 'application' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/generators/stopover/templates/layouts/stopover.html.haml

@@ -0,0 +1,8 @@
+!!!
+%html
+  %head
+    %title= content_for :title
+    = stylesheet_link_tag 'application', media: 'all'
+    = javascript_include_tag 'application'
+  %body
+    = yield

data/lib/generators/stopover/templates/layouts/stopover.html.slim

@@ -0,0 +1,8 @@
+doctype html
+html
+  head
+    title= content_for :title
+    = stylesheet_link_tag 'application', media: 'all'
+    = javascript_include_tag 'application'
+  body
+    = yield

data/lib/generators/stopover/templates/stopover.rb

@@ -0,0 +1,30 @@
+Stopover.setup do |config|
+  # Stopover is called after `rake assets:precompile` automatically.
+  # Set `true` and use `rake stopover:create` if you don't want.
+  # Default is <%= Stopover.disable_hook_assets_precompile.to_s %>.
+  # config.disable_hook_assets_precompile = <%= Stopover.disable_hook_assets_precompile.to_s %>
+
+  # The name of layout for all static pages. Set `false` if you don't need a layout.
+  # Default is '<%= Stopover.layout_name %>'.
+  # config.layout_name = '<%= Stopover.layout_name %>'
+
+  # The directry name of views. For exmaple, if this value is set to '<%= Stopover.view_path %>', Stopover finds views from 'app/views/<%= Stopover.view_path %>'.
+  # Default is '<%= Stopover.view_path %>'.
+  # config.view_path = '<%= Stopover.view_path %>'
+
+  # When you set custom methods, it will be included to `Stopover::ApplicationController`.
+  config.custom_methods do
+    # Set host etc to generate path/url in views.
+    def default_url_options
+      Rails.application.config.action_mailer[:default_url_options] || { host: 'localhost', port: 3000 }
+    end
+
+    # Override current_user is useful when you are using devise etc.
+    # For example, when a view calls `user_signed_in?`, it will return true/false on a browser,
+    # but raise an error on rake because of `request.env['warden']` is nil.
+    # In order to avoid this, you can set `current_user` is nil and it is always handled as a guest on both.
+    # def current_user
+    #   nil
+    # end
+  end
+end

data/lib/generators/stopover/templates/views/404.html.erb

@@ -0,0 +1,8 @@
+<%- content_for :title, "The page you were looking for doesn't exist (404)" %>
+<div class="dialog">
+  <div>
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</div>

data/lib/generators/stopover/templates/views/404.html.haml

@@ -0,0 +1,6 @@
+- content_for :title, "The page you were looking for doesn't exist (404)"
+.dialog
+  %div
+    %h1 The page you were looking for doesn't exist.
+    %p You may have mistyped the address or the page may have moved.
+  %p If you are the application owner check the logs for more information.

data/lib/generators/stopover/templates/views/404.html.slim

@@ -0,0 +1,6 @@
+- content_for :title, "The page you were looking for doesn't exist (404)"
+.dialog
+  div
+    h1 The page you were looking for doesn't exist.
+    p You may have mistyped the address or the page may have moved.
+  p If you are the application owner check the logs for more information.

data/lib/stopover.rb

@@ -0,0 +1,18 @@
+require 'stopover/engine'
+
+module Stopover
+  mattr_accessor(:disable_hook_assets_precompile) { false }
+  mattr_accessor(:layout_name) { 'stopover' }
+  mattr_accessor(:view_path) { 'stopover' }
+
+  module CustomMethods
+  end
+
+  def self.custom_methods(&block)
+    Stopover::CustomMethods.module_eval(&block) if block
+  end
+
+  def self.setup
+    yield self
+  end
+end

data/lib/stopover/engine.rb

@@ -0,0 +1,9 @@
+module Stopover
+  class Engine < ::Rails::Engine
+    isolate_namespace Stopover
+
+    config.to_prepare do
+      Stopover::ApplicationController.helper Rails.application.helpers
+    end
+  end
+end

data/lib/stopover/version.rb

@@ -0,0 +1,3 @@
+module Stopover
+  VERSION = "0.0.1"
+end

data/lib/tasks/stopover_tasks.rake

@@ -0,0 +1,27 @@
+namespace :stopover do
+  desc 'Creates static pages'
+  task create: :environment do
+    logger = Logger.new(STDOUT)
+    renderer = Stopover::ApplicationController.renderer
+    view_path = Rails.root.join('app', 'views', Stopover.view_path).to_s
+
+    Dir["#{view_path}/**/*"].each do |path|
+      filename = File.basename(path)
+      next if File.directory?(path) || filename.index(/^_/)
+
+      name = filename.split('.').first
+      dir = path.remove(view_path).remove(filename)
+      html = renderer.render_to_string("#{Stopover.view_path}#{dir}#{name}", layout: Stopover.layout_name)
+      html_dir = "#{Rails.public_path}#{dir}"
+      html_path = "#{html_dir}#{name}.html"
+
+      logger.info("Writing #{html_path}")
+      FileUtils.mkdir_p(html_dir)
+      File.open(html_path, 'w') { |f| f.write(html) }
+    end
+  end
+end
+
+Rake::Task['assets:precompile'].enhance do
+  Rake::Task['stopover:create'].invoke unless Stopover.disable_hook_assets_precompile
+end

data/test/controllers/stopover/application_controller_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+module Stopover
+  class ApplicationControllerTest < ActiveSupport::TestCase
+    setup do
+      Stopover.setup do |config|
+        config.custom_methods do
+          def default_url_options
+            { host: 'testtest.host', port: 3001 }
+          end
+
+          def current_user
+            nil
+          end
+        end
+      end
+    end
+
+    test 'instance methods from module_eval' do
+      @controller = Stopover::ApplicationController.new
+      assert_equal({ host: 'testtest.host', port: 3001 }, @controller.default_url_options)
+      assert_equal nil, @controller.current_user
+    end
+
+    test '.renderer' do
+      @renderer = Stopover::ApplicationController.renderer
+      assert_equal "<!DOCTYPE html>\n<html>\n  <head>\n    <title>404</title>\n    <link rel=\"stylesheet\" media=\"all\" href=\"/assets/application.css\" />\n    <script src=\"/assets/application.js\"></script>\n  </head>\n  <body>\n    <h1><a href=\"http://testtest.host:3001/stopover/\">404 - Test</a></h1>\n\n  </body>\n</html>\n", @renderer.render_to_string('stopover/404', layout: 'stopover')
+    end
+  end
+end

data/test/controllers/stopover/pages_controller_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+module Stopover
+  class PagesControllerTest < ActionController::TestCase
+    setup do
+      @routes = Engine.routes
+
+      Stopover.setup do |config|
+        config.custom_methods do
+          def default_url_options
+            { host: 'test.host' }
+          end
+        end
+      end
+    end
+
+    test 'GET index' do
+      get :index
+      assert_response :success
+      assert_equal 'Create views in app/views/stopover and then you can access /stopover/FILENAME without an extension.', @response.body
+    end
+
+    test 'GET show' do
+      get :show, id: 404
+      assert_response :success
+      assert_equal "<!DOCTYPE html>\n<html>\n  <head>\n    <title>404</title>\n    <link rel=\"stylesheet\" media=\"all\" href=\"/assets/application.css\" />\n    <script src=\"/assets/application.js\"></script>\n  </head>\n  <body>\n    <h1><a href=\"http://test.host/stopover/\">404 - Test</a></h1>\n\n  </body>\n</html>\n", @response.body
+    end
+  end
+end