rails_build 2.4.2 → 2.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fdeb8b08b19d89fe8b117fa6113056fa1c7cc7df38b66780f043fc970cde7ab
-  data.tar.gz: dc3342b95ad179fd2da82f57c0c41cf296796b0b7ebc92ef5f8011415ccd08ab
+  metadata.gz: 85f445833fa2d2a73f3fdcc41602c12a29b0710c3efe1f22fb3ca2255f28d0b3
+  data.tar.gz: c763470f51741a1082165bc9d4d67fe6528904bc5ac4598fad840a1b3025f702
 SHA512:
-  metadata.gz: 8c50a5d183280afadf89c695190d72fcfda5ed7cb4cfabd29c05acf4931749229d814c366e92f654935d3b4a4975f05c97e881717b3ca4713c91d30fa632dae6
-  data.tar.gz: ca443255a67532b1aa5a67edae2b5f745825b0a7f0f94bacdb8cd0c5e553764a33568a36647ee823cb2a60542c224860bc7be236ec834d457dc32e16a6f7aedd
+  metadata.gz: 3c1776c7af9d7b84230b00d573503897a90109f01c77ff4e039dce651dd7f4bb01333b30efe773f3dca9bf7b5b6a014e8211683e0b13a52b4b79cc61f13fbee6
+  data.tar.gz: c546c9901cfc78d879e6089e1a4ff59061e5b62f67706f9c712b035aff35e17e350d536323e8be2314b84333a21bc69b30667bf07edb4e43fe011504015c3315

data/LICENSE

@@ -1 +1 @@
-Ruby
+Nonstandard

data/README.md

@@ -3,27 +3,20 @@
 - install
 
   ```sh
-
     echo 'gem "raild_build"' >> Gemfile
-
     bundle
-
   ```
 
 - setup
 
   ```sh
-
     rails_build --init
-
   ```
 
 - build
 
   ```sh
-
     rails_build
-
   ```
 
 - deploy?
@@ -49,77 +42,144 @@
   absolutely minimal configuration.  it should be pretty darn self
   explanatory:
 
-```ruby
+  ```ruby
+
+    # file : ./config/rails_build.rb
 
-  # file : ./config/rails_build.rb
+    <<~________
 
-  <<~________
+      this file should to enumerate all the urls you'd like to build
 
-    this file should to enumerate all the urls you'd like to build
+      the contents of your ./public directory, and any assets, are automaticaly
+      included
 
-    the contents of your ./public directory, and any assets, are automaticaly
-    included
+      therefore you need only declare which dynamic urls, that is to say, 'routes'
 
-    therefore you need only declare which dynamic urls, that is to say, 'routes'
+      you would like included in your build
 
-    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
 
-    it is not loaded except during build time, and will not affect your normal
-    rails app in any way
+    ________
 
-  ________
 
+    RailsBuild.configure do |config|
 
-  RailsBuild.configure do |config|
+      # most of the time you are going to want your root route included, which
+      # will translate into an ./index.html being output in the build, as you
+      # would expect.
+      #
 
-    # most of the time you are going to want your route included, which will
-    # translate into an ./index.html being output in the build
-    #
+      config.urls << '/'
 
-    config.urls << '/'
+      # include any/all additional routes youd' like built thusly
+      #
 
-    # include any/all additional routes youd' like built thusly
-    #
+      Post.each do |post|
+        config.urls << "/posts/#{ post.id }"
+      end
+
+      # thats it! - now just run `rails_build` and you are gtg
 
-    Post.each do |post|
-      config.urls << "/posts/#{ post.id }"
     end
 
-    # thats it! - now just run `rails_build` and you are GTG
+  ```
+
+# CONFIGURATION
+
+  although `rails_build` aims to be as zero-config as possible, it does expose
+  a few configuration settings, which you may configure in
+  `config/rails_build.rb`:
+
+    - *config.urls*
+
+      as shown above, the config has a list of urls that the build process
+      will GET.  this is a simple array and contains only '/' by default, the
+      root route, such that the default unconfigured build would map '/' ->
+      'index.html' and not be empty.  if your app does not have a root route,
+      or you do not wish to include that route in your build, simply call
+      `config.urls.clear`
+
 
-  end
+  - *config.force_ssl*
 
-```
+    this one can be important.  when `rails_build` starts your rails app, it
+    does so with *RAILS_ENV=production*, such that the build is of production
+    quality and speed.  (you can change this by running `rails_build
+    --env=development`, etc.).  this can cause issues since the build runs on
+    localhost, and rails (without `thruster`), has no facility for ssl
+    termination.  as such, you may want the the following
+
+    ```ruby
+      # file : ./config/environments/production.rb
+
+      config.force_ssl = ENV['RAILS_BUILD'] ? false : true
+    ```
+
+  - *config.index_html*
+
+    controls the mapping of urls to build files, eg.
+
+    ```ruby
+      RailsBuild.configure do
+        config.index_html = true # the default
+        config.urls << "/post/42" #=> ./build/posts/42/index.html
+      end
+
+      # vs.
+
+      RailsBuild.configure do
+        config.index_html = false
+        config.urls << "/post/42" #=> ./build/posts/42.html
+      end
+    ```
+
+  - *config.path*
+
+    this is the path to the build config file itself, the default is
+    `./config/rails_build.rb`, as you would expect
+
+  - *config.trailing_slash*
+
+    this is current un-used, but maybe be used in the future.  it's default is the
+    value of
+
+    ```ruby
+      Rails.application.default_url_options[:trailing_slash]
+    ```
 
 # MOTIVATION
 
