Add Rails Generators by rmosolgo · Pull Request #521 · rmosolgo/graphql-ruby

rmosolgo · 2017-02-05T01:09:16Z

I think generators could make the Rails experience much better! We started chatting about them over at #511 . I've sketched out a few possibilities here, what do you think?

TODO:

Settle on naming conventions
Update yardocs
Write a guide

dphaener · 2017-02-06T17:00:27Z

👍 This looks like a great start. I think I would also vote for a generator that ties a bunch of those together. I typically like to create the model/type/mutations/resolvers all at the same time.

rmosolgo · 2017-02-06T17:13:58Z

That's a good point about tying them together -- I know Rails has hooks for rails g model (that's how Rspec makes tests and factory girl makes factories) so we could look into those too!

dphaener · 2017-02-06T17:17:07Z

My personal opinion on that would be to not automatically tie it in to a model generation, but rather wrap up the model generation in a "Higher Order" generator of sorts. Something like what I'm doing here: https://github.com/DNACodeStudios/react-rails-bootstrap/blob/master/lib/generators/graphql_resource_generator.rb

That makes it more of an opt in API, rather than an opt out.

rails g graphql_resource User email:string password_digest:string could then generate a model, type, mutations, etc. Or you could just generate each thing separately.

vergenzt · 2017-02-14T17:26:31Z

I know @theorygeek is working on goco-inc/graphql-activerecord--would that be the most appropriate place for Rails- and/or ActiveRecord-specific code?

vergenzt · 2017-02-14T17:27:18Z

lib/graphql/generators/install_generator.rb

+    #
+    # ```
+    # - app/
+    #   - graphql/


+💯

