frontman-ssg 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 874f589b9d149419ec7d8c8fa1b4891ecb9ab1af9a396bf50f5955d70757a6df
-  data.tar.gz: 1f3da03d51ae4352212258f02f91631463709b39204578b4ebc096fef1c6899e
+  metadata.gz: 34eef05a89e8a6afd90d01f0e07fe8477e348be90b8de3b603b4b7761d93d73a
+  data.tar.gz: 993051df2124b49cdd7df806c01a7cbe83276f155b08f93d0d4eed00fba342e9
 SHA512:
-  metadata.gz: a8f152c9dc2f6f3bc2c949beb5f9a6daf6b2c2308ef5beac28dc735711c5715f4e5bd565d2eba86f4ff3836e0f538e82936e2b998ab69a658b59053031f51fad
-  data.tar.gz: a62dea5dc5054e61a171852425d5f1ee3c750f6c2ee231d41f6b6a03d63a2c35f29e5919021166650e5411725a83d2930334692d8de947c2f8b3823cc2355e35
+  metadata.gz: 001edb81fb728535077e4dd34dea01ebce3eb184223a6513ce18fcef013c11eaeb601ec5a06503e26b0d0aef2ff24146c2f7bfa59c320f3fc55135dd090f56d4
+  data.tar.gz: 98bac4af65a1747a4b9c34ffd90e991440a94156f5e2d1b33570a3d519d7aaa8e1ea15135cf0a0f7dcce40ed58333abce0e4f6350f918298719b30431ef9131a

data/.github/CODEOWNERS

@@ -0,0 +1,3 @@
+  
+# Default owners
+* @DevinCodes @sarahdayan

data/.github/RELEASE.md

@@ -0,0 +1,30 @@
+ # Frontman release process
+ 
+ ## Setup
+ 
+ > You only have to do this once.
+ 
+ * Make sure you have an account on [RubyGems][rubygems].
+ * Run the `gem signin` command from your CLI and log in with your RubyGems credentials.
+ * Make sure you're an administrator on the [Frontman][frontman] gem. You can ask an existing administrator for access if you're in a position to release Frontman.
+ 
+ ## Release 
+ * First, make sure all the tests on `master` are green.
+ * Switch to the `master` branch: `git checkout master`.
+ * Make sure you branch is up-to-date: `git fetch && git pull`.
+ * Make sure your repository is clean: `git reset --hard && git clean -dfx`.
+ * Check the changes the new version introduces by visiting `github.com/algolia/frontman/compare/{latest_version}...master`, replacing `{latest version}` with the latest tag. You can run `git tag --list` to check for the latest release.
+ * Determine the [new version number][semver] that you should release, and make sure there are no breaking changes.
+ * Bump the version in `lib/frontman/version.rb`.
+ * Update the [`CHANGELOG.md`][changelog] file with the changes that this new version introduces.
+ * Commit your changes: `git commit -a -m "chore: bumps version to vX.Y.Z"`.
+ * Create a tag for the new version: `git tag X.Y.Z`.
+ * Push your changes and the new tag: `git push && git push --tags`.
+ * Build the Frontman gem: `gem build frontman-ssg.gemspec`.
+ * Push the newly built gem to [RubyGems][rubygems]: `gem push frontman-ssg-X.Y.Z.gem`.
+ * Delete the locally built gem: `rm frontman-ssg-X.Y.Z.gem`.
+ 
+[changelog]: ../CHANGELOG.md
+[frontman]: https://rubygems.org/gems/frontman-ssg
+[rubygems]: https://www.rubygems.org/
+[semver]: https://semver.org/

data/CHANGELOG.md

