session_rememberable 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d42747d3cd1711cbad85859b2327fa359f0eb0dc06b4f559939c9059914309
-  data.tar.gz: aa2136df09b6bcc560a20143ce9ba130dd9d89c3dd1eba934e33f338e71920d4
+  metadata.gz: 2bab239455bc7b525f614fdbfea7cc51cb7916ee910ab2b61702ae77c12b0dea
+  data.tar.gz: 4fc69684d8405580620990fd2d8b6836ba4113a8259b79639110f3ad20e33cbd
 SHA512:
-  metadata.gz: fdea891b6729f6621bdf3d5595af3ac19e2928750cd4a5aebc8671532b1983e4193c05c085b83b6f6fbf4e471fd827a555629c43f42c997060fcf6cd70f3ccdc
-  data.tar.gz: 8ee6000ca992b1f049b26208f26561d254839a3abfad435e954d80f9956db174d5d509aee6258981cc59759788594870d10d39f6d8277e88d39b3be7463122f1
+  metadata.gz: bde2bd889e9ba131bd3ebbd75a62c5df7ae17c8d454592256159d17ee9e806f39ebd7a5ed082c234044521e24f0689167466be8ff7220db175e1a677345df696
+  data.tar.gz: 5a16083e0ab1ca4b1acf11452a373235c534eb25e052a1ca97ec08ec3c50acc06ba1eb51dea9118b55d7137a59ae15b11b204b3b484bc8421170c1d4e7d76702

data/.gitignore

