jsonapi_suite 0.6.6 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b293a213e22bb372bc8c87fb8e341f79ab46baaa
-  data.tar.gz: 4ec742745959edbec72bf3d97c7e018f22bce7e3
+  metadata.gz: 958dcb4d91277ed10aad02acf0f21f4d0ab0789f
+  data.tar.gz: 29c1196b1f6211ec627ddfb88147c2d3ffb5450c
 SHA512:
-  metadata.gz: 7dc14ebd0183c3fe3e18686a634dcb755e4bbed75c39b1ce23eab4785c7f5292c525aee9af385a503eab1388a538980237812fb2279565dd1d0c1ebf41775ac6
-  data.tar.gz: b97d18d38a3a5c7f509bf1bdd401a9e37eaab7b653ef5726f2af6131dbbd6f927e6a543a784427919edfa7d3101b0b6e7523931722d56d41519ccfebba3d95c6
+  metadata.gz: 5a53116286cc3d7f4d32aaa19915a184d8608d4ac2dc06ded62147d7bde0654aef8cf0dff763fa7a2b96f4d6b02216d96b0f215c585d6e66f7b7c0813ce25da8
+  data.tar.gz: a80a9a55314cad23ed685da79c6bea4320c7b5b5b82351c8e459d94a0f819fbe83de6dbca962af4a63265fbd8d8caad04f6b4d49acc4fd7dba94ad64e82e22bb

data/lib/generators/jsonapi_suite/install_generator.rb

@@ -2,9 +2,12 @@ module JsonapiSuite
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
 
-    # spec helpers to test?
-    # gem 'jsonapi-rails', '~> 0.1'
-    # require 'jsonapi_compliable/adapters/active_record'
+    class_option :'omit-comments',
+      type: :boolean,
+      default: false,
+      aliases: ['-c'],
+      desc: 'Generate without documentation comments'
+
     desc "This generator boostraps jsonapi-suite with an initialize and controller mixin"
     def create_initializer
       to = File.join('config/initializers', 'jsonapi.rb')
@@ -13,15 +16,35 @@ module JsonapiSuite
       to = File.join('config/initializers', "strong_resources.rb")
       template('strong_resources.rb.erb', to)
 
-      inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::API\n" do <<-'RUBY'
-  include JsonapiSuite::ControllerMixin
-RUBY
-end
+      inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::API\n" do
+        app_controller_code
+      end
 
-      inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do <<-'RUBY'
-  include JsonapiSuite::ControllerMixin
-RUBY
-end
+      inject_into_file 'app/controllers/application_controller.rb', after: "class ApplicationController < ActionController::Base\n" do
+        app_controller_code
+      end
+    end
+
+    private
+
+    def app_controller_code
+      str = ""
+      unless omit_comments?
+        str << "  # Bootstrap jsonapi_suite with relevant modules\n"
+      end
+      str << "  include JsonapiSuite::ControllerMixin\n\n"
+      unless omit_comments?
+        str << "  # Catch all exceptions and render a JSONAPI-compliable error payload\n"
+        str << "  # For additional documentation, see https://jsonapi-suite.github.io/jsonapi_errorable\n"
+      end
+      str << "  rescue_from Exception do |e|\n"
+      str << "    handle_exception(e)\n"
+      str << "  end\n"
+      str
+    end
+
+    def omit_comments?
+      !!@options['omit-comments']
     end
   end
 end

data/lib/generators/jsonapi_suite/templates/initializer.rb.erb

@@ -1 +1,7 @@
+<%- unless omit_comments? -%>
+# Require any adapters your app needs. Since you are using Rails,
+# we'll start you off with ActiveRecord adapter.
+#
+# For further documentation on adapters, see https://jsonapi-suite.github.io/jsonapi_compliable/JsonapiCompliable/Adapters/Abstract.html
+<%- end -%>
 require 'jsonapi_compliable/adapters/active_record'

data/lib/generators/jsonapi_suite/templates/strong_resources.rb.erb

@@ -1,2 +1,36 @@
+<%- unless omit_comments? -%>
+# Define payloads that can be re-used across endpoints.
+#
+# For instance, you may create Tag objects via the /tags endpoint.
+# You may also sidepost Tag objects via the /posts endpoint.
+# Here is where the Tag payload can be defined. For example:
+#
+# strong_resource :tag do
+#   attribute :name, :string
+#   attribute :active, :boolean
+# end
+#
+# You can now reference this payload across controllers:
+#
+# class TagsController < ApplicationController
+#   strong_resource :tag
+# end
+#
+# class PostsController < ApplicationController
+#   strong_resource :post do
+#     has_many :tags, disassociate: true, destroy: true
+#   end
+# end
+#
+# Custom types can be added here as well:
+# Parameters = ActionController::Parameters
+# strong_param :pet_type, swagger: :string, type: Parameters.enum('Dog', 'Cat')
+#
+# strong_resource :pet do
+#   attribute :type, :pet_type
+# end
+#
+# For additional documentation, see https://jsonapi-suite.github.io/strong_resources
+<%- end -%>
 StrongResources.configure do
 end

data/lib/jsonapi_suite/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSuite
-  VERSION = "0.6.6"
+  VERSION = "0.6.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_suite
 version: !ruby/object:Gem::Version
-  version: 0.6.6
+  version: 0.6.7
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-24 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack