sanity-ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99698b9c87c062e3b1ba260579a51d00913b28690bba2eef557c5ab3ffe43a61
-  data.tar.gz: 0cc88772721d519604f1ffb3fecd38d456c4fcff8b5de036dbf7f932b537d13f
+  metadata.gz: 6992c7a949150c3c6d2fc4f927e74f18b2b00d7158cb26905e195eb7d91da627
+  data.tar.gz: 0c2e2088e770fe98cff7a1522c6a39076a8efc43410ea9eb241311e2611cd1fe
 SHA512:
-  metadata.gz: b2f9cf2fd8dece545f5ac80878fa99910b440b9ac78dc318b26f619da6103f9940c477a4431b7129626fd1c157b31a2ee6679fe32092e7be0add78d926a93f52
-  data.tar.gz: 7bda92a9734b5415abb245067dc1971b6a2239bdcd66b6710b14e5cb10fada6e4bb73c71e47a0fd4e65500c5bb7406b3e8274c4648c5cdde47ced1904d72cf09
+  metadata.gz: 2fff7714db16558133549a6cc8ed496cc2e157b17b533a44501ad125a0f7636d1575c9766939989711c7f957de7e6167cbd285963bbf8aac19bcdb7c2cde9377
+  data.tar.gz: 360d11148a57b4880b7cc661e4f7b7a51b8e2be937f991a4f1a6546fb21be348bd11123bba3d46eb71178a8c6aa628bcc107e7cee55ebeb613f4a80b4df5cdbe

data/.dockerignore

@@ -0,0 +1,10 @@
+/.bundle
+/vendor/
+Gemfile.lock
+
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+vendor/

data/Dockerfile-2.6

