graphql_scaffold 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02fc1815b04df60871dc86446836f1cccdd38f976a02bbc35a3b5c980b906337
-  data.tar.gz: 611f9c0a3be1f4539316db258a8914009b5b2cc69ce48c8ccaa23a4b2f74589f
+  metadata.gz: 03cc09538fcbd889926ea9d1e18dd7c531109417ccac26ad81e050492a246351
+  data.tar.gz: 8269d11ad04fc5717f18d8e90673e49e3bef00c6cfe2a8a9b204806c38f8ce41
 SHA512:
-  metadata.gz: 9b489b2f78359fb73a6a74efffd398bffe99875bf97abca0dfdd34879f5a88484fda2631b44e5697cbae5c1f694f5b9f86bfff5cc1c0f60f8306f025076aa380
-  data.tar.gz: 890cc7f145d45dc8d11156cae6cb7f78d124b4009d075e9e6d1bdad53ece54b2dd12071b53900ebc9d4396e0041d03f02baf2e490ad5e6caf3d095a697537d68
+  metadata.gz: d4afa80b52977dd92a8af6fbbd654308c262047dbd68f27d361d49c90704759d46f2f5e51317a08876bcbc9e567be54401d0b667d9d0b9f2e3b05f29793a200e
+  data.tar.gz: 28552729cf367e789992eba226328d58a5ade7bfe8ba2a215d1943bfb7f9e349ad875b104106ca43bd7b9a2de548c30b43804ce1bc186a21fced04ed3bf707eb

data/lib/generators/graphql_scaffold_common_methods.rb

@@ -7,6 +7,10 @@ module GraphqlScaffoldCommonMethods
     ActiveRecord::Base.connection.tables.include?(plural_name)
   end
 
+  def name
+    "#{namespace.nil? ? '' : 'namespace' + ' '}#{model_name}"
+  end
+
   def singular_name
     name.underscore.singularize
   end
@@ -15,8 +19,8 @@ module GraphqlScaffoldCommonMethods
     singular_name.gsub(' ', '_')
   end
 
-  def singular_name_camelized
-    singular_name_snaked.camelcase
+  def singular_name_camelized(type = :upper)
+    singular_name_snaked.camelcase(type)
   end
 
   def plural_name
@@ -27,8 +31,8 @@ module GraphqlScaffoldCommonMethods
     plural_name.gsub(' ', '_')
   end
 
-  def plural_name_camelized
-    plural_name_snaked.camelcase
+  def plural_name_camelized(type = :upper)
+    plural_name_snaked.camelcase(type)
   end
 
   def list_many
@@ -51,6 +55,26 @@ module GraphqlScaffoldCommonMethods
     "destroy_#{singular_name_snaked}"
   end
 
+  def list_many_camelized(type = :upper)
+    list_many.camelcase(type)
+  end
+
+  def list_one_camelized(type = :upper)
+    list_one.camelcase(type)
+  end
+
+  def create_one_camelized(type = :upper)
+    create_one.camelcase(type)
+  end
+
+  def change_one_camelized(type = :upper)
+    change_one.camelcase(type)
+  end
+
+  def destroy_one_camelized(type = :upper)
+    destroy_one.camelcase(type)
+  end
+
   def model_name
     name.gsub('_', ' ').titlecase.gsub(' ', '')
   end
@@ -117,24 +141,61 @@ module GraphqlScaffoldCommonMethods
       Time.now.strftime("%d/%m/%Y %H:%M:%S")
     when 'references', 'integer', 'float'
       rand(1..10).to_s
+    when 'boolean'
+      ['true', 'false'].sample
     else
-      the_type.to_s.titlecase
+      '"' + the_type.to_s.titlecase + '"'
     end
   end
 
-  def require_gems
-    gems = {
-      'graphql' => '1.9.15',
-      'search_object' => '1.2.0',
-      'search_object_graphql' => '0.1'
-    }
+  def queries
+    options['queries']
+  end
+
+  def mutations
+    options['mutations']
+  end
+
+  def subscriptions
+    options['subscriptions']
+  end
+
+  def tests
+    options['tests']
+  end
 
