soy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6bd54fbe6410b42d75c37e02b1b31650bb7fd14b41535425b08d9c745b35318
-  data.tar.gz: 2108d0d1526adf9e96830f6ec4fb187653c896793f1ea5ac69ea4da85541d483
+  metadata.gz: 51bbd538a472a9b4acac80fdeeadd43397a36b152bcf6634e08e623afc11ff3d
+  data.tar.gz: 6e0828e7e44d5d462f5072d5851cd4251f59c2bc81627a0564760dbc9f948539
 SHA512:
-  metadata.gz: 06bb73badd9937a74e7f452fe282c3497a1471bc144ec17106bd49d4f080746fa512ab59862e5504cbc7d650913fe87c5c54b27a6f0ed8e6495dfdbc04cce0d7
-  data.tar.gz: e6ae9aad16345d5e04bc3bc6d2736e87633ae45bdbbb43ee6dae9c4c585eff987a71f0375e6230ec37e10fa06035aa3f6265b8e954abcb6d759dfb518ef94d51
+  metadata.gz: 826df4c995a9addc89897d214d6ff59af353112924383cbc483c34d2bb992848beeb068753d1641ef086383aeda7b491c673c524fca1a3a656333974226be1c9
+  data.tar.gz: 831cf3ef9042b417206985fe827a9cff379caef2e993c790d0ce68335ec28c9c4d4cfdad880074322936178dfa97d4e18bcc05bceb45bf4d7dafe6a5e853cc41

data/.rubocop.yml

@@ -28,5 +28,18 @@ RSpec/MultipleExpectations:
   Enabled: false
 
 RSpec/ExampleLength:
+  Max: 20
   Exclude:
     - "spec/system/**/*_spec.rb"
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/NestedGroups:
+  Max: 5
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+
+RSpec/ReturnFromStub:
+  EnforcedStyle: block

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.2.0] - 2022-03-06
+
+- Adds support for ingesting Markdown and outputting HTML
+- Adds support for `.erb`-less HTML and Markdown file names while still processing with ERB
+- Adds support for extension-less path serving in `soy server`
+- Changes default port from Puma's default 9292 to 4848
+- Adds support for `--port` flag with `soy server`, example: `soy server --port 4200` to run local server on another port
+- Adds ability to process content nested within folders
+
 ## [0.1.0] - 2022-03-03
 
 - Initial release

data/README.md

@@ -1,5 +1,15 @@
 ![Soy mascot Tofu](demo/content/tofu.png)
 
