snfoil-rails 1.1.2 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6700afcdb719797fdaeabbf26cd6756eeaec499241e279c3c02782a9d6ff7acf
-  data.tar.gz: 35c678efb56db5936547a847e5e098a2f0fde3dc497554f9d205839c7d27469d
+  metadata.gz: 4a0c8626c47b7239591baba976eecbad1f19b3945c20d494f7c696c51c864c1b
+  data.tar.gz: 71d34c2b2a60a1cf30f7bd7e03bb9863a14a35de2172866f9f9b9b3ec197b885
 SHA512:
-  metadata.gz: e33b44fccb163393262df4955445afae964e3efd013f147a93eb519479a4b1dd22a33839e31c8029b20614bfe546ae1007285f95f95b25566f1d88e06ecb1379
-  data.tar.gz: a2ecf94f51600bee7b5fac77176a27dea9bd39cf04a6fbe674a1aae78829ed6e355023a95318d05312e4001761929e1a407f7505270b80f0225536b8d5a1ba17
+  metadata.gz: cdd56a1d2f025ebbb8badc3ebbbf411359d3bd7a5aa35e95adedfcacb147bc5754fb82a09d8a07135d9e33878df947bc11d4b6491ca2eda3c87124333a5441b7
+  data.tar.gz: 350c57c9e5617ef2336a2dd1e85e25dd3526937bec46d546116849db1ed2b84e062d02d02473c0e1d781fb7963c1f7760651d47b0d55f0aaf6314d37ad72fb77

data/lib/generators/snfoil/all/all_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/generators/snfoil/context/context_generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,9 +1,23 @@
 # frozen_string_literal: true
 
 class <%= class_modules %><%= class_name %>Context
-  include SnFoil::Context
+  include SnFoil::CRUD::Context
 
   model <%= class_name %>
   searcher <%= class_name.pluralize %>Searcher
   policy <%= class_name %>Policy
+
+  # #create #update #destroy #show #index are already defined by SnFoil::CRUD::Context
+  # you can override their behavior by editing their hooks.  Example:
+  # after_create do |options|
+  #   # do something after create
+  #   options # return options in hooks
+  # end
+  #
+  # or you can define your own workflows
+  # action :expire do |options|
+  #   # expire the object
+  #
+  #   options
+  # end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,9 +1,9 @@
 # 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
+class <%= class_modules %><%= class_name %>Controller < SnFoil::Rails::APIController
+  context <%= class_name.singularize %>Context
+  serializer <%= class_name.singularize %>Serializer
+  deserializer <%= class_name.singularize %>Deserializer
 
   # SnFoil::Controller requires current_entity or current_user defined to properly scope
   # all queries, otherwise data leaks could occur

