Justicar 0.1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 408dfbb73b156132cf179a3f64fa235ef7b9075f5f3742e1245b6ebdb2a1e12f
-  data.tar.gz: c39d1918d45a312c9ad4c05edcc4dcca5ef2de37e286d7a3621f38925289ec28
+  metadata.gz: 85d3d8d716701511ea15be92cdc99a55072a43f2b4f5f755eb43d904653f63ae
+  data.tar.gz: cf17e0bfc411d56b09e2f62dc9ba8191fffda95ba2a622a0dd0f70b362bb67d5
 SHA512:
-  metadata.gz: 3398a9b7c42ad27cf586671e3c24d93c1affcdceb21d4905129e80755b9e79fb7790ae846bab0434d9e5de2493c1f2db474604c47975c2de7c8d8762eff45d69
-  data.tar.gz: ccf19ce74161fcedad9b5a7f505c1e2bc6eea525d3205e4df7c754cf60fda081026e70031691565bedc958310865c0da47982fcba2eb01e6fef6acdbcbc49fe0
+  metadata.gz: 22f6291626fb0f9bcf24424b618bf2c3d9bf5313ee82b149701f0ae60cf01c2c5f193190e26c3f2c90514f8cb43e3d78542548fbeb3c8a7d6a09b36f7b7981a0
+  data.tar.gz: ca15c21f90c17c5977f2fa69f20716999bf6c16a534ba5466f84776b87be9070a746dbdf51de75ceca172f0d397066b4bcdb0a88efb5887ae6a45a1e372982e2

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## [Unreleased]
+## [1.0.1] - 2022-04-22
+- Updated the template's Gemfile
+
+## [1.0.0] - 2022-04-22
+- Added processing feature
+- Updated template to showcase processing
+
+## [0.1.1] - 2022-04-21
+
+- Better template
+- Cleanup some print statements
+- Logos and prettified readme
 
 ## [0.1.0] - 2022-04-20
 

data/Justicar.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|logo|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
   spec.bindir = "exe"

data/README.mdown

@@ -1,5 +1,10 @@
+ <img src="https://github.com/realtradam/Justicar/blob/master/template/public/justicar.png?raw=true" height="280" alt="Justicar"/>
+
 # Justicar
 
