ibrain-core 0.4.6 → 0.4.7

data/lib/generators/ibrain/graphql/object_generator.rb

@@ -2,75 +2,87 @@
 
 require_relative 'type_generator'
 
-class Ibrain::Graphql::ObjectGenerator < Ibrain::Graphql::TypeGeneratorBase
-  desc "Create a GraphQL::ObjectType with the given name and fields." \
-        "If the given type name matches an existing ActiveRecord model, the generated type will automatically include fields for the models database columns."
-  source_root File.expand_path('templates', __dir__)
+module Ibrain
+  module Graphql
+    # Generate an object type by name,
+    # with the specified fields.
+    #
+    # ```
+    # rails g graphql:object PostType name:String!
+    # ```
+    #
+    # Add the Node interface with `--node`.
+    class ObjectGenerator < TypeGeneratorBase
+      desc "Create a GraphQL::ObjectType with the given name and fields." \
+           "If the given type name matches an existing ActiveRecord model, the generated type will automatically include fields for the models database columns."
+      source_root File.expand_path('templates', __dir__)
 
-  argument :custom_fields,
-            type: :array,
-            default: [],
-            banner: "name:type name:type ...",
-            desc: "Fields for this object (type may be expressed as Ruby or GraphQL)"
+      argument :custom_fields,
+               type: :array,
+               default: [],
+               banner: "name:type name:type ...",
+               desc: "Fields for this object (type may be expressed as Ruby or GraphQL)"
 
-  class_option :node,
-                type: :boolean,
-                default: false,
-                desc: "Include the Relay Node interface"
+      class_option :node,
+                   type: :boolean,
+                   default: false,
+                   desc: "Include the Relay Node interface"
 
-  def create_type_file
-    create_dir('app/repositories') unless Dir.exist?('app/repositories')
+      def create_type_file
+        create_dir('app/repositories') unless Dir.exist?('app/repositories')
 
-    template "object.erb", "#{options[:directory]}/types/objects/#{type_file_name}.rb"
-    template "input.erb", "#{options[:directory]}/types/attributes/#{input_file_name}.rb"
-    template "repository.erb", "app/repositories/#{type_name}_repository.rb"
-  end
+        template "object.erb", "#{options[:directory]}/types/objects/#{type_file_name}.rb"
+        template "input.erb", "#{options[:directory]}/types/attributes/#{input_file_name}.rb"
+        template "repository.erb", "app/repositories/#{type_name}_repository.rb"
+      end
 
-  def fields
-    columns = []
-    columns += klass.columns.map { |c| generate_column_string(c) } if class_exists?
-    columns + custom_fields
-  end
+      def fields
+        columns = []
+        columns += klass.columns.map { |c| generate_column_string(c) } if class_exists?
+        columns + custom_fields
+      end
 
-  def self.normalize_type_expression(type_expression, mode:, null: true)
-    case type_expression
-    when "Text", "Json", "json"
-      ["String", null]
-    when "Decimal"
-      ["Float", null]
-    when "DateTime", "Datetime"
-      ["GraphQL::Types::ISO8601DateTime", null]
-    when "Date"
-      ["GraphQL::Types::ISO8601Date", null]
-    else
-      super
-    end
-  end
+      def self.normalize_type_expression(type_expression, mode:, null: true)
+        case type_expression
+        when "Text", "Json", "json"
+          ["String", null]
+        when "Decimal"
+          ["Float", null]
+        when "DateTime", "Datetime"
+          ["GraphQL::Types::ISO8601DateTime", null]
+        when "Date"
+          ["GraphQL::Types::ISO8601Date", null]
+        else
+          super
+        end
+      end
 
-  private
+      private
 
-  def generate_column_string(column)
-    name = column.name
-    required = column.null ? "" : "!"
-    type = column_type_string(column)
-    "#{name}:#{required}#{type}"
-  end
+      def generate_column_string(column)
+        name = column.name
+        required = column.null ? "" : "!"
+        type = column_type_string(column)
+        "#{name}:#{required}#{type}"
+      end
 
-  def column_type_string(column)
-    column.name == "id" ? "ID" : column.type.to_s.camelize
-  end
+      def column_type_string(column)
+        column.name == "id" ? "ID" : column.type.to_s.camelize
+      end
 
-  def class_exists?
-    klass.is_a?(Class) && klass.ancestors.include?(ActiveRecord::Base)
-  rescue NameError
-    false
-  end
+      def class_exists?
+        klass.is_a?(Class) && klass.ancestors.include?(ActiveRecord::Base)
+      rescue NameError
+        false
+      end
 
-  def model_name
-    type_name.try(:camelize, :upper)
-  end
+      def model_name
+        type_name.try(:camelize, :upper)
+      end
 