@@ -6,3 +6,16 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+coverage/*
+Gemfile.lock
+*~
+.bundle
+.rvmrc
+log/*
+measurement/*
+pkg/*
+.DS_Store
+.env
+spec/dummy/tmp/*
+spec/dummy/log/*.log

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--order rand
+--format doc

data/Gemfile

@@ -3,4 +3,4 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in session_rememberable.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem "rake", "~> 12.0"

data/Gemfile.lock

@@ -1,33 +1,186 @@
 PATH
   remote: .
   specs:
-    session_rememberable (0.2.1)
+    session_rememberable (0.3.1)
+      actionpack
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.2)
+      actionview (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.2)
+      activesupport (= 6.1.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activerecord (6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activestorage (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
     activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
+    builder (3.2.4)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
     concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dotenv (2.7.6)
+    erubi (1.10.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    mini_portile2 (2.6.1)
     minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.2)
+      actioncable (= 6.1.3.2)
+      actionmailbox (= 6.1.3.2)
+      actionmailer (= 6.1.3.2)
+      actionpack (= 6.1.3.2)
+      actiontext (= 6.1.3.2)
+      actionview (= 6.1.3.2)
+      activejob (= 6.1.3.2)
+      activemodel (= 6.1.3.2)
+      activerecord (= 6.1.3.2)
+      activestorage (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.3.2)
+      actionpack (= 6.1.3.2)
+      activesupport (= 6.1.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
     rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.3)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codecov
+  dotenv
+  rails
   rake (~> 12.0)
+  rspec
+  rspec-rails
   session_rememberable!
+  simplecov
+  sqlite3
 
 BUNDLED WITH
-   2.1.4
+   2.2.30

data/README.md

@@ -1,8 +1,6 @@
 # SessionRememberable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/session_rememberable`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Quick gem for remembering and forgetting data in a session.
 
 ## Installation
 
@@ -22,15 +20,57 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Incluce SessionRememberable concern in your application controller and define some keys to remember.
 
-## Development
+```ruby
+class ApplicationController < ActionController::Base
+  include SessionRememberable
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  remember :cart
+  remember :customer, class_name: 'User'
+  remember :visits, static_data: true
+end
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+In your controllers
 
-## Contributing
+```ruby
+class CustomersController < ApplicationController
+
+  def create
+    customer = User.new(permitted_params)
+
+    if customer.save
+      remember_customer customer
+      redirect_to customer
+    else
+      render :new
+    end
+  end
+
+  def destroy
+    customer = User.find(params[:id])
+
+    if customer.destroy
+      forget_customer
+      redirect_to root_path
+    else
+      render :edit
+    end
+  end
+
+  private
+
+    def permitted_params
+      params.require(:customer).permit(:name, :email)
+    end
+end
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/session_rememberable.
+In your views (.html.haml)
 
+```ruby
+%h1
+  Welcome
+  = current_customer.name
+```

data/Rakefile

@@ -1,2 +1,11 @@
 require "bundler/gem_tasks"
-task :default => :spec
+require 'rake'
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+task default: :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/lib/session_rememberable/methods.rb

@@ -0,0 +1,31 @@
+module SessionRememberable
+  module ClassMethods
+    def remember(key, class_name: nil, static_data: false)
+      define_method(:"current_#{key}") do
+        instance_var = instance_variable_get("@current_#{key}")
+        return instance_var if instance_var
+
+        if static_data
+          instance_variable_set "@current_#{key}", session["current_#{key}"]
+        else
+          class_name ||= key.to_s.titleize
+          instance_variable_set "@current_#{key}", class_name.constantize.find_by(id: session["current_#{key}"])
+        end
+      end
+      helper_method :"current_#{key}"
+    end
+  end
+
+  def remember(object, name=nil)
+    key = "current_#{name || object.class}".downcase
+    data = object.respond_to?(:id) ? object.id : object.to_s
+    session[key] = data
+    instance_variable_set "@#{key}", object
+  end
+
+  def forget(object, name=nil)
+    key = "current_#{name || object.class}".downcase
+    session[key] = nil
+    instance_variable_set "@#{key}", nil
+  end
+end

data/lib/session_rememberable/store.rb

@@ -0,0 +1,121 @@
+module SessionRememberable
+  # This cookie-based session store is the Rails default. It is
+  # dramatically faster than the alternatives.
+  #
+  # Sessions typically contain at most a user_id and flash message; both fit
+  # within the 4096 bytes cookie size limit. A CookieOverflow exception is raised if
+  # you attempt to store more than 4096 bytes of data.
+  #
+  # The cookie jar used for storage is automatically configured to be the
+  # best possible option given your application's configuration.
+  #
+  # Your cookies will be encrypted using your apps secret_key_base. This
+  # goes a step further than signed cookies in that encrypted cookies cannot
+  # be altered or read by users. This is the default starting in Rails 4.
+  #
+  # Configure your session store in an initializer:
+  #
+  #   Rails.application.config.session_store :cookie_store, key: '_your_app_session'
+  #
+  # In the development and test environments your application's secret key base is
+  # generated by Rails and stored in a temporary file in <tt>tmp/development_secret.txt</tt>.
+  # In all other environments, it is stored encrypted in the
+  # <tt>config/credentials.yml.enc</tt> file.
+  #
+  # If your application was not updated to Rails 5.2 defaults, the secret_key_base
+  # will be found in the old <tt>config/secrets.yml</tt> file.
+  #
+  # Note that changing your secret_key_base will invalidate all existing session.
+  # Additionally, you should take care to make sure you are not relying on the
+  # ability to decode signed cookies generated by your app in external
+  # applications or JavaScript before changing it.
+  #
+  # Because CookieStore extends Rack::Session::Abstract::Persisted, many of the
+  # options described there can be used to customize the session cookie that
+  # is generated. For example:
+  #
+  #   Rails.application.config.session_store :cookie_store, expire_after: 14.days
+  #
+  # would set the session cookie to expire automatically 14 days after creation.
+  # Other useful options include <tt>:key</tt>, <tt>:secure</tt> and
+  # <tt>:httponly</tt>.
+  class Store < ActionDispatch::Session::AbstractSecureStore
+    class SessionId < DelegateClass(Rack::Session::SessionId)
+      attr_reader :cookie_value
+
+      def initialize(session_id, cookie_value = {})
+        super(session_id)
+        @cookie_value = cookie_value
+      end
+    end
+
+    def initialize(app, options = {})
+      @permanent = options.dig(:rememberable_options, :permanent).present?
+      super(app, options.merge!(cookie_only: true))
+    end
+
+    def delete_session(req, _session_id, options)
+      new_sid = generate_sid unless options[:drop]
+      # Reset hash and Assign the new session id
+      req.set_header('action_dispatch.request.unsigned_session_cookie',
+                     new_sid ? { 'session_id' => new_sid.public_id } : {})
+      new_sid
+    end
+
+    def load_session(req)
+      stale_session_check! do
+        data = unpacked_cookie_data(req)
+        data = persistent_session_id!(data)
+        [Rack::Session::SessionId.new(data['session_id']), data]
+      end
+    end
+
+    private
+
+    def extract_session_id(req)
+      stale_session_check! do
+        sid = unpacked_cookie_data(req)['session_id']
+        sid && Rack::Session::SessionId.new(sid)
+      end
+    end
+
+    def unpacked_cookie_data(req)
+      req.fetch_header('action_dispatch.request.unsigned_session_cookie') do |k|
+        v = stale_session_check! do
+          if data = get_cookie(req)
+            data.stringify_keys!
+          end
+          data || {}
+        end
+        req.set_header k, v
+      end
+    end
+
+    def persistent_session_id!(data, sid = nil)
+      data ||= {}
+      data['session_id'] ||= sid || generate_sid.public_id
+      data
+    end
+
+    def write_session(_req, sid, session_data, _options)
+      session_data['session_id'] = sid.public_id
+      SessionId.new(sid, session_data)
+    end
+
+    def set_cookie(request, _session_id, cookie)
+      cookie_jar(request)[@key] = cookie
+    end
+
+    def get_cookie(req)
+      cookie_jar(req)[@key]
+    end
+
+    def cookie_jar(request)
+      if @permanent
+        request.cookie_jar.permanent.signed_or_encrypted
+      else
+        request.cookie_jar.signed_or_encrypted
+      end
+    end
+  end
+end

data/lib/session_rememberable/version.rb

@@ -1,3 +1,3 @@
 module SessionRememberable
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/session_rememberable.rb

@@ -1,31 +1,6 @@
+require_relative 'session_rememberable/methods'
+require_relative 'session_rememberable/store'
+
 module SessionRememberable
   extend ActiveSupport::Concern
-
-  module ClassMethods
-
-    def remember(key, class_name: nil, static_data: false)
-      define_method(:"current_#{key}") do
-        instance_var = instance_variable_get("@current_#{key}")
-        return instance_var if instance_var
-
-        if static_data
-          instance_variable_set "@current_#{key}", session["session_#{key}"]
-        else
-          class_name = class_name || key.to_s.titleize
-          instance_variable_set "@current_#{key}", class_name.constantize.find_by(id: session["session_#{key}"])
-        end
-      end
-      helper_method :"current_#{key}"
-
-      define_method(:"remember_#{key}") do |param|
-        data = param.respond_to?(:id) && !static_data ? param.id : param
-        session["session_#{key}"] = data
-      end
-
-      define_method(:"forget_#{key}") do
-        session["session_#{key}"] = nil
-        instance_variable_set "@current_#{key}", nil
-      end
-    end
-  end
 end

data/session_rememberable.gemspec

@@ -22,5 +22,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency 'actionpack'
+
   spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'codecov'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'sqlite3'
+  # rubocop dependencies...
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: session_rememberable
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - wynk182
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-16 00:00:00.000000000 Z
+date: 2021-12-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -24,7 +38,119 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: dotenv
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rspec-rails
+  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: sqlite3
+  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: simplecov
+  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'
+description: 
 email:
 - wynk182@gmail.com
 executables: []
@@ -32,6 +158,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -39,6 +166,8 @@ files:
 - bin/console
 - bin/setup
 - lib/session_rememberable.rb
+- lib/session_rememberable/methods.rb
+- lib/session_rememberable/store.rb
 - lib/session_rememberable/version.rb
 - session_rememberable.gemspec
 homepage: https://www.wynk182.com
@@ -46,7 +175,7 @@ licenses: []
 metadata:
   source_code_uri: https://github.com/wynk182/session_rememberable
   homepage_uri: https://www.wynk182.com
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -61,8 +190,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Quick concern for session variables
 test_files: []