+  def required_gems
+    # {
+    #   'graphql' => '1.9.15',
+    #   'search_object' => '1.2.3',
+    #   'search_object_graphql' => '0.3'
+    # }
+    [
+      {name: 'graphql', version: '1.9.15'},
+      {name: 'search_object', version: '1.2.3'},
+      {name: 'search_object_graphql', version: '0.3'}
+    ]
+  end
+
+  def check_gem_versions
+    required_gems.map{ |gem_item|
+      if Gem.loaded_specs[gem_item[:name]].nil?
+        "This version of Graphql Scaffold requires the gem #{gem_item[:name]}, version #{gem_item[:version]}. Please add the following line in your Gemfile:\n\n  gem '#{gem_item[:name]}', '#{gem_item[:version]}'\n"
+      elsif (Gem.loaded_specs[gem_item[:name]].version <=> Gem::Version.new(gem_item[:version])) < 0 
+        "The version of the gem #{gem_item[:name]} is not compatible with this version of Graphql Scaffold. We need at least version #{gem_item[:version]}."
+      else
+        nil
+      end
+    }.compact
+  end
+
+  def require_gems
     if !Dir.glob('./*.gemspec').empty?
-      puts "============> Engine : You must add gems to your main app \n #{gems.to_a.map{ |a| "gem '#{a[0]}'#{(a[1].nil? ? '' : ", '#{a[1]}'")} " }.join("\n")}"
+      puts "============> Engine : You must add gems to your main app \n #{required_gems.to_a.map{ |a| "gem '#{a[0]}'#{(a[1].nil? ? '' : ", '#{a[1]}'")} " }.join("\n")}"
     end
 
