sanity-ruby 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6bf214154655cc746cb50c817499ddef2dc104915633814fb4bbb60dbcf18d6
-  data.tar.gz: 0e906831bd32ae8b98431adb107a1aca54ea0b6baa30327807cb0764f0a35c25
+  metadata.gz: 8eac71da998761b24763c53a7d5751006738582374052c9a306240d3e06c8a90
+  data.tar.gz: 7f00d6937d416db65496fc130219f07e4663809acdf9c98f3de73a53b4ae60cb
 SHA512:
-  metadata.gz: 99db43870e1f4ac67f63e46b142545c5588657d93eaee2eb007352a33646f36f5d7b31d1992b8dbca12eb98f92b9bab27ae8c0122637b3d0a3815f3eb1543b02
-  data.tar.gz: 9c09be7fec031eda815290b3e6dab1c2e080a7cb053eaf0274989181661d8e9f84c264ef798c7d17ee9b828a1fd2abae9fe17547f137d1f6dcb167768d5425eb
+  metadata.gz: 7e1b8494784ef0076d78e0317c9627e4ff9eba2d132a3d8cb263ca48e410d978594b8186133fb2ba4e0f3431ee986d6ec13554ffb0ca15c5811c2e34a04e79ee
+  data.tar.gz: 876b992ee2bb568d79a10588bf8ee443d301b2d9a386a12de9c2373e0f4d5dda211f9b4639a2445d59409c035b86c7ee3cef8dac38056dd0a233cbde768b8b36

data/.github/workflows/ci.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [2.6, 2.7, "3.0"]
+        ruby: [2.6, 2.7, "3.0", "3.3"]
     steps:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1

data/Dockerfile-3.3

@@ -0,0 +1,30 @@
+FROM ruby:3.3-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

@@ -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)
@@ -35,6 +41,7 @@ gem 'sanity-ruby'
 Setup your configuration. If using in Rails, consider setting this in an initializer:
 
 ```ruby
+# config/initializers/sanity.rb
 Sanity.configure do |s|
   s.token = "yoursupersecrettoken"
   s.api_version = "v2021-03-25"
@@ -42,9 +49,19 @@ Sanity.configure do |s|
   s.dataset = "development"
   s.use_cdn = false
 end
+
+# OR
+
+# Sanity.configure do |s|
+#   s.token = ENV.fetch("SANITY_TOKEN", "")
+#   s.api_version = ENV.fetch("SANITY_API_VERSION", "")
+#   s.project_id = ENV.fetch("SANITY_PROJECT_ID", "")
+#   s.dataset = ENV.fetch("SANITY_DATASET", "")
+#   s.use_cdn = ENV.fetch("SANITY_USE_CDN", false)
+# end
 ```
 
-or you can set the following ENV variables at runtime:
+or you can set the following ENV variables at runtime without any initializer:
 
 ```bash
 SANITY_TOKEN="yoursupersecrettoken"
@@ -54,7 +71,30 @@ SANITY_DATASET="development"
 SANITY_USE_CDN="false"
 ```
 
-The configuration object is thread safe meaning you can connect to multiple different projects across multiple threads. This may be useful if your application is interacting with multiple different Sanity projects.
+The configuration object is thread safe by default meaning you can connect to multiple different projects and/or API variations across any number of threads. A real world scenario when working with Sanity may require that you sometimes interact with the [CDN based API](https://www.sanity.io/docs/api-cdn) and sometimes the non-CDN based API. Using ENV variables combined with the thread safe configuration object gives you the ultimate flexibility.
+
+If you're using this gem in a Rails application AND you're interacting with only ONE set of configuration you can make the gem use the global configuration by setting the `use_global_config` option to `true`.
+
+Your initializer `config/initializers/sanity.rb` should look like:
+
+```ruby
+# `use_global_config` is NOT thread safe. DO NOT use if you intend on changing the
+# config object at anytime within your application's lifecycle.
+#
+# Do not use `use_global_config` in your application if you're:
+# - Interacting with various Sanity project ids/token
+# - Interacting with multiple API versions
+# - Interacting with calls that sometimes require the use of the CDN and sometimes don't
+
+Sanity.use_global_config = true
+Sanity.configure do |s|
+  s.token = "yoursupersecrettoken"
+  s.api_version = "v2021-03-25"
+  s.project_id = "1234"
+  s.dataset = "development"
+  s.use_cdn = false
+end
+```
 
 To create a new document:
 

data/bin/dev-lint

@@ -1,3 +1,6 @@
 #!/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"
+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 && \
+        docker-compose run --rm 3.3 bin/standardrb"

data/bin/dev-test

@@ -1,3 +1,6 @@
 #!/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"
+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 && \
+        docker-compose run --rm 3.3 bundle exec rake test"

data/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.9'
-
 services:
   '2.6':
     build:
@@ -40,6 +38,19 @@ services:
     container_name: sanity-ruby-3.0
     command: bash
 
+  '3.3':
+    build:
+      context: .
+      dockerfile: Dockerfile-3.3
+    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.3
+    command: bash  
+
 volumes:
   bin:
   lib:

data/lib/sanity/configuration.rb

@@ -29,21 +29,36 @@ module Sanity
     def api_subdomain
       use_cdn ? "apicdn" : "api"
     end
-  end
 
-  def self.configuration
-    Thread.current[:sanity_configuration] ||= Configuration.new
+    def to_h
+      instance_variables.each_with_object({}) do |var, obj|
+        obj[var.to_s.delete("@").to_sym] = instance_variable_get(var)
+      end
+    end
   end
 
   class << self
+    attr_accessor :use_global_config
+
+    def configuration
+      if use_global_config
+        @configuration ||= Configuration.new
+      else
+        Thread.current[:sanity_configuration] ||= Configuration.new
+      end
+    end
     alias_method :config, :configuration
-  end
 
-  def self.configuration=(config)
-    Thread.current[:sanity_configuration] = config
-  end
+    def configuration=(config)
+      if use_global_config
+        @configuration = config
+      else
+        Thread.current[:sanity_configuration] = config
+      end
+    end
 
-  def self.configure
-    yield configuration
+    def configure
+      yield configuration
+    end
   end
 end

data/lib/sanity/http/where.rb

@@ -41,7 +41,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 +56,17 @@ module Sanity
 
         query_and_variables.to_json
       end
+
+      def serialize_variable_value(value)
+        case value
+        when String
+          "\"#{value}\""
+        when Array, Hash
+          value.to_json
+        else
+          value.to_s
+        end
+      end
     end
   end
 end

data/lib/sanity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sanity
-  VERSION = "0.5.0"
+  VERSION = "0.7.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,14 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Drew Monroe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2025-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -37,6 +37,7 @@ files:
 - Dockerfile-2.6
 - Dockerfile-2.7
 - Dockerfile-3.0
+- Dockerfile-3.3
 - Gemfile
 - LICENSE.txt
 - README.md