OSS Gate Workshop: Tokyo: 2019-09-14: imaharu: graphql-ruby: Work log

[imaharu]

This is a work log of a "OSS Gate workshop".
"OSS Gate workshop" is an activity to increase OSS developers.
Here's been discussed in Japanese. Thanks.

作業ログ作成時の説明

以下のテンプレートを埋めてタイトルに設定します。埋め方例はスクロールすると見えてきます。

OSS Gate Workshop: ${LOCATION}: ${YEAR}-${MONTH}-${DAY}: ${ACCOUNT_NAME}: ${OSS_NAME}: Work log

タイトル例↓：

OSS Gate Workshop: Tokyo: 2017-01-16: kou: Rabbit: Work log

OSS Gateワークショップ関連情報

• スライド：ワークショップの進行に使っているスライドがあります。
• チャット：OSS開発に関することならなんでも相談できます。ワークショップが終わった後もオンラインで相談しながら継続的にOSSの開発に参加しましょう！
• シナリオ：ワークショップの目的・内容・進め方の詳細が書いています。
• 過去のビギナーの作業ログ：他の人の作業ログから学べることがいろいろあるはずです。

[imaharu]

まずは、graphql-rubyのGetting Started行います
https://graphql-ruby.org/getting_started#declare-types

[imaharu]

各バージョンです

$ rails -v
Rails 5.2.3
$ ruby -v
ruby 2.5.0p0 (2017-12-25 revision 61468) [x86_64-darwin18]

[imaharu]

初期のGemfileです
ここに、 gem "graphql" を追記します
特に規定がないので、groupは指定しません

source 'https://rubygems.org'
git_source(:github) { |repo| "https://github.com/#{repo}.git" }

ruby '2.5.0'

# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
gem 'rails', '~> 5.2.3'
# Use sqlite3 as the database for Active Record
gem 'sqlite3'
# Use Puma as the app server
gem 'puma', '~> 3.11'
# Use SCSS for stylesheets
gem 'sass-rails', '~> 5.0'
# Use Uglifier as compressor for JavaScript assets
gem 'uglifier', '>= 1.3.0'
# See https://github.com/rails/execjs#readme for more supported runtimes
# gem 'mini_racer', platforms: :ruby

# Use CoffeeScript for .coffee assets and views
gem 'coffee-rails', '~> 4.2'
# Turbolinks makes navigating your web application faster. Read more: https://github.com/turbolinks/turbolinks
gem 'turbolinks', '~> 5'
# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
gem 'jbuilder', '~> 2.5'
# Use Redis adapter to run Action Cable in production
# gem 'redis', '~> 4.0'
# Use ActiveModel has_secure_password
# gem 'bcrypt', '~> 3.1.7'

# Use ActiveStorage variant
# gem 'mini_magick', '~> 4.8'

# Use Capistrano for deployment
# gem 'capistrano-rails', group: :development

# Reduces boot times through caching; required in config/boot.rb
gem 'bootsnap', '>= 1.1.0', require: false

group :development, :test do
  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
end

group :development do
  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
  gem 'web-console', '>= 3.3.0'
  gem 'listen', '>= 3.0.5', '< 3.2'
  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
  gem 'spring'
  gem 'spring-watcher-listen', '~> 2.0.0'
end

group :test do
  # Adds support for Capybara system testing and selenium driver
  gem 'capybara', '>= 2.15'
  gem 'selenium-webdriver'
  # Easy installation and use of chromedriver to run system tests with Chrome
  gem 'chromedriver-helper'
end

# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

[imaharu]

# Reduces boot times through caching; required in config/boot.rb
gem 'bootsnap', '>= 1.1.0', require: false

# for oss gate
gem "graphql"

上記のように追加した後に、bundle installをします

[imaharu]

その後、rails sを行うといつもの画面が出力されました

[imaharu]

macを利用しているので、.gitignoreに .DS_Store　を追加した後に

git add & git commit を行いました

g add .
g commit -m "First commit rails new with graphql-ruby && bundle install"

[imaharu]

Gemfile.lockの中身を見ると

graphql (1.9.12)がインストールされていました

[imaharu]

Getting　Startedページの
https://graphql-ruby.org/getting_started#declare-types から

GraphQL generatorsをクリックしたのち

https://graphql-ruby.org/schema/generators#graphqlinstall

Options段落に

• --no-graphiql will exclude graphiql-rails from the setup
  とあったが、 graphql:install --help 実行するとないため rails g graphql:install --no-graphiqlと実行した

 $ rails g  graphql:install --help
Running via Spring preloader in process 62782
Usage:
  rails generate graphql:install [options]

