rails_build 1.0.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cd82bac7610eed4089c5be9667a685dea9ebd327
-  data.tar.gz: 99110d59847285fad099e0769f333f49aded632f
+SHA256:
+  metadata.gz: 2fdeb8b08b19d89fe8b117fa6113056fa1c7cc7df38b66780f043fc970cde7ab
+  data.tar.gz: dc3342b95ad179fd2da82f57c0c41cf296796b0b7ebc92ef5f8011415ccd08ab
 SHA512:
-  metadata.gz: 4c4ddd3929c28ada377db4c57811e3934aaeeaae6e30e6fa920f158e5cd7c9bce2276111fbda6f15b23685658fe88cb107593d981e8bf4d0dd9788036eb9f8be
-  data.tar.gz: e1203289ae526130f34645705cefc37edf2409065671bd591991084755eabe7e0aeb1a37838dc9d94bde6a9793d370163f24cce9ccac9843cf443322c2a55642
+  metadata.gz: 8c50a5d183280afadf89c695190d72fcfda5ed7cb4cfabd29c05acf4931749229d814c366e92f654935d3b4a4975f05c97e881717b3ca4713c91d30fa632dae6
+  data.tar.gz: ca443255a67532b1aa5a67edae2b5f745825b0a7f0f94bacdb8cd0c5e553764a33568a36647ee823cb2a60542c224860bc7be236ec834d457dc32e16a6f7aedd

data/LICENSE

@@ -0,0 +1 @@
+Ruby

data/README.md

@@ -1,179 +1,125 @@
-# RailsBuild
+# TL;DR;
 
-A very small, very simple, very fast, and bullet proof static site generator
-built as a Rails 5 engine.
+- install
 
+  ```sh
 
+    echo 'gem "raild_build"' >> Gemfile
 
-## How It Works
+    bundle
 
-RailsBuild bundles all your assets, public directory, and configured urls into
-a static site suitable for deployment to Netlify, Amazon S3, or your favorite
-static website hosting solution.  It does this by:
+  ```
 
-- Booting your application in *production* mode
-- Precompiling all assets
-- Including every static resource in ./public/
-- GET'ing every configured url via super fast parallel downloading
+- setup
 
-RailsBuild let's you leverage the entire Rails' ecosystem for your static
-sites and requires learning practically no new techniques to make super fast
-building static websites.
+  ```sh
 
+    rails_build --init
 
+  ```
 
-## Configuration
+- build
 
-Configuration is quite simple, typically it will be much less than comparable
-static site generators.  You need to drop a *./config/rails_build.rb* looking
-something like this into your app:
+  ```sh
 
-```ruby
-
-  RailsBuild.configure do |rails_build|
-
-    urls = rails_build.urls
-
-    urls << "/"
-
-    urls << "/about/"
-
-    urls << "/contact/"
-
- 
-    Post.each do |post|
-      urls << blog_path(post) 
-    end
-
-  end
-
-
-```
-
-That's it: simply enumerate the urls - anything additional to your assets and
-./public/ directory - that you want to include in your build.
-
-## On Trailing Slashes
-
-Most static hosting solutions support Apache style directory indexing will be
-better behaved with urls that look like
-
-```markdown
-
-  http://my.site.com/blog/
-
-```
-
-vs.
-
-```markdown
-
-  http://my.site.com/blog
-
-```
-
-RailsBuild tries to help you do this with a little bit of Rails' config that
-is turned on by default but which can be turned off via
+    rails_build
 
-```ruby
-
-  RailsBuild.configure do |rails_build|
-
-    rails_build.trailing_slash false  # the default is 'true'
-
-  end
-
-```
+  ```
 
-The only real impact will be felt if you are using relative urls in your site
-like './about' vs. '../about'
+- deploy?
 
+  the contents of ./build/ are good to deploy to *any* static web host
+  including netlify, vercel, an s3 bucket, or simply your app's own ./public
+  directory in order to 'pre-cache' a ton of pages
 
