snfoil-rails 1.0.0 → 1.0.2

data/lib/generators/snfoil/context/templates/context.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Context
+  include SnFoil::Context
+
+  model <%= class_name %>
+  searcher <%= class_name.pluralize %>Searcher
+  policy <%= class_name %>Policy
+end

data/lib/generators/snfoil/controller/USAGE

@@ -0,0 +1,15 @@
+Description:
+    Creates a SnFoil::Controller Scaffold
+
+Arguments:
+    model: *required* The name of the model
+
+Options:
+    path: The path the files will be created at. default: app/controllers
+    type: The type of controller to create (base, api). default: base
+
+Example:
+    rails generate snfoil:controller User
+
+    This will create:
+        app/controllers/users_controller.rb

data/lib/generators/snfoil/controller/controller_generator.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  class ControllerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :type, desc: 'Generate Base or API', type: :string, default: 'base'
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/controllers'
+
+    def add_app_file
+      template(template_name, "#{options[:path]}/#{file_name}_controller.rb")
+    end
+
+    private
+
+    def file_name
+      @file_name ||= if modules.length.zero?
+                       name
+                     else
+                       "#{modules.join('/')}/#{name}"
+                     end
+    end
+
+    def template_name
+      @template_name ||= if options[:type] == 'api'
+                           'api_controller.erb'
+                         else
+                           'controller.erb'
+                         end
+    end
+
+    def name
+      @name ||= model.split('/').last.underscore.pluralize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/snfoil/controller/templates/api_controller.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Controller < SnFoil::Controller::API
+  context <%= class_name.singularize %>Context
+  serializer <%= class_name.singularize %>JsonapiSerializer
+  deserializer <%= class_name.singularize %>JsonapiDeserializer
+
+  # SnFoil::Controller requires current_entity or current_user defined to properly scope
+  # all queries, otherwise data leaks could occur
+  #
+  #  def current_entity
+  #  # logic to find authenticated user
+  #  end
+end

data/lib/generators/snfoil/controller/templates/controller.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Controller < SnFoil::Controller::Base
+  context <%= name.singularize.camelcase %>Context
+  serializer <%= name.singularize.camelcase %>JsonapiSerializer
+  deserializer <%= name.singularize.camelcase %>JsonapiDeserializer
+
+  # SnFoil::Controller requires current_entity or current_user defined to properly scope
+  # all queries, otherwise data leaks could occur
+  #
+  #  def current_entity
+  #  # logic to find authenticated user
+  #  end
+end

data/lib/generators/snfoil/jsonapi_deserializer/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Creates a SnFoil::JsonapiDeSerializer Scaffold
+
+Arguments:
+    model: *required* The name of the model
+
+Options:
+    path: The path the files will be created at. default: app/jsonapi_deserializers
+
+Example:
+    rails generate snfoil:jsonapi_deserializer User
+
+    This will create:
+        app/jsonapi_deserializers/user_jsonapi_deserializer.rb