-why another static site builder?  why not hugo or, the
-other-soon-to-be-released-blazing-fast-one-i-am-building-on Roda?
+  why yet _another_ static site builder?  why not hugo or, the
+  other-soon-to-be-released-blazing-fast-one-i-am-building-on Roda?
+
+  because:
 
-because:
+    - there are a lot of Rails apps
+    - nothing is as fast as static
+    - Rails has no facility to 'pre-render' routes on deployment
 
-- there are a lot of Rails apps
-- nothing is as fast as static
-- Rails has no facility to 'pre-render' routes on deployment
+  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.
 
-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.
 
-# HOW IT WORKS
+# RTFM
 
-as always, docs are worthless and Ruby is beautiful, so #RTFC ->
+  as always, docs are worthless and ruby is beautiful, so #RTFC ->
 
-  https://github.com/ahoward/rails_build/blob/main/bin/rails_build
+    https://github.com/ahoward/rails_build/blob/main/bin/rails_build
 
 
 # LICENSE
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+  the gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 # AI _boo_
 
-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.
+  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 (that is not a
+  typo) your llm is oss, please contact me directly before including this source.
+
+  any usage by openai, or google, is forbidden regardless.

data/bin/rails_build

@@ -194,7 +194,7 @@ module RailsBuild
 
   #
     def init!
-      config = DATA.read.strip
+      config = SAMPLE_CONFIG
 
       path = './config/rails_build.rb'
 
@@ -288,7 +288,7 @@ module RailsBuild
 
     def extract_urls!
       path = @config.path
-      urls = @config.urls
+      urls = @config.urls.uniq
 
       if urls.size == 0
         abort("failed to find any rails_build urls in:\n#{ @config.to_json }")
@@ -361,88 +361,6 @@ module RailsBuild
       end
     end
 
-  #
-=begin
-    def parallel_build!
-      size = @parallel
-
-      stats = {
-        :success => [],
-        :missing => [],
-        :failure => [],
-      }
-
-      times = []
-
-      elapsed = timing do
-        ThreadPool.new(size:) do |tp|
-          tp.run do
-            @urls.each{|url| tp.process!(url:)}
-          end
-
-          tp.process do |url:|
-            uri = uri_for(url)
-            path = path_for(uri)
-
-            upath = uri.path
-            rpath = relative_path(path, :from => @directory)
-
-            code = nil
-            body = nil
-
-            time =
-              timing do
-                code, body = http_get(uri)
-                write_path(path, body) if code == 200
-              end
-
-            tp.success!(url:, rpath:, time:, code:)
-          end
-
-          tp.success do |url:, rpath:, time:, code:|
-            times.push(time)
-            rps = (times.size / times.sum).round(4)
-            msg = "#{ url } -> /#{ rpath } (time:#{ time }, rps:#{ rps }, code:#{ code })"
-
-            case code
-              when 200
-                log(:info, msg)
-                stats[:success].push(url)
-              when 404
-                log(:error, msg)
-                stats[:missing].push(url)
-              else
-                log(:error, msg)
-                stats[:failure].push(url)
-            end
-          end
-        end
-      end
-
-      borked = 0
-
-      if stats[:missing].size > 0
-        borked += stats[:missing].size
-        log(:error, "missing on #{ stats[:missing].size } url(s)")
-      end
-
-      if stats[:failure].size > 0
-        borked += stats[:failure].size
-        log(:error, "failure on #{ stats[:failure].size } url(s)")
-      end
-
-      if borked > 0
-        exit(borked)
-      end
-
-      rps = (times.size / times.sum).round(4)
-
-      log(:info, "downloaded #{ @urls.size } urls at ~#{ rps } rps")
-
-      @urls
-    end
-=end
-
 #
     def parallel_build!
       size = @parallel