Options:
  [--skip-namespace], [--no-skip-namespace]                    # Skip namespace (affects only isolated applications)
  [--directory=DIRECTORY]                                      # Directory where generated files should be saved
                                                               # Default: app/graphql
  [--schema=SCHEMA]                                            # Name for the schema constant (default: {app_name}Schema)
  [--skip-keeps], [--no-skip-keeps]                            # Skip .keep files for source control
  [--skip-graphiql], [--no-skip-graphiql]                      # Skip graphiql-rails installation
  [--skip-mutation-root-type], [--no-skip-mutation-root-type]  # Skip creation of the mutation root type
  [--relay], [--no-relay]                                      # Include GraphQL::Relay installation
  [--batch], [--no-batch]                                      # Include GraphQL::Batch installation
  [--api], [--no-api]                                          # Preconfigure smaller stack for API only apps

Runtime options:
  -f, [--force]                    # Overwrite files that already exist
  -p, [--pretend], [--no-pretend]  # Run but do not make any changes
  -q, [--quiet], [--no-quiet]      # Suppress status output
  -s, [--skip], [--no-skip]        # Skip files that already exist

oss-gate-graphql $ rails g  graphql:install --no-graphiql
Running via Spring preloader in process 67146
      create  app/graphql/types
      create  app/graphql/types/.keep
      create  app/graphql/oss_gate_graphql_schema.rb
      create  app/graphql/types/base_object.rb
      create  app/graphql/types/base_argument.rb
      create  app/graphql/types/base_field.rb
      create  app/graphql/types/base_enum.rb
      create  app/graphql/types/base_input_object.rb
      create  app/graphql/types/base_interface.rb
      create  app/graphql/types/base_scalar.rb
      create  app/graphql/types/base_union.rb
      create  app/graphql/types/query_type.rb
add_root_type  query
      create  app/graphql/mutations
      create  app/graphql/mutations/.keep
      create  app/graphql/types/mutation_type.rb
add_root_type  mutation
      create  app/controllers/graphql_controller.rb
       route  post "/graphql", to: "graphql#execute"
     gemfile  graphiql-rails
       route  graphiql-rails

[imaharu]

すると、helpには存在しないコマンドが動いた

rails g graphql:install --no-graphiql

--no-graphiql がないコマンド

[imaharu]

再度、 rails g graphql:install --help を実行すると

下記のようなエラー文が出力された

oss-gate-graphql $ rails g  graphql:install --help
Could not find gem 'graphiql-rails' in any of the gem sources listed in your Gemfile.
Run `bundle install` to install missing gems.

[imaharu]

次にbundle installを実行した
https://graphql-ruby.org/getting_started

[imaharu]

これ以降、Gettingスタートをやります

ドキュメントはテンプレエンジンが変化してから更新されていない

[imaharu]

GitHubの該当ページはここ

https://github.com/rmosolgo/graphql-ruby/blob/master/guides/getting_started.md

[swamp09]

rails gで生成されるテンプレートファイルと、ドキュメントと違う部分があって、そこは直したほうが良いですね！という話をしました。
他に同じような問題でPRを出している人がいるか一緒に確認したところ、いないみたいなのでこのままいけそう！

[imaharu]

NameSpace(テンプレートエンジン)に関するPRは以下のリンクです

rmosolgo/graphql-ruby@7279b5f#diff-a6f0315311fb9167ede5428eb5a574d3

rmosolgo/graphql-ruby#1591

[imaharu]

PRヘ役立ちそうなリンク

類義語辞書
https://www.thesaurus.com/browse/

英英辞書

https://www.ldoceonline.com/dictionary/

[shioimm]

@imaharu
知り合いの記事なのですが、OSSにPRを送るまでの流れがまとまっているので
紹介しておきます🐣
https://qiita.com/fuqda/items/a3e5270ff9cb4fbf31e2#%E7%9B%AE%E6%AC%A1

[imaharu]

問題

Getting Started page が最新のテンプレートジェネレーターに追従していない

具体例

Getting Startedのドキュメントを参考にして rails g graphql:object Post title:String rating:Int comments:[Comment] を実行すると以下のコードが生成されます

# app/graphql/types/post_type.rb
module Types
  class PostType < Types::BaseObject
    # ...
  end
end

現在のドキュメントは、現状と異なっています

# app/graphql/types/post_type.rb
class Types::PostType < Types::BaseObject
　# ...
end

解決策

ドキュメントを修正し現状の状態と合うものにしました。

補足

調べて見ると、

@bary822さんが、rmosolgo/graphql-ruby#1591 を解決するために
コードを修正しました。

本PRは、この修正を反映したものです。

[bary822]

PR感謝です 🙏

[imaharu]

ここ、PRに投げました

rmosolgo/graphql-ruby#2477

[oss-gate-issue-cleaner]

おつかれさまでした！

後日引き続きワークショップがある場合

後日のワークショップで再開する際に、issueタイトルの日付を更新してreopenしてください！

ワークショップ終了後に続きがしたい場合

issueはクローズしますが、その後も作業を続けていただいて大丈夫です！

是非このissueを活用なさってください。

今後のイベントの案内

現在以下のイベントの開催を予定しています。

• OSS Gate東京ミートアップ2019-10-07
• OSS Gate東京ワークショップ2019-12-14
• OSS Gate東京ワークショップ2019-10-26

参加をお待ちしてます！