data/lib/generators/snfoil/jsonapi_deserializer/jsonapi_deserializer_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  class JsonapiDeserializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/jsonapi_deserializers'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    "#{modules.join('/')}/#{name}"
+                  end
+
+      template('jsonapi_deserializer.erb', "#{options[:path]}/#{file_name}_jsonapi_deserializer.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/snfoil/jsonapi_deserializer/templates/jsonapi_deserializer.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>JsonapiDeserializer
+  include SnFoil::JsonapiDeserializer
+  
+  # Add attributes of the model you want to serializer with the following syntax
+  attributes :id
+
+  # Add relationships with the following syntax
+  # belongs_to :store, serializer: Jsonapi::StoreJsonapiSerializer
+  # has_many :locations, serializer: Jsonapi::LocationJsonapiSerializer
+end

data/lib/generators/snfoil/jsonapi_serializer/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Creates a SnFoil::JsonapiSerializer Scaffold
+
+Arguments:
+    model: *required* The name of the model
+
+Options:
+    path: The path the files will be created at. default: app/jsonapi_serializers
+
+Example:
+    rails generate snfoil:jsonapi_serializer User
+
+    This will create:
+        app/jsonapi_serializers/user_jsonapi_serializer.rb

data/lib/generators/snfoil/jsonapi_serializer/jsonapi_serializer_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  class JsonapiSerializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/jsonapi_serializers'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    "#{modules.join('/')}/#{name}"
+                  end
+
+      template('jsonapi_serializer.erb', "#{options[:path]}/#{file_name}_jsonapi_serializer.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/snfoil/jsonapi_serializer/templates/jsonapi_serializer.erb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>JsonapiSerializer
+  include SnFoil::JsonapiSerializer
+
+  set_id :id
+  set_type :<%= name.pluralize.dasherize %>
+
+  # SnFoil::JsonapiSerializer is just a wrapper for jsonapi-serializer (https://github.com/jsonapi-serializer/jsonapi-serializer)
+  # with some defaults added in
+
+  # Add attributes of the model you want to serializer with the following syntax
+  # attributes :name
+  #            :description
+  #            :logo_url
+
+  # Add relationships with the following syntax
+  # belongs_to :store, serializer: Jsonapi::StoreJsonapiSerializer
+  # has_many :locations, serializer: Jsonapi::LocationJsonapiSerializer
+end

data/lib/generators/snfoil/policy/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Creates a SnFoil::Policy Scaffold
+
+Arguments:
+    model: *required* The name of the model
+
+Options:
+    path: The path the files will be created at. default: app/policies
+
+Example:
+    rails generate snfoil:policy User
+
+    This will create:
+        app/policies/user_policy.rb

data/lib/generators/snfoil/policy/policy_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  class PolicyGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/policies'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    "#{modules.join('/')}/#{name}"
+                  end
+
+      template('policy.erb', "#{options[:path]}/#{file_name}_policy.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/snfoil/policy/templates/policy.erb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Policy
+  include SnFoil::Policy
+  # A SnFoil::Policy is just a Pundit policy (https://github.com/varvet/pundit)
+  # with some defaults
+  # Available methods: show?, create?, update?, destroy?, index?, associate?
+
+  #  def show?
+  #    true
+  #  end
+
+  # class Scope
+  #   # available read-only attributes
+  #   # - scope: the default scope passed into the policy (ex: an ActiveRecord::Relation)
+  #   # - entity: the object that the scope is build around (ex: a User)
+
+  #   def resolve
+  #     # the new default scope
+  #   end
+  # end
+end

data/lib/generators/snfoil/searcher/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Creates a SnFoil::Searcher Scaffold
+
+Arguments:
+    model: *required* The name of the model
+
+Options:
+    path: The path the files will be created at. default: app/searcher
+
+Example:
+    rails generate snfoil:searcher User
+
+    This will create:
+        app/searchers/users_searcher.rb

data/lib/generators/snfoil/searcher/searcher_generator.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module SnFoil
+  class SearcherGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/searchers'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    "#{modules.join('/')}/#{name}"
+                  end
+
+      template('searcher.erb', "#{options[:path]}/#{file_name}_searcher.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.pluralize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/snfoil/searcher/templates/searcher.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Searcher
+  include SnFoil::Searcher
+  
+  model <%= class_name.singularize %>
+end

data/lib/snfoil/rails/api/create.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../concerns/inject_deserialized'
+require_relative '../concerns/inject_request_params'
+require_relative '../concerns/inject_request_id'
+require 'snfoil/controller'
+
+module SnFoil
+  module Rails
+    module API
+      module Create
+        extend ActiveSupport::Concern
+
+        included do
+          include SnFoil::Controller
+
+          include InjectRequestId
+          include InjectDeserialized
+          include InjectInclude
+          include InjectRequestParams
+
+          endpoint :create, with: :render_create
+
+          setup_create with: :inject_request_id
+          setup_create with: :inject_request_params
+          setup_create with: :inject_deserialized
+          setup_create with: :inject_include
+
+          process_create with: :run_context
+
+          def render_create(**options)
+            if options[:object].errors.empty?
+              render json: serialize(options[:object], **options), status: :created
+            else
+              render json: options[:object].errors, status: :unprocessable_entity
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/rails/api/destroy.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../concerns/inject_id'
+require_relative '../concerns/inject_request_params'
+require_relative '../concerns/inject_request_id'
+require 'snfoil/controller'
+
+module SnFoil
+  module Rails
+    module API
+      module Destroy
+        extend ActiveSupport::Concern
+
+        included do
+          include SnFoil::Controller
+
+          include InjectRequestId
+          include InjectId
+          include InjectRequestParams
+
+          endpoint :destroy, with: :render_destroy
+
+          setup_destroy with: :inject_request_id
+          setup_destroy with: :inject_request_params
+          setup_destroy with: :inject_id
+
+          process_destroy with: :run_context
+
+          def render_destroy(**options)
+            if options[:object].errors.empty?
+              render json: {}, status: :no_content
+            else
+              render json: options[:object].errors, status: :unprocessable_entity
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/snfoil/rails/api/index.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2021 Matthew Howes
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#   http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../concerns/inject_include'
+require_relative '../concerns/inject_request_params'
+require_relative '../concerns/inject_request_id'
+require_relative '../concerns/process_pagination'
+require 'snfoil/controller'
+
+module SnFoil
+  module Rails
+    module API
+      module Index
+        extend ActiveSupport::Concern
+
+        included do
+          include SnFoil::Controller
+
+          include InjectRequestId
+          include InjectInclude
+          include InjectRequestParams
+          include ProcessPagination
+
+          endpoint :index, with: :render_index
+
+          setup_index with: :inject_request_id
+          setup_index with: :inject_request_params
+          setup_index with: :inject_include
+
+          process_index with: :run_context
+          process_index with: :process_pagination
+
+          def render_index(**options)
+            render json: serialize(options[:object], **options), status: :ok
+          end
+        end
+      end
+    end
+  end
+end