graphql-rails-generators 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9068fe37ce3d14aea970bad494696cb852365038b50782ae4decffd4f70130ac
+  data.tar.gz: 9a07980ae9886f1015e4873d9a33b4123dac3cf7aac04bb0cc8035a406e5b45c
+SHA512:
+  metadata.gz: 656cb0197471b75bea857458eb6bc59dce4937caba86835fce3b09f2d45ce59210e061f10ead1d9b20784576b775cc010b3d86837ade2c2ee55cd1641d054ba2
+  data.tar.gz: d1b073eb0fbf73b19c0ec0d3da6c3d220f17b071a87e7cf69b3b8ae7ebdb146b005c3cff148dcd8f2123845c16ccf4e5842170a6cd61ac727e06e9d39385a977

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Alex Sharp
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# graphql-rails-generators
+
+A few generators to make it easy to integrate your Rails models with [graphql-ruby](https://github.com/rmosolgo/graphql-ruby). I created this because I was wasting too many keystrokes copying my model schema by hand to create graphql types.
+
+This project contains three generators that look at your ActiveRecord model schema and generates graphql types for you.
+
+* `gql:model_type Post` - Generate a graphql type for a model
+* `gql:input Post` - Generate a graphql input type for a model
+* `gql:mutation Update Post` - Generate a graphql mutation class for a model
+
+## Installation
+
+```
+gem 'graphql-rails-generators', group: :development
+```
+
+## Requirements
+
+This library only supports ActiveRecord, though it would be fairly trivial to add support for other ORMs.
+
+## Usage
+
+### gql:model_type
+
+Generate a model type from a model.
+
+```
+$ rails generate gql:model_type MODEL_CLASS
+```
+
+Result:
+
+```ruby
+# app/graphql/post_type.rb
+module Types
+  class PostType < Types::BaseObject
+    field :id, Int, null: true
+    field :title, String, null: true
+    field :body, String, null: true
+    field :created_at, GraphQL::Types::ISO8601DateTime, null: true
+    field :updated_at, GraphQL::Types::ISO8601DateTime, null: true
+  end
+end
+```
+
+### gql:input MODEL_CLASS
+
+Generate an input type from a model.
+
+```
+rails generate gql:input Post
+```
+
+Result:
+```ruby
+# app/graphql/types/post_input.rb
+module Types
+  module Input
+    class PostInput < Types::BaseInputObject
+      argument :title, String, required: false
+      argument :body, String, required: false
+    end
+  end
+end
+```
+
+### gql:mutation MUTATION_PREFIX MODEL_NAME
+
+Generate a mutation class from a model.
+
+A quick note about the mutation generator...
+
+The mutation generator generates something akin to an "upsert" mutation. It takes two arguments: an optional `id` and an optional `attributes`, which is the input type for the model. If you pass an `id`, it will attempt to find the model by the `id` and update it, otherwise it will initialize a new model and attempt to save it.
+
+```
+rails generate gql:mutation Update Post
+```
+
+Result:
+```ruby
+# app/graphql/mutations/update_post.rb
+module Mutations
+  class UpdatePost < Mutations::BaseMutation
+    field :post, Types::PostType, null: true
+
+    argument :attributes, Types::Input::PostInput, required: true
+    argument :id, Int, required: false
+
+    def resolve(attributes:, id: nil)
+      model = find_or_build_model(id)
+      model.attributes = attributes.to_h
+      if model.save
+        {post: model}
+      else
+        {errors: model.errors.full_messages}
+      end
+    end
+
+    def find_or_build_model(id)
+      if id
+        Post.find(id)
+      else
+        Post.new
+      end
+    end
+  end
+end
+```

data/lib/generators/gql/gql_generator_base.rb

@@ -0,0 +1,32 @@
+require 'rails/generators/base'
+# require 'active_support/extend'
+module Gql
+  module GqlGeneratorBase
+    extend ActiveSupport::Concern
+
+    included do
+      protected
+      def type_map
+        {
+          integer: 'Int',
+          string: 'String',
+          boolean: 'Boolean',
+          decimal: 'Float',
+          datetime: 'GraphQL::Types::ISO8601DateTime',
+          date: 'GraphQL::Types::ISO8601Date',
+          hstore: 'GraphQL::Types::JSON'
+        }
+      end
+  
+      def map_model_types(model_name)
+        klass = model_name.constantize
+        associations = klass.reflect_on_all_associations(:belongs_to)
+        bt_columns = associations.map(&:foreign_key)
+  
+        klass.columns
+          .reject { |col| bt_columns.include?(col.name) }
+          .map { |col| {name: col.name, gql_type: type_map.fetch(col.type)} }
+      end
+    end
+  end
+end

data/lib/generators/gql/input_generator.rb

@@ -0,0 +1,17 @@
+require_relative 'gql_generator_base'
+module Gql
+  class InputGenerator < Rails::Generators::Base
+    include GqlGeneratorBase
+    source_root File.expand_path('../templates', __FILE__)
+    argument :model_name, type: :string
+  
+    def generate_input_type
+      file_name = model_name
+
+      ignore = ['id', 'created_at', 'updated_at']
+      @fields = map_model_types(model_name).reject { |field| ignore.include?(field[:name]) }
+
+      template('input_type.rb', "app/graphql/types/input/#{file_name.underscore}_input.rb")
+    end
+  end
+end

data/lib/generators/gql/model_type_generator.rb

@@ -0,0 +1,14 @@
+require_relative 'gql_generator_base'
+module Gql
+  class ModelTypeGenerator < Rails::Generators::Base
+    include GqlGeneratorBase
+    source_root File.expand_path('../templates', __FILE__)
+    argument :model_name, type: :string
+
+    def type
+      file_name = "#{model_name.underscore}_type"
+      @fields = map_model_types(model_name)
+      template('model_type.rb', "app/graphql/types/#{file_name}.rb")
+    end
+  end
+end

data/lib/generators/gql/mutation_generator.rb

@@ -0,0 +1,13 @@
+module Gql
+  class MutationGenerator < Rails::Generators::Base
+    argument :mutation_prefix, type: :string
+    argument :model_name, type: :string
+    source_root File.expand_path('../templates', __FILE__)
+  
+    def mutation
+      file_name = "#{mutation_prefix}#{model_name}"
+      template('model_mutation.rb', "app/graphql/mutations/#{file_name.underscore}.rb")
+    end
+  end
+  
+end

data/lib/generators/gql/templates/input_type.rb

@@ -0,0 +1,9 @@
+module Types
+  module Input
+    class <%= @model_name %>Input < Types::BaseInputObject
+  <% @fields.each do |field| -%>
+    argument :<%= field[:name] %>, <%= field[:gql_type] %>, required: false
+  <% end %>
+    end
+  end
+end

data/lib/generators/gql/templates/model_mutation.rb

@@ -0,0 +1,26 @@
+module Mutations
+  class <%= @mutation_prefix %><%= @model_name %> < Mutations::BaseMutation
+    field :<%= @model_name.underscore %>, Types::<%= @model_name %>Type, null: true
+
+    argument :attributes, Types::Input::<%= @model_name %>Input, required: true
+    argument :id, Int, required: false
+
+    def resolve(attributes:, id: nil)
+      model = find_or_build_model(id)
+      model.attributes = attributes.to_h
+      if model.save
+        {<%= @model_name.underscore %>: model}
+      else
+        {errors: model.errors.full_messages}
+      end
+    end
+
+    def find_or_build_model(id)
+      if id
+        <%= @model_name %>.find(id)
+      else
+        <%= @model_name %>.new
+      end
+    end
+  end
+end

data/lib/generators/gql/templates/model_type.rb

@@ -0,0 +1,7 @@
+module Types
+  class <%= @model_name %>Type < Types::BaseObject
+  <% @fields.each do |field| -%>
+  field :<%= field[:name] %>, <%= field[:gql_type] %>, null: true
+  <% end %>
+  end
+end

data/lib/graphql-rails-generators/version.rb

@@ -0,0 +1,3 @@
+module GraphqlRailsGenerators
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: graphql-rails-generators
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Sharp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-26 00:00:00.000000000 Z
+dependencies: []
+description: A simple hello world gem
+email: ajsharp@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/generators/gql/gql_generator_base.rb
+- lib/generators/gql/input_generator.rb
+- lib/generators/gql/model_type_generator.rb
+- lib/generators/gql/mutation_generator.rb
+- lib/generators/gql/templates/input_type.rb
+- lib/generators/gql/templates/model_mutation.rb
+- lib/generators/gql/templates/model_type.rb
+- lib/graphql-rails-generators/version.rb
+homepage: https://github.com/ajsharp/graphql-rails-generators
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Hola!
+test_files: []