avocado 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9ec8adfbc4563b5bbcddd5d5406963b4a9fe7d5a38765e35a86c9a3d35a09a0
-  data.tar.gz: 6db1dfa3a370661017533e44f2278a09daeece5c145267f05f0bced8943ea910
+  metadata.gz: '08d664f6d291a21013b089cd5828f447e400cb6d8314715b503ab2e3b1f0a174'
+  data.tar.gz: 302cf7c4940831925bf5e26d3dab5363995ae9aa1a3191a2fe5da2744df2a838
 SHA512:
-  metadata.gz: 9761662e0cf44fab571f6f6003aed2c0be2ae56424afbc1cc4b3ccb2f0d856a3e4d3b7a67c8a9e82b7d408977ebb30b4f1f61d9af0fd24db17c3fcb5c944cd89
-  data.tar.gz: a8021001d0f4864a36c981b2c5d18b71bca432f4f4b6fcde4ff6f07c38e7fc39f766dd39670041582cacb9a80526423eafd8156b5d8fc0580189679a1b67d144
+  metadata.gz: 97def5337c7ccaa178b3a33a40b5c7601f89ff4155d6ee0c7e0bff7025e329ae2ab6694b6ceeb5454345cf989a43431f82c2db7b7ac7cfc7abd9cb6ada7ad894
+  data.tar.gz: 7ddeea306e591a49a4705337d3941518a1f8e900f502e2510e397cd860ce6576c7a14cb45226646cefd87c98a77e0de5a116b00dda0d71fa85fe9523ea855a9d

data/.standard.yml

@@ -1,4 +1,5 @@
 parallel: true
+ruby_version: 3.2
 plugins:
   - standard-performance
   - standard-rails

data/Appraisals

@@ -0,0 +1,14 @@
+appraise "rails_7.1" do
+  gem "rails", "~> 7.1.0"
+  gem "sqlite3", "~> 1.7"
+end
+
+appraise "rails_7.2" do
+  gem "rails", "~> 7.2.0"
+  gem "sqlite3", "~> 1.7"
+end
+
+appraise "rails_8.0" do
+  gem "rails", "~> 8.0.0.rc1"
+  gem "sqlite3", "~> 2.0"
+end

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## [Unreleased]
+## [0.8.0] - 2024-10-22
+
+### Changed
+
+- Minimum ruby version is now 3.2
+- Allow Rails versions 7.2 and 8.0
 
 ## [0.7.0] - 2023-08-10
 

data/README.md

@@ -2,6 +2,18 @@
 
 Authentication library for [Rails] 7.1+ applications.
 
+When most people notice the trifecta of `has_secure_password`,
+`authenticate_by`, and `generates_token_for` in [Rails 7.1] they think to
+themselves "Sweet sassy molassey, I bet you could DIY a nice auth solution with
+these dog-gone methods!" and then they slap the roof of their cars and yell
+"Everyone to the coder-cycle! Let's rev this bad boy up and build us an SDK!"
+
+But then again, maybe it's too soon for that, or maybe you're nervous about
+writing authentication code in your own application and would prefer to consume
+such code in scrumpulent gem form instead. The 🥑 gem is an extraction of the
+authentication portion of an experimental next-generation Rails codebase built
+in our research group.
+
 ## Installation
 
 Add to the application's Gemfile by executing:
@@ -10,7 +22,7 @@ Add to the application's Gemfile by executing:
 
 ## Usage
 
-Read the [documentation] for more details or the [wiki] for background.
+Read the [documentation] for more details.
 
 ## Development
 
@@ -31,3 +43,4 @@ The gem is available as open source under the terms of the [MIT License].
 [MIT License]: https://opensource.org/licenses/MIT
 [Rails]: https://github.com/rails/rails
 [wiki]: https://github.com/tcuwp/avocado/wiki
+[Rails 7.1]: https://guides.rubyonrails.org/7_1_release_notes.html

data/app/controllers/avocado/sessions_controller.rb

@@ -30,7 +30,7 @@ module Avocado
     end
 
     def destroy
-      @session.destroy
+      @session.destroy!
       redirect_to sessions_path,
         notice: t(".success")
     end

data/avocado.gemspec

@@ -0,0 +1,35 @@
+require_relative "lib/avocado/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "avocado"
+  spec.version = Avocado::VERSION
+  spec.authors = ["Matt Jankowski"]
+  spec.email = ["info@tcuwp.co"]
+
+  spec.summary = "Simple authentication for Rails applications"
+  spec.homepage = "https://github.com/tcuwp/avocado"
+  spec.license = "MIT"
+  spec.required_ruby_version = Avocado::MINIMUM_RUBY_VERSION
+
+  spec.metadata["bug_tracker_uri"] = "https://github.com/tcuwp/avocado/issues"
+  spec.metadata["changelog_uri"] = "https://github.com/tcuwp/avocado/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://github.com/tcuwp/avocado/blob/main/docs/USAGE.md"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/tcuwp/avocado/tree/main"
+  spec.metadata["wiki_uri"] = "https://github.com/tcuwp/avocado/wiki"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bcrypt", "~> 3.1"
+  spec.add_dependency "rails", Avocado::RAILS_VERSION
+end

