diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..ef21dc6 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,65 @@ +name: CI + +on: + push: + branches: + - main + pull_request: + +jobs: + coverage: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: .ruby-version + bundler-cache: true + + - name: Bootstrap + run: bin/bootstrap + + - name: Coverage + run: bundle exec bake coverage + + lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: .ruby-version + bundler-cache: true + + - name: Bootstrap + run: bin/bootstrap + + - name: Lint + run: bundle exec bake lint + + debug: + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Ruby + uses: ruby/setup-ruby@v1 + with: + ruby-version: .ruby-version + bundler-cache: true + + - name: Bootstrap + run: bin/bootstrap + + - name: Debug Build + run: bundle exec bake debug diff --git a/.gitignore b/.gitignore index fd286b6..84c0cbd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,2 @@ www Tests/*/actual -bin/gensite diff --git a/.ruby-version b/.ruby-version new file mode 100644 index 0000000..1454f6e --- /dev/null +++ b/.ruby-version @@ -0,0 +1 @@ +4.0.1 diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..23ee274 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,75 @@ +# Repository Guidelines + +## Project Structure & Module Organization +This repository is a single Ruby static-site generator project (the legacy Swift generators were removed). + +- Generator code: `lib/pressa/` (entrypoint: `lib/pressa.rb`) +- Build/deploy/draft tasks: `bake.rb` +- Tests: `test/` +- Site config: `site.toml`, `projects.toml` +- Published posts: `posts/YYYY/MM/*.md` +- Static and renderable public content: `public/` +- Draft posts: `public/drafts/` +- Generated output: `www/` (safe to delete/regenerate) + +Keep new code under the existing `Pressa` module structure (for example `lib/pressa/posts`, `lib/pressa/projects`, `lib/pressa/views`, `lib/pressa/config`, `lib/pressa/utils`) and add matching tests under `test/`. + +## Setup, Build, Test, and Development Commands +- Use `rbenv exec` for Ruby commands in this repository (for example `rbenv exec bundle exec ...`) to ensure the project Ruby version is used. +- `bin/bootstrap`: install prerequisites and gems (uses `rbenv` when available). +- `rbenv exec bundle exec bake debug`: build for `http://localhost:8000` into `www/`. +- `rbenv exec bundle exec bake serve`: serve `www/` via WEBrick on port 8000. +- `rbenv exec bundle exec bake watch target=debug`: Linux-only autorebuild loop (`inotifywait` required). +- `rbenv exec bundle exec bake mudge|beta|release`: build with environment-specific base URLs. +- `rbenv exec bundle exec bake publish_beta|publish`: build and rsync `www/` to remote host. +- `rbenv exec bundle exec bake clean`: remove `www/`. +- `rbenv exec bundle exec bake test`: run test suite. +- `rbenv exec bundle exec bake lint`: lint code. +- `rbenv exec bundle exec bake lint_fix`: auto-fix lint issues. +- `rbenv exec bundle exec bake coverage`: run tests and report `lib/` line coverage. +- `rbenv exec bundle exec bake coverage_regression baseline=merge-base`: compare coverage to a baseline and fail on regression (override `baseline` as needed). + +## Draft Workflow +- `rbenv exec bundle exec bake new_draft "Post Title"` creates `public/drafts/.md`. +- `rbenv exec bundle exec bake drafts` lists available drafts. +- `rbenv exec bundle exec bake publish_draft public/drafts/.md` moves draft to `posts/YYYY/MM/` and updates `Date` and `Timestamp`. + +## Content and Metadata Requirements +Posts must include YAML front matter. Required keys (enforced by `Pressa::Posts::PostMetadata`) are: + +- `Title` +- `Author` +- `Date` +- `Timestamp` + +Optional keys include `Tags`, `Link`, `Scripts`, and `Styles`. + +## Coding Style & Naming Conventions +- Ruby (see `.ruby-version`). +- Follow idiomatic Ruby style and keep code `bake lint`-clean. +- Use 2-space indentation and descriptive `snake_case` names for methods/variables, `UpperCamelCase` for classes/modules. +- Prefer small, focused classes for plugins, views, renderers, and config loaders. +- Do not hand-edit generated files in `www/`. + +## Testing Guidelines +- Use Minitest under `test/` (for example `test/posts`, `test/config`, `test/views`). +- Add regression tests for parser, rendering, feed, and generator behavior changes. +- Before submitting, run: + - `rbenv exec bundle exec bake test` + - `rbenv exec bundle exec bake coverage` + - `rbenv exec bundle exec bake lint` + - `rbenv exec bundle exec bake debug` + +## Commit & Pull Request Guidelines +- Use concise, imperative commit subjects (history examples: `Fix internal permalink regression in archives`). +- Keep commits scoped to one concern (generator logic, content, or deployment changes). +- In PRs, include motivation, verification commands run, and deployment impact. +- Include screenshots when changing rendered layout/CSS output. + +## Deployment & Security Notes +- Deployment is defined in `bake.rb` via rsync over SSH. +- Current publish host is `mudge` with: + - production: `/var/www/samhuri.net/public` + - beta: `/var/www/beta.samhuri.net/public` +- Validate `www/` before publishing to avoid shipping stale assets. +- Never commit credentials, SSH keys, or other secrets. diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..906017c --- /dev/null +++ b/Gemfile @@ -0,0 +1,15 @@ +source "https://rubygems.org" + +gem "phlex", "~> 2.3" +gem "kramdown", "~> 2.5" +gem "kramdown-parser-gfm", "~> 1.1" +gem "rouge", "~> 4.6" +gem "dry-struct", "~> 1.8" +gem "builder", "~> 3.3" +gem "bake", "~> 0.20" + +group :development, :test do + gem "guard", "~> 2.18" + gem "minitest", "~> 6.0" + gem "standard", "~> 1.43" +end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..5ea8741 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,178 @@ +GEM + remote: https://rubygems.org/ + specs: + ast (2.4.3) + bake (0.24.1) + bigdecimal + samovar (~> 2.1) + bigdecimal (4.0.1) + builder (3.3.0) + coderay (1.1.3) + concurrent-ruby (1.3.6) + console (1.34.2) + fiber-annotation + fiber-local (~> 1.1) + json + dry-core (1.2.0) + concurrent-ruby (~> 1.0) + logger + zeitwerk (~> 2.6) + dry-inflector (1.3.1) + dry-logic (1.6.0) + bigdecimal + concurrent-ruby (~> 1.0) + dry-core (~> 1.1) + zeitwerk (~> 2.6) + dry-struct (1.8.0) + dry-core (~> 1.1) + dry-types (~> 1.8, >= 1.8.2) + ice_nine (~> 0.11) + zeitwerk (~> 2.6) + dry-types (1.9.1) + bigdecimal (>= 3.0) + concurrent-ruby (~> 1.0) + dry-core (~> 1.0) + dry-inflector (~> 1.0) + dry-logic (~> 1.4) + zeitwerk (~> 2.6) + ffi (1.17.3-aarch64-linux-gnu) + ffi (1.17.3-aarch64-linux-musl) + ffi (1.17.3-arm-linux-gnu) + ffi (1.17.3-arm-linux-musl) + ffi (1.17.3-arm64-darwin) + ffi (1.17.3-x86-linux-gnu) + ffi (1.17.3-x86-linux-musl) + ffi (1.17.3-x86_64-darwin) + ffi (1.17.3-x86_64-linux-gnu) + ffi (1.17.3-x86_64-linux-musl) + fiber-annotation (0.2.0) + fiber-local (1.1.0) + fiber-storage + fiber-storage (1.0.1) + formatador (1.2.3) + reline + guard (2.20.1) + formatador (>= 0.2.4) + listen (>= 2.7, < 4.0) + logger (~> 1.6) + lumberjack (>= 1.0.12, < 2.0) + nenv (~> 0.1) + notiffany (~> 0.0) + pry (>= 0.13.0) + shellany (~> 0.0) + thor (>= 0.18.1) + ice_nine (0.11.2) + io-console (0.8.2) + json (2.18.1) + kramdown (2.5.2) + rexml (>= 3.4.4) + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + language_server-protocol (3.17.0.5) + lint_roller (1.1.0) + listen (3.10.0) + logger + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + logger (1.7.0) + lumberjack (1.4.2) + mapping (1.1.3) + method_source (1.1.0) + minitest (6.0.1) + prism (~> 1.5) + nenv (0.3.0) + notiffany (0.1.3) + nenv (~> 0.1) + shellany (~> 0.0) + parallel (1.27.0) + parser (3.3.10.1) + ast (~> 2.4.1) + racc + phlex (2.4.1) + refract (~> 1.0) + zeitwerk (~> 2.7) + prism (1.9.0) + pry (0.16.0) + coderay (~> 1.1) + method_source (~> 1.0) + reline (>= 0.6.0) + racc (1.8.1) + rainbow (3.1.1) + rb-fsevent (0.11.2) + rb-inotify (0.11.1) + ffi (~> 1.0) + refract (1.1.0) + prism + zeitwerk + regexp_parser (2.11.3) + reline (0.6.3) + io-console (~> 0.5) + rexml (3.4.4) + rouge (4.7.0) + rubocop (1.82.1) + json (~> 2.3) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.1.0) + parallel (~> 1.10) + parser (>= 3.3.0.2) + rainbow (>= 2.2.2, < 4.0) + regexp_parser (>= 2.9.3, < 3.0) + rubocop-ast (>= 1.48.0, < 2.0) + ruby-progressbar (~> 1.7) + unicode-display_width (>= 2.4.0, < 4.0) + rubocop-ast (1.49.0) + parser (>= 3.3.7.2) + prism (~> 1.7) + rubocop-performance (1.26.1) + lint_roller (~> 1.1) + rubocop (>= 1.75.0, < 2.0) + rubocop-ast (>= 1.47.1, < 2.0) + ruby-progressbar (1.13.0) + samovar (2.4.1) + console (~> 1.0) + mapping (~> 1.0) + shellany (0.0.1) + standard (1.53.0) + language_server-protocol (~> 3.17.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.82.0) + standard-custom (~> 1.0.0) + standard-performance (~> 1.8) + standard-custom (1.0.2) + lint_roller (~> 1.0) + rubocop (~> 1.50) + standard-performance (1.9.0) + lint_roller (~> 1.1) + rubocop-performance (~> 1.26.0) + thor (1.5.0) + unicode-display_width (3.2.0) + unicode-emoji (~> 4.1) + unicode-emoji (4.2.0) + zeitwerk (2.7.4) + +PLATFORMS + aarch64-linux-gnu + aarch64-linux-musl + arm-linux-gnu + arm-linux-musl + arm64-darwin + x86-linux-gnu + x86-linux-musl + x86_64-darwin + x86_64-linux-gnu + x86_64-linux-musl + +DEPENDENCIES + bake (~> 0.20) + builder (~> 3.3) + dry-struct (~> 1.8) + guard (~> 2.18) + kramdown (~> 2.5) + kramdown-parser-gfm (~> 1.1) + minitest (~> 6.0) + phlex (~> 2.3) + rouge (~> 4.6) + standard (~> 1.43) + +BUNDLED WITH + 4.0.6 diff --git a/Makefile b/Makefile deleted file mode 100644 index b25386e..0000000 --- a/Makefile +++ /dev/null @@ -1,51 +0,0 @@ -all: debug - -debug: - @echo - bin/build-gensite - bin/gensite . www http://localhost:8000 - -mudge: - @echo - bin/build-gensite - bin/gensite . www http://mudge:8000 - -beta: clean_blog - @echo - bin/build-gensite - bin/gensite . www https://beta.samhuri.net - -release: clean_blog - @echo - bin/build-gensite - bin/gensite . www - -publish: release - @echo - bin/publish --delete www/ - -publish_beta: beta - @echo - bin/publish --beta --delete www/ - -clean: clean_blog - -clean_blog: - @echo - rm -rf www/* www/.htaccess - -clean_swift: - @echo - rm -rf gensite/.build - rm -rf $(HOME)/Library/Developer/Xcode/DerivedData/gensite-* - rm -rf samhuri.net/.build - rm -rf $(HOME)/Library/Developer/Xcode/DerivedData/samhuri-* - -serve: - @echo - cd www && python3 -m http.server --bind localhost - -watch: - bin/watch - -.PHONY: debug beta release publish publish_beta clean clean_blog clean_swift serve watch diff --git a/Readme.md b/Readme.md index 463ade3..e262e04 100644 --- a/Readme.md +++ b/Readme.md @@ -1,252 +1,111 @@ # samhuri.net -The source code for [samhuri.net](https://samhuri.net). +Source code for [samhuri.net](https://samhuri.net), powered by a Ruby static site generator. ## Overview -This is a custom static site generator written in Swift and geared towards blogging, though it's built to be flexible enough to be any kind of static site. As is tradition it gets a lot more attention than my actual writing for the blog. +This repository contains the Ruby static-site generator and site content for samhuri.net. If what you want is an artisanal, hand-crafted, static site generator for your personal blog then this might be a decent starting point. If you want a static site generator for other purposes then this has the bones you need to do that too, by ripping out the bundled plugins for posts and projects and writing your own. -Some features: +- Generator core: `lib/pressa/` (entrypoint: `lib/pressa.rb`) +- Build tasks and utility workflows: `bake.rb` +- Tests: `test/` +- Config: `site.toml` and `projects.toml` +- Content: `posts/` and `public/` +- Output: `www/` -- Plugin-based architecture, including plugins for rendering posts and projects -- Uses Markdown for posts, rendered using [Ink][] and [Plot][] by [@johnsundell][] -- Supports the notion of a link post -- Generates RSS and JSON feeds -- Runs on Linux and macOS, requires Swift 6.0+ +## Requirements -If you don't use the posts or projects plugins then what this does at its core is transform and copy files from `public/` to `www/`, and the only transforms that it performs is Markdown to HTML. Everything else is layered on top of this foundation. +- Ruby (see `.ruby-version`) +- Bundler +- `rbenv` recommended -Posts are [organized by year/month directories](https://github.com/samsonjs/samhuri.net/tree/main/posts), there's [an archive page that lists all posts at /posts](https://samhuri.net/posts), plus individual pages for [each year at /posts/2011](https://samhuri.net/posts/2011) and [each month at /posts/2011/12](https://samhuri.net/posts/2011/12). You can throw [any Markdown file](https://github.com/samsonjs/samhuri.net/blob/main/public/about.md) in `public/` and it gets [rendered as HTML using your site's layout](https://samhuri.net/about). - -The main project is in the [samhuri.net directory][], and there's a second project for the command line tool called [gensite][] that uses the samhuri.net package. The entry points to everything live in the Makefile and the bin/ directory so those are good starting points for exploration. This project isn't intended to be a reusable library but rather something that you can fork and make your own without doing a ton of work beyond renaming some things and plugging in your personal info. - -[samhuri.net directory]: https://github.com/samsonjs/samhuri.net/tree/main/samhuri.net -[gensite]: https://github.com/samsonjs/samhuri.net/tree/main/gensite -[Ink]: https://github.com/johnsundell/ink -[Plot]: https://github.com/johnsundell/plot -[@johnsundell]: https://github.com/johnsundell - -### Post format - -Posts are formatted with Markdown, and require this front-matter (build will fail without these fields): - -``` ---- -Title: What's Golden -Author: Chali 2na -Date: 5th June, 2025 -Timestamp: 2025-06-05T09:41:42-07:00 -Tags: Ruby, C, structs, interop -Link: https://example.net/chali-2na/whats-golden # For link posts ---- -``` -## Getting started - -Clone this repo and build my blog: +## Setup ```bash -git clone https://github.com/samsonjs/samhuri.net.git -cd samhuri.net -make debug +bin/bootstrap ``` -Start a local development server: +Or manually: ```bash -make serve # http://localhost:8000 -make watch # Auto-rebuild on file changes (Linux only) +rbenv install -s "$(cat .ruby-version)" +bundle install ``` -## Workflows - -Work on drafts in `public/drafts/` and publish/edit posts in `posts/YYYY/MM/`. The build process renders source files from these directories: - -- posts: Markdown files organized in subdirectories by year and month that are rendered into `www/posts/YYYY/MM/` -- public: static files that are copied directly to the output directory `www/`, rendering Markdown along the way -- public/drafts: by extension this is automatically handled, nothing special for drafts they're just regular pages +## Build And Serve ```bash -bin/new-draft # Create a new empty draft post with frontmatter -bin/new-draft hello # You can pass in a title if you want using any number of args, quotes not needed - -bin/publish-draft public/drafts/hello.md # Publish a draft (updates date and timestamp to current time) - -make debug # Build for local development, browse at http://localhost:8000 after running make serve -make serve # Start local server at http://localhost:8000 - -make beta # Build for staging at https://beta.samhuri.net -make publish_beta # Deploy to staging server -make release # Build for production at https://samhuri.net -make publish # Deploy to production server +bake debug # build for http://localhost:8000 +bake serve # serve www/ locally ``` +## Configuration + +Site metadata and project data are configured with TOML files at the repository root: + +- `site.toml`: site identity, default scripts/styles, and a `plugins` list (for example `["posts", "projects"]`), plus `projects_plugin` assets when that plugin is enabled. +- `projects.toml`: project listing entries using `[[projects]]`. + +`Pressa.create_site` loads both files from the provided `source_path` and supports URL overrides for `debug`, `beta`, and `release` builds. + ## Customizing for your site -If this seems like a reasonable workflow then you could see what it takes to make it your own. +If this workflow seems like a good fit, here is the minimum to make it your own: -### Essential changes +- Update `site.toml` with your site identity (`author`, `email`, `title`, `description`, `url`) and any global `scripts` / `styles`. +- Set `plugins` in `site.toml` to explicitly enable features (`"posts"`, `"projects"`). Safe default if omitted is no plugins. +- Define your projects in `projects.toml` using `[[projects]]` entries with `name`, `title`, `description`, and `url`. +- Configure project-page-only assets in `site.toml` under `[projects_plugin]` (`scripts` and `styles`) when using the `"projects"` plugin. +- Add custom plugins by implementing `Pressa::Plugin` in `lib/pressa/` and registering them in `lib/pressa/config/loader.rb`. +- Adjust rendering and layout in `lib/pressa/views/` and the static content in `public/` as needed. -0. Probably **rename everything** unless you want to impersonate me 🥸 +Other targets: -1. **Update site configuration** in `samhuri.net/Sources/samhuri.net/samhuri.net.swift`: - - Site title, description, author name - - Base URL for your domain - - RSS/JSON feed metadata - -2. **Modify deployment** in `bin/publish`: - - Update rsync destination to your server - - Adjust staging/production URLs in Makefile - -3. **Customize styling** in `public/css/style.css` - -4. **Replace static assets** in `public/`: - - Favicon, apple-touch-icon - - About page, CV, any personal content or pages you want go in here - -## How it works - -There's a `Site` that contains everything needed to render the site: - -```swift -struct Site { - let author: String - let email: String - let title: String - let description: String - let imageURL: URL? - let url: URL - let scripts: [Script] - let styles: [Stylesheet] - let renderers: [Renderer] - let plugins: [Plugin] -} +```bash +bake mudge +bake beta +bake release +bake watch target=debug +bake clean +bake publish_beta +bake publish ``` -There are `Renderer`s that plugins use to transform files, e.g. Markdown to HTML: +## Draft Workflow -```swift -protocol Renderer { - func canRenderFile(named filename: String, withExtension ext: String?) -> Bool - func render(site: Site, fileURL: URL, targetDir: URL) throws -} +```bash +bake new_draft "Post title" +bake drafts +bake publish_draft public/drafts/post-title.md ``` -And this is the `Plugin` protocol: +Published posts in `posts/YYYY/MM/*.md` require YAML front matter keys: -```swift -protocol Plugin { - func setUp(site: Site, sourceURL: URL) throws - func render(site: Site, targetURL: URL) throws -} +- `Title` +- `Author` +- `Date` +- `Timestamp` + +## Tests And Lint + +```bash +bake test +standardrb ``` -Your site plus its renderers and plugins defines everything that it can do. +Or via bake: -```swift -public enum samhuri {} - -public extension samhuri { - struct net { - let siteURLOverride: URL? - - public init(siteURLOverride: URL? = nil) { - self.siteURLOverride = siteURLOverride - } - - public func generate(sourceURL: URL, targetURL: URL) throws { - let renderer = PageRenderer() - let site = makeSite(renderer: renderer) - let generator = try SiteGenerator(sourceURL: sourceURL, site: site) - try generator.generate(targetURL: targetURL) - } - - func makeSite(renderer: PageRenderer) -> Site { - let projectsPlugin = ProjectsPlugin.Builder(renderer: renderer) - .path("projects") - .assets(TemplateAssets(scripts: [ - "https://ajax.googleapis.com/ajax/libs/prototype/1.6.1.0/prototype.js", - "gitter.js", - "store.js", - "projects.js", - ], styles: [])) - .add("bin", description: "my collection of scripts in ~/bin") - .add("config", description: "important dot files (zsh, emacs, vim, screen)") - .add("compiler", description: "a compiler targeting x86 in Ruby") - .add("lake", description: "a simple implementation of Scheme in C") - .add("strftime", description: "strftime for JavaScript") - .add("format", description: "printf for JavaScript") - .add("gitter", description: "a GitHub client for Node (v3 API)") - .add("mojo.el", description: "turn emacs into a sweet mojo editor") - .add("ThePusher", description: "Github post-receive hook router") - .add("NorthWatcher", description: "cron for filesystem changes") - .add("repl-edit", description: "edit Node repl commands with your text editor") - .add("cheat.el", description: "cheat from emacs") - .add("batteries", description: "a general purpose node library") - .add("samhuri.net", description: "this site") - .build() - - let postsPlugin = PostsPlugin.Builder(renderer: renderer) - .path("posts") - .jsonFeed( - iconPath: "images/apple-touch-icon-300.png", - faviconPath: "images/apple-touch-icon-80.png" - ) - .rssFeed() - .build() - - return Site.Builder( - title: "samhuri.net", - description: "Sami Samhuri's blog about programming, mainly about iOS and Ruby and Rails these days.", - author: "Sami Samhuri", - imagePath: "images/me.jpg", - email: "sami@samhuri.net", - url: siteURLOverride ?? URL(string: "https://samhuri.net")! - ) - .styles("normalize.css", "style.css", "fontawesome.min.css", "brands.min.css", "solid.min.css") - .renderMarkdown(pageRenderer: renderer) - .plugin(projectsPlugin) - .plugin(postsPlugin) - .build() - } - } -} +```bash +bake test +bake lint +bake lint_fix ``` -You can swap out the [posts plugin][PostsPlugin] for something that handles recipes, or photos, or documentation, or whatever. Each plugin defines how to find content files, process them, and where to put the output. So while this is currently set up as a blog generator the underlying architecture doesn't dictate that at all. +## Notes -[PostsPlugin]: https://github.com/samsonjs/samhuri.net/blob/main/samhuri.net/Sources/samhuri.net/Posts/PostsPlugin.swift -[ProjectsPlugin]: https://github.com/samsonjs/samhuri.net/blob/main/samhuri.net/Sources/samhuri.net/Projects/ProjectsPlugin.swift - -Here's what a plugin might look like for generating photo galleries: - -```swift -final class PhotoPlugin: Plugin { - private var galleries: [Gallery] = [] - - func setUp(site: Site, sourceURL: URL) throws { - let photosURL = sourceURL.appendingPathComponent("photos") - let galleryDirs = try FileManager.default.contentsOfDirectory(at: photosURL, ...) - - for galleryDir in galleryDirs { - let imageFiles = try FileManager.default.contentsOfDirectory(at: galleryDir, ...) - .filter { $0.pathExtension.lowercased() == "jpg" } - galleries.append(Gallery(name: galleryDir.lastPathComponent, images: imageFiles)) - } - } - - func render(site: Site, targetURL: URL) throws { - let galleriesURL = targetURL.appendingPathComponent("galleries") - - for gallery in galleries { - let galleryDirectory = galleriesURL.appendingPathComponent(gallery.name) - // Generate HTML in the targetURL directory using Ink and Plot, or whatever else you want - } - } -} -``` - -## License - -Released under the terms of the [MIT license](https://sjs.mit-license.org). +- `bake watch` is Linux-only and requires `inotifywait`. +- Deployment uses `rsync` to host `mudge` (configured in `bake.rb`): + - production: `/var/www/samhuri.net/public` + - beta: `/var/www/beta.samhuri.net/public` diff --git a/bake.rb b/bake.rb new file mode 100644 index 0000000..be19b18 --- /dev/null +++ b/bake.rb @@ -0,0 +1,484 @@ +# Build tasks for samhuri.net static site generator + +require "etc" +require "fileutils" +require "open3" +require "tmpdir" + +LIB_PATH = File.expand_path("lib", __dir__).freeze +$LOAD_PATH.unshift(LIB_PATH) unless $LOAD_PATH.include?(LIB_PATH) + +DRAFTS_DIR = "public/drafts".freeze +PUBLISH_HOST = "mudge".freeze +PRODUCTION_PUBLISH_DIR = "/var/www/samhuri.net/public".freeze +BETA_PUBLISH_DIR = "/var/www/beta.samhuri.net/public".freeze +WATCHABLE_DIRECTORIES = %w[public posts lib].freeze +LINT_TARGETS = %w[bake.rb Gemfile lib test].freeze +BUILD_TARGETS = %w[debug mudge beta release].freeze + +# Generate the site in debug mode (localhost:8000) +def debug + build("http://localhost:8000") +end + +# Generate the site for the mudge development server +def mudge + build("http://mudge:8000") +end + +# Generate the site for beta/staging +def beta + build("https://beta.samhuri.net") +end + +# Generate the site for production +def release + build("https://samhuri.net") +end + +# Start local development server +def serve + require "webrick" + server = WEBrick::HTTPServer.new(Port: 8000, DocumentRoot: "www") + trap("INT") { server.shutdown } + puts "Server running at http://localhost:8000" + server.start +end + +# Create a new draft in public/drafts/. +# @parameter title_parts [Array] Optional title words; defaults to Untitled. +def new_draft(*title_parts) + title, filename = + if title_parts.empty? + ["Untitled", next_available_draft] + else + given_title = title_parts.join(" ") + slug = slugify(given_title) + abort "Error: title cannot be converted to a filename." if slug.empty? + + filename = "#{slug}.md" + path = draft_path(filename) + abort "Error: draft already exists at #{path}" if File.exist?(path) + + [given_title, filename] + end + + FileUtils.mkdir_p(DRAFTS_DIR) + path = draft_path(filename) + content = render_draft_template(title) + File.write(path, content) + + puts "Created new draft at #{path}" + puts ">>> Contents below <<<" + puts + puts content +end + +# Publish a draft by moving it to posts/YYYY/MM and updating dates. +# @parameter input_path [String] Draft path or filename in public/drafts. +def publish_draft(input_path = nil) + if input_path.nil? || input_path.strip.empty? + puts "Usage: bake publish_draft " + puts + puts "Available drafts:" + drafts = Dir.glob("#{DRAFTS_DIR}/*.md").map { |path| File.basename(path) } + if drafts.empty? + puts " (no drafts found)" + else + drafts.each { |draft| puts " #{draft}" } + end + abort + end + + draft_path_value, draft_file = resolve_draft_input(input_path) + abort "Error: File not found: #{draft_path_value}" unless File.exist?(draft_path_value) + + now = Time.now + content = File.read(draft_path_value) + content.sub!(/^Date:.*$/, "Date: #{ordinal_date(now)}") + content.sub!(/^Timestamp:.*$/, "Timestamp: #{now.strftime("%Y-%m-%dT%H:%M:%S%:z")}") + + target_dir = "posts/#{now.strftime("%Y/%m")}" + FileUtils.mkdir_p(target_dir) + target_path = "#{target_dir}/#{draft_file}" + + File.write(target_path, content) + FileUtils.rm_f(draft_path_value) + + puts "Published draft: #{draft_path_value} -> #{target_path}" +end + +# Watch content directories and rebuild on every change. +# @parameter target [String] One of debug, mudge, beta, or release. +def watch(target: "debug") + unless command_available?("inotifywait") + abort "inotifywait is required (install inotify-tools)." + end + + loop do + abort "Error: watch failed." unless system("inotifywait", "-e", "modify,create,delete,move", *watch_paths) + puts "changed at #{Time.now}" + sleep 2 + run_build_target(target) + end +end + +# Publish to beta/staging server +def publish_beta + beta + run_rsync(local_paths: ["www/"], publish_dir: BETA_PUBLISH_DIR, dry_run: false, delete: true) +end + +# Publish to production server +def publish + release + run_rsync(local_paths: ["www/"], publish_dir: PRODUCTION_PUBLISH_DIR, dry_run: false, delete: true) +end + +# Clean generated files +def clean + FileUtils.rm_rf("www") + puts "Cleaned www/ directory" +end + +# Default task: run coverage and lint. +def default + coverage + lint +end + +# Run Minitest tests +def test + run_test_suite(test_file_list) +end + +# Run Guard for continuous testing +def guard + exec "bundle exec guard" +end + +# List all available drafts +def drafts + Dir.glob("#{DRAFTS_DIR}/*.md").sort.each do |draft| + puts File.basename(draft) + end +end + +# Run StandardRB linter +def lint + run_standardrb +end + +# Auto-fix StandardRB issues +def lint_fix + run_standardrb("--fix") +end + +# Measure line coverage for files under lib/. +# @parameter lowest [Integer] Number of lowest-covered files to print (default: 10, use 0 to hide). +def coverage(lowest: 10) + lowest_count = Integer(lowest) + abort "Error: lowest must be >= 0." if lowest_count.negative? + + run_coverage(test_files: test_file_list, lowest_count:) +end + +# Compare line coverage for files under lib/ against a baseline and fail on regression. +# @parameter baseline [String] Baseline ref, or "merge-base" (default) to compare against merge-base with remote default branch. +# @parameter lowest [Integer] Number of lowest-covered files to print for the current checkout (default: 10, use 0 to hide). +def coverage_regression(baseline: "merge-base", lowest: 10) + lowest_count = Integer(lowest) + abort "Error: lowest must be >= 0." if lowest_count.negative? + + baseline_ref = resolve_coverage_baseline_ref(baseline) + baseline_commit = capture_command("git", "rev-parse", "--short", baseline_ref).strip + + puts "Running coverage for current checkout..." + current_output = capture_coverage_output(test_files: test_file_list, lowest_count:, chdir: Dir.pwd) + print current_output + current_percent = parse_coverage_percent(current_output) + + puts "Running coverage for baseline #{baseline_ref} (#{baseline_commit})..." + baseline_percent = with_temporary_worktree(ref: baseline_ref) do |worktree_path| + baseline_tests = test_file_list(chdir: worktree_path) + baseline_output = capture_coverage_output(test_files: baseline_tests, lowest_count: 0, chdir: worktree_path) + parse_coverage_percent(baseline_output) + end + + delta = current_percent - baseline_percent + puts format("Baseline coverage (%s %s): %.2f%%", baseline_ref, baseline_commit, baseline_percent) + puts format("Coverage delta: %+0.2f%%", delta) + + return unless delta.negative? + + abort format("Error: coverage regressed by %.2f%% against %s (%s).", -delta, baseline_ref, baseline_commit) +end + +private + +def run_test_suite(test_files) + run_command("ruby", "-Ilib", "-Itest", "-e", "ARGV.each { |file| require File.expand_path(file) }", *test_files) +end + +def run_coverage(test_files:, lowest_count:) + output = capture_coverage_output(test_files:, lowest_count:, chdir: Dir.pwd) + print output +end + +def test_file_list(chdir: Dir.pwd) + test_files = Dir.chdir(chdir) { Dir.glob("test/**/*_test.rb").sort } + abort "Error: no tests found in test/**/*_test.rb under #{chdir}" if test_files.empty? + + test_files +end + +def coverage_script(lowest_count:) + <<~RUBY + require "coverage" + + root = Dir.pwd + lib_root = File.join(root, "lib") + "/" + Coverage.start(lines: true) + + at_exit do + result = Coverage.result + rows = result.keys + .select { |file| file.start_with?(lib_root) && file.end_with?(".rb") } + .sort + .map do |file| + lines = result[file][:lines] || [] + total = 0 + covered = 0 + lines.each do |line_count| + next if line_count.nil? + total += 1 + covered += 1 if line_count.positive? + end + percent = total.zero? ? 100.0 : (covered.to_f / total * 100) + [file, covered, total, percent] + end + + covered_lines = rows.sum { |row| row[1] } + total_lines = rows.sum { |row| row[2] } + overall_percent = total_lines.zero? ? 100.0 : (covered_lines.to_f / total_lines * 100) + puts format("Coverage (lib): %.2f%% (%d / %d lines)", overall_percent, covered_lines, total_lines) + + unless #{lowest_count}.zero? || rows.empty? + puts "Lowest covered files:" + rows.sort_by { |row| row[3] }.first(#{lowest_count}).each do |file, covered, total, percent| + relative_path = file.delete_prefix(root + "/") + puts format(" %6.2f%% %d/%d %s", percent, covered, total, relative_path) + end + end + end + + ARGV.each { |file| require File.expand_path(file) } + RUBY +end + +def capture_coverage_output(test_files:, lowest_count:, chdir:) + capture_command("ruby", "-Ilib", "-Itest", "-e", coverage_script(lowest_count:), *test_files, chdir:) +end + +def parse_coverage_percent(output) + match = output.match(/Coverage \(lib\):\s+([0-9]+\.[0-9]+)%/) + abort "Error: unable to parse coverage output." unless match + + Float(match[1]) +end + +def resolve_coverage_baseline_ref(baseline) + baseline_name = baseline.to_s.strip + abort "Error: baseline cannot be empty." if baseline_name.empty? + + return coverage_merge_base_ref if baseline_name == "merge-base" + + baseline_name +end + +def coverage_merge_base_ref + remote = preferred_remote + remote_head_ref = remote_default_branch_ref(remote) + merge_base = capture_command("git", "merge-base", "HEAD", remote_head_ref).strip + abort "Error: could not resolve merge-base with #{remote_head_ref}." if merge_base.empty? + + merge_base +end + +def preferred_remote + upstream = capture_command_optional("git", "rev-parse", "--abbrev-ref", "--symbolic-full-name", "@{upstream}").strip + upstream_remote = upstream.split("/").first unless upstream.empty? + return upstream_remote if upstream_remote && !upstream_remote.empty? + + remotes = capture_command("git", "remote").lines.map(&:strip).reject(&:empty?) + abort "Error: no git remotes configured; pass baseline=." if remotes.empty? + + remotes.include?("origin") ? "origin" : remotes.first +end + +def remote_default_branch_ref(remote) + symbolic = capture_command_optional("git", "symbolic-ref", "--quiet", "refs/remotes/#{remote}/HEAD").strip + if symbolic.empty? + fallback = "#{remote}/main" + capture_command("git", "rev-parse", "--verify", fallback) + return fallback + end + + symbolic.sub("refs/remotes/", "") +end + +def with_temporary_worktree(ref:) + temp_root = Dir.mktmpdir("coverage-baseline-") + worktree_path = File.join(temp_root, "worktree") + + run_command("git", "worktree", "add", "--detach", worktree_path, ref) + begin + yield worktree_path + ensure + system("git", "worktree", "remove", "--force", worktree_path) + FileUtils.rm_rf(temp_root) + end +end + +def capture_command(*command, chdir: Dir.pwd) + stdout, stderr, status = Dir.chdir(chdir) { Open3.capture3(*command) } + output = +"" + output << stdout unless stdout.empty? + output << stderr unless stderr.empty? + abort "Error: command failed: #{command.join(" ")}\n#{output}" unless status.success? + + output +end + +def capture_command_optional(*command, chdir: Dir.pwd) + stdout, stderr, status = Dir.chdir(chdir) { Open3.capture3(*command) } + return stdout if status.success? + return "" if stderr.include?("no upstream configured") || stderr.include?("is not a symbolic ref") + + "" +end + +# Build the site with specified URL +# @parameter url [String] The site URL to use +def build(url) + require "pressa" + + puts "Building site for #{url}..." + site = Pressa.create_site(source_path: ".", url_override: url) + generator = Pressa::SiteGenerator.new(site:) + generator.generate(source_path: ".", target_path: "www") + puts "Site built successfully in www/" +end + +def run_build_target(target) + target_name = target.to_s + unless BUILD_TARGETS.include?(target_name) + abort "Error: invalid target '#{target_name}'. Use one of: #{BUILD_TARGETS.join(", ")}" + end + + public_send(target_name) +end + +def watch_paths + WATCHABLE_DIRECTORIES.flat_map { |path| ["-r", path] } +end + +def standardrb_command(*extra_args) + ["bundle", "exec", "standardrb", *extra_args, *LINT_TARGETS] +end + +def run_standardrb(*extra_args) + run_command(*standardrb_command(*extra_args)) +end + +def run_command(*command) + abort "Error: command failed: #{command.join(" ")}" unless system(*command) +end + +def run_rsync(local_paths:, publish_dir:, dry_run:, delete:) + command = ["rsync", "-aKv", "-e", "ssh -4"] + command << "--dry-run" if dry_run + command << "--delete" if delete + command.concat(local_paths) + command << "#{PUBLISH_HOST}:#{publish_dir}" + abort "Error: rsync failed." unless system(*command) +end + +def resolve_draft_input(input_path) + if input_path.include?("/") + if input_path.start_with?("posts/") + abort "Error: '#{input_path}' is already published in posts/ directory" + end + + [input_path, File.basename(input_path)] + else + [draft_path(input_path), input_path] + end +end + +def draft_path(filename) + File.join(DRAFTS_DIR, filename) +end + +def slugify(title) + title.downcase + .gsub(/[^a-z0-9\s-]/, "") + .gsub(/\s+/, "-").squeeze("-") + .gsub(/^-|-$/, "") +end + +def next_available_draft(base_filename = "untitled.md") + return base_filename unless File.exist?(draft_path(base_filename)) + + name_without_ext = File.basename(base_filename, ".md") + counter = 1 + loop do + numbered_filename = "#{name_without_ext}-#{counter}.md" + return numbered_filename unless File.exist?(draft_path(numbered_filename)) + + counter += 1 + end +end + +def render_draft_template(title) + now = Time.now + <<~FRONTMATTER + --- + Author: #{current_author} + Title: #{title} + Date: unpublished + Timestamp: #{now.strftime("%Y-%m-%dT%H:%M:%S%:z")} + Tags: + --- + + # #{title} + + TKTK + FRONTMATTER +end + +def current_author + Etc.getlogin || ENV["USER"] || `whoami`.strip +rescue + ENV["USER"] || `whoami`.strip +end + +def ordinal_date(time) + day = time.day + suffix = case day + when 1, 21, 31 + "st" + when 2, 22 + "nd" + when 3, 23 + "rd" + else + "th" + end + + time.strftime("#{day}#{suffix} %B, %Y") +end + +def command_available?(command) + system("which", command, out: File::NULL, err: File::NULL) +end diff --git a/bin/bootstrap b/bin/bootstrap index faa610c..0067969 100755 --- a/bin/bootstrap +++ b/bin/bootstrap @@ -1,50 +1,37 @@ #!/bin/bash -# bail on errors and unset variables set -euo pipefail -SWIFT_VERSION=6.1 -SWIFT_DIR=swift-$SWIFT_VERSION-RELEASE-ubuntu24.04 -SWIFT_FILENAME=$SWIFT_DIR.tar.gz +ROOT_DIR="$(cd "$(dirname "$0")/.." && pwd)" +RUBY_VERSION="$(cat "$ROOT_DIR/.ruby-version")" -if [[ $(uname) = "Linux" ]]; then +if [[ "$(uname)" = "Linux" ]]; then + echo "*** installing Linux prerequisites" sudo apt install -y \ - binutils \ - git \ - gnupg2 \ - libc6-dev \ - libcurl4 \ - libedit2 \ - libgcc-s1 \ - libpython3.12 \ - libsqlite3-0 \ - libstdc++-14-dev \ - libxml2 \ - libz3-dev \ - pkg-config \ - tzdata \ - uuid-dev \ - zlib1g-dev + build-essential \ + git \ + inotify-tools \ + libffi-dev \ + libyaml-dev \ + pkg-config \ + zlib1g-dev +fi - if which swift >/dev/null 2>/dev/null && swift --version | grep $SWIFT_VERSION >/dev/null 2>/dev/null; then - echo "*** swift $SWIFT_VERSION is installed" - else - echo "*** installing swift" - if [[ -e $SWIFT_FILENAME ]]; then - echo "*** $SWIFT_FILENAME exists, skipping download" - else - wget https://download.swift.org/swift-$SWIFT_VERSION-release/ubuntu2404/swift-$SWIFT_VERSION-RELEASE/$SWIFT_FILENAME - fi - if [[ -e $SWIFT_DIR ]]; then - echo "*** $SWIFT_DIR exists, skipping extraction" - else - tar xzf $SWIFT_FILENAME - fi - echo "*** add $PWD/$SWIFT_DIR/usr/bin to PATH in your shell's rc file" +cd "$ROOT_DIR" + +if command -v rbenv >/dev/null 2>/dev/null; then + echo "*** using rbenv (ruby $RUBY_VERSION)" + rbenv install -s "$RUBY_VERSION" + if ! rbenv exec gem list -i bundler >/dev/null 2>/dev/null; then + rbenv exec gem install bundler fi - - echo "*** installing inotify-tools for watch script" - sudo apt install -y inotify-tools + rbenv exec bundle install +else + echo "*** rbenv not found, using system Ruby" + if ! gem list -i bundler >/dev/null 2>/dev/null; then + gem install bundler + fi + bundle install fi echo "*** done" diff --git a/bin/build-gensite b/bin/build-gensite deleted file mode 100755 index 5902b0b..0000000 --- a/bin/build-gensite +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash - -set -euo pipefail - -if [[ $(uname) = "Linux" ]]; then - build_platform_dir="$(arch)-unknown-linux-gnu" -else - build_platform_dir="$(arch)-apple-macosx" -fi - -pushd "gensite" >/dev/null -swift build -cp .build/$build_platform_dir/debug/gensite ../bin/gensite -popd >/dev/null diff --git a/bin/new-draft b/bin/new-draft deleted file mode 100755 index 5e93aa7..0000000 --- a/bin/new-draft +++ /dev/null @@ -1,94 +0,0 @@ -#!/usr/bin/env ruby -w - -require 'fileutils' - -DRAFTS_DIR = File.expand_path("../public/drafts", __dir__).freeze - -def usage - puts "Usage: #{$0} [title]" - puts - puts "Examples:" - puts " #{$0} Top 5 Ways to Write Clickbait # using a title without quotes" - puts " #{$0} 'Something with punctuation?!' # fancy chars need quotes" - puts " #{$0} working-with-databases # using a slug" - puts " #{$0} # Creates untitled.md (or untitled-2.md, etc.)" - puts - puts "Creates a new draft in public/drafts/ directory with proper frontmatter." -end - -def draft_path(filename) - File.join(DRAFTS_DIR, filename) -end - -def main - if ARGV.include?('-h') || ARGV.include?('--help') - usage - exit 0 - end - - title, filename = - if ARGV.empty? - ['Untitled', next_available_draft] - else - given_title = ARGV.join(' ') - filename = "#{slugify(given_title)}.md" - path = draft_path(filename) - if File.exist?(path) - puts "Error: draft already exists at #{path}" - exit 1 - end - - [given_title, filename] - end - - FileUtils.mkdir_p(DRAFTS_DIR) - path = draft_path(filename) - content = render_template(title) - File.write(path, content) - - puts "Created new draft at #{path}" - puts '>>> Contents below <<<' - puts - puts content -end - -def slugify(title) - title.downcase - .gsub(/[^a-z0-9\s-]/, '') - .gsub(/\s+/, '-') - .gsub(/-+/, '-') - .gsub(/^-|-$/, '') -end - -def next_available_draft(base_filename = 'untitled.md') - return base_filename unless File.exist?(draft_path(base_filename)) - - name_without_ext = File.basename(base_filename, '.md') - counter = 1 - loop do - numbered_filename = "#{name_without_ext}-#{counter}.md" - return numbered_filename unless File.exist?(draft_path(numbered_filename)) - counter += 1 - end -end - -def render_template(title) - now = Time.now - iso_timestamp = now.strftime('%Y-%m-%dT%H:%M:%S%:z') - - <<~FRONTMATTER - --- - Author: #{`whoami`.strip} - Title: #{title} - Date: unpublished - Timestamp: #{iso_timestamp} - Tags: - --- - - # #{title} - - TKTK - FRONTMATTER -end - -main if $0 == __FILE__ diff --git a/bin/publish b/bin/publish deleted file mode 100755 index af294d3..0000000 --- a/bin/publish +++ /dev/null @@ -1,54 +0,0 @@ -#!/bin/bash - -# exit on errors -set -e - -PUBLISH_HOST="mudge" -PUBLISH_DIR="/var/www/samhuri.net/public" -ECHO=0 -RSYNC_OPTS="" - -BREAK_WHILE=0 -while [[ $# > 0 ]]; do - ARG="$1" - case "$ARG" in - - -b|--beta) - PUBLISH_DIR="/var/www/beta.samhuri.net/public" - shift - ;; - - -t|--test) - ECHO=1 - RSYNC_OPTS="$RSYNC_OPTS --dry-run" - shift - ;; - - -d|--delete) - RSYNC_OPTS="$RSYNC_OPTS --delete" - shift - ;; - - # we're at the paths, no more options - *) - BREAK_WHILE=1 - break - ;; - - esac - - [[ $BREAK_WHILE -eq 1 ]] && break -done - -declare -a CMD -if [[ $# -eq 0 ]]; then - CMD=(rsync -aKv -e "ssh -4" $RSYNC_OPTS www/ $PUBLISH_HOST:$PUBLISH_DIR) -else - CMD=(rsync -aKv -e "ssh -4" $RSYNC_OPTS $@ $PUBLISH_HOST:$PUBLISH_DIR) -fi - -if [[ $ECHO -eq 1 ]]; then - echo "${CMD[@]}" -fi - -"${CMD[@]}" diff --git a/bin/publish-draft b/bin/publish-draft deleted file mode 100755 index b754287..0000000 --- a/bin/publish-draft +++ /dev/null @@ -1,70 +0,0 @@ -#!/usr/bin/env ruby -w - -require 'fileutils' - -def usage - puts "Usage: #{$0} " - puts - puts "Examples:" - puts " #{$0} public/drafts/reverse-engineering-photo-urls.md" - puts - puts "Available drafts:" - drafts = Dir.glob('public/drafts/*.md').map { |f| File.basename(f) } - if drafts.empty? - puts " (no drafts found)" - else - drafts.each { |d| puts " #{d}" } - end -end - -if ARGV.empty? - usage - abort -end - -input_path = ARGV.first - -# Handle both full paths and just filenames -if input_path.include?('/') - draft_path = input_path - draft_file = File.basename(input_path) - if input_path.start_with?('posts/') - abort "Error: '#{input_path}' is already published in posts/ directory" - end -else - draft_file = input_path - draft_path = "public/drafts/#{draft_file}" -end - -abort "Error: File not found: #{draft_path}" unless File.exist?(draft_path) - -# Update display date timestamp to current time -def ordinal_date(time) - day = time.day - suffix = case day - when 1, 21, 31 then 'st' - when 2, 22 then 'nd' - when 3, 23 then 'rd' - else 'th' - end - time.strftime("#{day}#{suffix} %B, %Y") -end -now = Time.now -iso_timestamp = now.strftime('%Y-%m-%dT%H:%M:%S%:z') -human_date = ordinal_date(now) -content = File.read(draft_path) -content.sub!(/^Date:.*$/, "Date: #{human_date}") -content.sub!(/^Timestamp:.*$/, "Timestamp: #{iso_timestamp}") - -# Use current year/month for directory, pad with strftime -year_month = now.strftime('%Y-%m') -year, month = year_month.split('-') - -target_dir = "posts/#{year}/#{month}" -FileUtils.mkdir_p(target_dir) -target_path = "#{target_dir}/#{draft_file}" - -File.write(target_path, content) -FileUtils.rm_f(draft_path) - -puts "Published draft: #{draft_path} → #{target_path}" diff --git a/bin/watch b/bin/watch deleted file mode 100755 index 0c74d5e..0000000 --- a/bin/watch +++ /dev/null @@ -1,10 +0,0 @@ -#!/bin/bash - -BLOG_TARGET=${BLOG_TARGET:-mudge} - -while true; do - inotifywait -e modify,create,delete,move -r drafts -r posts - echo "changed at $(date)" - sleep 5 - make "$TARGET" -done diff --git a/gensite/.gitignore b/gensite/.gitignore deleted file mode 100644 index 504eed0..0000000 --- a/gensite/.gitignore +++ /dev/null @@ -1,5 +0,0 @@ -.DS_Store -/.build -/Packages -/*.xcodeproj -/.swiftpm diff --git a/gensite/Package.resolved b/gensite/Package.resolved deleted file mode 100644 index 5e3e272..0000000 --- a/gensite/Package.resolved +++ /dev/null @@ -1,25 +0,0 @@ -{ - "object": { - "pins": [ - { - "package": "Ink", - "repositoryURL": "https://github.com/johnsundell/ink.git", - "state": { - "branch": null, - "revision": "bcc9f219900a62c4210e6db726035d7f03ae757b", - "version": "0.6.0" - } - }, - { - "package": "Plot", - "repositoryURL": "https://github.com/johnsundell/plot.git", - "state": { - "branch": null, - "revision": "271926b4413fe868739d99f5eadcf2bd6cd62fb8", - "version": "0.14.0" - } - } - ] - }, - "version": 1 -} diff --git a/gensite/Package.swift b/gensite/Package.swift deleted file mode 100644 index 67142bc..0000000 --- a/gensite/Package.swift +++ /dev/null @@ -1,21 +0,0 @@ -// swift-tools-version:6.1 -// The swift-tools-version declares the minimum version of Swift required to build this package. - -import PackageDescription - -let package = Package( - name: "gensite", - platforms: [ - .macOS(.v14), - .iOS(.v17), - ], - dependencies: [ - .package(path: "../samhuri.net"), - ], - targets: [ - .executableTarget( name: "gensite", dependencies: [ - "samhuri.net", - ]), - .testTarget(name: "gensiteTests", dependencies: ["gensite"]), - ] -) diff --git a/gensite/Readme.md b/gensite/Readme.md deleted file mode 100644 index 3e98529..0000000 --- a/gensite/Readme.md +++ /dev/null @@ -1,5 +0,0 @@ -# gensite - -A binary to build [samhuri.net](https://samhuri.net) using SiteGenerator. - -See https://github.com/samsonjs/samhuri.net for details. diff --git a/gensite/Sources/gensite/main.swift b/gensite/Sources/gensite/main.swift deleted file mode 100644 index d6f3ab7..0000000 --- a/gensite/Sources/gensite/main.swift +++ /dev/null @@ -1,50 +0,0 @@ -// -// main.swift -// gensite -// -// Created by Sami Samhuri on 2019-12-01. -// - -import Foundation -import samhuri_net - -guard CommandLine.arguments.count >= 3 else { - let name = CommandLine.arguments[0] - FileHandle.standardError.write("Usage: \(name) \n".data(using: .utf8)!) - exit(1) -} - -let sourcePath = CommandLine.arguments[1] -var isDir: ObjCBool = false -let sourceExists = FileManager.default.fileExists(atPath: sourcePath, isDirectory: &isDir) -guard sourceExists, isDir.boolValue else { - FileHandle.standardError.write("error: Site path \(sourcePath) does not exist or is not a directory\n".data(using: .utf8)!) - exit(2) -} - -let targetPath = CommandLine.arguments[2] - -let siteURLOverride: URL? -if CommandLine.argc > 3, CommandLine.arguments[3].isEmpty == false { - let urlString = CommandLine.arguments[3] - guard let url = URL(string: urlString) else { - FileHandle.standardError.write("error: invalid site URL \(urlString)\n".data(using: .utf8)!) - exit(4) - } - siteURLOverride = url -} -else { - siteURLOverride = nil -} - -do { - let sourceURL = URL(fileURLWithPath: sourcePath) - let targetURL = URL(fileURLWithPath: targetPath) - let site = samhuri.net(siteURLOverride: siteURLOverride) - try site.generate(sourceURL: sourceURL, targetURL: targetURL) - exit(0) -} -catch { - FileHandle.standardError.write("error: \(error)\n".data(using: .utf8)!) - exit(-1) -} diff --git a/gensite/Tests/gensiteTests/gensiteTests.swift b/gensite/Tests/gensiteTests/gensiteTests.swift deleted file mode 100644 index f9377c1..0000000 --- a/gensite/Tests/gensiteTests/gensiteTests.swift +++ /dev/null @@ -1,8 +0,0 @@ -@testable import gensite -import Testing - -struct gensiteTests { - @Test func example() { - #expect(true) - } -} diff --git a/lib/pressa.rb b/lib/pressa.rb new file mode 100644 index 0000000..958d59c --- /dev/null +++ b/lib/pressa.rb @@ -0,0 +1,14 @@ +require "pressa/site" +require "pressa/site_generator" +require "pressa/plugin" +require "pressa/posts/plugin" +require "pressa/projects/plugin" +require "pressa/utils/markdown_renderer" +require "pressa/config/loader" + +module Pressa + def self.create_site(source_path: ".", url_override: nil) + loader = Config::Loader.new(source_path:) + loader.build_site(url_override:) + end +end diff --git a/lib/pressa/config/loader.rb b/lib/pressa/config/loader.rb new file mode 100644 index 0000000..bf11540 --- /dev/null +++ b/lib/pressa/config/loader.rb @@ -0,0 +1,217 @@ +require "pressa/site" +require "pressa/posts/plugin" +require "pressa/projects/plugin" +require "pressa/utils/markdown_renderer" +require "pressa/config/simple_toml" + +module Pressa + module Config + class ValidationError < StandardError; end + + class Loader + REQUIRED_SITE_KEYS = %w[author email title description url].freeze + REQUIRED_PROJECT_KEYS = %w[name title description url].freeze + + def initialize(source_path:) + @source_path = source_path + end + + def build_site(url_override: nil) + site_config = load_toml("site.toml") + + validate_required!(site_config, REQUIRED_SITE_KEYS, context: "site.toml") + + site_url = url_override || site_config["url"] + plugins = build_plugins(site_config) + + Site.new( + author: site_config["author"], + email: site_config["email"], + title: site_config["title"], + description: site_config["description"], + url: site_url, + image_url: normalize_image_url(site_config["image_url"], site_url), + scripts: build_scripts(site_config["scripts"], context: "site.toml scripts"), + styles: build_styles(site_config["styles"], context: "site.toml styles"), + plugins:, + renderers: [ + Utils::MarkdownRenderer.new + ] + ) + end + + private + + def load_toml(filename) + path = File.join(@source_path, filename) + SimpleToml.load_file(path) + rescue ParseError => e + raise ValidationError, e.message + end + + def build_projects(projects_config) + projects = projects_config["projects"] + raise ValidationError, "Missing required top-level array 'projects' in projects.toml" unless projects + raise ValidationError, "Expected 'projects' to be an array in projects.toml" unless projects.is_a?(Array) + + projects.map.with_index do |project, index| + unless project.is_a?(Hash) + raise ValidationError, "Project entry #{index + 1} must be a table in projects.toml" + end + + validate_required!(project, REQUIRED_PROJECT_KEYS, context: "projects.toml project ##{index + 1}") + + Projects::Project.new( + name: project["name"], + title: project["title"], + description: project["description"], + url: project["url"] + ) + end + end + + def validate_required!(hash, keys, context:) + missing = keys.reject do |key| + hash[key].is_a?(String) && !hash[key].strip.empty? + end + + return if missing.empty? + + raise ValidationError, "Missing required #{context} keys: #{missing.join(", ")}" + end + + def build_plugins(site_config) + plugin_names = parse_plugin_names(site_config["plugins"]) + + plugin_names.map.with_index do |plugin_name, index| + case plugin_name + when "posts" + Posts::Plugin.new + when "projects" + build_projects_plugin(site_config) + else + raise ValidationError, "Unknown plugin '#{plugin_name}' at site.toml plugins[#{index}]" + end + end + end + + def parse_plugin_names(value) + return [] if value.nil? + raise ValidationError, "Expected site.toml plugins to be an array" unless value.is_a?(Array) + + seen = {} + + value.map.with_index do |plugin_name, index| + unless plugin_name.is_a?(String) && !plugin_name.strip.empty? + raise ValidationError, "Expected site.toml plugins[#{index}] to be a non-empty String" + end + + normalized_plugin_name = plugin_name.strip + if seen[normalized_plugin_name] + raise ValidationError, "Duplicate plugin '#{normalized_plugin_name}' in site.toml plugins" + end + seen[normalized_plugin_name] = true + + normalized_plugin_name + end + end + + def build_projects_plugin(site_config) + projects_plugin = hash_or_empty(site_config["projects_plugin"], "site.toml projects_plugin") + projects_config = load_toml("projects.toml") + projects = build_projects(projects_config) + + Projects::Plugin.new( + projects:, + scripts: build_scripts(projects_plugin["scripts"], context: "site.toml projects_plugin.scripts"), + styles: build_styles(projects_plugin["styles"], context: "site.toml projects_plugin.styles") + ) + end + + def hash_or_empty(value, context) + return {} if value.nil? + return value if value.is_a?(Hash) + + raise ValidationError, "Expected #{context} to be a table" + end + + def build_scripts(value, context:) + entries = array_or_empty(value, context) + + entries.map.with_index do |item, index| + case item + when String + validate_asset_path!( + item, + context: "#{context}[#{index}]" + ) + Script.new(src: item, defer: true) + when Hash + src = item["src"] + raise ValidationError, "Expected #{context}[#{index}].src to be a String" unless src.is_a?(String) && !src.empty? + validate_asset_path!( + src, + context: "#{context}[#{index}].src" + ) + + defer = item.key?("defer") ? item["defer"] : true + unless [true, false].include?(defer) + raise ValidationError, "Expected #{context}[#{index}].defer to be a Boolean" + end + + Script.new(src:, defer:) + else + raise ValidationError, "Expected #{context}[#{index}] to be a String or table" + end + end + end + + def build_styles(value, context:) + entries = array_or_empty(value, context) + + entries.map.with_index do |item, index| + case item + when String + validate_asset_path!( + item, + context: "#{context}[#{index}]" + ) + Stylesheet.new(href: item) + when Hash + href = item["href"] + raise ValidationError, "Expected #{context}[#{index}].href to be a String" unless href.is_a?(String) && !href.empty? + validate_asset_path!( + href, + context: "#{context}[#{index}].href" + ) + + Stylesheet.new(href:) + else + raise ValidationError, "Expected #{context}[#{index}] to be a String or table" + end + end + end + + def array_or_empty(value, context) + return [] if value.nil? + return value if value.is_a?(Array) + + raise ValidationError, "Expected #{context} to be an array" + end + + def normalize_image_url(value, site_url) + return nil if value.nil? + return value if value.start_with?("http://", "https://") + + normalized = value.start_with?("/") ? value : "/#{value}" + "#{site_url}#{normalized}" + end + + def validate_asset_path!(value, context:) + return if value.start_with?("/", "http://", "https://") + + raise ValidationError, "Expected #{context} to start with / or use http(s) scheme" + end + end + end +end diff --git a/lib/pressa/config/simple_toml.rb b/lib/pressa/config/simple_toml.rb new file mode 100644 index 0000000..b182405 --- /dev/null +++ b/lib/pressa/config/simple_toml.rb @@ -0,0 +1,224 @@ +require "json" + +module Pressa + module Config + class ParseError < StandardError; end + + class SimpleToml + def self.load_file(path) + new.parse(File.read(path)) + rescue Errno::ENOENT + raise ParseError, "Config file not found: #{path}" + end + + def parse(content) + root = {} + current_table = root + lines = content.each_line.to_a + + line_index = 0 + while line_index < lines.length + line = lines[line_index] + line_number = line_index + 1 + source = strip_comments(line).strip + if source.empty? + line_index += 1 + next + end + + if source =~ /\A\[\[(.+)\]\]\z/ + current_table = start_array_table(root, Regexp.last_match(1), line_number) + line_index += 1 + next + end + + if source =~ /\A\[(.+)\]\z/ + current_table = start_table(root, Regexp.last_match(1), line_number) + line_index += 1 + next + end + + key, raw_value = parse_assignment(source, line_number) + while needs_continuation?(raw_value) + line_index += 1 + raise ParseError, "Unterminated value for key '#{key}' at line #{line_number}" if line_index >= lines.length + + continuation = strip_comments(lines[line_index]).strip + next if continuation.empty? + + raw_value = "#{raw_value} #{continuation}" + end + + if current_table.key?(key) + raise ParseError, "Duplicate key '#{key}' at line #{line_number}" + end + + current_table[key] = parse_value(raw_value, line_number) + line_index += 1 + end + + root + end + + private + + def start_array_table(root, raw_path, line_number) + keys = parse_path(raw_path, line_number) + parent = ensure_path(root, keys[0..-2], line_number) + table_name = keys.last + + parent[table_name] ||= [] + array = parent[table_name] + unless array.is_a?(Array) + raise ParseError, "Expected array for '[[#{raw_path}]]' at line #{line_number}" + end + + table = {} + array << table + table + end + + def start_table(root, raw_path, line_number) + keys = parse_path(raw_path, line_number) + ensure_path(root, keys, line_number) + end + + def ensure_path(root, keys, line_number) + cursor = root + + keys.each do |key| + cursor[key] ||= {} + unless cursor[key].is_a?(Hash) + raise ParseError, "Expected table path '#{keys.join(".")}' at line #{line_number}" + end + + cursor = cursor[key] + end + + cursor + end + + def parse_path(raw_path, line_number) + keys = raw_path.split(".").map(&:strip) + if keys.empty? || keys.any? { |part| part.empty? || part !~ /\A[A-Za-z0-9_]+\z/ } + raise ParseError, "Invalid table path '#{raw_path}' at line #{line_number}" + end + keys + end + + def parse_assignment(source, line_number) + separator = index_of_unquoted(source, "=") + raise ParseError, "Invalid assignment at line #{line_number}" unless separator + + key = source[0...separator].strip + value = source[(separator + 1)..].strip + + if key.empty? || key !~ /\A[A-Za-z0-9_]+\z/ + raise ParseError, "Invalid key '#{key}' at line #{line_number}" + end + raise ParseError, "Missing value for key '#{key}' at line #{line_number}" if value.empty? + + [key, value] + end + + def parse_value(raw_value, line_number) + JSON.parse(raw_value) + rescue JSON::ParserError + raise ParseError, "Unsupported TOML value '#{raw_value}' at line #{line_number}" + end + + def needs_continuation?(source) + in_string = false + escaped = false + depth = 0 + + source.each_char do |char| + if in_string + if escaped + escaped = false + elsif char == "\\" + escaped = true + elsif char == '"' + in_string = false + end + + next + end + + case char + when '"' + in_string = true + when "[", "{" + depth += 1 + when "]", "}" + depth -= 1 + end + end + + in_string || depth.positive? + end + + def strip_comments(line) + output = +"" + in_string = false + escaped = false + + line.each_char do |char| + if in_string + output << char + + if escaped + escaped = false + elsif char == "\\" + escaped = true + elsif char == '"' + in_string = false + end + + next + end + + case char + when '"' + in_string = true + output << char + when "#" + break + else + output << char + end + end + + output + end + + def index_of_unquoted(source, target) + in_string = false + escaped = false + + source.each_char.with_index do |char, index| + if in_string + if escaped + escaped = false + elsif char == "\\" + escaped = true + elsif char == '"' + in_string = false + end + + next + end + + if char == '"' + in_string = true + next + end + + return index if char == target + end + + nil + end + end + end +end diff --git a/lib/pressa/plugin.rb b/lib/pressa/plugin.rb new file mode 100644 index 0000000..4bd5d83 --- /dev/null +++ b/lib/pressa/plugin.rb @@ -0,0 +1,11 @@ +module Pressa + class Plugin + def setup(site:, source_path:) + raise NotImplementedError, "#{self.class}#setup must be implemented" + end + + def render(site:, target_path:) + raise NotImplementedError, "#{self.class}#render must be implemented" + end + end +end diff --git a/lib/pressa/posts/json_feed.rb b/lib/pressa/posts/json_feed.rb new file mode 100644 index 0000000..5b4b185 --- /dev/null +++ b/lib/pressa/posts/json_feed.rb @@ -0,0 +1,76 @@ +require "json" +require "pressa/utils/file_writer" +require "pressa/views/feed_post_view" + +module Pressa + module Posts + class JSONFeedWriter + FEED_VERSION = "https://jsonfeed.org/version/1.1" + + def initialize(site:, posts_by_year:) + @site = site + @posts_by_year = posts_by_year + end + + def write_feed(target_path:, limit: 30) + recent = @posts_by_year.recent_posts(limit) + + feed = build_feed(recent) + + json = JSON.pretty_generate(feed) + file_path = File.join(target_path, "feed.json") + Utils::FileWriter.write(path: file_path, content: json) + end + + private + + def build_feed(posts) + author = { + name: @site.author, + url: @site.url, + avatar: @site.image_url + } + + items = posts.map { |post| feed_item(post) } + + { + icon: icon_url, + favicon: favicon_url, + items: items, + home_page_url: @site.url, + author:, + version: FEED_VERSION, + authors: [author], + feed_url: @site.url_for("/feed.json"), + language: "en-CA", + title: @site.title + } + end + + def icon_url + @site.url_for("/images/apple-touch-icon-300.png") + end + + def favicon_url + @site.url_for("/images/apple-touch-icon-80.png") + end + + def feed_item(post) + content_html = Views::FeedPostView.new(post:, site: @site).call + permalink = @site.url_for(post.path) + + item = {} + item[:url] = permalink + item[:external_url] = post.link if post.link_post? + item[:tags] = post.tags unless post.tags.empty? + item[:content_html] = content_html + item[:title] = post.link_post? ? "→ #{post.title}" : post.title + item[:author] = {name: post.author} + item[:date_published] = post.date.iso8601 + item[:id] = permalink + + item + end + end + end +end diff --git a/lib/pressa/posts/metadata.rb b/lib/pressa/posts/metadata.rb new file mode 100644 index 0000000..1b58756 --- /dev/null +++ b/lib/pressa/posts/metadata.rb @@ -0,0 +1,50 @@ +require "yaml" +require "date" + +module Pressa + module Posts + class PostMetadata + REQUIRED_FIELDS = %w[Title Author Date Timestamp].freeze + + attr_reader :title, :author, :date, :formatted_date, :link, :tags + + def initialize(yaml_hash) + @raw = yaml_hash + validate_required_fields! + parse_fields + end + + def self.parse(content) + if content =~ /\A---\s*\n(.*?)\n---\s*\n/m + yaml_content = $1 + yaml_hash = YAML.safe_load(yaml_content, permitted_classes: [Date, Time]) + new(yaml_hash) + else + raise "No YAML front-matter found in post" + end + end + + private + + def validate_required_fields! + missing = REQUIRED_FIELDS.reject { |field| @raw.key?(field) } + raise "Missing required fields: #{missing.join(", ")}" unless missing.empty? + end + + def parse_fields + @title = @raw["Title"] + @author = @raw["Author"] + timestamp = @raw["Timestamp"] + @date = timestamp.is_a?(String) ? DateTime.parse(timestamp) : timestamp.to_datetime + @formatted_date = @raw["Date"] + @link = @raw["Link"] + @tags = parse_tags(@raw["Tags"]) + end + + def parse_tags(value) + return [] if value.nil? + value.is_a?(Array) ? value : value.split(",").map(&:strip) + end + end + end +end diff --git a/lib/pressa/posts/models.rb b/lib/pressa/posts/models.rb new file mode 100644 index 0000000..d95d63e --- /dev/null +++ b/lib/pressa/posts/models.rb @@ -0,0 +1,95 @@ +require "dry-struct" +require "pressa/site" + +module Pressa + module Posts + class Post < Dry::Struct + attribute :slug, Types::String + attribute :title, Types::String + attribute :author, Types::String + attribute :date, Types::Params::DateTime + attribute :formatted_date, Types::String + attribute :link, Types::String.optional.default(nil) + attribute :tags, Types::Array.of(Types::String).default([].freeze) + attribute :body, Types::String + attribute :excerpt, Types::String + attribute :path, Types::String + + def link_post? + !link.nil? + end + + def year + date.year + end + + def month + date.month + end + + def formatted_month + date.strftime("%B") + end + + def padded_month + format("%02d", month) + end + end + + class Month < Dry::Struct + attribute :name, Types::String + attribute :number, Types::Integer + attribute :padded, Types::String + + def self.from_date(date) + new( + name: date.strftime("%B"), + number: date.month, + padded: format("%02d", date.month) + ) + end + end + + class MonthPosts < Dry::Struct + attribute :month, Month + attribute :posts, Types::Array.of(Post) + + def sorted_posts + posts.sort_by(&:date).reverse + end + end + + class YearPosts < Dry::Struct + attribute :year, Types::Integer + attribute :by_month, Types::Hash.map(Types::Integer, MonthPosts) + + def sorted_months + by_month.keys.sort.reverse.map { |month_num| by_month[month_num] } + end + + def all_posts + by_month.values.flat_map(&:posts).sort_by(&:date).reverse + end + end + + class PostsByYear < Dry::Struct + attribute :by_year, Types::Hash.map(Types::Integer, YearPosts) + + def sorted_years + by_year.keys.sort.reverse + end + + def all_posts + by_year.values.flat_map(&:all_posts).sort_by(&:date).reverse + end + + def recent_posts(limit = 10) + all_posts.take(limit) + end + + def earliest_year + by_year.keys.min + end + end + end +end diff --git a/lib/pressa/posts/plugin.rb b/lib/pressa/posts/plugin.rb new file mode 100644 index 0000000..f12db01 --- /dev/null +++ b/lib/pressa/posts/plugin.rb @@ -0,0 +1,38 @@ +require "pressa/plugin" +require "pressa/posts/repo" +require "pressa/posts/writer" +require "pressa/posts/json_feed" +require "pressa/posts/rss_feed" + +module Pressa + module Posts + class Plugin < Pressa::Plugin + attr_reader :posts_by_year + + def setup(site:, source_path:) + posts_dir = File.join(source_path, "posts") + return unless Dir.exist?(posts_dir) + + repo = PostRepo.new + @posts_by_year = repo.read_posts(posts_dir) + end + + def render(site:, target_path:) + return unless @posts_by_year + + writer = PostWriter.new(site:, posts_by_year: @posts_by_year) + writer.write_posts(target_path:) + writer.write_recent_posts(target_path:, limit: 10) + writer.write_archive(target_path:) + writer.write_year_indexes(target_path:) + writer.write_month_rollups(target_path:) + + json_feed = JSONFeedWriter.new(site:, posts_by_year: @posts_by_year) + json_feed.write_feed(target_path:, limit: 30) + + rss_feed = RSSFeedWriter.new(site:, posts_by_year: @posts_by_year) + rss_feed.write_feed(target_path:, limit: 30) + end + end + end +end diff --git a/lib/pressa/posts/repo.rb b/lib/pressa/posts/repo.rb new file mode 100644 index 0000000..a036556 --- /dev/null +++ b/lib/pressa/posts/repo.rb @@ -0,0 +1,124 @@ +require "kramdown" +require "pressa/posts/models" +require "pressa/posts/metadata" + +module Pressa + module Posts + class PostRepo + EXCERPT_LENGTH = 300 + + def initialize(output_path: "posts") + @output_path = output_path + @posts_by_year = {} + end + + def read_posts(posts_dir) + enumerate_markdown_files(posts_dir) do |file_path| + post = read_post(file_path) + add_post_to_hierarchy(post) + end + + PostsByYear.new(by_year: @posts_by_year) + end + + private + + def enumerate_markdown_files(dir, &block) + Dir.glob(File.join(dir, "**", "*.md")).each(&block) + end + + def read_post(file_path) + content = File.read(file_path) + metadata = PostMetadata.parse(content) + + body_markdown = content.sub(/\A---\s*\n.*?\n---\s*\n/m, "") + + html_body = render_markdown(body_markdown) + + slug = File.basename(file_path, ".md") + path = generate_path(slug, metadata.date) + excerpt = generate_excerpt(body_markdown) + + Post.new( + slug:, + title: metadata.title, + author: metadata.author, + date: metadata.date, + formatted_date: metadata.formatted_date, + link: metadata.link, + tags: metadata.tags, + body: html_body, + excerpt:, + path: + ) + end + + def render_markdown(markdown) + Kramdown::Document.new( + markdown, + input: "GFM", + hard_wrap: false, + syntax_highlighter: "rouge", + syntax_highlighter_opts: { + line_numbers: false, + wrap: true + } + ).to_html + end + + def generate_path(slug, date) + year = date.year + month = format("%02d", date.month) + "/#{@output_path}/#{year}/#{month}/#{slug}" + end + + def generate_excerpt(markdown) + text = markdown.dup + + text.gsub!(/!\[[^\]]*\]\([^)]+\)/, "") + text.gsub!(/!\[[^\]]*\]\[[^\]]+\]/, "") + + text.gsub!(/\[([^\]]+)\]\([^)]+\)/, '\1') + text.gsub!(/\[([^\]]+)\]\[[^\]]+\]/, '\1') + + text.gsub!(/(?m)^\[[^\]]+\]:\s*\S.*$/, "") + + text.gsub!(/<[^>]+>/, "") + + text.gsub!(/\s+/, " ") + text.strip! + + return "..." if text.empty? + + "#{text[0...EXCERPT_LENGTH]}..." + end + + def add_post_to_hierarchy(post) + year = post.year + month_num = post.month + + @posts_by_year[year] ||= create_year_posts(year) + year_posts = @posts_by_year[year] + + month_posts = year_posts.by_month[month_num] + if month_posts + updated_posts = month_posts.posts + [post] + year_posts.by_month[month_num] = MonthPosts.new( + month: month_posts.month, + posts: updated_posts + ) + else + month = Month.from_date(post.date) + year_posts.by_month[month_num] = MonthPosts.new( + month:, + posts: [post] + ) + end + end + + def create_year_posts(year) + YearPosts.new(year:, by_month: {}) + end + end + end +end diff --git a/lib/pressa/posts/rss_feed.rb b/lib/pressa/posts/rss_feed.rb new file mode 100644 index 0000000..c58b353 --- /dev/null +++ b/lib/pressa/posts/rss_feed.rb @@ -0,0 +1,53 @@ +require "builder" +require "pressa/utils/file_writer" +require "pressa/views/feed_post_view" + +module Pressa + module Posts + class RSSFeedWriter + def initialize(site:, posts_by_year:) + @site = site + @posts_by_year = posts_by_year + end + + def write_feed(target_path:, limit: 30) + recent = @posts_by_year.recent_posts(limit) + + xml = Builder::XmlMarkup.new(indent: 2) + xml.instruct! :xml, version: "1.0", encoding: "UTF-8" + + xml.rss :version => "2.0", + "xmlns:atom" => "http://www.w3.org/2005/Atom", + "xmlns:content" => "http://purl.org/rss/1.0/modules/content/" do + xml.channel do + xml.title @site.title + xml.link @site.url + xml.description @site.description + xml.pubDate recent.first.date.rfc822 if recent.any? + xml.tag! "atom:link", href: @site.url_for("/feed.xml"), rel: "self", type: "application/rss+xml" + + recent.each do |post| + xml.item do + title = post.link_post? ? "→ #{post.title}" : post.title + permalink = @site.url_for(post.path) + xml.title title + xml.link permalink + xml.guid permalink, isPermaLink: "true" + xml.pubDate post.date.rfc822 + xml.author post.author + xml.tag!("content:encoded") { xml.cdata!(render_feed_post(post)) } + end + end + end + end + + file_path = File.join(target_path, "feed.xml") + Utils::FileWriter.write(path: file_path, content: xml.target!) + end + + def render_feed_post(post) + Views::FeedPostView.new(post:, site: @site).call + end + end + end +end diff --git a/lib/pressa/posts/writer.rb b/lib/pressa/posts/writer.rb new file mode 100644 index 0000000..0d54aa1 --- /dev/null +++ b/lib/pressa/posts/writer.rb @@ -0,0 +1,137 @@ +require "pressa/utils/file_writer" +require "pressa/views/layout" +require "pressa/views/post_view" +require "pressa/views/recent_posts_view" +require "pressa/views/archive_view" +require "pressa/views/year_posts_view" +require "pressa/views/month_posts_view" + +module Pressa + module Posts + class PostWriter + def initialize(site:, posts_by_year:) + @site = site + @posts_by_year = posts_by_year + end + + def write_posts(target_path:) + @posts_by_year.all_posts.each do |post| + write_post(post:, target_path:) + end + end + + def write_recent_posts(target_path:, limit: 10) + recent = @posts_by_year.recent_posts(limit) + content_view = Views::RecentPostsView.new(posts: recent, site: @site) + + html = render_layout( + page_subtitle: nil, + canonical_url: @site.url, + content: content_view, + page_description: "Recent posts", + page_type: "article" + ) + + file_path = File.join(target_path, "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def write_archive(target_path:) + content_view = Views::ArchiveView.new(posts_by_year: @posts_by_year, site: @site) + + html = render_layout( + page_subtitle: "Archive", + canonical_url: @site.url_for("/posts/"), + content: content_view, + page_description: "Archive of all posts" + ) + + file_path = File.join(target_path, "posts", "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def write_year_indexes(target_path:) + @posts_by_year.sorted_years.each do |year| + year_posts = @posts_by_year.by_year[year] + write_year_index(year:, year_posts:, target_path:) + end + end + + def write_month_rollups(target_path:) + @posts_by_year.by_year.each do |year, year_posts| + year_posts.by_month.each do |_month_num, month_posts| + write_month_rollup(year:, month_posts:, target_path:) + end + end + end + + private + + def write_post(post:, target_path:) + content_view = Views::PostView.new(post:, site: @site, article_class: "container") + + html = render_layout( + page_subtitle: post.title, + canonical_url: @site.url_for(post.path), + content: content_view, + page_description: post.excerpt, + page_type: "article" + ) + + file_path = File.join(target_path, post.path.sub(/^\//, ""), "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def write_year_index(year:, year_posts:, target_path:) + content_view = Views::YearPostsView.new(year:, year_posts:, site: @site) + + html = render_layout( + page_subtitle: year.to_s, + canonical_url: @site.url_for("/posts/#{year}/"), + content: content_view, + page_description: "Archive of all posts from #{year}", + page_type: "article" + ) + + file_path = File.join(target_path, "posts", year.to_s, "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def write_month_rollup(year:, month_posts:, target_path:) + month = month_posts.month + content_view = Views::MonthPostsView.new(year:, month_posts:, site: @site) + + title = "#{month.name} #{year}" + html = render_layout( + page_subtitle: title, + canonical_url: @site.url_for("/posts/#{year}/#{month.padded}/"), + content: content_view, + page_description: "Archive of all posts from #{title}", + page_type: "article" + ) + + file_path = File.join(target_path, "posts", year.to_s, month.padded, "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def render_layout( + page_subtitle:, + canonical_url:, + content:, + page_description: nil, + page_type: "website" + ) + layout = Views::Layout.new( + site: @site, + page_subtitle:, + canonical_url:, + page_description:, + page_type:, + content: + ) + + layout.call + end + end + end +end diff --git a/lib/pressa/projects/models.rb b/lib/pressa/projects/models.rb new file mode 100644 index 0000000..a70c769 --- /dev/null +++ b/lib/pressa/projects/models.rb @@ -0,0 +1,22 @@ +require "dry-struct" +require "pressa/site" + +module Pressa + module Projects + class Project < Dry::Struct + attribute :name, Types::String + attribute :title, Types::String + attribute :description, Types::String + attribute :url, Types::String + + def github_path + uri = URI.parse(url) + uri.path.sub(/^\//, "") + end + + def path + "/projects/#{name}" + end + end + end +end diff --git a/lib/pressa/projects/plugin.rb b/lib/pressa/projects/plugin.rb new file mode 100644 index 0000000..cb1a611 --- /dev/null +++ b/lib/pressa/projects/plugin.rb @@ -0,0 +1,86 @@ +require "pressa/plugin" +require "pressa/utils/file_writer" +require "pressa/views/layout" +require "pressa/views/projects_view" +require "pressa/views/project_view" +require "pressa/projects/models" + +module Pressa + module Projects + class Plugin < Pressa::Plugin + attr_reader :scripts, :styles + + def initialize(projects: [], scripts: [], styles: []) + @projects = projects + @scripts = scripts + @styles = styles + end + + def setup(site:, source_path:) + end + + def render(site:, target_path:) + write_projects_index(site:, target_path:) + + @projects.each do |project| + write_project_page(project:, site:, target_path:) + end + end + + private + + def write_projects_index(site:, target_path:) + content_view = Views::ProjectsView.new(projects: @projects, site:) + + html = render_layout( + site:, + page_subtitle: "Projects", + canonical_url: site.url_for("/projects/"), + content: content_view + ) + + file_path = File.join(target_path, "projects", "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def write_project_page(project:, site:, target_path:) + content_view = Views::ProjectView.new(project:, site:) + + html = render_layout( + site:, + page_subtitle: project.title, + canonical_url: site.url_for(project.path), + content: content_view, + page_scripts: @scripts, + page_styles: @styles, + page_description: project.description + ) + + file_path = File.join(target_path, "projects", project.name, "index.html") + Utils::FileWriter.write(path: file_path, content: html) + end + + def render_layout( + site:, + page_subtitle:, + canonical_url:, + content:, + page_scripts: [], + page_styles: [], + page_description: nil + ) + layout = Views::Layout.new( + site:, + page_subtitle:, + canonical_url:, + page_scripts:, + page_styles:, + page_description:, + content: + ) + + layout.call + end + end + end +end diff --git a/lib/pressa/site.rb b/lib/pressa/site.rb new file mode 100644 index 0000000..99899d4 --- /dev/null +++ b/lib/pressa/site.rb @@ -0,0 +1,39 @@ +require "dry-struct" + +module Pressa + module Types + include Dry.Types() + end + + class Script < Dry::Struct + attribute :src, Types::String + attribute :defer, Types::Bool.default(true) + end + + class Stylesheet < Dry::Struct + attribute :href, Types::String + end + + class Site < Dry::Struct + attribute :author, Types::String + attribute :email, Types::String + attribute :title, Types::String + attribute :description, Types::String + attribute :url, Types::String + attribute :image_url, Types::String.optional.default(nil) + attribute :copyright_start_year, Types::Integer.optional.default(nil) + attribute :scripts, Types::Array.of(Script).default([].freeze) + attribute :styles, Types::Array.of(Stylesheet).default([].freeze) + attribute :plugins, Types::Array.default([].freeze) + attribute :renderers, Types::Array.default([].freeze) + + def url_for(path) + "#{url}#{path}" + end + + def image_url_for(path) + return nil unless image_url + "#{image_url}#{path}" + end + end +end diff --git a/lib/pressa/site_generator.rb b/lib/pressa/site_generator.rb new file mode 100644 index 0000000..bc7aa6b --- /dev/null +++ b/lib/pressa/site_generator.rb @@ -0,0 +1,123 @@ +require "fileutils" +require "pressa/utils/file_writer" + +module Pressa + class SiteGenerator + attr_reader :site + + def initialize(site:) + @site = site + end + + def generate(source_path:, target_path:) + validate_paths!(source_path:, target_path:) + + FileUtils.rm_rf(target_path) + FileUtils.mkdir_p(target_path) + + setup_site = site + setup_site.plugins.each { |plugin| plugin.setup(site: setup_site, source_path:) } + + @site = site_with_copyright_start_year(setup_site) + site.plugins.each { |plugin| plugin.render(site:, target_path:) } + + copy_static_files(source_path, target_path) + process_public_directory(source_path, target_path) + end + + private + + def validate_paths!(source_path:, target_path:) + source_abs = absolute_path(source_path) + target_abs = absolute_path(target_path) + return unless contains_path?(container: target_abs, path: source_abs) + + raise ArgumentError, "target_path must not be the same as or contain source_path" + end + + def absolute_path(path) + File.exist?(path) ? File.realpath(path) : File.expand_path(path) + end + + def contains_path?(container:, path:) + path == container || path.start_with?("#{container}#{File::SEPARATOR}") + end + + def copy_static_files(source_path, target_path) + public_dir = File.join(source_path, "public") + return unless Dir.exist?(public_dir) + + Dir.glob(File.join(public_dir, "**", "*"), File::FNM_DOTMATCH).each do |source_file| + next if File.directory?(source_file) + next if skip_file?(source_file) + + filename = File.basename(source_file) + ext = File.extname(source_file)[1..] + + if can_render?(filename, ext) + next + end + + relative_path = source_file.sub("#{public_dir}/", "") + target_file = File.join(target_path, relative_path) + + FileUtils.mkdir_p(File.dirname(target_file)) + FileUtils.cp(source_file, target_file) + end + end + + def can_render?(filename, ext) + site.renderers.any? { |renderer| renderer.can_render_file?(filename:, extension: ext) } + end + + def process_public_directory(source_path, target_path) + public_dir = File.join(source_path, "public") + return unless Dir.exist?(public_dir) + + site.renderers.each do |renderer| + Dir.glob(File.join(public_dir, "**", "*"), File::FNM_DOTMATCH).each do |source_file| + next if File.directory?(source_file) + next if skip_file?(source_file) + + filename = File.basename(source_file) + ext = File.extname(source_file)[1..] + + if renderer.can_render_file?(filename:, extension: ext) + dir_name = File.dirname(source_file) + relative_path = if dir_name == public_dir + "" + else + dir_name.sub("#{public_dir}/", "") + end + target_dir = File.join(target_path, relative_path) + + renderer.render(site:, file_path: source_file, target_dir:) + end + end + end + end + + def skip_file?(source_file) + basename = File.basename(source_file) + basename.start_with?(".") + end + + def site_with_copyright_start_year(base_site) + start_year = find_copyright_start_year(base_site) + Site.new(**base_site.to_h.merge(copyright_start_year: start_year)) + end + + def find_copyright_start_year(base_site) + years = base_site.plugins.filter_map do |plugin| + next unless plugin.respond_to?(:posts_by_year) + + posts_by_year = plugin.posts_by_year + next unless posts_by_year.respond_to?(:earliest_year) + + posts_by_year.earliest_year + end + + years.min || Time.now.year + end + end +end diff --git a/lib/pressa/utils/file_writer.rb b/lib/pressa/utils/file_writer.rb new file mode 100644 index 0000000..96331ce --- /dev/null +++ b/lib/pressa/utils/file_writer.rb @@ -0,0 +1,20 @@ +require "fileutils" + +module Pressa + module Utils + class FileWriter + def self.write(path:, content:, permissions: 0o644) + FileUtils.mkdir_p(File.dirname(path)) + File.write(path, content, mode: "w") + File.chmod(permissions, path) + end + + def self.write_data(path:, data:, permissions: 0o644) + FileUtils.mkdir_p(File.dirname(path)) + + File.binwrite(path, data) + File.chmod(permissions, path) + end + end + end +end diff --git a/lib/pressa/utils/markdown_renderer.rb b/lib/pressa/utils/markdown_renderer.rb new file mode 100644 index 0000000..8dc1bfc --- /dev/null +++ b/lib/pressa/utils/markdown_renderer.rb @@ -0,0 +1,148 @@ +require "kramdown" +require "yaml" +require "pressa/utils/file_writer" +require "pressa/site" +require "pressa/views/layout" +require "pressa/views/icons" + +module Pressa + module Utils + class MarkdownRenderer + EXCERPT_LENGTH = 300 + + def can_render_file?(filename:, extension:) + extension == "md" + end + + def render(site:, file_path:, target_dir:) + content = File.read(file_path) + metadata, body_markdown = parse_content(content) + + html_body = render_markdown(body_markdown) + + page_title = presence(metadata["Title"]) || File.basename(file_path, ".md").capitalize + page_type = presence(metadata["Page type"]) || "website" + page_description = presence(metadata["Description"]) || generate_excerpt(body_markdown) + show_extension = ["true", "yes", true].include?(metadata["Show extension"]) + + slug = File.basename(file_path, ".md") + + relative_dir = File.dirname(file_path).sub(/^.*?\/public\/?/, "") + relative_dir = "" if relative_dir == "." + + canonical_path = if show_extension + "/#{relative_dir}/#{slug}.html".squeeze("/") + else + "/#{relative_dir}/#{slug}/".squeeze("/") + end + + html = render_layout( + site:, + page_subtitle: page_title, + canonical_url: site.url_for(canonical_path), + body: html_body, + page_description:, + page_type: + ) + + output_filename = if show_extension + "#{slug}.html" + else + File.join(slug, "index.html") + end + + output_path = File.join(target_dir, output_filename) + FileWriter.write(path: output_path, content: html) + end + + private + + def parse_content(content) + if content =~ /\A---\s*\n(.*?)\n---\s*\n(.*)/m + yaml_content = $1 + markdown = $2 + metadata = YAML.safe_load(yaml_content) || {} + [metadata, markdown] + else + [{}, content] + end + end + + def render_markdown(markdown) + Kramdown::Document.new( + markdown, + input: "GFM", + hard_wrap: false, + syntax_highlighter: "rouge", + syntax_highlighter_opts: { + line_numbers: false, + wrap: true + } + ).to_html + end + + def render_layout(site:, page_subtitle:, canonical_url:, body:, page_description:, page_type:) + layout = Views::Layout.new( + site:, + page_subtitle:, + canonical_url:, + page_description:, + page_type:, + content: PageView.new(page_title: page_subtitle, body:) + ) + + layout.call + end + + class PageView < Phlex::HTML + def initialize(page_title:, body:) + @page_title = page_title + @body = body + end + + def view_template + article(class: "container") do + h1 { @page_title } + raw(safe(@body)) + end + + div(class: "row clearfix") do + p(class: "fin") do + raw(safe(Views::Icons.code)) + end + end + end + end + + def generate_excerpt(markdown) + text = markdown.dup + + # Drop inline and reference-style images before links are simplified. + text.gsub!(/!\[[^\]]*\]\([^)]+\)/, "") + text.gsub!(/!\[[^\]]*\]\[[^\]]+\]/, "") + + # Replace inline and reference links with just their text. + text.gsub!(/\[([^\]]+)\]\([^)]+\)/, '\1') + text.gsub!(/\[([^\]]+)\]\[[^\]]+\]/, '\1') + + # Remove link reference definitions such as: [foo]: http://example.com + text.gsub!(/(?m)^\[[^\]]+\]:\s*\S.*$/, "") + + text.gsub!(/<[^>]+>/, "") + text.gsub!(/\s+/, " ") + text.strip! + + return nil if text.empty? + + "#{text[0...EXCERPT_LENGTH]}..." + end + + def presence(value) + return value unless value.respond_to?(:strip) + + stripped = value.strip + stripped.empty? ? nil : stripped + end + end + end +end diff --git a/lib/pressa/views/archive_view.rb b/lib/pressa/views/archive_view.rb new file mode 100644 index 0000000..1bde3b5 --- /dev/null +++ b/lib/pressa/views/archive_view.rb @@ -0,0 +1,24 @@ +require "phlex" +require "pressa/views/year_posts_view" + +module Pressa + module Views + class ArchiveView < Phlex::HTML + def initialize(posts_by_year:, site:) + @posts_by_year = posts_by_year + @site = site + end + + def view_template + div(class: "container") do + h1 { "Archive" } + end + + @posts_by_year.sorted_years.each do |year| + year_posts = @posts_by_year.by_year[year] + render Views::YearPostsView.new(year:, year_posts:, site: @site) + end + end + end + end +end diff --git a/lib/pressa/views/feed_post_view.rb b/lib/pressa/views/feed_post_view.rb new file mode 100644 index 0000000..fabbc4b --- /dev/null +++ b/lib/pressa/views/feed_post_view.rb @@ -0,0 +1,33 @@ +require "phlex" + +module Pressa + module Views + class FeedPostView < Phlex::HTML + def initialize(post:, site:) + @post = post + @site = site + end + + def view_template + div do + p(class: "time") { @post.formatted_date } + raw(safe(normalized_body)) + p do + a(class: "permalink", href: @site.url_for(@post.path)) { "∞" } + end + end + end + + private + + def normalized_body + @post.body.gsub(/(href|src)=(['"])(\/(?!\/)[^'"]*)\2/) do + attr = Regexp.last_match(1) + quote = Regexp.last_match(2) + path = Regexp.last_match(3) + %(#{attr}=#{quote}#{@site.url_for(path)}#{quote}) + end + end + end + end +end diff --git a/lib/pressa/views/icons.rb b/lib/pressa/views/icons.rb new file mode 100644 index 0000000..6a3c7dd --- /dev/null +++ b/lib/pressa/views/icons.rb @@ -0,0 +1,34 @@ +module Pressa + module Views + module Icons + module_function + + def mastodon + svg(class_name: "icon icon-mastodon", view_box: "0 0 448 512", path: IconPath::MASTODON) + end + + def github + svg(class_name: "icon icon-github", view_box: "0 0 496 512", path: IconPath::GITHUB) + end + + def rss + svg(class_name: "icon icon-rss", view_box: "0 0 448 512", path: IconPath::RSS) + end + + def code + svg(class_name: "icon icon-code", view_box: "0 0 640 512", path: IconPath::CODE) + end + + private_class_method def svg(class_name:, view_box:, path:) + "" + end + + module IconPath + MASTODON = "M433 268.89c0 0 0.799805 -71.6992 -9 -121.5c-6.23047 -31.5996 -55.1104 -66.1992 -111.23 -72.8994c-20.0996 -2.40039 -93.1191 -14.2002 -178.75 6.7002c0 -0.116211 -0.00390625 -0.119141 -0.00390625 -0.235352c0 -4.63281 0.307617 -9.19434 0.904297 -13.665 c6.62988 -49.5996 49.2197 -52.5996 89.6299 -54c40.8105 -1.2998 77.1201 10.0996 77.1201 10.0996l1.7002 -36.8994s-28.5098 -15.2998 -79.3203 -18.1006c-28.0098 -1.59961 -62.8193 0.700195 -103.33 11.4004c-112.229 29.7002 -105.63 173.4 -105.63 289.1 c0 97.2002 63.7197 125.7 63.7197 125.7c61.9209 28.4004 227.96 28.7002 290.48 0c0 0 63.71 -28.5 63.71 -125.7zM357.88 143.69c0 122 5.29004 147.71 -18.4199 175.01c-25.71 28.7002 -79.7197 31 -103.83 -6.10059l-11.5996 -19.5l-11.6006 19.5 c-24.0098 36.9004 -77.9297 35 -103.83 6.10059c-23.6094 -27.1006 -18.4092 -52.9004 -18.4092 -175h46.7295v114.2c0 49.6992 64 51.5996 64 -6.90039v-62.5098h46.3301v62.5c0 58.5 64 56.5996 64 6.89941v-114.199h46.6299z" + GITHUB = "M165.9 50.5996c0 -2 -2.30078 -3.59961 -5.2002 -3.59961c-3.2998 -0.299805 -5.60059 1.2998 -5.60059 3.59961c0 2 2.30078 3.60059 5.2002 3.60059c3 0.299805 5.60059 -1.2998 5.60059 -3.60059zM134.8 55.0996c0.700195 2 3.60059 3 6.2002 2.30078 c3 -0.900391 4.90039 -3.2002 4.2998 -5.2002c-0.599609 -2 -3.59961 -3 -6.2002 -2c-3 0.599609 -5 2.89941 -4.2998 4.89941zM179 56.7998c2.90039 0.299805 5.59961 -1 5.90039 -2.89941c0.299805 -2 -1.7002 -3.90039 -4.60059 -4.60059 c-3 -0.700195 -5.59961 0.600586 -5.89941 2.60059c-0.300781 2.2998 1.69922 4.19922 4.59961 4.89941zM244.8 440c138.7 0 251.2 -105.3 251.2 -244c0 -110.9 -67.7998 -205.8 -167.8 -239c-12.7002 -2.2998 -17.2998 5.59961 -17.2998 12.0996 c0 8.2002 0.299805 49.9004 0.299805 83.6006c0 23.5 -7.7998 38.5 -17 46.3994c55.8994 6.30078 114.8 14 114.8 110.5c0 27.4004 -9.7998 41.2002 -25.7998 58.9004c2.59961 6.5 11.0996 33.2002 -2.60059 67.9004c-20.8994 6.59961 -69 -27 -69 -27 c-20 5.59961 -41.5 8.5 -62.7998 8.5s-42.7998 -2.90039 -62.7998 -8.5c0 0 -48.0996 33.5 -69 27c-13.7002 -34.6006 -5.2002 -61.4004 -2.59961 -67.9004c-16 -17.5996 -23.6006 -31.4004 -23.6006 -58.9004c0 -96.1992 56.4004 -104.3 112.3 -110.5 c-7.19922 -6.59961 -13.6992 -17.6992 -16 -33.6992c-14.2998 -6.60059 -51 -17.7002 -72.8994 20.8994c-13.7002 23.7998 -38.6006 25.7998 -38.6006 25.7998c-24.5 0.300781 -1.59961 -15.3994 -1.59961 -15.3994c16.4004 -7.5 27.7998 -36.6006 27.7998 -36.6006 c14.7002 -44.7998 84.7002 -29.7998 84.7002 -29.7998c0 -21 0.299805 -55.2002 0.299805 -61.3994c0 -6.5 -4.5 -14.4004 -17.2998 -12.1006c-99.7002 33.4004 -169.5 128.3 -169.5 239.2c0 138.7 106.1 244 244.8 244zM97.2002 95.0996 c1.2998 1.30078 3.59961 0.600586 5.2002 -1c1.69922 -1.89941 2 -4.19922 0.699219 -5.19922c-1.2998 -1.30078 -3.59961 -0.600586 -5.19922 1c-1.7002 1.89941 -2 4.19922 -0.700195 5.19922zM86.4004 103.2c0.699219 1 2.2998 1.2998 4.2998 0.700195 c2 -1 3 -2.60059 2.2998 -3.90039c-0.700195 -1.40039 -2.7002 -1.7002 -4.2998 -0.700195c-2 1 -3 2.60059 -2.2998 3.90039zM118.8 67.5996c1.2998 1.60059 4.2998 1.30078 6.5 -1c2 -1.89941 2.60059 -4.89941 1.2998 -6.19922 c-1.2998 -1.60059 -4.19922 -1.30078 -6.5 1c-2.2998 1.89941 -2.89941 4.89941 -1.2998 6.19922zM107.4 82.2998c1.59961 1.2998 4.19922 0.299805 5.59961 -2c1.59961 -2.2998 1.59961 -4.89941 0 -6.2002c-1.2998 -1 -4 0 -5.59961 2.30078 c-1.60059 2.2998 -1.60059 4.89941 0 5.89941z" + RSS = "M128.081 32.041c0 -35.3691 -28.6719 -64.041 -64.041 -64.041s-64.04 28.6719 -64.04 64.041s28.6719 64.041 64.041 64.041s64.04 -28.6729 64.04 -64.041zM303.741 -15.209c0.494141 -9.13477 -6.84668 -16.791 -15.9951 -16.79h-48.0693 c-8.41406 0 -15.4707 6.49023 -16.0176 14.8867c-7.29883 112.07 -96.9404 201.488 -208.772 208.772c-8.39648 0.545898 -14.8867 7.60254 -14.8867 16.0176v48.0693c0 9.14746 7.65625 16.4883 16.791 15.9941c154.765 -8.36328 278.596 -132.351 286.95 -286.95z M447.99 -15.4971c0.324219 -9.03027 -6.97168 -16.5029 -16.0049 -16.5039h-48.0684c-8.62598 0 -15.6455 6.83496 -15.999 15.4531c-7.83789 191.148 -161.286 344.626 -352.465 352.465c-8.61816 0.354492 -15.4531 7.37402 -15.4531 15.999v48.0684 c0 9.03418 7.47266 16.3301 16.5029 16.0059c234.962 -8.43555 423.093 -197.667 431.487 -431.487z" + CODE = "M278.9 -63.5l-61 17.7002c-6.40039 1.7998 -10 8.5 -8.2002 14.8994l136.5 470.2c1.7998 6.40039 8.5 10 14.8994 8.2002l61 -17.7002c6.40039 -1.7998 10 -8.5 8.2002 -14.8994l-136.5 -470.2c-1.89941 -6.40039 -8.5 -10.1006 -14.8994 -8.2002zM164.9 48.7002 c-4.5 -4.90039 -12.1006 -5.10059 -17 -0.5l-144.101 135.1c-5.09961 4.7002 -5.09961 12.7998 0 17.5l144.101 135c4.89941 4.60059 12.5 4.2998 17 -0.5l43.5 -46.3994c4.69922 -4.90039 4.2998 -12.7002 -0.800781 -17.2002l-90.5996 -79.7002l90.5996 -79.7002 c5.10059 -4.5 5.40039 -12.2998 0.800781 -17.2002zM492.1 48.0996c-4.89941 -4.5 -12.5 -4.2998 -17 0.600586l-43.5 46.3994c-4.69922 4.90039 -4.2998 12.7002 0.800781 17.2002l90.5996 79.7002l-90.5996 79.7998c-5.10059 4.5 -5.40039 12.2998 -0.800781 17.2002 l43.5 46.4004c4.60059 4.7998 12.2002 5 17 0.5l144.101 -135.2c5.09961 -4.7002 5.09961 -12.7998 0 -17.5z" + end + end + end +end diff --git a/lib/pressa/views/layout.rb b/lib/pressa/views/layout.rb new file mode 100644 index 0000000..28dddcd --- /dev/null +++ b/lib/pressa/views/layout.rb @@ -0,0 +1,208 @@ +require "phlex" +require "pressa/views/icons" + +module Pressa + module Views + class Layout < Phlex::HTML + attr_reader :site, + :page_subtitle, + :page_description, + :page_type, + :canonical_url, + :page_scripts, + :page_styles, + :content + + def initialize( + site:, + canonical_url:, page_subtitle: nil, + page_description: nil, + page_type: "website", + page_scripts: [], + page_styles: [], + content: nil + ) + @site = site + @page_subtitle = page_subtitle + @page_description = page_description + @page_type = page_type + @canonical_url = canonical_url + @page_scripts = page_scripts + @page_styles = page_styles + @content = content + end + + def view_template + doctype + + html(lang: "en") do + comment { "meow" } + + head do + meta(charset: "UTF-8") + title { full_title } + meta(name: "twitter:title", content: full_title) + meta(property: "og:title", content: full_title) + meta(name: "description", content: description) + meta(name: "twitter:description", content: description) + meta(property: "og:description", content: description) + meta(property: "og:site_name", content: site.title) + + link(rel: "canonical", href: canonical_url) + meta(name: "twitter:url", content: canonical_url) + meta(property: "og:url", content: canonical_url) + meta(property: "og:image", content: og_image_url) if og_image_url + meta(property: "og:type", content: page_type) + meta(property: "article:author", content: site.author) + meta(name: "twitter:card", content: "summary") + + link( + rel: "alternate", + href: site.url_for("/feed.xml"), + type: "application/rss+xml", + title: site.title + ) + link( + rel: "alternate", + href: site.url_for("/feed.json"), + type: "application/json", + title: site.title + ) + + meta(name: "fediverse:creator", content: "@sjs@techhub.social") + link(rel: "author", type: "text/plain", href: site.url_for("/humans.txt")) + link(rel: "icon", type: "image/png", href: site.url_for("/images/favicon-32x32.png")) + link(rel: "shortcut icon", href: site.url_for("/images/favicon.icon")) + link(rel: "apple-touch-icon", href: site.url_for("/images/apple-touch-icon.png")) + link(rel: "mask-icon", color: "#aa0000", href: site.url_for("/images/safari-pinned-tab.svg")) + link(rel: "manifest", href: site.url_for("/images/manifest.json")) + meta(name: "msapplication-config", content: site.url_for("/images/browserconfig.xml")) + meta(name: "theme-color", content: "#121212") + meta(name: "viewport", content: "width=device-width, initial-scale=1.0, viewport-fit=cover") + link(rel: "dns-prefetch", href: "https://gist.github.com") + + all_styles.each do |style| + link(rel: "stylesheet", type: "text/css", href: style_href(style.href)) + end + end + + body do + render_header + render(content) if content + render_footer + render_scripts + end + end + end + + private + + def description + page_description || site.description + end + + def full_title + return site.title unless page_subtitle + + "#{site.title}: #{page_subtitle}" + end + + def og_image_url + site.image_url + end + + def all_styles + site.styles + page_styles + end + + def all_scripts + site.scripts + page_scripts + end + + def render_header + header(class: "primary") do + div(class: "title") do + h1 do + a(href: site.url) { site.title } + end + br + h4 do + plain "By " + a(href: site.url_for("/about")) { site.author } + end + end + + nav(class: "remote") do + ul do + li(class: "mastodon") do + a(rel: "me", "aria-label": "Mastodon", href: "https://techhub.social/@sjs") do + raw(safe(Icons.mastodon)) + end + end + li(class: "github") do + a("aria-label": "GitHub", href: "https://github.com/samsonjs") do + raw(safe(Icons.github)) + end + end + li(class: "rss") do + a("aria-label": "RSS", href: site.url_for("/feed.xml")) do + raw(safe(Icons.rss)) + end + end + end + end + + nav(class: "local") do + ul do + li { a(href: site.url_for("/about")) { "About" } } + li { a(href: site.url_for("/posts")) { "Archive" } } + li { a(href: site.url_for("/projects")) { "Projects" } } + end + end + + div(class: "clearfix") + end + end + + def render_footer + footer do + plain "© #{footer_years} " + a(href: site.url_for("/about")) { site.author } + end + end + + def render_scripts + all_scripts.each do |scr| + attrs = {src: script_src(scr.src)} + attrs[:defer] = true if scr.defer + script(**attrs) + end + end + + def script_src(src) + return src if src.start_with?("http://", "https://") + + absolute_asset(src) + end + + def style_href(href) + return href if href.start_with?("http://", "https://") + + absolute_asset(href) + end + + def absolute_asset(path) + normalized = path.start_with?("/") ? path : "/#{path}" + site.url_for(normalized) + end + + def footer_years + current_year = Time.now.year + start_year = site.copyright_start_year || current_year + return current_year.to_s if start_year >= current_year + + "#{start_year} - #{current_year}" + end + end + end +end diff --git a/lib/pressa/views/month_posts_view.rb b/lib/pressa/views/month_posts_view.rb new file mode 100644 index 0000000..9b50016 --- /dev/null +++ b/lib/pressa/views/month_posts_view.rb @@ -0,0 +1,26 @@ +require "phlex" +require "pressa/views/post_view" + +module Pressa + module Views + class MonthPostsView < Phlex::HTML + def initialize(year:, month_posts:, site:) + @year = year + @month_posts = month_posts + @site = site + end + + def view_template + div(class: "container") do + h1 { "#{@month_posts.month.name} #{@year}" } + end + + @month_posts.sorted_posts.each do |post| + div(class: "container") do + render PostView.new(post:, site: @site) + end + end + end + end + end +end diff --git a/lib/pressa/views/post_view.rb b/lib/pressa/views/post_view.rb new file mode 100644 index 0000000..30b0381 --- /dev/null +++ b/lib/pressa/views/post_view.rb @@ -0,0 +1,46 @@ +require "phlex" +require "pressa/views/icons" + +module Pressa + module Views + class PostView < Phlex::HTML + def initialize(post:, site:, article_class: nil) + @post = post + @site = site + @article_class = article_class + end + + def view_template + article(**article_attributes) do + header do + h2 do + if @post.link_post? + a(href: @post.link) { "→ #{@post.title}" } + else + a(href: @post.path) { @post.title } + end + end + time { @post.formatted_date } + a(href: @post.path, class: "permalink") { "∞" } + end + + raw(safe(@post.body)) + end + + div(class: "row clearfix") do + p(class: "fin") do + raw(safe(Icons.code)) + end + end + end + + private + + def article_attributes + return {} unless @article_class + + {class: @article_class} + end + end + end +end diff --git a/lib/pressa/views/project_view.rb b/lib/pressa/views/project_view.rb new file mode 100644 index 0000000..53f6906 --- /dev/null +++ b/lib/pressa/views/project_view.rb @@ -0,0 +1,63 @@ +require "phlex" +require "pressa/views/icons" + +module Pressa + module Views + class ProjectView < Phlex::HTML + def initialize(project:, site:) + @project = project + @site = site + end + + def view_template + article(class: "container project") do + h1(id: "project", data: {title: @project.title}) { @project.title } + h4 { @project.description } + + div(class: "project-stats") do + p do + a(href: @project.url) { "GitHub" } + plain " • " + a(id: "nstar", href: stargazers_url) + plain " • " + a(id: "nfork", href: network_url) + end + + p do + plain "Last updated on " + span(id: "updated") + end + end + + div(class: "project-info row clearfix") do + div(class: "column half") do + h3 { "Contributors" } + div(id: "contributors") + end + + div(class: "column half") do + h3 { "Languages" } + div(id: "langs") + end + end + end + + div(class: "row clearfix") do + p(class: "fin") do + raw(safe(Icons.code)) + end + end + end + + private + + def stargazers_url + "#{@project.url}/stargazers" + end + + def network_url + "#{@project.url}/network/members" + end + end + end +end diff --git a/lib/pressa/views/projects_view.rb b/lib/pressa/views/projects_view.rb new file mode 100644 index 0000000..a1f20d1 --- /dev/null +++ b/lib/pressa/views/projects_view.rb @@ -0,0 +1,34 @@ +require "phlex" +require "pressa/views/icons" + +module Pressa + module Views + class ProjectsView < Phlex::HTML + def initialize(projects:, site:) + @projects = projects + @site = site + end + + def view_template + article(class: "container") do + h1 { "Projects" } + + @projects.each do |project| + div(class: "project-listing") do + h4 do + a(href: @site.url_for(project.path)) { project.title } + end + p(class: "description") { project.description } + end + end + end + + div(class: "row clearfix") do + p(class: "fin") do + raw(safe(Icons.code)) + end + end + end + end + end +end diff --git a/lib/pressa/views/recent_posts_view.rb b/lib/pressa/views/recent_posts_view.rb new file mode 100644 index 0000000..79550c2 --- /dev/null +++ b/lib/pressa/views/recent_posts_view.rb @@ -0,0 +1,21 @@ +require "phlex" +require "pressa/views/post_view" + +module Pressa + module Views + class RecentPostsView < Phlex::HTML + def initialize(posts:, site:) + @posts = posts + @site = site + end + + def view_template + div(class: "container") do + @posts.each do |post| + render PostView.new(post:, site: @site) + end + end + end + end + end +end diff --git a/lib/pressa/views/year_posts_view.rb b/lib/pressa/views/year_posts_view.rb new file mode 100644 index 0000000..82b5743 --- /dev/null +++ b/lib/pressa/views/year_posts_view.rb @@ -0,0 +1,66 @@ +require "phlex" + +module Pressa + module Views + class YearPostsView < Phlex::HTML + def initialize(year:, year_posts:, site:) + @year = year + @year_posts = year_posts + @site = site + end + + def view_template + div(class: "container") do + h2(class: "year") do + a(href: year_path) { @year.to_s } + end + + @year_posts.sorted_months.each do |month_posts| + render_month(month_posts) + end + end + end + + private + + def year_path + @site.url_for("/posts/#{@year}/") + end + + def render_month(month_posts) + month = month_posts.month + + h3(class: "month") do + a(href: @site.url_for("/posts/#{@year}/#{month.padded}/")) do + month.name + end + end + + ul(class: "archive") do + month_posts.sorted_posts.each do |post| + render_post_item(post) + end + end + end + + def render_post_item(post) + if post.link_post? + li do + a(href: post.link) { "→ #{post.title}" } + time { short_date(post.date) } + a(class: "permalink", href: post.path) { "∞" } + end + else + li do + a(href: post.path) { post.title } + time { short_date(post.date) } + end + end + end + + def short_date(date) + date.strftime("%-d %b") + end + end + end +end diff --git a/posts/2006/02/first-post.md b/posts/2006/02/first-post.md index fab2b2d..63ab7f4 100644 --- a/posts/2006/02/first-post.md +++ b/posts/2006/02/first-post.md @@ -1,7 +1,7 @@ --- -Title: First Post! +Title: "First Post!" Author: Sami Samhuri -Date: 8th February, 2006 +Date: "8th February, 2006" Timestamp: 2006-02-07T19:21:00-08:00 Tags: life --- diff --git a/posts/2006/02/girlfriend-x.md b/posts/2006/02/girlfriend-x.md index 03fbe89..14757ad 100644 --- a/posts/2006/02/girlfriend-x.md +++ b/posts/2006/02/girlfriend-x.md @@ -1,7 +1,7 @@ --- -Title: Girlfriend X +Title: "Girlfriend X" Author: Sami Samhuri -Date: 18th February, 2006 +Date: "18th February, 2006" Timestamp: 2006-02-18T11:50:00-08:00 Tags: crazy, funny --- diff --git a/posts/2006/02/intelligent-migration-snippets-0_1-for-textmate.md b/posts/2006/02/intelligent-migration-snippets-0_1-for-textmate.md index 6a42fa5..b9aebf2 100644 --- a/posts/2006/02/intelligent-migration-snippets-0_1-for-textmate.md +++ b/posts/2006/02/intelligent-migration-snippets-0_1-for-textmate.md @@ -1,7 +1,7 @@ --- -Title: Intelligent Migration Snippets 0.1 for TextMate +Title: "Intelligent Migration Snippets 0.1 for TextMate" Author: Sami Samhuri -Date: 22nd February, 2006 +Date: "22nd February, 2006" Timestamp: 2006-02-22T03:28:00-08:00 Tags: mac os x, textmate, rails, hacking, migrations, snippets --- diff --git a/posts/2006/02/jump-to-viewcontroller-in-textmate.md b/posts/2006/02/jump-to-viewcontroller-in-textmate.md index cddaba1..a6cbec6 100644 --- a/posts/2006/02/jump-to-viewcontroller-in-textmate.md +++ b/posts/2006/02/jump-to-viewcontroller-in-textmate.md @@ -1,7 +1,7 @@ --- -Title: Jump to view/controller in TextMate +Title: "Jump to view/controller in TextMate" Author: Sami Samhuri -Date: 18th February, 2006 +Date: "18th February, 2006" Timestamp: 2006-02-18T14:51:00-08:00 Tags: hacking, rails, textmate, rails, textmate --- diff --git a/posts/2006/02/obligatory-post-about-ruby-on-rails.md b/posts/2006/02/obligatory-post-about-ruby-on-rails.md index 49eb02c..28ba837 100644 --- a/posts/2006/02/obligatory-post-about-ruby-on-rails.md +++ b/posts/2006/02/obligatory-post-about-ruby-on-rails.md @@ -1,10 +1,9 @@ --- -Title: Obligatory Post about Ruby on Rails +Title: "Obligatory Post about Ruby on Rails" Author: Sami Samhuri -Date: 20th February, 2006 +Date: "20th February, 2006" Timestamp: 2006-02-20T00:31:00-08:00 Tags: rails, coding, hacking, migration, rails, testing -Styles: typocode.css ---

