apogee 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 55c20d8b520abe0413950e3edbbae220ce1fbcdd1c8638f6db0e4036a55f7940
+  data.tar.gz: 333cf3e36c4ce96a5f9e8ba9d836da7f953649a063e3af874057750b7f783eb8
+SHA512:
+  metadata.gz: b637a99eb82bc4c06f82373313cdc78e50d066f19f16b282343fa58897972b77d0d42f4f2d63df6c030802826886155343d04b9eb31f4ee80f673087406c9469
+  data.tar.gz: f02aa1ab7f489385890fed0e2877272ef68fb6b17431e9342a32ba287aaf9ce3fe8b43eade9a6a6969cc1114e67378d23bb64432b8aceec9df8eb48ff72726bc

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,130 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+Style/BlockDelimiters:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented_relative_to_receiver
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**'
+    - 'spec/**/*'
+
+RSpec/ExampleLength:
+  Max: 10
+  Exclude:
+    - 'spec/**/*.rb'
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+RSpec/MultipleExpectations:
+  Max: 5
+
+Lint/DuplicateBranch:
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement:
+  Enabled: true
+
+Lint/EmptyBlock:
+  Enabled: true
+
+Lint/EmptyClass:
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks:
+  Enabled: true
+
+Lint/ToEnumArguments:
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator:
+  Enabled: true
+
+Style/ArgumentsForwarding:
+  Enabled: false
+
+Style/CollectionCompact:
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+
+Style/NegatedIfElseCondition:
+  Enabled: true
+
+Style/NilLambda:
+  Enabled: true
+
+Style/SwapValues:
+  Enabled: true
+
+Performance/AncestorsInclude:
+  Enabled: true
+
+Performance/ArraySemiInfiniteRangeSlice:
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument:
+  Enabled: true
+
+Performance/BlockGivenWithExplicitBlock:
+  Enabled: true
+
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+Performance/ConstantRegexp:
+  Enabled: true
+
+Performance/MethodObjectAsBlock:
+  Enabled: true
+
+Performance/RedundantSortBlock:
+  Enabled: true
+
+Performance/RedundantStringChars:
+  Enabled: true
+
+Performance/ReverseFirst:
+  Enabled: true
+
+Performance/SortReverse:
+  Enabled: true
+
+Performance/Squeeze:
+  Enabled: true
+
+Performance/StringInclude:
+  Enabled: true
+
+Performance/Sum:
+  Enabled: true

data/.rubycritic.yml