(re: #511 (comment))

vergenzt · 2017-02-14T17:36:19Z

lib/graphql/generators/install_generator.rb

+    #
+    # Accept a `--graphiql` option which adds
+    # `graphiql-rails` to the Gemfile and mounts the
+    # engine in `routes.rb` (Should this be the default?)


Should this be default?

I'd think so. :) It seems like someone not wanting GraphiQL will likely be the exception and not the norm.

vergenzt · 2017-02-14T17:56:18Z

lib/graphql/generators/loader_generator.rb

+    # ```
+    #
+    # Should we have a loader for the
+    # nearly-universal foreign key loader?


Should we have a loader for the nearly-universal foreign key loader?

👎 Personally I think any code that's "nearly-universal" should probably be in a gem rather than generated into the application codebase. Not sure whether graphql-ruby is the most appropriate gem or not--but maybe graphql-activerecord?

cjoudrey · 2017-02-16T19:07:43Z

lib/graphql/generators/install_generator.rb

+    #       - query_type.rb
+    #     - loaders/
+    #     - mutations/
+    #     - {app_name}_schema.rb


Is there a reason for prefixing with {app_name}_ besides the fact that otherwise we'd be conflicting with GraphQL::Schema?

🤔 I did this in my project to avoid file picker conflicts with db/schema.rb. (I thought it was a real Ruby naming conflict, but looking back, I see that it's not.) Maybe that's not a good enough reason to do so!

Personally I'm a fan of namespacing the schema name. Rails autoloading expects the filename to match the constant name, and having the app-wide constant for the schema simply be called Schema doesn't seem right to me. :/

cjoudrey · 2017-02-16T19:09:43Z

lib/graphql/generators/install_generator.rb

+    #
+    # ```ruby
+    # # config/routes.rb
+    # post "/graphql", to: "graphql_queries#create"


Why not just graphql#create?

That could be good, then you could even do something like

resource :graphql, only: :create

or maybe:

post "/graphql", to: "graphql#create"

rmosolgo · 2017-02-18T13:45:37Z

I pushed an install generator along the same lines as initially described, how do you think in played out?

I still need to give it a run with rails new and write some docs.

rmosolgo · 2017-02-22T20:19:00Z

Thanks for you input along the way! I've tried to cover all the ground here. Does anyone want to take another look before I get to documenting it? Any reasons not to recommend this kind of setup?

ps @dphaener Thanks for clarifying that. I think I'll start with some "simple" generators and then explore those options!

cjoudrey · 2017-02-22T22:51:40Z

lib/graphql/generators/install_generator.rb

+        create_dir("app/graphql/types")
+        template("query_type.erb", "app/graphql/types/query_type.rb")
+        template("schema.erb", "app/graphql/#{schema_name.underscore}.rb")
+        template("graphqls_controller.erb", "app/controllers/graphqls_controller.rb")


Could this be graphql_controller.rb instead? Pluralized GraphQL feels a bit weird to me.

Could be, then we'd have to switch:

- resource :graphql, only: :create + post "/graphql", to: "graphql#create"

I guess it's not really a resource anyways, old habits die hard :P

I wonder then if we should keep create as the action. Sounds a bit off, maybe something custom like execute?

That's nice, I updated to post "/graphql", to: "graphql#execute"!

cjoudrey · 2017-02-22T22:53:33Z

lib/graphql/generators/templates/graphqls_controller.erb

+    case ambiguous_param
+    when String
+      if ambiguous_param.present?
+        JSON.parse(ambiguous_param)


This won't necessarily be a hash if ambiguous_param is "[]". We might want to deal with that?

I guess we could assert that the parsed value is a Hash.

I just realized that this won't work on Rails 5 since ActionController::Parameters won't match when Hash 😖

I'll take a look at whether I can return the parameters as-is or whether they need to be to_unsafe_hashed.

Oh, it worked ok with GraphiQL since it sends the body as a string. I'll improve the messaging a bit in case someone does send random input

cjoudrey · 2017-02-22T22:54:18Z

lib/graphql/generators/templates/object.erb

@@ -0,0 +1,5 @@
+<%= type_ruby_name %> = GraphQL::ObjectType.define do
+  name "<%= type_graphql_name %>"
+<% if options.node %>  interfaces [GraphQL::Relay::Node.interface]


We can use implements GraphQL::Relay::Node.interface now. 🎉

cjoudrey · 2017-02-22T22:58:18Z

lib/graphql/generators/templates/schema.erb

+<% end %><% if options[:batch] %>
+  # GraphQL::Batch setup:
+  lazy_resolve(Promise, :sync)
+  instrument(:query, GraphQL::Batch::Setup)


Edit: Moved discussion to GraphQL-Batch: Shopify/graphql-batch#49

… runs GraphiQL out of the box

rmosolgo · 2017-02-25T01:37:09Z

I added a guide and yanked ResolverGenerator -- I'll add a FunctionGenerator along with #545 instead

rmosolgo added the help wanted label Feb 5, 2017

rmosolgo mentioned this pull request Feb 5, 2017

Improve Rails adoption process #511

Closed

vergenzt reviewed Feb 14, 2017

View reviewed changes

lib/graphql/generators/install_generator.rb Outdated

#

# ```

# - app/

# - graphql/

Copy link
Copy Markdown

vergenzt Feb 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+💯

(re: #511 (comment))

vergenzt reviewed Feb 14, 2017

View reviewed changes

rmosolgo force-pushed the generators branch 2 times, most recently from 3dd7989 to 9158613 Compare February 16, 2017 04:24

cjoudrey reviewed Feb 16, 2017

View reviewed changes

rmosolgo modified the milestone: 1.5.0 Feb 17, 2017

rmosolgo removed the help wanted label Feb 18, 2017

cjoudrey mentioned this pull request Feb 18, 2017

Rethink Directory Structure GraphQLAcademy/swapi-graphql-ruby#41

Open

rmosolgo force-pushed the generators branch 3 times, most recently from 1ac8405 to bc75596 Compare February 21, 2017 15:11

rmosolgo added 5 commits February 22, 2017 14:54

feat(Generators) sketch out some generators

18eef40

feat(Generators) add file generators

f1a0440

feat(Generators) add InstallGenerator

886252a

fix rubocop paths

7805d21

fix tests on old Rails versions

4a22f84

rmosolgo force-pushed the generators branch from b2e0893 to 4a22f84 Compare February 22, 2017 19:54

cjoudrey reviewed Feb 22, 2017

View reviewed changes

rmosolgo added 5 commits February 23, 2017 20:40

feat(Generators) move to paths where Rails can find them; fixes so it…

297bf9b

… runs GraphiQL out of the box

refactor(Generators) use graphql#execute action

59a353b

refactor(Generators) use implements for interface

722f9b4

refactor(Generators) remove resolver generator

4241c64

doc(Generators) add generators guide

3726815

rmosolgo merged commit 0e0198b into master Feb 27, 2017

rmosolgo deleted the generators branch February 27, 2017 14:12

Conversation

rmosolgo commented Feb 5, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dphaener commented Feb 6, 2017

Uh oh!

rmosolgo commented Feb 6, 2017

Uh oh!

dphaener commented Feb 6, 2017

Uh oh!

vergenzt commented Feb 14, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmosolgo commented Feb 18, 2017

Uh oh!

rmosolgo commented Feb 22, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmosolgo Feb 24, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cjoudrey Feb 22, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmosolgo commented Feb 25, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

rmosolgo commented Feb 5, 2017 •

edited

Loading

rmosolgo Feb 24, 2017 •

edited

Loading

cjoudrey Feb 22, 2017 •

edited

Loading