ibrain-core 0.4.6 → 0.4.7

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

@@ -7,106 +7,110 @@ require 'active_support'
 require 'active_support/core_ext/string/inflections'
 require_relative 'core'
 
-class Ibrain::Graphql::TypeGeneratorBase < Rails::Generators::Base
-  include Core
+module Ibrain
+  module Graphql
+    class TypeGeneratorBase < Rails::Generators::Base
+      include Core
 
-  argument :type_name,
-            type: :string,
-            banner: "TypeName",
-            desc: "Name of this object type (expressed as Ruby or GraphQL)"
+      argument :type_name,
+               type: :string,
+               banner: "TypeName",
+               desc: "Name of this object type (expressed as Ruby or GraphQL)"
 
-  # Take a type expression in any combination of GraphQL or Ruby styles
-  # and return it in a specified output style
-  # TODO: nullability / list with `mode: :graphql` doesn't work
-  # @param type_expresson [String]
-  # @param mode [Symbol]
-  # @param null [Boolean]
-  # @return [(String, Boolean)] The type expression, followed by `null:` value
-  def self.normalize_type_expression(type_expression, mode:, null: false)
-    if type_expression.start_with?("!")
-      normalize_type_expression(type_expression[1..-1], mode: mode, null: false)
-    elsif type_expression.end_with?("!")
-      normalize_type_expression(type_expression[0..-2], mode: mode, null: false)
-    elsif type_expression.start_with?("[") && type_expression.end_with?("]")
-      name, is_null = normalize_type_expression(type_expression[1..-2], mode: mode, null: null)
-      ["[#{name}]", is_null]
-    elsif type_expression.end_with?("Type")
-      normalize_type_expression(type_expression[0..-5], mode: mode, null: null)
-    elsif type_expression.start_with?("Types::")
-      normalize_type_expression(type_expression[7..-1], mode: mode, null: null)
-    elsif type_expression.start_with?("types.")
-      normalize_type_expression(type_expression[6..-1], mode: mode, null: null)
-    else
-      case mode
-      when :ruby
-        case type_expression
-        when "Int"
-          ["Integer", null]
-        when "Integer", "Float", "Boolean", "String", "ID"
-          [type_expression, null]
+      # Take a type expression in any combination of GraphQL or Ruby styles
+      # and return it in a specified output style
+      # TODO: nullability / list with `mode: :graphql` doesn't work
+      # @param type_expresson [String]
+      # @param mode [Symbol]
+      # @param null [Boolean]
+      # @return [(String, Boolean)] The type expression, followed by `null:` value
+      def self.normalize_type_expression(type_expression, mode:, null: false)
+        if type_expression.start_with?("!")
+          normalize_type_expression(type_expression[1..-1], mode: mode, null: false)
+        elsif type_expression.end_with?("!")
+          normalize_type_expression(type_expression[0..-2], mode: mode, null: false)
+        elsif type_expression.start_with?("[") && type_expression.end_with?("]")
+          name, is_null = normalize_type_expression(type_expression[1..-2], mode: mode, null: null)
+          ["[#{name}]", is_null]
+        elsif type_expression.end_with?("Type")
+          normalize_type_expression(type_expression[0..-5], mode: mode, null: null)
+        elsif type_expression.start_with?("Types::")
+          normalize_type_expression(type_expression[7..-1], mode: mode, null: null)
+        elsif type_expression.start_with?("types.")
+          normalize_type_expression(type_expression[6..-1], mode: mode, null: null)
         else
-          ["Types::#{type_expression.camelize}Type", null]
+          case mode
+          when :ruby
+            case type_expression
+            when "Int"
+              ["Integer", null]
+            when "Integer", "Float", "Boolean", "String", "ID"
+              [type_expression, null]
+            else
+              ["Types::#{type_expression.camelize}Type", null]
+            end
+          when :input
+            ["Types::#{type_expression.camelize}Input", null]
+          when :graphql
+            [type_expression.camelize, null]
+          else
+            raise "Unexpected normalize mode: #{mode}"
+          end
         end
