sanity-ruby 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cb8ebee529e3f7aa924f79ef9db8971f2e02ff727f307a0af4c2e01cd778afc
-  data.tar.gz: ac53d38a057a8e830ccfed73032d751bdf3f49f98e70b835b7d4b108a31ef2a3
+  metadata.gz: 76349642b02272270f94ada31fe1f03f438490859eff6f1f987819ccf5ddb9dc
+  data.tar.gz: 246e2f225d6a6955f06aba7ffe29e718904887154423c61ee1de5ba5d03af65c
 SHA512:
-  metadata.gz: c613cd3d0dc68006d80f0a52b40a2884d654e77357e516b30e01ff78519360ca592fa8ea0c06962792daad9aac7d9841d83a7ee11c8c73d07c588e75730a87ae
-  data.tar.gz: 799a99a83a17e76526efa652207f1aad6756c01574a2dd63b786c9a3af75192ca5c6b10ca2ffaba602d275fdbf9ef7ee38996af258364406ca5b7a6818ef3855
+  metadata.gz: f2287a0e8eba82e69213bef9e0e0c928da0a5fdc29ca21e50d99f43fbea0604093506331375c8277783ab564d07bc0589edd906eb19cc85b6c63e64672f80ccc
+  data.tar.gz: 60e53655e0e9156959a2a9c40978850501bd92f4bf94feb604e37418778bb91ba05b89ba1ea78bf5f3064bd5477a22456cdabef8a33ac1b8ce6661ca996febb8

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+## Description
+
+
+
+## Checklist
+
+- [ ] I have checked existing issues for duplicates
+- [ ] I have run `bin/dev-test` locally and all tests pass
+- [ ] I have run `bin/dev-lint` locally and there are no linting errors
+- [ ] I have updated the README if this change affects documentation
+

data/Gemfile

@@ -14,3 +14,9 @@ gem "guard-minitest"
 gem "yard"
 
 gem "standard"
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.0")
+  gem "ffi", "~> 1.16.3"
+else
+  gem "ffi"
+end

data/README.md

@@ -12,6 +12,12 @@ The library also provides other features, like:
 - Extensibility in overriding the serializer for the API response results
 - A small DSL around GROQ queries
 
+> [!NOTE]
+> This gem was originally developed in early 2021 to facilitate Morning Brew's content migration from Rails to Sanity. It was subsequently used to enable interaction between Morning Brew's Rails-based Advertising CMS and their Sanity-based Editorial CMS for another ~year. The gem is no longer actively used in production as the Rails applications have since been deprecated, but it remains available as an open-source solution for Ruby - Sanity integrations.
+
+> [!WARNING]
+> If you're looking for a way to embed Sanity Studio within a Rails application, this gem is not the solution.
+
 ## Contents
 
 - [Sanity](#sanity)
@@ -121,6 +127,12 @@ class User < Sanity::Resource
   queryable
   publishable
 end
+
+# If your class name doesn't match the Sanity document type, use `document_type`:
+class Cms::BlogPost < Sanity::Resource
+  self.document_type = :post
+  # ...
+end
 ```
 
 
@@ -351,6 +363,7 @@ groq_query = <<-GROQ
 GROQ
 
 Sanity::Document.where(groq: groq_query, variables: {name: "Monsters, Inc."})
+# Note: symbols are treated like strings when passed as variables
 ```
 
 

data/lib/sanity/groq/select.rb

@@ -27,7 +27,7 @@ module Sanity
         return unless select
 
         Array.wrap(select).each_with_index do |x, idx|
-          val << "#{idx.positive? ? "," : ""} #{x}"
+          val << "#{"," if idx.positive?} #{x}"
         end
 
         "{ #{val.strip} }"

data/lib/sanity/helpers/type_helper.rb

@@ -5,7 +5,8 @@ module Sanity
     def self.default_type(klass)
       return nil if klass == Sanity::Document
 
-      type = klass.to_s
+      type = (klass.try(:document_type) || klass).to_s
+
       type[0].downcase + type[1..]
     end
   end

data/lib/sanity/http/find.rb

@@ -4,6 +4,7 @@ module Sanity
   module Http
     class Find
       include Sanity::Http::Query
+
       delegate find_api_endpoint: :resource_klass
       alias_method :api_endpoint, :find_api_endpoint
 

data/lib/sanity/http/where.rb

@@ -7,6 +7,7 @@ module Sanity
   module Http
     class Where
       include Sanity::Http::Query
+
       delegate where_api_endpoint: :resource_klass
       alias_method :api_endpoint, :where_api_endpoint
 
@@ -41,7 +42,7 @@ module Sanity
         else
           {}.tap do |hash|
             variables.each do |key, value|
-              hash["$#{key}"] = "\"#{value}\""
+              hash["$#{key}"] = serialize_variable_value(value)
             end
           end
         end.merge(query: groq_query)
@@ -56,6 +57,17 @@ module Sanity
 
         query_and_variables.to_json
       end
+
+      def serialize_variable_value(value)
+        case value
+        when String, Symbol
+          "\"#{value}\""
+        when Array, Hash
+          value.to_json
+        else
+          value.to_s
+        end
+      end
     end
   end
 end

data/lib/sanity/queryable.rb

@@ -28,6 +28,8 @@ module Sanity
     module ClassMethods
       DEFAULT_KLASS_QUERIES = %i[find where].freeze
 
+      attr_accessor :document_type
+
       # See https://www.sanity.io/docs/http-query & https://www.sanity.io/docs/http-doc
       QUERY_ENDPOINTS = {
         find: "data/doc",

data/lib/sanity/version.rb

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

data/lib/sanity.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "logger"
 require "active_model"
 require "forwardable"
 require "sanity/refinements"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Drew Monroe
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -31,6 +30,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".dockerignore"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/ci.yml"
 - ".gitignore"
 - ".standard.yml"
@@ -94,7 +94,6 @@ metadata:
   homepage_uri: https://github.com/dvmonroe/sanity-ruby
   source_code_uri: https://github.com/dvmonroe/sanity-ruby
   changelog_uri: https://github.com/dvmonroe/sanity-ruby
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -109,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby bindings for the Sanity API
 test_files: []