jekyll_file_wizard 0.1.0

data/examples/data_integration_example/data_integration_example.md

@@ -0,0 +1,86 @@
+# Data Integration Examples for JekyllFileWizard
+
+This folder contains examples demonstrating how JekyllFileWizard can be used to integrate data from Jekyll's `_data` directory into various sections of a website.
+
+## Example 1: Team Members Page
+
+**Scenario**: You want to create a "Team" page that dynamically populates information about each team member from a YAML file in the `_data` directory.
+
+### Steps:
+
+1. **Data File**:
+   - Location: `_data/team.yml`
+   - Content: YAML structure containing details of team members (name, role, bio, image, etc.).
+
+2. **Team Template**:
+   - File: `team_section.html`
+   - Content: HTML template for the team section with Liquid placeholders for team data.
+
+3. **Configuration File** (`config.yml`):
+   ```yaml
+   updates:
+     - target: "about/team.html"
+       template: "team_section.html"
+       data_file: "team.yml"
+   ```
+
+4. **Run JekyllFileWizard**:
+   ```bash
+   jekyll_file_wizard
+   ```
+
+## Example 2: Product Catalog
+
+**Scenario**: Automatically generate a product catalog page using product data stored in a YAML file.
+
+### Steps:
+
+1. **Data File**:
+   - Location: `_data/products.yml`
+   - Content: YAML structure with details of products (name, description, price, image, etc.).
+
+2. **Product Catalog Template**:
+   - File: `product_catalog.html`
+   - Content: HTML template for displaying products with Liquid placeholders for product data.
+
+3. **Configuration File** (`config.yml`):
+   ```yaml
+   updates:
+     - target: "products/index.html"
+       template: "product_catalog.html"
+       data_file: "products.yml"
+   ```
+
+4. **Run JekyllFileWizard**:
+   ```bash
+   jekyll_file_wizard
+   ```
+
+## Example 3: Client Testimonials
+
+**Scenario**: Populate a testimonials section on your site using data from a YAML file.
+
+### Steps:
+
+1. **Data File**:
+   - Location: `_data/testimonials.yml`
+   - Content: YAML structure containing client testimonials (client name, testimonial text, image, etc.).
+
+2. **Testimonials Template**:
+   - File: `testimonials_section.html`
+   - Content: HTML template for displaying testimonials with Liquid placeholders for testimonials data.
+
+3. **Configuration File** (`config.yml`):
+   ```yaml
+   updates:
+     - target: "index.html"
+       template: "testimonials_section.html"
+       data_file: "testimonials.yml"
+   ```
+
+4. **Run JekyllFileWizard**:
+   ```bash
+   jekyll_file_wizard
+   ```
+
+These examples illustrate the powerful data integration capabilities of JekyllFileWizard, allowing for dynamic content generation and easy updates to your Jekyll site. By leveraging YAML data files, you can create more dynamic and maintainable site sections, such as team pages, product catalogs, and client testimonials.

data/jekyll_file_wizard.gemspec

@@ -0,0 +1,28 @@
+# JekyllFileWizard.gemspec
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll_file_wizard"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Thaddeus Thomas"]
+  spec.email         = ["thaddeus.r.thomas@gmail.com"]
+
+  spec.summary       = "Automate and enhance Jekyll site file management and updates with JekyllFileWizard."
+  spec.description   = <<-DESC
+JekyllFileWizard is a comprehensive gem designed to streamline the management and dynamic updating of Jekyll site structures. It automates the process of checking, creating, and updating various files in a Jekyll project, including HTML files, data files, and more. The gem offers features like dynamic HTML structure handling, integration with Jekyll's data files, template management, robust error handling, an interactive command-line interface, and automated testing and validation. It's ideal for Jekyll site developers looking to enhance their site's functionality and maintainability, making it easier to manage large and complex Jekyll sites.
+DESC
+  spec.homepage      = "https://visionary-code-works.github.io/JekyllFileWizard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Specify dependencies:
+  spec.add_runtime_dependency "nokogiri", "~> 1.11"
+  # Add other dependencies here
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  # Add other development dependencies here
+end