-      when :input
-        ["Types::#{type_expression.camelize}Input", null]
-      when :graphql
-        [type_expression.camelize, null]
-      else
-        raise "Unexpected normalize mode: #{mode}"
       end
-    end
-  end
 
-  private
+      private
 
-  # @return [String] The user-provided type name, normalized to Ruby code
-  def type_ruby_name
-    @type_ruby_name ||= self.class.normalize_type_expression(type_name, mode: :ruby)[0]
-  end
+      # @return [String] The user-provided type name, normalized to Ruby code
+      def type_ruby_name
+        @type_ruby_name ||= self.class.normalize_type_expression(type_name, mode: :ruby)[0]
+      end
 
-  # @return [String] The user-provided type name, as a GraphQL name
-  def type_graphql_name
-    @type_graphql_name ||= self.class.normalize_type_expression(type_name, mode: :graphql)[0]
-  end
+      # @return [String] The user-provided type name, as a GraphQL name
+      def type_graphql_name
+        @type_graphql_name ||= self.class.normalize_type_expression(type_name, mode: :graphql)[0]
+      end
 
-  # @return [String] The user-provided type name, as a file name (without extension)
-  def type_file_name
-    @type_file_name ||= "#{type_graphql_name}Type".underscore
-  end
+      # @return [String] The user-provided type name, as a file name (without extension)
+      def type_file_name
+        @type_file_name ||= "#{type_graphql_name}Type".underscore
+      end
 
-  # @return [String] The user-provided type name, as a file name (without extension)
-  def input_file_name
-    @input_file_name ||= "#{type_graphql_name}Input".underscore
-  end
+      # @return [String] The user-provided type name, as a file name (without extension)
+      def input_file_name
+        @input_file_name ||= "#{type_graphql_name}Input".underscore
+      end
 
-  def input_ruby_name
-    @input_ruby_name ||= self.class.normalize_type_expression(type_name, mode: :input)[0]
-  end
+      def input_ruby_name
+        @input_ruby_name ||= self.class.normalize_type_expression(type_name, mode: :input)[0]
+      end
 
-  # @return [Array<NormalizedField>] User-provided fields, in `(name, Ruby type name)` pairs
-  def normalized_fields
-    skip_fields = ["created_at:!Datetime", "updated_at:!Datetime"]
+      # @return [Array<NormalizedField>] User-provided fields, in `(name, Ruby type name)` pairs
+      def normalized_fields
+        skip_fields = ["created_at:!Datetime", "updated_at:!Datetime"]
 
-    @normalized_fields ||= fields.reject { |f| skip_fields.include?(f) }.map { |f|
-      name, raw_type = f.split(":", 2)
-      type_expr, null = self.class.normalize_type_expression(raw_type, mode: :ruby)
-      NormalizedField.new(name, type_expr, null)
-    }
-  end
+        @normalized_fields ||= fields.reject { |f| skip_fields.include?(f) }.map { |f|
+          name, raw_type = f.split(":", 2)
+          type_expr, null = self.class.normalize_type_expression(raw_type, mode: :ruby)
+          NormalizedField.new(name, type_expr, null)
+        }
+      end
 
-  class NormalizedField
-    def initialize(name, type_expr, null)
-      @name = name
-      @type_expr = type_expr
-      @null = null
-    end
+      class NormalizedField
+        def initialize(name, type_expr, null)
+          @name = name
+          @type_expr = type_expr
+          @null = null
+        end
 
-    def to_ruby
-      "field :#{@name}, #{@type_expr}, null: #{@null}"
-    end
+        def to_ruby
+          "field :#{@name}, #{@type_expr}, null: #{@null}"
+        end
 
-    def to_argument
-      "argument :#{@name}, #{@type_expr}, required: #{@null}"
+        def to_argument
+          "argument :#{@name}, #{@type_expr}, required: #{@null}"
+        end
+      end
     end
   end
 end

data/lib/generators/ibrain/install/install_generator.rb

@@ -3,175 +3,178 @@
 require 'rails/generators'
 require 'ibrain/logger'
 
