graphql_scaffold_fan 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b89f177d02c073eedb6222ef8caf94defdbde92c973490bb497175ab9ab9c3
-  data.tar.gz: 4075e692e0ecb7e3416fc2b64c630e6f203b392e39cb1ade162092056d07422a
+  metadata.gz: 5ba50341e941f5a2367cb3a550f3701fc59eacbbb550184a9e697229b07e8ae4
+  data.tar.gz: 687c142252f59cb524e2e3f01b8bc3aac8ed8cca769659e4cf5171b2c5710de1
 SHA512:
-  metadata.gz: e032c47e83be49a405a772d6d4db361ce260fb172995067d245d039f413efb4a88479f9492cd63f94d45fb9acd6d24cccff5e0bc36bbadf2b3e663798c6b2f3d
-  data.tar.gz: 1d9b2f0c1e049f07d3e8c3882a8d27e10be2a292e5462c1080f771d2c3a99f8bc990773fbc95b9bbcf9d1edd953ea689ce3ddd7a5bbc10ca7b7dd676f6d2b3f1
+  metadata.gz: 63d9ae28ce65ecae2f72ccddde40639eb6185624b12ce6a585d48ff8f70d858d73fa923b6ef3b25b9529c849b17f3d425d87e585a4cb145c79faed8267ab4b39
+  data.tar.gz: d482fe72bcffba00321c07c0e708864182812655197a415319f8eeca4d695c5d4cf2d6f33edd79ce02a4975c84d3bfe79db938b32bc494be7d469fe07e84ceef

data/Gemfile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in graphql_scaffold_fan.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'

data/README.md

@@ -32,4 +32,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/graphql_scaffold_fan.
+Bug reports and pull requests are welcome on GitHub at https://github.com/FanZhangYYDSPixelforce/graphql_scaffold.

data/Rakefile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 task default: %i[]

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "graphql_scaffold_fan"
+require 'bundler/setup'
+require 'graphql_scaffold_fan'
 
 # 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.
@@ -11,5 +11,5 @@ require "graphql_scaffold_fan"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/graphql_scaffold_fan.gemspec

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require_relative "lib/graphql_scaffold_fan/version"
+require_relative 'lib/graphql_scaffold_fan/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "graphql_scaffold_fan"
+  spec.name          = 'graphql_scaffold_fan'
   spec.version       = GraphqlScaffoldFan::VERSION
-  spec.authors       = ["Fan Zhang"]
-  spec.email         = ["fan.zhang@pixelforce.com.au"]
+  spec.authors       = ['Fan Zhang']
+  spec.email         = ['fan.zhang@pixelforce.com.au']
 
-  spec.summary       = "Helping creating graphql files"
-  spec.description   = "Helping creating graphql files"
+  spec.summary       = 'Helping creating graphql files'
+  spec.description   = 'Helping creating graphql files'
   spec.homepage      = ''
 
   # Specify which files should be added to the gem when it is released.
@@ -17,13 +17,13 @@ Gem::Specification.new do |spec|
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
-end
+end

data/lib/generators/graphql_scaffold/init_generator.rb

@@ -0,0 +1,46 @@
+require 'rails/generators/base'
+module GraphqlScaffold
+  module Generators
+    class InitGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __dir__)
+
+      def create_ListMetadataType_file
+        dir_path = 'app/graphql/types/admin'
+        file_path = dir_path + '/list_metadata_type.rb'
+        FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path)
+
+        if File.exist?(file_path)
+          p 'File list_metadata_type.rb already exists'
+        else
+          template 'list_metadata_type.haml', file_path
+        end
+      end
+
+      def create_admin_schema_file
+        @top_folder_name = File.basename(Dir.getwd)
+        dir_path = 'app/graphql'
+        file_path = dir_path + "#{@top_folder_name.underscore}_admin_schema.rb"
+        FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path)
+
+        if File.exist?(file_path)
+          p "File #{@top_folder_name}_admin_schema.rb already exists"
+        else
+          template 'admin_schema.haml', file_path
+        end
+      end
+
+      def create_admin_controller_file
+        @top_folder_name = File.basename(Dir.getwd)
+        dir_path = 'app/controllers'
+        file_path = dir_path + '/admin_graphql_controller.rb'
+        FileUtils.mkdir_p(dir_path) unless File.exist?(dir_path)
+
+        if File.exist?(file_path)
+          p 'File admin_graphql_controller.rb already exists'
+        else
+          template 'admin_controller.haml', file_path
+        end
+      end
+    end
+  end
+end