data/lib/jekyll_file_wizard/configuration.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+module JekyllFileWizard
+  class Configuration
+    attr_accessor :sections_to_update, :feature_toggles
+
+    def initialize
+      # Default values
+      @sections_to_update = []
+      @feature_toggles = {}
+    end
+
+    def load_from_file(file_path)
+      if File.exist?(file_path)
+        config = YAML.load_file(file_path)
+
+        @sections_to_update = config['sections_to_update'] if config['sections_to_update']
+        @feature_toggles = config['feature_toggles'] if config['feature_toggles']
+      else
+        raise "Configuration file not found at #{file_path}"
+      end
+    end
+
+    def apply_command_line_options(options)
+      # Assuming options is a hash with keys as configuration attributes
+      options.each do |key, value|
+        send("#{key}=", value) if respond_to?("#{key}=")
+      end
+    end
+  end
+end

data/lib/jekyll_file_wizard.rb

@@ -0,0 +1,42 @@
+require 'nokogiri'
+require 'jekyll_file_wizard/configuration'
+
+class JekyllFileWizard
+  def initialize(index_path)
+    @index_path = index_path
+    @doc = parse_index_html
+  end
+
+  def parse_index_html
+    html = File.read(@index_path)
+    Nokogiri::HTML(html)
+  end
+
+  def update_section(identifier, new_content)
+    section = find_section(identifier)
+    return unless section
+
+    section.inner_html = new_content
+    save_changes
+  end
+
+  private
+
+  def find_section(identifier)
+    # This can be an ID, class, or any other attribute
+    # Adjust the logic here based on how you want to identify sections
+    if identifier[:id]
+      @doc.at_css("##{identifier[:id]}")
+    elsif identifier[:class]
+      @doc.at_css(".#{identifier[:class]}")
+    elsif identifier[:tag]
+      @doc.at_css(identifier[:tag])
+    else
+      nil
+    end
+  end
+
+  def save_changes
+    File.open(@index_path, 'w') { |file| file.write(@doc.to_html) }
+  end
+end

data/lib/main.rb

@@ -0,0 +1,23 @@
+require_relative 'jekyll_file_wizard'
+require_relative 'configuration'
+
+module JekyllFileWizard
+  class Main
+    def initialize(config_path, html_file_path)
+      @config = Configuration.new
+      @config.load_from_file(config_path)
+      @jekyll_wizard = JekyllFileWizard.new(html_file_path)
+    end
+
+    def update_html_structure
+      @config.sections_to_update.each do |section|
+        identifier = section['identifier']
+        new_content = section['content']
+
+        @jekyll_wizard.update_section(identifier, new_content)
+      end
+    end
+
+    # Other methods as needed
+  end
+end

data/templates/blog_section.html

@@ -0,0 +1,4 @@
+<section class="blog-section">
+    <h2>Latest Blog Posts</h2>
+    <!-- Blog posts will be inserted here -->
+</section>

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_file_wizard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thaddeus Thomas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-12-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 'JekyllFileWizard is a comprehensive gem designed to streamline the management
+  and dynamic updating of Jekyll site structures. It automates the process of checking,
+  creating, and updating various files in a Jekyll project, including HTML files,
+  data files, and more. The gem offers features like dynamic HTML structure handling,
+  integration with Jekyll''s data files, template management, robust error handling,
+  an interactive command-line interface, and automated testing and validation. It''s
+  ideal for Jekyll site developers looking to enhance their site''s functionality
+  and maintainability, making it easier to manage large and complex Jekyll sites.
+
+  '
+email:
+- thaddeus.r.thomas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".vscode/settings.json"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/jekyll_file_wizard
+- docs/advanced_features.md
+- docs/api_reference.md
+- docs/configuration.md
+- docs/examples.md
+- docs/getting_started.md
+- docs/troubleshooting.md
+- docs/usage.md
+- examples/advanced_example/advanced_examples.md
+- examples/basic_example/basic_example.md
+- examples/config.yml
+- examples/data_integration_example/data_integration_example.md
+- jekyll_file_wizard.gemspec
+- lib/jekyll_file_wizard.rb
+- lib/jekyll_file_wizard/configuration.rb
+- lib/jekyll_file_wizard/data_integrator.rb
+- lib/jekyll_file_wizard/html_updater.rb
+- lib/jekyll_file_wizard/version.rb
+- lib/main.rb
+- templates/blog_section.html
+homepage: https://visionary-code-works.github.io/JekyllFileWizard
+licenses:
+- MIT
+metadata: {}
+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.22
+signing_key: 
+specification_version: 4
+summary: Automate and enhance Jekyll site file management and updates with JekyllFileWizard.
+test_files: []