I'm a Rails newbie and eager to learn. I welcome any suggestions or criticism you have. You can direct them to my inbox or leave me a comment below.

@@ -17,52 +16,36 @@ Styles: typocode.css

It's unlikely that he was surprised at my lengthy response, but I was. I have been known to write him long messages on topics that interest me. However, I've only been learning Rails for two weeks or so. Could I possibly have so much to say about it already? Apparently I do.

Ruby on Rails background

-

I assume a pretty basic knowledge of what Rails is, so if you're not familiar with it now's a good time to read something on the official Rails website and watch the infamous 15-minute screencast, where Rails creator, David Heinemeier Hansson, creates a simple blog application.

-

The screencasts are what sparked my curiosity, but they hardly scratch the surface of Rails. After that I spent hours reading whatever I could find about Rails before deciding to take the time to learn it well. As a result, a lot of what you read here will sound familiar if you've read other blogs and articles about Rails. This post wasn't planned so there's no list of references yet. I hope to add some links though so please contact me if any ideas or paraphrasing here is from your site, or if you know who I should give credit to.

-

Rails through my eyes

-

Rails is like my Black & Decker toolkit. I have a hammer, power screwdriver, tape measure, needle-nose pliers, wire cutters, a level, etc. This is exactly what I need—no more, no less. It helps me get things done quickly and easily that would otherwise be painful and somewhat difficult. I can pick up the tools and use them without much training. Therefore I am instantly productive with them.