data/lib/generators/graphql_scaffold/mutation_generator.rb

@@ -4,17 +4,44 @@ module GraphqlScaffold
     class MutationGenerator < Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __dir__)
 
+      def create_base_admin_mutation_file
+        mutations_dir_path = 'app/graphql/mutations'
+        generator_path = mutation_type_dir_path + '/base_admin_mutation.rb'
+
+        FileUtils.mkdir_p(mutation_type_dir_path) unless File.exist?(mutation_type_dir_path)
+
+        if File.exist?(generator_path)
+          p 'File base_admin_mutation.rb already exists'
+        else
+          template 'base_admin_mutation.haml', generator_path
+        end
+      end
+
       def create_admin_mutation_folders
         admin_mutation_dir_path = 'app/graphql/mutations/admin'
         generator_dir_path = admin_mutation_dir_path + ("/#{@module_name.underscore}" if @module_name.present?).to_s
         @generator_path = generator_dir_path + "/#{file_name}s"
 
+        admin_mutation_test_dir_path = 'spec/graphql/mutations/admin'
+        generator_test_dir_path = admin_mutation_test_dir_path + (if @module_name.present?
+                                                                    "/#{@module_name.underscore}"
+                                                                  end).to_s
+        @generator_test_path = generator_test_dir_path + "/#{file_name}s"
+
         FileUtils.mkdir_p(admin_mutation_dir_path) unless File.exist?(admin_mutation_dir_path)
+        FileUtils.mkdir_p(admin_mutation_test_dir_path) unless File.exist?(admin_mutation_test_dir_path)
+
         if File.exist?(@generator_path)
           p 'Folder already exist'
         elsif Dir.mkdir(@generator_path)
           p 'Folder created successfully'
         end
+
+        if File.exist?(@generator_test_path)
+          p 'Mutation Test Folder already exist'
+        elsif Dir.mkdir(@generator_test_path)
+          p 'Mutation Test Folder created successfully'
+        end
       end
 
       def create_admin_mutation_create_file
@@ -26,6 +53,15 @@ module GraphqlScaffold
             template 'mutation_create.haml', create_file_path
           end
         end
+
+        if File.exist?(@generator_test_path)
+          create_test_file_path = @generator_test_path + "/create_#{file_name}_spec.rb"
+          if File.exist?(create_test_file_path)
+            p 'Mutation_Create_Test File already exist'
+          else
+            template 'mutation_create_test.haml', create_test_file_path
+          end
+        end
       end
 
       def create_admin_mutation_update_file
@@ -37,6 +73,15 @@ module GraphqlScaffold
             template 'mutation_update.haml', update_file_path
           end
         end
+
+        if File.exist?(@generator_test_path)
+          update_test_file_path = @generator_test_path + "/update_#{file_name}_spec.rb"
+          if File.exist?(update_test_file_path)
+            p 'Mutation_Update_Test File already exist'
+          else
+            template 'mutation_update_test.haml', update_test_file_path
+          end
+        end
       end
 
       def create_admin_mutation_delete_file
@@ -48,6 +93,15 @@ module GraphqlScaffold
             template 'mutation_delete.haml', delete_file_path
           end
         end
