rawfeed 0.3.1 → 1.0.0

data/lib/rawfeed/{resume.rb → content/resume.rb}

@@ -3,11 +3,11 @@
 require "colorize"
 require "fileutils"
 require "rubygems"
-require_relative "utils"
+require_relative "../core/utils"
 
 module Rawfeed
   class Resume
-    def self.resume_page_create
+    def self.restore_page
       Rawfeed::Utils.create_directory(Rawfeed::CONFIG['PAGES_DIR'])
       slug = "resume"
       filepath = File.join(Rawfeed::CONFIG['PAGES_DIR'], "#{slug}.#{CONFIG['markdown_extension']}")
@@ -27,9 +27,13 @@ module Rawfeed
         file.puts("---")
         file.puts("layout: resume")
         file.puts("author: # \"Your Name\"")
-        file.puts("order: 4")
         file.puts("title: Resume")
+        file.puts("order: 4")
+        file.puts("emoji: 📜")
+        file.puts("in_menu: true")
         file.puts("published: false")
+        file.puts("toc:")
+        file.puts("  enable: false")
         file.puts("permalink: /resume/")
         file.puts("---")
         file.puts("")
@@ -40,21 +44,21 @@ module Rawfeed
       puts "[!] Note: Remember to set \"published\" to \"true\" to publish.".yellow
 
     end
-    def self.resume_create
-      self.resume_page_create
-      Rawfeed::Utils.create_directory(Rawfeed::CONFIG['RESUME_DIR'])
-      spec = Gem::Specification.find_by_name("rawfeed")
-      theme_path = spec.gem_dir
-      src = File.join(theme_path, "_data", "resume.yml")
-      dest = File.join(Dir.pwd, Rawfeed::CONFIG['RESUME_DIR'])
-
-      if File.exist?(File.join(dest, "resume.yml"))
-        answer = Rawfeed::Utils.confirm("File #{File.join(dest, "resume.yml")} already exists. Do you want to overwrite?")
-        abort("Creation of #{File.join(dest, "resume.yml")} canceled by user!") if answer == 'n'
-      end
-      FileUtils.cp(src, dest)
-      puts "[*] Created #{File.join(dest, "resume.yml")} successfully!".green
-      puts "[!] Note: Configure your #{File.join(dest, "resume.yml")} settings".yellow
-    end
+    # def self.restore
+    #   self.restore_page
+    #   Rawfeed::Utils.create_directory(Rawfeed::CONFIG['RESUME_DIR'])
+    #   spec = Gem::Specification.find_by_name("rawfeed")
+    #   theme_path = spec.gem_dir
+    #   src = File.join(theme_path, "_data", "resume.yml")
+    #   dest = File.join(Dir.pwd, Rawfeed::CONFIG['RESUME_DIR'])
+
+    #   if File.exist?(File.join(dest, "resume.yml"))
+    #     answer = Rawfeed::Utils.confirm("File #{File.join(dest, "resume.yml")} already exists. Do you want to overwrite?")
+    #     abort("Creation of #{File.join(dest, "resume.yml")} canceled by user!") if answer == 'n'
+    #   end
+    #   FileUtils.cp(src, dest)
+    #   puts "[*] Created #{File.join(dest, "resume.yml")} successfully!".green
+    #   puts "[!] Note: Configure your #{File.join(dest, "resume.yml")} settings".yellow
+    # end
   end
 end

data/lib/rawfeed/{layout.rb → core/layout.rb}

@@ -21,7 +21,7 @@ module Rawfeed
     def self.home_blog
       file = "index.md"
       content = File.read(file)
-      updated = content.gsub(/^layout:\s*\S+$/, "layout: blog")
+      updated = content.gsub(/^layout:\s*\S+$/, "layout: blog/index")
       File.write(file, updated)
 
        puts "Home page changed to 'blog' successfully!".green

data/lib/rawfeed/core/utils.rb