-

The kit is suitable for many people who need these things at home, such as myself. Companies build skyscrapers and huge malls and apartments, and they clearly need more powerful tools than I. There are others that just need to drive in a nail to hang a picture, in which case the kit I have is overkill. They're better off just buying and using a single hammer. I happen to fall in the big grey middle chunk, not the other two.

-

I'm a university student. I code because it's satisfying and fun to create software. I do plan on coding for a living when I graduate. I don't work with ancient databases, or create monster sites like Amazon, Google, or Ebay. The last time I started coding a website from scratch I was using PHP, that was around the turn of the millennium. [It was a fan site for a favourite band of mine.]

-

After a year or so I realized I didn't have the time to do it properly (ie. securely and cleanly) if I wanted it to be done relatively soon. A slightly customized MediaWiki promptly took it's place. It did all that I needed quite well, just in a less specific way.

-

The wiki is serving my site extremely well, but there's still that itch to create my own site. I feel if Rails was around back then I may have been able to complete the project in a timely manner. I was also frustrated with PHP. Part of that is likely due to a lack of experience and of formal programming education at that time, but it was still not fun for me. It wasn't until I started learning Rails that I thought "hey, I could create that site pretty quickly using this!"

-

Rails fits my needs like a glove, and this is where it shines. Many professionals are making money creating sites in Rails, so I'm not trying to say it's for amateurs only or something equally silly.

