halitosis 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 759e2f5eada1444024bd208f82706b0a30b40dbfe24f6c1d829bea49067d1b3d
+  data.tar.gz: 72b52a2ccba027e2745fbcc245b7311b8aca6097afc77395c92f4274036c8d00
+SHA512:
+  metadata.gz: b4384527d214837272668d24c9e0f4c7ad9578189d0c31bbadb8490b00a88f2cd92b236c7c36f3584f98abebf216980c626c6b617c72e4e217d11bac3df175ed
+  data.tar.gz: 1f4d4c859877996961a9187397ab9913f0214542893d718f5fe8c9dc226ceaff5eb2d298f4b18d62f0a65ad5e1a32330268ff7c1eb57c25db25d0e032fecbad6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,32 @@
+require:
+  - standard
+  - standard-performance
+  - standard-rspec
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+inherit_gem:
+  standard: config/base.yml
+  standard-performance: config/base.yml
+  standard-rspec: config/base.yml
+
+AllCops:
+  NewCops: disable
+  TargetRubyVersion: 3.2
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MessageSpies:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/integrations/**/*.rb
+
+RSpec/NestedGroups:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-30
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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, caste, color, 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 email 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
+[INSERT CONTACT METHOD].
+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.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ben Morrall
+
+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,360 @@
+# Halitosis
+
+> bmorrall: I’ve come up with the best name for a rails library!!!
+>
+> bmorrall: HAL is an API design standard. I like what it does, but it doesn’t fully mesh well with rails.
+>
+> bmorrall: So I’m thinking of adapting the standard to work better with rails, and bundling up a library to help generate the required data from it
+>
+> bmorrall: Calling it "rails_is_hal"
+>
+> daveabbott: Or Halitosis.
+>
+> bmorrall: That’s also not a bad idea, and slightly more professional sounding
+
+Provides an interface for serializing resources as JSON with HAL-like links and relationships, with additonal meta and permissions info.
+
+Need something more standardized ([JSON:API](https://jsonapi.org/), or [HAL](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-11))? Most of this code was converted from [halogen](https://github.com/mode/halogen); which is a great alternative for HAL+JSON serialization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "`UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG`"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG`
+```
+
+### Basic usage
+
+Create a simple serializer class and include Halitosis:
+
+```ruby
+class Duck
+  def name = "Ferdi"
+  def code = "ferdi"
+end
+
+class DuckSerializer
+  include Halitosis
+
+  resource :duck
+
+  property :name
+
+  link :self do
+    "/ducks/#{duck.code}"
+  end
+end
+```
+
+Instantiate:
+
+```ruby
+duck = Duck.new
+serializer = DuckSerializer.new(duck)
+```
+
+Then call `serializer.render`:
+
+```json
+{
+  name: 'Ferdi',
+  _links: {
+    self: { href: '/ducks/ferdi' }
+  }
+}
+```
+
+Or `serializer.to_json`:
+
+```ruby
+'{"name": "Ferdi", "_links": {"self": {"href": "/ducks/ferdi"}}}'
+```
+
+
+### Serializer types
+
+#### 1. Simple
+
+Not associated with any particular resource or collection. For example, an API
+entry point:
+
+```ruby
+class ApiRootSerializer
+  include Halitosis
+
+  link(:self) { '/api' }
+end
+```
+
+#### 2. Resource
+
+Represents a single item:
+
+```ruby
+class DuckSerializer
+  include Halitosis
+
+  resource :duck
+end
+```
+
+When a resource is declared, `#initialize` expects the resource as the first argument:
+
+```ruby
+serializer = DuckSerializer.new(Duck.new, ...)
+```
+
+This makes property definitions cleaner:
+
+```ruby
+property :name # now calls Duck#name by default
+```
+
+#### 3. Collection
+
+Represents a collection of items. When a collection is declared, `#initialize` expects the collection as the first argument:
+
+```ruby
+class DuckKidsSerializer
+  include Halitosis
+
+  collection :ducklings do
+    [ ... ]
+  end
+end
+```
+
+The block should return an array of Halitosis instances in order to be rendered.
+
+### Defining properties, links, relationships, meta, and permissions
+
+Properties can be defined in several ways:
+
+```ruby
+property(:quacks) { "#{duck.quacks} per minute" }
+```
+
+```ruby
+property :quacks # => Duck#quacks, if resource is declared
+```
+
+```ruby
+property :quacks do
+  duck.quacks.round
+end
+```
+
+```ruby
+property(:quacks) { calculate_quacks }
+
+def calculate_quacks
+  ...
+end
+```
+
+#### Conditionals
+
+The inclusion of properties can be determined by conditionals using `if` and
+`unless` options. For example, with a method name:
+
+```ruby
+property :quacks, if: :include_quacks?
+
+def include_quacks?
+  duck.quacks < 10
+end
+```
+
+With a proc:
+```ruby
+property :quacks, unless: proc { duck.quacks.nil? }, value: ...
+```
+
+For links and relationships:
+
+```ruby
+link :ducklings, :templated, unless: :exclude_ducklings_link?, value: ...
+```
+
+```ruby
+relationship :ducklings, if: proc { duck.ducklings.size > 0 } do
+  [ ... ]
+end
+```
+
+#### Links
+
+Simple link:
+
+```ruby
+link(:root) { '/' }
+# => { _links: { root: { href: '/' } } ... }
+```
+
+Templated link:
+
+```ruby
+link(:find, :templated) { '/ducks/{?id}' }
+# => { _links: { find: { href: '/ducks/{?id}', templated: true } } ... }
+```
+
+Optional links:
+
+```ruby
+serializer = MySerializerWithManyLinks.new(include_links: false)
+rendered = serializer.render
+rendered[:_links] # nil
+```
+
+#### Relationships
+
+Simple one-to-one relationship:
+
+```ruby
+relationship(:owner) { UserSerializer.new(duck.owner) }
+# => { duck: { _relationships: { owner: { ... } } } }
+```
+
+or a one-to-many collection with an array of record serializers:
+
+```ruby
+relationship(:ducklings) do
+  duck.ducklings.map { |duckling| DucklingSerializer.new(duckling) }
+end
+# => { duck: { _relationships: { ducklings: [ ... ] } } }
+```
+
+or with a single collection serializer:
+
+```ruby
+relationship(:ducklings) do
+  DucklingsSerializer.new(duck.ducklings)
+end
+```
+
+A rel shorthand is also available for those who like to avoid a relationship:
+
+```ruby
+rel(:parent) { UserSerializer.new(...) }
+rel(:ducklings) { [DucklingSerializer.new(...), ...] }
+end
+```
+
+Resources are not rendered by default. They will be included if both
+of the following conditions are met:
+
+1. The proc returns either a Halitosis instance or an array of Halitosis instances
+2. The relationship is requested via the parent serializer's options, e.g.:
+
+```ruby
+DuckSerializer.new(include: { ducklings: true, parent: false })
+```
+
+They can also be prested as an array of strings:
+
+```ruby
+DuckSerializer.new(include: ["ducklings", "parent"])
+```
+
+or as comma-joined strings:
+
+```ruby
+DuckSerializer.new(include: "ducklings,parent")
+```
+
+Resources can be nested to any depth, e.g.:
+
+```ruby
+DuckSerializer.new(include: {
+  ducklings: {
+    foods: {
+      ingredients: true
+    },
+    pond: true
+  }
+})
+```
+
+or:
+
+```ruby
+DuckSerializer.new(include: "ducklings.foods.ingredients,ducklings.pond")
+```
+
+and requested on collections:
+
+```ruby
+DucksSerializer.new(..., include: ["ducks.ducklings.foods"])
+```
+
+#### Meta
+
+Simple nested Meta information. Use this for providing details of attributes that are not modified directly by the API.
+
+```ruby
+meta(:created_at)
+# => { _meta: { created_at: "2024-09-30T20:46:00Z }}
+```
+
+#### Permissions
+
+Simple nested Access Rights information. Use this for informing clients of what resources they are able to access.
+
+```ruby
+permission(:snuggle) -> { duckling_policy.snuggle? }
+# => { _permissions: { snuggle: true }}
+```
+
+
+### Using with Rails
+
+If Halitosis is loaded in a Rails application, Rails url helpers will be
+available in serializers:
+
+```ruby
+link(:new) { new_duck_url }
+```
+
+Serializers can either be passed in as a json argument to render:
+
+```ruby
+render json: DuckSerializer.new(duck)
+```
+
+or directly given as arguments to render:
+
+```ruby
+render DuckSerializer.new(duck)
+```
+
+
+## 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.
+
+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/bmorrall/halitosis. 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/bmorrall/halitosis/blob/main/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 Halitosis project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bmorrall/halitosis/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/halitosis/base.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module Base
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.send :include, InstanceMethods
+      base.send :include, Links
+      base.send :include, Meta
+      base.send :include, Permissions
+      base.send :include, Properties
+      base.send :include, Relationships
+
+      base.send :attr_reader, :options
+    end
+
+    module ClassMethods
+      # @return [Halitosis::Fields]
+      def fields
+        @fields ||= Fields.new
+      end
+
+      def collection?
+        false
+      end
+    end
+
+    module InstanceMethods
+      # @param options [nil, Hash] hash of options
+      #
+      # @return [Object] the serializer instance
+      #
+      def initialize(**options)
+        @options = Halitosis::HashUtil.symbolize_params(options)
+      end
+
+      # @return [Hash, Array] rendered JSON
+      def as_json(...)
+        render.as_json(...)
+      end
+
+      # @return [String] rendered JSON
+      #
+      def to_json(...)
+        render.to_json(...)
+      end
+
+      # @return [Hash] rendered representation
+      #
+      def render
+        {}
+      end
+
+      # @return [nil, Object] the parent serializer, if this instance is an
+      #   embedded child
+      #
+      def parent
+        @parent ||= options.fetch(:parent, nil)
+      end
+
+      # @return [Integer] the depth at which this serializer is embedded
+      #
+      def depth
+        @depth ||= parent ? parent.depth + 1 : 0
+      end
+
+      def collection?
+        false
+      end
+
+      protected
+
+      # Allow included modules to decorate rendered hash
+      #
+      # @param key [Symbol] the key (e.g. `embedded`, `links`)
+      # @param result [Hash] the partially rendered hash to decorate
+      #
+      # @return [Hash] the decorated hash
+      #
+      def decorate_render(key, result)
+        result.tap do
+          value = send(key)
+
+          result[:"_#{key}"] = value if value.any?
+        end
+      end
+
+      # Iterate through enabled fields of the given type, allowing instance
+      # to build up resulting hash
+      #
+      # @param type [Symbol, String] the field type
+      #
+      # @return [Hash] the result
+      #
+      def render_fields(type)
+        fields = self.class.fields.fetch(type, [])
+
+        fields.each_with_object({}) do |field, result|
+          next unless field.enabled?(self)
+
+          yield field, result
+        end
+      end
+
+      # @param child [Halitosis] the child serializer
+      # @param opts [Hash] the include options to assign to the child
+      #
+      # @return [nil, Hash] the rendered child
+      #
+      def render_child(child, opts)
+        return unless child.class.included_modules.include?(Halitosis)
+
+        child.options[:include] ||= {}
+        child.options[:include] = child.options[:include].merge(opts)
+
+        child.options[:parent] = self
+
+        child.render
+      end
+    end
+  end
+end

data/lib/halitosis/collection/field.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Halitosis
+  module Collection
+    class Field < Halitosis::Field
+    end
+  end
+end