-class Ibrain::InstallGenerator < Rails::Generators::Base
-  CORE_MOUNT_ROUTE = "mount Ibrain::Core::Engine"
-  source_root File.expand_path('templates', __dir__)
-
-  class_option :user_class, type: :string
-  class_option :with_authentication, type: :boolean, default: true
-  class_option :with_rubocop, type: :boolean, default: true
-  class_option :with_graphql, type: :boolean, default: false
-  class_option :with_annotation, type: :boolean, default: true
-  class_option :with_sendgrid, type: :boolean, default: false
-  class_option :enforce_available_locales, type: :boolean, default: nil
-  class_option :with_ridgepole, type: :boolean, default: true
-
-  def additional_tweaks
-    return unless File.exist? 'public/robots.txt'
-
-    append_file "public/robots.txt", <<-ROBOTS.strip_heredoc
-      User-agent: *
-      Disallow: /user
-      Disallow: /account
-      Disallow: /api
-      Disallow: /password
-    ROBOTS
-  end
+module Ibrain
+  # @private
+  class InstallGenerator < Rails::Generators::Base
+    CORE_MOUNT_ROUTE = "mount Ibrain::Core::Engine"
+    source_root File.expand_path('templates', __dir__)
+
+    class_option :user_class, type: :string
+    class_option :with_authentication, type: :boolean, default: true
+    class_option :with_rubocop, type: :boolean, default: true
+    class_option :with_graphql, type: :boolean, default: false
+    class_option :with_annotation, type: :boolean, default: true
+    class_option :with_sendgrid, type: :boolean, default: false
+    class_option :enforce_available_locales, type: :boolean, default: nil
+    class_option :with_ridgepole, type: :boolean, default: true
+
+    def additional_tweaks
+      return unless File.exist? 'public/robots.txt'
+
+      append_file "public/robots.txt", <<-ROBOTS.strip_heredoc
+        User-agent: *
+        Disallow: /user
+        Disallow: /account
+        Disallow: /api
+        Disallow: /password
+      ROBOTS
+    end
 
-  def create_overrides_directory
-    empty_directory "app/overrides"
-  end
+    def create_overrides_directory
+      empty_directory "app/overrides"
+    end
 
-  def configure_application
-    if !options[:enforce_available_locales].nil?
-      application <<-RUBY
-        I18n.enforce_available_locales = #{options[:enforce_available_locales]}
-      RUBY
+    def configure_application
+      if !options[:enforce_available_locales].nil?
+        application <<-RUBY
+          I18n.enforce_available_locales = #{options[:enforce_available_locales]}
+        RUBY
+      end
     end
-  end
 
-  def plugin_install_preparation
-    @plugins_to_be_installed = []
-    @plugin_generators_to_run = []
-  end
+    def plugin_install_preparation
+      @plugins_to_be_installed = []
+      @plugin_generators_to_run = []
+    end
 
