sanity-ruby 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6992c7a949150c3c6d2fc4f927e74f18b2b00d7158cb26905e195eb7d91da627
-  data.tar.gz: 0c2e2088e770fe98cff7a1522c6a39076a8efc43410ea9eb241311e2611cd1fe
+  metadata.gz: e02c772808fc5112f526e0e8bd329a829dd4ba0e2395d82a83d34f8419a05e66
+  data.tar.gz: c2b80c8bee2242e68ec2b814fc18e11ad699687a2174889cdf4a7b34823405f2
 SHA512:
-  metadata.gz: 2fff7714db16558133549a6cc8ed496cc2e157b17b533a44501ad125a0f7636d1575c9766939989711c7f957de7e6167cbd285963bbf8aac19bcdb7c2cde9377
-  data.tar.gz: 360d11148a57b4880b7cc661e4f7b7a51b8e2be937f991a4f1a6546fb21be348bd11123bba3d46eb71178a8c6aa628bcc107e7cee55ebeb613f4a80b4df5cdbe
+  metadata.gz: e265993399cfa3c24f821cac9625daaf763a0468353d18f0fac375231bc9e62e727f2a3314bbf55fc7aaa3b5d51f733822cc16409489bf6f3aebbff75ba5c72d
+  data.tar.gz: 5bf5fbfdb1fcf02d691fec0ad2226d2c24a9b993559f6e92eba16d6961eb0f54d97c70616e6642f6f42982666f3e3443b98bc8a9c53dc356b6fa956e99ae077b

data/README.md

@@ -1,7 +1,7 @@
 # Sanity
 
