gql_serializer 2.2.0 → 3.0.0

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "gql_serializer"
-
-# 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__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gql_serializer"
+
+# 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

@@ -1,8 +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
+#!/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/gql_serializer.gemspec

@@ -1,36 +1,36 @@
-require_relative 'lib/gql_serializer/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "gql_serializer"
-  spec.version       = GqlSerializer::VERSION
-  spec.authors       = ["Andrew Scullion"]
-  spec.email         = ["andrewsc32@protonmail.com"]
-
-  spec.summary       = %q{A gem that adds `as_gql` to easily serialize ActiveRecord objects}
-  spec.description   = %q{A gem that adds `as_gql` to easily serialize ActiveRecord objects}
-  spec.homepage      = "https://github.com/TheDro/gql_serializer"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.1")
-
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/TheDro/gql_serializer"
-  spec.metadata["changelog_uri"] = "https://github.com/TheDro/gql_serializer"
-
-  # 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('..', __FILE__)) 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"]
-
-  spec.add_development_dependency "rake", "~> 12.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry", "~> 0.13.1"
-  spec.add_development_dependency "sqlite3", "~> 1.4.2"
-
-  spec.add_runtime_dependency "activerecord", ">= 5.2", "< 8.0"
-end
+require_relative 'lib/gql_serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gql_serializer"
+  spec.version       = GqlSerializer::VERSION
+  spec.authors       = ["Andrew Scullion"]
+  spec.email         = ["andrewsc32@protonmail.com"]
+
+  spec.summary       = %q{A gem that adds `as_gql` to easily serialize ActiveRecord objects}
+  spec.description   = %q{A gem that adds `as_gql` to easily serialize ActiveRecord objects}
+  spec.homepage      = "https://github.com/TheDro/gql_serializer"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/TheDro/gql_serializer"
+  spec.metadata["changelog_uri"] = "https://github.com/TheDro/gql_serializer"
+
+  # 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('..', __FILE__)) 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"]
+
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.15"
+  spec.add_development_dependency "sqlite3", "~> 2.7"
+
+  spec.add_runtime_dependency "activerecord", ">= 7.0", "< 8.1"
+end

data/lib/gql_serializer/configuration.rb

@@ -1,30 +1,30 @@
-
-
-module GqlSerializer
-  class Configuration
-    CAMEL_CASE = :camel
-    SNAKE_CASE = :snake
-    NONE_CASE = :none
-    SUPPORTED_CASES = [CAMEL_CASE, SNAKE_CASE, NONE_CASE]
-
-    def initialize
-      reset
-    end
-
-    attr_reader :case, :preload
-
-    def case=(value)
-      raise "Specified case '#{value}' is not supported" unless SUPPORTED_CASES.include?(value)
-      @case = value
-    end
-
-    def reset
-      @case = NONE_CASE
-      @preload = false # Default will be true in version 3+
-    end
-
-    def to_h
-      {case: @case}
-    end
-  end
+
+
+module GqlSerializer
+  class Configuration
+    CAMEL_CASE = :camel
+    SNAKE_CASE = :snake
+    NONE_CASE = :none
+    SUPPORTED_CASES = [CAMEL_CASE, SNAKE_CASE, NONE_CASE]
+
+    def initialize
+      reset
+    end
+
+    attr_accessor :case, :preload
+
+    def case=(value)
+      raise "Specified case '#{value}' is not supported" unless SUPPORTED_CASES.include?(value)
+      @case = value
+    end
+
+    def reset
+      @case = NONE_CASE
+      @preload = true
+    end
+
+    def to_h
+      self.instance_values.symbolize_keys
+    end
+  end
 end

data/lib/gql_serializer/extensions.rb

@@ -1,52 +1,71 @@
-require "active_record"
-
-module GqlSerializer
-  module Array
-    def as_gql(query = nil)
-      map { |v| v.as_gql(query) }
-    end
-  end
-
-  module Relation
-    def as_gql(query = nil, options = {})
-      options_with_defaults = GqlSerializer.configuration.to_h.merge(options)
-      query_hasharray = query ? GqlSerializer.parse_query(query) : []
-      include_hasharray = GqlSerializer.query_include(self.model, query_hasharray)
-      records = self.includes(include_hasharray).records
-      GqlSerializer.serialize(records, query_hasharray, options_with_defaults)
-    end
-  end
-
-  module ActiveRecord
-    def self.as_gql(query = nil, options = {})
-      self.all.as_gql(query, options)
-    end
-
-    def as_gql(query = nil, options = {})
-      options_with_defaults = GqlSerializer.configuration.to_h.merge(options)
-      query_hasharray = query ? GqlSerializer.parse_query(query) : []
-      include_hasharray = GqlSerializer.query_include(self.class, query_hasharray)
-      if options_with_defaults[:preload]
-        GqlSerializer._preload([self], include_hasharray)
-        GqlSerializer.serialize(self, query_hasharray, options_with_defaults)
-      else
-        record = include_hasharray.empty? ? self : self.class.where(id: self).includes(include_hasharray).first
-        GqlSerializer.serialize(record, query_hasharray, options_with_defaults)
-      end
-    end
-  end
-
-  def self._preload(records, include_hasharray)
-    if ::ActiveRecord::VERSION::MAJOR >= 7
-      ::ActiveRecord::Associations::Preloader.
-        new(records: records, associations: include_hasharray).call
-    else
-      ::ActiveRecord::Associations::Preloader.
-        new.preload(records, include_hasharray)
-    end
-  end
-end
-
-ActiveRecord::Base.include GqlSerializer::ActiveRecord
-ActiveRecord::Relation.include GqlSerializer::Relation
-Array.include GqlSerializer::Array
+require "active_record"
+
+module GqlSerializer
+  module Array
+    def as_gql(*args)
+      map { |v| v.as_gql(*args) }
+    end
+  end
+
+  module Hash
+    def as_gql(query = nil, options = {})
+      options_with_default = GqlSerializer.configuration.to_h.merge(options)
+      query_hasharray = query ? GqlSerializer.parse_query(query) : []
+      GqlSerializer.serialize(self, query_hasharray, options_with_default)
+    end
+  end
+
+  module Object
+    def as_gql(query = nil, options = {})
+      options_with_default = GqlSerializer.configuration.to_h.merge(options)
+      query_hasharray = query ? GqlSerializer.parse_query(query) : []
+      GqlSerializer.serialize(self, query_hasharray, options_with_default)
+    end
+  end
+
+  module Relation
+    def as_gql(query = nil, options = {})
+      options_with_defaults = GqlSerializer.configuration.to_h.merge(options)
+      query_hasharray = query ? GqlSerializer.parse_query(query) : []
+      include_hasharray = GqlSerializer.query_include(self.model, query_hasharray)
+      records = self.includes(include_hasharray).records
+      GqlSerializer.serialize(records, query_hasharray, options_with_defaults)
+    end
+  end
+
+  module ActiveRecord
+    def self.as_gql(query = nil, options = {})
+      self.all.as_gql(query, options)
+    end
+
+    def as_gql(query = nil, options = {})
+      options_with_defaults = GqlSerializer.configuration.to_h.merge(options)
+      query_hasharray = query ? GqlSerializer.parse_query(query) : []
+      include_hasharray = GqlSerializer.query_include(self.class, query_hasharray)
+      if options_with_defaults[:preload]
+        GqlSerializer._preload([self], include_hasharray)
+        GqlSerializer.serialize(self, query_hasharray, options_with_defaults)
+      else
+        record = include_hasharray.empty? ? self : self.class.where(id: self).includes(include_hasharray).first
+        GqlSerializer.serialize(record, query_hasharray, options_with_defaults)
+      end
+    end
+  end
+
+  def self._preload(records, include_hasharray)
+    if ::ActiveRecord::VERSION::MAJOR >= 7
+      ::ActiveRecord::Associations::Preloader.
+        new(records: records, associations: include_hasharray).call
+    else
+      ::ActiveRecord::Associations::Preloader.
+        new.preload(records, include_hasharray)
+    end
+  end
+end
+
+ActiveRecord::Base.include GqlSerializer::ActiveRecord
+ActiveRecord::Relation.include GqlSerializer::Relation
+Array.include GqlSerializer::Array
+Hash.include GqlSerializer::Hash
+# This is invasive but users can choose to add `as_gql` to all objects in their project with:
+# Object.include GqlSerializer::Object

data/lib/gql_serializer/version.rb

@@ -1,3 +1,3 @@
-module GqlSerializer
-  VERSION = "2.2.0"
-end
+module GqlSerializer
+  VERSION = "3.0.0"
+end