-  def install_auth_plugin
-    if options[:with_authentication] && (options[:auto_accept] || !no?("
-      Ibrain has a default authentication extension that uses Devise.
-      You can find more info at https://github.com/john-techfox/ibrain-auth.git.
+    def install_auth_plugin
+      if options[:with_authentication] && (options[:auto_accept] || !no?("
+        Ibrain has a default authentication extension that uses Devise.
+        You can find more info at https://github.com/john-techfox/ibrain-auth.git.
 
-      Would you like to install it? (Y/n)"))
+        Would you like to install it? (Y/n)"))
 
-      @plugins_to_be_installed << 'ibrain-auth' unless system('gem list | grep ibrain-auth')
-      @plugin_generators_to_run << "ibrain:auth:install --with-ridgpole=#{options[:with_ridgepole]}"
+        @plugins_to_be_installed << 'ibrain-auth' unless system('gem list | grep ibrain-auth')
+        @plugin_generators_to_run << "ibrain:auth:install --with-ridgpole=#{options[:with_ridgepole]}"
+      end
     end
-  end
 
-  def run_bundle_install_if_needed_by_plugins
-    @plugins_to_be_installed.each do |plugin_name|
-      gem plugin_name
-    end
+    def run_bundle_install_if_needed_by_plugins
+      @plugins_to_be_installed.each do |plugin_name|
+        gem plugin_name
+      end
 
-    if options[:with_rubocop]
-      append_gem('rubocop', '1.23.0', 'development')
-      append_gem('rubocop-performance', '1.12.0', 'development')
-      append_gem('rubocop-rails', '2.12.4', 'development')
-      append_gem('rubocop-graphql', '0.11.2', 'development')
-    end
+      if options[:with_rubocop]
+        append_gem('rubocop', '1.23.0', 'development')
+        append_gem('rubocop-performance', '1.12.0', 'development')
+        append_gem('rubocop-rails', '2.12.4', 'development')
+        append_gem('rubocop-graphql', '0.11.2', 'development')
+      end
 
-    if options[:with_graphql]
-      append_gem('graphql', '1.12.6')
-      append_gem('graphql-batch', '0.4.3')
-      append_gem('graphql-guard', '2.0.0')
-      append_gem('graphql-rails-generators', '1.1.2', 'development')
-      append_gem('graphiql-rails', '1.8.0', 'development')
-      append_gem('apollo_upload_server', '2.1')
-    end
+      if options[:with_graphql]
+        append_gem('graphql', '1.12.6')
+        append_gem('graphql-batch', '0.4.3')
+        append_gem('graphql-guard', '2.0.0')
+        append_gem('graphql-rails-generators', '1.1.2', 'development')
+        append_gem('graphiql-rails', '1.8.0', 'development')
+        append_gem('apollo_upload_server', '2.1')
+      end
 
-    append_gem('annotate', '3.1.1', 'development') if options[:with_annotation]
-    append_gem('sendgrid-ruby', '6.6.0') if options[:with_sendgrid]
+      append_gem('annotate', '3.1.1', 'development') if options[:with_annotation]
+      append_gem('sendgrid-ruby', '6.6.0') if options[:with_sendgrid]
 
-    if options[:with_ridgepole]
-      append_gem('ridgepole', '1.0.0', 'development')
-    else
-      remove_gem('ridgepole')
-    end
+      if options[:with_ridgepole]
+        append_gem('ridgepole', '1.0.0', 'development')
+      else
+        remove_gem('ridgepole')
+      end
 
-    bundle_cleanly{ run "bundle install" } if @plugins_to_be_installed.any?
-    run "spring stop" if defined?(Spring)
+      bundle_cleanly{ run "bundle install" } if @plugins_to_be_installed.any?
+      run "spring stop" if defined?(Spring)
 
-    @plugin_generators_to_run.each do |plugin_generator_name|
-      generate plugin_generator_name.to_s
+      @plugin_generators_to_run.each do |plugin_generator_name|
+        generate plugin_generator_name.to_s
+      end
     end
-  end
 
-  def install_routes
-    routes_file_path = File.join('config', 'routes.rb')
-    unless File.read(routes_file_path).include? CORE_MOUNT_ROUTE
-      insert_into_file routes_file_path, after: "Rails.application.routes.draw do\n" do
-        <<-RUBY
-          # This line mounts Ibrain's routes at the root of your application.
-          # This means, any requests to URLs such as /graphql, will go to Ibrain::GraphqlController,
-          # any requests to URLS such as /auth, will go to Ibrain::AuthController,
-          # If you would like to change where this engine is mounted, simply change the :at option to something different.
-          #
-          # We ask that you don't use the :as option here, as Ibrain relies on it being the default of "ibrain"
-          #{CORE_MOUNT_ROUTE}, at: '/'
-
-          # Please contact to Tai Nguyen Van <tainv@its-global.vn> if you have any question?
-        RUBY
+    def install_routes
+      routes_file_path = File.join('config', 'routes.rb')
+      unless File.read(routes_file_path).include? CORE_MOUNT_ROUTE
+        insert_into_file routes_file_path, after: "Rails.application.routes.draw do\n" do
+          <<-RUBY
+            # This line mounts Ibrain's routes at the root of your application.
+            # This means, any requests to URLs such as /graphql, will go to Ibrain::GraphqlController,
+            # any requests to URLS such as /auth, will go to Ibrain::AuthController,
+            # If you would like to change where this engine is mounted, simply change the :at option to something different.
+            #
+            # We ask that you don't use the :as option here, as Ibrain relies on it being the default of "ibrain"
+            #{CORE_MOUNT_ROUTE}, at: '/'
+
+            # Please contact to Tai Nguyen Van <tainv@its-global.vn> if you have any question?
+          RUBY
+        end
       end
-    end
 
-    unless options[:quiet]
-      Ibrain::Logger.info "*" * 50
-      Ibrain::Logger.info "We added the following line to your application's config/routes.rb file:"
-      Ibrain::Logger.info " "
-      Ibrain::Logger.info "    #{CORE_MOUNT_ROUTE}, at: '/'"
+      unless options[:quiet]
+        Ibrain::Logger.info "*" * 50
+        Ibrain::Logger.info "We added the following line to your application's config/routes.rb file:"
+        Ibrain::Logger.info " "
+        Ibrain::Logger.info "    #{CORE_MOUNT_ROUTE}, at: '/'"
+      end
     end
-  end
 
-  def add_files
-    template 'config/initializers/ibrain.rb.tt', 'config/initializers/ibrain.rb', { skip: true }
-    template 'config/initializers/cors.tt', 'config/initializers/cors.rb'
-    template 'config/puma.tt', 'config/puma.rb'
-    yml_template 'config/database.tt', 'config/database.yml'
-    template 'rubocop.yml.tt', '.rubocop.yml' if options[:with_rubocop]
-
-    if options[:with_graphql]
-      template 'graphql/app_schema.rb.tt', 'app/graphql/app_schema.rb', { skip: true }
-      template 'graphql/types/mutation_type.rb.tt', 'app/graphql/types/mutation_type.rb', { skip: true }
-      template 'graphql/types/query_type.rb.tt', 'app/graphql/types/query_type.rb', { skip: true }
+    def add_files
+      template 'config/initializers/ibrain.rb.tt', 'config/initializers/ibrain.rb', { skip: true }
+      template 'config/initializers/cors.tt', 'config/initializers/cors.rb'
+      template 'config/puma.tt', 'config/puma.rb'
+      yml_template 'config/database.tt', 'config/database.yml'
+      template 'rubocop.yml.tt', '.rubocop.yml' if options[:with_rubocop]
+
+      if options[:with_graphql]
+        template 'graphql/app_schema.rb.tt', 'app/graphql/app_schema.rb', { skip: true }
+        template 'graphql/types/mutation_type.rb.tt', 'app/graphql/types/mutation_type.rb', { skip: true }
+        template 'graphql/types/query_type.rb.tt', 'app/graphql/types/query_type.rb', { skip: true }
+      end
     end
-  end
 
-  def complete
-    unless options[:quiet]
-      Ibrain::Logger.info "*" * 50
-      Ibrain::Logger.info "Ibrain has been installed successfully. You're all ready to go!"
-      Ibrain::Logger.info " "
-      Ibrain::Logger.info "Enjoy!"
+    def complete
+      unless options[:quiet]
+        Ibrain::Logger.info "*" * 50
+        Ibrain::Logger.info "Ibrain has been installed successfully. You're all ready to go!"
+        Ibrain::Logger.info " "
+        Ibrain::Logger.info "Enjoy!"
+      end
     end
-  end
 
-  private
+    private
 
-  def bundle_cleanly(&block)
-    Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&block) : Bundler.with_clean_env(&block)
-  end
+    def bundle_cleanly(&block)
+      Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&block) : Bundler.with_clean_env(&block)
+    end
 
-  def append_gem(name, version, group_name = nil)
-    shell_command = ["\ngem '#{name}', '~> #{version}'"]
-    shell_command.push("group: :#{group_name}") if group_name.present?
-    string_command = shell_command.join(', ')
-    gems = Gem.loaded_specs.values.map(&:full_name).join(' ')
+    def append_gem(name, version, group_name = nil)
+      shell_command = ["\ngem '#{name}', '~> #{version}'"]
+      shell_command.push("group: :#{group_name}") if group_name.present?
+      string_command = shell_command.join(', ')
+      gems = Gem.loaded_specs.values.map(&:full_name).join(' ')
 
-    system( `echo "#{string_command}" >> Gemfile` ) unless gems.include?("#{name}-")
-  end
+      system( `echo "#{string_command}" >> Gemfile` ) unless gems.include?("#{name}-")
+    end
 
-  def remove_gem(name)
-    gems = Gem.loaded_specs.values.map(&:full_name).join(' ')
+    def remove_gem(name)
+      gems = Gem.loaded_specs.values.map(&:full_name).join(' ')
 
-    system( "bundle remove #{name}" ) if gems.include?("#{name}-")
-  end
+      system( "bundle remove #{name}" ) if gems.include?("#{name}-")
+    end
 
-  def yml_template(source, *args)
-    config = args.last.is_a?(Hash) ? args.pop : {}
-    destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/o, "")
-    source = File.expand_path(find_in_source_paths(source.to_s))
+    def yml_template(source, *args)
+      config = args.last.is_a?(Hash) ? args.pop : {}
+      destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/o, "")
+      source = File.expand_path(find_in_source_paths(source.to_s))
 
