sentient_model 1.0.1 → 1.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sentient_model (1.0.0)
+    sentient_model (1.0.2)
       bundler (>= 1.0)
 
 GEM

data/README.md

@@ -0,0 +1,35 @@
+# sentient_model
+
+sentient_model is simple piece of code trying to solve a common problem.
+
+Imagine you are writing an authentication system for [Ruby on Rails](http://rubyonrails.org). Usually you would define a method called `current_user` in your `ApplicationController` and expose it to your views and so on (which is fine in most cases).
+
+However, if you need `current_user` in locations where you can't easily expose the method, sentient_model is the perfect solution. Instead of manually exposing `current_user`, you would just rely on `User.current`. sentient_model's methods are globally accessible - therefore you don't have to worry about anything - it just works.
+
+## Usage
+
+Define your models as usual and include the module `SentientModel`:
+
+    class YourModel
+      include SentientModel
+      # more code such as validations or associations
+    end
+
+By including `SentientModel`, the following methods are added to your model:
+
+    YourModel#make_current # instance method - makes the callee object the sentient object
+    YourModel#current?     # instance method - true if the callee is the current sentient object or false otherwise
+    YourModel.current      # class method    - returns the sentient object or nil
+    YourModel.current=(m)  # class method    - sets the sentient object to the supplied argument (must be an instance of YourModel)
+    YourModel.has_current? # class method    - true if a sentient object defined or false otherwise 
+
+## Compatibility
+
+  * MRI Ruby 1.8.7
+  * MRI Ruby 1.9.2
+  * JRuby 1.6
+
+## How to contribute?
+
+  1. Fork on [GitHub](http://github.com/cs/sentient_model).
+  2. Send Pull Request.

data/sentient_model.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |s|
   s.name        = 'sentient_model'
-  s.version     = '1.0.1'
+  s.version     = '1.0.2'
   s.platform    = Gem::Platform::RUBY
-  s.summary     = 'Define variables available to an entire request with ease.'
-  s.description = 'Inspired by sentient_user Gem.'
+  s.summary     = 'Simple piece of code trying to solve a common problem.'
+  s.description = 'Replace methods like `current_account` in your controllers with globally accessible methods like `Account.current`.'
 
   s.required_ruby_version     = '>= 1.8.7'
   s.required_rubygems_version = ">= 1.3.6"
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.require_path = "lib"
 
   s.files = [
+    "README.md",
     "Rakefile",
     "Gemfile",
     "Gemfile.lock",

data/spec/sentient_model_spec.rb

@@ -52,8 +52,10 @@ describe SentientModel do
       @foo = TestClass.new.make_current
       @bar = OtherTestClass.new.make_current
     end
+    it { TestClass.has_current?.should be_true }
     it { TestClass.current.should eql(@foo) }
     it { TestClass.current.should_not eql(@bar) }
+    it { OtherTestClass.has_current?.should be_true }
     it { OtherTestClass.current.should eql(@bar) }
     it { OtherTestClass.current.should_not eql(@foo) }
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sentient_model
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Christoph Schiessl
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 +02:00
-default_executable: 
+date: 2011-05-29 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler
@@ -48,7 +47,7 @@ dependencies:
         version: "0.9"
   type: :development
   version_requirements: *id002
-description: Inspired by sentient_user Gem.
+description: Replace methods like `current_account` in your controllers with globally accessible methods like `Account.current`.
 email: chs@proactive.cc
 executables: []
 
@@ -57,6 +56,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
 - Rakefile
 - Gemfile
 - Gemfile.lock
@@ -64,7 +64,6 @@ files:
 - sentient_model.gemspec
 - spec/spec_helper.rb
 - spec/sentient_model_spec.rb
-has_rdoc: true
 homepage: http://github.com/bokmann/sentient_user
 licenses: []
 
@@ -98,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.4
 signing_key: 
 specification_version: 3
 summary: A trivial bit of common code