snfoil-rails 0.8.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8317d5da3fd8d19a7ddc0c090c3065578d39ace6a431da7d3920e7dde76c92b0
-  data.tar.gz: ac1beda041a2d44d7e5066b3c9f39d9b8a1f28d1a8fe0f0c5cbdaf93047054d0
+  metadata.gz: 5306949c4295cfde76959a28c9ef66300d157690a0d436097483ad0ca2c7e242
+  data.tar.gz: 19157fbb48e70a81d55e4a2dbd7e043d9e51af5a2185e1e5993968c0995e50bb
 SHA512:
-  metadata.gz: 70da8fe5e43597103002d545e6e48362ea855ffc78bf3edd1c6e4c4fcf2de745b28bed82bd1526c8801a23395b2d9a85436c69daa01f0243669c7786f73e9a68
-  data.tar.gz: 0c0e11fed83253c68c9c393e96b9328cc6f4081b4aa832d4963cf4cf0402f795624dc38481dfbc4f2887f8fbf6762b1f15afb09cb82140307e1c4ca28dbc5090
+  metadata.gz: c19cd5a2a490a5a94d163d3575ac9ca2a45941712fb752363d9a15240d090b783fcda45364df8d4522476ec6461085f7bb73389965a5b7e1ff2c3ee4ee9be223
+  data.tar.gz: 6c402d3ca67b0c2e99c9bd5e3ff656822dcc0f79cf53b7b44dc27fb51953caf2626ec90f32fb4656fc64a1db6f6a5812ca48482f3ae9efa605ad867eedd4efda

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Howes
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2022-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -27,47 +27,145 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.6
 - !ruby/object:Gem::Dependency
-  name: jsonapi-serializer
+  name: snfoil
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: snfoil
+  name: snfoil-controller
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 1.0.1
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: blueprinter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -82,20 +180,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.6
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.2.6
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -130,56 +242,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.29'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '1.29'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -194,7 +306,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Additional functionality gem for using SnFoil with Rails
 email:
 - howeszy@gmail.com
 - dmurph24@gmail.com
@@ -202,46 +314,15 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
-- CODE_OF_CONDUCT.md
-- MIT-LICENSE
-- README.md
-- Rakefile
-- lib/generators/sn_foil/all/all_generator.rb
-- lib/generators/sn_foil/context/context_generator.rb
-- lib/generators/sn_foil/context/templates/context.erb
-- lib/generators/sn_foil/controller/controller_generator.rb
-- lib/generators/sn_foil/controller/templates/api_controller.erb
-- lib/generators/sn_foil/controller/templates/controller.erb
-- lib/generators/sn_foil/jsonapi_deserializer/jsonapi_deserializer_generator.rb
-- lib/generators/sn_foil/jsonapi_deserializer/templates/jsonapi_deserializer.erb
-- lib/generators/sn_foil/jsonapi_serializer/jsonapi_serializer_generator.rb
-- lib/generators/sn_foil/jsonapi_serializer/templates/jsonapi_serializer.erb
-- lib/generators/sn_foil/policy/policy_generator.rb
-- lib/generators/sn_foil/policy/templates/policy.erb
-- lib/generators/sn_foil/searcher/searcher_generator.rb
-- lib/generators/sn_foil/searcher/templates/searcher.erb
-- lib/sn_foil/configuration/lazy_jsonapi_serializer.rb
-- lib/sn_foil/controller/api.rb
-- lib/sn_foil/controller/base.rb
-- lib/sn_foil/controller/concerns/change_controller_concern.rb
-- lib/sn_foil/controller/concerns/create_controller_concern.rb
-- lib/sn_foil/controller/concerns/destroy_controller_concern.rb
-- lib/sn_foil/controller/concerns/index_controller_concern.rb
-- lib/sn_foil/controller/concerns/setup_controller_concern.rb
-- lib/sn_foil/controller/concerns/show_controller_concern.rb
-- lib/sn_foil/controller/concerns/update_controller_concern.rb
-- lib/sn_foil/jsonapi_deserializer.rb
-- lib/sn_foil/jsonapi_serializer.rb
-- lib/sn_foil/rails.rb
-- lib/sn_foil/rails/engine.rb
-- lib/sn_foil/rails/version.rb
-- lib/sn_foil/searcher.rb
-- lib/snfoil-rails.rb
+files: []
 homepage: https://github.com/limited-effort/snfoil-rails
 licenses:
-- MIT
-metadata: {}
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/limited-effort/snfoil-rails
+  source_code_uri: https://github.com/limited-effort/snfoil-rails
+  changelog_uri: https://github.com/limited-effort/snfoil-rails/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -250,7 +331,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -260,5 +341,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: Additional functionality gem for using SnFoil with Rails
+summary: Snfoil Rails Helpers
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at howeszy@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2019 Matthew Howes
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,28 +0,0 @@
-# Sn::Foil::Rails
-Short description and motivation.
-
-## Usage
-How to use my plugin.
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'snfoil-rails'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install snfoil-rails
-```
-
-## Contributing
-Contribution directions go here.
-
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'SnFoil::Rails'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test

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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module SnFoil
-  class AllGenerator < 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(:skip_model, desc: 'Skip Model Creation', type: :boolean, default: false)
-
-    def add_model
-      rails_command "generate model #{call_args.join(' ')}", call_options
-    end
-
-    def add_policy
-      rails_command "generate sn_foil:policy #{call_args.join(' ')}", call_options
-    end
-
-    def add_searcher
-      rails_command "generate sn_foil:searcher #{call_args.join(' ')}", call_options
-    end
-
-    def add_context
-      rails_command "generate sn_foil:context #{call_args.join(' ')}", call_options
-    end
-
-    def add_jsonapi_serializer
-      rails_command "generate sn_foil:jsonapi_serializer #{call_args.join(' ')}", call_options
-    end
-
-    def add_jsonapi_deserializer
-      rails_command "generate sn_foil:jsonapi_deserializer #{call_args.join(' ')}", call_options
-    end
-
-    def add_controller
-      rails_command "generate sn_foil:controller #{call_args.join(' ')}", call_options
-    end
-
-    private
-
-    def call_args
-      @call_args ||= [model].concat(args)
-    end
-
-    def call_options
-      @call_options ||= options.deep_symbolize_keys
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module SnFoil
-  class ContextGenerator < 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/contexts'
-
-    def add_app_file
-      file_name = if modules.length.zero?
-                    name
-                  else
-                    "#{modules.join('/')}/#{name}"
-                  end
-
-      template('context.erb', "#{options[:path]}/#{file_name}_context.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/sn_foil/context/templates/context.erb

@@ -1,9 +0,0 @@
-# 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/sn_foil/controller/controller_generator.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-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/sn_foil/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