+
+        if File.exist?(@generator_test_path)
+          delete_test_file_path = @generator_test_path + "/delete_#{file_name}_spec.rb"
+          if File.exist?(delete_test_file_path)
+            p 'Mutation_Delete_Test File already exist'
+          else
+            template 'mutation_delete_test.haml', delete_test_file_path
+          end
+        end
       end
 
       def create_mutation_type_file
@@ -77,4 +131,4 @@ module GraphqlScaffold
       end
     end
   end
-end
+end

data/lib/generators/graphql_scaffold/type_generator.rb

@@ -9,7 +9,7 @@ module GraphqlScaffold
 
           src_file = "app/graphql/types/#{file_name}_type.rb"
           dst_dir = 'app/graphql/types/admin'
-          if File.exist? ("app/graphql/types/#{file_name}_type.rb")
+          if File.exist?("app/graphql/types/#{file_name}_type.rb")
             FileUtils.mv(src_file, dst_dir)
             file = File.open("#{dst_dir}/#{file_name}_type.rb")
             file_data = file.read

data/lib/generators/templates/admin_controller.haml

@@ -0,0 +1,64 @@
+class AdminGraphqlController < ApplicationController
+  include GraphqlDevise::Concerns::SetUserByToken
+
+  attr_reader :current_resource
+
+  # If accessing from outside this domain, nullify the session
+  # This allows for outside API access while preventing CSRF attacks,
+  # but you'll have to authenticate your user separately
+  protect_from_forgery with: :null_session
+  after_action :track_action
+
+  def execute
+    variables = prepare_variables(params[:variables])
+    query = params[:query]
+    operation_name = params[:operationName]
+
+    context = gql_devise_context(AdminUser)
+
+    @current_resource = context[:current_resource]
+
+    result = <%= @top_folder_name.camelize %>AdminSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
+    render json: result
+  rescue StandardError => e
+    raise e unless Rails.env.development?
+
+    handle_error_in_development(e)
+  end
+
+  private
+
+  # Handle variables in form data, JSON body, or a blank value
+  def prepare_variables(variables_param)
+    case variables_param
+    when String
+      if variables_param.present?
+        JSON.parse(variables_param) || {}
+      else
+        {}
+      end
+    when Hash
+      variables_param
+    when ActionController::Parameters
+      variables_param.to_unsafe_hash # GraphQL-Ruby will validate name and type of incoming variables.
+    when nil
+      {}
+    else
+      raise ArgumentError, "Unexpected parameter: #{variables_param}"
+    end
+  end
+
+  def handle_error_in_development(err)
+    logger.error err.message
+    logger.error err.backtrace.join("\n")
+
+    render json: { errors: [{ message: err.message, backtrace: err.backtrace }], data: {} }, status: :internal_server_error
+  end
+
+  def track_action
+    variables = prepare_variables(params[:variables])
+    query = params[:query]
+    operation_name = params[:operationName]
+    ahoy.track 'Admin Portal', query: query, variables: variables, operation_name: operation_name
+  end
+end

data/lib/generators/templates/admin_filter.haml

@@ -1,7 +1,7 @@
 module Types
   module Inputs
     module Admin
-      class <%= class_name %> < Types::BaseInputObject
+      class <%= class_name %>Filter < Types::BaseInputObject
         argument :ids, [ID], required: false
 
         def prepare

data/lib/generators/templates/admin_schema.haml

