graphql-rails-api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da727dde4584527a0597124ff476b0366f056ec29f46b51e0886a51f5c7fe00c
-  data.tar.gz: 1ccc03fa9aaf3b81e0df7135571601df989a65b6e6b50d9940ca7329d2a69486
+  metadata.gz: b644695c5f738ce04ffbffc6751c67f43b5e3e5abe171e39ea98f5a526b50aaf
+  data.tar.gz: b59bdb2628478c676369f59a594181e1cc3a4d98d8ccdbb9ac9e4a52ebdb2f14
 SHA512:
-  metadata.gz: d4fc5d6d2e90a155c8dc712b739dc2e2921d12121b46168a7549c2bb16108c5c77620a84c3f6fda467de239d8ced4ddf36db3f9bf8203cabc67a4989cd6248a3
-  data.tar.gz: ca77d437d4f161d16555da1c8dabf16207d798291c883b1f33309467a7470d121f75314f0e8d37f6a4e998cbc0317118ec70d61d4eb6e751288390b1d902b3c2
+  metadata.gz: 7d9293440b05eb1bad81b54d1f980a1247947a19a1282a0713d34d64b440fcfb1f5fdf472ea11530abf2c0b56f94e826acd9cc5b3339bfc2543959a042c8628d
+  data.tar.gz: a8845eb6c68a3b49fe778144bbdcf2986a7ea5f2197b3fcb90217941dc683726508a51bc6898bfee325c0a532241cccf469d4986d8f646baa9976b2b69b0b353

data/README.md

@@ -1,6 +1,6 @@
 # GraphqlRailsApi
 
-`graphql-rails-api` is a gem that provide generators to describe easily your graphql API.
+`graphql-rails-api` is a gem that provides generators to describe easily your graphql API in a domain driven design way.
 
 ## Installation
 Add these lines to your application's Gemfile:
@@ -16,22 +16,69 @@ $ bundle
 $ rails generate graphql_rails_api:install
 ```
 
+To disable PostgreSQL uuid extension, add the option `--no-pg-uuid`
 
-## Usage
+To disable ActionCable websocket subscriptions, add the option `--no-action-cable-subs`
+
+To disable Apollo compatibility, add the option `--no-apollo-compatibility`
+
+Automatically, `post '/graphql', to: 'graphql#execute'` will be added to your `config/route.rb`
+To avoid this, you can just add the option `--no-generate-graphql-route`
+
+# Usage
+
+## Resources generation
 
 ```bash
