sentient_user_request_store 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 072578849d62f4c14e46bbba9298078673e22a56
+  data.tar.gz: d214388ec0381993cb9e2aec98d2cee61ca7217e
+SHA512:
+  metadata.gz: 679bc68b2d1b05f2fdf4dd6a33644d35c84d9d562d659bc8e4f031065b0f5070ba1752805aa23da1c2a8f7705d406b669ffad3781c11f6eedc4f7a3d8103a7e0
+  data.tar.gz: bed93e79a4c018610a3f890f008434d016ba9a93c5c5690c8673ee113d0b654b90831dca83ea82cc1bb8d338fb7bf7a238a848a185f322f41159d2ace613ca44

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.bundle
+vendor

data/.rbenv-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.1.5
+  - 2.2.0
+  - 2.3.0
+  - jruby
+before_install:
+ - gem update bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 [dbock at javaguy dot org]. 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/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    sentient_user_request_store (1.0.0)
+      railties (>= 3.1)
+      request_store (= 1.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.0.13)
+      activesupport (= 4.0.13)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activesupport (4.0.13)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    ansi (1.5.0)
+    builder (3.1.4)
+    concurrent-ruby (1.0.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (1.8.3)
+    minitest (4.7.5)
+    minitest_should (0.3.1)
+    multi_json (1.13.1)
+    rack (1.5.5)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    railties (4.0.13)
+      actionpack (= 4.0.13)
+      activesupport (= 4.0.13)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (11.1.2)
+    rdoc (4.2.2)
+      json (~> 1.4)
+    request_store (1.4.1)
+      rack (>= 1.4)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    turn (0.9.7)
+      ansi
+      minitest (~> 4)
+    tzinfo (0.3.54)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (= 4.7.5)
+  minitest_should
+  rake
+  rdoc
+  sentient_user_request_store!
+  simplecov
+  turn
+
+BUNDLED WITH
+   1.13.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 bokmann
+
+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.rdoc

@@ -0,0 +1,46 @@
+= sentient_user
+
+How often have you needed to access the current user in your models?  This happens often if you are attempting intelligent logging or if you want the models to control some aspect of their access, etc.  This is easy hackery that you can find in many blog entries, but I wanted a nice package for it, for several reasons:
+
+* There are several different ways this can be accomplished, but only the variation that uses Thread.local is safe for use in thread-safe rails.
+* Even using Thread.local is considered slightly hacky (but better than monkeypatching ActiveRecord::Base)
+* Should fashions change in this area in Rails' future, I want one place to change it, and to keep my methods working.
+* This concept generally breaks in the console, where there is no controller to set the user.  This gem adds a make_current method on the user instance, so you can choose to find a user and execute the current_user method.  That could be really useful in rake tasks, for instance.
+
+== Fork Notes
+
+This fork of [sentient_user](https://github.com/bokmann/sentient_user) uses [request_store](https://github.com/steveklabnik/request_store) instead of `Thread.current`.
+
+== Usage
+* include SentientUser in your user model
+* include SentientController in your application controller
+
+== Assumptions and limitations
+* Your user model is called 'User'.
+* You have a current_user method available to your controllers
+* You will write your own tests to cover this code. The gem has tests, but its up to you to make sure you use this ability wisely.
+
+If those assumptions don't work for you, feel free to unpack and hack.  It's simple enough code to change.  I purposefully didn't want to complicate it with an initializer, several config options, etc. as all that would blur this delightfully simple piece of code.
+
+
+== Recent Changes
+This gem has been remarkably stable for many years and many iterations of rails.  The recent deprecation of before_filter in favor of before_action is making me update it.
+
+* 1.0.0 - use Request Store
+* 0.4.0 - for use on Rails 5 and beyond.
+* 0.3.3 - for versions prior to rails 5.
+
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it
+  unintentionally in a future version.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but please bump the version in a commit by itself which I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009-2016 bokmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+
+require File.expand_path('../lib/sentient_user/version.rb', __FILE__)

data/lib/sentient_user.rb

@@ -0,0 +1,49 @@
+require 'request_store'
+
+module SentientUser
+
+  def self.included(base)
+    base.class_eval {
+      def self.current
+        RequestStore.store[:user]
+      end
+
+      def self.current=(o)
+        raise(ArgumentError,
+            "Expected an object of class '#{self}', got #{o.inspect}") unless (o.is_a?(self) || o.nil?)
+        RequestStore.store[:user] = o
+      end
+
+      def make_current
+        RequestStore.store[:user] = self
+      end
+
+      def current?
+        !RequestStore.store[:user].nil? && self.id == RequestStore.store[:user].id
+      end
+
+      def self.do_as(user, &block)
+        old_user = self.current
+
+        begin
+          self.current = user
+          response = block.call unless block.nil?
+        ensure
+          self.current = old_user
+        end
+
+        response
+      end
+    }
+  end
+end
+
+module SentientController
+  def self.included(base)
+    base.class_eval {
+      before_action do |c|
+        User.current = c.send(:current_user)
+      end
+    }
+  end
+end

data/lib/sentient_user/version.rb

@@ -0,0 +1,3 @@
+module SentientUser
+  VERSION = "1.0.0"
+end

data/sentient_user_request_store.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sentient_user/version.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["bokmann"]
+  gem.email         = ["dbock@javaguy.org"]
+  gem.description   = %q{lets the User model in most authentication frameworks know who is the current user}
+  gem.summary       = %q{A trivial bit of common code}
+  gem.homepage      = "http://github.com/house9/sentient_user_request_store"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "sentient_user_request_store"
+  gem.require_paths = ["lib"]
+  gem.version       = SentientUser::VERSION
+
+  gem.add_dependency "railties", ">= 3.1"
+  gem.add_dependency 'request_store', '1.4.1'
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rdoc"
+  gem.add_development_dependency "minitest", "4.7.5"
+  gem.add_development_dependency 'minitest_should'
+  gem.add_development_dependency 'turn'
+
+  gem.add_development_dependency "simplecov"
+
+end

data/test/helper.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+#require 'test/unit'
+require "minitest/autorun"
+require "minitest/should"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sentient_user'
+
+#class Test::Unit::TestCase
+#end
+
+class Person
+  include SentientUser
+end
+
+class User
+  include SentientUser
+end
+
+class AnonymousUser < User ; end
+
+ExceptedWords = %w{ hackery hacky monkeypatching
+                    ActiveRecord SentientUser SentientController
+                    initializer config rakefile bokmann
+                    sublicense MERCHANTABILITY NONINFRINGEMENT img src
+                    }
+
+def check_spelling_in_file(path_relative_to_gem_root)
+  path = "#{File.dirname(__FILE__)}/../#{path_relative_to_gem_root}"
+  begin
+    aspell_output = `cat #{path} | aspell list`
+  rescue => err
+    warn "You probably don't have aspell. On mac: brew install aspell --lang=en"
+    raise err
+  end
+  noticed_words = aspell_output.split($/)
+  misspellings = noticed_words - ExceptedWords
+  assert_equal [], misspellings
+end

data/test/test_sentient_user.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+class TestTruth < Minitest::Should::TestCase
+  should "allow making the 'person' class sentient" do
+    p = Person.new
+    p.make_current
+    assert_equal Person.current, p
+  end
+
+  should "allow making the 'user' class sentient" do
+    u = User.new
+    u.make_current
+    assert_equal User.current, u
+  end
+
+  should "not allow making Person.current a user" do
+    assert_raises ArgumentError do
+      Person.current = User.new
+    end
+  end
+
+  should "allow making person.current a person" do
+    Person.current = Person.new
+  end
+
+  should "allow subclasses of user to be assigned to user.current" do
+    User.current = AnonymousUser.new
+  end
+
+  should "allow execution of a block as a specified user" do
+    p, p2 = Person.new, Person.new
+    p.make_current
+    Person.do_as(p2) { assert_equal Person.current, p2 }
+  end
+
+  should "should reset the original user after executing a block as a specified user" do
+    p, p2 = Person.new, Person.new
+    p.make_current
+
+    Person.do_as(p2) { }
+    assert_equal Person.current, p
+
+    begin
+      Person.do_as(p2) { raise "error" }
+    rescue
+      assert_equal Person.current, p
+    end
+  end
+
+  should "have no spelling errors in its README" do
+    check_spelling_in_file "README.rdoc"
+  end
+
+  should "have no spelling errors in the license" do
+    check_spelling_in_file "LICENSE"
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: sentient_user_request_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- bokmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+- !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: rdoc
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: minitest_should
+  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: turn
+  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: lets the User model in most authentication frameworks know who is the
+  current user
+email:
+- dbock@javaguy.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rbenv-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/sentient_user.rb
+- lib/sentient_user/version.rb
+- sentient_user_request_store.gemspec
+- test/helper.rb
+- test/test_sentient_user.rb
+homepage: http://github.com/house9/sentient_user_request_store
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A trivial bit of common code
+test_files:
+- test/helper.rb
+- test/test_sentient_user.rb