@@ -0,0 +1,103 @@
+require "colorize"
+require "time"
+
+module Rawfeed
+  CONFIG = {
+    'DRAFTS_DIR' => File.join(".", "_drafts"),
+    'POSTS_DIR' => File.join(".", "_posts"),
+    'PIXELS_DIR' => File.join(".", "_pixels"),
+    'PAGES_DIR' => File.join(".", "_pages"),
+    'RESUME_DIR' => File.join(".", "_data"),
+    'CONFIG_YML' => File.join(".", "_config.yml"),
+    'markdown_extension' => "md"
+  }
+
+  # Utility methods for the Rawfeed framework.
+  # Provides helper functionality such as directory creation, slug generation,
+  # date formatting, user prompts, and file payload compilation.
+  class Utils
+    # Safely creates a directory if it does not already exist.
+    #
+    # @param path [String] The path of the directory to create.
+    # @return [void]
+    def self.create_directory(path)
+      unless File.directory?(path)
+        FileUtils.mkdir_p(path)
+        puts ":: Folder '#{path}', created!".green
+      end
+    end
+
+    # Generates a URL-friendly slug from a string.
+    # It converts the string to lowercase, strips whitespace, replaces spaces with
+    # hyphens, and removes any non-word characters (except hyphens).
+    #
+    # @param parameter [String] The input string to sluggify.
+    # @return [String] The generated slug.
+    def self.slug_generator(parameter)
+      parameter.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
+    end
+
+    # Generates a formatted datetime string.
+    # Uses the 'date' environment variable if present, otherwise uses the current time.
+    #
+    # @param parameter [String] The strftime formatting string.
+    # @return [String] The formatted time string.
+    def self.datetime_generator(parameter)
+      (ENV['date'] ? Time.parse(ENV['date']) : Time.now).strftime(parameter)
+    rescue ArgumentError
+      puts "[x] Error - date format must be YYYY-MM-DD, please check you typed it correctly!".red
+      exit 1
+    end
+
+    # Prompts the user for a Yes/No confirmation.
+    # Forces the user to input 'y' or 'n'.
+    #
+    # @param message [String] The message to display to the user.
+    # @return [String] Returns 'y' or 'n' based on user input.
+    def self.confirm(message)
+      print "#{message} [y/n]: ".blue
+      answer = STDIN.gets.chomp.downcase
+      until %w[y n].include?(answer)
+        print "[!] Please type 'y' or 'n': ".yellow
+        answer = STDIN.gets.chomp.downcase
+      end
+      answer
+    end
+
+    # Scaffolds a new content file (e.g., page, post) by asking the user for a title
+    # and generating the required slug and dates.
+    #
+    # @param directory [String] The directory where the file will be saved.
+    # @param message [String] The prompt message to ask the user for a title.
+    # @param type [String] The type of content ('page' or other for time-prefixed files).
+    # @return [Array<String>] An array containing [title, date, datetime, filename].
+    def self.engineer(directory, message, type)
+      self.create_directory(directory)
+      # abort("Rake aborted: #{directory} directory not found.") unless FileTest.directory?(directory)
+      begin
+        print "#{message}\n>>> ".blue
+        title = STDIN.gets.chomp
+      rescue Interrupt
+        puts "\n[!] Approached by the user".yellow
+        exit!
+      end
+
+      slug     = slug_generator(title)
+      date     = datetime_generator('%Y-%m-%d')
+      datetime = datetime_generator('%Y-%m-%d %R:%S')
+
+      if type == 'page'
+        filename = File.join(directory, "#{slug}.#{CONFIG['markdown_extension']}")
+      else
+        filename = File.join(directory, "#{date}-#{slug}.#{CONFIG['markdown_extension']}")
+      end
+
+      if File.exist?(filename)
+        answer = confirm("#{filename} already exists. Do you want to overwrite?")
+        abort("Action aborted by user!") if answer == 'n'
+      end
+
+      [title, date, datetime, filename]
+    end
+  end
+end

data/lib/rawfeed/{version.rb → core/version.rb}

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rawfeed
-  VERSION = "0.3.1"
+  VERSION = "1.0.0"
 end

data/lib/rawfeed/{datelang.rb → plugin/datelang.rb}

@@ -2,6 +2,7 @@
 require "json"
 require "date"
 require "jekyll"