+```
+   oo_       .-.   wWw  wWw 
+  /  _)-<  c(O_O)c (O)  (O) 
+  \__ `.  ,'.---.`,( \  / ) 
+     `. |/ /|_|_|\ \\ \/ /  
+     _| || \_____/ | \o /   
+  ,-'   |'. `---' .`_/ /    
+ (_..--'   `-...-' (_.'     
+```
+
 # Soy
 
 **A static-site generator for Rubyists**
@@ -40,22 +50,24 @@ fermenting...
 ## Bugs / Features
 
 - Write templates in ERB and use the Ruby you know and love
+- Author content in Markdown or HTML
 - Boot up a server and watch for changes
 
 ## Installation
 
 Soy requires a modern, stable Ruby, [see ruby-lang.org](https://www.ruby-lang.org/en/downloads/)
 
-- 3.1.1
-- 3.0.3
-- 2.7.5
+Supported Rubies:
+- 3.1
+- 3.0
+- 2.7
 
 1. Install Soy with `gem install soy`
 2. Create a new site with `soy new YOUR_SITE_NAME`
 3. Move into it the new site's directory
 4. Run `soy server` to get to building!
 
-Your site will then be accessible at [localhost:9292](http://localhost:9292)
+Your site will then be accessible at [localhost:4848](http://localhost:4848)
 
 ## Usage
 
@@ -73,9 +85,63 @@ Browse `./demo/` to see a full site, but here's a breakdown of what goes into a
 - `build/` – where the HTML is output to & served from locally, don't check this in
 - `content/` – where pages, images, styles, etc. live
     - e.g. `index.html.erb`
+    - e.g. `about.md`
 - `views/` – where page layouts live (to be evaluated)
     - `layout.html.erb` — default HTML page layout
 
+## Content
+
+Soy content lives in the `content/` directory. If the file name ends in `.erb`,
+it'll get run through the Soy renderer for ERB.
+
+### Markdown
+
+Content can be authored in Markdown, which outputs HTML. Soy uses
+[Kramdown](https://rubygems.org/gems/kramdown) for Markdown parsing.
+
+### ERB
+
+HTML and Markdown files don't need the `.erb` file extension, they'll always
+get run through ERB. So that's optional and totally up to you. `.erb` can help
+with syntax highlighting in your editor.
+
+ERB content will be rendered inside the layout specified in
+`views/layout.html.erb`.
+
+ERB is neat because you can use whatever Ruby you want within it. Here's an
+example with Markdown:
+
+``` markdown
+<% @title = "Neat Products Made of Soy" %>
+
+# <%= @title %>
+
+<% ["tofu", "tempeh", "edamame"].each do |product| %>
+- <%= product %>
+<% end %>
+```
+
+### Links
+
+Link to pages and content using the relative path. Markdown example:
+
+``` markdown
+Check out [my super cool link](/cool-link).
+```
+
+That would link to the `cool-link.html` page in the build dir.
+
+The Soy development server (and many hosts) handle extension-less HTML
+requests.
+
+You can include the extension if you want to:
+
+``` markdown
+Check out [my super cool link](/cool-link.html).
+```
+
+It's really up to you and your preferences.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
@@ -93,6 +159,8 @@ of the features as possible with the project.
 The `bin/soy` binstub can be used to run the local repo's code, so `bin/soy
 build demo` will build the demo site.
 
+[View the demo site on Netlify.](https://soy-demo.netlify.app)
+
 ## Releasing New Versions
 
 To release a new version, update the version number in `version.rb`, and then run

data/exe/soy

@@ -1,37 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "soy"
+require "soy/cli"
 
-def elapsed
-  starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-  yield
-  ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-  (ending - starting).round(6)
-end
-
-first_arg = ARGV[0]
-case first_arg
-when "build", "b"
-  puts "Building site..."
-  time = elapsed do
-    Soy.build(ARGV[1])
-  end
-  puts "Site successfully built in #{time} seconds"
-when "help", "h", "-h", "--help", nil
-  puts "Soy v#{Soy::VERSION}\n\n"
-  puts "Available commands:\n"
-  puts "\tbuild (b) - generate site in the build directory"
-  puts "\tnew (n) - create a new Soy site\n\t\tsoy new SITE_NAME"
-  puts "\tserver (s) - rebuild site on changes and start HTTP server"
-  puts "\tversion (v) - current version of the library"
-when "new", "n"
-  Soy.new_site(ARGV[1])
-when "server", "serve", "s"
-  Soy::Server.start(ARGV[1])
-when "version", "v", "-v", "--v"
-  puts Soy::VERSION
-else
-  puts "`#{first_arg}` is not a command"
-  puts "Run `soy help` for list of commands"
-end
+Soy::Cli.new(ARGV).run

data/lib/soy/builder.rb

@@ -5,30 +5,45 @@ require "fileutils"
 module Soy
   # Builds the static site content
   class Builder
+    include Helpers
+
     def initialize(project_dir)
-      @project_dir = project_dir
+      @project_dir = project_dir || Dir.pwd
       @build_dir = "#{@project_dir}/build/"
+      @content_dir = "#{@project_dir}/content/"
     end
 
     def call
-      @layout = File.read("#{@project_dir}/views/layout.html.erb")
-      FileUtils.mkdir_p(@build_dir)
-      process_dir("#{@project_dir}/content")
+      puts "Building site..."
+      time = elapsed do
+        FileUtils.rm_rf(@build_dir)
+        FileUtils.mkdir_p(@build_dir)
+        process_content
+      end
+      puts "Site successfully built in #{time} seconds"
     end
 
     private
 
-    def process_dir(dir)
-      content = Dir.glob("#{dir}/*")
-
-      content.each do |file|
-        if file =~ /html.erb$/
-          bare_name = file.split("/").last.split(".").first
-          out = Soy::Renderer.new(File.read(file), @layout).render
-          File.write("#{@build_dir}/#{bare_name}.html", out)
-        else
-          FileUtils.cp(file, @build_dir)
-        end
+    def process_content
+      Dir.glob("#{@content_dir}**/*").each do |file|
+        process_file(file)
+      end
+    end
+
+    def process_file(file_path)
+      file = Soy::File.new(file_path)
+
+      dest = file_path.gsub(@content_dir, @build_dir).gsub(%r{/[\w-]+(\.\w+)+$}, "/")
+
+      if ::File.directory?(file_path)
+        FileUtils.mkdir_p(file_path.gsub(@content_dir, @build_dir))
+      elsif file.render_with_erb?
+        layout = Soy::File.new("#{@project_dir}/views/layout.html.erb")
+        out = Soy::Renderer.new(file, layout).render
+        ::File.write("#{dest}#{file.rendered_name}", out)
+      else
+        FileUtils.cp(file_path, dest)
       end
     end
   end

data/lib/soy/cli.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "soy"
+
+module Soy
+  # Command-Line Interface entrance for Soy
+  class Cli
+    include Helpers
+
+    # @param args - ARGV, array of arguments
+    def initialize(args)
+      @args = Array(args)
+    end
+
+    COMMANDS = {
+      build: {
+        aliases: ["b"],
+        description: "Generate the site, supports passing path to site directory",
+        examples: ["soy build", "soy build path/to/site"],
+        run: ->(args) { Soy::Builder.new(args[1]).call }
+      },
+      help: {
+        aliases: ["h", "-h", "--help"],
+        description: "Generate the site, supports passing path to site directory",
+        examples: ["soy build", "soy build path/to/site"],
+        run: lambda do |_args|
+          puts "Soy v#{Soy::VERSION}\n\n"
+          puts "Available commands:\n"
+          COMMANDS.each do |command, details|
+            puts "\t#{command} - #{details[:description]}"
+            puts "\t\taliases: #{details[:aliases].join(", ")}"
+            puts "\t\texamples:\n\t\t\t#{details[:examples].join("\n\t\t\t")}"
+          end
+        end
+      },
+      new: {
+        aliases: ["n"],
+        description: "Create a site from the basic Soy template",
+        examples: ["soy new site_name"],
+        run: ->(args) { Soy.new_site(args[1]) }
+      },
+      server: {
+        aliases: %w[s serve],
+        description: "Start development server & rebuild site on changes," \
+                     "supports passing path to site directory and an optional --port arg",
+        examples: ["soy server", "soy server path/to/site", "soy server --port=4040"],
+        run: lambda do |args|
+          opts = {}
+          OptionParser.new do |parser|
+            parser.banner = "soy server option flags"
+            parser.on("-p", "--port [PORT]", Integer, "HTTP to run the server at")
+          end.parse!(args, into: opts)
+          Soy::Server.start(args[1], port: opts[:port])
+        end
+      },
+      version: {
+        aliases: ["v", "-v", "--version"],
+        description: "Output installed Soy version",
+        examples: ["soy version"],
+        run: ->(_args) { puts Soy::VERSION }
+      }
+    }.freeze
+
+    def run
+      first_arg = @args[0]
+
+      return COMMANDS[:help][:run].call(@args) if first_arg.nil?
+
+      command = COMMANDS.find do |key, details|
+        first_arg == key.to_s || details.fetch(:aliases, []).include?(first_arg)
+      end
+
+      if command
+        command[1].fetch(:run).call(@args)
+      else
+        puts "`#{first_arg}` is not a command"
+        puts "Run `soy help` for list of commands"
+      end
+    end
+  end
+end

data/lib/soy/file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Soy
+  # Utility class for taking a path to a file and determining what its
+  # capabilities are within Soy
+  class File
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def read
+      ::File.read(@file_path)
+    end
+
+    def rendered_name
+      bare_name = @file_path.split("/").last.split(".").first
+      "#{bare_name}.html"
+    end
+
+    def render_with_erb?
+      @file_path =~ /.erb$/ || markdown? || html?
+    end
+
+    def markdown?
+      @file_path =~ /.(md|markdown)/
+    end
+
+    def html?
+      @file_path =~ /.html/
+    end
+  end
+end

data/lib/soy/helpers.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Soy
+  # Utility methods to be used across classes
+  module Helpers
+    # Returns the time for executing the block, rounded to the sixth
+    # place.
+    def elapsed
+      starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      yield
+      ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      (ending - starting).round(6)
+    end
+  end
+end

data/lib/soy/page.rb

@@ -19,5 +19,13 @@ module Soy
         public_send("#{attr}=".to_sym, attr_val)
       end
     end
+
+    def method_missing(_)
+      nil
+    end
+
+    def respond_to_missing?
+      true
+    end
   end
 end

data/lib/soy/renderer.rb

@@ -1,19 +1,27 @@
 # frozen_string_literal: true
 
+require "kramdown"
 require "soy/page"
 
 module Soy
-  # Takes IO objects and runs them through ERB
+  # Runs the template through ERB and generates HTML from it, within optional
+  # layout.
   class Renderer
-    def initialize(template, layout = nil)
+    # template, +Soy::File+ instance
+    # layout, +Soy::File+ instance
+    def initialize(template, layout)
       @template = template
       @layout = layout
+
       @page = Page.new
     end
 
     def render
-      template = _render(@template)
-      _render(@layout) { template }
+      out = _render(@template)
+      out = convert_template(out)
+      out = _render(@layout) { out }
+      out = out.gsub(/^\s+$/, "")
+      out.gsub(/\A\n/, "")
     end
 
     private
@@ -22,8 +30,14 @@ module Soy
       if template.nil?
         yield
       else
-        ERB.new(template).result(binding)
+        ERB.new(template.read).result(binding)
       end
     end
+
+    def convert_template(text)
+      text = Kramdown::Document.new(text).to_html if @template.markdown?
+
+      text
+    end
   end
 end

data/lib/soy/server.rb

@@ -10,12 +10,15 @@ require "rack/show_exceptions"
 module Soy
   # Container of data for a given page
   class Server
-    def self.start(dir = Dir.pwd)
-      new(dir).call
+    DEFAULT_PORT = 4848
+
+    def self.start(dir = Dir.pwd, port: DEFAULT_PORT)
+      new(dir, port).call
     end
 
-    def initialize(dir)
+    def initialize(dir, port)
       @dir = dir || Dir.pwd
+      @port = port || DEFAULT_PORT
       @relative_output_dir = "build"
       @output_dir = "#{@dir}/#{@relative_output_dir}"
       @builder = Builder.new(@dir)
@@ -40,7 +43,7 @@ module Soy
 
     def start_server
       puts "Serving files from #{@output_dir}"
-      Rack::Server.start(app: app, Port: 9292)
+      Rack::Server.start(app: app, Port: @port)
     end
 
     def app
@@ -48,14 +51,29 @@ module Soy
         Rack::ShowExceptions.new(
           Rack::Lint.new(
             Rack::Static.new(
-              -> { [200, { "Content-Type" => "text/html" }, ["Hello from Soy!"]] },
+              bare_finder_with_404_fallback,
               urls: [""],
               root: @output_dir,
+              cascade: true,
               index: "index.html"
             )
           )
         )
       )
     end
+
+    def bare_finder_with_404_fallback
+      lambda do |env|
+        request_path = env["REQUEST_PATH"]
+        file_path = "#{@output_dir + request_path}.html"
+        [200, { "Content-Type" => "text/html;charset=utf8" }, [::File.read(file_path)]]
+      rescue Errno::ENOENT => e
+        [
+          404,
+          { "Content-Type" => "text/plain;charset=utf8" },
+          ["File Not Found\n\n#{e.message}\n\nCreate content to match the path.\n\n༼☯﹏☯༽"]
+        ]
+      end
+    end
   end
 end

data/lib/soy/template/content/styles.css

@@ -0,0 +1,5 @@
+/* Add your styles below */
+
+body {
+  font-family: Helvetica, Arial, sans-serif;
+}

data/lib/soy/template/views/layout.html.erb

@@ -1,8 +1,12 @@
+<!doctype html>
+
 <html>
-  <head>
+  <head lang="en">
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
     <title><%= @page.title || "Your Site" %></title>
+    <link href="/styles.css" rel="stylesheet">
   </head>
-
   <body>
     <%= yield %>
   </body>

data/lib/soy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Soy
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/soy.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
+require_relative "soy/helpers"
+
 require_relative "soy/builder"
+require_relative "soy/cli"
+require_relative "soy/file"
 require_relative "soy/renderer"
 require_relative "soy/server"
 require_relative "soy/version"
@@ -11,11 +15,6 @@ require "erb"
 module Soy
   class Error < StandardError; end
 
-  def self.build(dir)
-    dir ||= Dir.pwd
-    Builder.new(dir).call
-  end
-
   def self.new_site(name)
     FileUtils.cp_r("#{__dir__}/soy/template/", name)
     puts "New Soy site created, view in: #{name}"

data/soy.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Static site builder with support for data models, helpers, an admin, and more."
   spec.homepage = "https://github.com/brettchalupa/soy"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.5"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "kramdown", "~> 2.3"
   spec.add_dependency "listen", "~> 3.7"
   spec.add_dependency "puma", "~> 5.6.2"
   spec.add_dependency "rack", "~> 2.2"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: soy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brett Chalupa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-03 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -70,11 +84,15 @@ files:
 - exe/soy
 - lib/soy.rb
 - lib/soy/builder.rb
+- lib/soy/cli.rb
+- lib/soy/file.rb
+- lib/soy/helpers.rb
 - lib/soy/page.rb
 - lib/soy/renderer.rb
 - lib/soy/server.rb
 - lib/soy/template/.gitignore
 - lib/soy/template/content/index.html.erb
+- lib/soy/template/content/styles.css
 - lib/soy/template/views/layout.html.erb
 - lib/soy/version.rb
 - sig/sito.rbs
@@ -95,14 +113,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.5
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Data-backed static site generator