+  ps. if you want to preview your local static ./build i *highly* recommend
 
-## Optimization and Notes
+    https://github.com/copiousfreetime/launchy
 
 
-RailsBuild is fast.  Very fast.  [DOJO4](http://dojo4.com) has seen optimized [Middleman](https://middlemanapp.com/) builds of > 30 minutes dropped to *60 seconds* by simply making basic use of Rails' built-in caching facilites.
-
-When trying to squeeze out performance just remember that RailsBuild runs in
-production mode and, therefore, making a build go fast follows the *exact same
-rules* as making anything other Rails' application fast.  The first place to
-reach is typically fragment caching of partials used in your app.
-
-Finally, don't forget about *./config/initializers/assets.rb* - RailsBuild
-doesn't do anything special to the asset pipeline and only those assets
-normally built when
-
-```bash
-
-  ~> rake assets:precompile
-
-```
-
-is run will be included in the build.
+# ABOUT
 
+  rails_build is a very small, fast enough, static site generator built on top
+  of the rails you already know and love.
 
+  it's been in production usage for close to a decade but i've been too busy
+  to relase it until now.  also, #wtf is up with javascript land?!
 
-## Installation
-
-Add this line to your application's Gemfile:
+  it has a small set of dependencies, namely the `parallel` gem, and requires
+  absolutely minimal configuration.  it should be pretty darn self
+  explanatory:
 
 ```ruby
 
-  gem 'rails_build'
-
-
-```
+  # file : ./config/rails_build.rb
 
-And then execute:
+  <<~________
 
-```bash
+    this file should to enumerate all the urls you'd like to build
 
-$ bundle
+    the contents of your ./public directory, and any assets, are automaticaly
+    included
 
-$ bundle binstubs rails_build
-
-
-```
+    therefore you need only declare which dynamic urls, that is to say, 'routes'
 
+    you would like included in your build
 
+    it is not loaded except during build time, and will not affect your normal
+    rails app in any way
 
-## Building Your Site
+  ________
 
 
-After installation and configuration simply run
+  RailsBuild.configure do |config|
 
-```bash
+    # most of the time you are going to want your route included, which will
+    # translate into an ./index.html being output in the build
+    #
 
-  ~> ./bin/rails_build
+    config.urls << '/'
 
+    # include any/all additional routes youd' like built thusly
+    #
 
-# or, if you prefer, simply
+    Post.each do |post|
+      config.urls << "/posts/#{ post.id }"
+    end
 
-  ~> rails build
+    # thats it! - now just run `rails_build` and you are GTG
 
+  end
 
 ```
 
+# MOTIVATION
 
+why another static site builder?  why not hugo or, the
+other-soon-to-be-released-blazing-fast-one-i-am-building-on Roda?
 
-## Netlfiy
+because:
 
-We love Netlify at [DOJO4](http://dojo4.com).  RailsBuild works with netlify
-out of the box and simply requires
+- there are a lot of Rails apps
+- nothing is as fast as static
+- Rails has no facility to 'pre-render' routes on deployment
 
-```yaml
+so, you can use this tool to leverage the code and the app you already have,
+and/or to utilize the entire Rails ecosystem, it's docs and gems, to build
+sophisticated sites without needing to learn yet another framework.
 
-  build_command : rails_build
+# HOW IT WORKS
 
-  build_directory: build
+as always, docs are worthless and Ruby is beautiful, so #RTFC ->
 
-```
+  https://github.com/ahoward/rails_build/blob/main/bin/rails_build
 
-to be configured as the build command and directory respectively.
 
+# LICENSE
 
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
-## License
+# AI _boo_
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Any and all usage, in any way, shape, or form, in prohibited by any AI
+application, or LLM.  This includes indexing, knowing about, training on, or
+existing inside a commercial LLM or training data set.  Iff (and *only* if)
+your LLM is OSS, please contact me directly before including this source.