RubyGems - endleaf - Versions diffs - 0.1.0 - Mend

Files changed (13) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +39 -0
data/Rakefile +8 -0
data/app/controllers/endleaf/pages_controller.rb +15 -0
data/app/views/layouts/endleaf.html.erb +12 -0
data/config/routes.rb +5 -0
data/lib/endleaf/engine.rb +4 -0
data/lib/endleaf/railtie.rb +4 -0
data/lib/endleaf/version.rb +3 -0
data/lib/endleaf.rb +6 -0
data/lib/tasks/endleaf/render.rake +38 -0
metadata +71 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e57280cf9e74833917adf64e42296f18550963bab92d7c2ccb98e7ad735d55aa
+  data.tar.gz: e4ebb14b254fd6614d1cf88f396ebcff36028256035a03a0d159c251347ff8f5
+SHA512:
+  metadata.gz: 73b9cd8dd06eed1b9c5abb277339a41b4cad7941c2d29c2196e13237848250738b35a05793a7b0d2a3f7c3d96639209b9ed85a271a06328657f5220b827a3a50
+  data.tar.gz: 23fa2ceffaa1f8f0c466f07d4cc0645c69d5b20c73a396696c4dc3ca321cc7b1dbe77248d081bb59dff725801f77b9eef97598adb535f81c97236804f038f11c

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright Wittawas W
+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 ADDED Viewed

@@ -0,0 +1,39 @@
+# Endleaf
+Routing and utilities for static pages creation in Rails.
+## Installation
+Add this line to your Rails application's Gemfile:
+```ruby
+gem "endleaf"
+```
+## Usage
+- Use with Ruby on Rails only.
+- Add routes to `config/routes.rb`
+```ruby
+scope module: 'endleaf' do
+  get '/pages/:page', to: 'pages#show', as: :page
+end
+```
+- Create pages in `app/views/pages` with filenames corresponding to their routes.
+```ruby
+# can be used in specific routes e.g. homepage
+# this route is rendered from app/view/pages/home.html.erb (or any supported extensions)
+root 'endleaf/pages#show' , page: 'home'
+# this route is rendered from app/view/pages/about.html.erb (or any supported extensions)
+get  'endleaf/pages#show' , page: 'about'
+```
+- Pre-render pages into the `public` directory. Pre-rendered pages can be served by a web server and are more cache-friendly.
+```shell
+bundle exec rake endleaf:render:generate_html
+```
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,8 @@
+require "bundler/setup"
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+require "bundler/gem_tasks"

data/app/controllers/endleaf/pages_controller.rb ADDED Viewed

@@ -0,0 +1,15 @@
+module Endleaf
+  class PagesController < ApplicationController
+    before_action :set_layout
+    def show
+      render template: "pages/#{params[:page]}"
+    end
+    private
+    def set_layout
+      self.class.layout('endleaf')
+    end
+  end
+end

data/app/views/layouts/endleaf.html.erb ADDED Viewed

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Endleaf</title>
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+  </head>
+  <body>
+    <p>Override this with app/views/layouts/endleaf.html.erb</p>
+    <%= yield %>
+  </body>
+</html>

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+  scope module: 'endleaf' do
+    get '/pages/:page', to: 'pages#show', as: :page
+  end
+end

data/lib/endleaf/engine.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Endleaf
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/endleaf/railtie.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Endleaf
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/endleaf/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Endleaf
+  VERSION = "0.1.0"
+end

data/lib/endleaf.rb ADDED Viewed

@@ -0,0 +1,6 @@
+require "endleaf/version"
+require "endleaf/engine"
+module Endleaf
+  # Your code goes here...
+end

data/lib/tasks/endleaf/render.rake ADDED Viewed

@@ -0,0 +1,38 @@
+namespace :endleaf do
+  namespace :render do
+    desc 'Render and save static pages as HTML'
+    task :generate_html => :environment do
+      # Include the necessary modules to access render_to_string
+      controller_path = 'endleaf/pages'
+      action_name = 'show'
+      # Create a controller instance
+      controller = ActionController::Base.new
+      controller.request = ActionDispatch::Request.new({})
+      # Set the controller path and action name
+      controller.params = { controller: controller_path, action: action_name }
+      # Define the directory containing your static pages within the engine
+      pages_directory = Rails.root.join('app', 'views', 'pages')
+      # Loop through each file in the pages directory
+      Dir.glob("#{pages_directory}/*.html.erb") do |file|
+        # Extract the filename without the directory and extension
+        filename = File.basename(file, '.html.erb')
+        # Render the page
+        html_content = controller.render_to_string(template: "pages/#{filename}", layout: 'endleaf')
+        # Define the path to save the HTML file in the public directory
+        save_path = Rails.root.join('public', "#{filename}.html")
+        # Save the rendered HTML to the file
+        File.write(save_path, html_content)
+        puts "Rendered and saved #{filename}.html"
+      end
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: endleaf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wittawas W
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description: Routing and utilities for static pages creation in Rails.
+email:
+- start@wittawasw.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/endleaf/pages_controller.rb
+- app/views/layouts/endleaf.html.erb
+- config/routes.rb
+- lib/endleaf.rb
+- lib/endleaf/engine.rb
+- lib/endleaf/railtie.rb
+- lib/endleaf/version.rb
+- lib/tasks/endleaf/render.rake
+homepage: https://github.com/wittawasw/endleaf
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wittawasw/endleaf
+  source_code_uri: https://github.com/wittawasw/endleaf
+  changelog_uri: https://github.com/wittawasw/endleaf
+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: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Routing and utilities for static pages creation in Rails.
+test_files: []

endleaf 0.1.0