-

Web Frameworks and iPods?

-

Some might say I have merely been swept up in hype and am following the herd. You may be right, and that's okay. I'm going to tell you a story. There was a guy who didn't get one of the oh-so-shiny iPods for a long time, though they looked neat. His discman plays mp3 CDs, and that was good enough for him. The latest iPod, which plays video, was sufficiently cool enough for him to forget that everyone at his school has an iPod and he would be trendy just like them now.

-

Shocker ending: he is I, and I am him. Now I know why everyone has one of those shiny devices. iPods and web frameworks have little in common except that many believe both the iPod and Rails are all hype and flash. I've realized that something creating this kind of buzz may actually just be a good product. I feel that this is the only other thing the iPod and Rails have in common: they are both damn good. Enough about the iPod, everyone hates hearing about it. My goal is to write about the other thing everyone is tired of hearing about.

-

Why is Rails special?

-

Rails is not magic. There are no exclusive JavaScript libraries or HTML tags. We all have to produce pages that render in the same web browsers. My dad was correct, there is nothing special about my website either. It's more or less a stock Typo website.

-

So what makes developing with Rails different? For me there are four big things that set Rails apart from the alternatives:

-
  1. Separating data, function, and design
  2. Readability (which is underrated)
    3. @@ -70,148 +53,120 @@ Styles: typocode.css
  3. Testing is so easy it hurts
-

MVC 101 (or, Separating data, function, and design)

-

Now I'm sure you've heard about separating content from design. Rails takes that one step further from just using CSS to style your website. It uses what's known as the MVC paradigm: Model-View-Controller. This is a tried and tested development method. I'd used MVC before in Cocoa programming on Mac OS X, so I was already sold on this point.

-
  • The model deals with your data. If you're creating an online store you have a product model, a shopping cart model, a customer model, etc. The model takes care of storing this data in the database (persistence), and presenting it to you as an object you can manipulate at runtime.
-
  • The view deals only with presentation. That's it, honestly. An interface to your app.
-
  • The controller binds the model to the view, so that when the user clicks on the Add to cart link the controller is wired to call the add_product method of the cart model and tell it which product to add. Then the controller takes the appropriate action such as redirecting the user to the shopping cart view.
-

Of course this is not exclusive to Rails, but it's an integral part of it's design.

-

Readability

-

Rails, and Ruby, both read amazingly like spoken English. This code is more or less straight out of Typo. You define relationships between objects like this:

- -
class Article < Content
-  has_many :comments, :dependent => true, :order => "created_at ASC"
-  has_many :trackbacks, :dependent => true, :order => "created_at ASC"
-  has_and_belongs_to_many :categories, :foreign_key => 'article_id'
-  has_and_belongs_to_many :tags, :foreign_key => 'article_id'
-  belongs_to :user
-  ...
+```ruby +class Article < Content + has_many :comments, :dependent => true, :order => "created_at ASC" + has_many :trackbacks, :dependent => true, :order => "created_at ASC" + has_and_belongs_to_many :categories, :foreign_key => 'article_id' + has_and_belongs_to_many :tags, :foreign_key => 'article_id' + belongs_to :user + ... +```

dependent => true means if an article is deleted, it's comments go with it. Don't worry if you don't understand it all, this is just for you to see some actual Rails code.

-

In the Comment model you have:

+```ruby +class Comment < Content + belongs_to :article + belongs_to :user -
class Comment < Content
-  belongs_to :article
-  belongs_to :user
-
-  validates_presence_of :author, :body
-  validates_against_spamdb :body, :url, :ip
-  validates_age_of :article_id
-  ...
+ validates_presence_of :author, :body + validates_against_spamdb :body, :url, :ip + validates_age_of :article_id + ... +```

(I snuck in some validations as well)

-

But look how it reads! Read it out loud. I'd bet that my mom would more or less follow this, and she's anything but a programmer. That's not to say programming should be easy for grandma, but code should be easily understood by humans. Let the computer understand things that are natural for me to type, since we're making it understand a common language anyways.

-

Ruby and Ruby on Rails allow and encourage you to write beautiful code. That is so much more important than you may realize, because it leads to many other virtues. Readability is obvious, and hence maintainability. You must read code to understand and modify it. Oh, and happy programmers will be more productive than frustrated programmers.

-

Database Migrations

-

Here's one more life-saver: migrations. Migrations are a way to version your database schema from within Rails. So you have a table, call it albums, and you want to add the date the album was released. You could modify the database directly, but that's not fun. Even if you only have one server, all your configuration will be in one central place, the app. And Rails doesn't care if you have PostgreSQL, MySQL, or SQLite behind it. You can develop and test on SQLite and deploy on MySQL and the migrations will just work in both environments.

+```ruby +class AddDateReleased < ActiveRecord::Migration + def self.up + add_column "albums", "date_released", :datetime + Albums.update_all "date_released = now()" + end -
class AddDateReleased < ActiveRecord::Migration
-  def self.up
-    add_column "albums", "date_released", :datetime
-    Albums.update_all "date_released = now()"
-  end
-
-  def self.down
-    remove_column "albums", "date_released"
-  end
-end
+ def self.down + remove_column "albums", "date_released" + end +end +```

Then you run the migration (rake migrate does that) and boom, your up to date. If you're wondering, the self.down method indeed implies that you can take this the other direction as well. Think rake migrate VERSION=X.

-

Along with the other screencasts is one on migrations featuring none other than David Hansson. You should take a look, it's the third video.

-

Testing so easy it hurts

-

To start a rails project you type rails project_name and it creates a directory structure with a fresh project in it. This includes a directory appropriately called test which houses unit tests for the project. When you generate models and controllers it creates test stubs for you in that directory. Basically, it makes it so easy to test that you're a fool not to do it. As someone wrote on their site: It means never having to say "I introduced a new bug while fixing another."

-

Rails builds on the unit testing that comes with Ruby. On a larger scale, that means that Rails is unlikely to flop on you because it is regularly tested using the same method. Ruby is unlikely to flop for the same reason. That makes me look good as a programmer. If you code for a living then it's of even more value to you.

-

I don't know why it hurts. Maybe it hurts developers working with other frameworks or languages to see us have it so nice and easy.

-

Wrapping up

-

Rails means I have fun doing web development instead of being frustrated (CSS hacks aside). David Hansson may be right when he said you have to have been soured by Java or PHP to fully appreciate Rails, but that doesn't mean you won't enjoy it if you do like Java or PHP.

-

Justin Gehtland rewrote a Java app using Rails and the number of lines of code of the Rails version was very close to that of the XML configuration for the Java version. Java has strengths, libraries available now seems to be a big one, but it's too big for my needs. If you're like me then maybe you'll enjoy Rails as much as I do.

-

You're not done, you lied to me!

-

Sort of... there are a few things that it seems standard to include when someone writes about how Rails saved their life and gave them hope again. For completeness sake, I feel compelled to mention some principles common amongst those who develop Rails, and those who develop on Rails. It's entirely likely that there's nothing new for you here unless you're new to Rails or to programming, in which case I encourage you to read on.

-

DRY

-

Rails follows the DRY principle religiously. That is, Don't Repeat Yourself. Like MVC, I was already sold on this. I had previously encountered it in The Pragmatic Programmer. Apart from telling some_model it belongs_to :other_model and other_model that it has_many :some_models nothing has jumped out at me which violates this principle. However, I feel that reading a model's code and seeing it's relationships to other models right there is a Good Thingâ„¢.

-

Convention over configuration (or, Perceived intelligence)

-

Rails' developers also have the mantra "convention over configuration", which you can see from the video there. (you did watch it, didn't you? ;) Basically that just means Rails has sane defaults, but is still flexible if you don't like the defaults. You don't have to write even one line of SQL with Rails, but if you need greater control then you can write your own SQL. A standard cliché: it makes the simple things easy and the hard possible.

-

Rails seems to have a level of intelligence which contributes to the wow-factor. After these relationships are defined I can now filter certain negative comments like so:

- -
article = Article.find :first
-for comment in article.comments do
-  print comment unless comment.downcase == 'you suck!'
-end
+```ruby +article = Article.find :first +for comment in article.comments do + print comment unless comment.downcase == 'you suck!' +end +```

Rails knows to look for the field article_id in the comments table of the database. This is just a convention. You can call it something else but then you have to tell Rails what you like to call it.

-

Rails understands pluralization, which is a detail but it makes everything feel more natural. If you have a Person model then it will know to look for the table named people.

-

Code as you learn

-

I love how I've only been coding in Rails for a week or two and I can do so much already. It's natural, concise and takes care of the inane details. I love how I know that I don't even have to explain that migration example. It's plainly clear what it does to the database. It doesn't take long to get the basics down and once you do it goes fast.

- diff --git a/posts/2006/02/sjs-rails-bundle-0_2-for-textmate.md b/posts/2006/02/sjs-rails-bundle-0_2-for-textmate.md index 63d8695..8c6dc43 100644 --- a/posts/2006/02/sjs-rails-bundle-0_2-for-textmate.md +++ b/posts/2006/02/sjs-rails-bundle-0_2-for-textmate.md @@ -1,10 +1,9 @@ --- -Title: SJ's Rails Bundle 0.2 for TextMate +Title: "SJ's Rails Bundle 0.2 for TextMate" Author: Sami Samhuri -Date: 23rd February, 2006 +Date: "23rd February, 2006" Timestamp: 2006-02-23T17:18:00-08:00 Tags: textmate, rails, coding, bundle, macros, rails, snippets, textmate -Styles: typocode.css --- Everything that you've seen posted on my blog is now available in one bundle. Snippets for Rails database migrations and assertions are all included in this bundle. @@ -13,15 +12,17 @@ There are 2 macros for class-end and def-end blocks, bound to ⌃C
method(arg1, arg2_)
+```ruby +method(arg1, arg2_) +``` Typing ⌃D at this point results in this code: - -
def method(arg1, arg2)
-  _
-end
+```ruby +def method(arg1, arg2) + _ +end +``` There is a list of the snippets in Features.rtf, which is included in the disk image. Of course you can also browse them in the Snippets Editor built into TextMate. diff --git a/posts/2006/02/some-textmate-snippets-for-rails-migrations.md b/posts/2006/02/some-textmate-snippets-for-rails-migrations.md index 22055e7..0aeebb0 100644 --- a/posts/2006/02/some-textmate-snippets-for-rails-migrations.md +++ b/posts/2006/02/some-textmate-snippets-for-rails-migrations.md @@ -1,7 +1,7 @@ --- -Title: Some TextMate snippets for Rails Migrations +Title: "Some TextMate snippets for Rails Migrations" Author: Sami Samhuri -Date: 18th February, 2006 +Date: "18th February, 2006" Timestamp: 2006-02-18T22:48:00-08:00 Tags: textmate, rails, hacking, rails, snippets, textmate --- @@ -16,39 +16,53 @@ Scope should be *source.ruby.rails* and the triggers I use are above the snippet mcdt: **M**igration **C**reate and **D**rop **T**able - create_table "${1:table}" do |t| - $0 - end - ${2:drop_table "$1"} +```ruby +create_table "${1:table}" do |t| + $0 +end +${2:drop_table "$1"} +``` mcc: **M**igration **C**reate **C**olumn - t.column "${1:title}", :${2:string} +```ruby +t.column "${1:title}", :${2:string} +``` marc: **M**igration **A**dd and **R**emove **C**olumn - add_column "${1:table}", "${2:column}", :${3:string} - ${4:remove_column "$1", "$2"} +```ruby +add_column "${1:table}", "${2:column}", :${3:string} +${4:remove_column "$1", "$2"} +``` I realize this might not be for everyone, so here are my original 4 snippets that do the work of *marc* and *mcdt*. mct: **M**igration **C**reate **T**able - create_table "${1:table}" do |t| - $0 - end +```ruby +create_table "${1:table}" do |t| + $0 +end +``` mdt: **M**igration **D**rop **T**able - drop_table "${1:table}" +```ruby +drop_table "${1:table}" +``` mac: **M**igration **A**dd **C**olumn - add_column "${1:table}", "${2:column}", :${3:string} +```ruby +add_column "${1:table}", "${2:column}", :${3:string} +``` mrc: **M**igration **R**remove **C**olumn - remove_column "${1:table}", "${2:column}" +```ruby +remove_column "${1:table}", "${2:column}" +``` I'll be adding more snippets and macros. There should be a central place where the rails bundle can be improved and extended. Maybe there is... @@ -91,4 +105,3 @@ I'll be adding more snippets and macros. There should be a central place where t

P.S. I tried several ways to get the combo-snippets to put the pieces inside the right functions but failed. We'll see tomorrow if Allan (creator of TextMate) has any ideas.

- diff --git a/posts/2006/02/textmate-insert-text-into-self-down.md b/posts/2006/02/textmate-insert-text-into-self-down.md index df9b935..34fb1b6 100644 --- a/posts/2006/02/textmate-insert-text-into-self-down.md +++ b/posts/2006/02/textmate-insert-text-into-self-down.md @@ -1,46 +1,44 @@ --- -Title: TextMate: Insert text into self.down +Title: "TextMate: Insert text into self.down" Author: Sami Samhuri -Date: 21st February, 2006 +Date: "21st February, 2006" Timestamp: 2006-02-21T14:55:00-08:00 Tags: textmate, rails, hacking, commands, macro, rails, snippets, textmate -Styles: typocode.css ---

UPDATE: I got everything working and it's all packaged up here. There's an installation script this time as well.

Thanks to a helpful thread on the TextMate mailing list I have the beginning of a solution to insert text at 2 (or more) locations in a file.

-

I implemented this for a new snippet I was working on for migrations, rename_column. Since the command is the same in self.up and self.down simply doing a reverse search for rename_column in my hackish macro didn't return the cursor the desired location.

That's enough introduction, here's the program to do the insertion:

+```ruby +#!/usr/bin/env ruby +def indent(s) + s =~ /^(\s*)/ + ' ' * $1.length +end -
#!/usr/bin/env ruby
-def indent(s)
-  s =~ /^(\s*)/
-  ' ' * $1.length
-end
+up_line = 'rename_column "${1:table}", "${2:column}", "${3:new_name}"$0'
+down_line = "rename_column \"$$1\", \"$$3\", \"$$2\"\n"
 
-up_line = 'rename_column "${1:table}", "${2:column}", "${3:new_name}"$0'
-down_line = "rename_column \"$$1\", \"$$3\", \"$$2\"\n"
+# find the end of self.down and insert 2nd line
+lines = STDIN.read.to_a.reverse
+ends_seen = 0
+lines.each_with_index do |line, i|
+  ends_seen += 1    if line =~ /^\s*end\b/
+  if ends_seen == 2
+    lines[i..i] = [lines[i], indent(lines[i]) * 2 + down_line]
+    break
+  end
+end
 
-# find the end of self.down and insert 2nd line
-lines = STDIN.read.to_a.reverse
-ends_seen = 0
-lines.each_with_index do |line, i|
-  ends_seen += 1    if line =~ /^\s*end\b/
-  if ends_seen == 2
-    lines[i..i] = [lines[i], indent(lines[i]) * 2 + down_line]
-    break
-  end
-end
-
-# return the new text, escaping special chars
-print up_line + lines.reverse.to_s.gsub('[$`\\]', '\\\\\1').gsub('\\$\\$', '$')
+# return the new text, escaping special chars +print up_line + lines.reverse.to_s.gsub(/([$`\\])/, '\\\\\1').gsub(/\$\$/, '$') +```

Save this as a command in your Rails, or syncPeople on Rails, bundle. The command options should be as follows:

-
  • Save: Nothing
  • Input: Selected Text or Nothing
    • @@ -49,10 +47,8 @@ Styles: typocode.css
  • Scope Selector: source.ruby.rails
-

The first modification it needs is to get the lines to insert as command line arguments so we can use it for other snippets. Secondly, regardless of the Re-indent pasted text setting the text returned is indented incorrectly.

- The macro I'm thinking of to invoke this is tab-triggered and will simply:
  • Select word (⌃W)
    • @@ -60,5 +56,3 @@ The macro I'm thinking of to invoke this is tab-triggered and will simply:
  • Select to end of file (⇧⌘↓)
  • Run command "Put in self.down"
- - diff --git a/posts/2006/02/textmate-move-selection-to-self-down.md b/posts/2006/02/textmate-move-selection-to-self-down.md index f277402..7df3ab2 100644 --- a/posts/2006/02/textmate-move-selection-to-self-down.md +++ b/posts/2006/02/textmate-move-selection-to-self-down.md @@ -1,32 +1,29 @@ --- -Title: TextMate: Move selection to self.down +Title: "TextMate: Move selection to self.down" Author: Sami Samhuri -Date: 21st February, 2006 +Date: "21st February, 2006" Timestamp: 2006-02-21T00:26:00-08:00 Tags: textmate, rails, hacking, hack, macro, rails, textmate -Styles: typocode.css ---

UPDATE: This is obsolete, see this post for a better solution.

Duane's comment prompted me to think about how to get the drop_table and remove_column lines inserted in the right place. I don't think TextMate's snippets are built to do this sort of text manipulation. It would be nicer, but a quick hack will suffice for now.

Use MCDT to insert:

-
create_table "table" do |t|
+```ruby
+create_table "table" do |t|
 
-end
-drop_table "table"
+end +drop_table "table" +```

Then press tab once more after typing the table name to select the code drop_table "table". I created a macro that cuts the selected text, finds def self.down and pastes the line there. Then it searches for the previous occurence of create_table and moves the cursor to the next line, ready for you to add some columns.

-

I have this bound to ⌃⌥⌘M because it wasn't in use. If your Control key is to the left the A key it's quite comfortable to hit this combo. Copy the following file into ~/Library/Application Support/TextMate/Bundles/Rails.tmbundle/Macros.

-

Move selection to self.down

-

This works for the MARC snippet as well. I didn't tell you the whole truth, the macro actually finds the previous occurence of (create_table|add_column).

-

The caveat here is that if there is a create_table or add_column between self.down and the table you just added, it will jump back to the wrong spot. It's still faster than doing it all manually, but should be improved. If you use these exclusively, the order they occur in self.down will be opposite of that in self.up. That means either leaving things backwards or doing the re-ordering manually. =/