data/docs/USAGE.md

@@ -120,17 +120,16 @@ There is an `Avocado::Mailer` which gets called to send emails. The mailer views
 here are very basic, and should be overriden within applications. Place views
 within `app/views/avocado/mailer/` to make this happen.
 
-### Before actions
+### Filters
 
-There is an `authenticate` method installed as default controller behavior using
-`before_action :authenticate`. Any actions which do not need to be authenticated
-should disable this with `skip_before_action :authenticate`, or inherit from a
-controller which performs the skip.
+There are two methods added to the default `before_action` stack:
 
-There is also a `set_current_request_details` method installed as a default
-`before_action` which takes some loggable request meta information (User Agent,
-IP Address) and sets their values in `Current` so that they are accesible to
-code elsewhere in the 🥑 gem.
+- The `authenticate` method defaults controller behavior to require a signed in
+  session. Actions can disable it with `skip_before_action :authenticate`, or
+  inherit from a controller which performs the skip.
+- The `set_current_request_details` method makes some loggable request meta
+  information (User Agent, IP Address) values available in `Current` so that
+  they are accesible to code elsewhere in the 🥑 gem.
 
 ### Helpers
 
@@ -149,8 +148,7 @@ There is not any configuration. To override functionality:
 
 - Redefine a method created in one of the models by the included module
 - Subclass a controller and update the routing to go to the subclass
-- Place views in the app where avocado expects (`app/views/avocado`) them to
-  override the defaults
+- Place views in the app where 🥑 expects them (`app/views/avocado`) to override
 
 There is an `avocado:views` generator which will copy all the views as a
 starting point for further modification.

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "capybara"
+gem "combustion"
+gem "factory_bot_rails"
+gem "rake"
+gem "rspec-rails"
+gem "rubocop-rspec"
+gem "shoulda-matchers"
+gem "simplecov", require: false
+gem "sqlite3", "~> 1.7"
+gem "standard-performance"
+gem "standard-rails"
+gem "standard"
+gem "rails", "~> 7.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.2.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "capybara"
+gem "combustion"
+gem "factory_bot_rails"
+gem "rake"
+gem "rspec-rails"
+gem "rubocop-rspec"
+gem "shoulda-matchers"
+gem "simplecov", require: false
+gem "sqlite3", "~> 1.7"
+gem "standard-performance"
+gem "standard-rails"
+gem "standard"
+gem "rails", "~> 7.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_8.0.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "capybara"
+gem "combustion"
+gem "factory_bot_rails"
+gem "rake"
+gem "rspec-rails"
+gem "rubocop-rspec"
+gem "shoulda-matchers"
+gem "simplecov", require: false
+gem "sqlite3", "~> 2.0"
+gem "standard-performance"
+gem "standard-rails"
+gem "standard"
+gem "rails", "~> 8.0.0.rc1"
+
+gemspec path: "../"

data/lib/avocado/authentication.rb

@@ -40,7 +40,7 @@ module Avocado
     end
 
     def session_from_token
-      ::Session.find_by_token(cookies.signed[:session_token])
+      ::Session.find_by(token: cookies.signed[:session_token])
     end
 
     def set_current_request_details

data/lib/avocado/version.rb

@@ -1,3 +1,5 @@
 module Avocado
-  VERSION = "0.7.0"
+  MINIMUM_RUBY_VERSION = ">= 3.2.0".freeze
+  VERSION = "0.8.0".freeze
+  RAILS_VERSION = ">= 7.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avocado
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matt Jankowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-10 00:00:00.000000000 Z
+date: 2024-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt
@@ -28,16 +28,16 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0.alpha
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 7.1.0.alpha
+        version: '7.1'
 description:
 email:
 - info@tcuwp.co
@@ -48,6 +48,7 @@ files:
 - ".rspec"
 - ".rubocop/rspec.yml"
 - ".standard.yml"
+- Appraisals
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
@@ -85,10 +86,14 @@ files:
 - app/views/avocado/sessions/index.html.erb
 - app/views/avocado/sessions/new.html.erb
 - app/views/avocado/verifications/edit.html.erb
+- avocado.gemspec
 - config.ru
 - config/locales/en.yml
 - config/routes/avocado.rb
 - docs/USAGE.md
+- gemfiles/rails_7.1.gemfile
+- gemfiles/rails_7.2.gemfile
+- gemfiles/rails_8.0.gemfile
 - lib/avocado.rb
 - lib/avocado/authentication.rb
 - lib/avocado/current.rb
@@ -112,9 +117,12 @@ homepage: https://github.com/tcuwp/avocado
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/tcuwp/avocado
-  source_code_uri: https://github.com/tcuwp/avocado
+  bug_tracker_uri: https://github.com/tcuwp/avocado/issues
   changelog_uri: https://github.com/tcuwp/avocado/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/tcuwp/avocado/blob/main/docs/USAGE.md
+  homepage_uri: https://github.com/tcuwp/avocado
+  source_code_uri: https://github.com/tcuwp/avocado/tree/main
+  wiki_uri: https://github.com/tcuwp/avocado/wiki
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -123,15 +131,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Simple authentication for Rails (7.1+) applications
+summary: Simple authentication for Rails applications
 test_files: []