graphql-rails-generators 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38981ddd6d3252268196ca9c333672436e63ee24badf5fa54e72915c4bbcfeb5
-  data.tar.gz: cbe8ba3110f66a30c2dbba7e2301b33e7ab52bd7deb2b6f7e4d37afc0b1bb9f0
+  metadata.gz: 5b3e945d1874ce80d7b6869974c0ff1ed879ab4c05a0cf7c95f45e92a7353592
+  data.tar.gz: 303b4b236b892bdf7062153bbd502f198426ca666557a2a3edee34964be8edb1
 SHA512:
-  metadata.gz: e359081f8e02097e84af9d00fdc507e6d42fdc6d2b9727fb8732fc5f8b420da9d6279e62b99f79ab6f5b5bdf055484499a74df2cc9c4b9f829533afa1d046949
-  data.tar.gz: d28b879ad5152567bd3e66b58dfe5713c3920f315553c5b94e0e8836f790914de8c1b5b5bd4886abd908f076712967e479eadc053bbd0d6f58738265f3446d57
+  metadata.gz: 00fc8c39ac7fc1fbe52c5441af7c23992767837e6416466cb10265ef756195c241f3736aa90b7d8079536f3d75e2efb5ae3b098114be99bf51fbe1c7ed39d03b
+  data.tar.gz: eb88f4cc1003f4eedfecead2bfb983f1a47aa8ee318a20fd17436cfb03b995073baf456adb7ad76d535f3b9f9205a4294e9ef0a5d1c06915c171f7b9f2c1672b

data/README.md

@@ -2,11 +2,12 @@
 
 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.
+This project contains 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
+- `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
+- `gql:search_object` - A search object based on [SearchObjectGraphQL](https://github.com/RStankov/SearchObjectGraphQL)
 
 ## Installation
 
@@ -28,7 +29,11 @@ Generate a model type from a model.
 $ rails generate gql:model_type MODEL_CLASS
 ```
 
-Result:
+#### Options
+
+* `--name` - customize the file/class name, useful if you don't want the default Type suffix.
+
+#### Example
 
 ```ruby
 # app/graphql/post_type.rb
@@ -51,7 +56,12 @@ Generate an input type from a model.
 rails generate gql:input Post
 ```
 
-Result:
+#### Options
+
+* `--name` - customize the file/class name, useful if you don't want the default Input suffix.
+
+#### Example
+
 ```ruby
 # app/graphql/types/post_input.rb
 module Types
@@ -72,7 +82,8 @@ Generate create, update and delete mutations for a model.
 rails generate gql:mutations Post
 ```
 
-Result:
+#### Example
+
 ```ruby
 # app/graphql/types/post_input.rb
 module Types
@@ -97,7 +108,8 @@ The mutation generator generates something akin to an "upsert" mutation. It take
 rails generate gql:mutation Update Post
 ```
 