+require "rawfeed/root"
 
 module Rawfeed
   module Datelang
@@ -14,21 +15,19 @@ module Rawfeed
       def render(context)
         site = context.registers[:site]
         page = context.registers[:page] || {}
-        options = site.data['options']
+        generic = site.data['generic']
 
-        locale = options.dig("datelang", "lang") || "en_US"
-
-        json_path = File.join(site.source, "assets", "json", "datelang.json")
-        json_path = File.expand_path("../../assets/json/datelang.json", __dir__) unless File.exist?(json_path)
+        json_path = File.join(Rawfeed::ROOT, "assets", "json", "datelang.json")
 
         return "[datelang error: datelang.json not found]" unless File.exist?(json_path)
 
         translations = JSON.parse(File.read(json_path))
+        locale = generic.dig("datelang", "lang") || "en_US"
         data = translations[locale] || translations["en_US"]
 
         args = parse_args(@markup, context)
         date_input = args[:date] || page["date"] || page[:date]
-        format = args[:format] || "%b %-d, %Y"
+        format = args[:format] || generic.dig("datelang", "format") || "%b %-d, %Y"
 
         return "[datelang: no date]" unless date_input && date_input.to_s.strip != ""
 

data/lib/rawfeed/{pub.rb → plugin/pub.rb}

@@ -1,7 +1,7 @@
 # pub.rb
 
 module Jekyll
-  # Define a página que será gerada dinamicamente para cada diretório
+  # Defines the page that will be dynamically generated for each directory.
   class DirectoryListingPage < Page
     def initialize(site, base, dir, files_and_dirs)
       @site = site
@@ -11,60 +11,62 @@ module Jekyll
       @layout_name = 'pub.html'
 
       self.process(@name)
-      theme_layouts = File.join(site.theme.root, "_layouts")
+      theme_root = site.theme&.root || File.join(site.source, "_layouts")
+      theme_layouts = File.join(theme_root, "_layouts")
       self.read_yaml(theme_layouts, "pub.html")
       # # Note: This is for _plugins/
       # self.read_yaml(File.join(base, '_layouts'), 'pub.html')
 
-      # Define o permalink correto para a página de índice
-      # Garante que 'pub/sub/index.html' tenha o permalink '/pub/sub/'
+      # Defines the correct permalink for the index page
+      # Ensures that 'pub/sub/index.html' has the permalink '/pub/sub/'
       self.data['permalink'] = "/#{dir}/"
 
-      # Título (opcional, pode ser formatado no layout)
+      # Title (optional, can be formatted in the layout)
       self.data['title'] = File.basename(dir).capitalize
 
-      # A MÁGICA: Injeta a lista de conteúdo no objeto da página
+      # THE MAGIC: Injects the content list into the page object.
       self.data['directory_contents'] = files_and_dirs
       self.data['layout'] = 'pub'
     end
   end
 
-  # O gerador que executa o escaneamento recursivo
+  # The generator that performs the recursive scan.
   class DirectoryListingGenerator < Generator
     safe true
     priority :normal
 
-    # Diretório principal que você deseja listar
+    # Main directory you want to list
     PUB_DIR = 'pub'
 
     def generate(site)
-      # Pega todos os arquivos e diretórios dentro de PUB_DIR
-      # Exclui o PUB_DIR raiz em si.
+      # Extracts all files and directories within PUB_DIR
+      # Deletes the root PUB_DIR itself.
       all_paths = Dir.glob("#{PUB_DIR}/**/{" + '*' + ",.*}")
 
-      # Itera sobre cada item encontrado e agrupa por diretório pai
+      # Iterates over each item found and groups by parent directory.
       directory_map = {}
 
       all_paths.each do |path|
-        # Ignora arquivos/diretórios que o Jekyll já processa ou ignora
-        next if path.start_with?('_') || path.start_with?('.')
-        next if File.basename(path) == 'index.html'
+        # It ignores files/directories that Jekyll already processes or ignores.
+        basename = File.basename(path)
+        next if basename.start_with?('_') || basename.start_with?('.')
+        next if basename == 'index.html'
 