@@ -0,0 +1,42 @@
+class <%= @top_folder_name.camelize %>AdminSchema < GraphQL::Schema
+  use GraphQL::Tracing::NewRelicTracing, set_transaction_name: true
+  use GraphqlDevise::SchemaPlugin.new(
+    query:            Types::Query::AdminUserQueryType,
+    mutation:         Types::Mutation::AdminUserMutationType,
+    resource_loaders: [
+      GraphqlDevise::ResourceLoader.new(AdminUser, only: %i[login logout])
+    ]
+  )
+
+  mutation(Types::Mutation::AdminUserMutationType)
+  query(Types::Query::AdminUserQueryType)
+
+  use GraphQL::Batch
+
+  # Union and Interface Resolution
+  def self.resolve_type(_abstract_type, _obj, _ctx)
+    # TODO: Implement this function
+    # to return the correct object type for `obj`
+    raise(GraphQL::RequiredImplementationMissingError)
+  end
+
+  # Relay-style Object Identification:
+
+  # Return a string UUID for `object`
+  def self.id_from_object(object, type_definition, _query_ctx)
+    # Here's a simple implementation which:
+    # - joins the type name & object.id
+    # - encodes it with base64:
+    GraphQL::Schema::UniqueWithinType.encode(type_definition.name, object.id)
+  end
+
+  # Given a string UUID, find the object
+  def self.object_from_id(id, _query_ctx)
+    # For example, to decode the UUIDs generated above:
+    type_name, item_id = GraphQL::Schema::UniqueWithinType.decode(id)
+    #
+    # Then, based on `type_name` and `id`
+    # find an object in your application
+    # ...
+  end
+end

data/lib/generators/templates/base_admin_mutation.haml

@@ -0,0 +1,4 @@
+module Mutations
+  class BaseAdminMutation < GraphQL::Schema::Mutation
+  end
+end

data/lib/generators/templates/list_metadata_type.haml

@@ -0,0 +1,7 @@
+module Types
+  module Admin
+    class ListMetadataType < Types::BaseObject
+      field :count, Integer, null: false
+    end
+  end
+end

data/lib/generators/templates/mutation_create.haml

@@ -4,8 +4,13 @@ module Mutations
 
       type Types::Admin::<%= class_name %>Type
 
-      def resolve(id:, **args)
-        
+      def resolve(**args)
+         <%= class_name.underscore %> = <%= class_name %>.new(args)
+        if  <%= class_name.underscore %>.save
+           <%= class_name.underscore %>
+        else
+          context.add_error(GraphQL::ExecutionError.new( <%= class_name.underscore %>.errors.full_messages.join(', ')))
+        end
       end
     end
   end

data/lib/generators/templates/mutation_create_test.haml

@@ -0,0 +1,32 @@
+require 'rails_helper'
+
+RSpec.describe Mutations::Admin::<%= class_name %>s::Create<%= class_name %>, type: :request do
+  let(:admin_user) { create(:admin_user) }
+
+  describe '.resolve' do
+    it 'should create' do
+      variables = <<~GQL
+        {
+        }
+      GQL
+
+      expect do
+        sign_in admin_user
+        post '/api/admin/graphql', headers: admin_user.create_new_auth_token, params: { query: query, variables: variables }
+        expect(response).to have_http_status(:success)
+        json = JSON.parse(response.body)
+        data = json['data']['create<%= class_name %>']
+      end.to change { <%= class_name %>.count }.by(1)
+    end
+  end
+
+  def query
+    <<~GQL
+      mutation create<%= class_name %>() {
+        create<%= class_name %>(){
+          id
+        }
+      }
+    GQL
+  end
+end

data/lib/generators/templates/mutation_delete.haml

@@ -4,8 +4,10 @@ module Mutations
 
       type Types::Admin::<%= class_name %>Type
 
-      def resolve(id:, **args)
-        
+      def resolve(id:)
+        <%= class_name.underscore %> = ::<%= class_name %>.find(id)
+        <%= class_name.underscore %>.destroy!
+        <%= class_name.underscore %>
       end
     end
   end

data/lib/generators/templates/mutation_delete_test.haml