-![](https://github.com/morning-brew/sanity-ruby/actions/workflows/ci.yml/badge.svg)
-<a href="https://codeclimate.com/github/morning-brew/sanity-ruby/maintainability"><img src="https://api.codeclimate.com/v1/badges/1984ee6eb0bce46a2469/maintainability" /></a>
+![](https://github.com/dvmonroe/sanity-ruby/actions/workflows/ci.yml/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/24b96780b59c8a871e6e/maintainability)](https://codeclimate.com/github/dvmonroe/sanity-ruby/maintainability)
 
 The Sanity Ruby library provides convenient access to the Sanity API from applications written in Ruby. It includes a pre-defined set of classes for API resources.
 
@@ -76,6 +76,20 @@ class User < Sanity::Resource
 end
 ```
 
+Since `Sanity::Resource` includes `ActiveModel::Model` and
+`ActiveModel::Attributes`, you're able to define types on attributes and use
+methods like `alias_attribute`.
+
+```ruby
+class User < Sanity::Resource
+  ...
+  attribute :name, :string, default: 'John Doe'
+  attribute :_createdAt, :datetime
+  alias_attribute :created_at, :_createdAt
+  ...
+end
+```
+
 To create a new document in Sanity:
 
 ```ruby
@@ -296,7 +310,7 @@ bin/dev-lint
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/morning-brew/sanity-ruby.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dvmonroe/sanity-ruby.
 
 ## License
 

data/lib/sanity/attributable.rb

@@ -39,7 +39,7 @@ module Sanity
     def initialize(**args)
       self.class.default_attributes.merge(args).then do |attrs|
         attrs.each do |key, val|
-          define_singleton_method("#{key}=") do |val|
+          define_singleton_method(:"#{key}=") do |val|
             args[key] = val
             attributes[key] = val
           end

data/lib/sanity/helpers/type_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Sanity
+  module TypeHelper
+    def self.default_type(klass)
+      return nil if klass == Sanity::Document
+
+      type = klass.to_s
+      type[0].downcase + type[1..]
+    end
+  end
+end

data/lib/sanity/helpers.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "sanity/helpers/type_helper"

data/lib/sanity/http/mutation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "set"
+require "set" # rubocop:disable Lint/RedundantRequireStatement
 using Sanity::Refinements::Strings
 using Sanity::Refinements::Arrays
 

data/lib/sanity/queryable.rb

@@ -36,15 +36,20 @@ module Sanity
 
       private
 
-      # @private
       def queryable(**options)
         options.fetch(:only, DEFAULT_KLASS_QUERIES).each do |query|
-          define_singleton_method(query) do |**args|
-            Module.const_get("Sanity::Http::#{query.to_s.classify}").call(**args.merge(resource_klass: self))
-          end
-          define_singleton_method("#{query}_api_endpoint") { QUERY_ENDPOINTS[query] }
+          define_query_method(query)
         end
       end
+
+      def define_query_method(query)
+        define_singleton_method(query) do |**args|
+          default_type = args.key?(:_type) ? args[:_type] : Sanity::TypeHelper.default_type(self)
+          default_args = {resource_klass: self, _type: default_type}.compact
+          Module.const_get("Sanity::Http::#{query.to_s.classify}").call(**default_args.merge(args))
+        end
+        define_singleton_method(:"#{query}_api_endpoint") { QUERY_ENDPOINTS[query] }
+      end
     end
   end
 end

data/lib/sanity/resource.rb

@@ -5,7 +5,6 @@ module Sanity
   # the sanity resources defined within this gem.
   #
   # Out of the box it includes the following mixins:
-  #   Sanity::Attributable
   #   Sanity::Mutatable
   #   Sanity::Queryable
   #   Sanity::Serializable
@@ -24,7 +23,9 @@ module Sanity
   #   end
   #
   class Resource
-    include Sanity::Attributable
+    include ActiveModel::Model
+    include ActiveModel::Attributes
+
     include Sanity::Mutatable
     include Sanity::Queryable
     include Sanity::Serializable

data/lib/sanity/serializable.rb

@@ -50,8 +50,9 @@ module Sanity
 
       def class_serializer
         @class_serializer ||= proc do |results|
-          results["result"].map do |result|
-            attributes = result.slice(*self.attributes.map(&:to_s))
+          key = results.key?("result") ? "result" : "documents"
+          results[key].map do |result|
+            attributes = result.slice(*attribute_names)
             new(**attributes.transform_keys(&:to_sym))
           end
         end

data/lib/sanity/version.rb

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

data/lib/sanity.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "active_model"
 require "forwardable"
 require "sanity/refinements"
 
@@ -8,8 +9,8 @@ require "sanity/configuration"
 
 require "sanity/groqify"
 require "sanity/http"
+require "sanity/helpers"
 
-require "sanity/attributable"
 require "sanity/mutatable"
 require "sanity/queryable"
 require "sanity/serializable"

data/sanity.gemspec

@@ -5,12 +5,12 @@ require_relative "lib/sanity/version"
 Gem::Specification.new do |spec|
   spec.name = "sanity-ruby"
   spec.version = Sanity::VERSION
-  spec.authors = "Morning Brew"
-  spec.email = "tech@morningbrew.com"
+  spec.authors = "Drew Monroe"
+  spec.email = "drew@pinecreeklabs.com"
 
   spec.summary = "Ruby bindings for the Sanity API"
   spec.description = ""
-  spec.homepage = "https://github.com/morning-brew/sanity-ruby"
+  spec.homepage = "https://github.com/dvmonroe/sanity-ruby"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "activemodel"
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: sanity-ruby
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
-- Morning Brew
+- Drew Monroe
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-23 00:00:00.000000000 Z
-dependencies: []
+date: 2024-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
-email: tech@morningbrew.com
+email: drew@pinecreeklabs.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -42,6 +56,8 @@ files:
 - lib/sanity/groq/select.rb
 - lib/sanity/groq/slice.rb
 - lib/sanity/groqify.rb
+- lib/sanity/helpers.rb
+- lib/sanity/helpers/type_helper.rb
 - lib/sanity/http.rb
 - lib/sanity/http/create.rb
 - lib/sanity/http/create_if_not_exists.rb
@@ -66,13 +82,13 @@ files:
 - lib/sanity/serializable.rb
 - lib/sanity/version.rb
 - sanity.gemspec
-homepage: https://github.com/morning-brew/sanity-ruby
+homepage: https://github.com/dvmonroe/sanity-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/morning-brew/sanity-ruby
-  source_code_uri: https://github.com/morning-brew/sanity-ruby
-  changelog_uri: https://github.com/morning-brew/sanity-ruby
+  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: