solidus_graphql_api 0.2.0 → 0.3.0

data/README.md

@@ -1,8 +1,8 @@
 # SolidusGraphqlApi
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/8ea7739ad6726ad8cfa7/maintainability)](https://codeclimate.com/github/solidusio-contrib/solidus_graphql_api/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/8ea7739ad6726ad8cfa7/test_coverage)](https://codeclimate.com/github/solidusio-contrib/solidus_graphql_api/test_coverage)
-[![CircleCI](https://circleci.com/gh/solidusio-contrib/solidus_graphql_api.svg?style=shield)](https://circleci.com/gh/solidusio-contrib/solidus_graphql_api)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8ea7739ad6726ad8cfa7/maintainability)](https://codeclimate.com/github/solidusio/solidus_graphql_api/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/8ea7739ad6726ad8cfa7/test_coverage)](https://codeclimate.com/github/solidusio/solidus_graphql_api/test_coverage)
+[![CircleCI](https://circleci.com/gh/solidusio/solidus_graphql_api.svg?style=shield)](https://circleci.com/gh/solidusio/solidus_graphql_api)
 [![Gem Version](https://badge.fury.io/rb/solidus_graphql_api.svg)](https://badge.fury.io/rb/solidus_graphql_api)
 
 Provides a [graphql](https://graphql.org/) api for the [Solidus](https://github.com/solidusio/solidus) ecommerce framework.
@@ -36,7 +36,7 @@ POST http://localhost:3000/graphql
 
 ## Documentation
 
-The Solidus GraphQL API documentation can be found [here](https://solidusio-contrib.github.io/solidus_graphql_api/docs/).
+The Solidus GraphQL API documentation can be found [here](https://solidusio.github.io/solidus_graphql_api/docs/).
 
 ## Customizations
 

data/Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bundler/gem_tasks'
 require 'solidus_dev_support/rake_tasks'
 require 'graphql-docs'
 

data/bin/sandbox

@@ -22,7 +22,7 @@ if [ ! -z $SOLIDUS_BRANCH ]
 then
   BRANCH=$SOLIDUS_BRANCH
 else
-  BRANCH="master"
+  BRANCH="main"
 fi
 
 extension_name="solidus_graphql_api"
@@ -50,7 +50,6 @@ fi
 cd ./sandbox
 cat <<RUBY >> Gemfile
 gem 'solidus', github: 'solidusio/solidus', branch: '$BRANCH'
-gem 'solidus_auth_devise', '>= 2.1.0'
 gem 'rails-i18n'
 gem 'solidus_i18n'
 
@@ -69,13 +68,10 @@ unbundled bundle exec rake db:drop db:create
 
 unbundled bundle exec rails generate solidus:install \
   --auto-accept \
-  --user_class=Spree::User \
-  --enforce_available_locales=true \
-  --with-authentication=false \
+  --authentication=devise \
   --payment-method=none \
   $@
 
-unbundled bundle exec rails generate solidus:auth:install
 unbundled bundle exec rails generate ${extension_name}:install
 
 echo

data/lib/solidus_graphql_api/batch_loader.rb

@@ -108,7 +108,7 @@ module SolidusGraphqlApi
     end
 
     def graphql_loader_for(object_id, options = {}, &block)
-      ::BatchLoader::GraphQL.for(object_id).batch(default_options.merge(options), &block)
+      ::BatchLoader::GraphQL.for(object_id).batch(**default_options.merge(options), &block)
     end
   end
 end

data/lib/solidus_graphql_api/context.rb

@@ -3,7 +3,7 @@
 module SolidusGraphqlApi
   class Context
     AUTHORIZATION_HEADER = "Authorization"
-    TOKEN_PATTERN = /^Bearer (?<token>.*)/.freeze
+    TOKEN_PATTERN = /^Bearer (?<token>.*)/
 
     attr_reader :request, :headers
 
@@ -23,7 +23,7 @@ module SolidusGraphqlApi
 
     def current_user
       @current_user ||= begin
-        return nil unless bearer_token&.present?
+        return nil if bearer_token.blank?
 
         Spree.user_class.find_by(spree_api_key: bearer_token)
       end

data/lib/solidus_graphql_api/queries/taxon/children_query.rb

@@ -11,7 +11,7 @@ module SolidusGraphqlApi
         end
 
         def call
-          SolidusGraphqlApi::BatchLoader.for(taxon, :children, scope: Spree::Taxon.order(:position, :id))
+          SolidusGraphqlApi::BatchLoader.for(taxon, :children, scope: Spree::Taxon.order(:id))
         end
       end
     end

data/lib/solidus_graphql_api/queries/taxonomy/taxons_query.rb

@@ -11,7 +11,7 @@ module SolidusGraphqlApi
         end
 
         def call
-          SolidusGraphqlApi::BatchLoader.for(taxonomy, :taxons, scope: Spree::Taxon.order(:position, :id))
+          SolidusGraphqlApi::BatchLoader.for(taxonomy, :taxons, scope: Spree::Taxon.order(:id))
         end
       end
     end

data/lib/solidus_graphql_api/version.rb

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

data/solidus_graphql_api.gemspec

@@ -10,14 +10,14 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Solidus GraphQL API'
   spec.description = 'GraphQL comes to Solidus'
-  spec.homepage = 'https://github.com/solidusio-contrib/solidus_graphql_api'
+  spec.homepage = 'https://github.com/solidusio/solidus_graphql_api'
   spec.license = 'BSD-3-Clause'
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/solidusio-contrib/solidus_graphql_api'
-  spec.metadata['changelog_uri'] = 'https://github.com/solidusio-contrib/solidus_graphql_api/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/solidusio/solidus_graphql_api'
+  spec.metadata['changelog_uri'] = 'https://github.com/solidusio/solidus_graphql_api/releases'
 
-  spec.required_ruby_version = Gem::Requirement.new('~> 2.5')
+  spec.required_ruby_version = Gem::Requirement.new('~> 3.0')
 
   # 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.
@@ -31,8 +31,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'batch-loader', '~> 2.0'
   spec.add_dependency 'graphql', '>= 1.10', '< 1.13'
-  spec.add_dependency 'rails', '~> 6.1'
-  spec.add_dependency 'solidus_core', ['>= 2.10', '< 4']
+  spec.add_dependency 'solidus_core', ['>= 3.2', '< 5']
   spec.add_dependency 'solidus_support', '~> 0.6'
 
   spec.add_development_dependency 'graphql-docs', '~> 2.0.1'
@@ -41,5 +40,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'solidus_dev_support', '~> 2.4'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
-  spec.add_development_dependency 'with_model', '~> 2.1.2'
 end

data/spec/integration/mutations/checkout/add_addresses_to_checkout_spec.rb

@@ -13,7 +13,7 @@ RSpec.describe_mutation :add_addresses_to_checkout, mutation: :add_addresses_to_
     ]
   }
 
-  let(:country_id) { SolidusGraphqlApi::Schema.id_from_object(create(:country), nil, nil) }
+  let(:country_id) { SolidusGraphqlApi::Schema.id_from_object(create(:country, states_required: false), nil, nil) }
   let(:address) {
     address = build_stubbed(:address).slice(:address1, :city, :phone, :zipcode)
     address[:countryId] = country_id

data/spec/integration/queries/countries_spec.rb

@@ -9,8 +9,8 @@ RSpec.describe_query :countries, query: :countries, freeze_date: true do
     end
 
     context 'when countries exists' do
-      let!(:us_country) { create(:country, :with_states, id: 1) }
-      let!(:it_country) { create(:country, id: 2, iso: 'IT') }
+      let!(:us_country) { create(:country, :with_states, id: 1, states_required: false) }
+      let!(:it_country) { create(:country, id: 2, iso: 'IT', states_required: false) }
 
       it { is_expected.to match_response(:countries) }
     end

data/spec/integration/queries/current_user_spec.rb

@@ -12,8 +12,13 @@ RSpec.describe_query :current_user, query: :current_user, freeze_date: true do
            bill_address: bill_address)
   }
 
-  let(:ship_address) { create(:ship_address, id: 1, zipcode: 10_001) }
-  let(:bill_address) { create(:bill_address, id: 2, zipcode: 10_002) }
+  # Previos to Solidus v3.3, states_required was always false and the state was
+  # always automatically assigned. We force the behavior here to have the same
+  # response for any Solidus version.
+  let(:country) { create(:country, states_required: false) }
+  let(:state) { create(:state, name: "Alabama", abbr: "AL", country: country) }
+  let(:ship_address) { create(:ship_address, id: 1, zipcode: 10_001, country: country, state: state) }
+  let(:bill_address) { create(:bill_address, id: 2, zipcode: 10_002, country: country, state: state) }
   let(:credit_card) {
     create(:credit_card,
            user: user,

data/spec/integration/queries/taxonomies_spec.rb

@@ -9,9 +9,12 @@ RSpec.describe_query :taxonomies do
     end
 
     context 'when taxonomies exists' do
-      let!(:brand_taxonomy) { create(:taxonomy, :with_taxon_meta, :with_root_icon, id: 1, root_taxon_id: 1) }
+      let!(:brand_taxonomy) do
+        create(:taxonomy, :with_taxon_meta, :with_root_icon, id: 1, name: "Brand", root_taxon_id: 1)
+      end
       let!(:category_taxonomy) { create(:taxonomy, :with_root_icon, id: 2, name: 'Category', root_taxon_id: 2) }
-      let!(:taxon) { create(:taxon, :with_icon, id: 3, name: 'Solidus', taxonomy: brand_taxonomy) }
+      # Need to reload taxon to get the correct icon url, because the icon is attached after the taxon is created
+      let!(:taxon) { create(:taxon, :with_icon, id: 3, name: 'Solidus', taxonomy: brand_taxonomy).tap(&:reload) }
 
       before do
         taxon.update(parent: brand_taxonomy.root)

data/spec/lib/solidus_graphql_api/batch_loader/belongs_to_spec.rb

@@ -2,7 +2,9 @@
 
 require 'spec_helper'
 
-RSpec.describe SolidusGraphqlApi::BatchLoader::BelongsTo do
+RSpec.describe SolidusGraphqlApi::BatchLoader::BelongsTo, skip: (ENV["DB"] == "mysql") do
+  include Helpers::ActiveRecord
+
   subject(:loader) do
     described_class.new(
       object,
@@ -14,19 +16,21 @@ RSpec.describe SolidusGraphqlApi::BatchLoader::BelongsTo do
   let(:options) { {} }
 
   context 'with a regular association' do
-    with_model :Article, scope: :all do
-      model do
-        has_many :comments
+    before do
+      run_migrations do
+        create_table :articles, force: true
+        create_table :comments, force: true do |t|
+          t.belongs_to :article
+        end
       end
+      create_model("Article")
+      create_model("Comment") { belongs_to :article }
     end
 
-    with_model :Comment, scope: :all do
-      table do |t|
-        t.belongs_to :article
-      end
-
-      model do
-        belongs_to :article
+    after do
+      run_migrations do
+        drop_table :articles
+        drop_table :comments
       end
     end
 
@@ -39,21 +43,16 @@ RSpec.describe SolidusGraphqlApi::BatchLoader::BelongsTo do
   end
 
   context 'with a polymorphic association' do
-    with_model :Image, scope: :all do
-      table do |t|
-        t.integer :imageable_id
-        t.string :imageable_type
-      end
-
-      model do
-        belongs_to :imageable, polymorphic: true
-      end
-    end
-
-    with_model :Article, scope: :all do
-      model do
-        has_many :images, as: :imageable
+    before do
+      run_migrations do
+        create_table :images, force: true do |t|
+          t.integer :imageable_id
+          t.string :imageable_type
+        end
+        create_table :articles, force: true
       end
+      create_model("Image") { belongs_to :imageable, polymorphic: true }
+      create_model("Article") { has_many :images, as: :imageable }
     end
 
     let!(:object) { Image.create!(imageable: Article.create!) }

data/spec/lib/solidus_graphql_api/batch_loader/has_many_spec.rb

@@ -2,7 +2,9 @@
 
 require 'spec_helper'
 
-RSpec.describe SolidusGraphqlApi::BatchLoader::HasMany do
+RSpec.describe SolidusGraphqlApi::BatchLoader::HasMany, skip: (ENV["DB"] == "mysql") do
+  include Helpers::ActiveRecord
+
   subject(:loader) do
     described_class.new(
       article,
@@ -10,28 +12,28 @@ RSpec.describe SolidusGraphqlApi::BatchLoader::HasMany do
     )
   end
 
-  with_model :Article, scope: :all do
-    model do
-      has_many :comments
+  before do
+    run_migrations do
+      create_table :articles, force: true
+      create_table :comments, force: true do |t|
+        t.belongs_to :article
+      end
     end
-  end
+    create_model("Article") { has_many :comments }
+    create_model("Comment") { belongs_to :article }
 
-  with_model :Comment, scope: :all do
-    table do |t|
-      t.belongs_to :article
-    end
+    article.comments.create!
+  end
 
-    model do
-      belongs_to :article
+  after do
+    run_migrations do
+      drop_table :articles
+      drop_table :comments
     end
   end
 
   let!(:article) { Article.create! }
 
-  before do
-    article.comments.create!
-  end
-
   it 'loads the association properly' do
     expect(loader.load.sync).to eq(article.comments)
   end

data/spec/lib/solidus_graphql_api/batch_loader/has_many_through_spec.rb

@@ -2,7 +2,9 @@
 
 require 'spec_helper'
 
-RSpec.describe SolidusGraphqlApi::BatchLoader::HasManyThrough do
+RSpec.describe SolidusGraphqlApi::BatchLoader::HasManyThrough, skip: (ENV["DB"] == "mysql") do
+  include Helpers::ActiveRecord
+
   subject(:loader) do
     described_class.new(
       physician,
@@ -10,37 +12,40 @@ RSpec.describe SolidusGraphqlApi::BatchLoader::HasManyThrough do
     )
   end
 
-  with_model :Physician, scope: :all do
-    model do
+  before do
+    run_migrations do
+      create_table :physicians, force: true
+      create_table :patients, force: true
+      create_table :appointments, force: true do |t|
+        t.belongs_to :physician
+        t.belongs_to :patient
+      end
+    end
+    create_model("Physician") do
       has_many :appointments
       has_many :patients, through: :appointments
     end
-  end
-
-  with_model :Appointment, scope: :all do
-    table do |t|
-      t.belongs_to :physician, index: { name: :appointment_on_physician }
-      t.belongs_to :patient
+    create_model("Patient") do
+      has_many :appointments
     end
-
-    model do
+    create_model("Appointment") do
       belongs_to :physician
       belongs_to :patient
     end
+
+    physician.appointments.create!(patient: Patient.create!)
   end
 
-  with_model :Patient, scope: :all do
-    model do
-      has_many :appointments
+  after do
+    run_migrations do
+      drop_table :physicians
+      drop_table :patients
+      drop_table :appointments
     end
   end
 
   let!(:physician) { Physician.create! }
 
-  before do
-    physician.appointments.create!(patient: Patient.create!)
-  end
-
   it 'loads the association properly' do
     expect(loader.load.sync).to eq(physician.patients)
   end

data/spec/lib/solidus_graphql_api/batch_loader/has_one_spec.rb

@@ -2,7 +2,9 @@
 
 require 'spec_helper'
 
-RSpec.describe SolidusGraphqlApi::BatchLoader::HasOne do
+RSpec.describe SolidusGraphqlApi::BatchLoader::HasOne, skip: (ENV["DB"] == "mysql") do
+  include Helpers::ActiveRecord
+
   subject(:loader) do
     described_class.new(
       article,
@@ -10,28 +12,28 @@ RSpec.describe SolidusGraphqlApi::BatchLoader::HasOne do
     )
   end
 
-  with_model :Article, scope: :all do
-    model do
-      has_one :image
+  before do
+    run_migrations do
+      create_table :articles, force: true
+      create_table :images, force: true do |t|
+        t.belongs_to :article
+      end
     end
-  end
+    create_model("Article") { has_one :image }
+    create_model("Image") { belongs_to :article }
 
-  with_model :Image, scope: :all do
-    table do |t|
-      t.belongs_to :article
-    end
+    article.create_image!
+  end
 
-    model do
-      belongs_to :article
+  after do
+    run_migrations do
+      drop_table :articles
+      drop_table :images
     end
   end
 
   let!(:article) { Article.create! }
 
-  before do
-    article.create_image!
-  end
-
   it 'loads the association properly' do
     expect(loader.load.sync).to eq(article.image)
   end

data/spec/lib/solidus_graphql_api/queries/taxon/children_query_spec.rb

@@ -3,9 +3,13 @@
 require 'spec_helper'
 
 RSpec.describe SolidusGraphqlApi::Queries::Taxon::ChildrenQuery do
-  let(:taxon) { create(:taxon) }
-
-  let!(:children) { create_list(:taxon, 2, parent: taxon) }
-
-  it { expect(described_class.new(taxon: taxon).call.sync).to match_array(children) }
+  it do
+    taxonomy = create(:taxonomy)
+    root = taxonomy.root
+    children = [
+      create(:taxon, name: "Taxon one", parent: root),
+      create(:taxon, name: "Taxon two", parent: root)
+    ]
+    expect(described_class.new(taxon: root).call.sync).to match_array(children)
+  end
 end

data/spec/lib/solidus_graphql_api/queries/taxonomy/taxons_query_spec.rb

@@ -3,9 +3,12 @@
 require 'spec_helper'
 
 RSpec.describe SolidusGraphqlApi::Queries::Taxonomy::TaxonsQuery do
-  let(:taxons) { build_list(:taxon, 2) }
-
-  let(:taxonomy) { create(:taxonomy, taxons: taxons) }
-
-  it { expect(described_class.new(taxonomy: taxonomy).call.sync).to match_array(taxons) }
+  it do
+    taxonomy = create(:taxonomy)
+    root_taxon = taxonomy.root
+    taxon = create(:taxon, taxonomy: taxonomy, parent: root_taxon)
+    create(:taxon)
+
+    expect(described_class.new(taxonomy: taxonomy).call.sync).to match_array([root_taxon, taxon])
+  end
 end

data/spec/spec_helper.rb

@@ -14,7 +14,6 @@ require dummy_env
 # Requires factories and other useful helpers defined in spree_core.
 require 'solidus_dev_support/rspec/feature_helper'
 require "graphql/schema_comparator"
-require 'with_model'
 require 'timecop'
 
 # Requires supporting ruby files with custom matchers and macros, etc,
@@ -35,7 +34,12 @@ RSpec.configure do |config|
 
   if defined?(ActiveStorage::Current)
     config.before(:all) do
-      ActiveStorage::Current.host = 'https://www.example.com'
+      test_host = 'https://www.example.com'
+      if Rails.gem_version >= Gem::Version.new(7)
+        ActiveStorage::Current.url_options = { host: test_host }
+      else
+        ActiveStorage::Current.host = test_host
+      end
     end
   end
 
@@ -63,6 +67,4 @@ RSpec.configure do |config|
       example.run
     end
   end
-
-  config.extend WithModel
 end

data/spec/support/helpers/active_record.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Helpers
+  module ActiveRecord
+    def run_migrations(&block)
+      migration = Class.new(::ActiveRecord::Migration[6.1]).tap do |klass|
+        klass.define_method(:up, &block)
+      end
+      ::ActiveRecord::Migration.suppress_messages { migration.migrate(:up) }
+    end
+
+    def create_model(name, &block)
+      stub_const(name, Class.new(ApplicationRecord)).tap do |klass|
+        klass.class_eval(&block) if block_given?
+      end
+    end
+  end
+end

data/spec/support/helpers/graphql.rb

@@ -14,12 +14,12 @@ module Helpers
       JSON.parse(result.to_json, object_class: object_class, symbolize_names: true)
     end
 
-    def execute_query(*args)
-      execute(RSpec.configuration.graphql_queries_dir, *args)
+    def execute_query(*args, **kwargs)
+      execute(RSpec.configuration.graphql_queries_dir, *args, **kwargs)
     end
 
-    def execute_mutation(*args)
-      execute(RSpec.configuration.graphql_mutations_dir, *args)
+    def execute_mutation(*args, **kwargs)
+      execute(RSpec.configuration.graphql_mutations_dir, *args, **kwargs)
     end
 
     def decode_field_ids(field)