-    create_file destination, nil, config do
-      File.read(source)
+      create_file destination, nil, config do
+        File.read(source)
+      end
     end
   end
 end

data/lib/generators/ibrain/install/templates/graphql/types/mutation_type.rb.tt

@@ -1,20 +1,22 @@
 # frozen_string_literal: true
 
-class Types::MutationType < Ibrain::Types::BaseApiObject
-  description 'Define all mutation for client'
+module Types
+  class MutationType < Ibrain::Types::BaseApiObject
+    description 'Define all mutation for client'
 
-  # TODO: remove me
-  # Default session_required is true, set false if yout want to skip authenticated
-  field :test_authenticated_field, , String, null: false,
-                              description: 'An example field added by the generator'
+    # TODO: remove me
+    # Default session_required is true, set false if yout want to skip authenticated
+    field :test_authenticated_field, , String, null: false,
+                               description: 'An example field added by the generator'
 
-  field :test_field, String, null: false,
-                              description: 'An example field added by the generator', session_required: false
-  def test_field
-    'Hello World'
-  end
+    field :test_field, String, null: false,
+                               description: 'An example field added by the generator', session_required: false
+    def test_field
+      'Hello World'
+    end
 
-  def test_authenticated_field
-    'Im logged in!'
+    def test_authenticated_field
+      'Im logged in!'
+    end
   end
 end