-$ rails generate graphql_resource account base_email:string auth_id:string
-$ rails generate graphql_resource user email:string first_name:string last_name:string has_many:users
-$ rails generate graphql_resource computer ref:string description:text belongs_to:user
-$ rails generate graphql_resource motherboard ref:string many_to_many:computers
+$ rails generate graphql_resource resource_name field1:string field2:float belongs_to:other_resource_name has_many:other_resources_name many_to_many:other_resources_name
+```
+
+To disable migration generation, add the option `--no-migration`
+
+To disable model generation, add the option `--no-model`
+
+To disable mutations generation, add the option `--no-mutations`
+
+To disable service generation, add the option `--no-service`
+
+To disable graphql-type generation, add the option `--no-graphql-type`
+
+To disable graphql-input-type generation, add the option `--no-graphql-input-type`
+
+To disable propagation (has_many creating the id in the other table, many to many creating the join table, and apply to the graphql types), add the option `--no-propagation`
 
+I made the choice of migrate automatically after generating a resource, to avoid doing it each time.
+You can of course disable the automatic migrate by adding the option `--no-migrate`
+
+## On generating resources
+
+```bash
+$ rails generate graphql_resource computer code:string price:integer power_bench:float belongs_to:user has_many:hard_drives many_to_many:tags
 ```
 
+This line will create the data migration, the model and the graphql type of the Computer resource.
+
+It will automatically add `has_many :computers` to the User model
+
+It will add a `computer_id` to the `HardDrive` model, and
+respectively the `has_many :hard_drives` and `belongs_to :computer` to the `Computer` and `HardDrive` models.
+
+The `many_to_many` option will make the `has_many through` association and create the join table between tag and computer.
+
+All of these relations will be propagated to the graphql types.
+
+
+
+## Graphql API example
+
+Example of a backend API: https://github.com/Poilon/graphql-rails-api-example
 
 
 
 ## Contributing
-Contribution directions go here.
+
+You can post any issue, and contribute by making pull requests.
+Don't hesitate, even the shortest pull request is great help. <3
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/generators/graphql_rails_api/install_generator.rb

@@ -6,6 +6,7 @@ module GraphqlRailsApi
     class_option('apollo_compatibility', type: :boolean, default: true)
     class_option('action_cable_subs', type: :boolean, default: true)
     class_option('pg_uuid', type: :boolean, default: true)
+    class_option('generate_graphql_route', type: :boolean, default: true)
 
     def generate_files
       @app_name = File.basename(Rails.root.to_s).underscore
@@ -18,10 +19,13 @@ module GraphqlRailsApi
       write_mutation_type
       write_subscription_type
       write_controller
-      write_channel if options.action_cable_subs?
+      if options.action_cable_subs?
+        write_websocket_connection
+        write_channel
+      end
       write_initializer
       write_require_application_rb
-      write_route
+      write_route if options.generate_graphql_route?
       write_uuid_extensions_migration if options.pg_uuid?
     end
 
@@ -60,12 +64,10 @@ module GraphqlRailsApi
     end
 
     def write_require_application_rb
-      File.write(
+      write_at(
         'config/application.rb',
-        File.read('config/application.rb').gsub(
-          "require 'rails/all'",
-          "require 'rails/all'\nrequire 'graphql/hydrate_query'\nrequire 'graphql/visibility_hash'\n"
-        )
+        5,
+        "require 'graphql/hydrate_query'\nrequire 'graphql/visibility_hash'\n"
       )
     end
 
@@ -103,6 +105,26 @@ module GraphqlRailsApi
       )
     end
 
+    def write_websocket_connection
+      File.write(
+        'app/channels/application_cable/connection.rb',
+        <<~'STRING'
+          module ApplicationCable
+            class Connection < ActionCable::Connection::Base
+
+              identified_by :current_user
+
+              def connect
+                # Check authentication, and define current user
+                self.current_user = nil
+              end
+
+            end
+          end
+        STRING
+      )
+    end
+
     def write_channel
       File.write(
         'app/channels/graphql_channel.rb',
@@ -181,7 +203,8 @@ module GraphqlRailsApi
             def authenticated_user
               # Here you need to authenticate the user.
               # You can use devise, then just write:
-              current_user
+
+              # current_user
             end
 
             # Handle form data, JSON body, or a blank value
@@ -415,7 +438,6 @@ module GraphqlRailsApi
       )
     end
 
-
     def write_at(file_name, line, data)
       open(file_name, 'r+') do |f|
         while (line -= 1).positive?

data/lib/generators/graphql_resource/graphql_resource_generator.rb

@@ -7,11 +7,11 @@ class GraphqlResourceGenerator < Rails::Generators::NamedBase
   TYPES_MAPPING = {
     'id' => '!types.ID',
     'uuid' => '!types.String',
-    'text' => 'types.String',
-    'datetime' => 'types.String',
+    'boolean' => 'types.Boolean',
+    'float' => 'types.Float',
+    'decimal' => 'types.Float',
     'integer' => 'types.Int',
-    'json' => 'types.String',
-    'jsonb' => 'types.String'
+    'bigint' => 'types.Int'
   }.freeze
 
   def create_graphql_files
@@ -44,7 +44,7 @@ class GraphqlResourceGenerator < Rails::Generators::NamedBase
   private
 
   def types_mapping(type)
-    TYPES_MAPPING[type] || "types.#{type.capitalize}"
+    TYPES_MAPPING[type] || "types.String"
   end
 
   def parse_args

data/lib/graphql/rails/api/version.rb

@@ -1,7 +1,7 @@
 module Graphql
   module Rails
     module Api
-      VERSION = '0.1.5'.freeze
+      VERSION = '0.1.6'.freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - poilon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2018-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphql