halbuilder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8aef0833d5b98f1f2be71e2734b74f2ac39e9a403bdaacd698759fc99a59ba68
+  data.tar.gz: d49275d798a0a73ffb68ca951ec045490e5b0d491f9e3ef86ac4c3aceb5f30cb
+SHA512:
+  metadata.gz: c470bcb51e9e4c1fea988533afdf86273dc8f1ddab377809e0e402ebb385289f755887098f3adae717f472dd039d937b309afcbb3dfc4f3b1eb9866cbe1e2a02
+  data.tar.gz: 7ff41ec9985d74868b82c3a7b027d75856df927ea94ea449d3aad0477238d2746fc021f98a0e8cb88ccc381bbb97d51ca116e49c63c1c9594d41661e32d5193c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-20
+
+Initial release, including:
+
+- Key formatting options
+- `json.hal_link!` href/block support
+- `json.hal_embed!` lambda/block support
+- `json.hal_paginate!` total/count/links
+- `?zoom=` param parsing for embedded objects/collections

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ryancavis@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in halbuilder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "standard", "~> 1.3"
+gem "pry", "~> 0.13.1"

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    halbuilder (0.1.0)
+      jbuilder (>= 2.0.0)
+      kaminari (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (6.1.6.1)
+      activesupport (= 6.1.6.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activerecord (6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.10.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jbuilder (2.11.5)
+      actionview (>= 5.0.0)
+      activesupport (>= 5.0.0)
+    json (2.6.2)
+    kaminari (1.2.2)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.2)
+      kaminari-activerecord (= 1.2.2)
+      kaminari-core (= 1.2.2)
+    kaminari-actionview (1.2.2)
+      actionview
+      kaminari-core (= 1.2.2)
+    kaminari-activerecord (1.2.2)
+      activerecord
+      kaminari-core (= 1.2.2)
+    kaminari-core (1.2.2)
+    loofah (2.18.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.16.2)
+    nokogiri (1.13.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.7-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.3)
+      loofah (~> 2.3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.31.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.13.0)
+      rubocop (= 1.31.2)
+      rubocop-performance (= 1.14.3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  halbuilder!
+  pry (~> 0.13.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 PRX
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,252 @@
+# Halbuilder
+
+[![license](https://img.shields.io/github/license/PRX/halbuilder.svg)](LICENSE)
+[![Gem](https://img.shields.io/gem/v/halbuilder)](https://rubygems.org/gems/halbuilder)
+[![Gem](https://img.shields.io/gem/dt/halbuilder)](https://rubygems.org/gems/halbuilder)
+![RSpec](https://github.com/PRX/halbuilder/workflows/RSpec/badge.svg)
+![Standard](https://github.com/PRX/halbuilder/workflows/Standard/badge.svg)
+
+[Hypertext Application Language](https://en.wikipedia.org/wiki/Hypertext_Application_Language) (HAL)
+specific extensions for [Jbuilder](https://github.com/rails/jbuilder).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add halbuilder
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install halbuilder
+
+## Configuration
+
+To customize Halbuilder, create an initializer in your Rails app at `config/initializers/halbuilder.rb`.
+Or if not using Rails, you can really configure this gem from anywhere:
+
+```ruby
+# config/initializers/halbuilder.rb
+
+Halbuilder.configure do |config|
+  config.key_format = :camelize_lower
+end
+```
+
+Available configurations are:
+
+- `key_format` (default `:camelize_lower`) - the key format used for [Jbuilder formatting keys](https://github.com/rails/jbuilder#formatting-keys)
+  - This gem always formats nested keys
+  - Allowed values are: `nil` `:underscore` `:dasherize` `:camelize_lower` `:camelize_upper`
+- `link_namespace` (default `nil`) - allow namespacing links in a way that breaks `key_format`
+  - Can be any alphanumeric string
+  - E.g. `"hello"` would cause `json.hello_world "val"` to generate `{"hello:world":"val"}`.
+- `link_format` (default `:dasherize`) - format namespaced links differently from `key_format`
+  - Only applies if you set a non-nil `link_namespace`
+  - Same allowed values as `key_format`
+  - E.g. `:dasherize` would cause `json.hello_world_there "val"` to generate `{"hello:world-there":"val"}`
+
+## Usage
+
+This library strives to be low-to-moderately opinionated about how you format your
+Jbuilder views. And there will always be many ways to build the same output. But - here are some general patterns for creating HAL JSON APIs.
+
+### Links
+
+The HAL `_links` object can be generated from anywhere within your `*.json.jbuilder` template,
+and given either a plain string href or yield a block object:
+
+```ruby
+# just a string href
+json.hal_link! "hello:one", "/api/v1/hello-one"
+
+# or a block
+json.hal_link! 'second' do
+  json.href "/api/v1/second"
+  json.title "my title"
+end
+
+# or manually add a link
+json._links do
+  json.third_link do
+    json.href "/api/v1/thr33"
+  end
+end
+```
+
+```json
+{
+  "_links": {
+    "hello:one": {
+      "href": "/api/v1/hello-one"
+    },
+    "second": {
+      "href": "/api/v1/second",
+      "title": "my title"
+    },
+    "thirdLink": {
+      "href": "/api/v1/thr33"
+    }
+  }
+}
+```
+
+### Embeds
+
+One convention for speeding up HAL APIs is to embed linked resources into the same documents.
+For this, we use the `_embedded` top level key, followed by the same `rel` as the link, and
+the object or array of objects (or null) you would get back had you followed the link.
+
+```ruby
+json.hal_embed! "hello:one" do
+  json.id 1234
+  json.title "Some Resource"
+end
+
+json.hal_embed! "hello:two", 1..3 do |num|
+  json.id num
+  json.title "Thing #{num}"
+end
+```
+
+```json
+{
+  "_embedded": {
+    "hello:one": {
+      "id": 1234,
+      "title": "Some Resource"
+    },
+    "hello:two": [
+      {
+        "id": 1,
+        "title": "Thing 1"
+      },
+      {
+        "id": 2,
+        "title": "Thing 2"
+      },
+      {
+        "id": 3,
+        "title": "Thing 3"
+      }
+    ]
+  }
+}
+```
+
+Note that after the name of the `rel`, you can optionally pass a collection to iterate
+over. You can also pass a lambda, just-in-time returning either an object or collection
+to render:
+
+```ruby
+json.hal_embed! "hello:one", -> { {id: 1234, title: "Some Resource"} } do |obj|
+  json.id obj[:id]
+  json.title obj[:title]
+end
+
+json.hal_embed! "hello:two", -> { 1..3 } do |num|
+  json.id num
+  json.title "Thing #{num}"
+end
+```
+
+This works in conjunction with the `?zoom=` query parameter. By passing `zoom: true` to
+a `hal_embed!` we indicate that by default, we want to render this collection. Or passing
+`zoom: false` indicates not to render it.
+
+```ruby
+# GET /api/v1/resource
+
+json.hal_embed! "hello:one", zoom: false do
+  title "This will not render"
+end
+
+json.hal_embed! "hello:two", zoom: true do
+  title "This WILL render"
+end
+```
+
+Passing `?zoom=1` or `?zoom=0` will result in _ALL_ `hal_embed!`s in the view being
+rendered or not rendered, regardless of their defaults.
+
+Passing `?zoom=hello:one,hello:two` will result in just those 2 rels being rendered,
+but any other `hal_embed!` with a `zoom:` will not be. This can be used in conjunction
+with lambdas/blocks to only load data needed for the requested zoom level:
+
+```ruby
+# GET /api/v1/resource?zoom=hello:one,hello:two
+
+json.hal_embed! "hello:one", zoom: false do
+  # this code will run and render
+  title some_expensive_db.get_title
+end
+
+json.hal_embed! "hello:two", -> { some_expensive_db.fetch_two }, zoom: true do |thing|
+  # this code will also run and render
+  title thing.title
+end
+
+json.hal_embed! "hello:three", -> { some_expensive_db.fetch_three }, zoom: true do |thing|
+  # this code will NOT run the expensive db operation, OR render
+  title thing.title
+end
+
+json.hal_embed! "hello:four", zoom: true do
+  # this code will not run or render
+  title some_expensive_db.get_title
+end
+```
+
+### Pagination
+
+It's often useful to parse query params and render `_links` to different collection pages,
+using the gem [Kaminari](https://github.com/kaminari/kaminari). After paging the collection in
+your controller, just call `hal_paginate!` on it:
+
+```ruby
+# GET /api/v1/things?foo=bar&page=3
+
+json.hal_paginate! @things
+```
+
+```json
+{
+  "count": 10,
+  "total": 999,
+  "_links": {
+    "first": {
+      "href": "/api/v1/accounts?foo=bar"
+    },
+    "prev": {
+      "href": "/api/v1/accounts?foo=bar&page=2"
+    },
+    "next": {
+      "href": "/api/v1/accounts?foo=bar&page=4"
+    },
+    "last": {
+      "href": "/api/v1/accounts?foo=bar&page=100"
+    }
+  }
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+Before commiting any code, run `rake standardrb` and/or `rake standardrb --fix` to make sure your changes are compliant with the [Standard](https://github.com/testdouble/standard) style guide.
+
+When you're ready to push changes, open a pull request against the `main branch` of the repo.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PRX/halbuilder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/PRX/halbuilder/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Halbuilder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/PRX/halbuilder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/halbuilder.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/halbuilder/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "halbuilder"
+  spec.version = Halbuilder::VERSION
+  spec.authors = ["cavis"]
+  spec.email = ["ryan@prx.org"]
+
+  spec.summary = "HAL DSL extensions for Jbuilder."
+  spec.homepage = "https://github.com/PRX/halbuilder"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/PRX/halbuilder"
+  spec.metadata["changelog_uri"] = "https://github.com/PRX/halbuilder/blob/main/CHANGELOG.md"
+  spec.metadata["bug_tracker_uri"] = "https://github.com/PRX/halbuilder/issues"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "jbuilder", ">= 2.0.0"
+  spec.add_dependency "kaminari", ">= 1.0.0"
+end

data/lib/halbuilder/configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "jbuilder"
+
+module Halbuilder
+  class Configuration
+    attr_reader :link_key, :embed_key
+    attr_accessor :key_format, :link_namespace, :link_format
+
+    def initialize
+      @link_key = "_links"
+      @embed_key = "_embedded"
+      @key_format = :camelize_lower
+      @link_namespace = nil
+      @link_format = :dasherize
+    end
+  end
+end

data/lib/halbuilder/embed.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Halbuilder::Embed
+  def hal_embed!(rel, *args, &block)
+    collection = :not_provided
+    opts = {}
+
+    # first arg may optionally be an iterable collection
+    if args.count > 1
+      collection = args[0]
+      opts = args[1]
+    elsif args[0].is_a?(Hash)
+      # NOTE: we don't allow passing a _non_ options hash as the only argument
+      opts = args[0]
+    elsif args.length > 0
+      collection = args[0]
+    end
+
+    # check if we're zooming before rendering anything
+    if hal_zoomed?(rel, opts[:zoom])
+      set! Halbuilder.configuration.embed_key do
+        set! rel do
+          # only load collection from proc after deciding to zoom
+          collection = collection.call if collection.is_a?(Proc)
+
+          # iterate block, or render explicit nulls
+          if collection.respond_to?(:each) && !collection.is_a?(Hash)
+            array! collection do |c|
+              block.call(c)
+            end
+          elsif collection.present? || collection == :not_provided
+            block.call(collection)
+          else
+            null!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/halbuilder/key_format.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Halbuilder::KeyFormat
+  class << self
+    def setup
+      ::Jbuilder.deep_format_keys(true)
+
+      ::Jbuilder.key_format ->(key) do
+        key_format = Halbuilder.configuration.key_format
+        link_format = Halbuilder.configuration.link_format
+        link_key = Halbuilder.configuration.link_key
+        embed_key = Halbuilder.configuration.embed_key
+
+        ns = Halbuilder.configuration.link_namespace
+        ns_start = "#{ns}_" if ns.present?
+        ns_length = ns_start.length if ns.present?
+
+        if key == link_key || key == embed_key
+          key
+        elsif ns_start && key.start_with?(ns_start)
+          format_key("#{ns}:#{key[ns_length..]}", link_format)
+        else
+          format_key(key, key_format)
+        end
+      end
+    end
+
+    private
+
+    def format_key(key, format)
+      if format.nil?
+        key
+      elsif format == :underscore
+        key.underscore
+      elsif format == :dasherize
+        key.dasherize
+      elsif format == :camelize_lower
+        key.camelize(:lower)
+      elsif format == :camelize_upper
+        key.camelize(:upper)
+      else
+        raise Halbuilder::Error.new("Unknown key format: #{format}")
+      end
+    end
+  end
+end

data/lib/halbuilder/link.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Halbuilder::Link
+  def hal_link!(rel, val = nil, &block)
+    set! Halbuilder.configuration.link_key do
+      if block.present?
+        set! rel do
+          block.call
+        end
+      elsif val.is_a?(String)
+        set! rel do
+          href val
+        end
+      else
+        raise Halbuilder::Error.new("Invalid hal link: #{href.inspect}")
+      end
+    end
+  end
+end

data/lib/halbuilder/paginate.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Halbuilder::Paginate
+  def hal_paginate!(collection)
+    return unless paginated?(collection)
+
+    set!("count", collection.size)
+    set!("total", collection.total_count)
+    _links do
+      hal_paginate_links!(collection)
+    end
+  end
+
+  def hal_paginate_links!(rel)
+    set!("first", page_href(1)) unless rel.first_page?
+    set!("prev", page_href(rel.prev_page)) unless rel.first_page?
+    set!("next", page_href(rel.next_page)) unless rel.last_page?
+    set!("last", page_href(rel.total_pages)) unless rel.last_page?
+  end
+
+  private
+
+  def paginated?(rel)
+    if rel
+      rel.respond_to?(:current_page) && rel.respond_to?(:total_pages)
+    end
+  end
+
+  def page_href(num)
+    query =
+      if num == 1
+        @context.request.query_parameters.except("page")
+      else
+        @context.request.query_parameters.tap { |q| q["page"] = num }
+      end
+
+    query_str = ::URI.encode_www_form(query)
+    if query_str.present?
+      {href: "#{@context.request.path}?#{query_str}"}
+    else
+      {href: @context.request.path}
+    end
+  end
+end

data/lib/halbuilder/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Halbuilder
+  VERSION = "0.1.0"
+end

data/lib/halbuilder/zoom.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Halbuilder::Zoom
+  TRUTHY = [true, "true", "TRUE", 1, "1"]
+  FALSEY = [false, "false", "FALSE", 0, "0"]
+
+  def hal_zoomed?(rel, default_setting)
+    if default_setting.nil?
+      true
+    elsif zoom_param.nil?
+      default_setting
+    elsif TRUTHY.include?(zoom_param)
+      true
+    elsif FALSEY.include?(zoom_param)
+      false
+    else
+      zoom_rels.include?(rel)
+    end
+  end
+
+  private
+
+  def zoom_param
+    @context.params[:zoom]
+  end
+
+  def zoom_rels
+    zoom_param.is_a?(Array) ? zoom_param : zoom_param.split(",")
+  end
+end

data/lib/halbuilder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "jbuilder"
+require_relative "halbuilder/configuration"
+require_relative "halbuilder/embed"
+require_relative "halbuilder/key_format"
+require_relative "halbuilder/link"
+require_relative "halbuilder/paginate"
+require_relative "halbuilder/version"
+require_relative "halbuilder/zoom"
+
+module Halbuilder
+  class << self
+    def reset!
+      @configuration = nil
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+      setup
+    end
+
+    def setup
+      Halbuilder::KeyFormat.setup
+    end
+  end
+
+  class Error < StandardError; end
+end
+
+Halbuilder::KeyFormat.setup
+Jbuilder.include Halbuilder::Embed
+Jbuilder.include Halbuilder::Link
+Jbuilder.include Halbuilder::Paginate
+Jbuilder.include Halbuilder::Zoom

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: halbuilder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cavis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description:
+email:
+- ryan@prx.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- halbuilder.gemspec
+- lib/halbuilder.rb
+- lib/halbuilder/configuration.rb
+- lib/halbuilder/embed.rb
+- lib/halbuilder/key_format.rb
+- lib/halbuilder/link.rb
+- lib/halbuilder/paginate.rb
+- lib/halbuilder/version.rb
+- lib/halbuilder/zoom.rb
+homepage: https://github.com/PRX/halbuilder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/PRX/halbuilder
+  source_code_uri: https://github.com/PRX/halbuilder
+  changelog_uri: https://github.com/PRX/halbuilder/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/PRX/halbuilder/issues
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: HAL DSL extensions for Jbuilder.
+test_files: []