ibrain-core 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f025cda0967d5fb69166c0c8414008674498f34ee663f835686fa72e928dcc8
-  data.tar.gz: 4a70645118e2df91125b8baead82bfd1688cc7ea11dfe24c471a6cbc875761f0
+  metadata.gz: 15662385f790ab0c279015f64d2b030b3a8876b3ae065dcba33f882d1c8eb5ef
+  data.tar.gz: b4d0abf1ada4db4e786c708625c554406259a98cb76ad49f23769e2da5c39aee
 SHA512:
-  metadata.gz: e4c427744bc5d9c0e7535b81827f805509173f6966bf1a1f9f227dec8acfee5baf0b284d1e4581bc6a2446671c7808e1a51e4e19ed29d8ea1a263187e9484152
-  data.tar.gz: 3c652fd06e5202f33b7fc7c32c3d173ac608aec4c9010dc2163c7a6e41bf876f9a3035b9b5c2d56acfe068004e78652e471fa87ac7e6728f0078ab3d03fc32e0
+  metadata.gz: bab3e2f29f099217bd5ba3f9d09ab5479208d80e0ced40df6284056d1eb5e5ba3a10c027b3e674ba813c76446e437faa4e8d696b85dc4940a887a42fe6e5c91f
+  data.tar.gz: e23a79aa2347ca540cac61f20923fed42e0288ee98fda296e70734b1cab86740ad4e4a5b4b45524b593cb518ec94b303a8e6a230195a6bbed5a5205111feb6e3

data/app/graphql/ibrain/extentions/default_value.rb

@@ -3,6 +3,8 @@
 module Ibrain
   module Extentions
     class DefaultValue < GraphQL::Schema::FieldExtension
+      description 'Default value extention'
+
       def after_resolve(value:, **_rest)
         if value.nil?
           options[:default_value]

data/app/graphql/ibrain/resolvers/base_resolver.rb

@@ -3,9 +3,9 @@
 module Ibrain
   module Resolvers
     class BaseResolver < GraphQL::Schema::Resolver
-      argument :filter, Ibrain::Types::FilterType, required: false, default_value: nil
-      argument :offset, Int, required: false, default_value: 0
-      argument :limit, Int, required: false, default_value: 10
+      argument :filter, Ibrain::Types::FilterType, required: false, default_value: nil, description: 'Filter object for resolver'
+      argument :limit, Int, required: false, default_value: 10, description: 'Limit records'
+      argument :offset, Int, required: false, default_value: 0, description: 'Get records from cursor position'
 
       def current_user
         context.fetch(:current_user)

data/app/graphql/ibrain/types/filter_type.rb

@@ -3,6 +3,7 @@
 module Ibrain
   module Types
     class FilterType < GraphQL::Schema::Scalar
+      description 'Filter Type'
     end
   end
 end

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

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Resolvers
-  class <%= "#{resolver_name}Aggregate" %> < Ibrain::Resolvers::BaseAggregate
+  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.capitalize %>.ransack(args[:filter]).result

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

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Mutations
   class <%= mutation_name %> < Ibrain::Mutations::BaseMutation
+    # TODO: define description describe about this mutation
+    # description
+
     # TODO: define return fields
-    field :<%= model_name.underscore %>, Types::<%= model_name %>Type, null: false
+    field :<%= model_name.underscore %>, Types::<%= model_name %>Type, null: false, description: 'Record Type for mutation response'
 
     # TODO: define arguments
     # argument :name, String, required: true

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

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

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

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 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
+    type Types::Objects::<%= model_name.capitalize %>Type, null: false, description: 'Define data type will be response to client'
 
-    argument :id, ID, required: false
+    argument :id, ID, required: false, description: 'TODO: describe about this argument'
 
     # TODO: define resolve method
     def resolve(args)

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

@@ -1,8 +1,13 @@
+# frozen_string_literal: true
+
 <% module_namespacing_when_supported do -%>
 module Resolvers
-  class <%= resolver_name %> < <%= "#{resolver_name}Aggregate" %>
+  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
+    type [Types::Objects::<%= model_name.capitalize %>Type], null: false, description: 'Define data type will be response to client'
 
     # TODO: define resolve method
     def resolve(args)

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

@@ -79,6 +79,7 @@ module Ibrain
         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]

data/lib/generators/ibrain/install/templates/graphql/app_schema.rb.tt

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 class AppSchema < Ibrain::BaseSchema
+  description 'Define root schema'
+
   mutation(Types::MutationType)
   query(Types::QueryType)
-end
+end

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

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Types
   class MutationType < Ibrain::Types::BaseObject
+    description 'Define all mutation for client'
+
     # TODO: remove me
     field :test_field, String, null: false,
                                description: 'An example field added by the generator'
@@ -7,4 +11,4 @@ module Types
       'Hello World'
     end
   end
-end
+end

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

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Types
   class QueryType < Ibrain::Types::BaseObject
+    description 'Define all resolver for client'
+
     # Add `node(id: ID!) and `nodes(ids: [ID!]!)`
     include GraphQL::Types::Relay::HasNodeField
     include GraphQL::Types::Relay::HasNodesField

data/lib/generators/ibrain/install/templates/rubocop.yml.tt

@@ -3,15 +3,11 @@
 require:
   - rubocop-performance
   - rubocop-rails
+  - rubocop-graphql
 
 AllCops:
   TargetRubyVersion: 2.5
 
-# Sometimes I believe this reads better
-# This also causes spacing issues on multi-line fixes
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 # We use class vars and will have to continue doing so for compatability
 Style/ClassVars:
   Enabled: false