@@ -0,0 +1,30 @@
+FROM ruby:2.6-alpine as base
+
+RUN apk add --update --no-cache \
+  build-base \
+  cmake \
+  tzdata \
+  bash \
+  git
+
+ENV APP_PATH /var/www/sanity-ruby
+RUN mkdir -p $APP_PATH
+
+# Build intermediate
+FROM base as intermediate
+
+WORKDIR $APP_PATH
+
+RUN rm -rf /var/cache/apk/*
+
+FROM base as development
+
+COPY --from=intermediate $APP_PATH $APP_PATH
+
+WORKDIR $APP_PATH
+
+ENV GEM_HOME $APP_PATH/vendor/bundle
+ENV BUNDLE_PATH vendor/bundle
+
+COPY . ./
+RUN bundle check || bundle install

data/Dockerfile-2.7

@@ -0,0 +1,31 @@
+FROM ruby:2.7-alpine as base
+
+RUN apk add --update --no-cache \
+  build-base \
+  cmake \
+  tzdata \
+  bash \
+  git
+
+ENV APP_PATH /var/www/sanity-ruby
+RUN mkdir -p $APP_PATH
+
+# Build intermediate
+FROM base as intermediate
+
+WORKDIR $APP_PATH
+
+RUN rm -rf /var/cache/apk/*
+
+FROM base as development
+
+COPY --from=intermediate $APP_PATH $APP_PATH
+
+WORKDIR $APP_PATH
+
+ENV GEM_HOME $APP_PATH/vendor/bundle
+ENV BUNDLE_PATH vendor/bundle
+
+COPY . ./
+RUN bundle check || bundle install
+

data/Dockerfile-3.0

@@ -0,0 +1,30 @@
+FROM ruby:3.0-alpine as base
+
+RUN apk add --update --no-cache \
+  build-base \
+  cmake \
+  tzdata \
+  bash \
+  git
+
+ENV APP_PATH /var/www/sanity-ruby
+RUN mkdir -p $APP_PATH
+
+# Build intermediate
+FROM base as intermediate
+
+WORKDIR $APP_PATH
+
+RUN rm -rf /var/cache/apk/*
+
+FROM base as development
+
+COPY --from=intermediate $APP_PATH $APP_PATH
+
+WORKDIR $APP_PATH
+
+ENV GEM_HOME $APP_PATH/vendor/bundle
+ENV BUNDLE_PATH vendor/bundle
+
+COPY . ./
+RUN bundle check || bundle install

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in sanity.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", ">= 12.0"
 gem "minitest", "~> 5.0"
 gem "minitest-reporters", ">= 1.4"
 gem "mocha", ">= 1.12"

data/README.md

@@ -9,7 +9,7 @@ The library also provides other features, like:
 
 - Easy configuration for fast setup and use.
 - A pre-defined class to help make any PORO a "sanity resource"
-- Extensibility in overriding the wrapper of your API response results
+- Extensibility in overriding the serializer for the API response results
 - A small DSL around GROQ queries
 
 ## Contents
@@ -17,6 +17,7 @@ The library also provides other features, like:
 - [Sanity](#sanity)
   - [Contents](#contents)
   - [Getting Started](#getting-started)
+  - [Serialization](#serialization)
   - [Mutating](#mutating)
   - [Querying](#querying)
   - [Development](#development)
@@ -100,6 +101,63 @@ class User
 end
 ```
 
+## Serialization
+
+When using a PORO, you can opt-in to automatically serialize your results. You
+must define all attributes that should be serialized.
+
+```ruby
+class User < Sanity::Resource
+  auto_serialize
+  ...
+end
+```
+
+Additionally, you can configure a custom serializer. See how to define a custom
+serializer [below](#custom-serializer).
+
+```ruby
+class User < Sanity::Resource
+  serializer UserSerializer
+  ...
+end
+```
+
+Finally, at query time you can also pass in a serializer. A serializer specified
+at query time will take priority over any other configuration.
+
+```ruby
+User.where(active: true, serializer: UserSerializer)
+```
+
+where `UserSerializer` might look like:
+
+```ruby
+class UserSerializer
+  class << self
+    def call(...)
+      new(...).call
+    end
+  end
+
+  attr_reader :results
+
+  def initialize(args)
+    @results = args["result"]
+  end
+
+  def call
+    results.map do |result|
+      User.new(
+        _id: result["_id"],
+        _type: result["_type"]
+      )
+    end
+  end
+end
+```
+
+
 ## Mutating
 
 To [create a document](https://www.sanity.io/docs/http-mutations#c732f27330a4):
@@ -137,7 +195,7 @@ Sanity::Document.patch(params: { _id: "1234-321", set: { first_name: "Carl" }})
 To [find document(s) by id](https://www.sanity.io/docs/http-doc):
 
 ```ruby
-Sanity::Document.find(_id: "1234-321")
+Sanity::Document.find(id: "1234-321")
 ```
 
 To find documents based on certain fields:
@@ -218,12 +276,24 @@ GROQ
 Sanity::Document.where(groq: groq_query, variables: {name: "Monsters, Inc."})
 ```
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
 
+### Testing across all supported versions:
+
+To run tests across all gem supported ruby versions (requires Docker):
+```sh
+bin/dev-test
+```
+To run lint across all gem supported ruby versions (requires Docker):
+```sh
+bin/dev-lint
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/morning-brew/sanity-ruby.

data/bin/dev-lint

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+system "docker-compose run --rm 2.6 bin/standardrb && docker-compose run --rm 2.7 bin/standardrb && docker-compose run --rm 3.0 bin/standardrb"

data/bin/dev-test

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+system "docker-compose run --rm 2.6 bundle exec rake test && docker-compose run --rm 2.7 bundle exec rake test && docker-compose run --rm 3.0 bundle exec rake test"

data/docker-compose.yml

@@ -0,0 +1,46 @@
+version: '3.9'
+
+services:
+  '2.6':
+    build:
+      context: .
+      dockerfile: Dockerfile-2.6
+    tty: true
+    stdin_open: true
+    volumes:
+      - ./bin:/var/www/sanity-ruby/bin/
+      - ./lib:/var/www/sanity-ruby/lib/
+      - ./test:/var/www/sanity-ruby/test/
+    container_name: sanity-ruby-2.6
+    command: bash
+
+  '2.7':
+    build:
+      context: .
+      dockerfile: Dockerfile-2.7
+    tty: true
+    stdin_open: true
+    volumes:
+      - ./bin:/var/www/sanity-ruby/bin/
+      - ./lib:/var/www/sanity-ruby/lib/
+      - ./test:/var/www/sanity-ruby/test/
+    container_name: sanity-ruby-2.7
+    command: bash
+
+  '3.0':
+    build:
+      context: .
+      dockerfile: Dockerfile-3.0
+    tty: true
+    stdin_open: true
+    volumes:
+      - ./bin:/var/www/sanity-ruby/bin/
+      - ./lib:/var/www/sanity-ruby/lib/
+      - ./test:/var/www/sanity-ruby/test/
+    container_name: sanity-ruby-3.0
+    command: bash
+
+volumes:
+  bin:
+  lib:
+  test:

data/lib/sanity/groq/filter.rb

@@ -68,6 +68,8 @@ module Sanity
             filter_value << "#{filter(key: nested_key)} #{key} #{equal} #{cast_value(val)}"
           elsif val.is_a?(Array) && !val[0].is_a?(Hash)
             filter_value << "#{key} in #{val.map(&:to_s)}"
+          elsif [true, false].include?(val)
+            filter_value << "#{filter(key: nested_key)} #{key} #{equal} #{val}"
           elsif LOGICAL_OPERATORS.key?(key)
             if val.is_a?(Array)
               val.each { |hsh| iterate(hsh, nested_key: key) }

data/lib/sanity/groq/slice.rb

@@ -24,7 +24,7 @@ module Sanity
       def call
         return "" unless limit
 
-        !offset ? zero_index_to_limit : offset_to_limit
+        (!offset) ? zero_index_to_limit : offset_to_limit
       end
 
       private

data/lib/sanity/http/mutation.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "set"
 using Sanity::Refinements::Strings
 using Sanity::Refinements::Arrays
 
@@ -34,13 +35,18 @@ module Sanity
         visibility: :sync
       }.freeze
 
-      attr_reader :options, :params, :resource_klass, :query_set, :result_wrapper
+      attr_reader :options, :params, :resource_klass, :query_set, :serializer
 
       def initialize(**args)
         @resource_klass = args.delete(:resource_klass)
         @params = args.delete(:params)
         @query_set = Set.new
-        @result_wrapper = args.delete(:result_wrapper) || Sanity::Http::Results
+
+        warn RESULT_WRAPPER_DEPRECATION_WARNING if args[:result_wrapper]
+        @serializer = args.delete(:serializer) ||
+          args.delete(:result_wrapper) || # kept for backwards compatibility
+          klass_serializer ||
+          Sanity::Http::Results
 
         raise ArgumentError, "resource_klass must be defined" unless resource_klass
         raise ArgumentError, "params argument is missing" unless params
@@ -59,10 +65,15 @@ module Sanity
 
       def call
         Net::HTTP.post(uri, {"#{REQUEST_KEY}": body}.to_json, headers).then do |result|
-          block_given? ? yield(result_wrapper.call(result)) : result_wrapper.call(result)
+          block_given? ? yield(serializer.call(result)) : serializer.call(result)
         end
       end
 
+      def result_wrapper
+        warn RESULT_WRAPPER_DEPRECATION_WARNING
+        serializer
+      end
+
       private
 
       def base_url
@@ -88,6 +99,12 @@ module Sanity
         }
       end
 
+      def klass_serializer
+        return unless @resource_klass.respond_to?(:default_serializer)
+
+        @resource_klass.default_serializer
+      end
+
       def query_params
         camelize_query_set.map do |key, val|
           "#{key}=#{val}"

data/lib/sanity/http/query.rb

@@ -21,12 +21,17 @@ module Sanity
         end
       end
 
-      attr_reader :resource_klass, :result_wrapper
+      attr_reader :resource_klass, :serializer
 
       # @todo Add query support
       def initialize(**args)
         @resource_klass = args.delete(:resource_klass)
-        @result_wrapper = args.delete(:result_wrapper) || Sanity::Http::Results
+
+        warn RESULT_WRAPPER_DEPRECATION_WARNING if args[:result_wrapper]
+        @serializer = args.delete(:serializer) ||
+          args.delete(:result_wrapper) || # kept for backwards compatibility
+          klass_serializer ||
+          Sanity::Http::Results
       end
 
       # @todo Add query support
@@ -42,10 +47,15 @@ module Sanity
         http.request(request).then do |result|
           data = JSON.parse(result.body)
 
-          block_given? ? yield(result_wrapper.call(data)) : result_wrapper.call(data)
+          block_given? ? yield(serializer.call(data)) : serializer.call(data)
         end
       end
 
+      def result_wrapper
+        warn RESULT_WRAPPER_DEPRECATION_WARNING
+        serializer
+      end
+
       private
 
       def request_body
@@ -66,6 +76,12 @@ module Sanity
         }
       end
 
+      def klass_serializer
+        return unless @resource_klass.respond_to?(:default_serializer)
+
+        @resource_klass.default_serializer
+      end
+
       def uri
         URI(base_url)
       end

data/lib/sanity/http/where.rb

@@ -18,7 +18,9 @@ module Sanity
         @variables = args.delete(:variables) || {}
         @use_post = args.delete(:use_post) || false
 
-        @groq_attributes = args.except(:groq, :use_post, :resource_klass, :result_wrapper)
+        @groq_attributes = args.except(
+          :groq, :use_post, :resource_klass, :serializer, :result_wrapper
+        )
       end
 
       private

data/lib/sanity/refinements/strings.rb

@@ -17,7 +17,7 @@ module Sanity
       refine String do
         def camelize_lower
           split("_")[0..].each_with_index.map do |val, idx|
-            idx != 0 ? val.capitalize : val
+            (idx != 0) ? val.capitalize : val
           end.join
         end
 

data/lib/sanity/resource.rb

@@ -8,6 +8,7 @@ module Sanity
   #   Sanity::Attributable
   #   Sanity::Mutatable
   #   Sanity::Queryable
+  #   Sanity::Serializable
   #
   # Sanity::Document and Sanity::Asset both inherit
   # from Sanity::Resource
@@ -26,5 +27,6 @@ module Sanity
     include Sanity::Attributable
     include Sanity::Mutatable
     include Sanity::Queryable
+    include Sanity::Serializable
   end
 end

data/lib/sanity/serializable.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Sanity
+  # Serializable is responsible for configuring auto serialization or a default
+  # serializer. It also defines the default class serializer used when auto
+  # serialization is enabled.
+  #
+  # The auto_serialize macro is used to enable auto serialization.
+  #
+  # @example enables auto serialization
+  #   auto_serialize
+  #
+  # The serializer marco is used to define the default serializer.
+  #
+  # @example default to using a custom defined UserSerializer
+  #   serializer UserSerializer
+  #
+  module Serializable
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+      end
+    end
+
+    module ClassMethods
+      def default_serializer
+        @default_serializer ||=
+          if auto_serialize?
+            class_serializer
+          elsif defined?(@serializer)
+            @serializer
+          end
+      end
+
+      def auto_serialize?
+        return @auto_serialize if defined?(@auto_serialize)
+
+        superclass.respond_to?(:auto_serialize?) && superclass.auto_serialize?
+      end
+
+      private
+
+      def auto_serialize
+        @auto_serialize = true
+      end
+
+      def serializer(serializer)
+        @serializer = serializer
+      end
+
+      def class_serializer
+        @class_serializer ||= proc do |results|
+          results["result"].map do |result|
+            attributes = result.slice(*self.attributes.map(&:to_s))
+            new(**attributes.transform_keys(&:to_sym))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sanity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sanity
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/sanity.rb

@@ -12,10 +12,13 @@ require "sanity/http"
 require "sanity/attributable"
 require "sanity/mutatable"
 require "sanity/queryable"
+require "sanity/serializable"
 
 require "sanity/resource"
 require "sanity/resources"
 
 module Sanity
   class Error < StandardError; end
+
+  RESULT_WRAPPER_DEPRECATION_WARNING = "DEPRECATION: `result_wrapper` is deprecated. Please use `serializer` instead."
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Morning Brew
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email: tech@morningbrew.com
@@ -16,16 +16,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".standard.yml"
+- Dockerfile-2.6
+- Dockerfile-2.7
+- Dockerfile-3.0
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/dev-lint
+- bin/dev-test
 - bin/setup
 - bin/standardrb
+- docker-compose.yml
 - lib/sanity-ruby.rb
 - lib/sanity.rb
 - lib/sanity/attributable.rb
@@ -56,6 +63,7 @@ files:
 - lib/sanity/resources.rb
 - lib/sanity/resources/asset.rb
 - lib/sanity/resources/document.rb
+- lib/sanity/serializable.rb
 - lib/sanity/version.rb
 - sanity.gemspec
 homepage: https://github.com/morning-brew/sanity-ruby
@@ -80,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: Ruby bindings for the Sanity API