@@ -883,37 +801,40 @@ END {
   RailsBuild::CLI.run!
 }
 
-__END__
-<<~________
+module RailsBuild
+  SAMPLE_CONFIG =  <<~'__'
+    <<~________
 
-  this file should to enumerate all the urls you'd like to build
+      this file should to enumerate all the urls you'd like to build
 
-  the contents of your ./public directory, and any assets, are automaticaly included
+      the contents of your ./public directory, and any assets, are automaticaly included
 
-  therefore you need only declare which dynamic urls, that is to say, 'routes'
+      therefore you need only declare which dynamic urls, that is to say, 'routes'
 
-  you would like included in your build
+      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
+      it is not loaded except during build time, and will not affect your normal rails app in any way
 
-________
+    ________
 
 
-RailsBuild.configure do |config|
+    RailsBuild.configure do |config|
 
-  # most of the time you are going to want your route included, which will
-  # translate into an ./index.html being output in the build
-  #
+      # most of the time you are going to want your route included, which will
+      # translate into an ./index.html being output in the build
+      #
 
-  config.urls << '/'
+      config.urls << '/'
 
-  # include any/all additional routes youd' like built thusly
-  #
+      # include any/all additional routes youd' like built thusly
+      #
 
-  Post.each do |post|
-    config.urls << "/posts/#{ post.id }"
-  end
+      Post.each do |post|
+        config.urls << "/posts/#{ post.id }"
+      end
 
-  # thats it! - now just run `rails_build` and you are GTG
+      # thats it! - now just run `rails_build` and you are GTG
 
+    end
+  __
 end

data/lib/rails_build/_lib.rb

@@ -1,5 +1,5 @@
 module RailsBuild
-  VERSION = '2.4.2' unless defined?(VERSION)
+  VERSION = '2.4.4' unless defined?(VERSION)
 
   class << self
     def version

data/lib/rails_build.rb

@@ -72,7 +72,7 @@ module RailsBuild
       defaults = {
         path: RailsBuild.config_path,
         trailing_slash: (defined?(Rails) ? !!Rails.application.default_url_options[:trailing_slash] : false),
-        force_ssl: (defined?(Rails) ? !!Rails.configuration.force_ssl : true),
+        force_ssl: (defined?(Rails) ? !!Rails.configuration.force_ssl : false),
         urls: %w[ / ],
         index_html: true,
       }

data/rails_build.gemspec

@@ -3,12 +3,12 @@
 
 Gem::Specification::new do |spec|
   spec.name = "rails_build"
-  spec.version = "2.4.2"
+  spec.version = "2.4.4"
   spec.required_ruby_version = '>= 3.0'
   spec.platform = Gem::Platform::RUBY
   spec.summary = "a small, simple, bullet proof, and fast enough static site generator built on top of the rails you already know and love"
   spec.description = "rails_build is a very small, fast enough, static site generator built\non top of the rails you already know and love.\n\nit's been in production usage for close to a decade but i've been too\nbusy to relase it until now.  also, #wtf is up with javascript land?!\n\nit has a small set of dependencies, namely the `parallel` gem, and\nrequires absolutely minimal configuration.  it should be pretty darn\nself explanatory:"
-  spec.license = "Ruby"
+  spec.license = "Nonstandard"
 
   spec.files =
 ["LICENSE",
@@ -16,8 +16,6 @@ Gem::Specification::new do |spec|
  "Rakefile",
  "bin",
  "bin/rails_build",
- "config",
- "config/rails_build.rb",
  "lib",
  "lib/rails_build",
  "lib/rails_build.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_build
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.4
 platform: ruby
 authors:
 - Ara T. Howard
@@ -58,13 +58,12 @@ files:
 - README.md
 - Rakefile
 - bin/rails_build
-- config/rails_build.rb
 - lib/rails_build.rb
 - lib/rails_build/_lib.rb
 - rails_build.gemspec
 homepage: https://github.com/ahoward/rails_build
 licenses:
-- Ruby
+- Nonstandard
 metadata: {}
 post_install_message:
 rdoc_options: []

data/config/rails_build.rb

@@ -1,33 +0,0 @@
-<<~________
-
-  this file should to enumerate all the urls you'd like to build
-
-  the contents of your ./public directory, and any assets, are automaticaly included
-
-  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
-
-________
-
-
-RailsBuild.configure do |config|
-
-  # most of the time you are going to want your route included, which will
-  # translate into an ./index.html being output in the build
-  #
-
-  config.urls << '/'
-
-  # include any/all additional routes youd' like built thusly
-  #
-
-  Post.each do |post|
-    config.urls << "/posts/#{ post.id }"
-  end
-
-  # thats it! - now just run `rails_build` and you are GTG
-
-end