-Result:
+#### Example
+
 ```ruby
 # app/graphql/mutations/update_post.rb
 module Mutations
@@ -126,4 +138,66 @@ module Mutations
     end
   end
 end
-```
+```
+
+### gql:search_object MODEL_NAME
+
+Generate a search object from a model using [SearchObjectGraphQL](https://github.com/RStankov/SearchObjectGraphQL)
+
+If you have not yet created a base search resolver:
+
+`rails g gql:model_search_base`
+
+\*_Adds `gem 'search_object_graphql'` to gemfile_
+
+#### Example
+
+```ruby
+# app/graphql/resolvers/base_search_resolver.rb
+module Resolvers
+  class BaseSearchResolver < GraphQL::Schema::Resolver
+    require 'search_object'
+    require 'search_object/plugin/graphql'
+    include SearchObject.module(:graphql)
+  end
+end
+```
+
+Then generate a search object for your model:
+
+`rails g gql:model_search Post`
+
+#### Example
+
+```ruby
+# app/graphql/resolvers/post_search.rb
+module Resolvers
+  class PostSearch < Resolvers::BaseSearchResolver
+    type [Types::PostType], null: false
+    description "Lists posts"
+
+    scope { Post.all }
+
+    option(:id, type: Int)   { |scope, value| scope.where id: value }
+    option(:title, type: String)   { |scope, value| scope.where title: value }
+    option(:body, type: Int)   { |scope, value| scope.where rating: value }
+    option(:created_at, type: GraphQL::Types::ISO8601DateTime)   { |scope, value| scope.where created_at: value }
+    option(:updated_at, type: GraphQL::Types::ISO8601DateTime)   { |scope, value| scope.where updated_at: value }
+
+    def resolve
+      []
+    end
+
+  end
+end
+```
+
+This will also insert a search field into the beginning of query_type.rb
+
+```ruby
+  #app/graphql/types/query_type.rb
+  module Types
+  class QueryType < Types::BaseObject
+    field :posts, resolver: Resolvers::PostSearch
+    ...
+```

data/lib/generators/gql/gql_generator_base.rb

@@ -2,40 +2,71 @@ require 'rails/generators/base'
 
 module Gql
   module GqlGeneratorBase
-    extend ActiveSupport::Concern
+    protected
 
-    included do
-      protected
+    # Generate a namedspaced class name with the mutation prefix
+    def prefixed_class_name(prefix)
+      (class_path + ["#{prefix}_#{file_name}"]).map!(&:camelize).join("::")
+    end
 
-      # Generate a namedspaced class name with the mutation prefix
-      def prefixed_class_name(prefix)
-        (class_path + ["#{prefix}_#{file_name}"]).map!(&:camelize).join("::")
-      end
+    def type_map
+      {
+        integer: 'Int',
+        string: 'String',
+        boolean: 'Boolean',
+        decimal: 'Float',
+        datetime: 'GraphQL::Types::ISO8601DateTime',
+        date: 'GraphQL::Types::ISO8601Date',
+        hstore: 'GraphQL::Types::JSON',
+        text: 'String',
+        json: 'GraphQL::Types::JSON',
+        jsonb: 'GraphQL::Types::JSON'
+      }
+    end
 
-      def type_map
-        {
-          integer: 'Int',
-          string: 'String',
-          boolean: 'Boolean',
-          decimal: 'Float',
-          datetime: 'GraphQL::Types::ISO8601DateTime',
-          date: 'GraphQL::Types::ISO8601Date',
-          hstore: 'GraphQL::Types::JSON',
-          text: 'String',
-          json: '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) }
-          .reject { |col| type_map[col.type].nil? }
-          .map { |col| {name: col.name, gql_type: type_map[col.type]} }
+    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) }
+        .reject { |col| type_map[col.type].nil? }
+        .map do |col|
+          {
+            name: col.name,
+            null: col.null,
+            gql_type: klass.primary_key == col.name ? 'GraphQL::Types::ID' : type_map[col.type]
+          }
+        end
+    end
+
+    def root_directory(namespace)
+      "app/graphql/#{namespace.underscore}"
+    end
+
+    def wrap_in_namespace(namespace)
+      namespace = namespace.split('::')
+      namespace.shift if namespace[0].empty?
+
+      code = namespace.each_with_index.map { |name, i| "  " * i + "module #{name}" }.join("\n")
+      code << "\n" << yield(namespace.size) << "\n"
+      code << (namespace.size - 1).downto(0).map { |i| "  " * i  + "end" }.join("\n")
+      code
+    end
+
+    def class_with_fields(namespace, name, superclass, fields)
+      wrap_in_namespace(namespace) do |indent|
+        klass = []
+        klass << sprintf("%sclass %s < %s", "  " * indent, name, superclass)
+
+        fields.each do |field|
+          klass << sprintf("%sfield :%s, %s, null: %s", "  " * (indent + 1), field[:name], field[:gql_type], field[:null])
+        end
+
+        klass << sprintf("%send", "  " * indent)
+        klass.join("\n")
       end
     end
   end
-end
+end

data/lib/generators/gql/input_generator.rb

@@ -3,15 +3,29 @@ module Gql
   class InputGenerator < Rails::Generators::Base
     include GqlGeneratorBase
     source_root File.expand_path('../templates', __FILE__)
+
     argument :model_name, type: :string
-  
+
+    class_option :name, type: :string
+    class_option :include_columns, type: :array, default: []
+    class_option :superclass, type: :string, default: 'Types::BaseInputObject'
+    class_option :namespace, type: :string, default: 'Types::Input'
+
     def generate_input_type
-      file_name = model_name
+      name = options['name'].nil? ? "#{model_name}Input" : options['name']
+      superclass = options['superclass']
 
       ignore = ['id', 'created_at', 'updated_at']
-      @fields = map_model_types(model_name).reject { |field| ignore.include?(field[:name]) }
+      fields = map_model_types(model_name)
+      fields.reject! { |field| ignore.include?(field[:name]) }
+      if options['include_columns'].any?
+        fields.reject! { |field| !options['include_columns'].include?(field[:name]) }
+      end
+
+      code = class_with_fields(options['namespace'], name, superclass, fields)
+      file_name = File.join(root_directory(options['namespace']), "#{name.underscore}.rb")
 
-      template('input_type.rb', "app/graphql/types/input/#{file_name.underscore}_input.rb")
+      create_file file_name, code
     end
   end
-end
+end

data/lib/generators/gql/model_search_base_generator.rb

@@ -0,0 +1,9 @@
+module Gql
+  class ModelSearchBaseGenerator < Rails::Generators::Base          
+    source_root File.expand_path('../templates', __FILE__)    
+    def generate_model_search_base
+      gem 'search_object_graphql'    
+      template('model_search_base.rb', "app/graphql/resolvers/base_search_resolver.rb")
+    end
+  end
+end

data/lib/generators/gql/model_search_generator.rb

@@ -0,0 +1,19 @@
+require_relative 'gql_generator_base'
+module Gql
+  class ModelSearchGenerator < Rails::Generators::Base
+    include GqlGeneratorBase
+    source_root File.expand_path('../templates', __FILE__)
+    argument :model_name, type: :string
+
+    def search
+      inject_into_file(
+        "app/graphql/types/query_type.rb", 
+        "\t\tfield :#{model_name.downcase.pluralize}, resolver: Resolvers::#{model_name}Search \n", 
+        :after => "class QueryType < Types::BaseObject\n"
+      )
+      file_name = "#{model_name.underscore}_search"
+      @fields = map_model_types(model_name)
+      template('model_search.rb', "app/graphql/resolvers/#{file_name}.rb")
+    end
+  end
+end

data/lib/generators/gql/model_type_generator.rb

@@ -3,12 +3,28 @@ module Gql
   class ModelTypeGenerator < Rails::Generators::Base
     include GqlGeneratorBase
     source_root File.expand_path('../templates', __FILE__)
+
     argument :model_name, type: :string
 
+    class_option :name, type: :string
+    class_option :include_columns, type: :array, default: []
+    class_option :superclass, type: :string, default: 'Types::BaseObject'
+    class_option :namespace, type: :string, default: 'Types'
+
     def type
-      file_name = "#{model_name.underscore}_type"
-      @fields = map_model_types(model_name)
-      template('model_type.rb', "app/graphql/types/#{file_name}.rb")
+      name = options['name'].nil? ? "#{model_name}Type" : options['name']
+
+      superclass = options['superclass']
+
+      fields = map_model_types(model_name)
+      if options['include_columns'].any?
+        fields.reject! { |field| !options['include_columns'].include?(field[:name]) }
+      end
+
+      code = class_with_fields(options['namespace'], name, superclass, fields)
+      file_name = File.join(root_directory(options['namespace']), "#{name.underscore}.rb")
+
+      create_file file_name, code
     end
   end
-end
+end

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

@@ -0,0 +1,16 @@
+module Resolvers
+  class <%= @resolver_prefix %><%= @model_name %>Search < Resolvers::BaseSearchResolver
+    type [Types::<%= @model_name %>Type], null: false
+    description "Lists <%= @model_name.downcase.pluralize %>"
+
+    scope { <%= @model_name %>.all }
+  
+  <% @fields.each do |field| -%>
+  option(:<%= field[:name] %>, type: <%= field[:gql_type] %>)   { |scope, value| scope.where <%= field[:name] %>: value }
+  <% end %>
+    def resolve
+      []
+    end
+
+  end
+end

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

@@ -0,0 +1,7 @@
+module Resolvers
+  class BaseSearchResolver < GraphQL::Schema::Resolver
+    require 'search_object'
+    require 'search_object/plugin/graphql'
+    include SearchObject.module(:graphql)
+  end
+end

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

@@ -1,3 +1,3 @@
 module GraphqlRailsGenerators
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: graphql-rails-generators
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Alex Sharp
@@ -20,14 +20,16 @@ files:
 - README.md
 - lib/generators/gql/gql_generator_base.rb
 - lib/generators/gql/input_generator.rb
+- lib/generators/gql/model_search_base_generator.rb
+- lib/generators/gql/model_search_generator.rb
 - lib/generators/gql/model_type_generator.rb
 - lib/generators/gql/mutation_generator.rb
 - lib/generators/gql/mutations_generator.rb
 - lib/generators/gql/templates/create_mutation.rb
 - lib/generators/gql/templates/delete_mutation.rb
-- lib/generators/gql/templates/input_type.rb
 - lib/generators/gql/templates/model_mutation.rb
-- lib/generators/gql/templates/model_type.rb
+- lib/generators/gql/templates/model_search.rb
+- lib/generators/gql/templates/model_search_base.rb
 - lib/generators/gql/templates/update_mutation.rb
 - lib/graphql-rails-generators/version.rb
 homepage: https://github.com/ajsharp/graphql-rails-generators

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

@@ -1,9 +0,0 @@
-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_type.rb

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