-    gems.each{ |gem_to_add, version|
+    required_gems.each{ |gem_to_add, version|
       gem(gem_to_add, version)
     }
   end
-end
+end

data/lib/generators/graphql_scaffold_generator.rb

@@ -8,18 +8,37 @@ class GraphqlScaffoldGenerator < Rails::Generators::Base
 
   source_root File.expand_path('../templates', __FILE__)
 
-  argument :name, type: :string, desc: 'Name of model (singular)'
+  argument :model_name, type: :string, desc: 'Name of model (singular)'
   argument :myattributes, type: :array, default: [], banner: 'field:type field:type'
 
-  class_option :namespace, default: nil
-  class_option :donttouchgem, default: nil
-  class_option :mountable_engine, default: true
+  class_option :namespace, default: nil, desc: 'Create a namespace for the Model and GraphQL.'
+  class_option :queries, type: :boolean, default: true, desc: 'Create the GraphQL Queries.'
+  class_option :mutations, type: :boolean, default: true, desc: 'Create the GraphQL Mutations.'
+  class_option :subscriptions, type: :boolean, default: true, desc: 'Create the GraphQL Subscriptions.'
+  class_option :tests, type: :boolean, default: true, desc: 'Create the GraphQL Tests.'
+
+  def check_what_to_do
+    if !queries && !mutations && !subscriptions
+      puts "\n  ** What do you want me to do? Nothing??? No queries, no mutations, no subscriptions...\n\n"
+      exit
+    end
+  end
+
+  def install_gems
+    if check_gem_versions.present?
+      puts '='*80
+      puts '      ATENTION!!! ATENTION!!! ATENTION!!!'
+      puts '='*80
+      puts check_gem_versions.join("\n")
+      puts '='*80
+    end    
+  end
 
   def check_model_existence
     unless model_exists?
       if myattributes.present?
         puts 'Generating model...'
-        generate('model', "#{name} #{myattributes.join(' ')}")
+        generate('model', "#{namespace.nil? ? '' : namespace+'::'}#{name} #{myattributes.join(' ')}")
       else
         puts "The model #{name} wasn't found. You can add attributes and generate the model with Graphql Scaffold."
         exit
@@ -27,51 +46,66 @@ class GraphqlScaffoldGenerator < Rails::Generators::Base
     end
   end
 
-  def install_gems
-    require_gems if options[:donttouchgem].blank?
+  def copy_files
+    copy_file 'app/graphql/types/date_time_type.rb', 'app/graphql/types/date_time_type.rb'
+    # copy_file 'app/graphql/types/base_field.rb', 'app/graphql/types/base_field.rb'
 
-    Bundler.with_clean_env do
-      run 'bundle install'
+    if queries
+      copy_file 'app/graphql/resolvers/base_search_resolver.rb', 'app/graphql/resolvers/base_search_resolver.rb'
+      copy_file 'app/graphql/types/enums/operator.rb', 'app/graphql/types/enums/operator.rb'
+      copy_file 'app/graphql/types/enums/sort_dir.rb', 'app/graphql/types/enums/sort_dir.rb'
     end
 
-    if options[:donttouchgem].blank?
-      generate('graphql:install')
-      run 'bundle install'
+    if mutations
+      copy_file 'app/graphql/mutations/base_mutation.rb', 'app/graphql/mutations/base_mutation.rb'
     end
-  end
 
-  def copy_files
-    copy_file 'app/graphql/resolvers/base_search_resolver.rb', 'app/graphql/resolvers/base_search_resolver.rb'
-    copy_file 'app/graphql/types/enums/operator.rb', 'app/graphql/types/enums/operator.rb'
-    copy_file 'app/graphql/types/enums/sort_dir.rb', 'app/graphql/types/enums/sort_dir.rb'
-    copy_file 'app/graphql/types/date_time_type.rb', 'app/graphql/types/date_time_type.rb'
-    copy_file 'app/graphql/types/base_field.rb', 'app/graphql/types/base_field.rb'
-    copy_file 'app/graphql/mutations/base_mutation.rb', 'app/graphql/mutations/base_mutation.rb'
-    copy_file 'test/integration/graphql_1st_test.rb', 'test/integration/graphql_1st_test.rb'
+    if subscriptions
+    end
+
+    if tests && (queries || mutations || subscriptions)
+      copy_file 'test/integration/graphql_1st_test.rb', 'test/integration/graphql_1st_test.rb'
+    end
   end
 
   def generate_graphql_query
     template 'app/graphql/types/enums/table_field.rb', "app/graphql/types/enums/#{plural_name_snaked}_field.rb"
     template 'app/graphql/types/table_type.rb', "app/graphql/types/#{singular_name_snaked}_type.rb"
-    template 'app/graphql/resolvers/table_search.rb', "app/graphql/resolvers/#{plural_name_snaked}_search.rb"
-    template 'app/graphql/mutations/change_table.rb', "app/graphql/mutations/change_#{singular_name_snaked}.rb"
-    template 'app/graphql/mutations/create_table.rb', "app/graphql/mutations/create_#{singular_name_snaked}.rb"
-    template 'app/graphql/mutations/destroy_table.rb', "app/graphql/mutations/destroy_#{singular_name_snaked}.rb"
-    template 'test/integration/graphql_table_test.rb', "test/integration/graphql_#{singular_name_snaked}_test.rb"
+    
+    if queries
+      template 'app/graphql/resolvers/table_search.rb', "app/graphql/resolvers/#{plural_name_snaked}_search.rb"
+    end
+
+    if mutations
+      template 'app/graphql/mutations/change_table.rb', "app/graphql/mutations/change_#{singular_name_snaked}.rb"
+      template 'app/graphql/mutations/create_table.rb', "app/graphql/mutations/create_#{singular_name_snaked}.rb"
+      template 'app/graphql/mutations/destroy_table.rb', "app/graphql/mutations/destroy_#{singular_name_snaked}.rb"
+    end
+
+    if subscriptions
+    end
+
+    if tests && (queries || mutations || subscriptions)
+      template 'test/integration/graphql_table_test.rb', "test/integration/graphql_#{singular_name_snaked}_test.rb"
+    end
   end
 
   def add_in_query_type
-    inject_into_file(
-      'app/graphql/types/query_type.rb', 
-      "    field :#{list_many}, function: Resolvers::#{plural_name_camelized}Search\n", 
-      after: "class QueryType < Types::BaseObject\n")
-
-    inject_into_file(
-      'app/graphql/types/mutation_type.rb', 
-      "\n    field :#{create_one}, mutation: Mutations::Create#{singular_name_camelized}" +
-      "\n    field :#{change_one}, mutation: Mutations::Change#{singular_name_camelized}" +
-      "\n    field :#{destroy_one}, mutation: Mutations::Destroy#{singular_name_camelized}\n",
-      after: "class MutationType < Types::BaseObject\n")
+    if queries
+      inject_into_file(
+        'app/graphql/types/query_type.rb', 
+        "    field :#{list_many}, function: Resolvers::#{plural_name_camelized}Search\n", 
+        after: "class QueryType < Types::BaseObject\n")
+    end
+
+    if mutations
+      inject_into_file(
+        'app/graphql/types/mutation_type.rb', 
+        "\n    field :#{create_one}, mutation: Mutations::Create#{singular_name_camelized}" +
+        "\n    field :#{change_one}, mutation: Mutations::Change#{singular_name_camelized}" +
+        "\n    field :#{destroy_one}, mutation: Mutations::Destroy#{singular_name_camelized}\n",
+        after: "class MutationType < Types::BaseObject\n")
+    end
   end
 
 end

data/lib/generators/templates/app/graphql/mutations/base_mutation.rb

@@ -1,11 +1,15 @@
-class Mutations::BaseMutation < GraphQL::Schema::RelayClassicMutation
-  # Add your custom classes if you have them:
-  # This is used for generating payload types
-  object_class Types::BaseObject
-  
-  # This is used for return fields on the mutation's payload
-  field_class Types::BaseField
+# frozen_string_literal: true
 
-  # This is used for generating the `input: { ... }` object type
-  input_object_class Types::BaseInputObject
-end
+module Mutations
+  class BaseMutation < GraphQL::Schema::RelayClassicMutation
+    # Add your custom classes if you have them:
+    # This is used for generating payload types
+    object_class Types::BaseObject
+    
+    # This is used for return fields on the mutation's payload
+    field_class Types::BaseField
+
+    # This is used for generating the `input: { ... }` object type
+    input_object_class Types::BaseInputObject
+  end
+end

data/lib/generators/templates/test/integration/graphql_table_test.rb

@@ -8,9 +8,9 @@ class Graphql<%= plural_name_camelized %>Test < ActionDispatch::IntegrationTest
   test "can see a result" do
     gql = <<-GRAPHQL
       {
-        <%= list_many %>(first: 10, sort_by: {field: <%= columns_type_without_primary_key.sample[:name] %>, sortDirection: asc}) {
+        <%= list_many_camelized(:lower) %>(first: 10, sort_by: {field: <%= columns_type_without_primary_key.sample[:name] %>, sortDirection: asc}) {
 <% for attribute in columns_types -%>
-            <%= attribute[:name] %>
+            <%= attribute[:name].camelcase(:lower) %>
 <% end -%>
         }
       }
@@ -20,22 +20,22 @@ class Graphql<%= plural_name_camelized %>Test < ActionDispatch::IntegrationTest
     assert_response :success
     json = JSON.parse(response.body)
     assert_not_empty json['data']
-    assert_not_empty json['data']['<%= list_many %>']
+    assert_not_empty json['data']['<%= list_many_camelized(:lower) %>']
   end
 
   test "can add a record" do
     gql = <<-GRAPHQL
       mutation a {
-        <%= create_one %>(input: {
+        <%= create_one_camelized(:lower) %>(input: {
 <% for attribute in columns_type_without_primary_key -%>
-          <%= attribute[:name] %>: "<%= attribute[:sample] %>",
+          <%= attribute[:name].camelcase(:lower) %>: <%= attribute[:sample] %>,
 <% end -%>
           clientMutationId: "test-1"
         } ) 
         {
-          <%= singular_name_snaked %> {
+          <%= singular_name_camelized(:lower) %> {
 <% for attribute in columns_types -%>
-            <%= attribute[:name] %>
+            <%= attribute[:name].camelcase(:lower) %>
 <% end -%>
           }
           clientMutationId
@@ -46,14 +46,13 @@ class Graphql<%= plural_name_camelized %>Test < ActionDispatch::IntegrationTest
     post '/graphql', params: {query: gql}
     assert_response :success
     json = JSON.parse(response.body)
-    #puts response.body
     
     assert_not_empty json['data']
-    assert_not_empty json['data']['<%= create_one %>']
-    assert_not_empty json['data']['<%= create_one %>']['<%= singular_name_snaked %>']
-    assert_empty json['data']['<%= create_one %>']['errors']
+    assert_not_empty json['data']['<%= create_one_camelized(:lower) %>']
+    assert_not_empty json['data']['<%= create_one_camelized(:lower) %>']['<%= singular_name_camelized(:lower) %>']
+    assert_equal json['data']['<%= create_one_camelized(:lower) %>']['errors'], []
 
-    <%= primary_key %> = json['data']['<%= create_one %>']['<%= singular_name_snaked %>']['<%= primary_key %>']
+    <%= primary_key %> = json['data']['<%= create_one_camelized(:lower) %>']['<%= singular_name_camelized(:lower) %>']['<%= primary_key.camelcase(:lower) %>']
     assert_not_empty <%= singular_name_camelized %>.where(<%= primary_key %>: <%= primary_key %>)
   end
 
@@ -61,16 +60,16 @@ class Graphql<%= plural_name_camelized %>Test < ActionDispatch::IntegrationTest
     <%= primary_key %> = <%= singular_name_camelized %>.last.<%= primary_key %>
     gql = <<-GRAPHQL
       mutation a {
-        <%= change_one %>(input: {
-          <%= primary_key %>: "#{<%= primary_key %>}", 
+        <%= change_one_camelized(:lower) %>(input: {
+          <%= primary_key.camelcase(:lower) %>: "#{<%= primary_key %>}", 
 <% for attribute in columns_type_without_primary_key -%>
-          <%= attribute[:name] %>: "<%= attribute[:sample] %>",
+          <%= attribute[:name].camelcase(:lower) %>: <%= attribute[:sample] %>,
 <% end -%>
           clientMutationId: "test-2"} ) 
         {
-          <%= singular_name_snaked %> {
+          <%= singular_name_camelized(:lower) %> {
 <% for attribute in columns_types -%>
-            <%= attribute[:name] %>
+            <%= attribute[:name].camelcase(:lower) %>
 <% end -%>
           }
           clientMutationId
@@ -83,21 +82,20 @@ class Graphql<%= plural_name_camelized %>Test < ActionDispatch::IntegrationTest
     assert_response :success
     json = JSON.parse(response.body)
     assert_not_empty json['data']
-    assert_not_empty json['data']['<%= change_one %>']
-    assert_empty json['data']['<%= change_one %>']['errors']
-
-    assert_equal <%= singular_name_camelized %>.find(id).url, json['data']['<%= change_one %>']['<%= singular_name_snaked %>']['url']
+    assert_not_empty json['data']['<%= change_one_camelized(:lower) %>']
+    assert_equal json['data']['<%= change_one_camelized(:lower) %>']['errors'], []
+    assert_equal <%= singular_name_camelized %>.find(id).<%= columns_type_without_primary_key.first[:name] %>, json['data']['<%= change_one_camelized(:lower) %>']['<%= singular_name_camelized(:lower) %>']['<%= columns_type_without_primary_key.first[:name].camelcase(:lower) %>']
   end
 
   test "can destroy a record" do
     <%= primary_key %> = <%= singular_name_camelized %>.last.<%= primary_key %>
     gql = <<-GRAPHQL
       mutation a {
-        <%= destroy_one %>(input: {<%= primary_key %>: "#{<%= primary_key %>}", clientMutationId: "test-3"} ) 
+        <%= destroy_one_camelized(:lower) %>(input: {<%= primary_key.camelcase(:lower) %>: "#{<%= primary_key %>}", clientMutationId: "test-3"} ) 
         {
-          <%= singular_name_snaked %> {
+          <%= singular_name_camelized(:lower) %> {
 <% for attribute in columns_types -%>
-            <%= attribute[:name] %>
+            <%= attribute[:name].camelcase(:lower) %>
 <% end -%>
           }
           clientMutationId
@@ -110,8 +108,8 @@ class Graphql<%= plural_name_camelized %>Test < ActionDispatch::IntegrationTest
     assert_response :success
     json = JSON.parse(response.body)
     assert_not_empty json['data']
-    assert_not_empty json['data']['<%= destroy_one %>']
-    assert_empty json['data']['<%= destroy_one %>']['errors']
+    assert_not_empty json['data']['<%= destroy_one_camelized(:lower) %>']
+    assert_equal json['data']['<%= destroy_one_camelized(:lower) %>']['errors'], []
 
     assert_empty <%= singular_name_camelized %>.where(<%= primary_key %>: <%= primary_key %>)
   end

data/lib/graphql_scaffold/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GraphqlScaffold
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/readme.md

@@ -8,17 +8,39 @@ Rails generator for scaffolding models with [GraphQL-Ruby](https://github.com/rm
 
 ## Installation
 
-Install from RubyGems by adding it to your `Gemfile`, then bundling.
+Install from RubyGems by adding it to your `Gemfile`:
 
 ```ruby
 # Gemfile
 gem 'graphql_scaffold'
 ```
+And then execute:
 
 ```
 $ bundle install
 ```
 
+Or install it yourself as:
+
+```
+$ gem install graphql_scaffold
+```
+
+## Dependencies
+
+The scaffolded graphql queries, mutations and subscriptions depend on:
+
+- `SearchObjectGraphql` >= 0.3
+- `SearchObject` >= 1.2.3
+- `Graphql` >= 1.9.5
+
+Besides this you may need to run the following command to begin with Graphql:
+
+```
+$ rails generate graphql:install
+```
+
+
 ## Usage
 
 If you have a model already created:
@@ -34,3 +56,25 @@ $ rails generate graphql_scaffold model_example field1 field2:integer field3
 ```
 
 After this, you may need to run `rails db:migrate`. The format for fields are the same as rails generate model.
+
+### Example
+
+## Todo
+
+- Create subscription scaffold
+- Better tests
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Run the tests (`rake`)
+6. Create new Pull Request
+
+## License
+
+**[MIT License](https://github.com/arthurmolina/graphql_scaffold/blob/master/LICENSE)**
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graphql_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Arthur Molina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2019-11-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -37,7 +37,7 @@ files:
 - lib/graphql_scaffold.rb
 - lib/graphql_scaffold/version.rb
 - readme.md
-homepage: https://github.com/arthurmolina/grapql_scaffold
+homepage: https://github.com/arthurmolina/graphql_scaffold
 licenses:
 - MIT
 metadata: {}