ralphql_generator 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 424c0525b6ba37043784f664352284c95a761e514567097a1078e5a9a62f68ce
+  data.tar.gz: b6f2c7930183531db5d6d7d674d346eb850e0ee1b7dc028daca13f5d75092db0
+SHA512:
+  metadata.gz: 419ccaca078fd4e800ada37e6d7a92aa9462a11c2e26d42b7a1aacee9c19f10e6a4e4ae223f26bcd8e7b1aa243ab529aed7af379f8db458d7d4855d26a77b135
+  data.tar.gz: c2384bd3f947cde30351f00f005257b281baf7bdc84cd20d43fd4fce8b7aea5bc61fabcffb37a016a7a2013e768fde89f0facc225374b0d583eaeac1cea21978

data/README.md

@@ -0,0 +1,64 @@
+# Ralphql_generator
+
+ralphql_generator an useful gem for generating GraphQL queries and mutations in Rails applications. With ralphql_generator, you can quickly and easily create queries and mutations based on your application's data model, freeing up your time to focus on more complex development tasks.
+
+By using ralphql_generator, you can reduce the likelihood of typos and other errors that can occur when writing GraphQL queries and mutations by hand. Instead, you can generate the necessary code with a few simple commands and then customize it as needed to fit your specific requirements.
+
+ralphql_generator's name is a playful reference to the lovable yet dimwitted character from The Simpsons, Ralph Wiggum. By leaving the simple tasks to Ralph, you can focus on the parts of your application that truly require your expertise and creativity.
+
+![ralph computing](https://media.giphy.com/media/xT5LMI5WLGkftxKJeE/giphy.gif)
+
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem  'ralphql_generator'
+```
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install ralphql_generator
+```
+ 
+## Usage
+### Queries Generators
+```bash
+$ rails generate gql YourModel
+```
+And it will create base files:
+ - `app/graphql/types/your_model_type.rb`
+ - `app/graphql/resolvers/your_model_resolver.rb`
+-  `app/policies/your_model_policy.rb` 
+ - `spec/fixtures/graphql/your_models.graphql`
+ - `spec/graphql/queries/your_models_spec.rb` 
+ and it  add  `your_models_field` into `app/graphql/types/query_type.rb`
+
+Then now you just have to update  `your_model_policy.rb` and update or remove `xit`  in `your_models_spec.rb` to have a base type fetchable
+
+### Mutations Generators
+```bash
+$ rails generate gql_mutation YourMutation
+```
+And it will create base files:
+      - `app/graphql/mutations/your_mutation.rb`
+      - `spec/graphql/mutations/your_mutation_spec.rb`
+      - `spec/fixtures/graphql/mutations/your_mutations.graphql`
+There is no magical here, juste generate base files, you have to create your own business logic inside 
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+  
+
+## Contributing
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ralphql_generator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tymate/ralphql_generator/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/generators/gql/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate gql Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/gql/gql_generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class GqlGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_gql_file
+    template 'exemple_policy.rb', File.join('app/policies/', "#{file_name.underscore}_policy.rb")
+    template 'exemple_spec.rb', File.join('spec/graphql/queries', "#{file_name.underscore.pluralize}_spec.rb")
+    template 'exemple_resolver.rb', File.join('app/graphql/resolvers', "#{file_name.underscore}_resolver.rb")
+    template 'exemple.graphql.rb', File.join('spec/fixtures/graphql', "#{file_name.underscore.pluralize}.graphql")
+    template 'exemple_type.rb', File.join('app/graphql/types', "#{file_name.underscore}_type.rb")
+    insert_into_query_type
+  end
+
+  private # Example method that can be invoked from the template
+
+  def excluded_columns
+    %i[id created_at updated_at]
+  end
+
+  def base_order_columns
+    %i[created_at updated_at position]
+  end
+
+  def insert_into_query_type
+    inject_into_file 'app/graphql/types/query_type.rb', after: "# Index Queries\n" do 
+    "    field :#{file_name.underscore.pluralize},
+          Types:: #{class_name.constantize}Type.connection_type,
+          resolver: Resolvers::#{class_name.constantize}Resolver,
+          preauthorize: { to: :index?, with: #{class_name.constantize}Policy },
+          connection: GraphQL::Connections::Stable,
+          null: false\n"
+    end
+  end
+
+  def graphqlTypeFor(type)
+    types = {
+      string: 'String',
+      text: 'String',
+      integer: 'Int',
+      float: 'Float',
+      boolean: 'Boolean',
+      datetime: 'GraphQL::Types::ISO8601DateTime',
+      date: 'GraphQL::Types::ISO8601Date',
+      json: 'JSON'
+    }
+    types[type]
+  end
+end

data/lib/generators/gql/templates/exemple.graphql.rb

@@ -0,0 +1,10 @@
+query <%= class_name.camelize(:lower).pluralize %>{
+  <%= class_name.camelize(:lower).pluralize %>{
+    nodes{
+      <%- class_name.constantize.columns.each do |column| -%>
+      <%- next if class_name.constantize.reflect_on_all_associations.map(&:foreign_key).include?(column.name) -%>
+        <%= column.name.camelize(:lower)%>
+      <%- end -%>
+    }
+  }
+}

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= class_name %>Policy < ApplicationPolicy
+  relation_scope do |scope|
+    raise "Add custom policy scope in #{__FILE__}"
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Resolvers
+  class <%= class_name %>Resolver < BaseResolver
+    include SearchObject.module(:graphql)
+
+    description 'Search resolver for <%= class_name.underscore %>'
+
+    type Types::<%= class_name %>Type.connection_type, null: false
+
+    scope do
+      authorized_scope(<%= class_name %>.all)
+    end
+
+    class OrderColumnEnum < Types::BaseEnum
+      description 'Available columns for ordering'
+
+      graphql_name '<%= class_name %>OrderColumn'
+
+    <%- class_name.constantize.columns.each do |column| -%>
+    <%- next unless base_order_columns.include?(column.name.to_sym) -%>
+      value '<%= column.name.to_sym.upcase %>', value: :<%= column.name %>
+    <%- end -%>
+    end
+
+    class <%= class_name %>OrderCriteria < Types::BaseInputObject
+      description 'Criteria for ordering'
+
+      argument :column, OrderColumnEnum, required: true
+      argument :direction, Types::OrderDirectionType, required: true
+    end
+
+    DEFAULT_ORDER = { column: :created_at, direction: :asc }.freeze
+
+    option(
+      :order,
+      type: <%= class_name %>OrderCriteria, default: DEFAULT_ORDER
+    ) do |scope, order|
+      scope.order(order.column => order.direction)
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Types::QueryType, type: :request do
+
+  let(:query) { '<%= class_name.camelize(:lower).pluralize %>' }
+  let(:data) { json.dig(:data, :<%= class_name.camelize(:lower).pluralize %>, :nodes) }
+
+  describe '<%= class_name.underscore %>' do
+    it_behaves_like 'with standard user' do
+      before do
+        5.times do
+          Fabricate(:<%= class_name.underscore %>)
+        end
+        do_graphql_request
+      end
+
+      it 'get a <%= class_name.underscore.pluralize %> list' do
+        raise "Change me or adopt me in #{__FILE__}"
+        expect(errors).to be_blank
+        expect(data.size).to eq(5)
+      end
+    end
+  end
+
+  describe 'when unauthenticated' do
+    before do
+      do_graphql_request
+    end
+
+    include_examples 'when unauthenticated'
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Types
+  class <%= class_name %>Type < Types::BaseType
+    description 'A <%= class_name %>'
+
+    <%- class_name.constantize.columns.each do |column| -%>
+    <%- next if excluded_columns.include?(column.name.to_sym) || class_name.constantize.reflect_on_all_associations.map(&:foreign_key).include?(column.name) -%>
+    field :<%= column.name %>, <%= graphqlTypeFor(column.type) %>, null: <%= column.null %>
+    <%- end -%>
+    # belongs_to Associations
+    <%- class_name.constantize.reflect_on_all_associations(:belongs_to).each do |association| -%>
+    field :<%= association.name %>, Types::<%= association.klass.name %>Type, null: false
+    <%- end -%>
+    # has_many Associations
+    <%- class_name.constantize.reflect_on_all_associations(:has_many).each do |association| -%>
+    field :<%= association.name %>, Types::<%= association.klass.name %>Type.connection_type, resolver: Resolvers::<%= association.klass.name %>Resolver, null: true
+    <%- end -%>
+    # has_one Associations
+    <%- class_name.constantize.reflect_on_all_associations(:has_one).each do |association| -%>
+    <%- if association.options[:class_name] == "ActionText::RichText" -%>
+    field :<%= association.name %>, String, null: true
+    <%- else -%>
+    field :<%= association.name %>, Types::<%= association.klass.name %>Type, null: true
+    <%- end -%>
+    <%- end -%>
+  end
+end
+

data/lib/generators/gql_mutation/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate gql_mutation Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/gql_mutation/gql_mutation_generator.rb

@@ -0,0 +1,18 @@
+class GqlMutationGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  def create_gql_file
+    template 'exemple_mutation.rb', File.join('app/graphql/mutations', "#{file_name.underscore}.rb")
+    template 'exemple_mutation_spec.rb', File.join('spec/graphql/mutations', "#{file_name.underscore}_spec.rb")
+    template 'exemple_mutation.graphql.rb', File.join('spec/fixtures/graphql/mutations/', "#{file_name.underscore}s.graphql")
+    update_mutation_type
+  end
+
+  private
+
+  def update_mutation_type
+    path = 'app/graphql/types/mutation_type.rb'
+    mutations = File.read(path).gsub("end\nend\n", "  field :#{file_name.underscore}, mutation: Mutations::#{file_name.camelize}\n  end\nend\n")
+    File.write(path, mutations)
+  end
+end

data/lib/generators/gql_mutation/templates/exemple_mutation.graphql.rb

@@ -0,0 +1,17 @@
+fragment errorFields on ValidationError {
+  path
+  message
+  attributes
+  error
+}
+
+mutation <%= class_name.camelize(:lower) %>($input: <%= class_name.camelize %>Input!) {
+  <%= class_name.camelize(:lower) %>(input: $input) {
+    changeMe {
+      id
+    }
+    errors {
+      ...errorFields
+    }
+  }
+}

data/lib/generators/gql_mutation/templates/exemple_mutation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Mutations
+  class <%= class_name %> < BaseMutation
+    description '<%= class_name %>'
+
+    # argument :argument_name, String, required: false
+    # field :field_name, Types::MyType, null: true
+
+    def resolve(**args)
+      # authorize! current_user, to: :<%= class_name.underscore %>?
+      # todo add logic here
+      # {field_name: field_name}
+    end
+  end
+end

data/lib/generators/gql_mutation/templates/exemple_mutation_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Mutations::<%= class_name %>, type: :request do
+  let(:query) { '<%= class_name.camelize(:lower) %>' }
+
+  # let(:object) { Fabricate :object }
+
+  let(:variables) do
+    {
+      input: {
+        # objectId: object.to_sgid.to_s
+      }
+    }
+  end
+
+  it_behaves_like 'with standard user' do
+    xit '<%= class_name %>' do
+      do_graphql_request
+      expect(errors).to be_blank
+      data = json.dig('data', '<%= class_name.camelize(:lower) %>', 'object').deep_symbolize_keys
+      expect(data).not_to be_empty
+    end
+  end
+end

data/lib/ralphql/version.rb

@@ -0,0 +1,3 @@
+module Ralphql
+  VERSION = "0.2.0"
+end

data/lib/ralphql.rb

@@ -0,0 +1,4 @@
+require "ralphql/version"
+
+module Ralphql
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ralphql_generator
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Michel Delpierre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.3
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- tech@tymate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/generators/gql/USAGE
+- lib/generators/gql/gql_generator.rb
+- lib/generators/gql/templates/exemple.graphql.rb
+- lib/generators/gql/templates/exemple_policy.rb
+- lib/generators/gql/templates/exemple_resolver.rb
+- lib/generators/gql/templates/exemple_spec.rb
+- lib/generators/gql/templates/exemple_type.rb
+- lib/generators/gql_mutation/USAGE
+- lib/generators/gql_mutation/gql_mutation_generator.rb
+- lib/generators/gql_mutation/templates/exemple_mutation.graphql.rb
+- lib/generators/gql_mutation/templates/exemple_mutation.rb
+- lib/generators/gql_mutation/templates/exemple_mutation_spec.rb
+- lib/ralphql.rb
+- lib/ralphql/version.rb
+homepage: https://rubygems.org/gems/ralph_ql
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://rubygems.org/gems/ralph_ql
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: A Ruby on Rails gralphql generators
+test_files: []