fresco 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93c55d52fcf4445d93f529ebfbc40fd21ba6844f7af94f516e305ebfd827d62a
-  data.tar.gz: fe611cbe51502fc2cbe2229796a68cb5c1e841869389f2cd3859a51a229a76c9
+  metadata.gz: 4f7b6f64c6bd5b23261c7452d83024a166651fefb519c4673d6bb36ffa483acc
+  data.tar.gz: 3fc5c6e9ae09f243159fc50bb870e7058e04a20641a6705475b4b2274d97f2d4
 SHA512:
-  metadata.gz: 38cd762b679821ba12347aed98ddc83e95a935bedeec0b0a836c8812ee56d621b9c3e2aceb3976319e4f118f9c53ff52771c8ba0be72caa18a868a2d62b58cf0
-  data.tar.gz: 24cacf9b0c77e7f899ae775898384d4aa497686cf90e0a9a2267d7873c63e208501e4e2897deb5fbd7e2ed78db602129677a0a42b77001708fd18b01dd621f76
+  metadata.gz: 6ba5dbf005600b3965e5937bd946d1beff29d7daacc55e7cbd8911568cddcbc951894c34a262c87c919766fea8c2fb283462127d2da7920c369d01bc55911e77
+  data.tar.gz: c211e492fa047174125d398a3146d70c774249030ff47e47ca397111cde05893602c02db2038319a90bb1228bbef648d7d71e05195e6c8365b88a2313fcb57dc

data/README.md

@@ -0,0 +1,169 @@
+# Fresco
+
+An application framework for Ruby that compiles to a static binary via
+[Spinel][spinel]. Two modes from the same source tree:
+
+- **Dev**: CRuby with auto-reload — `bin/dev`.
+- **Release**: a single static binary, no Ruby on the host — `bin/release`
+  produces `build/app`.
+
+A build-time DSL (routes, schema, models, migrations) is captured under
+CRuby and codegen'd into `generated/`. The generated tree is what Spinel
+AOT-compiles for release; CRuby loads the same tree for dev.
+
+For a runnable tour of the framework, see
+[afomera/fresco-example][fresco-example].
+
+[spinel]: https://github.com/matz/spinel
+[fresco-example]: https://github.com/afomera/fresco-example
+
+## Install
+
+```sh
+gem install fresco
+```
+
+Or in a Gemfile:
+
+```ruby
+gem "fresco"
+```
+
+Requires Ruby `>= 3.0` for the dev loop. The release binary has no Ruby
+runtime dependency on the host machine.
+
+## Installing Spinel
+
+`fresco dev` runs under CRuby and does **not** need Spinel. `fresco
+release` shells out to a `spinel` binary to AOT-compile your app, so you
+need Spinel installed before you ship a build.
+
+Spinel doesn't ship a prebuilt binary today — clone and build it from
+source:
+
+```sh
+# Pick a checkout location. We'll symlink the resulting binary into your
+# Fresco app, so anywhere on disk is fine.
+git clone https://github.com/matz/spinel.git
+cd spinel
+
+make deps    # fetch and build Spinel's vendored dependencies
+make all     # build the spinel binary
+```
+
+That produces a `spinel` executable in the repo root. `fresco release`
+looks for it in this order:
+
+1. `./spinel` in the Fresco app directory (symlink or copy)
+2. `./vendor/spinel/bin/spinel`
+3. `spinel` on `$PATH`
+
+The simplest setup is a symlink at the app root:
+
+```sh
+cd path/to/your-fresco-app
+ln -s /absolute/path/to/spinel/spinel ./spinel
+```
+
+`.gitignore` the symlink — the binary is per-machine.
+
+### macOS Postgres note
+
+If your app uses the Postgres adapter, `fresco release` auto-detects
+Homebrew's keg-only `libpq` (`/opt/homebrew/opt/libpq`,
+`/usr/local/opt/libpq`) and `Postgres.app`, and prepends their
+`include/` and `lib/` to `CPATH` / `LIBRARY_PATH` so Spinel's compile of
+the libpq shim resolves `libpq-fe.h` and `-lpq` without manual export.
+SQLite builds need no extra setup.
+
+## Quick start
+
+```sh
+fresco new bookshelf
+cd bookshelf
+bundle install
+bin/dev
+```
+
+Open <http://localhost:3030/>.
+
+To build a release binary:
+
+```sh
+ln -s /path/to/spinel/spinel ./spinel
+bin/release
+./build/app
+```
+
+## Commands
+
+```
+fresco new <name>    Scaffold a new app in ./<name>/
+fresco build         Regenerate generated/* from config + app/
+fresco dev           Run the CRuby dev loop (build + watch + serve)
+fresco release       Build a Spinel-compiled binary at ./build/app
+```
+
+The scaffolded app's `bin/dev`, `bin/build`, and `bin/release` are thin
+wrappers around `bundle exec fresco <subcommand>`.
+
+### `fresco new` flags
+
+```
+--fresco-path <dir>   Pin the generated Gemfile to a path-installed
+                      fresco (useful when co-developing fresco itself).
+```
+
+## App layout
+
+A Fresco app generated by `fresco new` looks like:
+
+```
+app/
+  action.rb            # base class
+  actions/             # request handlers
+  models/              # build-time model declarations
+  views/               # ERB templates (compiled at build time)
+config/
+  app.rb               # framework config
+  database.rb          # adapter + DSN (omit for no DB)
+  routes.rb            # route table
+db/
+  schema.rb            # table declarations
+  migrations/          # versioned SQL migrations
+bin/
+  dev, build, release  # wrappers for `bundle exec fresco …`
+app.rb                 # Spinel entry point
+```
+
+`generated/` and `build/` are produced by the toolchain and should be
+gitignored.
+
+## How dev and release stay in sync
+
+Both modes load the same `generated/` tree. `fresco dev` re-runs the
+build step on file changes; `fresco release` runs it once and hands the
+result to Spinel. There is no separate "production codepath" to drift —
+if a route works in dev, it works in the compiled binary (modulo Spinel's
+Ruby subset, which `rubocop_spinel` lints for at build time when present
+in your Gemfile).
+
+## Development of the gem itself
+
+```sh
+bundle install
+bundle exec rake build     # → pkg/fresco-<version>.gem
+bundle exec rake install   # build + install locally
+bundle exec rake release   # tag + push to rubygems.org
+```
+
+When iterating on `fresco` alongside an app, scaffold the app against
+your working copy:
+
+```sh
+fresco new myapp --fresco-path ../fresco
+```
+
+## License
+
+MIT.

data/lib/fresco/cli/new.rb

@@ -64,7 +64,7 @@ module Fresco
         locals = {
           app_name:      app_name,
           module_name:   camelize(app_name),
-          fresco_source: fresco_path ? ", path: #{File.expand_path(fresco_path).inspect}" : "",
+          fresco_source: fresco_path ? ", path: #{File.expand_path(fresco_path).inspect}" : ", source: \"https://rubygems.org\"",
         }
 
         FileUtils.mkdir_p(target)

data/lib/fresco/version.rb

@@ -1,3 +1,3 @@
 module Fresco
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fresco
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrea Fomera
@@ -46,6 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - exe/fresco
 - lib/fresco.rb
 - lib/fresco/application.rb