-  def klass
-    @klass ||= Module.const_get(type_name.camelize)
+      def klass
+        @klass ||= Module.const_get(type_name.camelize)
+      end
+    end
   end
 end

data/lib/generators/ibrain/graphql/resolver_generator.rb

@@ -4,26 +4,34 @@
 
 require_relative 'resolvers_generator'
 
-class Ibrain::Graphql::ResolverGenerator < Ibrain::Graphql::ResolversGenerator
-  source_root File.expand_path('templates', __dir__)
+module Ibrain
+  module Graphql
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::Resolver` by name
+    #     rails g graphql:resolver PostsResolver
+    class ResolverGenerator < ResolversGenerator
+      source_root File.expand_path('templates', __dir__)
 
-  def create_resolver_file
-    if @behavior == :revoke
-      log :gsub, "#{options[:directory]}/types/query_type.rb"
-    else
-      create_resolver_root_type
-    end
+      def create_resolver_file
+        if @behavior == :revoke
+          log :gsub, "#{options[:directory]}/types/query_type.rb"
+        else
+          create_resolver_root_type
+        end
 
-    if options[:model].present?
-      system("bundle exec rails generate ibrain:graphql:object #{options[:model].underscore}")
-    end
+        if options[:model].present?
+          system("bundle exec rails generate ibrain:graphql:object #{options[:model].underscore}")
+        end
 
-    template "resolver.erb", "#{options[:directory]}/resolvers/#{file_name}.rb"
-    return unless ::Ibrain::Config.is_auto_append_mutation
+        template "resolver.erb", "#{options[:directory]}/resolvers/#{file_name}.rb"
+        return unless ::Ibrain::Config.is_auto_append_mutation
 
-    in_root do
-      gsub_file "#{options[:directory]}/types/query_type.rb", /  \# TODO: Add Resolvers as fields\s*\n/m, ""
-      inject_into_file "#{options[:directory]}/types/query_type.rb", "\n    field :#{field_name}, resolver: Resolvers::#{resolver_name} \n  ", before: "end\nend", verbose: true, force: true
+        in_root do
+          gsub_file "#{options[:directory]}/types/query_type.rb", /  \# TODO: Add Resolvers as fields\s*\n/m, ""
+          inject_into_file "#{options[:directory]}/types/query_type.rb", "\n    field :#{field_name}, resolver: Resolvers::#{resolver_name} \n  ", before: "end\nend", verbose: true, force: true
+        end
+      end
     end
   end
-end
+end

data/lib/generators/ibrain/graphql/resolvers_generator.rb

@@ -4,65 +4,73 @@ require 'rails/generators'
 require 'rails/generators/named_base'
 require_relative 'core'
 
-class Ibrain::Graphql::ResolversGenerator < Rails::Generators::Base
-  include Core
-
-  desc "Create a resolver by name"
-  source_root File.expand_path('templates', __dir__)
-
-  argument :name, type: :string
-  class_option :model, type: :string, default: nil
-  class_option :prefix, type: :string, default: nil
-
-  def initialize(args, *options) # :nodoc:
-    # Unfreeze name in case it's given as a frozen string
-    args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
-    super
-
-    assign_names!(name)
-  end
-
-  attr_reader :file_name, :resolver_name, :field_name, :model_name
-
-  def create_resolver_file
-    if @behavior == :revoke
-      log :gsub, "#{options[:directory]}/types/query_type.rb"
-    else
-      create_resolver_root_type
-    end
-
-    if options[:model].present?
-      system("bundle exec rails generate ibrain:graphql:object #{options[:model].underscore}")
-    end
-
-    template "resolvers.erb", "#{options[:directory]}/resolvers/#{file_name}.rb"
-    template "aggregate.erb", "#{options[:directory]}/resolvers/#{file_name}_aggregate.rb"
-    return unless ::Ibrain::Config.is_auto_append_mutation
-
-    in_root do
-      gsub_file "#{options[:directory]}/types/query_type.rb", /  \# TODO: Add Resolvers as fields\s*\n/m, ""
-      inject_into_file "#{options[:directory]}/types/query_type.rb", "\n    field :#{field_name}, resolver: Resolvers::#{resolver_name}\n    field :#{field_name}_aggregate, resolver: Resolvers::#{resolver_name}Aggregate \n  ", before: "end\nend", verbose: true, force: true
-    end
-  end
-
-  private
-
-  def assign_names!(name)
-    underscore_name = name&.camelize&.underscore
-    prefix = options[:prefix].try(:underscore)
-
-    @model_name = options[:model].blank? ? 'Post' : options[:model].try(:camelize, :upper)
-
-    if prefix.blank?
-      @resolver_name = name.camelize(:upper)
-      @file_name = underscore_name
-      @field_name = underscore_name
-
-      return
+module Ibrain
+  module Graphql
+    # TODO: What other options should be supported?
+    #
+    # @example Generate a `GraphQL::Schema::Resolver` by name
+    #     rails g graphql:resolver PostsResolver
+    class ResolversGenerator < Rails::Generators::Base
+      include Core
+
+      desc "Create a resolver by name"
+      source_root File.expand_path('templates', __dir__)
+
+      argument :name, type: :string
+      class_option :model, type: :string, default: nil
+      class_option :prefix, type: :string, default: nil
+
+      def initialize(args, *options) # :nodoc:
+        # Unfreeze name in case it's given as a frozen string
+        args[0] = args[0].dup if args[0].is_a?(String) && args[0].frozen?
+        super
+
+        assign_names!(name)
+      end
+
+      attr_reader :file_name, :resolver_name, :field_name, :model_name
+
+      def create_resolver_file
+        if @behavior == :revoke
+          log :gsub, "#{options[:directory]}/types/query_type.rb"
+        else
+          create_resolver_root_type
+        end
+
+        if options[:model].present?
+          system("bundle exec rails generate ibrain:graphql:object #{options[:model].underscore}")
+        end
+
+        template "resolvers.erb", "#{options[:directory]}/resolvers/#{file_name}.rb"
+        template "aggregate.erb", "#{options[:directory]}/resolvers/#{file_name}_aggregate.rb"
+        return unless ::Ibrain::Config.is_auto_append_mutation
+
+        in_root do
+          gsub_file "#{options[:directory]}/types/query_type.rb", /  \# TODO: Add Resolvers as fields\s*\n/m, ""
+          inject_into_file "#{options[:directory]}/types/query_type.rb", "\n    field :#{field_name}, resolver: Resolvers::#{resolver_name}\n    field :#{field_name}_aggregate, resolver: Resolvers::#{resolver_name}Aggregate \n  ", before: "end\nend", verbose: true, force: true
+        end
+      end
+
+      private
+
+      def assign_names!(name)
+        underscore_name = name&.camelize&.underscore
+        prefix = options[:prefix].try(:underscore)
+
+        @model_name = options[:model].blank? ? 'Post' : options[:model].try(:camelize, :upper)
+
+        if prefix.blank?
+          @resolver_name = name.camelize(:upper)
+          @file_name = underscore_name
+          @field_name = underscore_name
+
+          return
+        end
+
+        @resolver_name = "#{prefix.try(:camelize, :upper)}::#{name.camelize(:upper)}"
+        @file_name = "#{prefix}/#{underscore_name}"
+        @field_name = "#{prefix}_#{underscore_name}"
+      end
     end
-
-    @resolver_name = "#{prefix.try(:camelize, :upper)}::#{name.camelize(:upper)}"
-    @file_name = "#{prefix}/#{underscore_name}"
-    @field_name = "#{prefix}_#{underscore_name}"
   end
 end

data/lib/generators/ibrain/graphql/templates/aggregate.erb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 <% module_namespacing_when_supported do -%>
-class Resolvers::<%= resolver_name %>Aggregate < Ibrain::Resolvers::BaseAggregate
-  description 'Define aggregate to count total records for <%= resolver_name %>'
-  # define resolve method
-  def resolve(args)
-    <%= model_name.try(:camelize, :upper) %>Repository.aggregate(args)
+module Resolvers
+  class <%= resolver_name %>Aggregate < Ibrain::Resolvers::BaseAggregate
+    description 'Define aggregate to count total records for <%= resolver_name %>'
+    # define resolve method
+    def resolve(args)
+      <%= model_name.try(:camelize, :upper) %>Repository.aggregate(args)
+    end
   end
 end
 <% end -%>

data/lib/generators/ibrain/graphql/templates/input.erb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
 
 <% module_namespacing_when_supported do -%>
-class Types::Attributes::<%= input_ruby_name.split('::')[-1] %> < Ibrain::Types::BaseInputObject
-  description '<%= input_ruby_name.split('::')[-1] %>'
-  
-  <% normalized_fields.each do |f| %>  <%= f.to_argument %>
-<% end %>end
+module Types
+  module Attributes
+    class <%= input_ruby_name.split('::')[-1] %> < Ibrain::Types::BaseInputObject
+      description '<%= input_ruby_name.split('::')[-1] %>'
+      
+    <% normalized_fields.each do |f| %>  <%= f.to_argument %>
+    <% end %>end
+  end
+end
 <% end -%>

data/lib/generators/ibrain/graphql/templates/mutation.erb

@@ -1,31 +1,32 @@
 # frozen_string_literal: true
 
 <% module_namespacing_when_supported do -%>
-class Mutations::<%= mutation_name %> < Ibrain::Mutations::BaseMutation
-  # TODO: define description describe about this mutation
-  # description
-
-  # TODO: define return fields
-  field :returning, Types::Objects::<%= model_name %>Type, null: true, description: 'Record Type for mutation response'
-
-  # TODO: define arguments
-  # argument :name, String, required: true
-  argument :attributes, Types::Attributes::<%= model_name %>Input, required: true
-  # argument :id, ID, required: true
-
-  # TODO: define resolve method
-  def resolve(args)
-    # TODO: define logic inside repository
-    # Something like
-    # if resource.blank?
-    #   raise GraphQL::ExecutionError, I18n.t("activerecord.errors.models.job.attributes.id.could_not_find")
-    # end
-
-    # repo.update(normalize_parameters)
-    graphql_return
-  end
+module Mutations
+  class <%= mutation_name %> < Ibrain::Mutations::BaseMutation
+    # TODO: define description describe about this mutation
+    # description
+
+    # TODO: define return fields
+    field :returning, Types::Objects::<%= model_name %>Type, null: true, description: 'Record Type for mutation response'
+
+    # TODO: define arguments
+    # argument :name, String, required: true
+    argument :attributes, Types::Attributes::<%= model_name %>Input, required: true
+    # argument :id, ID, required: true
+
+    # TODO: define resolve method
+    def resolve(args)
+      # TODO: define logic inside repository
+      # Something like
+      # if resource.blank?
+      #   raise GraphQL::ExecutionError, I18n.t("activerecord.errors.models.job.attributes.id.could_not_find")
+      # end
+
+      # repo.update(normalize_parameters)
+      graphql_return
+    end
 
-  private
+    private
 
     def normalize_parameters
       # attribute_params.permit(:name, :status)
@@ -38,5 +39,6 @@ class Mutations::<%= mutation_name %> < Ibrain::Mutations::BaseMutation
     def repo
       # <%= model_name %>Repository.new(current_user, resource)
     end
+  end
 end
 <% end -%>

data/lib/generators/ibrain/graphql/templates/object.erb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 <% module_namespacing_when_supported do -%>
-class Types::Objects::<%= type_ruby_name.split('::')[-1] %> < Ibrain::Types::BaseType
-  implements Ibrain::Interfaces::RecordInterface
+module Types
+  module Objects
+    class <%= type_ruby_name.split('::')[-1] %> < Ibrain::Types::BaseType
+      implements Ibrain::Interfaces::RecordInterface
 
-  description '<%= type_ruby_name.split('::')[-1] %>'
-  
-<% normalized_fields.each do |f| %>  <%= f.to_ruby %>
-<% end %>end
+      description '<%= type_ruby_name.split('::')[-1] %>'
+      
+    <% normalized_fields.each do |f| %>  <%= f.to_ruby %>
+    <% end %>end
+  end
+end
 <% end -%>

data/lib/generators/ibrain/graphql/templates/resolver.erb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
 <% module_namespacing_when_supported do -%>
-class Resolvers::<%= resolver_name %> < Ibrain::Resolvers::BaseResolver
-  # TODO: define description describe about this mutation
-  # description
+module Resolvers
+  class <%= resolver_name %> < Ibrain::Resolvers::BaseResolver
+    # TODO: define description describe about this mutation
+    # description
 
-  # TODO: define return fields
-  type Types::Objects::<%= model_name.capitalize %>Type, null: false
+    # TODO: define return fields
+    type Types::Objects::<%= model_name.capitalize %>Type, null: false
 
-  argument :id, ID, required: true, description: 'TODO: describe about this argument'
+    argument :id, ID, required: true, description: 'TODO: describe about this argument'
 
-  # TODO: define resolve method
-  def resolve(args)
-    <%= model_name.capitalize %>Repository.find(args)
+    # TODO: define resolve method
+    def resolve(args)
+      <%= model_name.capitalize %>Repository.find(args)
+    end
   end
 end
 <% end -%>

data/lib/generators/ibrain/graphql/templates/resolvers.erb

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
 <% module_namespacing_when_supported do -%>
-class Resolvers::<%= resolver_name %> < <%= resolver_name %>Aggregate
-  # TODO: define description describe about this mutation
-  # description
+module Resolvers
+  class <%= resolver_name %> < <%= resolver_name %>Aggregate
+    # TODO: define description describe about this mutation
+    # description
 
-  # TODO: define return fields
-  type [Types::Objects::<%= model_name.capitalize %>Type], null: false
+    # TODO: define return fields
+    type [Types::Objects::<%= model_name.capitalize %>Type], null: false
 
-  # TODO: define resolve method
-  def resolve(args)
-    super(args).paginate(args)
+    # TODO: define resolve method
+    def resolve(args)
+      super(args).paginate(args)
+    end
   end
 end
 <% end -%>