halva 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 900e5a47a7c2ffcb2528799f258b4de9245358315dfb0c7cf5c211844bfe872b
+  data.tar.gz: 798b4bb53e9121a805f8e0acb963609c8626b2281e80c54098e76b037c6574b9
+SHA512:
+  metadata.gz: 447cd2a234cc0edc69b2404207731add3093e91527ffe2ce9ab34416e78fd7415f344d03cebfff9289411cc6af8f502d55bdef7dc95dd20773469f719ac0ecde
+  data.tar.gz: 6dde2bcef96c82921f98af028a0c6c78c47453e904f6dc9ad891cacaf001ab03100e8a43a28820c8deef92a00caa84872688526661899665005d873c6ff5f05f

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.6
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in halva.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+
+group :development do
+  gem 'rubocop', '~> 1.45', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    halva (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (12.3.3)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  halva!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.45)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Denis Semenenko
+
+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,67 @@
+# Halva
+
+HAL-compliant serializer
+
+[![Ruby](https://github.com/denblackstache/halva/actions/workflows/main.yml/badge.svg)](https://github.com/denblackstache/halva/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/halva.svg)](https://badge.fury.io/rb/halva)
+
+Links
+* [HAL - Hypertext Application Language](https://stateless.co/hal_specification.html)
+* [Specification Draft](https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-08)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'halva'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install halva
+
+## Usage
+
+### Representing an object
+
+```ruby
+order = Order.find(1)
+Halva::Resource.from_model(order)
+               .embed(Halva::Resource.from_model(order.customer).build, :customer)
+               .link(Halva::Link.new('/orders/1', :self))
+               .link(Halva::Link.new('/orders/1/customer', :customer))
+               .build
+
+```
+
+### Representing a collection
+
+```ruby
+orders = Order.find
+Halva::Resource.from_empty_model
+               .embed(orders.map { |order| Halva::Resource.from_model(order).build })
+               .link(Halva::Link.new('/orders?page=3', :next))
+               .link(Halva::Link.new('/orders?page=2', :self))
+               .link(Halva::Link.new('/orders?page=1', :prev))
+               .build
+
+```
+
+## 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 tags, 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/denblackstache/halva.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'halva'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/halva.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/halva/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'halva'
+  spec.version       = Halva::VERSION
+  spec.authors       = ['Denis Semenenko']
+  spec.email         = ['hypercoderx@gmail.com']
+
+  spec.summary       = 'HAL-compliant serializer'
+  spec.homepage      = 'https://github.com/denblackstache/halva'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/denblackstache/halva'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/halva/link.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Halva
+  # HAL Link Object
+  # https://datatracker.ietf.org/doc/html/draft-kelly-json-hal#section-5}
+  class Link
+    attr_reader :relation, :href
+
+    def initialize(href, relation, options = {})
+      @href = href
+      @relation = relation.to_sym
+      @options = options
+    end
+
+    def to_h
+      { href: @href, **@options }
+    end
+  end
+end

data/lib/halva/resource.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Halva
+  # HAL Resource object
+  # https://datatracker.ietf.org/doc/html/draft-kelly-json-hal#section-4
+  class Resource
+    EMBEDDED_KEY = :_embedded
+    LINKS_KEY = :_links
+
+    def self.from_model(model)
+      new(model.to_h)
+    end
+
+    def self.from_empty_model
+      new({})
+    end
+
+    def initialize(model)
+      @model = model
+      @embedded = []
+      @links = []
+    end
+
+    def embed(resource, relation = :item)
+      @embedded << { resource: resource, relation: relation.to_sym }
+      self
+    end
+
+    def link(link)
+      @links << link
+      self
+    end
+
+    def build
+      unless @embedded.empty?
+        @model[EMBEDDED_KEY] = {} unless @model.key?(EMBEDDED_KEY)
+        @embedded.each do |emb|
+          @model[EMBEDDED_KEY][emb[:relation]] = emb[:resource]
+        end
+      end
+
+      unless @links.empty?
+        @model[LINKS_KEY] = {} unless @model.key?(LINKS_KEY)
+        @links.each do |link|
+          @model[LINKS_KEY][link.relation] = link.to_h
+        end
+      end
+
+      @model.to_h
+    end
+  end
+end

data/lib/halva/version.rb

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

data/lib/halva.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'halva/version'
+
+module Halva
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: halva
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Denis Semenenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- hypercoderx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- halva.gemspec
+- lib/halva.rb
+- lib/halva/link.rb
+- lib/halva/resource.rb
+- lib/halva/version.rb
+homepage: https://github.com/denblackstache/halva
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/denblackstache/halva
+  source_code_uri: https://github.com/denblackstache/halva
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: HAL-compliant serializer
+test_files: []