diff --git a/posts/2006/02/textmate-snippets-for-rails-assertions.md b/posts/2006/02/textmate-snippets-for-rails-assertions.md index 0e7cc1a..6255751 100644 --- a/posts/2006/02/textmate-snippets-for-rails-assertions.md +++ b/posts/2006/02/textmate-snippets-for-rails-assertions.md @@ -1,7 +1,7 @@ --- -Title: TextMate Snippets for Rails Assertions +Title: "TextMate Snippets for Rails Assertions" Author: Sami Samhuri -Date: 20th February, 2006 +Date: "20th February, 2006" Timestamp: 2006-02-20T23:52:00-08:00 Tags: textmate, rails, coding, rails, snippets, testing, textmate --- diff --git a/posts/2006/02/touch-screen-on-steroids.md b/posts/2006/02/touch-screen-on-steroids.md index 14cea60..7b7e93b 100644 --- a/posts/2006/02/touch-screen-on-steroids.md +++ b/posts/2006/02/touch-screen-on-steroids.md @@ -1,7 +1,7 @@ --- -Title: Touch Screen on Steroids +Title: "Touch Screen on Steroids" Author: Sami Samhuri -Date: 8th February, 2006 +Date: "8th February, 2006" Timestamp: 2006-02-08T06:06:00-08:00 Tags: technology, touch --- diff --git a/posts/2006/02/urban-extreme-gymnastics.md b/posts/2006/02/urban-extreme-gymnastics.md index fd09b10..a3838a6 100644 --- a/posts/2006/02/urban-extreme-gymnastics.md +++ b/posts/2006/02/urban-extreme-gymnastics.md @@ -1,7 +1,7 @@ --- -Title: Urban Extreme Gymnastics? +Title: "Urban Extreme Gymnastics?" Author: Sami Samhuri -Date: 15th February, 2006 +Date: "15th February, 2006" Timestamp: 2006-02-15T10:41:00-08:00 Tags: amusement --- diff --git a/posts/2006/03/generate-selfdown-in-your-rails-migrations.md b/posts/2006/03/generate-selfdown-in-your-rails-migrations.md index 0fd9e19..3a11eae 100644 --- a/posts/2006/03/generate-selfdown-in-your-rails-migrations.md +++ b/posts/2006/03/generate-selfdown-in-your-rails-migrations.md @@ -1,7 +1,7 @@ --- -Title: Generate self.down in your Rails migrations +Title: "Generate self.down in your Rails migrations" Author: Sami Samhuri -Date: 3rd March, 2006 +Date: "3rd March, 2006" Timestamp: 2006-03-03T21:38:00-08:00 Tags: rails, textmate, migrations, rails, textmate --- diff --git a/posts/2006/03/i-dont-mind-fairplay-either.md b/posts/2006/03/i-dont-mind-fairplay-either.md index 1493050..da1cf2b 100644 --- a/posts/2006/03/i-dont-mind-fairplay-either.md +++ b/posts/2006/03/i-dont-mind-fairplay-either.md @@ -1,7 +1,7 @@ --- -Title: I don't mind FairPlay either +Title: "I don't mind FairPlay either" Author: Sami Samhuri -Date: 3rd March, 2006 +Date: "3rd March, 2006" Timestamp: 2006-03-03T21:56:00-08:00 Tags: apple, mac os x, life, drm, fairplay, ipod, itunes --- diff --git a/posts/2006/03/spore.md b/posts/2006/03/spore.md index 770ffbc..a317e43 100644 --- a/posts/2006/03/spore.md +++ b/posts/2006/03/spore.md @@ -1,7 +1,7 @@ --- -Title: Spore +Title: "Spore" Author: Sami Samhuri -Date: 3rd March, 2006 +Date: "3rd March, 2006" Timestamp: 2006-03-03T21:43:00-08:00 Tags: amusement, technology, cool, fun, games --- diff --git a/posts/2006/04/zsh-terminal-goodness-on-os-x.md b/posts/2006/04/zsh-terminal-goodness-on-os-x.md index 93cda1d..279123e 100644 --- a/posts/2006/04/zsh-terminal-goodness-on-os-x.md +++ b/posts/2006/04/zsh-terminal-goodness-on-os-x.md @@ -1,7 +1,7 @@ --- -Title: zsh terminal goodness on OS X +Title: "zsh terminal goodness on OS X" Author: Sami Samhuri -Date: 4th April, 2006 +Date: "4th April, 2006" Timestamp: 2006-04-04T14:57:00-07:00 Tags: mac os x, apple, osx, terminal, zsh --- diff --git a/posts/2006/05/os-x-and-fitts-law.md b/posts/2006/05/os-x-and-fitts-law.md index ec1b553..48bfbfe 100644 --- a/posts/2006/05/os-x-and-fitts-law.md +++ b/posts/2006/05/os-x-and-fitts-law.md @@ -1,7 +1,7 @@ --- -Title: OS X and Fitt's law +Title: "OS X and Fitt's law" Author: Sami Samhuri -Date: 7th May, 2006 +Date: "7th May, 2006" Timestamp: 2006-05-07T20:43:00-07:00 Tags: mac os x, apple, mac, os, usability, x --- diff --git a/posts/2006/05/wikipediafs-on-linux-in-python.md b/posts/2006/05/wikipediafs-on-linux-in-python.md index 97c2ccf..6a81c63 100644 --- a/posts/2006/05/wikipediafs-on-linux-in-python.md +++ b/posts/2006/05/wikipediafs-on-linux-in-python.md @@ -1,7 +1,7 @@ --- -Title: WikipediaFS on Linux, in Python +Title: "WikipediaFS on Linux, in Python" Author: Sami Samhuri -Date: 7th May, 2006 +Date: "7th May, 2006" Timestamp: 2006-05-07T20:49:00-07:00 Tags: hacking, python, linux, fuse, linux, mediawiki, python, wikipediafs --- diff --git a/posts/2006/06/apple-pays-attention-to-detail.md b/posts/2006/06/apple-pays-attention-to-detail.md index 59aebbe..cc50544 100644 --- a/posts/2006/06/apple-pays-attention-to-detail.md +++ b/posts/2006/06/apple-pays-attention-to-detail.md @@ -1,7 +1,7 @@ --- -Title: Apple pays attention to detail +Title: "Apple pays attention to detail" Author: Sami Samhuri -Date: 11th June, 2006 +Date: "11th June, 2006" Timestamp: 2006-06-11T01:30:00-07:00 Tags: technology, mac os x, apple --- diff --git a/posts/2006/06/ich-bin-auslnder-und-spreche-nicht-gut-deutsch.md b/posts/2006/06/ich-bin-auslnder-und-spreche-nicht-gut-deutsch.md index 3736759..de8ce70 100644 --- a/posts/2006/06/ich-bin-auslnder-und-spreche-nicht-gut-deutsch.md +++ b/posts/2006/06/ich-bin-auslnder-und-spreche-nicht-gut-deutsch.md @@ -1,7 +1,7 @@ --- -Title: Ich bin Ausländer und spreche nicht gut Deutsch +Title: "Ich bin Ausländer und spreche nicht gut Deutsch" Author: Sami Samhuri -Date: 5th June, 2006 +Date: "5th June, 2006" Timestamp: 2006-06-05T10:11:00-07:00 Tags: life, munich, seekport, work --- diff --git a/posts/2006/06/never-buy-a-german-keyboard.md b/posts/2006/06/never-buy-a-german-keyboard.md index de487e8..43c012c 100644 --- a/posts/2006/06/never-buy-a-german-keyboard.md +++ b/posts/2006/06/never-buy-a-german-keyboard.md @@ -1,7 +1,7 @@ --- -Title: Never buy a German keyboard! +Title: "Never buy a German keyboard!" Author: Sami Samhuri -Date: 9th June, 2006 +Date: "9th June, 2006" Timestamp: 2006-06-09T01:17:00-07:00 Tags: apple, apple, german, keyboard --- diff --git a/posts/2006/06/theres-nothing-regular-about-regular-expressions.md b/posts/2006/06/theres-nothing-regular-about-regular-expressions.md index ca9cd48..385b9b8 100644 --- a/posts/2006/06/theres-nothing-regular-about-regular-expressions.md +++ b/posts/2006/06/theres-nothing-regular-about-regular-expressions.md @@ -1,7 +1,7 @@ --- -Title: There's nothing regular about regular expressions +Title: "There's nothing regular about regular expressions" Author: Sami Samhuri -Date: 10th June, 2006 +Date: "10th June, 2006" Timestamp: 2006-06-10T01:28:00-07:00 Tags: technology, book, regex --- @@ -16,8 +16,9 @@ It requires more thinking than the last 2 computer books I read, *Programming Ru QOTD, p. 329, about matching nested pairs of parens: - \(([^()]|\(([^()]|\(([^()]|\(([^()])*\))*\))*\))*\) - Wow, that's ugly. +```conf +\(([^()]|\(([^()]|\(([^()]|\(([^()])*\))*\))*\))*\) +Wow, that's ugly. +``` (Don't worry, there's a much better solution on the next 2 pages after that quote.) - diff --git a/posts/2006/07/class-method-instance-method-it-doesnt-matter-to-php.md b/posts/2006/07/class-method-instance-method-it-doesnt-matter-to-php.md index 3bb1516..7e3e579 100644 --- a/posts/2006/07/class-method-instance-method-it-doesnt-matter-to-php.md +++ b/posts/2006/07/class-method-instance-method-it-doesnt-matter-to-php.md @@ -1,7 +1,7 @@ --- -Title: Class method? Instance method? It doesn't matter to PHP +Title: "Class method? Instance method? It doesn't matter to PHP" Author: Sami Samhuri -Date: 21st July, 2006 +Date: "21st July, 2006" Timestamp: 2006-07-21T07:56:00-07:00 Tags: php, coding --- @@ -16,7 +16,7 @@ I would fully expect the PHP parser to give me an error like "No class method [f This code: -

+```php
 class Foo {
   public static function static_fun()
   {
@@ -29,7 +29,7 @@ class Foo {
   }
 }
 
-echo '<pre>';
+echo '
';
 echo "From Foo:\n";
 echo Foo::static_fun();
 echo Foo::not_static();
@@ -37,14 +37,14 @@ echo "\n";
 
 echo "From \$foo = new Foo():\n";
 $foo = new Foo();
-echo $foo->static_fun();
-echo $foo->not_static();
-echo '</pre>';
-

+echo $foo->static_fun();
+echo $foo->not_static();
+echo '
'; +``` Produces: -

+```php
 From Foo:
 This is a class method!
 This is an instance method!
@@ -52,7 +52,7 @@ This is an instance method!
 From $foo = new Foo():
 This is a class method!
 This is an instance method!
-
+``` What the fuck?! http://www.php.net/manual/en/language.oop5.static.php is lying to everyone. diff --git a/posts/2006/07/late-static-binding.md b/posts/2006/07/late-static-binding.md index 6d673b5..965bf34 100644 --- a/posts/2006/07/late-static-binding.md +++ b/posts/2006/07/late-static-binding.md @@ -1,7 +1,7 @@ --- -Title: Late static binding +Title: "Late static binding" Author: Sami Samhuri -Date: 19th July, 2006 +Date: "19th July, 2006" Timestamp: 2006-07-19T10:23:00-07:00 Tags: php, coding, coding, php --- @@ -10,8 +10,7 @@ Tags: php, coding, coding, php As colder on ##php (freenode) told me today, class methods in PHP don't have what they call late static binding. What's that? It means that this code: -
-
+```php
 class Foo
 {
   public static function my_method()
@@ -24,15 +23,13 @@ class Bar extends Foo
 {}
 
 Bar::my_method();
-
-
+``` outputs "I'm a Foo!", instead of "I'm a Bar!". That's not fun. Using __CLASS__ in place of get_class() makes zero difference. You end up with proxy methods in each subclass of Foo that pass in the real name of the calling class, which sucks. -
-
+```php
 class Bar extends Foo
 {
   public static function my_method()
@@ -40,8 +37,7 @@ class Bar extends Foo
     return parent::my_method( get_class() );
   }
 }
-
-
+``` I was told that they had a discussion about this on the internal PHP list, so at least they're thinking about this stuff. Too bad PHP5 doesn't have it. I guess I should just be glad I won't be maintaining this code. diff --git a/posts/2006/07/ruby-and-rails-have-spoiled-me-rotten.md b/posts/2006/07/ruby-and-rails-have-spoiled-me-rotten.md index e27f1dc..768418c 100644 --- a/posts/2006/07/ruby-and-rails-have-spoiled-me-rotten.md +++ b/posts/2006/07/ruby-and-rails-have-spoiled-me-rotten.md @@ -1,7 +1,7 @@ --- -Title: Ruby and Rails have spoiled me rotten +Title: "Ruby and Rails have spoiled me rotten" Author: Sami Samhuri -Date: 17th July, 2006 +Date: "17th July, 2006" Timestamp: 2006-07-17T05:40:00-07:00 Tags: rails, ruby, php, coding, framework, php, rails, ruby, zend --- diff --git a/posts/2006/07/ubuntu-linux-for-linux-users-please.md b/posts/2006/07/ubuntu-linux-for-linux-users-please.md index 9c100d4..4bb18ea 100644 --- a/posts/2006/07/ubuntu-linux-for-linux-users-please.md +++ b/posts/2006/07/ubuntu-linux-for-linux-users-please.md @@ -1,7 +1,7 @@ --- -Title: Ubuntu: Linux for Linux users please +Title: "Ubuntu: Linux for Linux users please" Author: Sami Samhuri -Date: 13th July, 2006 +Date: "13th July, 2006" Timestamp: 2006-07-13T08:34:00-07:00 Tags: linux, linux, ubuntu --- diff --git a/posts/2006/07/working-with-the-zend-framework.md b/posts/2006/07/working-with-the-zend-framework.md index 188ae38..e22d73b 100644 --- a/posts/2006/07/working-with-the-zend-framework.md +++ b/posts/2006/07/working-with-the-zend-framework.md @@ -1,7 +1,7 @@ --- -Title: Working with the Zend Framework +Title: "Working with the Zend Framework" Author: Sami Samhuri -Date: 6th July, 2006 +Date: "6th July, 2006" Timestamp: 2006-07-06T07:36:00-07:00 Tags: coding, technology, php, framework, php, seekport, zend --- diff --git a/posts/2006/08/where-are-my-headphones.md b/posts/2006/08/where-are-my-headphones.md index a7edd27..7895735 100644 --- a/posts/2006/08/where-are-my-headphones.md +++ b/posts/2006/08/where-are-my-headphones.md @@ -1,7 +1,7 @@ --- -Title: Where are my headphones? +Title: "Where are my headphones?" Author: Sami Samhuri -Date: 22nd August, 2006 +Date: "22nd August, 2006" Timestamp: 2006-08-22T07:31:00-07:00 Tags: life, seekport --- diff --git a/posts/2006/09/buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo.md b/posts/2006/09/buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo.md index eb178ab..0609077 100644 --- a/posts/2006/09/buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo.md +++ b/posts/2006/09/buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo-buffalo.md @@ -1,7 +1,7 @@ --- -Title: Buffalo buffalo Buffalo buffalo buffalo buffalo Buffalo buffalo +Title: "Buffalo buffalo Buffalo buffalo buffalo buffalo Buffalo buffalo" Author: Sami Samhuri -Date: 16th September, 2006 +Date: "16th September, 2006" Timestamp: 2006-09-16T22:11:00-07:00 Tags: amusement, buffalo Link: http://en.wikipedia.org/wiki/Buffalo_buffalo_buffalo_buffalo_buffalo_buffalo_buffalo_buffalo diff --git a/posts/2006/09/some-features-you-might-have-missed-in-itunes-7.md b/posts/2006/09/some-features-you-might-have-missed-in-itunes-7.md index acf1ae4..9be9bf1 100644 --- a/posts/2006/09/some-features-you-might-have-missed-in-itunes-7.md +++ b/posts/2006/09/some-features-you-might-have-missed-in-itunes-7.md @@ -1,7 +1,7 @@ --- -Title: Some features you might have missed in iTunes 7 +Title: "Some features you might have missed in iTunes 7" Author: Sami Samhuri -Date: 22nd September, 2006 +Date: "22nd September, 2006" Timestamp: 2006-09-22T16:59:00-07:00 Tags: apple, apple, itunes --- diff --git a/posts/2006/12/coping-with-windows-xp-activiation-on-a-mac.md b/posts/2006/12/coping-with-windows-xp-activiation-on-a-mac.md index 65dd185..622bb6e 100644 --- a/posts/2006/12/coping-with-windows-xp-activiation-on-a-mac.md +++ b/posts/2006/12/coping-with-windows-xp-activiation-on-a-mac.md @@ -1,7 +1,7 @@ --- -Title: Coping with Windows XP activiation on a Mac +Title: "Coping with Windows XP activiation on a Mac" Author: Sami Samhuri -Date: 17th December, 2006 +Date: "17th December, 2006" Timestamp: 2006-12-17T23:30:00-08:00 Tags: parallels, windows, apple, mac os x, bootcamp --- @@ -28,7 +28,9 @@ If anyone actually knows how to write batch files I'd like to hear any suggestio You will probably just want to test my method of testing for Parallels and Boot Camp first. The easiest way is to just open a command window and run this command: - ipconfig /all | find "Parallels" +```bat +ipconfig /all | find "Parallels" +``` If you see a line of output like **"Description . . . . : Parallels Network Adapter"** and you are in Parallels then the test works. If you see no output and you are in Boot Camp then the test works. @@ -46,8 +48,10 @@ If you're lazy then you can download backup-parallels-wpa.bat @@ -57,8 +61,10 @@ Download backup-bootcamp-wpa.bat @@ -72,19 +78,21 @@ If you have XP Pro then you can get it to run using the Group Policy editor. Sav

If you have XP Home then the best you can do is run this script from your Startup folder (Start -> All Programs -> Startup), but that is not really going to work because eventually Windows will not even let you log in until you activate it. What a P.O.S.

- @echo off +```bat +@echo off - ipconfig /all | find "Parallels" > network.tmp - for /F "tokens=14" %%x in (network.tmp) do set parallels=%x - del network.tmp +ipconfig /all | find "Parallels" > network.tmp +for /F "tokens=14" %%x in (network.tmp) do set parallels=%x +del network.tmp - if defined parallels ( - echo Parallels - copy C:\Windows\System32\Parallels\wpa.* C:\Windows\System32 - ) else ( - echo Boot Camp - copy C:\Windows\System32\BootCamp\wpa.* C:\Windows\System32 - ) +if defined parallels ( + echo Parallels + copy C:\Windows\System32\Parallels\wpa.* C:\Windows\System32 +) else ( + echo Boot Camp + copy C:\Windows\System32\BootCamp\wpa.* C:\Windows\System32 +) +``` Download activate.bat @@ -105,4 +113,3 @@ This method worked for me and hopefully it will work for you as well. I'm intere I finally bought Windows XP this week and I'm starting to regret it because of all the hoops they make you jump through to use it. I only use it to fix sites in IE because it can't render a web page properly and I didn't want to buy it just for that. I thought that it would be good to finally get a legit copy since I was using a pirated version and was sick of working around validation bullshit for updates. Now I have to work around MS's activation bullshit and it's just as bad! Screw Microsoft for putting their customers through this sort of thing. Things like this and the annoying balloons near the system tray just fuel my contempt for Windows and reinforce my love of Linux and Mac OS X. I don't make money off any of my sites, which is why I didn't want to have to buy stupid Windows. I hate MS so much for making shitty IE the standard browser. - diff --git a/posts/2007/03/digg-v4-reply-to-replies-greasemonkey-script.md b/posts/2007/03/digg-v4-reply-to-replies-greasemonkey-script.md index 283862a..d5647b6 100644 --- a/posts/2007/03/digg-v4-reply-to-replies-greasemonkey-script.md +++ b/posts/2007/03/digg-v4-reply-to-replies-greasemonkey-script.md @@ -1,7 +1,7 @@ --- -Title: Digg v4: Reply to replies (Greasemonkey script) +Title: "Digg v4: Reply to replies (Greasemonkey script)" Author: Sami Samhuri -Date: 8th March, 2007 +Date: "8th March, 2007" Timestamp: 2007-03-08T23:19:00-08:00 Tags: coding, digg, firefox, userscript --- diff --git a/posts/2007/03/diggscuss-0_9.md b/posts/2007/03/diggscuss-0_9.md index 884b769..cffabb7 100644 --- a/posts/2007/03/diggscuss-0_9.md +++ b/posts/2007/03/diggscuss-0_9.md @@ -1,7 +1,7 @@ --- -Title: Diggscuss 0.9 +Title: "Diggscuss 0.9" Author: Sami Samhuri -Date: 25th March, 2007 +Date: "25th March, 2007" Timestamp: 2007-03-25T08:03:00-07:00 Tags: coding, digg, firefox, userscript --- diff --git a/posts/2007/03/full-screen-cover-flow.md b/posts/2007/03/full-screen-cover-flow.md index 41fa62e..8c9c81d 100644 --- a/posts/2007/03/full-screen-cover-flow.md +++ b/posts/2007/03/full-screen-cover-flow.md @@ -1,7 +1,7 @@ --- -Title: Full-screen Cover Flow +Title: "Full-screen Cover Flow" Author: Sami Samhuri -Date: 6th March, 2007 +Date: "6th March, 2007" Timestamp: 2007-03-06T13:51:00-08:00 Tags: apple, coverflow, itunes --- diff --git a/posts/2007/04/a-triple-booting-schizophrenic-macbook.md b/posts/2007/04/a-triple-booting-schizophrenic-macbook.md index c07629a..bfea9c1 100644 --- a/posts/2007/04/a-triple-booting-schizophrenic-macbook.md +++ b/posts/2007/04/a-triple-booting-schizophrenic-macbook.md @@ -1,7 +1,7 @@ --- -Title: A triple-booting, schizophrenic MacBook +Title: "A triple-booting, schizophrenic MacBook" Author: Sami Samhuri -Date: 4th April, 2007 +Date: "4th April, 2007" Timestamp: 2007-04-04T23:30:00-07:00 Tags: linux, mac os x, windows --- diff --git a/posts/2007/04/activerecord-base_find_or_create-and-find_or_initialize.md b/posts/2007/04/activerecord-base_find_or_create-and-find_or_initialize.md index 17f86c2..3482add 100644 --- a/posts/2007/04/activerecord-base_find_or_create-and-find_or_initialize.md +++ b/posts/2007/04/activerecord-base_find_or_create-and-find_or_initialize.md @@ -1,7 +1,7 @@ --- -Title: ActiveRecord::Base.find_or_create and find_or_initialize +Title: "ActiveRecord::Base.find_or_create and find_or_initialize" Author: Sami Samhuri -Date: 11th April, 2007 +Date: "11th April, 2007" Timestamp: 2007-04-11T03:24:00-07:00 Tags: activerecord, coding, rails, ruby --- @@ -12,98 +12,54 @@ They work exactly as you'd expect them to work with possibly one gotcha. If you Enough chat, here's the self-explanatory code: -
1
-2
-3
-4
-
-
# extend ActiveRecord::Base with find_or_create and find_or_initialize.
-ActiveRecord::Base.class_eval do
-  include ActiveRecordExtensions
-end
+```ruby +# extend ActiveRecord::Base with find_or_create and find_or_initialize. +ActiveRecord::Base.class_eval do + include ActiveRecordExtensions +end +``` +```ruby +module ActiveRecordExtensions + def self.included(base) + base.extend(ClassMethods) + end -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-
-
module ActiveRecordExtensions
-  def self.included(base)
-    base.extend(ClassMethods)
-  end
+  module ClassMethods
+    def find_or_initialize(params)
+      find_or_do('initialize', params)
+    end
 
-  module ClassMethods
-    def find_or_initialize(params)
-      find_or_do('initialize', params)
-    end
-
-    def find_or_create(params)
-      find_or_do('create', params)
-    end
+    def find_or_create(params)
+      find_or_do('create', params)
+    end
 
     private
 
-    # Find a record that matches the attributes given in the +params+ hash, or do +action+
-    # to retrieve a new object with the given parameters and return that.
-    def find_or_do(action, params)
-      # if an id is given just find the record directly
-      self.find(params[:id])
+    # Find a record that matches the attributes given in the +params+ hash, or do +action+
+    # to retrieve a new object with the given parameters and return that.
+    def find_or_do(action, params)
+      # if an id is given just find the record directly
+      self.find(params[:id])
 
-    rescue ActiveRecord::RecordNotFound => e
-      attrs = {}     # hash of attributes passed in params
+    rescue ActiveRecord::RecordNotFound => e
+      attrs = {}     # hash of attributes passed in params
 
-      # search for valid attributes in params
-      self.column_names.map(&:to_sym).each do |attrib|
-        # skip unknown columns, and the id field
-        next if params[attrib].nil? || attrib == :id
+      # search for valid attributes in params
+      self.column_names.map(&:to_sym).each do |attrib|
+        # skip unknown columns, and the id field
+        next if params[attrib].nil? || attrib == :id
 
         attrs[attrib] = params[attrib]
-      end
+      end
 
-      # no valid params given, return nil
-      return nil if attrs.empty?
+      # no valid params given, return nil
+      return nil if attrs.empty?
 
-      # call the appropriate ActiveRecord finder method
-      self.send("find_or_#{action}_by_#{attrs.keys.join('_and_')}", *attrs.values)
-    end
-  end
-end
+ # call the appropriate ActiveRecord finder method + self.send("find_or_#{action}_by_#{attrs.keys.join('_and_')}", *attrs.values) + end + end +end +``` diff --git a/posts/2007/04/funny-how-code-can-be-beautiful.md b/posts/2007/04/funny-how-code-can-be-beautiful.md index 731846d..685aac4 100644 --- a/posts/2007/04/funny-how-code-can-be-beautiful.md +++ b/posts/2007/04/funny-how-code-can-be-beautiful.md @@ -1,14 +1,16 @@ --- -Title: Funny how code can be beautiful +Title: "Funny how code can be beautiful" Author: Sami Samhuri -Date: 30th April, 2007 +Date: "30th April, 2007" Timestamp: 2007-04-30T07:07:00-07:00 Tags: haskell --- While reading a Haskell tutorial I came across the following code for defining the Fibonacci numbers: - fib = 1 : 1 : [ a + b | (a, b) <- zip fib (tail fib) ] +```haskell +fib = 1 : 1 : [ a + b | (a, b) <- zip fib (tail fib) ] +``` After reading it a few times and understanding how it works I couldn’t help but think how beautiful it is. I don’t mean that it’s aesthetically pleasing to me; the beautiful part is the meaning and simplicity. Lazy evaluation is sweet. @@ -24,4 +26,3 @@ Going deeper down the functional rabbit-hole you’ll find things like What the hell are Monads? * Monads on WikiBooks * Monads for the Working Haskell Programmer - diff --git a/posts/2007/04/getting-to-know-vista.md b/posts/2007/04/getting-to-know-vista.md index c41f491..afbd44f 100644 --- a/posts/2007/04/getting-to-know-vista.md +++ b/posts/2007/04/getting-to-know-vista.md @@ -1,7 +1,7 @@ --- -Title: Getting to know Vista +Title: "Getting to know Vista" Author: Sami Samhuri -Date: 16th April, 2007 +Date: "16th April, 2007" Timestamp: 2007-04-16T11:09:00-07:00 Tags: windows --- diff --git a/posts/2007/04/quickly-inserting-millions-of-rows-with-mysql-innodb.md b/posts/2007/04/quickly-inserting-millions-of-rows-with-mysql-innodb.md index 2c0f4fe..69eccb1 100644 --- a/posts/2007/04/quickly-inserting-millions-of-rows-with-mysql-innodb.md +++ b/posts/2007/04/quickly-inserting-millions-of-rows-with-mysql-innodb.md @@ -1,7 +1,7 @@ --- -Title: Quickly inserting millions of rows with MySQL/InnoDB +Title: "Quickly inserting millions of rows with MySQL/InnoDB" Author: Sami Samhuri -Date: 26th April, 2007 +Date: "26th April, 2007" Timestamp: 2007-04-26T07:06:00-07:00 Tags: linux, mysql --- diff --git a/posts/2007/05/a-new-way-to-look-at-networking.md b/posts/2007/05/a-new-way-to-look-at-networking.md index a927692..7d1bc32 100644 --- a/posts/2007/05/a-new-way-to-look-at-networking.md +++ b/posts/2007/05/a-new-way-to-look-at-networking.md @@ -1,7 +1,7 @@ --- -Title: A New Way to Look at Networking +Title: "A New Way to Look at Networking" Author: Sami Samhuri -Date: 5th May, 2007 +Date: "5th May, 2007" Timestamp: 2007-05-05T16:10:00-07:00 Tags: technology, networking --- diff --git a/posts/2007/05/a-scheme-parser-in-haskell-part-1.md b/posts/2007/05/a-scheme-parser-in-haskell-part-1.md index 576eebe..896b2ff 100644 --- a/posts/2007/05/a-scheme-parser-in-haskell-part-1.md +++ b/posts/2007/05/a-scheme-parser-in-haskell-part-1.md @@ -1,7 +1,7 @@ --- -Title: A Scheme parser in Haskell: Part 1 +Title: "A Scheme parser in Haskell: Part 1" Author: Sami Samhuri -Date: 3rd May, 2007 +Date: "3rd May, 2007" Timestamp: 2007-05-03T00:47:50-07:00 Tags: coding, haskell --- @@ -18,9 +18,10 @@ I'm going to explain one of the exercises because converting between the various Last night I rewrote parseNumber using do and >>= (bind) notations (ex. 3.3.1). Here's parseNumber using the liftM method given in the tutorial: -
parseNumber :: Parser LispVal
+```haskell
+parseNumber :: Parser LispVal
 parseNumber :: liftM (Number . read) $ many1 digit
-
+``` Okay that's pretty simple right? Let's break it down, first looking at the right-hand side of the $ operator, then the left. * many1 digit reads as many decimal digits as it can. @@ -41,24 +42,25 @@ The $ acts similar to a pipe in $FAVOURITE_SHELL, and So how does a Haskell newbie go about re-writing that using other notations which haven't even been explained in the tutorial? Clearly one must search the web and read as much as they can until they understand enough to figure it out (which is one thing I like about the tutorial). If you're lazy like me, here are 3 equivalent pieces of code for you to chew on. parseNumber's type is Parser LispVal (Parser is a monad). - Familiar liftM method: -
parseNumber -> liftM (Number . read) $ many1 digit
-
+```haskell +parseNumber -> liftM (Number . read) $ many1 digit +``` Using do notation: -
parseNumber -> do digits <- many1 digit
+```haskell
+parseNumber -> do digits <- many1 digit
                   return $ (Number . read) digits
-
+``` If you're thinking "Hey a return, I know that one!" then the devious masterminds behind Haskell are certainly laughing evilly right now. return simply wraps up it's argument in a monad of some sort. In this case it's the Parser monad. The return part may seem strange at first. Since many1 digit yields a monad why do we need to wrap anything? The answer is that using <- causes digits to contain a String, stripped out of the monad which resulted from many1 digit. Hence we no longer use liftM to make (Number . read) monads, and instead need to use return to properly wrap it back up in a monad. In other words liftM eliminates the need to explicitly re-monadize the contents as is necessary using do. - Finally, using >>= (bind) notation: -
parseNumber -> many1 digit >>= \digits ->
+```haskell
+parseNumber -> many1 digit >>= \digits ->
                return $ (Number . read) digits
-
+``` At this point I don't think this warrants much of an explanation. The syntactic sugar provided by do should be pretty obvious. Just in case it's not, >>= passes the contents of its left argument (a monad) to the function on its right. Once again return is needed to wrap up the result and send it on its way. When I first read about Haskell I was overwhelmed by not knowing anything, and not being able to apply my previous knowledge of programming to anything in Haskell. One piece of syntax at a time I am slowly able to understand more of the Haskell found in the wild. diff --git a/posts/2007/05/cheating-at-life-in-general.md b/posts/2007/05/cheating-at-life-in-general.md index 28a3a9e..7eecd58 100644 --- a/posts/2007/05/cheating-at-life-in-general.md +++ b/posts/2007/05/cheating-at-life-in-general.md @@ -1,7 +1,7 @@ --- -Title: Cheating at Life in General +Title: "Cheating at Life in General" Author: Sami Samhuri -Date: 16th May, 2007 +Date: "16th May, 2007" Timestamp: 2007-05-16T02:46:00-07:00 Tags: cheat, vim, emacs, textmate --- diff --git a/posts/2007/05/dtrace-ruby-goodness-for-sun.md b/posts/2007/05/dtrace-ruby-goodness-for-sun.md index b6c4204..4c94b61 100644 --- a/posts/2007/05/dtrace-ruby-goodness-for-sun.md +++ b/posts/2007/05/dtrace-ruby-goodness-for-sun.md @@ -1,7 +1,7 @@ --- -Title: dtrace + Ruby = Goodness for Sun +Title: "dtrace + Ruby = Goodness for Sun" Author: Sami Samhuri -Date: 9th May, 2007 +Date: "9th May, 2007" Timestamp: 2007-05-09T08:45:00-07:00 Tags: ruby, dtrace, sun --- diff --git a/posts/2007/05/dumping-objects-to-the-browser-in-rails.md b/posts/2007/05/dumping-objects-to-the-browser-in-rails.md index 13f7b4f..09f6fb0 100644 --- a/posts/2007/05/dumping-objects-to-the-browser-in-rails.md +++ b/posts/2007/05/dumping-objects-to-the-browser-in-rails.md @@ -1,35 +1,38 @@ --- -Title: Dumping Objects to the Browser in Rails +Title: "Dumping Objects to the Browser in Rails" Author: Sami Samhuri -Date: 15th May, 2007 +Date: "15th May, 2007" Timestamp: 2007-05-15T13:38:00-07:00 Tags: rails -Styles: typocode.css --- Here's an easy way to solve a problem that may have nagged you as it did me. Simply using foo.inspect to dump out some object to the browser dumps one long string which is barely useful except for short strings and the like. The ideal output is already available using the PrettyPrint module so we just need to use it. - -Unfortunately typing 
<%= PP.pp(@something, '') %>
 to quickly debug some possibly large object (or collection) can get old fast so we need a shortcut. - +Unfortunately typing <pre><%= PP.pp(@something, '') %></pre> to quickly debug some possibly large object (or collection) can get old fast so we need a shortcut. Taking the definition of Object#pp_s from the extensions project it's trivial to create a helper method to just dump out an object in a reasonable manner. +**/app/helpers/application_helper.rb** -
/app/helpers/application_helper.rb
def dump(thing)
-  s = StringIO.new
-  PP.pp(thing, s)
-  s.string
-end
+```ruby +def dump(thing) + s = StringIO.new + PP.pp(thing, s) + s.string +end +``` Alternatively you could do as the extensions folks do and actually define Object#pp_s so you can use it in your logs or anywhere else you may want to inspect an object. If you do this you probably want to change the dump helper method accordingly in case you decide to change pp_s in the future. +**lib/local_support/core_ext/object.rb** -
lib/local_support/core_ext/object.rb
class Object
-  def pp_s
-    pps = StringIO.new
-    PP.pp(self, pps)
-    pps.string
-  end
-end
+```ruby +class Object + def pp_s + pps = StringIO.new + PP.pp(self, pps) + pps.string + end +end +``` diff --git a/posts/2007/05/enumerable-pluck-and-string-to_proc-for-ruby.md b/posts/2007/05/enumerable-pluck-and-string-to_proc-for-ruby.md index 37598bc..f159456 100644 --- a/posts/2007/05/enumerable-pluck-and-string-to_proc-for-ruby.md +++ b/posts/2007/05/enumerable-pluck-and-string-to_proc-for-ruby.md @@ -1,10 +1,9 @@ --- -Title: Enumurable#pluck and String#to_proc for Ruby +Title: "Enumurable#pluck and String#to_proc for Ruby" Author: Sami Samhuri -Date: 10th May, 2007 +Date: "10th May, 2007" Timestamp: 2007-05-10T16:14:00-07:00 Tags: ruby, extensions -Styles: typocode.css --- I wanted a method analogous to Prototype's pluck and invoke in Rails for building lists for options_for_select. Yes, I know about options_from_collection_for_select. @@ -13,114 +12,130 @@ I wanted something more general that I can use anywhere - not just in Rails - so First you need Symbol#to_proc, which shouldn't need an introduction. If you're using Rails you have this already. -
Symbol#to_proc
class Symbol
-  # Turns a symbol into a proc.
-  #
-  # Example:
-  #   # The same as people.map { |p| p.birthdate }
-  #   people.map(&:birthdate)
-  #
-  def to_proc
-    Proc.new {|thing, *args| thing.send(self, *args)}
-  end
-end
-
+**Symbol#to_proc** + +```ruby +class Symbol + # Turns a symbol into a proc. + # + # Example: + # # The same as people.map { |p| p.birthdate } + # people.map(&:birthdate) + # + def to_proc + Proc.new {|thing, *args| thing.send(self, *args)} + end +end +``` Next we define String#to_proc, which is nearly identical to the Array#to_proc method I previously wrote about. -
String#to_proc
class String
-  # Turns a string into a proc.
-  #
-  # Example:
-  #   # The same as people.map { |p| p.birthdate.year }
-  #   people.map(&'birthdate.year')
-  #
-  def to_proc
-    Proc.new do |*args|
-      split('.').inject(args.shift) do |thing, msg|
-        thing = thing.send(msg.to_sym, *args)
-      end
-    end
-  end
-end
-
+**String#to_proc** + +```ruby +class String + # Turns a string into a proc. + # + # Example: + # # The same as people.map { |p| p.birthdate.year } + # people.map(&'birthdate.year') + # + def to_proc + Proc.new do |*args| + split('.').inject(args.shift) do |thing, msg| + thing = thing.send(msg.to_sym, *args) + end + end + end +end +``` Finally there's Enumerable#to_proc which returns a proc that passes its parameter through each of its members and collects their results. It's easier to explain by example. -
Enumerable#to_proc
module Enumerable
-  # Effectively treats itself as a list of transformations, and returns a proc
-  # which maps values to a list of the results of applying each transformation
-  # in that list to the value.
-  #
-  # Example:
-  #   # The same as people.map { |p| [p.birthdate, p.email] }
-  #   people.map(&[:birthdate, :email])
-  #
-  def to_proc
-    @procs ||= map(&:to_proc)
-    Proc.new do |thing, *args|
-      @procs.map do |proc|
-        proc.call(thing, *args)
-      end
-    end
-  end
-end
+**Enumerable#to_proc** + +```ruby +module Enumerable + # Effectively treats itself as a list of transformations, and returns a proc + # which maps values to a list of the results of applying each transformation + # in that list to the value. + # + # Example: + # # The same as people.map { |p| [p.birthdate, p.email] } + # people.map(&[:birthdate, :email]) + # + def to_proc + @procs ||= map(&:to_proc) + Proc.new do |thing, *args| + @procs.map do |proc| + proc.call(thing, *args) + end + end + end +end +``` Here's the cool part, Enumerable#pluck for Ruby in all its glory. -
Enumerable#pluck
module Enumerable
-  # Use this to pluck values from objects, especially useful for ActiveRecord models.
-  # This is analogous to Prototype's Enumerable.pluck method but more powerful.
-  #
-  # You can pluck values simply, like so:
-  #   >> people.pluck(:last_name)  #=> ['Samhuri', 'Jones', ...]
-  #
-  # But with Symbol#to_proc defined this is effectively the same as:
-  #   >> people.map(&:last_name)   #=> ['Samhuri', 'Jones', ...]
-  #
-  # Where pluck's power becomes evident is when you want to do something like:
-  #   >> people.pluck(:name, :address, :phone)
-  #        #=> [['Johnny Canuck', '123 Maple Lane', '416-555-124'], ...]
-  #
-  # Instead of:
-  #   >> people.map { |p| [p.name, p.address, p.phone] }
-  #
-  #   # map each person to: [person.country.code, person.id]
-  #   >> people.pluck('country.code', :id)
-  #        #=> [['US', 1], ['CA', 2], ...]
-  #
-  def pluck(*args)
-    # Thanks to Symbol#to_proc, Enumerable#to_proc and String#to_proc this Just Works(tm)
-    map(&args)
-  end
-end
+**Enumerable#pluck** + +```ruby +module Enumerable + # Use this to pluck values from objects, especially useful for ActiveRecord models. + # This is analogous to Prototype's Enumerable.pluck method but more powerful. + # + # You can pluck values simply, like so: + # >> people.pluck(:last_name) #=> ['Samhuri', 'Jones', ...] + # + # But with Symbol#to_proc defined this is effectively the same as: + # >> people.map(&:last_name) #=> ['Samhuri', 'Jones', ...] + # + # Where pluck's power becomes evident is when you want to do something like: + # >> people.pluck(:name, :address, :phone) + # #=> [['Johnny Canuck', '123 Maple Lane', '416-555-124'], ...] + # + # Instead of: + # >> people.map { |p| [p.name, p.address, p.phone] } + # + # # map each person to: [person.country.code, person.id] + # >> people.pluck('country.code', :id) + # #=> [['US', 1], ['CA', 2], ...] + # + def pluck(*args) + # Thanks to Symbol#to_proc, Enumerable#to_proc and String#to_proc this Just Works(tm) + map(&args) + end +end +``` I wrote another version without using the various #to_proc methods so as to work with a standard Ruby while only patching 1 module. -
module Enumerable
-  # A version of pluck which doesn't require any to_proc methods.
-  def pluck(*args)
-    procs = args.map do |msgs|
-      # always operate on lists of messages
-      if String === msgs
-        msgs = msgs.split('.').map {|a| a.to_sym} # allow 'country.code'
-      elsif !(Enumerable === msgs)
-        msgs = [msgs]
-      end
-      Proc.new do |orig|
-        msgs.inject(orig) { |thing, msg| thing = thing.send(msg) }
-      end
-    end
+```ruby
+module Enumerable
+  # A version of pluck which doesn't require any to_proc methods.
+  def pluck(*args)
+    procs = args.map do |msgs|
+      # always operate on lists of messages
+      if String === msgs
+        msgs = msgs.split('.').map {|a| a.to_sym} # allow 'country.code'
+      elsif !(Enumerable === msgs)
+        msgs = [msgs]
+      end
+      Proc.new do |orig|
+        msgs.inject(orig) { |thing, msg| thing = thing.send(msg) }
+      end
+    end
 
-    if procs.size == 1
-      map(&procs.first)
-    else
-      map do |thing|
-        procs.map { |proc| proc.call(thing) }
-      end
-    end
-  end
-end
+ if procs.size == 1 + map(&procs.first) + else + map do |thing| + procs.map { |proc| proc.call(thing) } + end + end + end +end +``` It's just icing on the cake considering Ruby's convenient block syntax, but there it is. Do with it what you will. You can change or extend any of these to support drilling down into hashes quite easily too. diff --git a/posts/2007/05/finnish-court-rules-css-ineffective-at-protecting-dvds.md b/posts/2007/05/finnish-court-rules-css-ineffective-at-protecting-dvds.md index 4147df7..a6e6268 100644 --- a/posts/2007/05/finnish-court-rules-css-ineffective-at-protecting-dvds.md +++ b/posts/2007/05/finnish-court-rules-css-ineffective-at-protecting-dvds.md @@ -1,7 +1,7 @@ --- -Title: Finnish court rules CSS ineffective at protecting DVDs +Title: "Finnish court rules CSS ineffective at protecting DVDs" Author: Sami Samhuri -Date: 26th May, 2007 +Date: "26th May, 2007" Timestamp: 2007-05-26T03:24:00-07:00 Tags: drm --- diff --git a/posts/2007/05/gotta-love-the-ferry-ride.md b/posts/2007/05/gotta-love-the-ferry-ride.md index a934ddd..f6ceba7 100644 --- a/posts/2007/05/gotta-love-the-ferry-ride.md +++ b/posts/2007/05/gotta-love-the-ferry-ride.md @@ -1,7 +1,7 @@ --- -Title: Gotta Love the Ferry Ride +Title: "Gotta Love the Ferry Ride" Author: Sami Samhuri -Date: 5th May, 2007 +Date: "5th May, 2007" Timestamp: 2007-05-05T04:25:00-07:00 Tags: life, photo, bc, victoria --- diff --git a/posts/2007/05/i-cant-wait-to-see-what-matt-stone-trey-parker-do-with-this.md b/posts/2007/05/i-cant-wait-to-see-what-matt-stone-trey-parker-do-with-this.md index beea637..67335ca 100644 --- a/posts/2007/05/i-cant-wait-to-see-what-matt-stone-trey-parker-do-with-this.md +++ b/posts/2007/05/i-cant-wait-to-see-what-matt-stone-trey-parker-do-with-this.md @@ -1,7 +1,7 @@ --- -Title: I Can't Wait to See What Trey Parker & Matt Stone Do With This +Title: "I Can't Wait to See What Trey Parker & Matt Stone Do With This" Author: Sami Samhuri -Date: 9th May, 2007 +Date: "9th May, 2007" Timestamp: 2007-05-09T14:34:00-07:00 Tags: crazy --- diff --git a/posts/2007/05/inspirado.md b/posts/2007/05/inspirado.md index dc78cde..ce6095d 100644 --- a/posts/2007/05/inspirado.md +++ b/posts/2007/05/inspirado.md @@ -1,7 +1,7 @@ --- -Title: Inspirado +Title: "Inspirado" Author: Sami Samhuri -Date: 22nd May, 2007 +Date: "22nd May, 2007" Timestamp: 2007-05-22T13:23:00-07:00 Tags: rails, inspirado --- diff --git a/posts/2007/05/iphone-humour.md b/posts/2007/05/iphone-humour.md index 3aa8c4c..831ceed 100644 --- a/posts/2007/05/iphone-humour.md +++ b/posts/2007/05/iphone-humour.md @@ -1,7 +1,7 @@ --- -Title: iPhone Humour +Title: "iPhone Humour" Author: Sami Samhuri -Date: 18th May, 2007 +Date: "18th May, 2007" Timestamp: 2007-05-18T11:34:00-07:00 Tags: apple, funny, iphone --- diff --git a/posts/2007/05/rails-plugins-link-dump.md b/posts/2007/05/rails-plugins-link-dump.md index 93d249d..b235b96 100644 --- a/posts/2007/05/rails-plugins-link-dump.md +++ b/posts/2007/05/rails-plugins-link-dump.md @@ -1,7 +1,7 @@ --- -Title: Rails Plugins (link dump) +Title: "Rails Plugins (link dump)" Author: Sami Samhuri -Date: 10th May, 2007 +Date: "10th May, 2007" Timestamp: 2007-05-09T17:22:00-07:00 Tags: rails --- diff --git a/posts/2007/05/typo-and-i-are-friends-again.md b/posts/2007/05/typo-and-i-are-friends-again.md index aa18b76..e62c654 100644 --- a/posts/2007/05/typo-and-i-are-friends-again.md +++ b/posts/2007/05/typo-and-i-are-friends-again.md @@ -1,7 +1,7 @@ --- -Title: Typo and I are friends again +Title: "Typo and I are friends again" Author: Sami Samhuri -Date: 1st May, 2007 +Date: "1st May, 2007" Timestamp: 2007-05-01T21:51:37-07:00 Tags: typo --- diff --git a/posts/2007/06/301-moved-permanently.md b/posts/2007/06/301-moved-permanently.md index 25516da..e2174a6 100644 --- a/posts/2007/06/301-moved-permanently.md +++ b/posts/2007/06/301-moved-permanently.md @@ -1,7 +1,7 @@ --- -Title: 301 moved permanently +Title: "301 moved permanently" Author: Sami Samhuri -Date: 8th June, 2007 +Date: "8th June, 2007" Timestamp: 2007-06-08T18:00:00-07:00 Tags: life --- diff --git a/posts/2007/06/back-on-gentoo-trying-new-things.md b/posts/2007/06/back-on-gentoo-trying-new-things.md index 150e076..632f0ac 100644 --- a/posts/2007/06/back-on-gentoo-trying-new-things.md +++ b/posts/2007/06/back-on-gentoo-trying-new-things.md @@ -1,7 +1,7 @@ --- -Title: Back on Gentoo, trying new things +Title: "Back on Gentoo, trying new things" Author: Sami Samhuri -Date: 18th June, 2007 +Date: "18th June, 2007" Timestamp: 2007-06-18T18:05:00-07:00 Tags: emacs, gentoo, linux, vim --- diff --git a/posts/2007/06/begging-the-question.md b/posts/2007/06/begging-the-question.md index 3f48a82..833463a 100644 --- a/posts/2007/06/begging-the-question.md +++ b/posts/2007/06/begging-the-question.md @@ -1,7 +1,7 @@ --- -Title: Begging the question +Title: "Begging the question" Author: Sami Samhuri -Date: 15th June, 2007 +Date: "15th June, 2007" Timestamp: 2007-06-15T11:49:00-07:00 Tags: english, life, pedantry --- @@ -14,9 +14,11 @@ Anyway I was very pleased to see the only correct usage of the phrase "begs the This describes a perfectly legitimate mathematical function. We could use it to recognize whether one number is the square root of another, or to derive facts about square roots in general. On the other hand, the definition does not describe a procedure. Indeed, it tells us almost nothing about how to actually find the square root of a given number. It will not help matters to rephrase this definition in pseudo-Lisp: -
(define (sqrt x)
+```scheme
+(define (sqrt x)
   (the y (and (= y 0)
-              (= (square y) x))))
+ (= (square y) x)))) +``` This only begs the question. diff --git a/posts/2007/06/controlling-volume-via-the-keyboard-on-linux.md b/posts/2007/06/controlling-volume-via-the-keyboard-on-linux.md index f154e5c..7ec9dc2 100644 --- a/posts/2007/06/controlling-volume-via-the-keyboard-on-linux.md +++ b/posts/2007/06/controlling-volume-via-the-keyboard-on-linux.md @@ -1,7 +1,7 @@ --- -Title: Controlling volume via the keyboard on Linux +Title: "Controlling volume via the keyboard on Linux" Author: Sami Samhuri -Date: 30th June, 2007 +Date: "30th June, 2007" Timestamp: 2007-06-30T16:13:00-07:00 Tags: alsa, linux, ruby, volume --- diff --git a/posts/2007/06/emacs-for-textmate-junkies.md b/posts/2007/06/emacs-for-textmate-junkies.md index 5f02137..def8f7d 100644 --- a/posts/2007/06/emacs-for-textmate-junkies.md +++ b/posts/2007/06/emacs-for-textmate-junkies.md @@ -1,7 +1,7 @@ --- -Title: Emacs for TextMate junkies +Title: "Emacs for TextMate junkies" Author: Sami Samhuri -Date: 23rd June, 2007 +Date: "23rd June, 2007" Timestamp: 2007-06-22T19:17:00-07:00 Tags: emacs, textmate --- @@ -14,76 +14,20 @@ Tags: emacs, textmate Despite my current infatuation with Emacs there are many reasons I started using TextMate, especially little time-savers that are very addictive. I'll talk about one of those features tonight. When you have text selected in TextMate and you hit say the ' (single quote) then TextMate will surround the selected text with single quotes. The same goes for double quotes, parentheses, brackets, and braces. This little trick is one of my favourites so I had to come up with something similar in Emacs. It was easy since a mailing list post has a solution for surrounding the current region with tags, which served as a great starting point. - -
1
-2
-3
-4
-5
-6
-7
-
-
(defun surround-region-with-tag (tag-name beg end)
+```lisp
+(defun surround-region-with-tag (tag-name beg end)
       (interactive "sTag name: \nr")
       (save-excursion
         (goto-char beg)
-        (insert "<" tag-name ">")
+        (insert "<" tag-name ">")
         (goto-char (+ end 2 (length tag-name)))
-        (insert "</" tag-name ">")))
- + (insert ""))) +``` With a little modification I now have the following in my ~/.emacs file: - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-
-
;; help out a TextMate junkie
+```lisp
+;; help out a TextMate junkie
 
 (defun wrap-region (left right beg end)
   "Wrap the region in arbitrary text, LEFT goes to the left and RIGHT goes to the right."
@@ -103,7 +47,7 @@ With a little modification I now have the following in my ~/.emacs file:
   (interactive)
   (if (and mark-active transient-mark-mode)
       (call-interactively 'wrap-region-with-tag)
-    (insert "<")))
+    (insert "<")))
 
 (defun wrap-region-with-tag (tag beg end)
   "Wrap the region in the given HTML/XML tag using `wrap-region'. If any
@@ -111,10 +55,10 @@ attributes are specified then they are only included in the opening tag."
   (interactive "*sTag (including attributes): \nr")
   (let* ((elems    (split-string tag " "))
          (tag-name (car elems))
-         (right    (concat "</" tag-name ">")))
+         (right    (concat "")))
     (if (= 1 (length elems))
-        (wrap-region (concat "<" tag-name ">") right beg end)
-      (wrap-region (concat "<" tag ">") right beg end))))
+        (wrap-region (concat "<" tag-name ">") right beg end)
+      (wrap-region (concat "<" tag ">") right beg end))))
 
 (defun wrap-region-or-insert (left right)
   "Wrap the region with `wrap-region' if an active region is marked, otherwise insert LEFT at point."
@@ -129,7 +73,8 @@ attributes are specified then they are only included in the opening tag."
 (global-set-key "("  (wrap-region-with-function "(" ")"))
 (global-set-key "["  (wrap-region-with-function "[" "]"))
 (global-set-key "{"  (wrap-region-with-function "{" "}"))
-(global-set-key "<"  'wrap-region-with-tag-or-insert) ;; I opted not to have a wrap-with-angle-brackets
+(global-set-key "<" 'wrap-region-with-tag-or-insert) ;; I opted not to have a wrap-with-angle-brackets +``` ↓ Download wrap-region.el diff --git a/posts/2007/06/emacs-tagify-region-or-insert-tag.md b/posts/2007/06/emacs-tagify-region-or-insert-tag.md index 4957412..e9e55fb 100644 --- a/posts/2007/06/emacs-tagify-region-or-insert-tag.md +++ b/posts/2007/06/emacs-tagify-region-or-insert-tag.md @@ -1,7 +1,7 @@ --- -Title: Emacs: tagify-region-or-insert-tag +Title: "Emacs: tagify-region-or-insert-tag" Author: Sami Samhuri -Date: 25th June, 2007 +Date: "25th June, 2007" Timestamp: 2007-06-25T15:13:00-07:00 Tags: emacs, tagify --- diff --git a/posts/2007/06/embrace-the-database.md b/posts/2007/06/embrace-the-database.md index 892113d..525110f 100644 --- a/posts/2007/06/embrace-the-database.md +++ b/posts/2007/06/embrace-the-database.md @@ -1,7 +1,7 @@ --- -Title: Embrace the database +Title: "Embrace the database" Author: Sami Samhuri -Date: 22nd June, 2007 +Date: "22nd June, 2007" Timestamp: 2007-06-22T03:14:00-07:00 Tags: activerecord, rails, ruby --- diff --git a/posts/2007/06/floating-point-in-elschemo.md b/posts/2007/06/floating-point-in-elschemo.md index e599a5b..fe43d91 100644 --- a/posts/2007/06/floating-point-in-elschemo.md +++ b/posts/2007/06/floating-point-in-elschemo.md @@ -1,7 +1,7 @@ --- -Title: Floating point in ElSchemo +Title: "Floating point in ElSchemo" Author: Sami Samhuri -Date: 24th June, 2007 +Date: "24th June, 2007" Timestamp: 2007-06-24T11:53:00-07:00 Tags: elschemo, haskell, scheme --- @@ -10,24 +10,8 @@ Tags: elschemo, haskell, scheme The first task is extending the LispVal type to grok floats. - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-
-
type LispInt = Integer
+```haskell
+type LispInt = Integer
 type LispFloat = Float
 
 -- numeric data types
@@ -41,30 +25,22 @@ data LispVal = Atom String
              | Number LispNum
              | Char Char
              | String String
-             | ...
- + | ... +``` The reason for using the new LispNum type and not just throwing a new Float Float constructor in there is so that functions can accept and operate on parameters of any supported numeric type. First the floating point numbers need to be parsed. For now I only parse floating point numbers in decimal because the effort to parse other bases is too great for the benefits gained (none, for me). ElSchemo now parses negative numbers so I'll start with 2 helper functions that are used when parsing both integers and floats: - -
1
-2
-3
-4
-5
-6
-7
-
-
parseSign :: Parser Char
+```haskell
+parseSign :: Parser Char
 parseSign = do try (char '-')
-           <|> do optional (char '+')
+           <|> do optional (char '+')
                   return '+'
 
-applySign :: Char -> LispNum -> LispNum
-applySign sign n = if sign == '-' then negate n else n
- +applySign :: Char -> LispNum -> LispNum +applySign sign n = if sign == '-' then negate n else n +``` parseSign is straightforward as it follows the convention that a literal number is positive unless explicitly marked as negative with a leading minus sign. A leading plus sign is allowed but not required. @@ -72,94 +48,64 @@ applySign sign n = if sign == '-' then negate n else n Armed with these 2 functions we can now parse floating point numbers in decimal. Conforming to R5RS an optional #d prefix is allowed. - -
1
-2
-3
-4
-5
-6
-7
-8
-
-
parseFloat :: Parser LispVal
+```haskell
+parseFloat :: Parser LispVal
 parseFloat = do optional (string "#d")
-                sign <- parseSign
-                whole <- many1 digit
+                sign <- parseSign
+                whole <- many1 digit
                 char '.'
-                fract <- many1 digit
+                fract <- many1 digit
                 return . Number $ applySign sign (makeFloat whole fract)
-    where makeFloat whole fract = Float . fst . head . readFloat $ whole ++ "." ++ fract
- + where makeFloat whole fract = Float . fst . head . readFloat $ whole ++ "." ++ fract +``` The first 6 lines should be clear. Line 7 simply applies the parsed sign to the parsed number and returns it, delegating most of the work to makeFloat. makeFloat in turn delegates the work to the readFloat library function, extracts the result and constructs a LispNum for it. The last step for parsing is to modify parseExpr to try and parse floats. - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-
-
-- Integers, floats, characters and atoms can all start with a # so wrap those with try.
+```haskell
+-- Integers, floats, characters and atoms can all start with a # so wrap those with try.
 -- (Left factor the grammar in the future)
 parseExpr :: Parser LispVal
 parseExpr = (try parseFloat)
-        <|> (try parseInteger)
-        <|> (try parseChar)
-        <|> parseAtom
-        <|> parseString
-        <|> parseQuoted
-        <|> do char '('
-               x <- (try parseList) <|> parseDottedList
+        <|> (try parseInteger)
+        <|> (try parseChar)
+        <|> parseAtom
+        <|> parseString
+        <|> parseQuoted
+        <|> do char '('
+               x <- (try parseList) <|> parseDottedList
                char ')'
                return x
-        <|> parseComment
- + <|> parseComment +``` ### Displaying the floats ### - That's it for parsing, now let's provide a way to display these suckers. LispVal is an instance of show, where show = showVal so showVal is our first stop. Remembering that LispVal now has a single Number constructor we modify it accordingly: +```haskell +showVal (Number n) = showNum n -
1
-2
-3
-4
-5
-6
-7
-
-
showVal (Number n) = showNum n
-
-showNum :: LispNum -> String
+showNum :: LispNum -> String
 showNum (Integer contents) = show contents
 showNum (Float contents) = show contents
 
-instance Show LispNum where show = showNum
- +instance Show LispNum where show = showNum +``` One last, and certainly not least, step is to modify eval so that numbers evaluate to themselves. - - eval env val@(Number _) = return val +```haskell +eval env val@(Number _) = return val +``` There's a little more housekeeping to be done such as fixing integer?, number?, implementing float? but I will leave those as an exercise to the reader, or just wait until I share the full code. As it stands now floating point numbers can be parsed and displayed. If you fire up the interpreter and type 2.5 or -10.88 they will be understood. Now try adding them: - (+ 2.5 1.1) - Invalid type: expected integer, found 2.5 +```scheme +(+ 2.5 1.1) +Invalid type: expected integer, found 2.5 +``` Oops, we don't know how to operate on floats yet! @@ -167,79 +113,8 @@ Oops, we don't know how to operate on floats yet! Parsing was the easy part. Operating on the new floats is not necessarily difficult, but it was more work than I realized it would be. I don't claim that this is the best or the only way to operate on any LispNum, it's just the way I did it and it seems to work. There's a bunch of boilerplate necessary to make LispNum an instance of the required classes, Eq, Num, Real, and Ord. I don't think I have done this properly but for now it works. What is clearly necessary is the code that operates on different types of numbers. I think I've specified sane semantics for coercion. This will be very handy shortly. - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-19
-20
-21
-22
-23
-24
-25
-26
-27
-28
-29
-30
-31
-32
-33
-34
-35
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70 
-
-
lispNumEq :: LispNum -> LispNum -> Bool
+```haskell
+lispNumEq :: LispNum -> LispNum -> Bool
 lispNumEq (Integer arg1) (Integer arg2) = arg1 == arg2
 lispNumEq (Integer arg1) (Float arg2) = (fromInteger arg1) == arg2
 lispNumEq (Float arg1) (Float arg2) = arg1 == arg2
@@ -247,35 +122,35 @@ lispNumEq (Float arg1) (Integer arg2) = arg1 == (fromInteger arg2)
 
 instance Eq LispNum where (==) = lispNumEq
 
-lispNumPlus :: LispNum -> LispNum -> LispNum
+lispNumPlus :: LispNum -> LispNum -> LispNum
 lispNumPlus (Integer x) (Integer y) = Integer $ x + y
 lispNumPlus (Integer x) (Float y)   = Float $ (fromInteger x) + y
 lispNumPlus (Float x)   (Float y)   = Float $ x + y
 lispNumPlus (Float x)   (Integer y) = Float $ x + (fromInteger y)
 
-lispNumMinus :: LispNum -> LispNum -> LispNum
+lispNumMinus :: LispNum -> LispNum -> LispNum
 lispNumMinus (Integer x) (Integer y) = Integer $ x - y
 lispNumMinus (Integer x) (Float y)   = Float $ (fromInteger x) - y
 lispNumMinus (Float x)   (Float y)   = Float $ x - y
 lispNumMinus (Float x)   (Integer y) = Float $ x - (fromInteger y)
 
-lispNumMult :: LispNum -> LispNum -> LispNum
+lispNumMult :: LispNum -> LispNum -> LispNum
 lispNumMult (Integer x) (Integer y) = Integer $ x * y
 lispNumMult (Integer x) (Float y)   = Float $ (fromInteger x) * y
 lispNumMult (Float x)   (Float y)   = Float $ x * y
 lispNumMult (Float x)   (Integer y) = Float $ x * (fromInteger y)
 
-lispNumDiv :: LispNum -> LispNum -> LispNum
+lispNumDiv :: LispNum -> LispNum -> LispNum
 lispNumDiv (Integer x) (Integer y) = Integer $ x `div` y
 lispNumDiv (Integer x) (Float y)   = Float $ (fromInteger x) / y
 lispNumDiv (Float x)   (Float y)   = Float $ x / y
 lispNumDiv (Float x)   (Integer y) = Float $ x / (fromInteger y)
 
-lispNumAbs :: LispNum -> LispNum
+lispNumAbs :: LispNum -> LispNum
 lispNumAbs (Integer x) = Integer (abs x)
 lispNumAbs (Float x) = Float (abs x)
 
-lispNumSignum :: LispNum -> LispNum
+lispNumSignum :: LispNum -> LispNum
 lispNumSignum (Integer x) = Integer (signum x)
 lispNumSignum (Float x) = Float (signum x)
 
@@ -287,50 +162,32 @@ instance Num LispNum where
     signum = lispNumSignum
     fromInteger x = Integer x
 
-
-lispNumToRational :: LispNum -> Rational
+lispNumToRational :: LispNum -> Rational
 lispNumToRational (Integer x) = toRational x
 lispNumToRational (Float x) = toRational x
 
 instance Real LispNum where
     toRational = lispNumToRational
 
-
-lispIntQuotRem :: LispInt -> LispInt -> (LispInt, LispInt)
+lispIntQuotRem :: LispInt -> LispInt -> (LispInt, LispInt)
 lispIntQuotRem n d = quotRem n d
 
-lispIntToInteger :: LispInt -> Integer
+lispIntToInteger :: LispInt -> Integer
 lispIntToInteger x = x
 
-lispNumLessThanEq :: LispNum -> LispNum -> Bool
-lispNumLessThanEq (Integer x) (Integer y) = x <= y
-lispNumLessThanEq (Integer x) (Float y)   = (fromInteger x) <= y
-lispNumLessThanEq (Float x)   (Integer y) = x <= (fromInteger y)
-lispNumLessThanEq (Float x)   (Float y)   = x <= y
-
-instance Ord LispNum where (<=) = lispNumLessThanEq
+lispNumLessThanEq :: LispNum -> LispNum -> Bool +lispNumLessThanEq (Integer x) (Integer y) = x <= y +lispNumLessThanEq (Integer x) (Float y) = (fromInteger x) <= y +lispNumLessThanEq (Float x) (Integer y) = x <= (fromInteger y) +lispNumLessThanEq (Float x) (Float y) = x <= y +instance Ord LispNum where (<=) = lispNumLessThanEq +``` Phew, ok with that out of the way now we can actually extend our operators to work with any type of LispNum. Our Scheme operators are defined using the functions numericBinop and numBoolBinop. First we'll slightly modify our definition of primitives: - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-
-
primitives :: [(String, [LispVal] -> ThrowsError LispVal)]
+```haskell
+primitives :: [(String, [LispVal] -> ThrowsError LispVal)]
 primitives = [("+", numericBinop (+)),
               ("-", subtractOp),
               ("*", numericBinop (*)),
@@ -339,94 +196,57 @@ primitives = [("+", numericBinop (+)),
               ("quotient", integralBinop quot),
               ("remainder", integralBinop rem),
               ("=", numBoolBinop (==)),
-              ("<", numBoolBinop (<)),
-              (">", numBoolBinop (>)),
+              ("<", numBoolBinop (<)),
+              (">", numBoolBinop (>)),
               ("/=", numBoolBinop (/=)),
-              (">=", numBoolBinop (>=)),
-              ("<=", numBoolBinop (<=)),
-              ...]
- + (">=", numBoolBinop (>=)), + ("<=", numBoolBinop (<=)), + ...] +``` Note that mod, quotient, and remainder are only defined for integers and as such use integralBinop, while division (/) is only defined for floating point numbers using floatBinop. subtractOp is different to support unary usage, e.g. (- 4) => -4, but it uses numericBinop internally when more than 1 argument is given. On to the implementation! First extend unpackNum to work with any LispNum, and provide separate unpackInt and unpackFloat functions to handle both kinds of LispNum. - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-
-
unpackNum :: LispVal -> ThrowsError LispNum
+```haskell
+unpackNum :: LispVal -> ThrowsError LispNum
 unpackNum (Number (Integer n)) = return $ Integer n
 unpackNum (Number (Float n)) = return $ Float n
 unpackNum notNum = throwError $ TypeMismatch "number" notNum
 
-unpackInt :: LispVal -> ThrowsError Integer
+unpackInt :: LispVal -> ThrowsError Integer
 unpackInt (Number (Integer n)) = return n
 unpackInt (List [n]) = unpackInt n
 unpackInt notInt = throwError $ TypeMismatch "integer" notInt
 
-unpackFloat :: LispVal -> ThrowsError Float
+unpackFloat :: LispVal -> ThrowsError Float
 unpackFloat (Number (Float f)) = return f
 unpackFloat (Number (Integer f)) = return $ fromInteger f
 unpackFloat (List [f]) = unpackFloat f
-unpackFloat notFloat = throwError $ TypeMismatch "float" notFloat
- +unpackFloat notFloat = throwError $ TypeMismatch "float" notFloat +``` The initial work of separating integers and floats into the LispNum abstraction, and the code I said would be handy shortly, are going to be really handy here. There's relatively no change in numericBinop except for the type signature. integralBinop and floatBinop are just specific versions of the same function. I'm sure there's a nice Haskelly way of doing this with less repetition, and I welcome such corrections. - -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15
-16
-17
-18
-
-
numericBinop :: (LispNum -> LispNum -> LispNum) -> [LispVal] -> ThrowsError LispVal
+```haskell
+numericBinop :: (LispNum -> LispNum -> LispNum) -> [LispVal] -> ThrowsError LispVal
 numericBinop op singleVal@[_] = throwError $ NumArgs 2 singleVal
-numericBinop op params = mapM unpackNum params >>= return . Number . foldl1 op
+numericBinop op params = mapM unpackNum params >>= return . Number . foldl1 op
 
-integralBinop :: (LispInt -> LispInt -> LispInt) -> [LispVal] -> ThrowsError LispVal
+integralBinop :: (LispInt -> LispInt -> LispInt) -> [LispVal] -> ThrowsError LispVal
 integralBinop op singleVal@[_] = throwError $ NumArgs 2 singleVal
-integralBinop op params = mapM unpackInt params >>= return . Number . Integer . foldl1 op
+integralBinop op params = mapM unpackInt params >>= return . Number . Integer . foldl1 op
 
-floatBinop :: (LispFloat -> LispFloat -> LispFloat) -> [LispVal] -> ThrowsError LispVal
+floatBinop :: (LispFloat -> LispFloat -> LispFloat) -> [LispVal] -> ThrowsError LispVal
 floatBinop op singleVal@[_] = throwError $ NumArgs 2 singleVal
-floatBinop op params = mapM unpackFloat params >>= return . Number . Float . foldl1 op
+floatBinop op params = mapM unpackFloat params >>= return . Number . Float . foldl1 op
 
-subtractOp :: [LispVal] -> ThrowsError LispVal
-subtractOp num@[_] = unpackNum (head num) >>= return . Number . negate
+subtractOp :: [LispVal] -> ThrowsError LispVal
+subtractOp num@[_] = unpackNum (head num) >>= return . Number . negate
 subtractOp params = numericBinop (-) params
 
-numBoolBinop :: (LispNum -> LispNum -> Bool) -> [LispVal] -> ThrowsError LispVal
-numBoolBinop op params = boolBinop unpackNum op params
- +numBoolBinop :: (LispNum -> LispNum -> Bool) -> [LispVal] -> ThrowsError LispVal +numBoolBinop op params = boolBinop unpackNum op params +``` That was a bit of work but now ElSchemo supports floating point numbers, and if you're following along then your Scheme might too if I haven't missed any important details! - Next time I'll go over some of the special forms I have added, including short-circuiting and and or forms and the full repetoire of let, let*, and letrec. Stay tuned! - diff --git a/posts/2007/06/more-scheming-with-haskell.md b/posts/2007/06/more-scheming-with-haskell.md index aa946d0..a8fdc70 100644 --- a/posts/2007/06/more-scheming-with-haskell.md +++ b/posts/2007/06/more-scheming-with-haskell.md @@ -1,7 +1,7 @@ --- -Title: More Scheming with Haskell +Title: "More Scheming with Haskell" Author: Sami Samhuri -Date: 14th June, 2007 +Date: "14th June, 2007" Timestamp: 2007-06-13T18:09:00-07:00 Tags: coding, haskell, scheme --- @@ -14,11 +14,14 @@ It's been a little while since I wrote about Haskell and the R5RS compliant numbers, which is exercise 3.3.4 if you're following along the tutorial. Only integers in binary, octal, decimal, and hexadecimal are parsed right now. The syntaxes for those are #b101010, #o52, 42 (or #d42), and #x2a, respectively. To parse these we use the readOct, readDec, readHex, and readInt functions provided by the Numeric module, and import them thusly: - import Numeric (readOct, readDec, readHex, readInt) +```haskell +import Numeric (readOct, readDec, readHex, readInt) +``` In order to parse binary digits we need to write a few short functions to help us out. For some reason I couldn't find binDigit, isBinDigit and readBin in their respective modules but luckily they're trivial to implement. The first two are self-explanatory, as is the third if you look at the implementation of its relatives for larger bases. In a nutshell readBin says to: "read an integer in base 2, validating digits with isBinDigit." -
-- parse a binary digit, analagous to decDigit, octDigit, hexDigit
+```haskell
+-- parse a binary digit, analagous to decDigit, octDigit, hexDigit
 binDigit :: Parser Char
 binDigit = oneOf "01"
 
@@ -28,24 +31,30 @@ isBinDigit c = (c == '0' || c == '1')
 
 -- analogous to readDec, readOct, readHex
 readBin :: (Integral a) = ReadS a
-readBin = readInt 2 isBinDigit digitToInt
+readBin = readInt 2 isBinDigit digitToInt +``` The next step is to augment parseNumber so that it can handle R5RS numbers in addition to regular decimal numbers. To refresh, the tutorial's parseNumber function looks like this: - parseNumber :: Parser LispVal - parseNumber = liftM (Number . read) $ many1 digit +```haskell +parseNumber :: Parser LispVal +parseNumber = liftM (Number . read) $ many1 digit +``` Three more lines in this function will give us a decent starting point: - parseNumber = do char '#' - base <- oneOf "bdox" - parseDigits base +```haskell +parseNumber = do char '#' + base <- oneOf "bdox" + parseDigits base +``` Translation: First look for an R5RS style base, and if found call parseDigits with the given base to do the dirty work. If that fails then fall back to parsing a boring old string of decimal digits. That brings us to actually parsing the numbers. parseDigits is simple, but there might be a more Haskell-y way of doing this. -
-- Parse a string of digits in the given base.
+```haskell
+-- Parse a string of digits in the given base.
 parseDigits :: Char - Parser LispVal
 parseDigits base = many1 d >>= return
     where d = case base of
@@ -53,7 +62,7 @@ parseDigits base = many1 d >>= return
                 'd' -> digit
                 'o' -> octDigit
                 'x' -> hexDigit
-
+``` The trickiest part of all this was figuring out how to use the various readFoo functions properly. They return a list of pairs so head grabs the first pair and fst grabs the first element of the pair. Once I had that straight it was smooth sailing. Having done this, parsing R5RS characters (#\a, #\Z, #\?, ...) is a breeze so I won't bore you with that. @@ -61,27 +70,17 @@ The trickiest part of all this was figuring out how to use the various rea It still takes me some time to knit together meaningful Haskell statements. Tonight I spent said time cobbling together an implementation of cond as a new special form. Have a look at the code. The explanation follows. - -
1
-2
-3
-4
-5
-6
-7
-8
-9 
-
-
eval env (List (Atom "cond" : List (Atom "else" : exprs) : [])) =
+```haskell
+eval env (List (Atom "cond" : List (Atom "else" : exprs) : [])) =
     liftM last $ mapM (eval env) exprs
 eval env (List (Atom "cond" : List (pred : conseq) : rest)) = 
-    do result <- eval env $ pred
+    do result <- eval env $ pred
        case result of
-         Bool False -> case rest of
-                         [] -> return $ List []
-                         _ -> eval env $ List (Atom "cond" : rest)
-         _ -> liftM last $ mapM (eval env) conseq
- + Bool False -> case rest of + [] -> return $ List [] + _ -> eval env $ List (Atom "cond" : rest) + _ -> liftM last $ mapM (eval env) conseq +``` * __Lines 1-2:__ Handle else clauses by evaluating the given expression(s), returning the last result. It must come first or it's overlapped by the next pattern. * __Line 3:__ Evaluate a cond by splitting the first condition into predicate and consequence, tuck the remaining conditions into rest for later. @@ -93,4 +92,3 @@ eval env (List (Atom "cond" : List (pred : conseq) : rest)) = * __Line 9:__ Anything other than #f is considered true and causes conseq to be evaluated and returned. Like else, conseq can be a sequence of expressions. So far my Scheme weighs in at 621 lines, 200 more than the tutorial's final code listing. Hopefully I'll keep adding things on my TODO list and it will grow a little bit more. Now that I have cond it will be more fun to expand my stdlib.scm as well. - diff --git a/posts/2007/06/propaganda-makes-me-sick.md b/posts/2007/06/propaganda-makes-me-sick.md index 7ae47d4..01602e9 100644 --- a/posts/2007/06/propaganda-makes-me-sick.md +++ b/posts/2007/06/propaganda-makes-me-sick.md @@ -1,7 +1,7 @@ --- -Title: Propaganda makes me sick +Title: "Propaganda makes me sick" Author: Sami Samhuri -Date: 25th June, 2007 +Date: "25th June, 2007" Timestamp: 2007-06-25T03:55:00-07:00 Tags: propaganda --- diff --git a/posts/2007/06/recent-ruby-and-rails-regales.md b/posts/2007/06/recent-ruby-and-rails-regales.md index bb05c40..8b81d8f 100644 --- a/posts/2007/06/recent-ruby-and-rails-regales.md +++ b/posts/2007/06/recent-ruby-and-rails-regales.md @@ -1,7 +1,7 @@ --- -Title: Recent Ruby and Rails Regales +Title: "Recent Ruby and Rails Regales" Author: Sami Samhuri -Date: 28th June, 2007 +Date: "28th June, 2007" Timestamp: 2007-06-28T12:23:00-07:00 Tags: rails, rails on rules, regular expressions, ruby, sake, secure associations, regex --- diff --git a/posts/2007/06/reinventing-the-wheel.md b/posts/2007/06/reinventing-the-wheel.md index 3d42df3..737ecbd 100644 --- a/posts/2007/06/reinventing-the-wheel.md +++ b/posts/2007/06/reinventing-the-wheel.md @@ -1,7 +1,7 @@ --- -Title: Reinventing the wheel +Title: "Reinventing the wheel" Author: Sami Samhuri -Date: 20th June, 2007 +Date: "20th June, 2007" Timestamp: 2007-06-20T09:27:00-07:00 Tags: emacs, snippets --- diff --git a/posts/2007/06/rtfm.md b/posts/2007/06/rtfm.md index 34846d9..9bb5fc1 100644 --- a/posts/2007/06/rtfm.md +++ b/posts/2007/06/rtfm.md @@ -1,7 +1,7 @@ --- -Title: RTFM! +Title: "RTFM!" Author: Sami Samhuri -Date: 26th June, 2007 +Date: "26th June, 2007" Timestamp: 2007-06-25T14:19:00-07:00 Tags: emacs, rtfm --- diff --git a/posts/2007/06/so-long-typo-and-thanks-for-all-the-timeouts.md b/posts/2007/06/so-long-typo-and-thanks-for-all-the-timeouts.md index 31af818..94af7b8 100644 --- a/posts/2007/06/so-long-typo-and-thanks-for-all-the-timeouts.md +++ b/posts/2007/06/so-long-typo-and-thanks-for-all-the-timeouts.md @@ -1,7 +1,7 @@ --- -Title: so long typo (and thanks for all the timeouts) +Title: "so long typo (and thanks for all the timeouts)" Author: Sami Samhuri -Date: 8th June, 2007 +Date: "8th June, 2007" Timestamp: 2007-06-08T18:01:00-07:00 Tags: mephisto, typo --- @@ -12,22 +12,15 @@ Recently I had looked at converting Typo to Mephisto and it seemed pretty painle After running that code snippet to fix my tags, I decided to completely ditch categories in favour of tags. I tagged each new Mephisto article with a tag for each Typo category it had previously belonged to. I fired up RAILS_ENV=production script/console and typed something similar to the following: -
1
-2
-3
-4
-5
-6
-7 
-
-
require 'converters/base'
-require 'converters/typo'
-articles = Typo::Article.find(:all).map {|a| [a, Article.find_by_permalink(a.permalink)] }
-articles.each do |ta, ma|
-  next if ma.nil?
-  ma.tags << Tag.find_or_create(ta.categories.map(&:name))
-end
- +```ruby +require 'converters/base' +require 'converters/typo' +articles = Typo::Article.find(:all).map {|a| [a, Article.find_by_permalink(a.permalink)] } +articles.each do |ta, ma| + next if ma.nil? + ma.tags << Tag.find_or_create(ta.categories.map(&:name)) +end +``` When I say something similar I mean exactly that. I just typed that from memory so it may not work, or even be syntactically correct. If any permalinks changed then you'll have to manually add new tags corresponding to old Typo categories. The only case where this bit me was when I had edited the title of an article, in which case the new Mephisto permalink matched the new title while the Typo permalink matched the initial title, whatever it was. diff --git a/posts/2007/06/testspec-on-rails-declared-awesome-just-one-catch.md b/posts/2007/06/testspec-on-rails-declared-awesome-just-one-catch.md index e4bae64..65add7d 100644 --- a/posts/2007/06/testspec-on-rails-declared-awesome-just-one-catch.md +++ b/posts/2007/06/testspec-on-rails-declared-awesome-just-one-catch.md @@ -1,7 +1,7 @@ --- -Title: test/spec on rails declared awesome, just one catch +Title: "test/spec on rails declared awesome, just one catch" Author: Sami Samhuri -Date: 14th June, 2007 +Date: "14th June, 2007" Timestamp: 2007-06-14T07:21:00-07:00 Tags: bdd, rails, test/spec --- @@ -10,79 +10,47 @@ This last week I've been getting to know - -
use_controller :foo
- +```ruby +use_controller :foo +``` and can be placed in the setup method, like so: +```ruby +# in test/functional/sessions_controller_test.rb -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13
-14
-15 
-
-
# in test/functional/sessions_controller_test.rb
+context "A guest" do
+  fixtures :users
 
-context "A guest" do
-  fixtures :users
+  setup do
+    use_controller :sessions
+  end
 
-  setup do
-    use_controller :sessions
-  end
-
-  specify "can login" do
-    post :create, :username => 'sjs', :password => 'blah'
-    response.should.redirect_to user_url(users(:sjs))
+  specify "can login" do
+    post :create, :username => 'sjs', :password => 'blah'
+    response.should.redirect_to user_url(users(:sjs))
     ...
-  end
-end
- + end +end +``` This is great and the test will work. But let's say that I have another controller that guests can access: +```ruby +# in test/functional/foo_controller_test.rb -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-13 
-
-
# in test/functional/foo_controller_test.rb
+context "A guest" do
+  setup do
+    use_controller :foo
+  end
 
-context "A guest" do
-  setup do
-    use_controller :foo
-  end
-
-  specify "can do foo stuff" do
-    get :fooriffic
-    status.should.be :success
+  specify "can do foo stuff" do
+    get :fooriffic
+    status.should.be :success
     ...
-  end
-end
- + end +end +``` This test will pass on its own as well, which is what really tripped me up. When I ran my tests individually as I wrote them, they passed. When I ran rake test:functionals this morning and saw over a dozen failures and errors I was pretty alarmed. Then I looked at the errors and was thoroughly confused. Of course the action fooriffic can't be found in SessionsController, it lives in FooController and that's the controller I said to use! What gives?! diff --git a/posts/2007/07/a-textmate-tip-for-emacs-users.md b/posts/2007/07/a-textmate-tip-for-emacs-users.md index 2be4215..4a858fe 100644 --- a/posts/2007/07/a-textmate-tip-for-emacs-users.md +++ b/posts/2007/07/a-textmate-tip-for-emacs-users.md @@ -1,7 +1,7 @@ --- -Title: A TextMate tip for Emacs users +Title: "A TextMate tip for Emacs users" Author: Sami Samhuri -Date: 3rd July, 2007 +Date: "3rd July, 2007" Timestamp: 2007-07-03T09:45:00-07:00 Tags: emacs, keyboard shortcuts, textmate --- diff --git a/posts/2007/07/people.md b/posts/2007/07/people.md index 25a9638..5221132 100644 --- a/posts/2007/07/people.md +++ b/posts/2007/07/people.md @@ -1,7 +1,7 @@ --- -Title: people +Title: "people" Author: Sami Samhuri -Date: 12th July, 2007 +Date: "12th July, 2007" Timestamp: 2007-07-12T05:28:00-07:00 Tags: life, people --- diff --git a/posts/2007/07/rushcheck-quickcheck-for-ruby.md b/posts/2007/07/rushcheck-quickcheck-for-ruby.md index 7d477dc..9c6624b 100644 --- a/posts/2007/07/rushcheck-quickcheck-for-ruby.md +++ b/posts/2007/07/rushcheck-quickcheck-for-ruby.md @@ -1,7 +1,7 @@ --- -Title: RushCheck: QuickCheck for Ruby +Title: "RushCheck: QuickCheck for Ruby" Author: Sami Samhuri -Date: 5th July, 2007 +Date: "5th July, 2007" Timestamp: 2007-07-05T12:50:00-07:00 Tags: quickcheck, ruby, rushcheck --- diff --git a/posts/2007/07/see-your-regular-expressions-in-emacs.md b/posts/2007/07/see-your-regular-expressions-in-emacs.md index d52b7f2..e70bd95 100644 --- a/posts/2007/07/see-your-regular-expressions-in-emacs.md +++ b/posts/2007/07/see-your-regular-expressions-in-emacs.md @@ -1,7 +1,7 @@ --- -Title: See your regular expressions in Emacs +Title: "See your regular expressions in Emacs" Author: Sami Samhuri -Date: 6th July, 2007 +Date: "6th July, 2007" Timestamp: 2007-07-06T09:45:00-07:00 Tags: emacs, regex --- diff --git a/posts/2007/08/5-ways-to-avoid-looking-like-a-jerk-on-the-internet.md b/posts/2007/08/5-ways-to-avoid-looking-like-a-jerk-on-the-internet.md index 808f2b6..f96694b 100644 --- a/posts/2007/08/5-ways-to-avoid-looking-like-a-jerk-on-the-internet.md +++ b/posts/2007/08/5-ways-to-avoid-looking-like-a-jerk-on-the-internet.md @@ -1,7 +1,7 @@ --- -Title: 5 ways to avoid looking like a jerk on the Internet +Title: "5 ways to avoid looking like a jerk on the Internet" Author: Sami Samhuri -Date: 30th August, 2007 +Date: "30th August, 2007" Timestamp: 2007-08-30T08:25:00-07:00 Tags: life, netiquette --- diff --git a/posts/2007/08/captivating-little-creatures.md b/posts/2007/08/captivating-little-creatures.md index 9abb07c..05f883c 100644 --- a/posts/2007/08/captivating-little-creatures.md +++ b/posts/2007/08/captivating-little-creatures.md @@ -1,7 +1,7 @@ --- -Title: Captivating little creatures +Title: "Captivating little creatures" Author: Sami Samhuri -Date: 26th August, 2007 +Date: "26th August, 2007" Timestamp: 2007-08-26T05:35:00-07:00 Tags: games, lemmings --- diff --git a/posts/2007/08/catch-compiler-errors-at-runtime.md b/posts/2007/08/catch-compiler-errors-at-runtime.md index 602adfe..dc50e83 100644 --- a/posts/2007/08/catch-compiler-errors-at-runtime.md +++ b/posts/2007/08/catch-compiler-errors-at-runtime.md @@ -1,7 +1,7 @@ --- -Title: Catch compiler errors at runtime +Title: "Catch compiler errors at runtime" Author: Sami Samhuri -Date: 19th August, 2007 +Date: "19th August, 2007" Timestamp: 2007-08-19T15:17:00-07:00 Tags: ruby --- diff --git a/posts/2007/08/cheat-from-emacs.md b/posts/2007/08/cheat-from-emacs.md index c59a1f7..d75a89e 100644 --- a/posts/2007/08/cheat-from-emacs.md +++ b/posts/2007/08/cheat-from-emacs.md @@ -1,7 +1,7 @@ --- -Title: Cheat from Emacs +Title: "Cheat from Emacs" Author: Sami Samhuri -Date: 9th August, 2007 +Date: "9th August, 2007" Timestamp: 2007-08-09T18:56:00-07:00 Tags: Emacs --- diff --git a/posts/2007/08/cheat-productively-in-emacs.md b/posts/2007/08/cheat-productively-in-emacs.md index 1d1648e..57c6fd3 100644 --- a/posts/2007/08/cheat-productively-in-emacs.md +++ b/posts/2007/08/cheat-productively-in-emacs.md @@ -1,7 +1,7 @@ --- -Title: Cheat productively in Emacs +Title: "Cheat productively in Emacs" Author: Sami Samhuri -Date: 21st August, 2007 +Date: "21st August, 2007" Timestamp: 2007-08-21T11:20:00-07:00 Tags: Emacs --- diff --git a/posts/2007/08/elschemo-boolean-logic-and-branching.md b/posts/2007/08/elschemo-boolean-logic-and-branching.md index f3420e7..9ff64d0 100644 --- a/posts/2007/08/elschemo-boolean-logic-and-branching.md +++ b/posts/2007/08/elschemo-boolean-logic-and-branching.md @@ -1,7 +1,7 @@ --- -Title: ElSchemo: Boolean logic and branching +Title: "ElSchemo: Boolean logic and branching" Author: Sami Samhuri -Date: 2nd August, 2007 +Date: "2nd August, 2007" Timestamp: 2007-08-02T09:59:00-07:00 Tags: elschemo, haskell, scheme --- @@ -16,7 +16,6 @@ that means the code here is for me to get some feedback as much as to show others how to do this kind of stuff. This may not be too interesting if you haven't at least browsed the tutorial. - I'm going to cover 3 new special forms: and, or, and cond. I promised to cover the let family of special forms this time around but methinks this is long enough as it is. My sincere apologies if @@ -45,25 +44,16 @@ concise language. My explanations may be redundant because of this. ### lispAnd ### - -
1
-2
-3
-4
-5
-6
-7
-8 
-
-
lispAnd :: Env -> [LispVal] -> IOThrowsError LispVal
+```haskell
+lispAnd :: Env -> [LispVal] -> IOThrowsError LispVal
 lispAnd env [] = return $ Bool True
 lispAnd env [pred] = eval env pred
 lispAnd env (pred:rest) = do
-    result <- eval env pred
+    result <- eval env pred
     case result of
-      Bool False -> return result
-      _ -> lispAnd env rest
- + Bool False -> return result + _ -> lispAnd env rest +``` Starting with the trivial case, and returns #t with zero arguments. @@ -84,25 +74,16 @@ just complicates things but it's a viable solution. Predictably this is quite similar to lispAnd. - -
1
-2
-3
-4
-5
-6
-7
-8 
-
-
lispOr :: Env -> [LispVal] -> IOThrowsError LispVal
+```haskell
+lispOr :: Env -> [LispVal] -> IOThrowsError LispVal
 lispOr env [] = return $ Bool False
 lispOr env [pred] = eval env pred
 lispOr env (pred:rest) = do
-    result <- eval env pred
+    result <- eval env pred
     case result of
-        Bool False -> lispOr env rest
-        _ -> return result
- + Bool False -> lispOr env rest + _ -> return result +``` With no arguments lispOr returns #f, and with one argument it evaluates and returns the result. @@ -117,33 +98,23 @@ First let me define a convenience function that I have added to ElSchemo. It maps a list of expressions to their values by evaluating each one in the given environment. - -
1
-2 
-
-
evalExprs :: Env -> [LispVal] -> IOThrowsError [LispVal]
-evalExprs env exprs = mapM (eval env) exprs
- +```haskell +evalExprs :: Env -> [LispVal] -> IOThrowsError [LispVal] +evalExprs env exprs = mapM (eval env) exprs +``` ### lispCond ### Again, lispCond has the same type as eval. - -
1
-2
-3
-4
-5
-6 
-
-
lispCond :: Env -> [LispVal] -> IOThrowsError LispVal
+```haskell
+lispCond :: Env -> [LispVal] -> IOThrowsError LispVal
 lispCond env (List (pred:conseq) : rest) = do
-    result <- eval env pred
+    result <- eval env pred
     case result of
-        Bool False -> if null rest then return result else lispCond env rest
-        _ -> liftM last $ evalExprs env conseq
- + Bool False -> if null rest then return result else lispCond env rest + _ -> liftM last $ evalExprs env conseq +``` Unlike Lisp – which uses a predicate of T (true) – Scheme uses a predicate of else to trigger the default branch. When the pattern @@ -164,15 +135,11 @@ expressions and return the value of the last one. Now all that's left is to hook up the new functions in eval. - -
1
-2
-3 
-
-
eval env (List (Atom "and" : params)) = lispAnd env params
+```haskell
+eval env (List (Atom "and" : params)) = lispAnd env params
 eval env (List (Atom "or" : params)) = lispOr env params
-eval env (List (Atom "cond" : params)) = lispCond env params
- +eval env (List (Atom "cond" : params)) = lispCond env params +``` You could, of course, throw the entire definitions in eval itself but eval is big enough for me as it is. YMMV. diff --git a/posts/2007/08/opera-is-pretty-slick.md b/posts/2007/08/opera-is-pretty-slick.md index f9a56d7..b5fa5cb 100644 --- a/posts/2007/08/opera-is-pretty-slick.md +++ b/posts/2007/08/opera-is-pretty-slick.md @@ -1,7 +1,7 @@ --- -Title: Opera is pretty slick +Title: "Opera is pretty slick" Author: Sami Samhuri -Date: 11th August, 2007 +Date: "11th August, 2007" Timestamp: 2007-08-11T05:11:00-07:00 Tags: browsers, firefox, opera --- diff --git a/posts/2007/08/snap-crunchle-pop.md b/posts/2007/08/snap-crunchle-pop.md index bc6c8dc..3ff3d54 100644 --- a/posts/2007/08/snap-crunchle-pop.md +++ b/posts/2007/08/snap-crunchle-pop.md @@ -1,7 +1,7 @@ --- -Title: Snap, crunchle, pop +Title: "Snap, crunchle, pop" Author: Sami Samhuri -Date: 9th August, 2007 +Date: "9th August, 2007" Timestamp: 2007-08-09T03:17:00-07:00 Tags: humans, injury, life --- diff --git a/posts/2007/09/learning-lisp-read-pcl.md b/posts/2007/09/learning-lisp-read-pcl.md index 5d925ff..c6c2cfb 100644 --- a/posts/2007/09/learning-lisp-read-pcl.md +++ b/posts/2007/09/learning-lisp-read-pcl.md @@ -1,7 +1,7 @@ --- -Title: Learning Lisp? Read PCL +Title: "Learning Lisp? Read PCL" Author: Sami Samhuri -Date: 25th September, 2007 +Date: "25th September, 2007" Timestamp: 2007-09-25T02:59:00-07:00 Tags: lisp --- diff --git a/posts/2007/09/python-and-ruby-brain-dump.md b/posts/2007/09/python-and-ruby-brain-dump.md index 07d1f80..55043a9 100644 --- a/posts/2007/09/python-and-ruby-brain-dump.md +++ b/posts/2007/09/python-and-ruby-brain-dump.md @@ -1,7 +1,7 @@ --- -Title: Python and Ruby brain dump +Title: "Python and Ruby brain dump" Author: Sami Samhuri -Date: 26th September, 2007 +Date: "26th September, 2007" Timestamp: 2007-09-26T03:34:00-07:00 Tags: python, ruby --- diff --git a/posts/2007/10/gtkpod-in-gutsy-got-you-groaning.md b/posts/2007/10/gtkpod-in-gutsy-got-you-groaning.md index e032d28..4595869 100644 --- a/posts/2007/10/gtkpod-in-gutsy-got-you-groaning.md +++ b/posts/2007/10/gtkpod-in-gutsy-got-you-groaning.md @@ -1,7 +1,7 @@ --- -Title: Gtkpod in Gutsy Got You Groaning? +Title: "Gtkpod in Gutsy Got You Groaning?" Author: Sami Samhuri -Date: 29th October, 2007 +Date: "29th October, 2007" Timestamp: 2007-10-29T14:14:00-07:00 Tags: broken, gtkpod, linux, ubuntu --- @@ -21,21 +21,8 @@ Now that you know what to do I'll give you what you probably wanted at the begin ↓ gtkpod-aac-fix.sh -
1
-2
-3
-4
-5
-6
-7
-8
-9
-10
-11
-12
-
- -
mkdir /tmp/gtkpod-fix
+```shell
+mkdir /tmp/gtkpod-fix
 cd /tmp/gtkpod-fix
 wget http://ftp.uni-kl.de/debian-multimedia/pool/main/libm/libmpeg4ip/libmp4v2-0_1.5.0.1-0.3_amd64.deb
 wget http://ftp.uni-kl.de/debian-multimedia/pool/main/libm/libmpeg4ip/libmp4v2-dev_1.5.0.1-0.3_amd64.deb
@@ -44,6 +31,7 @@ wget http://ftp.uni-kl.de/debian-multimedia/pool/main/libm/libmpeg4ip/libmpeg4ip
 for f in *.deb; do sudo gdebi -n "$f"; done
 svn co https://gtkpod.svn.sourceforge.net/svnroot/gtkpod/gtkpod/trunk gtkpod
 cd gtkpod
-./autogen.sh --with-mp4v2 && make && sudo make install
+./autogen.sh --with-mp4v2 && make && sudo make install
 cd
-rm -rf /tmp/gtkpod-fix
+rm -rf /tmp/gtkpod-fix +``` diff --git a/posts/2008/01/random-pet-peeve-of-the-day.md b/posts/2008/01/random-pet-peeve-of-the-day.md index eb43229..6084c2f 100644 --- a/posts/2008/01/random-pet-peeve-of-the-day.md +++ b/posts/2008/01/random-pet-peeve-of-the-day.md @@ -1,7 +1,7 @@ --- -Title: Random pet peeve of the day +Title: "Random pet peeve of the day" Author: Sami Samhuri -Date: 7th January, 2008 +Date: "7th January, 2008" Timestamp: 2008-01-07T09:42:00-08:00 Tags: usability, web --- diff --git a/posts/2008/02/thoughts-on-arc.md b/posts/2008/02/thoughts-on-arc.md index e1556e4..8d332ac 100644 --- a/posts/2008/02/thoughts-on-arc.md +++ b/posts/2008/02/thoughts-on-arc.md @@ -1,7 +1,7 @@ --- -Title: Thoughts on Arc +Title: "Thoughts on Arc" Author: Sami Samhuri -Date: 19th February, 2008 +Date: "19th February, 2008" Timestamp: 2008-02-19T03:26:00-08:00 Tags: lisp arc --- diff --git a/posts/2008/03/project-euler-code-repo-in-arc.md b/posts/2008/03/project-euler-code-repo-in-arc.md index a7af391..1b2ee00 100644 --- a/posts/2008/03/project-euler-code-repo-in-arc.md +++ b/posts/2008/03/project-euler-code-repo-in-arc.md @@ -1,17 +1,17 @@ --- -Title: Project Euler code repo in Arc +Title: "Project Euler code repo in Arc" Author: Sami Samhuri -Date: 3rd March, 2008 +Date: "3rd March, 2008" Timestamp: 2008-03-03T08:24:00-08:00 Tags: arc, project euler --- Release early and often. This is a code repo web app for solutions to Project Euler problems. You can only see your own solutions so it's not that exciting yet (but it scratches my itch... once it highlights syntax). You can try it out or download the source. You'll need an up-to-date copy of Anarki to untar the source in. Just run arc.sh then enter this at the REPL: - -
arc> (load "euler.arc")
-arc> (esv)
-
+```lisp +arc> (load "euler.arc") +arc> (esv) +``` That will setup the web server on port 3141. If you want a different port then run (esv 25) (just to mess with 'em). diff --git a/posts/2009/11/using-emacs-to-develop-mojo-apps-for-webos.md b/posts/2009/11/using-emacs-to-develop-mojo-apps-for-webos.md index e97ea95..13d37dc 100644 --- a/posts/2009/11/using-emacs-to-develop-mojo-apps-for-webos.md +++ b/posts/2009/11/using-emacs-to-develop-mojo-apps-for-webos.md @@ -1,7 +1,7 @@ --- -Title: Using Emacs to Develop Mojo Apps for WebOS +Title: "Using Emacs to Develop Mojo Apps for WebOS" Author: Sami Samhuri -Date: 21st November, 2009 +Date: "21st November, 2009" Timestamp: 2009-11-21T00:00:00-08:00 Tags: emacs, mojo, webos, lisp, javascript --- diff --git a/posts/2010/01/a-preview-of-mach-o-file-generation.md b/posts/2010/01/a-preview-of-mach-o-file-generation.md index 0736e70..955f429 100644 --- a/posts/2010/01/a-preview-of-mach-o-file-generation.md +++ b/posts/2010/01/a-preview-of-mach-o-file-generation.md @@ -1,7 +1,7 @@ --- -Title: A preview of Mach-O file generation +Title: "A preview of Mach-O file generation" Author: Sami Samhuri -Date: 20th January, 2010 +Date: "20th January, 2010" Timestamp: 2010-01-20T00:00:00-08:00 Tags: ruby, mach-o, os x, compiler --- diff --git a/posts/2010/01/basics-of-the-mach-o-file-format.md b/posts/2010/01/basics-of-the-mach-o-file-format.md index 90c754d..791f109 100644 --- a/posts/2010/01/basics-of-the-mach-o-file-format.md +++ b/posts/2010/01/basics-of-the-mach-o-file-format.md @@ -1,7 +1,7 @@ --- -Title: Basics of the Mach-O file format +Title: "Basics of the Mach-O file format" Author: Sami Samhuri -Date: 18th January, 2010 +Date: "18th January, 2010" Timestamp: 2010-01-18T00:00:00-08:00 Tags: mach-o, os x, compiler --- @@ -45,17 +45,15 @@ blob of machine code. That blob could be described by a single section named \_\_text, inside a single nameless segment. Here's a diagram showing the layout of such a file:

-
-
+```markdown
             ,---------------------------,
   Header    |  Mach header              |
             |    Segment 1              |
             |      Section 1 (__text)   | --,
             |---------------------------|   |
-  Data      |           blob            | <-'
+  Data      |           blob            | <-'
             '---------------------------'
-
- +```

The Mach Header

@@ -71,7 +69,6 @@ CStruct we define the Mach header like so:

-

Segments

Segments, or segment commands, specify where in memory the @@ -92,7 +89,6 @@ be easy enough to follow.

-

Sections

All sections within a segment are described one after the other @@ -115,7 +111,6 @@ two underscores, e.g. \_\_bss or \_\_text

-

macho.rb

As much of the Mach-O format as we need is defined in @@ -126,7 +121,6 @@ constants as well.

I'll cover symbol tables and relocation tables in my next post.

-

Looking at real Mach-O files

To see the segments and sections of an object file, run @@ -145,7 +139,6 @@ also disassemble the \_\_text section with

You'll get to know otool quite well if you work with Mach-O.

-

Take a break

That was probably a lot to digest, and to make real sense of it you diff --git a/posts/2010/01/working-with-c-style-structs-in-ruby.md b/posts/2010/01/working-with-c-style-structs-in-ruby.md index f2f40aa..cfd474c 100644 --- a/posts/2010/01/working-with-c-style-structs-in-ruby.md +++ b/posts/2010/01/working-with-c-style-structs-in-ruby.md @@ -1,40 +1,18 @@ --- -Title: Working with C-style structs in Ruby +Title: "Working with C-style structs in Ruby" Author: Sami Samhuri -Date: 17th January, 2010 +Date: "17th January, 2010" Timestamp: 2010-01-17T00:00:00-08:00 Tags: ruby, cstruct, compiler --- -This is the beginning of a series on generating Mach-O object files in -Ruby. We start small by introducing some Ruby tools that are useful when -working with binary data. Subsequent articles will cover a subset of the -Mach-O file format, then generating Mach object files suitable for linking -with ld or gcc to produce working executables. A basic knowledge of Ruby and C -are assumed. You can likely wing it on the Ruby side of things if you know any -similar languages. +This is the beginning of a series on generating Mach-O object files in Ruby. We start small by introducing some Ruby tools that are useful when working with binary data. Subsequent articles will cover a subset of the Mach-O file format, then generating Mach object files suitable for linking with ld or gcc to produce working executables. A basic knowledge of Ruby and C are assumed. You can likely wing it on the Ruby side of things if you know any similar languages. -First we need to read and write structured binary files with Ruby. -[Array#pack](http://ruby-doc.org/core/classes/Array.html#M002222) and -[String#unpack](http://ruby-doc.org/core/classes/String.html#M000760) -get the job done at a low level, but every time I use them I have to look up -the documentation. It would also be nice to encapsulate serializing and -deserializing into classes describing the various binary data structures. The -built-in [Struct class](http://ruby-doc.org/core/classes/Struct.html) sounds -promising but did not meet my needs, nor was it easily extended to meet them. +First we need to read and write structured binary files with Ruby. [Array#pack](http://ruby-doc.org/core/classes/Array.html#M002222) and [String#unpack](http://ruby-doc.org/core/classes/String.html#M000760) get the job done at a low level, but every time I use them I have to look up the documentation. It would also be nice to encapsulate serializing and deserializing into classes describing the various binary data structures. The built-in [Struct class](http://ruby-doc.org/core/classes/Struct.html) sounds promising but did not meet my needs, nor was it easily extended to meet them. -Meet [CStruct](https://github.com/samsonjs/compiler/blob/20c758ae85daa5cfa0ad9276c6633b78e982f8b4/asm/cstruct.rb#files), -a class that you can use to describe a binary structure, somewhat similar to -how you would do it in C. Subclassing CStruct results in a class whose -instances can be serialized, and unserialized, with little effort. You can -subclass descendants of CStruct to extend them with additional members. -CStruct does not implement much more than is necessary for the compiler. For -example there is no support for floating point. If you want to use this for -more general purpose tasks be warned that it may require some work. Anything -supported by Array#pack is fairly easy to add though. +Meet [CStruct](https://github.com/samsonjs/compiler/blob/20c758ae85daa5cfa0ad9276c6633b78e982f8b4/asm/cstruct.rb#files), a class that you can use to describe a binary structure, somewhat similar to how you would do it in C. Subclassing CStruct results in a class whose instances can be serialized, and unserialized, with little effort. You can subclass descendants of CStruct to extend them with additional members. CStruct does not implement much more than is necessary for the compiler. For example there is no support for floating point. If you want to use this for more general purpose tasks be warned that it may require some work. Anything supported by Array#pack is fairly easy to add though. -First a quick example and then we'll get into the CStruct class itself. In -C you may write the following to have one struct "inherit" from another: +First a quick example and then we'll get into the CStruct class itself. In C you may write the following to have one struct "inherit" from another: @@ -42,30 +20,16 @@ With CStruct in Ruby that translates to: -CStructs act like Ruby's built-in Struct to a certain extent. They are -instantiated the same way, by passing values to #new in the same order they -are defined in the class. You can find out the size (in bytes) of a CStruct -instance using the #bytesize method, or of any member using #sizeof(name). +CStructs act like Ruby's built-in Struct to a certain extent. They are instantiated the same way, by passing values to #new in the same order they are defined in the class. You can find out the size (in bytes) of a CStruct instance using the #bytesize method, or of any member using #sizeof(name). -The most important method (for us) is #serialize, which returns a binary -string representing the contents of the CStruct. +The most important method (for us) is #serialize, which returns a binary string representing the contents of the CStruct. -(I know that CStruct.new_from_bin should be called CStruct.unserialize, you -can see where my focus was when I wrote it.) +(I know that CStruct.new_from_bin should be called CStruct.unserialize, you can see where my focus was when I wrote it.) -CStruct#serialize automatically creates a "pack pattern", which is an array -of strings used to pack each member in turn. The pack pattern is mapped to the -result of calling Array#pack on each corresponding member, and then the -resulting strings are joined together. Serializing strings complicates matters -so we cannot build up a pack pattern string and then serialize it in one go, -but conceptually it's quite similar. +CStruct#serialize automatically creates a "pack pattern", which is an array of strings used to pack each member in turn. The pack pattern is mapped to the result of calling Array#pack on each corresponding member, and then the resulting strings are joined together. Serializing strings complicates matters so we cannot build up a pack pattern string and then serialize it in one go, but conceptually it's quite similar. -Unserializing is the same process in reverse, and was mainly added for -completeness and testing purposes. +Unserializing is the same process in reverse, and was mainly added for completeness and testing purposes. -That's about all you need to know to use CStruct. The code needs some work -but I decided to just go with what I have already so I can get on with the -more interesting and fun tasks. +That's about all you need to know to use CStruct. The code needs some work but I decided to just go with what I have already so I can get on with the more interesting and fun tasks. *Next in this series: [Basics of the Mach-O file format](/posts/2010/01/basics-of-the-mach-o-file-format)* - diff --git a/posts/2010/11/37signals-chalk-dissected.md b/posts/2010/11/37signals-chalk-dissected.md index c03ed40..a495b3c 100644 --- a/posts/2010/11/37signals-chalk-dissected.md +++ b/posts/2010/11/37signals-chalk-dissected.md @@ -1,7 +1,7 @@ --- -Title: 37signals' Chalk Dissected +Title: "37signals' Chalk Dissected" Author: Sami Samhuri -Date: 4th November, 2010 +Date: "4th November, 2010" Timestamp: 2010-11-04T00:00:00-07:00 Tags: 37signals, chalk, ipad, javascript, web, html, css, zepto.js --- @@ -14,7 +14,8 @@ Tags: 37signals, chalk, ipad, javascript, web, html, css, zepto.js

The manifest is a nice summary of the contents, and allows browsers to cache the app for offline use. Combine this with mobile Safari's "Add to Home Screen" button and you have yourself a free chalkboard app that works offline.

-
CACHE MANIFEST
+```conf
+CACHE MANIFEST
 
 /
 /zepto.min.js
@@ -26,7 +27,7 @@ Tags: 37signals, chalk, ipad, javascript, web, html, css, zepto.js
 /images/chalk-tile-red.png
 /images/chalk-tile-white.png
 /stylesheets/chalk.css
-
+```

Not much there, just 10 requests to fetch the whole thing. 11 including the manifest. In we go.

@@ -170,7 +171,6 @@ chalk-sprites.png

 

-

When the light switch is touched (or clicked) the shade class on the body element is toggled. Nothing to it.

 

diff --git a/posts/2011/11/lights.md b/posts/2011/11/lights.md index 864c578..cfeb60b 100644 --- a/posts/2011/11/lights.md +++ b/posts/2011/11/lights.md @@ -1,9 +1,8 @@ --- -Title: Lights +Title: "Lights" Author: Sami Samhuri -Date: 27th November, 2011 +Date: "27th November, 2011" Timestamp: 2011-11-27T18:11:00-08:00 -Tags: Link: http://lights.elliegoulding.com/ --- diff --git a/posts/2011/11/recovering-old-posts.md b/posts/2011/11/recovering-old-posts.md index ab2bf59..3bb2d31 100644 --- a/posts/2011/11/recovering-old-posts.md +++ b/posts/2011/11/recovering-old-posts.md @@ -1,7 +1,7 @@ --- -Title: Recovering Old Blog Posts +Title: "Recovering Old Blog Posts" Author: Sami Samhuri -Date: 27th November, 2011 +Date: "27th November, 2011" Timestamp: 2011-11-27T01:15:00-08:00 Tags: recover, old, blog, posts --- diff --git a/posts/2011/12/i-see-http.md b/posts/2011/12/i-see-http.md index 4b3cf4c..f1b3ec5 100644 --- a/posts/2011/12/i-see-http.md +++ b/posts/2011/12/i-see-http.md @@ -1,9 +1,8 @@ --- -Title: I see HTTP +Title: "I see HTTP" Author: Sami Samhuri -Date: 15th December, 2011 +Date: "15th December, 2011" Timestamp: 2011-12-15T07:47:15-08:00 -Tags: Link: http://calendar.perfplanet.com/2011/i-see-http/ --- diff --git a/posts/2011/12/my-kind-of-feature-checklist.md b/posts/2011/12/my-kind-of-feature-checklist.md index 28c0634..8a6eca7 100644 --- a/posts/2011/12/my-kind-of-feature-checklist.md +++ b/posts/2011/12/my-kind-of-feature-checklist.md @@ -1,9 +1,8 @@ --- -Title: My kind of feature checklist +Title: "My kind of feature checklist" Author: Sami Samhuri -Date: 19th December, 2011 +Date: "19th December, 2011" Timestamp: 2011-12-19T20:20:05-08:00 -Tags: Link: http://www.marco.org/2011/12/19/amazon-kindle-vs-ipad --- diff --git a/posts/2011/12/new-release-of-firefox-for-android-optimized-for-tablets.md b/posts/2011/12/new-release-of-firefox-for-android-optimized-for-tablets.md index e298fcb..b048634 100644 --- a/posts/2011/12/new-release-of-firefox-for-android-optimized-for-tablets.md +++ b/posts/2011/12/new-release-of-firefox-for-android-optimized-for-tablets.md @@ -1,9 +1,8 @@ --- -Title: New Release of Firefox for Android, Optimized for Tablets +Title: "New Release of Firefox for Android, Optimized for Tablets" Author: Sami Samhuri -Date: 22nd December, 2011 +Date: "22nd December, 2011" Timestamp: 2011-12-25T18:54:11-08:00 -Tags: Link: http://daringfireball.net/linked/2011/12/22/firefox-android --- diff --git a/posts/2011/12/pure-css3-images-hmm-maybe-later.md b/posts/2011/12/pure-css3-images-hmm-maybe-later.md index 2e6dade..df81f9e 100644 --- a/posts/2011/12/pure-css3-images-hmm-maybe-later.md +++ b/posts/2011/12/pure-css3-images-hmm-maybe-later.md @@ -1,9 +1,8 @@ --- -Title: Pure CSS3 images? Hmm, maybe later +Title: "Pure CSS3 images? Hmm, maybe later" Author: Sami Samhuri -Date: 11th December, 2011 +Date: "11th December, 2011" Timestamp: 2011-12-11T12:25:03-08:00 -Tags: Link: http://calendar.perfplanet.com/2011/pure-css3-images-hmm-maybe-later/ --- diff --git a/posts/2011/12/static-url-shortener-using-htaccess.md b/posts/2011/12/static-url-shortener-using-htaccess.md index 2337fc0..d0fd049 100644 --- a/posts/2011/12/static-url-shortener-using-htaccess.md +++ b/posts/2011/12/static-url-shortener-using-htaccess.md @@ -1,7 +1,7 @@ --- -Title: A Static URL Shortener Using .htaccess +Title: "A Static URL Shortener Using .htaccess" Author: Sami Samhuri -Date: 10th December, 2011 +Date: "10th December, 2011" Timestamp: 2011-12-10T22:29:09-08:00 Tags: s42.ca, url, shortener, samhuri.net, url shortener --- diff --git a/posts/2011/12/the-broken-pixel-theory.md b/posts/2011/12/the-broken-pixel-theory.md index 969cf1a..f575d16 100644 --- a/posts/2011/12/the-broken-pixel-theory.md +++ b/posts/2011/12/the-broken-pixel-theory.md @@ -1,9 +1,8 @@ --- -Title: The Broken Pixel Theory +Title: "The Broken Pixel Theory" Author: Sami Samhuri -Date: 25th December, 2011 +Date: "25th December, 2011" Timestamp: 2011-12-25T18:54:20-08:00 -Tags: Link: http://jtaby.com/2011/12/25/the-broken-pixel-theory.html --- diff --git a/posts/2012/01/fujitsu-has-lost-their-mind.md b/posts/2012/01/fujitsu-has-lost-their-mind.md index 9815063..2597d86 100644 --- a/posts/2012/01/fujitsu-has-lost-their-mind.md +++ b/posts/2012/01/fujitsu-has-lost-their-mind.md @@ -1,9 +1,8 @@ --- -Title: Fujitsu has lost their mind +Title: "Fujitsu has lost their mind" Author: Sami Samhuri -Date: 19th January, 2012 +Date: "19th January, 2012" Timestamp: 2012-01-19T20:05:33-08:00 -Tags: Link: http://tablet-news.com/2012/01/17/fujitsu-lifebook-2013-concept-incorporates-a-tablet-for-a-keyboard-phone-and-digital-camera/ --- diff --git a/posts/2012/01/recovering-from-a-computer-science-education.md b/posts/2012/01/recovering-from-a-computer-science-education.md index f61dadb..8d3a70f 100644 --- a/posts/2012/01/recovering-from-a-computer-science-education.md +++ b/posts/2012/01/recovering-from-a-computer-science-education.md @@ -1,9 +1,8 @@ --- -Title: Recovering From a Computer Science Education +Title: "Recovering From a Computer Science Education" Author: Sami Samhuri -Date: 17th January, 2012 +Date: "17th January, 2012" Timestamp: 2012-01-17T00:00:00-08:00 -Tags: Link: http://prog21.dadgum.com/123.html --- diff --git a/posts/2012/01/sopa-lives-and-mpaa-calls-protests-an-abuse-of-power.md b/posts/2012/01/sopa-lives-and-mpaa-calls-protests-an-abuse-of-power.md index 5f4bada..c2a48e4 100644 --- a/posts/2012/01/sopa-lives-and-mpaa-calls-protests-an-abuse-of-power.md +++ b/posts/2012/01/sopa-lives-and-mpaa-calls-protests-an-abuse-of-power.md @@ -1,9 +1,8 @@ --- -Title: SOPA lives - and MPAA calls protests an "abuse of power" +Title: "SOPA lives - and MPAA calls protests an \"abuse of power\"" Author: Sami Samhuri -Date: 17th January, 2012 +Date: "17th January, 2012" Timestamp: 2012-01-17T02:46:40-08:00 -Tags: Link: http://arstechnica.com/tech-policy/news/2012/01/sopa-livesand-mpaa-calls-protests-an-abuse-of-power.ars --- diff --git a/posts/2012/01/the-40-standup-desk.md b/posts/2012/01/the-40-standup-desk.md index b1a9f32..12ab2ed 100644 --- a/posts/2012/01/the-40-standup-desk.md +++ b/posts/2012/01/the-40-standup-desk.md @@ -1,9 +1,8 @@ --- -Title: The $40 Standup Desk +Title: "The $40 Standup Desk" Author: Sami Samhuri -Date: 9th January, 2012 +Date: "9th January, 2012" Timestamp: 2012-01-09T00:16:40-08:00 -Tags: Link: http://opensoul.org/blog/archives/2012/01/09/the-40-standup-desk/ --- diff --git a/posts/2012/01/yak-shaving.md b/posts/2012/01/yak-shaving.md index f1cd90d..60f6ec5 100644 --- a/posts/2012/01/yak-shaving.md +++ b/posts/2012/01/yak-shaving.md @@ -1,9 +1,8 @@ --- -Title: Yak shaving +Title: "Yak shaving" Author: Sami Samhuri -Date: 4th January, 2012 +Date: "4th January, 2012" Timestamp: 2012-01-04T13:24:00-08:00 -Tags: Link: http://blog.hasmanythrough.com/2012/1/4/yak-shaving --- diff --git a/posts/2013/03/zelda-tones-for-ios.md b/posts/2013/03/zelda-tones-for-ios.md index 9d185ec..b568ebf 100644 --- a/posts/2013/03/zelda-tones-for-ios.md +++ b/posts/2013/03/zelda-tones-for-ios.md @@ -1,7 +1,7 @@ --- -Title: Zelda Tones for iOS +Title: "Zelda Tones for iOS" Author: Sami Samhuri -Date: 6th March, 2013 +Date: "6th March, 2013" Timestamp: 2013-03-06T18:51:13-08:00 Tags: zelda, nintendo, pacman, ringtones, tones, ios --- diff --git a/posts/2013/09/linky.md b/posts/2013/09/linky.md index 848e36e..9b6a99a 100644 --- a/posts/2013/09/linky.md +++ b/posts/2013/09/linky.md @@ -1,7 +1,7 @@ --- -Title: Linky +Title: "Linky" Author: Sami Samhuri -Date: 27th September, 2013 +Date: "27th September, 2013" Timestamp: 2013-09-27T21:49:02-07:00 Tags: linky, north watcher, ruby, gmail, links, notifications --- @@ -35,17 +35,23 @@ Yup, that is a lot of moving parts. It is rather elegant in a [Unixy way](http:/ For example, the following lines would be created in a file at `~/Dropbox/Linky/Ruxton/.txt` for my machine named [Ruxton](http://en.wikipedia.org/wiki/Ruxton_Island). - Callbacks as our Generations' Go To Statement - http://tirania.org/blog/archive/2013/Aug-15.html +```markdown +Callbacks as our Generations' Go To Statement +http://tirania.org/blog/archive/2013/Aug-15.html +``` The filename field is defined as: - {FromAddress}-{ReceivedAt} +```conf +{FromAddress}-{ReceivedAt} +``` And the content is: - {Subject}
- {BodyPlain}
+```conf +{Subject}
+{BodyPlain}
+``` That means that when you email links, the subject should contain the title and the body should contain the link on the first line. It's ok if there's stuff after the body (like your signature), they will be ignored later. @@ -63,7 +69,9 @@ This is a quick and dirty thing I whipped up a couple of years ago, and now it's It has a text configuration file kind of like [cron](http://en.wikipedia.org/wiki/Cron). Here's mine from Ruxton: - + Dropbox/Linky/Ruxton ruby /Users/sjs/bin/linky-notify +```shell ++ Dropbox/Linky/Ruxton ruby /Users/sjs/bin/linky-notify +``` That tells NorthWatcher to run `ruby /Users/sjs/bin/linky-notify` when files are added to the directory `~/Dropbox/Linky/Ruxton`. @@ -80,4 +88,3 @@ You can get `terminal-notifier` with [homebrew](http://brew.sh) in a few seconds ## Cool story, bro It may not be exciting, but as someone who typically suffers from [NIH syndrome](http://en.wikipedia.org/wiki/Not_invented_here) and writes too much from scratch, I found it pretty rewarding to cobble something seemingly complicated together with a bunch of existing components. It didn't take very long and only involved about 10 lines of code. It's not exactly what I wanted but it's surprisingly close. Success! - diff --git a/posts/2014/02/ember-structure.md b/posts/2014/02/ember-structure.md index 7f771a2..cb6a56f 100644 --- a/posts/2014/02/ember-structure.md +++ b/posts/2014/02/ember-structure.md @@ -1,7 +1,7 @@ --- -Title: Structure of an Ember app +Title: "Structure of an Ember app" Author: Sami Samhuri -Date: 3rd February, 2014 +Date: "3rd February, 2014" Timestamp: 2014-02-03T18:05:49-08:00 Tags: ember.js --- diff --git a/posts/2015/05/a-bitcoin-miner-in-every-device-and-in-every-hand.md b/posts/2015/05/a-bitcoin-miner-in-every-device-and-in-every-hand.md index 6cf4d89..192cc3c 100644 --- a/posts/2015/05/a-bitcoin-miner-in-every-device-and-in-every-hand.md +++ b/posts/2015/05/a-bitcoin-miner-in-every-device-and-in-every-hand.md @@ -1,9 +1,8 @@ --- -Title: A bitcoin miner in every device and in every hand +Title: "A bitcoin miner in every device and in every hand" Author: Sami Samhuri -Date: 19th May, 2015 +Date: "19th May, 2015" Timestamp: 2015-05-18T19:53:54-07:00 -Tags: Link: https://medium.com/@21dotco/a-bitcoin-miner-in-every-device-and-in-every-hand-e315b40f2821 --- diff --git a/posts/2015/05/apple-watch-human-interface-guidelines.md b/posts/2015/05/apple-watch-human-interface-guidelines.md index 6c168b1..3de1b91 100644 --- a/posts/2015/05/apple-watch-human-interface-guidelines.md +++ b/posts/2015/05/apple-watch-human-interface-guidelines.md @@ -1,9 +1,8 @@ --- -Title: Apple Watch Human Interface Guidelines +Title: "Apple Watch Human Interface Guidelines" Author: Sami Samhuri -Date: 10th May, 2015 +Date: "10th May, 2015" Timestamp: 2015-05-09T18:57:19-07:00 -Tags: Link: https://developer.apple.com/watch/human-interface-guidelines/ --- diff --git a/posts/2015/05/constraints-and-transforms-in-ios-8.md b/posts/2015/05/constraints-and-transforms-in-ios-8.md index c92aaf2..43ac907 100644 --- a/posts/2015/05/constraints-and-transforms-in-ios-8.md +++ b/posts/2015/05/constraints-and-transforms-in-ios-8.md @@ -1,9 +1,8 @@ --- -Title: Constraints and Transforms in iOS 8 +Title: "Constraints and Transforms in iOS 8" Author: Sami Samhuri -Date: 15th May, 2015 +Date: "15th May, 2015" Timestamp: 2015-05-15T07:26:35-07:00 -Tags: Link: http://revealapp.com/blog/constraints-and-transforms.html --- diff --git a/posts/2015/05/github-flow-like-a-pro.md b/posts/2015/05/github-flow-like-a-pro.md index e275370..9a77f1d 100644 --- a/posts/2015/05/github-flow-like-a-pro.md +++ b/posts/2015/05/github-flow-like-a-pro.md @@ -1,9 +1,8 @@ --- -Title: GitHub Flow Like a Pro +Title: "GitHub Flow Like a Pro" Author: Sami Samhuri -Date: 28th May, 2015 +Date: "28th May, 2015" Timestamp: 2015-05-28T07:42:27-07:00 -Tags: Link: http://haacked.com/archive/2014/07/28/github-flow-aliases/ --- diff --git a/posts/2015/05/importing-modules-in-lldb.md b/posts/2015/05/importing-modules-in-lldb.md index beb74dd..52921cc 100644 --- a/posts/2015/05/importing-modules-in-lldb.md +++ b/posts/2015/05/importing-modules-in-lldb.md @@ -1,9 +1,8 @@ --- -Title: Importing Modules in LLDB +Title: "Importing Modules in LLDB" Author: Sami Samhuri -Date: 12th May, 2015 +Date: "12th May, 2015" Timestamp: 2015-05-11T19:03:35-07:00 -Tags: Link: http://furbo.org/2015/05/11/an-import-ant-change-in-xcode/ --- diff --git a/posts/2015/05/lenovo-thinkpad-x1-carbon.md b/posts/2015/05/lenovo-thinkpad-x1-carbon.md index 95e4b29..f1c5a51 100644 --- a/posts/2015/05/lenovo-thinkpad-x1-carbon.md +++ b/posts/2015/05/lenovo-thinkpad-x1-carbon.md @@ -1,9 +1,8 @@ --- -Title: Lenovo ThinkPad X1 Carbon +Title: "Lenovo ThinkPad X1 Carbon" Author: Sami Samhuri -Date: 22nd May, 2015 +Date: "22nd May, 2015" Timestamp: 2015-05-21T17:36:29-07:00 -Tags: Link: http://www.anandtech.com/show/9264/the-lenovo-thinkpad-x1-carbon-review-2015 --- diff --git a/posts/2015/05/magical-wristband.md b/posts/2015/05/magical-wristband.md index 40342c9..c16a82b 100644 --- a/posts/2015/05/magical-wristband.md +++ b/posts/2015/05/magical-wristband.md @@ -1,9 +1,8 @@ --- -Title: Magical Wristband +Title: "Magical Wristband" Author: Sami Samhuri -Date: 27th May, 2015 +Date: "27th May, 2015" Timestamp: 2015-05-26T22:17:29-07:00 -Tags: Link: http://www.wired.com/2015/03/disney-magicband/ --- diff --git a/posts/2015/05/undocumented-corestorage-commands.md b/posts/2015/05/undocumented-corestorage-commands.md index 2f1a325..97dcc80 100644 --- a/posts/2015/05/undocumented-corestorage-commands.md +++ b/posts/2015/05/undocumented-corestorage-commands.md @@ -1,9 +1,8 @@ --- -Title: Undocumented CoreStorage Commands +Title: "Undocumented CoreStorage Commands" Author: Sami Samhuri -Date: 24th May, 2015 +Date: "24th May, 2015" Timestamp: 2015-05-23T19:58:36-07:00 -Tags: Link: http://blog.fosketts.net/2011/08/05/undocumented-corestorage-commands/ --- diff --git a/posts/2015/06/debugging-layouts-with-recursive-view-descriptions-in-xcode.md b/posts/2015/06/debugging-layouts-with-recursive-view-descriptions-in-xcode.md index c4a79d2..f5f1fc8 100644 --- a/posts/2015/06/debugging-layouts-with-recursive-view-descriptions-in-xcode.md +++ b/posts/2015/06/debugging-layouts-with-recursive-view-descriptions-in-xcode.md @@ -1,9 +1,8 @@ --- -Title: Debugging Layouts with Recursive View Descriptions in Xcode +Title: "Debugging Layouts with Recursive View Descriptions in Xcode" Author: Sami Samhuri -Date: 2nd June, 2015 +Date: "2nd June, 2015" Timestamp: 2015-06-02T16:35:35-07:00 -Tags: Link: http://jeffreysambells.com/2013/01/24/debugging-layouts-with-recursive-view-descriptions-in-xcode --- diff --git a/posts/2015/06/the-unofficial-guide-to-xcconfig-files.md b/posts/2015/06/the-unofficial-guide-to-xcconfig-files.md index e4da317..093614c 100644 --- a/posts/2015/06/the-unofficial-guide-to-xcconfig-files.md +++ b/posts/2015/06/the-unofficial-guide-to-xcconfig-files.md @@ -1,9 +1,8 @@ --- -Title: The Unofficial Guide to xcconfig files +Title: "The Unofficial Guide to xcconfig files" Author: Sami Samhuri -Date: 1st June, 2015 +Date: "1st June, 2015" Timestamp: 2015-06-01T08:16:51-07:00 -Tags: Link: http://pewpewthespells.com/blog/xcconfig_guide.html?utm_campaign=iOS%2BDev%2BWeekly&utm_source=iOS_Dev_Weekly_Issue_200 --- diff --git a/posts/2015/07/scripts-to-rule-them-all.md b/posts/2015/07/scripts-to-rule-them-all.md index 6b0119c..c2150a1 100644 --- a/posts/2015/07/scripts-to-rule-them-all.md +++ b/posts/2015/07/scripts-to-rule-them-all.md @@ -1,9 +1,8 @@ --- -Title: Scripts to Rule Them All +Title: "Scripts to Rule Them All" Author: Sami Samhuri -Date: 1st July, 2015 +Date: "1st July, 2015" Timestamp: 2015-07-01T07:37:04-07:00 -Tags: Link: http://githubengineering.com/scripts-to-rule-them-all/ --- diff --git a/posts/2015/07/swift-new-stuff-in-xcode-7-beta-3.md b/posts/2015/07/swift-new-stuff-in-xcode-7-beta-3.md index 92e0715..371dbbd 100644 --- a/posts/2015/07/swift-new-stuff-in-xcode-7-beta-3.md +++ b/posts/2015/07/swift-new-stuff-in-xcode-7-beta-3.md @@ -1,9 +1,8 @@ --- -Title: Swift: New stuff in Xcode 7 Beta 3 +Title: "Swift: New stuff in Xcode 7 Beta 3" Author: Sami Samhuri -Date: 9th July, 2015 +Date: "9th July, 2015" Timestamp: 2015-07-09T09:17:13-07:00 -Tags: Link: http://ericasadun.com/2015/07/08/swift-new-stuff-in-xcode-7-beta-3/ --- diff --git a/posts/2015/08/acorn-5s-live-help-search.md b/posts/2015/08/acorn-5s-live-help-search.md index 5159e57..84687fc 100644 --- a/posts/2015/08/acorn-5s-live-help-search.md +++ b/posts/2015/08/acorn-5s-live-help-search.md @@ -1,9 +1,8 @@ --- -Title: Acorn 5's Live Help Search +Title: "Acorn 5's Live Help Search" Author: Sami Samhuri -Date: 25th August, 2015 +Date: "25th August, 2015" Timestamp: 2015-08-24T22:00:27-07:00 -Tags: Link: http://shapeof.com/archives/2015/8/acorn_5_search_index.html --- diff --git a/posts/2015/08/cloaks-updated-privacy-policy.md b/posts/2015/08/cloaks-updated-privacy-policy.md index b9a3077..099e7f8 100644 --- a/posts/2015/08/cloaks-updated-privacy-policy.md +++ b/posts/2015/08/cloaks-updated-privacy-policy.md @@ -1,9 +1,8 @@ --- -Title: Cloak's Updated Privacy Policy +Title: "Cloak's Updated Privacy Policy" Author: Sami Samhuri -Date: 27th August, 2015 +Date: "27th August, 2015" Timestamp: 2015-08-26T19:56:54-07:00 -Tags: Link: https://blog.getcloak.com/2015/08/25/updated-privacy-policy/ --- diff --git a/posts/2016/03/moving-beyond-the-oop-obsession.md b/posts/2016/03/moving-beyond-the-oop-obsession.md index fd3cb3a..89148bb 100644 --- a/posts/2016/03/moving-beyond-the-oop-obsession.md +++ b/posts/2016/03/moving-beyond-the-oop-obsession.md @@ -1,9 +1,8 @@ --- -Title: Moving Beyond the OOP Obsession +Title: "Moving Beyond the OOP Obsession" Author: Sami Samhuri -Date: 28th March, 2016 +Date: "28th March, 2016" Timestamp: 2016-03-28T09:08:47-07:00 -Tags: Link: http://prog21.dadgum.com/218.html --- diff --git a/posts/2016/03/reduce-the-cognitive-load-of-your-code.md b/posts/2016/03/reduce-the-cognitive-load-of-your-code.md index 5311ff4..397cc94 100644 --- a/posts/2016/03/reduce-the-cognitive-load-of-your-code.md +++ b/posts/2016/03/reduce-the-cognitive-load-of-your-code.md @@ -1,9 +1,8 @@ --- -Title: Reduce the cognitive load of your code +Title: "Reduce the cognitive load of your code" Author: Sami Samhuri -Date: 30th March, 2016 +Date: "30th March, 2016" Timestamp: 2016-03-30T07:10:29-07:00 -Tags: Link: http://chrismm.com/blog/how-to-reduce-the-cognitive-load-of-your-code/ --- diff --git a/posts/2016/04/tales-of-prk-laser-eye-surgery.md b/posts/2016/04/tales-of-prk-laser-eye-surgery.md index c7c5f5c..6acbade 100644 --- a/posts/2016/04/tales-of-prk-laser-eye-surgery.md +++ b/posts/2016/04/tales-of-prk-laser-eye-surgery.md @@ -1,9 +1,8 @@ --- -Title: Tales of PRK Laser Eye Surgery +Title: "Tales of PRK Laser Eye Surgery" Author: Sami Samhuri -Date: 12th April, 2016 +Date: "12th April, 2016" Timestamp: 2016-04-11T20:52:53-07:00 -Tags: --- Today I scheduled PRK laser eye surgery on April 19th. Exciting but also kind of terrifying because the procedure sounds a bit horrific. Most accounts from people don't sound very bad though so the operation itself should be a breeze! I scoured the web for PRK recovery stories to get an idea of what I was in for and found some good quotes. diff --git a/posts/2016/08/easy-optimization-wins.md b/posts/2016/08/easy-optimization-wins.md index edfcfd6..22289fa 100644 --- a/posts/2016/08/easy-optimization-wins.md +++ b/posts/2016/08/easy-optimization-wins.md @@ -1,7 +1,7 @@ --- -Title: Easy Optimization Wins +Title: "Easy Optimization Wins" Author: Sami Samhuri -Date: 10th August, 2016 +Date: "10th August, 2016" Timestamp: 2016-08-10T10:30:49-07:00 Tags: ios, git --- @@ -10,7 +10,7 @@ It's not hard to hide a whole lot of complexity behind a function call, so you h Here's some example code illustrating a big performance problem I found in a codebase I've inherited. We have a dictionary keyed by a string representing a date, e.g. "2016-08-10", and where the values are arrays of videos for that given date. Due to some unimportant product details videos can actually appear in more than one of the array values. The goal is to get an array of all videos, sorted by date, and with no duplicates. So we need to discard duplicates when building the sorted array. -```Swift +```swift func allVideosSortedByDate(allVideos: [String:[Video]]) -> [Video] { var sortedVideos: [Video] = [] // sort keys newest first @@ -32,7 +32,7 @@ Because this is being called from within a loop that's already looping over all In this particular case my first instinct is to reach for a set. We want a collection of all the videos and want to ensure that they're unique, and that's what sets are for. So what about sorting? Well we can build up the set of all videos, then sort that set, converting it to an array in the process. Sounds like a lot of work right? Is it really faster? Let's see what it looks like. -```Swift +```swift func allVideosSortedByDate(allVideos: [String:[Video]]) -> [Video] { var uniqueVideos: Set