-        # Determina o diretório pai (o que vai ter o index.html gerado)
+        # Specifies the parent directory (the one where the generated index.html file will be located).
         parent_dir = File.dirname(path)
         parent_dir = PUB_DIR if parent_dir == '.'
 
-        # Inicializa a lista se for a primeira vez
+        # Initialize the list if it's the first time.
         directory_map[parent_dir] ||= []
 
-        # Determina o tipo e prepara os dados
+        # It determines the type and prepares the data.
         if File.directory?(path)
-          # Se for um diretório, adiciona a barra final para URL
+          # If it's a directory, add the trailing slash for URL.
           type = 'directory'
           url = "/#{path}/"
           size = ''
           date = File.mtime(path)
-          # Adiciona apenas se o diretório não estiver vazio
+          # It only adds if the directory is not empty.
           directory_map[parent_dir] << {
             'name' => File.basename(path),
             'type' => type,
@@ -72,13 +74,13 @@ module Jekyll
             'date' => date
           } unless Dir.empty?(path)
         else
-          # Se for um arquivo
+          # If it's a file
           type = 'file'
           url = "/#{path}"
-          size = File.size(path) # Tamanho em bytes
+          size = File.size(path)
           date = File.mtime(path)
 
-          # Adiciona o item ao seu diretório pai
+          # Add the item to its parent directory.
           directory_map[parent_dir] << {
             'name' => File.basename(path),
             'type' => type,
@@ -89,25 +91,25 @@ module Jekyll
         end
       end
 
-      # Cria as páginas de listagem dinamicamente
+      # Creates listing pages dynamically.
       directory_map.each do |dir_path, contents|
-        # Classifica por tipo (diretórios primeiro), depois por nome
+        # Sort by type (directories first), then by name.
         sorted_contents = contents.sort_by do |item|
           [item['type'] == 'file' ? 1 : 0, item['name'].downcase]
         end
 
-        # Lógica para a entrada de navegação '..'
+        # Logic for the navigation input '..'
         parent_url = nil
         parent_name = '../'
 
         if dir_path == PUB_DIR
-          # Caso especial: se estiver na raiz 'pub/', o pai é a raiz do site '/'
+          # Special case: if it's in the root 'pub/', the parent is the root of the site '/'.
           parent_url = '/'
         else
-          # Para todos os outros subdiretórios (ex: pub/subpasta)
+          # For all other subdirectories (e.g. pub/subfolder)
           parent_dir = File.dirname(dir_path)
 
-          # Garante que 'pub' não se torne '.' e que o URL termine em barra
+          # Ensures that 'pub' doesn't become '.' and that the URL doesn't end in a slash.
           if parent_dir == PUB_DIR
             parent_url = "/#{PUB_DIR}/"
           else
@@ -115,14 +117,14 @@ module Jekyll
           end
         end
 
-        # Adiciona a entrada de navegação para o diretório pai
+        # Adds the navigation entry for the parent directory.
         sorted_contents.unshift({
           'name' => parent_name,
           'type' => 'parent',
           'url'  => parent_url
         })
 
-        # # Adiciona a página ".." para navegar de volta, exceto para o pub/ raiz
+        # # Adds the ".." page for back navigation, except for the pub/root directory.
         # unless dir_path == PUB_DIR
         #   parent_url = File.dirname(dir_path)
         #   parent_url = '/' if parent_url == '.'
@@ -135,7 +137,7 @@ module Jekyll
         #   })
         # end
 
-        # Cria a nova página e a adiciona ao site
+        # Create the new page and add it to the website.
         page = DirectoryListingPage.new(site, site.source, dir_path, sorted_contents)
         site.pages << page
       end

data/lib/rawfeed/{reading_time.rb → plugin/reading_time.rb}

@@ -4,10 +4,11 @@ module Rawfeed
   module ReadingTimeFilter
     def reading_time(input)
       site = Jekyll.sites.first rescue nil
-      options_data = site&.data&.dig("options") rescue {}
-      words_per_minute = options_data&.dig("reading_time", "words_per_minute") || 180
-      message = options_data&.dig("reading_time", "message") || ["Read this post in", "Read this post in less than"]
-      minutes_text = options_data&.dig("reading_time", "minutes_label") || ["minute", "minutes"]
+      # blog_data = site.data['screen', 'blog'] rescue {}
+      blog_data = site&.data&.dig("screen", "blog") rescue {}
+      words_per_minute = blog_data&.dig("post", "reading_time", "words_per_minute") || 180
+      message = blog_data&.dig("post", "reading_time", "message") || ["Read this post in", "Read this post in less than"]
+      minutes_text = blog_data&.dig("post", "reading_time", "minutes_label") || ["minute", "minutes"]
       words = input.split.size;
       minutes = ( words / words_per_minute ).floor
       minutes_label = minutes == 1 ? "#{minutes_text[0]}" : "#{minutes_text[1]}"

data/lib/rawfeed/root.rb

@@ -0,0 +1,3 @@
+module Rawfeed
+  ROOT = File.expand_path("../..", __dir__)
+end

data/lib/rawfeed.rb

@@ -1,17 +1,39 @@
 # frozen_string_literal: true
 # author: William C. Canin
 
-require_relative "rawfeed/version"
-require_relative "rawfeed/draft"
-require_relative "rawfeed/post"
-require_relative "rawfeed/page"
-require_relative "rawfeed/resume"
-require_relative "rawfeed/layout"
-require_relative "rawfeed/pixel"
-require_relative "rawfeed/author"
-require "rawfeed/datelang"
-require "rawfeed/reading_time"
-require "rawfeed/with_class"
-require "rawfeed/pub"
-# require "rawfeed/csp_filters"
-# require "rawfeed/typescript_liquid"
+# Core
+require_relative "rawfeed/core/version"
+require_relative "rawfeed/core/utils"
+require_relative "rawfeed/core/layout"
+require_relative "rawfeed/build"
+
+# Commands
+require_relative "rawfeed/command/installer"
+require_relative "rawfeed/command/cli"
+require_relative "rawfeed/command/backup"
+require_relative "rawfeed/command/tools"
+
+# Content Generators
+require_relative "rawfeed/content/author"
+require_relative "rawfeed/content/draft"
+require_relative "rawfeed/content/page"
+require_relative "rawfeed/content/donate"
+require_relative "rawfeed/content/contact"
+require_relative "rawfeed/content/licenses"
+require_relative "rawfeed/content/pixel"
+require_relative "rawfeed/content/post"
+require_relative "rawfeed/content/resume"
+
+# Jekyll Plugins (optional for CLI-only usage)
+begin
+  require "jekyll" unless defined?(Jekyll)
+rescue LoadError
+  # Keep CLI features available even when Jekyll is not installed.
+end
+
+if defined?(Jekyll)
+  require_relative "rawfeed/plugin/datelang"
+  require_relative "rawfeed/plugin/pub"
+  require_relative "rawfeed/plugin/reading_time"
+  require_relative "rawfeed/plugin/with_class"
+end

data/pixels/index.md

@@ -0,0 +1,11 @@
+---
+layout: pixels/index
+author: "William C. Canin"
+title: "Pixels"
+description: |
+  Here is my day to day life as a photographer
+published: true
+permalink: /pixels/
+---
+
+<!-- There is no need to put anything here -->

data/robots.txt

@@ -0,0 +1,26 @@
+# robots.tx default - Generated by rawfeed-jekyll
+# Note: Add other pages you create here in Allow.
+User-agent: *
+Allow: /
+Allow: /blog/
+Allow: /contact/
+Allow: /donate/
+Allow: /licenses/
+Allow: /pixels/
+Allow: /resume/
+
+# Block system files and licenses
+Disallow: /LICENSE
+Disallow: /README.md
+Disallow: /CNAME
+Disallow: /feed.xml
+
+# Block assets that do not need to be indexed individually.
+Disallow: /assets/js/
+Disallow: /assets/css/
+
+# Prevent indexing of error pages.
+Disallow: /404.html
+
+# Change the URL to your website's sitemap.xml.
+Sitemap: http://your_website_URL/sitemap.xml