endleaf 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b87bcf46951a064d0f7096c84934fa9b5a59b7a3027c97b68e4ae24b7262ede
-  data.tar.gz: ba5ed3ff9cff7c16113e91ce28f0e7c5daf222f24b90307a79d8fe805a84ef6e
+  metadata.gz: 90f0e34500f5b54264548be3dcc719321a373698836ab9e4947895f76525ec7e
+  data.tar.gz: 786a0759dc2c2dc0d685bfb94e9adc560476a86aeb25240b9d5add113b64a3f6
 SHA512:
-  metadata.gz: 80bd03da2778c6aa1f3506c806974ba0c055185deea8fee2c16763b1c0d034b88d367d5f1aa7ccee109f7f9470525a07a0b966c270bbf4815ebe07524c1e4544
-  data.tar.gz: 231eab7930780dcf295dbcb531f05ce2486e41ba6cfbefa9ae0b9ba25845c9c3023db47b6b4d8667f7497b6d40037f9a3e21c3e5d4548b67c856e6ce9436c657
+  metadata.gz: 4304bce0e6ccd3d3e56f272b948d2dbf8ef7de06c016f25452ee9994ad494450222be0214dae79e9000bec431737dc7a08af753e60a9f3d52dfc785a2c8f87fd
+  data.tar.gz: 3353e33205c82259354930e068d08d6c54e7f9e3baee42860151e2980393b19ec4497e35c6d0a185be323362fab01ea29522337befa0834d6c1b54ed1f6945bd

data/README.md

@@ -10,14 +10,27 @@ gem "endleaf"
 
 ## Usage
 - Use with Ruby on Rails only.
+- Create pages in `app/views/pages` with filenames corresponding to their routes.
 - Add routes to `config/routes.rb`
 
 ```ruby
+# Simple usage
 scope module: 'endleaf' do
   get '/pages/:page', to: 'pages#show', as: :page
 end
+
+# Use scope and constraints to achieve routes into sub directories
+scope "/pages", constraints: { path: /pages\/.*/ } do
+  get "*page", to: "endleaf/pages#show"
+end
+
+# With custom path and layout
+# path:   app/views/posts
+# layout: app/views/layouts/posts.html.erb
+scope "/posts", constraints: { path: /posts\/.*/ } do
+  get "*page", to: "endleaf/pages#show", as: :endleaf_posts_post, defaults: { path: "posts", layout: "posts" }
+end
 ```
-- Create pages in `app/views/pages` with filenames corresponding to their routes.
 
 ```ruby
 # can be used in specific routes e.g. homepage
@@ -32,6 +45,14 @@ get  'endleaf/pages#show' , page: 'about'
 
 ```shell
 bundle exec rake endleaf:render:generate_html
+
+# custom path, layout, output with variables [path,layout,output]
+# Example:
+# path: app/views/posts
+# layout: app/views/layouts/posts.html.erb
+# output: public/static/posts
+ bundle exec rake endleaf:render:generate_html\[posts,posts,static\/posts\]
+
 ```
 
 

data/app/controllers/endleaf/pages_controller.rb

@@ -3,13 +3,32 @@ module Endleaf
     before_action :set_layout
 
     def show
-      render template: "pages/#{params[:page]}"
+      path_segments = params[:page].split('/')
+      view_path = path_segments.join('/')
+
+      render template: "#{path}/#{view_path}"
     end
 
     private
 
     def set_layout
-      self.class.layout('endleaf')
+      self.class.layout(page_layout)
+    end
+
+    def page_layout
+      unless params[:layout].blank?
+        params[:layout]
+      else
+        Endleaf::Config::DEFAULT_LAYOUT
+      end
+    end
+
+    def path
+      unless params[:path].blank?
+        params[:path]
+      else
+        Endleaf::Config::DEFAULT_PATH
+      end
     end
   end
 end

data/lib/endleaf/config.rb

@@ -0,0 +1,6 @@
+module Endleaf
+  module Config
+    DEFAULT_LAYOUT = "endleaf".freeze # Default layout
+    DEFAULT_PATH   = "pages".freeze # Default path
+  end
+end

data/lib/endleaf/version.rb

@@ -1,3 +1,3 @@
 module Endleaf
-  VERSION = "0.1.1"
+  VERSION = "0.3.0".freeze
 end

data/lib/endleaf.rb

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

data/lib/tasks/endleaf/render.rake

@@ -1,13 +1,17 @@
 namespace :endleaf do
   namespace :render do
-    desc 'Render and save static pages as HTML'
+    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'
+    task :generate_html, [:path, :layout, :output] => :environment do |t, args|
+      # Manually set the controller path and action name
+      controller_path = "endleaf/pages"
+      action_name = "show"
+
+      # Set static pages directory and layout
+      page_path = args[:path]   || Endleaf::Config::DEFAULT_PATH
+      layout    = args[:layout] || Endleaf::Config::DEFAULT_LAYOUT
+      output    = args[:output].to_s
 
-      # Create a controller instance
       controller = ActionController::Base.new
       controller.request = ActionDispatch::Request.new({})
 
@@ -15,23 +19,42 @@ namespace :endleaf do
       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')
+      pages_directory = Rails.root.join("app", "views", page_path)
+
+      # Supported template extensions
+      template_extensions = %w[html.erb erb html.haml haml html.slim slim]
+
+      puts "#{pages_directory}/**/*.{#{template_extensions.join(',')}}"
 
-      # 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')
+      # Loop through each file in the pages directory and subdirectories
+      Dir.glob("#{pages_directory}/**/*.{#{template_extensions.join(',')}}") do |file|
+        # Extract the relative path from the pages directory
+        relative_path = Pathname.new(file).relative_path_from(pages_directory).to_s
 
-        # Render the page
-        html_content = controller.render_to_string(template: "pages/#{filename}", layout: 'endleaf')
+        # Extract the filename without the extension
+        filename = File.basename(file, '.*')
+
+        # Construct the absolute path to the template file
+        template_path = "#{page_path}/#{relative_path.sub(/\.(#{template_extensions.join('|')})$/, '')}"
+        puts "template: #{template_path}"
+
+        # Render the page using the controller's render_to_string method
+        html_content = controller.render_to_string(
+          template: template_path,
+          layout: layout
+        )
 
         # Define the path to save the HTML file in the public directory
-        save_path = Rails.root.join('public', "#{filename}.html")
+        # Modify save_path logic to generate 'example/index.html' format
+        save_path = Rails.root.join('public', output, "#{relative_path.sub(/\.html\.erb$/, '')}/index.html")
+
+        # Create directories if they don't exist
+        FileUtils.mkdir_p(File.dirname(save_path))
 
         # Save the rendered HTML to the file
         File.write(save_path, html_content)
 
-        puts "Rendered and saved #{filename}.html"
+        puts "Rendered and saved #{save_path}"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endleaf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Wittawas W
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -37,6 +37,7 @@ files:
 - app/controllers/endleaf/pages_controller.rb
 - app/views/layouts/endleaf.html.erb
 - lib/endleaf.rb
+- lib/endleaf/config.rb
 - lib/endleaf/engine.rb
 - lib/endleaf/railtie.rb
 - lib/endleaf/version.rb
@@ -47,7 +48,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/wittawasw/endleaf
   source_code_uri: https://github.com/wittawasw/endleaf
-  changelog_uri: https://github.com/wittawasw/endleaf
+  changelog_uri: https://github.com/wittawasw/endleaf/blob/main/changelog.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -63,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.4.20
 signing_key: 
 specification_version: 4
 summary: Routing and utilities for static pages creation in Rails.