soy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6bd54fbe6410b42d75c37e02b1b31650bb7fd14b41535425b08d9c745b35318
+  data.tar.gz: 2108d0d1526adf9e96830f6ec4fb187653c896793f1ea5ac69ea4da85541d483
+SHA512:
+  metadata.gz: 06bb73badd9937a74e7f452fe282c3497a1471bc144ec17106bd49d4f080746fa512ab59862e5504cbc7d650913fe87c5c54b27a6f0ed8e6495dfdbc04cce0d7
+  data.tar.gz: e6ae9aad16345d5e04bc3bc6d2736e87633ae45bdbbb43ee6dae9c4c585eff987a71f0375e6230ec37e10fa06035aa3f6265b8e954abcb6d759dfb518ef94d51

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "soy.gemspec"
+    - "spec/**/*.rb"
+
+Metrics/MethodLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Exclude:
+    - "spec/system/**/*_spec.rb"

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-03-03
+
+- Initial release
+- Adds `soy` command with help info
+- Adds `soy build` command
+- Adds `soy server` command serves HTML files and watches for changes
+- Adds `soy new` command to generate a basic Soy site

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at brettchalupa@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Brett Chalupa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,125 @@
+![Soy mascot Tofu](demo/content/tofu.png)
+
+# Soy
+
+**A static-site generator for Rubyists**
+
+Soy is a program to generate websites. It embraces Ruby by using ERB for making
+dynamic templates instead of using another templating language.
+
+## Why / Vision
+
+_Ugh, another static site generator?!_ I hear you! I do! There are so many
+static site generators out there, it's almost disturbing.
+
+But I think there's space for something a little different.
+
+Most static site generators are centered around Markdown files or HTML files,
+but I think static websites have a data model and structure to them. Even a
+simple blog does. And often times there are needs for more complex data models
+with associations.
+
+I want Soy to be a data model-driven site generator with support for multiple
+data stores, from Markdown to `YAML::Store` to maybe things like SQLite. The
+key is that the data doesn't vary per environment and is checked into the
+source code since it's used to generate the site.
+
+I also think Ruby is really joyous to code with, so by leveraging it for
+templates, it's expressive and powerful. Also, when it comes to defining the
+data models and helpers, it'll be easy to stand up and validate.
+
+Of course it's not going to be as fast or as portable as Go or Rust or C but I
+hope it'll be fast enough and more than friendly to work with.
+
+I have a lot of ideas for how Soy could evolve, and I'm excited to make it
+happen.
+
+Soy is new and actively under development. You could say it's still
+fermenting...
+
+## Bugs / Features
+
+- Write templates in ERB and use the Ruby you know and love
+- 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
+
+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)
+
+## Usage
+
+`soy` or `soy help` will output the commands that are available, but the most
+common ones are:
+
+- `soy new your_site_name` – create a new site from Soy's basic template
+- `soy build` – generate the HTML for your site
+- `soy server` – start up a web server to handle requests & watch for site changes to trigger rebuilds
+
+## Structure of a Soy Site
+
+Browse `./demo/` to see a full site, but here's a breakdown of what goes into a Soy site:
+
+- `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`
+- `views/` – where page layouts live (to be evaluated)
+    - `layout.html.erb` — default HTML page layout
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. 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`.
+
+## Demo Site
+
+The `./demo/` directory includes a site that can be built with Soy to test
+works in progress and experiment with new features. It intends to use as many
+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.
+
+## Releasing New Versions
+
+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
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/brettchalupa/soy. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [code of
+conduct](https://github.com/brettchalupa/soy/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Soy project's codebases, issue trackers, chat rooms
+and mailing lists is expected to follow the [code of
+conduct](https://github.com/brettchalupa/soy/blob/main/CODE_OF_CONDUCT.md).
+
+## Friends / Enemies
+
+- Jekyll — a really useful static site generator that uses Liquid for templating, core inspiration
+- Middleman — Ruby-based site generator that I used years ago and enjoyed
+- Hugo — really fast and compelling Go static site generator

data/exe/soy

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "soy"
+
+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

data/lib/soy/builder.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Soy
+  # Builds the static site content
+  class Builder
+    def initialize(project_dir)
+      @project_dir = project_dir
+      @build_dir = "#{@project_dir}/build/"
+    end
+
+    def call
+      @layout = File.read("#{@project_dir}/views/layout.html.erb")
+      FileUtils.mkdir_p(@build_dir)
+      process_dir("#{@project_dir}/content")
+    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
+      end
+    end
+  end
+end

data/lib/soy/page.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Soy
+  # Container of data for a given page
+  class Page
+    # Create reader and writers for the passed in hash keys
+    def set(args)
+      raise ArgumentError, "must set with a Hash" unless args.is_a?(Hash)
+
+      args.each do |attr, attr_val|
+        self.class.send(:define_method, "#{attr}=".to_sym) do |value|
+          instance_variable_set("@#{attr}", value)
+        end
+
+        self.class.send(:define_method, attr.to_sym) do
+          instance_variable_get("@#{attr}")
+        end
+
+        public_send("#{attr}=".to_sym, attr_val)
+      end
+    end
+  end
+end

data/lib/soy/renderer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "soy/page"
+
+module Soy
+  # Takes IO objects and runs them through ERB
+  class Renderer
+    def initialize(template, layout = nil)
+      @template = template
+      @layout = layout
+      @page = Page.new
+    end
+
+    def render
+      template = _render(@template)
+      _render(@layout) { template }
+    end
+
+    private
+
+    def _render(template)
+      if template.nil?
+        yield
+      else
+        ERB.new(template).result(binding)
+      end
+    end
+  end
+end

data/lib/soy/server.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "listen"
+require "rack"
+require "rack/common_logger"
+require "rack/lint"
+require "rack/server"
+require "rack/show_exceptions"
+
+module Soy
+  # Container of data for a given page
+  class Server
+    def self.start(dir = Dir.pwd)
+      new(dir).call
+    end
+
+    def initialize(dir)
+      @dir = dir || Dir.pwd
+      @relative_output_dir = "build"
+      @output_dir = "#{@dir}/#{@relative_output_dir}"
+      @builder = Builder.new(@dir)
+    end
+
+    def call
+      @builder.call
+      start_watcher
+      start_server
+    end
+
+    private
+
+    def start_watcher
+      puts "Watching for changes in #{@dir}"
+      listener = Listen.to(@dir, ignore: [/#{@relative_output_dir}/]) do |modified, added, removed|
+        puts(modified: modified, added: added, removed: removed)
+        @builder.call
+      end
+      listener.start
+    end
+
+    def start_server
+      puts "Serving files from #{@output_dir}"
+      Rack::Server.start(app: app, Port: 9292)
+    end
+
+    def app
+      Rack::CommonLogger.new(
+        Rack::ShowExceptions.new(
+          Rack::Lint.new(
+            Rack::Static.new(
+              -> { [200, { "Content-Type" => "text/html" }, ["Hello from Soy!"]] },
+              urls: [""],
+              root: @output_dir,
+              index: "index.html"
+            )
+          )
+        )
+      )
+    end
+  end
+end

data/lib/soy/template/.gitignore

@@ -0,0 +1 @@
+build

data/lib/soy/template/content/index.html.erb

@@ -0,0 +1,5 @@
+<% @page.set(title: "Home") %>
+
+<h1><%= @page.title %></h1>
+
+<p>Time to get building!</p>

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

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title><%= @page.title || "Your Site" %></title>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/soy/version.rb

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

data/lib/soy.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "soy/builder"
+require_relative "soy/renderer"
+require_relative "soy/server"
+require_relative "soy/version"
+
+require "erb"
+
+# Entry point into the library
+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}"
+  end
+end

data/sig/sito.rbs

@@ -0,0 +1,4 @@
+module Soy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/soy.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/soy/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "soy"
+  spec.version = Soy::VERSION
+  spec.authors = ["Brett Chalupa"]
+  spec.email = ["brettchalupa@gmail.com"]
+
+  spec.summary = "Data-backed static site generator"
+  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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) ||
+        f.match(
+          %r{\A(?:(?:bin|test|spec|features|demo)/|\.(?:git|travis|circleci)|appveyor|Rakefile|Gemfile)}
+        )
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "listen", "~> 3.7"
+  spec.add_dependency "puma", "~> 5.6.2"
+  spec.add_dependency "rack", "~> 2.2"
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: soy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brett Chalupa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.6.2
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Static site builder with support for data models, helpers, an admin,
+  and more.
+email:
+- brettchalupa@gmail.com
+executables:
+- soy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/soy
+- lib/soy.rb
+- lib/soy/builder.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/views/layout.html.erb
+- lib/soy/version.rb
+- sig/sito.rbs
+- soy.gemspec
+homepage: https://github.com/brettchalupa/soy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/brettchalupa/soy
+  source_code_uri: https://github.com/brettchalupa/soy
+  changelog_uri: https://github.com/brettchalupa/soy/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Data-backed static site generator
+test_files: []