@@ -78,7 +74,7 @@ Layout/ElseAlignment:
 Layout/IndentationWidth:
   Enabled: false
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Enabled: false
 
 Layout/ClosingParenthesisIndentation:
@@ -87,13 +83,13 @@ Layout/ClosingParenthesisIndentation:
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
-Layout/IndentFirstArrayElement:
+Layout/FirstArrayElementIndentation:
   Enabled: false
 
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   Enabled: false
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
 Style/TrailingCommaInArguments:
@@ -307,7 +303,7 @@ Style/FrozenStringLiteralComment:
 Style/LambdaCall:
   Enabled: false
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - id
     - to
@@ -320,11 +316,283 @@ Style/IdenticalConditionalBranches:
 Naming/MemoizedInstanceVariableName:
   Enabled: false
 
-Lint/UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: false
 
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: false
 
 Rails/ReflectionClassName:
-  Enabled: true
+  Enabled: true
+  Exclude:
+    - app/models/ibrain/role_user.rb
+
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+
+Gemspec/RequireMFA: # new in 1.23
+  Enabled: true
+
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+
+Lint/UselessRuby2Keywords: # new in 1.23
+  Enabled: true
+
+Security/IoMethods: # new in 1.22
+  Enabled: true
+
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+
+Style/HashConversion: # new in 1.10
+  Enabled: true
+
+Style/HashExcept: # new in 1.7
+  Enabled: true
+
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+
+Style/NilLambda: # new in 1.3
+  Enabled: true
+
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+
+Style/OpenStructUse: # new in 1.23
+  Enabled: true
+
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+
+Style/StringChars: # new in 1.12
+  Enabled: true
+
+Style/SwapValues: # new in 1.1
+  Enabled: true
+
+Performance/AncestorsInclude: # new in 1.7
+  Enabled: true
+
+Performance/BigDecimalWithNumericArgument: # new in 1.7
+  Enabled: true
+
+Performance/BlockGivenWithExplicitBlock: # new in 1.9
+  Enabled: true
+
+Performance/CollectionLiteralInLoop: # new in 1.8
+  Enabled: true
+
+Performance/ConcurrentMonotonicTime: # new in 1.12
+  Enabled: true
+
+Performance/ConstantRegexp: # new in 1.9
+  Enabled: true
+
+Performance/MapCompact: # new in 1.11
+  Enabled: true
+
+Performance/MethodObjectAsBlock: # new in 1.9
+  Enabled: true
+
+Performance/RedundantEqualityComparisonBlock: # new in 1.10
+  Enabled: true
+
+Performance/RedundantSortBlock: # new in 1.7
+  Enabled: true
+
+Performance/RedundantSplitRegexpArgument: # new in 1.10
+  Enabled: true
+
+Performance/RedundantStringChars: # new in 1.7
+  Enabled: true
+
+Performance/ReverseFirst: # new in 1.7
+  Enabled: true
+
+Performance/SortReverse: # new in 1.7
+  Enabled: true
+
+Performance/Squeeze: # new in 1.7
+  Enabled: true
+
+Performance/StringInclude: # new in 1.7
+  Enabled: true
+
+Performance/Sum: # new in 1.8
+  Enabled: true
+
+Rails/ActiveRecordCallbacksOrder: # new in 2.7
+  Enabled: true
+
+Rails/AddColumnIndex: # new in 2.11
+  Enabled: true
+
+Rails/AfterCommitOverride: # new in 2.8
+  Enabled: true
+
+Rails/AttributeDefaultBlockValue: # new in 2.9
+  Enabled: true
+
+Rails/EagerEvaluationLogMessage: # new in 2.11
+  Enabled: true
+
+Rails/ExpandedDateRange: # new in 2.11
+  Enabled: true
+
+Rails/FindById: # new in 2.7
+  Enabled: true
+
+Rails/I18nLocaleAssignment: # new in 2.11
+  Enabled: true
+
+Rails/Inquiry: # new in 2.7
+  Enabled: true
+
+Rails/MailerName: # new in 2.7
+  Enabled: true
+
+Rails/MatchRoute: # new in 2.7
+  Enabled: true
+
+Rails/NegateInclude: # new in 2.7
+  Enabled: true
+
+Rails/Pluck: # new in 2.7
+  Enabled: true
+
+Rails/PluckInWhere: # new in 2.7
+  Enabled: true
+
+Rails/RedundantTravelBack: # new in 2.12
+  Enabled: true
+
+Rails/RenderInline: # new in 2.7
+  Enabled: true
+
+Rails/RenderPlainText: # new in 2.7
+  Enabled: true
+
+Rails/ShortI18n: # new in 2.7
+  Enabled: true
+
+Rails/SquishedSQLHeredocs: # new in 2.8
+  Enabled: true
+
+Rails/TimeZoneAssignment: # new in 2.10
+  Enabled: true
+
+Rails/UnusedIgnoredColumns: # new in 2.11
+  Enabled: true
+
+Rails/WhereEquals: # new in 2.9
+  Enabled: true
+
+Rails/WhereExists: # new in 2.7
+  Enabled: true
+
+Rails/WhereNot: # new in 2.8
+  Enabled: true
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+GraphQL/FieldDescription:
+  Enabled: false

data/lib/ibrain/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Ibrain
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 
   def self.ibrain_version
     VERSION
   end
 
   def self.previous_ibrain_minor_version
-    '0.1.0'
+    '0.1.1'
   end
 
   def self.ibrain_gem_version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ibrain-core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tai Nguyen Van
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord-session_store