data/lib/generators/ibrain/install/templates/graphql/types/query_type.rb.tt

@@ -1,17 +1,19 @@
 # frozen_string_literal: true
 
-class Types::QueryType < Ibrain::Types::BaseApiObject
-  description 'Define all resolver for client'
+module Types
+  class QueryType < Ibrain::Types::BaseApiObject
+    description 'Define all resolver for client'
 
-  # Add `node(id: ID!) and `nodes(ids: [ID!]!)`
-  include GraphQL::Types::Relay::HasNodeField
-  include GraphQL::Types::Relay::HasNodesField
+    # Add `node(id: ID!) and `nodes(ids: [ID!]!)`
+    include GraphQL::Types::Relay::HasNodeField
+    include GraphQL::Types::Relay::HasNodesField
 
-  # Add root-level fields here.
-  # Default session_required is true, set false if yout want to skip authenticated
-  # They will be entry points for queries on your schema.
+    # Add root-level fields here.
+    # Default session_required is true, set false if yout want to skip authenticated
+    # They will be entry points for queries on your schema.
 
-  # Example with user resolvers
-  # field :authenticated_users, resolver: Resolvers::UsersResolver
-  # field :users, resolver: Resolvers::UsersResolver, session_required: false
+    # Example with user resolvers
+    # field :authenticated_users, resolver: Resolvers::UsersResolver
+    # field :users, resolver: Resolvers::UsersResolver, session_required: false
+  end
 end