@@ -0,0 +1,37 @@
+require 'rails_helper'
+
+RSpec.describe Mutations::Admin::<%= class_name %>s::Delete<%= class_name %>, type: :request do
+  let(:admin_user) { create :admin_user }
+  let(:<%= class_name.underscore %>) { create :<%= class_name.underscore %> }
+
+  describe '.resolve' do
+    it 'should delete' do
+      admin_user = create(:admin_user)
+      sign_in admin_user
+
+      variables = <<~GQL
+        {
+          "id": "#{<%= class_name.underscore %>.id}"
+        }
+      GQL
+
+      headers = admin_user.create_new_auth_token
+
+      post '/api/admin/graphql', headers: headers, params: { query: query, variables: variables }
+      expect(response).to have_http_status(:success)
+      json = JSON.parse(response.body)
+
+      expect { <%= class_name %>.find(<%= class_name.underscore %>.id) }.to raise_error ActiveRecord::RecordNotFound
+    end
+  end
+
+  def query
+    <<~GQL
+      mutation delete<%= class_name %>($id: ID!) {
+        delete<%= class_name %>(id: $id){
+          id
+        }
+      }
+    GQL
+  end
+end

data/lib/generators/templates/mutation_update.haml

@@ -5,7 +5,12 @@ module Mutations
       type Types::Admin::<%= class_name %>Type
 
       def resolve(id:, **args)
-        
+        <%= class_name.underscore %> = <%= class_name %>.find(id)
+        if <%= class_name.underscore %>.update(args)
+          <%= class_name.underscore %>
+        else
+          context.add_error(GraphQL::ExecutionError.new(<%= class_name.underscore %>.errors.full_messages.join(', ')))
+        end
       end
     end
   end

data/lib/generators/templates/mutation_update_test.haml

@@ -0,0 +1,35 @@
+require 'rails_helper'
+
+RSpec.describe Mutations::Admin::<%= class_name %>s::Update<%= class_name %>, type: :request do
+  let(:admin_user) { create :admin_user }
+  let(:<%= class_name.underscore %>) { create :<%= class_name.underscore %> }
+
+  describe '.resolve' do
+    it 'should update' do
+      sign_in admin_user
+
+      variables = <<~GQL
+        {
+          "id":    "#{<%= class_name.underscore %>.id}"
+        }
+      GQL
+
+      post '/api/admin/graphql', headers: admin_user.create_new_auth_token, params: { query: query, variables: variables }
+      expect(response).to have_http_status(:success)
+      json = JSON.parse(response.body)
+
+      data = json['data']['update<%= class_name %>']
+      expect(data['id']).to eq <%= class_name.underscore %>.id.to_s
+    end
+  end
+
+  def query
+    <<~GQL
+      mutation update<%= class_name %>($id: ID!) {
+        update<%= class_name %>(id: $id){
+          id
+        }
+      }
+    GQL
+  end
+end

data/lib/graphql_scaffold_fan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlScaffoldFan
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

data/lib/graphql_scaffold_fan.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "graphql_scaffold_fan/version"
+require_relative 'graphql_scaffold_fan/version'
 
 module GraphqlScaffold
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_scaffold_fan
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Fan Zhang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-21 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies: []
 description: Helping creating graphql files
 email:
@@ -26,15 +26,23 @@ files:
 - bin/console
 - bin/setup
 - graphql_scaffold_fan.gemspec
+- lib/generators/graphql_scaffold/init_generator.rb
 - lib/generators/graphql_scaffold/mutation_generator.rb
 - lib/generators/graphql_scaffold/type_generator.rb
+- lib/generators/templates/admin_controller.haml
 - lib/generators/templates/admin_filter.haml
+- lib/generators/templates/admin_schema.haml
+- lib/generators/templates/base_admin_mutation.haml
 - lib/generators/templates/base_object.haml
+- lib/generators/templates/list_metadata_type.haml
 - lib/generators/templates/mutation_create.haml
+- lib/generators/templates/mutation_create_test.haml
 - lib/generators/templates/mutation_delete.haml
+- lib/generators/templates/mutation_delete_test.haml
 - lib/generators/templates/mutation_test.haml
 - lib/generators/templates/mutation_type.haml
 - lib/generators/templates/mutation_update.haml
+- lib/generators/templates/mutation_update_test.haml
 - lib/generators/templates/query_test.haml
 - lib/generators/templates/query_type.haml
 - lib/graphql_scaffold_fan.rb