@@ -5,7 +5,22 @@ We document all notable changes to the project in the file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [semantic versioning](http://semver.org/).
 
 # Release Notes
-## [Unreleased](https://github.com/algolia/frontman/compare/0.0.2...master)
+## [Unreleased](https://github.com/algolia/frontman/compare/0.0.3...master)
+
+## [0.0.3](https://github.com/algolia/frontman/tree/0.0.3) - 2020-08-28
+
+#### Added
+* Documentation on the release process.
+* Load possible `.env` files before application bootstrapping.
+* Asset fingerprinting through configuration.
+
+#### Security
+* Update dependencies in the Webpack project template.
+
+#### Fixed
+* Prevent `DataStoreFile` from being converted to `OpenStruct`.
+* Misc. updates to the projects documentation.
+
 ## [0.0.2](https://github.com/algolia/frontman/tree/0.0.2)
 The initial alpha release.
 

data/lib/frontman/bootstrapper.rb

@@ -2,6 +2,7 @@
 
 # typed: ignore
 
+require 'dotenv'
 require 'sorbet-runtime'
 require 'frontman/app'
 require 'frontman/resource'
@@ -26,13 +27,11 @@ module Frontman
       sig { params(app: Frontman::App).returns(Frontman::App) }
       def bootstrap_app(app)
         unless bootstrapped?
+          Dotenv.load
           register_default_helpers(app)
 
-          config_path = Frontman::Config.get(
-            :config_path,
-            fallback: './config.rb'
-          )
-          app.run(File.read(config_path)) if File.exist?(config_path)
+          config = Frontman::Config.get(:config_path, fallback: './config.rb')
+          app.run(File.read(config)) if File.exist?(config)
 
           @@bootstrapped = true
         end

data/lib/frontman/builder/builder.rb

@@ -79,11 +79,31 @@ module Frontman
           .returns(Frontman::Builder::File)
       end
       def build_from_asset(path, manifest_path)
-        target_path = create_target_path(manifest_path)
+        target = manifest_path
+
+        if Frontman::Config.get(:fingerprint_assets, fallback: false)
+          path_with_digest = add_asset_to_manifest(manifest_path, path)
+          target = path_with_digest
+        end
+
+        target_path = create_target_path(target)
 
         build_from_content(target_path, ::File.read(path))
       end
 
+      sig do
+        params(manifest_path: String, file_path: String)
+          .returns(String)
+      end
+      def add_asset_to_manifest(manifest_path, file_path)
+        path_with_digest = manifest_path.sub(/\.(\w+)$/) do |ext|
+          "-#{digest(file_path)}#{ext}"
+        end
+
+        Frontman::App.instance.add_to_manifest(manifest_path, path_with_digest)
+        path_with_digest
+      end
+
       sig do
         params(path: String, manifest_path: String)
           .returns(Frontman::Builder::File)

data/lib/frontman/data_store_file.rb

@@ -56,5 +56,10 @@ module Frontman
     def to_s
       "<DataStoreFile #{@data.keys.join(', ')} >"
     end
+
+    sig { returns(Frontman::DataStoreFile) }
+    def to_ostruct
+      self
+    end
   end
 end

data/lib/frontman/iterator.rb

@@ -6,8 +6,6 @@ require 'parallel'
 module Frontman
   class Iterator
     class << self
-      extend T::Sig
-
       def map(collection, *options, &block)
         forward(:map, collection, *options, &block)
       end

data/lib/frontman/version.rb

@@ -2,5 +2,5 @@
 
 module Frontman
   # Current Version
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/project-templates/webpack/config.rb

@@ -16,6 +16,7 @@ add_asset_pipeline(
 
 Frontman::Config.set :public_dir, '.tmp/'
 Frontman::Config.set :domain, 'https://example.com'
+Frontman::Config.set :fingerprint_assets, true
 
 Frontman::Bootstrapper.resources_from_dir(
   'source/'

data/project-templates/webpack/package-lock.json

@@ -3009,9 +3009,9 @@
       "dev": true
     },
     "elliptic": {
-      "version": "6.5.2",
-      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.2.tgz",
-      "integrity": "sha512-f4x70okzZbIQl/NSRLkI/+tteV/9WqL98zx+SQ69KbXxmVrmjwsNUPn/gYJJ0sHvEak24cZgHIPegRePAtA/xw==",
+      "version": "6.5.3",
+      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.3.tgz",
+      "integrity": "sha512-IMqzv5wNQf+E6aHeIqATs0tOLeOTwj1QKbRcS3jBbYkl5oLAserA8yJTT7/VyHUYG91PRmPyeQDObKLPpeS4dw==",
       "dev": true,
       "requires": {
         "bn.js": "^4.4.0",
@@ -4354,9 +4354,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==",
+      "version": "4.17.20",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.20.tgz",
+      "integrity": "sha512-PlhdFcillOINfeV7Ni6oF1TAEayyZBoZ8bcshTHqOYJYlrqzRK5hagpagky5o4HfCzzd1TRkXPMFq6cKk9rGmA==",
       "dev": true
     },
     "lodash.memoize": {

data/readme.md

@@ -1,20 +1,22 @@
 ⚠️  **Frontman is currently in an alpha release**, which can involve breaking changes. However, we try to preserve backwards compatibility as much as possible, and we document all changes in the [changelog][changelog].
 
+<div align="center">
+
 # Frontman
 
 [![CircleCI](https://circleci.com/gh/algolia/frontman/tree/master.svg?style=shield&circle-token=ea3dfd1f27a86d050cbc806d3cbd27c1742746ac)](https://circleci.com/gh/algolia/frontman/tree/master)
 [![License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)][license]
 [![Gem Version](http://img.shields.io/gem/v/frontman-ssg.svg?style=flat)][gem]
-[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)
-
+[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/algolia/frontman/issues)
 
-![Frontman](frontman.svg)
+<img src="frontman.svg" alt="Frontman" height="200"/>
 
 Frontman is a static site generator written in Ruby, optimized for speed. It helps you convert your content to static HTML files, so you can focus on your content instead of maintaining servers.
 
-
 **Check out our [wiki][wiki] for detailed documentation.**
 
+</div>
+
 ## About Frontman
 Frontman is heavily inspired by [Middleman][middleman], a fantastic static site generator with a large community and feature set. We've used it for a long time, with great success.
 However, once our project reached a certain size, we realized that Middleman had a few shortcomings when it comes to performance. It was becoming a serious bottleneck for us to iterate fast. After unsuccessfully trying to improve build time, we had to move away from it. Instead of undertaking a huge, lengthy migration to another tool and language, we decided to preserve our current codebase, and create our own, Middleman-inspired static site generator.

data/spec/frontman/data_store_file_spec.rb

@@ -3,7 +3,17 @@
 
 require './spec/spec_setup'
 require 'lib/frontman/data_store_file'
+require 'lib/frontman/data_store'
 
 describe Frontman::DataStoreFile do
-  # TODO: determine best tests
+  subject do
+    data = Frontman::DataStore.new("#{__dir__}/mocks")
+    data.info
+  end
+
+  describe '#to_ostruct' do
+    it 'does not convert to custom struct' do
+      expect(subject.to_ostruct.is_a?(Frontman::DataStoreFile)).to eq true
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frontman-ssg
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Devin Beeuwkes
@@ -340,10 +340,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/CODEOWNERS"
 - ".github/CODE_OF_CONDUCT.md"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/RELEASE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md