Justicar 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b22adc821ecbac4e53ae63316017a6098442d2d5322a55b62499e6abadc1ca0
-  data.tar.gz: ce181785fe42f0176369dc9f25ee8fffa3e330d82d7575ab9971a00fab66df4e
+  metadata.gz: 55c8b42fbd2198f01391f1237b4dc15e5acf89954692873f634467ff9179a439
+  data.tar.gz: c03016ed7a911179be462872b6b6f1cd766676e30b23cb6fd607bab42533931d
 SHA512:
-  metadata.gz: 3b77f4efe139580d9d3b4899067364f54d50c1ac44e9c4424dc71c49e179042dce33a1d5ff2915eb60629f83afd1853cbcf11155afb6420de6f1b1c38cbaaced
-  data.tar.gz: 2b550a0eb34ad79807eb03a12819e9f64ebc175be3ef57208e367ee4e76ce96f8d5cd1a1c5141f3cf349dfa7d3d15eda3ae1e354c041fb1988cb96371eb8e4e5
+  metadata.gz: 9144011fa2a1f37e7c9c8aa8294e4e7d1d355ad8a065da791bbc766b8cbdabff9863705921df553217b303b81e6a880123162f562f1835834f250f3026cb7e5f
+  data.tar.gz: d1606efa29997c3c8a31acedc8a31d2bfc9bbbc089378e7662116034815c29e521c62f5681452b39d727dfae74f4fa051db7ba9ad6662eb0d7bca5820d552d00

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## [1.0.0] - 2022-04-22
+- Added processing feature
+- Updated template to showcase processing
 
 ## [0.1.1] - 2022-04-21
 

data/README.mdown

@@ -1,4 +1,4 @@
- ![Justicar](https://github.com/realtradam/Justicar/blob/master/template/public/justicar.png?raw=true)
+ <img src="https://github.com/realtradam/Justicar/blob/master/template/public/justicar.png?raw=true" height="280" alt="Justicar"/>
 
 # Justicar
 
@@ -25,25 +25,28 @@ $ rake build # <- generates the website
 $ rake serve # <- locally host the project
 ```
 
-### How it works:
+### How it works when your run `rake serve`:
 
-#### Source Dir:
+1. Preproces 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
 
-HTML and CSS gets compiled using Paggio while Js gets compiled using Opal.
+### File types
 
-#### Public 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
 
-This is where static non-generated files go such as Images.
+##### `.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.
 
-#### Build Dir:
+##### `.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.
 
-Build is where your generated site gets exported to.
+##### `.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.
 
-## Development
-
-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.
-
-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.1"
+  VERSION = "1.0.0"
 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,6 +64,10 @@ 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|
         if val.is_a? String
           file_name, type, _rb = key.to_s.split('.')
@@ -60,14 +75,19 @@ class Justicar
             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
     end
 
+    def ensure_dir(dir)
+      unless Dir.exist? dir
+        FileUtils.mkdir dir
+      end
+      File.directory? dir
+    end
+
     def output
       @output ||= {}
     end
@@ -80,4 +100,6 @@ class Justicar
 
   end
 
+  PreProcessor = OpenStruct.new
+
 end

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

@@ -2,7 +2,7 @@ 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')
+  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

@@ -5,7 +5,7 @@ Paggio.css do
 
   rule '.justicar' do
     top 134.px
-    left 360.px
+    left 400.px
     opacity 0.7
     position 'absolute'
     width 400.px
@@ -20,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.1
+  version: 1.0.0
 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
@@ -75,8 +75,11 @@ files:
 - template/Gemfile.lock
 - template/Rakefile
 - template/public/favicon.ico
-- template/public/favicon.png
 - 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