data/lib/generators/snfoil/{jsonapi_deserializer/jsonapi_deserializer_generator.rb → deserializer/deserializer_generator.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,17 +15,18 @@
 # limitations under the License.
 
 module SnFoil
-  class JsonapiDeserializerGenerator < ::Rails::Generators::Base
+  class DeserializerGenerator < ::Rails::Generators::Base
     def self.base_name
       'snfoil'
     end
 
-    namespace 'snfoil:jsonapi_deserializer'
+    namespace 'snfoil:deserializer'
     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'
+    class_option :type, desc: 'Generate JSON or JSONAPI deserializer', type: :string, default: 'json'
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/deserializers'
 
     def add_app_file
       file_name = if modules.empty?
@@ -34,7 +35,7 @@ module SnFoil
                     "#{modules.join('/')}/#{name}"
                   end
 
-      template('jsonapi_deserializer.erb', "#{options[:path]}/#{file_name}_jsonapi_deserializer.rb")
+      template('deserializer.erb', "#{options[:path]}/#{file_name}_deserializer.rb")
     end
 
     private
@@ -43,6 +44,16 @@ module SnFoil
       @name ||= model.split('/').last.underscore.singularize
     end
 
+    def template_name
+      @template_name ||= if options[:type] == 'json'
+                           'json.erb'
+                         elsif options[:type] == 'jsonapi'
+                           'jsonapi.erb'
+                         else
+                           raise ArgumentError, "Unknown deserializer type: #{options[:type]}"
+                         end
+    end
+
     def class_name
       @class_name ||= name.camelize
     end

data/lib/generators/snfoil/deserializer/templates/json.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Deserializer
+  include SnFoil::Deserializer::JSON
+
+  # Underline the keys in the payload
+  key_transform :underscore
+  
+  # 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: StoreSerializer
+  # has_many :locations, serializer: LocationSerializer
+end

data/lib/generators/snfoil/deserializer/templates/jsonapi.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Deserializer
+  include SnFoil::Deserializer::JSONAPI
+
+  # Underline the keys in the payload
+  key_transform :underscore
+  
+  # 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: StoreSerializer
+  # has_many :locations, serializer: LocationSerializer
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -2,21 +2,18 @@
 
 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
+  # Example policy for <%= class_name %> entity.
+  # permission :create?, with: :active_and_owner?
 
-  # 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)
+  # permission :update?, with: :active_and_owner?
 
-  #   def resolve
-  #     # the new default scope
-  #   end
+  # permission :destroy? do
+  #   entity.archived_at.nil? &&
+  #     (record.user_id == entity.id || entity.is_admin?)
+  # end
+
+  # def active_and_owner?
+  #   entity.archived_at.nil? && record.user_id == entity.id
   # end
 end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 class <%= class_modules %><%= class_name %>Searcher
-  include SnFoil::Searcher
+  include SnFoil::Rails::Searcher
   
   model <%= class_name.singularize %>
-end
+
+  # filter do |scope, params|
+  #   scope.where(archived_at: nil)
+  # end
+end

data/lib/generators/snfoil/{jsonapi_serializer/jsonapi_serializer_generator.rb → serializer/serializer_generator.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,17 +15,17 @@
 # limitations under the License.
 
 module SnFoil
-  class JsonapiSerializerGenerator < ::Rails::Generators::Base
+  class SerializerGenerator < ::Rails::Generators::Base
     def self.base_name
       'snfoil'
     end
 
-    namespace 'snfoil:jsonapi_serializer'
+    namespace 'snfoil:serializer'
     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'
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/serializers'
 
     def add_app_file
       file_name = if modules.empty?
@@ -34,7 +34,7 @@ module SnFoil
                     "#{modules.join('/')}/#{name}"
                   end
 
-      template('jsonapi_serializer.erb', "#{options[:path]}/#{file_name}_jsonapi_serializer.rb")
+      template('serializer.erb', "#{options[:path]}/#{file_name}_serializer.rb")
     end
 
     private

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Serializer
+  # SnFoil no longer ships with a serializer, it is recommended to use your favorite and implement
+  # the serialize method in your controller.
+  # 
+  # example: Blueprinter
+  # class <%= class_modules %><%= class_name %>Serializer < Blueprinter::Base
+  #   identifier :id
+  #   fields :name, :description, :created_at, :updated_at
+  # end
+  #
+  # example: Alba
+  # class <%= class_modules %><%= class_name %>Serializer
+  #   include Alba::Resource
+  #   attributes :id, :name, :description, :created_at, :updated_at
+  # end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/api_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/concerns/inject_deserialized.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/concerns/inject_id.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/concerns/inject_include.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/concerns/inject_request_id.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/concerns/inject_request_params.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/concerns/process_pagination.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/searcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/snfoil/rails/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2025 Matthew Howes
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -16,6 +16,6 @@
 
 module SnFoil
   module Rails
-    VERSION = '1.1.2'
+    VERSION = '1.1.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.4
 platform: ruby
 authors:
 - Matthew Howes
@@ -87,20 +87,20 @@ files:
 - lib/generators/snfoil/context/templates/context.erb
 - lib/generators/snfoil/controller/USAGE
 - lib/generators/snfoil/controller/controller_generator.rb
-- lib/generators/snfoil/controller/templates/api_controller.erb
 - lib/generators/snfoil/controller/templates/controller.erb
-- lib/generators/snfoil/jsonapi_deserializer/USAGE
-- lib/generators/snfoil/jsonapi_deserializer/jsonapi_deserializer_generator.rb
-- lib/generators/snfoil/jsonapi_deserializer/templates/jsonapi_deserializer.erb
-- lib/generators/snfoil/jsonapi_serializer/USAGE
-- lib/generators/snfoil/jsonapi_serializer/jsonapi_serializer_generator.rb
-- lib/generators/snfoil/jsonapi_serializer/templates/jsonapi_serializer.erb
+- lib/generators/snfoil/deserializer/USAGE
+- lib/generators/snfoil/deserializer/deserializer_generator.rb
+- lib/generators/snfoil/deserializer/templates/json.erb
+- lib/generators/snfoil/deserializer/templates/jsonapi.erb
 - lib/generators/snfoil/policy/USAGE
 - lib/generators/snfoil/policy/policy_generator.rb
 - lib/generators/snfoil/policy/templates/policy.erb
 - lib/generators/snfoil/searcher/USAGE
 - lib/generators/snfoil/searcher/searcher_generator.rb
 - lib/generators/snfoil/searcher/templates/searcher.erb
+- lib/generators/snfoil/serializer/USAGE
+- lib/generators/snfoil/serializer/serializer_generator.rb
+- lib/generators/snfoil/serializer/templates/serializer.erb
 - lib/snfoil/rails.rb
 - lib/snfoil/rails/api/create.rb
 - lib/snfoil/rails/api/destroy.rb

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

@@ -1,14 +0,0 @@
-# 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/jsonapi_deserializer/templates/jsonapi_deserializer.erb

@@ -1,12 +0,0 @@
-# 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/templates/jsonapi_serializer.erb

@@ -1,20 +0,0 @@
-# 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