@@ -0,0 +1,7 @@
+no_browser: true
+path: '/tmp/rubycritic'
+formats:
+  - console
+minimum_score: 90
+paths:
+  - 'lib/'

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at brian@disjunct.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'thor'
+
+group :development do
+  gem 'rubocop'
+  gem 'rubocop-performance'
+  gem 'rubocop-rake'
+  gem 'rubocop-rspec'
+  gem 'rubycritic'
+end
+
+group :test do
+  gem 'simplecov'
+end
+
+group :development, :test do
+  gem 'byebug'
+  gem 'rspec', '~> 3.0'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,131 @@
+PATH
+  remote: .
+  specs:
+    apogee (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (11.1.3)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    flay (2.12.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.4)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    ice_nine (0.11.2)
+    kwalify (0.7.2)
+    launchy (2.5.0)
+      addressable (~> 2.7)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    path_expander (1.1.0)
+    psych (3.2.0)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    reek (6.0.2)
+      kwalify (~> 0.7.0)
+      parser (>= 2.5.0.0, < 2.8, != 2.5.1.1)
+      psych (~> 3.1)
+      rainbow (>= 2.0, < 4.0)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.3.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.9.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.0.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.15.0)
+      sexp_processor (~> 4.9)
+    rubycritic (4.5.2)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (>= 2.0.0)
+      parser (>= 2.6.0)
+      rainbow (~> 3.0)
+      reek (~> 6.0, < 7.0)
+      ruby_parser (~> 3.8)
+      simplecov (>= 0.17.0)
+      tty-which (~> 0.4.0)
+      virtus (~> 1.0)
+    sexp_processor (4.15.1)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tty-which (0.4.2)
+    unicode-display_width (1.7.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apogee!
+  byebug
+  rake
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  rubycritic
+  simplecov
+  thor
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Brian Davies
+
+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,156 @@
+# Apogee
+
+Apogee is a no-frill, no-configuration static site generator for when you need
+to build a simple site fast and don't want to mess with more complicated
+frameworks.
+
+
+## Installation
+Install it with:
+
+```bash
+$ gem install apogee
+```
+
+
+## Usage
+
+### Create a site
+You may create a new site from the command line with:
+```bash
+$ apogee new site_name
+```
+
+Your site is now fully configured and ready to use:
+```
+site_name
+├── dist  <---------------- Rendered final site
+├── Gemfile
+├── Guardfile
+├── README.md
+└── src   <---------------- Working files
+    ├── css
+    │   └── styles.css
+    ├── images
+    ├── javascript
+    │   └── script.js
+    ├── layouts
+    │   └── default.html
+    └── pages
+        └── index.html
+```
+
+
+### Build the final deployable site from your source files:
+Render your deployable site using:
+```bash
+$ apogee build
+```
+
+Pages are rendered inside their respective layouts.
+
+CSS and Javascript assets are combined and linked inside a layout.
+
+
+### Tokens
+Tokens can be used to specify a page's layout, as well as pass information from a page to its layout.
+
+
+Apogee manages 4 tokens for you:
+* `layout`: Specifies which layout file to use with a given page
+* `css_bundle`: Specifies location in the layout to link the css bundle
+* `js_bundle`: Specifies location in the layout to link the js bundle
+* `page_content`: Specifies location in the layout to insert the page content
+
+To pass additional information from a page to its layout, you may define arbitrary tokens 
+in pages using a YAML format HTML comment.
+
+
+Here is an example setup:
+
+`src/pages/index.html`:
+```html
+ <!--
+    layout: 'no_navigation'
+    title: 'Welcome to Example Site'
+ -->
+
+ <h1>Hello, World<h2>
+```
+
+
+`src/layouts/no_navigation.html`:
+```html
+<html>
+    <head>
+        <title>{{title}}</title>
+
+        {{js_bundle}}
+        {{css_bundle}}
+    </head>
+    <body>
+        <div>{{page_content}}</div>
+    </body>
+</html>
+```
+
+
+This would yield the following page when the site is built:
+
+`dist/index.html`:
+```html
+<html>
+    <head>
+        <title>Welcome to Example Site</title>
+
+        <script src="script.js"></script>
+        <link rel="stylesheet" href="styles.css">
+    </head>
+    <body>
+        <div><h1>Hello, World<h2></div>
+    </body>
+</html>
+```
+
+### Using Guard to improve workflow
+Sites created with Apogee come configured to work with [Guard](https://github.com/guard/guard) 
+for automatic building and browser reloading.
+
+The new site [README.md](https://github.com/bdavi/apogee/blob/main/lib/apogee/templates/new_site/README.md)
+includes more detail on how to use Guard to speed up site creation workflow.
+
+
+## Development
+
+After you checkout the repo, run `bundle install` to install dependencies.
+
+Then, you can run `bundle exec rspec` to run the tests.
+
+Apogee uses a variety of tools to maintain code correctness, consistency
+and quality. Before merging new code the expectation is:
+* All specs pass
+* 90% test coverage
+* Adherence to the style guide
+* Minimum 90% quality score on all code files
+
+To verify the application run:
+```
+$ bin/verify
+```
+
+For more information about how to work with gems in development, see [https://guides.rubygems.org/make-your-own-gem/](https://guides.rubygems.org/make-your-own-gem/).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bdavi/apogee. 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/bdavi/apogee/blob/master/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 Apogee project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bdavi/apogee/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/apogee.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/apogee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'apogee'
+  spec.version       = Apogee::VERSION
+  spec.authors       = ['Brian Davies']
+  spec.email         = ['brian@disjunct.io']
+
+  spec.summary       = 'Dead simple static sites'
+  spec.description   = "Sometimes you don't need the complexity of a full web framework."
+  spec.homepage      = 'https://github.com/bdavi/apogee'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/bdavi/apogee'
+  spec.metadata['changelog_uri'] = 'https://github.com/bdavi/apogee/blob/main/CODE_OF_CONDUCT.md'
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables << 'apogee'
+  spec.require_paths = ['lib']
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'apogee'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/reinstall

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+gem uninstall apogee
+gem build apogee.gemspec
+gem install apogee-0.1.0.gem

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/bin/verify

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+system! 'bundle exec rspec'
+system! 'bundle exec rubocop'
+system! 'bundle exec rubycritic'
+
+puts "\nVerification Successful"

data/exe/apogee

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'apogee'
+
+Apogee::CLI.start(ARGV)

data/lib/apogee.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'apogee/builder'
+require 'apogee/builder_helpers'
+require 'apogee/cli'
+require 'apogee/css_processor'
+require 'apogee/file_helpers'
+require 'apogee/image_processor'
+require 'apogee/installer'
+require 'apogee/js_processor'
+require 'apogee/page_processor'
+require 'apogee/page_renderer'
+require 'apogee/version'
+
+module Apogee
+  class Error < StandardError; end
+end

data/lib/apogee/builder.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'builder_helpers'
+
+module Apogee
+  # Builds site for distribution using the specified processors
+  class Builder
+    attr_reader :processors
+
+    def initialize(
+      processors: [
+        ImageProcessor.new,
+        CSSProcessor.new,
+        JSProcessor.new,
+        PageProcessor.new
+      ]
+    )
+      @processors = processors
+    end
+
+    def build
+      prepare_dist_dir
+      processors.each(&:process)
+    end
+
+    def prepare_dist_dir
+      FileUtils.rm_rf('dist')
+      FileUtils.mkdir('dist')
+    end
+  end
+end

data/lib/apogee/builder_helpers.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Apogee
+  # Helpers for classes processing the build
+  module BuilderHelpers
+    def images?
+      image_paths.any?
+    end
+
+    def image_paths
+      Dir[File.join('src', 'images', '**', '*.*')]
+    end
+
+    def css?
+      css_paths.any?
+    end
+
+    def css_paths
+      Dir[File.join('src', 'css', '**', '*.css')]
+    end
+
+    def js?
+      js_paths.any?
+    end
+
+    def js_paths
+      Dir[File.join('src', 'javascript', '**', '*.js')]
+    end
+
+    def layout(name)
+      IO.read(File.join('src', 'layouts', "#{name}.html"))
+    end
+  end
+end

data/lib/apogee/cli.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Apogee
+  # Command line interface
+  class CLI < Thor
+    package_name 'apogee'
+
+    desc 'new SITE_NAME', 'Creates a new empty site.'
+    long_desc <<~LONGDESC
+      `apogee new SITE_NAME` will create a new empty site with the specified name.
+
+      SITE_NAME must be a valid as a directory name and contain only letters, numbers, dashes and underscores.
+
+      Example:
+      \x5> apogee new site_name
+    LONGDESC
+    def new(site_name)
+      Installer.new(site_name).install
+    end
+
+    desc 'build', 'Builds the site for preview or distribution'
+    long_desc <<~LONGDESC
+      `apogee build` will builds the site for preview or distribution.
+
+      WARNING: THIS WILL OVERWRITE THE CONTENTS OF THE `/dist` DIRECTORY.
+
+      The working files in `/src` are compiled into `/dist`.
+
+      Example:
+      \x5> apogee build
+    LONGDESC
+    def build
+      Builder.new.build
+    end
+  end
+end

data/lib/apogee/css_processor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'builder_helpers'
+
+module Apogee
+  # Processes site css for distribution
+  class CSSProcessor
+    include BuilderHelpers
+
+    def process
+      return unless css?
+
+      IO.write(out_path, processed_styles)
+    end
+
+    private
+
+    def processed_styles
+      css_paths.map { |path| IO.read(path) }.join("\n")
+    end
+
+    def out_path
+      File.join('dist', 'styles.css')
+    end
+  end
+end

data/lib/apogee/file_helpers.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Apogee
+  # Helpers related to files and file manipulation
+  module FileHelpers
+    def self.file_gsub(path, pattern, replacement)
+      IO.write(
+        path,
+        IO.read(path).gsub(pattern, replacement)
+      )
+    end
+  end
+end

data/lib/apogee/image_processor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'builder_helpers'
+
+module Apogee
+  # Processes site images for distribution
+  class ImageProcessor
+    include Apogee::BuilderHelpers
+
+    def process
+      return unless images?
+
+      FileUtils.cp_r(File.join('src', 'images'), File.join('dist', 'images'))
+    end
+  end
+end

data/lib/apogee/installer.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'apogee'
+
+module Apogee
+  # Creates an empty apogee site
+  class Installer
+    VALID_FILENAME_PATTERN = /\A[A-Za-z0-9\-_]+\z/.freeze
+    FILES_WITH_SITE_NAME = [
+      'README.md',
+      File.join('src', 'pages', 'index.html')
+    ].freeze
+
+    attr_reader :site_name, :destination_root_dir
+
+    def initialize(site_name, destination_root_dir: Dir.pwd)
+      @site_name = site_name
+      @destination_root_dir = destination_root_dir
+      validate
+    end
+
+    def install
+      copy_template_files
+      gsub_site_name
+      bundle_dependencies
+    end
+
+    def validate
+      validate_destination_dir
+      validate_site_name
+    end
+
+    def copy_template_files
+      FileUtils.mkdir_p(destination_root_dir) unless Dir.exist?(destination_root_dir)
+      FileUtils.cp_r(template_dir, destination_dir)
+    end
+
+    def gsub_site_name
+      FILES_WITH_SITE_NAME.each do |file|
+        path = File.join(destination_dir, file)
+        FileHelpers.file_gsub(path, '{{site_name}}', site_name)
+      end
+    end
+
+    def bundle_dependencies
+      Kernel.system "cd #{destination_dir}"
+      Kernel.system 'bundle install'
+    end
+
+    private
+
+    def destination_dir
+      File.join(destination_root_dir, site_name)
+    end
+
+    def template_dir
+      File.join(File.dirname(__FILE__), 'templates', 'new_site')
+    end
+
+    def validate_destination_dir
+      return unless Dir.exist?(destination_dir)
+
+      raise InstallDirectoryAlreadyExistsError, "#{destination_dir} already exists."
+    end
+
+    def validate_site_name
+      return if site_name.match?(VALID_FILENAME_PATTERN)
+
+      raise ApplicationNameInvalidError, \
+            "#{site_name} is not a valid site name. Please use only " \
+            'letters, numbers, underscores and dashes in the application name'
+    end
+
+    class InstallDirectoryAlreadyExistsError < StandardError; end
+    class ApplicationNameInvalidError < StandardError; end
+  end
+end

data/lib/apogee/js_processor.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'builder_helpers'
+
+module Apogee
+  # Processes site js for distribution
+  class JSProcessor
+    include BuilderHelpers
+
+    def process
+      return unless js?
+
+      IO.write(out_path, processed_js)
+    end
+
+    private
+
+    def processed_js
+      js_paths.map { |path| IO.read(path) }.join("\n")
+    end
+
+    def out_path
+      File.join('dist', 'script.js')
+    end
+  end
+end

data/lib/apogee/page_processor.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'builder_helpers'
+
+module Apogee
+  # Processes site pages for distribution
+  class PageProcessor
+    attr_reader :renderer
+
+    def initialize(renderer: PageRenderer.new)
+      @renderer = renderer
+    end
+
+    def process
+      copy_src_pages_to_dist
+
+      dist_file_paths.each do |path|
+        IO.write(
+          path,
+          renderer.render(IO.read(path))
+        )
+      end
+    end
+
+    private
+
+    def copy_src_pages_to_dist
+      FileUtils.cp_r(File.join('src', 'pages', '.'), 'dist')
+    end
+
+    def dist_file_paths
+      Dir[File.join('dist', '**', '*.html')]
+    end
+  end
+end

data/lib/apogee/page_renderer.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require_relative 'builder_helpers'
+
+module Apogee
+  # Processes site pages for distribution
+  class PageRenderer
+    include BuilderHelpers
+
+    TOKEN_COMMENT_PATTERN = /\A<!--[^>]*-->/.freeze
+
+    attr_reader :page_content
+
+    def render(page_content)
+      @page_content = page_content
+
+      tokens.inject(layout_content) do |rendered, (name, value)|
+        rendered.gsub("{{#{name}}}", value)
+      end
+    end
+
+    def layout_content
+      layout(tokens['layout'])
+    end
+
+    def tokens
+      automatic_tokens.merge(parsed_tokens)
+    end
+
+    def automatic_tokens
+      {
+        'layout' => 'default',
+        'css_bundle' => css_bundle,
+        'js_bundle' => js_bundle,
+        'page_content' => cleaned_page_content
+      }
+    end
+
+    def parsed_tokens
+      doc = page_content
+              .match(TOKEN_COMMENT_PATTERN)[0]
+              .delete_prefix('<!--')
+              .delete_suffix('-->')
+              .each_line
+              .map(&:strip)
+              .join("\n")
+
+      YAML.safe_load(doc)
+    rescue StandardError
+      {}
+    end
+
+    def css_bundle
+      return '' unless css?
+
+      '<link rel="stylesheet" href="styles.css">'
+    end
+
+    def js_bundle
+      return '' unless js?
+
+      '<script src="script.js"></script>'
+    end
+
+    def cleaned_page_content
+      page_content.gsub(TOKEN_COMMENT_PATTERN, '').strip
+    end
+  end
+end

data/lib/apogee/templates/new_site/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'guard'
+gem 'guard-livereload'
+gem 'guard-yield'

data/lib/apogee/templates/new_site/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+WATCH_PATTERN = %r{^src/.*}.freeze
+
+run_build = proc { system('apogee build') }
+
+guard :yield, { run_on_modifications: run_build } do
+  watch(WATCH_PATTERN)
+end
+
+guard 'livereload' do
+  watch(WATCH_PATTERN)
+end

data/lib/apogee/templates/new_site/README.md

@@ -0,0 +1,46 @@
+# {{site_name}}
+
+## Summary
+Describe your site here
+
+
+## Setup
+Install Ruby gems;
+```
+bundle install
+```
+
+Build site for first time;
+```
+bundle exec apogee build
+```
+
+
+## Repo Structure
+Working files are available in the `/src` directory.
+
+Rendered files are available in the `/dist` directory.
+
+
+## Suggested development workflow
+Install the LiveReload plugin/extension in your browser.
+
+Start Guard in a terminal:
+```
+bundle exec guard
+```
+
+In your browser open `/dist/index.html`.
+
+Connect the LiveReload plugin by clicking its icon in the browser.
+
+Now you can edit files in the `/src` directory and the changes will be rendered
+after each file save in the browser.
+
+When you are finished with a development session, type `exit` in the guard 
+session to end it.
+
+
+## Apogee
+More informantion about apogee available here:
+[https://github.com/bdavi/apogee](https://github.com/bdavi/apogee)

data/lib/apogee/templates/new_site/src/css/styles.css

@@ -0,0 +1 @@
+/* Your styles go here */

data/lib/apogee/templates/new_site/src/javascript/script.js

@@ -0,0 +1 @@
+// Your Javascript goes here

data/lib/apogee/templates/new_site/src/layouts/default.html

@@ -0,0 +1,19 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="utf-8">
+
+  <title>{{title}}</title>
+
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  {{css_bundle}}
+  {{js_bundle}}
+</head>
+
+<body>
+  {{page_content}}
+</body>
+
+</html>

data/lib/apogee/templates/new_site/src/pages/index.html

@@ -0,0 +1,2 @@
+<h1>{{site_name}}</h1>
+<p>Hello, World!</p>

data/lib/apogee/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Apogee
+  VERSION = '0.2.0'
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: apogee
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Brian Davies
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-12-15 00:00:00.000000000 Z
+dependencies: []
+description: Sometimes you don't need the complexity of a full web framework.
+email:
+- brian@disjunct.io
+executables:
+- apogee
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubycritic.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- apogee.gemspec
+- bin/console
+- bin/reinstall
+- bin/setup
+- bin/verify
+- exe/apogee
+- lib/apogee.rb
+- lib/apogee/builder.rb
+- lib/apogee/builder_helpers.rb
+- lib/apogee/cli.rb
+- lib/apogee/css_processor.rb
+- lib/apogee/file_helpers.rb
+- lib/apogee/image_processor.rb
+- lib/apogee/installer.rb
+- lib/apogee/js_processor.rb
+- lib/apogee/page_processor.rb
+- lib/apogee/page_renderer.rb
+- lib/apogee/templates/new_site/Gemfile
+- lib/apogee/templates/new_site/Guardfile
+- lib/apogee/templates/new_site/README.md
+- lib/apogee/templates/new_site/src/css/styles.css
+- lib/apogee/templates/new_site/src/javascript/script.js
+- lib/apogee/templates/new_site/src/layouts/default.html
+- lib/apogee/templates/new_site/src/pages/index.html
+- lib/apogee/version.rb
+homepage: https://github.com/bdavi/apogee
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bdavi/apogee
+  source_code_uri: https://github.com/bdavi/apogee
+  changelog_uri: https://github.com/bdavi/apogee/blob/main/CODE_OF_CONDUCT.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Dead simple static sites
+test_files: []