+[![MIT License](https://img.shields.io/github/license/realtradam/Justicar?style=flat)](https://github.com/realtradam/Justicar/blob/master/LICENSE.txt)
+[![Ko-Fi](https://img.shields.io/static/v1?message=Buy%20me%20a%20coffee&logo=kofi&labelColor=ff5e5b&color=434B57&logoColor=white&label=%20)](https://ko-fi.com/tradam)
+
 A Ruby obsessed static website generator that does web development Justice!
 
 ## Installation
@@ -20,25 +25,28 @@ $ rake build # <- generates the website
 $ rake serve # <- locally host the project
 ```
 
-### How it works:
-
-#### Source Dir:
-
-HTML and CSS gets compiled using Paggio while Js gets compiled using Opal.
+### How it works when your run `rake serve`:
 
-#### Public Dir:
+1. Preprocess special files in Source Dir
+2. Process remaining files in Source Dir
+3. Copy Public Dir to Build Dir
+4. Write the Source Hash into Build Dir
+	- Note this can cause the Source Hash to overwrite files copied from the Public Dir
 
-This is where static non-generated files go such as Images.
+### File types
 
-#### Build Dir:
+##### `.html.rb, .css.rb`
+These files are executed and the resulting string gets saved in a file using its respective relative path as well as using its filename(sans the `.rb`) as the resulting file's name
 
-Build is where your generated site gets exported to.
+##### `.js.rb`
+These files get read and passed into the Opal parser to generate the resulting javascript. This gets saved in a file similiarly as `html.rb` files.
 
-## Development
+##### `.pre.rb`
+These are files that are executed before the file generation phase but do not get written anywhere. Here you should create a proc and store it in `Justicar::PreProcessor` (see sample project for an example). These are files generally used for templates or articles where you want a table of contents.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+##### `.post.rb`
+These are files that are executed during the file generation phase but do not themselves get written anywhere. These files are generally used for programmatically generating multiple files (such as creating a bunch of article pages stored in the preprocessor). See sample project for an example.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/Justicar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Justicar
-  VERSION = "0.1.0"
+  VERSION = "1.0.1"
 end

data/lib/Justicar.rb

@@ -3,16 +3,20 @@
 require_relative "Justicar/version"
 require "paggio"
 require "opal"
+require "ostruct"
 
 class Justicar
   class << self
 
-    def load_templates(dir)
-      Dir.each_child(dir) do |file|
-        if File.directory? "#{dir}/#{file}"
-          self.load_templates "#{dir}/#{file}"
+    def load_preprocessors(dir)
+      Dir.each_child(dir) do |full_file_name|
+        file_name, extension, _rb = full_file_name.split('.')
+        if File.directory?("#{dir}/#{full_file_name}")
+          self.load_preprocessors("#{dir}/#{full_file_name}")
         else
-          load "#{dir}/#{file}"
+          if ['pre'].include? extension
+            load "#{dir}/#{full_file_name}"
+          end
         end
       end
     end
@@ -28,14 +32,21 @@ class Justicar
       Dir.each_child(dir) do |full_file_name|
         file_name, extension, _rb = full_file_name.split('.')
         if File.directory?("#{dir}/#{full_file_name}")
-          target[full_file_name] = {}
+          target[full_file_name] ||= {}
           self.build_source("#{dir}/#{full_file_name}", target[full_file_name])
         else
+          # single html and css files
           if ['html', 'css'].include? extension
             File.open("#{dir}/#{full_file_name}", 'r') do |file|
               target[full_file_name] = instance_eval(file.read)
             end
-          elsif extension == 'js'
+            # does "post processing" and lets you execute custom code depending on preprocessing
+          elsif ['post'].include? extension
+            File.open("#{dir}/#{full_file_name}", 'r') do |file|
+              # use dir and target
+              instance_eval(file.read)
+            end
+          elsif ['js'].include? extension
             opl_file, _dot, _extension = full_file_name.partition('.')
             opl_file = "#{"#{dir}/".partition('/').last}#{opl_file}"
             target[full_file_name] = opl.build(opl_file).to_s
@@ -44,7 +55,7 @@ class Justicar
       end
     end
 
-    def build(target_dir, public_dir, hash = self.output)
+    def build_initialize(target_dir, public_dir, hash = self.output)
       if Dir.exist? target_dir
         FileUtils.rm_r target_dir
       end
@@ -53,22 +64,28 @@ class Justicar
       else
         FileUtils.mkdir target_dir
       end
+      build(target_dir, public_dir, hash)
+    end
+
+    def build(target_dir, public_dir, hash = self.output)
       hash.each do |key, val|
-        puts "key: #{key}, val: #{val}"
         if val.is_a? String
           file_name, type, _rb = key.to_s.split('.')
-          puts "filename: #{file_name}, type: #{type}"
           File.open("#{target_dir}/#{file_name}.#{type}", "w") do |file|
             file.write(val)
           end
         else
-          unless Dir.exist? "#{target_dir}/#{key}"
-            FileUtils.mkdir "#{target_dir}/#{key}"
-          end
-          self.build("#{target_dir}/#{key}", hash)
+          ensure_dir "#{target_dir}/#{key}"
+          self.build("#{target_dir}/#{key}", public_dir, hash[key])
         end
       end
-      puts File.expand_path(File.dirname(__FILE__))
+    end
+
+    def ensure_dir(dir)
+      unless Dir.exist? dir
+        FileUtils.mkdir dir
+      end
+      File.directory? dir
     end
 
     def output
@@ -83,4 +100,6 @@ class Justicar
 
   end
 
+  PreProcessor = OpenStruct.new
+
 end

data/template/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "webrick", "~> 1.7"
+
+gem "opal-browser", "~> 0.3.3"
+
+gem "Justicar", "~> 1.0.1"
+
+gem "rake", "~> 13.0"

data/template/Rakefile

@@ -3,8 +3,9 @@ require 'opal-browser'
 
 desc "Build your website"
 task :build do
+  Justicar.load_preprocessors('src')
   Justicar.build_source('src')
-  Justicar.build('build', 'public')
+  Justicar.build_initialize('build', 'public')
 end
 
 desc "Create a server and open your site in your browser"

data/template/src/articles/crab.pre.rb

@@ -0,0 +1,8 @@
+Justicar::PreProcessor.articles ||= {} # ensure the has exists
+
+# assign the result to a hash to be generated later
+Justicar::PreProcessor.articles["crab.html"] = Paggio.html! do
+  h2 do
+    "This is an article about CRABS!"
+  end
+end

data/template/src/articles/fish.pre.rb

@@ -0,0 +1,8 @@
+Justicar::PreProcessor.articles ||= {} # ensure the has exists
+
+# assign the result to a hash to be generated later
+Justicar::PreProcessor.articles["fish.html"] = Paggio.html! do
+  h2 do
+    "This is an article about FISH!"
+  end
+end

data/template/src/articles/index.post.rb

@@ -0,0 +1,28 @@
+# note: `target` will always be relative to the current directory for
+# postprocessor files
+
+# this generates all of our preprocessed articles we stored
+# note: you need to use the param `|_|` for paggio to allow us
+#       to use local variables in the proc
+Justicar::PreProcessor.articles.each do |key, val|
+  target[key] = Paggio.html do |_|
+    _.html do
+      val
+    end
+  end
+end
+
+# this creates the articles page which contains links to
+# all of our articles
+target["index.html"] = Paggio.html do |_|
+  _.html do
+    _.h1 do
+      'Here is a list of all the articles!'
+    end
+    Justicar::PreProcessor.articles.each do |key, val|
+      _.p do
+        _.a.articles(href: "#{key}") { key.delete_suffix('.html').upcase + "!" }
+      end
+    end
+  end
+end

data/template/src/articles/lion.pre.rb

@@ -0,0 +1,8 @@
+Justicar::PreProcessor.articles ||= {} # ensure the has exists
+
+# assign the result to a hash to be generated later
+Justicar::PreProcessor.articles["lion.html"] = Paggio.html! do
+  h2 do
+    "This is an article about LIONS!"
+  end
+end

data/template/src/index.html.rb

@@ -1,6 +1,8 @@
 Paggio.html do
   script type: "text/javascript", src: "script.js"
   link rel: "stylesheet", href: "style.css"
+  link rel: 'icon', type: 'image/x-icon', href: 'favicon.ico'
+  img.justicar(src: '/justicar.png', alt: 'Justicar', height: '400px')
   h1 { "Hello world from Justicar" }
   hr
   h2.paggio do

data/template/src/script.js.rb

@@ -9,5 +9,11 @@ $document.ready do
       "Hello World from Opal!"
     end
     p.opal {"This part was generated by Opal from Javascript (:"}
+    h2.articles do
+      "Here is some articles that were generated using the processing system:"
+    end
+    p.articles do 
+      a(href: '/articles').articles { "Articles" }
+    end
   end.append_to($document.body)
 end

data/template/src/style.css.rb

@@ -1,4 +1,17 @@
 Paggio.css do
+  rule 'body' do
+    height 100.vh
+  end
+
+  rule '.justicar' do
+    top 134.px
+    left 400.px
+    opacity 0.7
+    position 'absolute'
+    width 400.px
+    height 'auto'
+  end
+
   rule '.opal' do
     color :dodgerblue
   end
@@ -7,6 +20,11 @@ Paggio.css do
     color :goldenrod
   end
 
+  rule '.articles' do
+    color :limegreen
+    max width: 400.px
+  end
+
   rule 'h1' do
     font style: :italic
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: Justicar
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - _Tradam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-21 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paggio
@@ -71,7 +71,14 @@ files:
 - lib/Justicar.rb
 - lib/Justicar/version.rb
 - sig/Justicar.rbs
+- template/Gemfile
 - template/Rakefile
+- template/public/favicon.ico
+- template/public/justicar.png
+- template/src/articles/crab.pre.rb
+- template/src/articles/fish.pre.rb
+- template/src/articles/index.post.rb
+- template/src/articles/lion.pre.rb
 - template/src/index.html.rb
 - template/src/script.js.rb
 - template/src/style.css.rb