active_session 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in active_session.gemspec
+gemspec
+
+gem "rake"
+gem "minitest", :platform => :ruby_18

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jakub Kuźma, Wojciech Wnętrzak
+
+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

@@ -0,0 +1,5 @@
+# Active Session
+
+## Copyright
+
+Copyright (c) 2011 Jakub Kuźma, Wojciech Wnętrzak. See [LICENSE](http://github.com/qoobaa/active_session/raw/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,10 @@
+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

data/active_session.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_session/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active_session"
+  s.version     = ActiveSession::VERSION
+  s.authors     = ["Jakub Kuźma", "Wojciech Wnętrzak"]
+  s.email       = ["qoobaa@gmail.com", "w.wnetrzak@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{ActiveModel session}
+  s.description = %q{ActiveModel session}
+
+  #s.rubyforge_project = "active_session"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activemodel", "~> 3.1.1"
+  s.add_runtime_dependency "activesupport", "~> 3.1.1"
+end

data/lib/active_session/errors.rb

@@ -0,0 +1,17 @@
+module ActiveSession
+  module ActiveSessionError
+
+  end
+
+  class UnknownAttributeError < NoMethodError
+    include ActiveSessionError
+  end
+
+  class AssociationTypeMismatch < StandardError
+    include ActiveSessionError
+  end
+
+  class StoreValueNotDefined < StandardError
+    include ActiveSessionError
+  end
+end

data/lib/active_session/version.rb

@@ -0,0 +1,3 @@
+module ActiveSession
+  VERSION = "0.0.1"
+end

data/lib/active_session.rb

@@ -0,0 +1,113 @@
+require "active_model"
+require "active_support/concern"
+require "active_support/core_ext"
+require "active_session/errors"
+
+module ActiveSession
+  extend ActiveSupport::Concern
+
+  included do
+    extend ActiveModel::Naming
+    include ActiveModel::AttributeMethods
+    include ActiveModel::Conversion
+    include ActiveModel::MassAssignmentSecurity
+    include ActiveModel::Validations
+
+    attribute_method_suffix "", "="
+    attr_reader :attributes
+
+    cattr_accessor :store_key
+    self.store_key = :id
+  end
+
+  module ClassMethods
+    def clear_store(store)
+      store.delete(store_key)
+    end
+
+    def belongs_to(name, options = {})
+      klass = options.fetch(:class_name, name.to_s.classify.constantize)
+      foreign_key = options.fetch(:foreign_key, "#{name}_id").to_sym
+
+      define_method(name) do
+        return instance_variable_get("@#{name}") if instance_variable_defined?("@#{name}")
+        instance_variable_set("@#{name}", klass.find(send(foreign_key)))
+      end
+
+      define_method("#{name}=") do |model|
+        raise ActiveSession::AssociationTypeMismatch, "#{klass} expected, got #{model.class}" unless model.nil? or model.is_a?(klass)
+        send("#{foreign_key}=", model.try(:id))
+      end
+
+      define_method(foreign_key) do
+        @attributes[foreign_key]
+      end
+
+      define_method("#{foreign_key}=") do |model_id|
+        remove_instance_variable("@#{name}") if instance_variable_defined?("@#{name}")
+        @attributes[foreign_key] = model_id
+      end
+    end
+  end
+
+  module InstanceMethods
+    def initialize(store, attributes = nil, options = {})
+      @store = store
+      @attributes = {}
+      assign_attributes(attributes, options) if attributes
+      yield self if block_given?
+    end
+
+    def attributes=(attributes)
+      assign_attributes(attributes)
+    end
+
+    def assign_attributes(new_attributes, options = {})
+      return unless new_attributes
+
+      attributes = new_attributes.stringify_keys
+
+      unless options[:without_protection]
+        attributes = sanitize_for_mass_assignment(attributes, options.fetch(:as, :default))
+      end
+
+      attributes.each do |key, value|
+        if respond_to?("#{key}=")
+          send("#{key}=", value)
+        else
+          raise ActiveSession::UnknownAttributeError, "unknown attribute: #{key}"
+        end
+      end
+    end
+
+    def persisted?
+      @store[self.class.store_key].present? and @store[self.class.store_key] == store_value
+    end
+
+    def destroy
+      persisted? && self.class.clear_store(@store) && true
+    end
+
+    def store_value
+      raise ActiveSession::StoreValueNotDefined, "you have to override store_value method to return something useful (usually user_id)"
+    end
+
+    def save
+      valid? && serialize && true
+    end
+
+    private
+
+    def attribute(attribute)
+      @attributes[attribute.to_sym]
+    end
+
+    def attribute=(attribute, value)
+      @attributes[attribute.to_sym] = value
+    end
+
+    def serialize
+      @store[self.class.store_key] = store_value
+    end
+  end
+end

data/test/basic_session_test.rb

@@ -0,0 +1,12 @@
+require "helper"
+
+require "models/basic_session"
+
+describe BasicSession do
+  include ActiveModel::Lint::Tests
+
+  before do
+    @store = {}
+    @model = BasicSession.new(@store)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,3 @@
+require "minitest/autorun"
+
+require "active_session"

data/test/models/basic_session.rb

@@ -0,0 +1,3 @@
+class BasicSession
+  include ActiveSession
+end

data/test/models/user.rb

@@ -0,0 +1,11 @@
+class User
+  attr_reader :id
+
+  def self.find(id)
+    new(id) if id.to_i > 0
+  end
+
+  def initialize(id)
+    @id = id
+  end
+end

data/test/models/user_session.rb

@@ -0,0 +1,10 @@
+class UserSession
+  include ActiveSession
+
+  belongs_to :user
+
+  validates :user, :presence => true
+
+  self.store_key = :user_id
+  alias_method :store_value, :user_id
+end

data/test/user_session_test.rb

@@ -0,0 +1,121 @@
+require "helper"
+
+require "models/user"
+require "models/user_session"
+
+describe UserSession do
+  include ActiveModel::Lint::Tests
+
+  before do
+    @store = {}
+    @model = UserSession.new(@store)
+  end
+
+  describe "valid?" do
+
+    it "returns true with existing user_id" do
+      session = UserSession.new(@store, :user_id => 1)
+      assert_equal true, session.valid?
+    end
+
+    it "returns false with non-existing user_id" do
+      session = UserSession.new(@store, :user_id => "non-existing")
+      assert_equal false, session.valid?
+    end
+
+    it "returns true with existing user" do
+      session = UserSession.new(@store, :user => User.new(1))
+      assert_equal true, session.valid?
+    end
+
+    it "returns false when user is nil" do
+      session = UserSession.new(@store, :user => nil)
+      assert_equal false, session.valid?
+    end
+
+  end
+
+  describe "save" do
+
+    it "returns true with existing user_id" do
+      session = UserSession.new(@store, :user_id => 5)
+      assert_equal true, session.save
+      assert_equal 5, @store[:user_id]
+    end
+
+    it "returns false with non-existing user" do
+      @store[:user_id] = "666"
+      session = UserSession.new(@store, :user => nil)
+      assert_equal false, session.save
+      assert_equal "666", @store[:user_id]
+    end
+
+  end
+
+  describe "persisted?" do
+
+    it "returns true with existing user and user_id in store" do
+      @store[:user_id] = 1
+      session = UserSession.new(@store, :user_id => 1)
+      assert_equal true, session.persisted?
+    end
+
+    it "returns false without user_id" do
+      @store[:user_id] = "666"
+      session = UserSession.new(@store)
+      assert_equal false, session.persisted?
+    end
+
+    it "returns false with existing user and different user_id in store" do
+      @store[:user_id] = "666"
+      session = UserSession.new(@store, :user_id => 1)
+      assert_equal false, session.persisted?
+    end
+
+  end
+
+  describe "destroy" do
+
+    it "returns true when persisted with existing user" do
+      @store[:user_id] = 1
+      session = UserSession.new(@store, :user_id => 1)
+      assert_equal true, session.destroy
+      assert_nil @store[:user_id]
+    end
+
+    it "returns false when not persisted" do
+      @store[:user_id] = "666"
+      session = UserSession.new(@store, :user_id => 1)
+      assert_equal false, session.destroy
+      assert_equal "666", @store[:user_id]
+    end
+
+  end
+
+  describe "user" do
+
+    it "returns user with given user_id" do
+      session = UserSession.new(@store)
+      assert_nil session.user
+      session.user_id = 1
+      assert_equal 1, session.user.id
+    end
+
+  end
+
+  describe "user=" do
+
+    it "works properly with nil" do
+      session = UserSession.new(@store, :user => User.new(1))
+      session.user = nil
+      assert_nil session.user
+      assert_nil session.user_id
+    end
+
+    it "raises exception when non-user class given" do
+      session = UserSession.new(@store, :user_id => 1)
+      assert_raises(ActiveSession::AssociationTypeMismatch) { session.user = "zomg" }
+    end
+
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: active_session
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jakub Kuźma
+- Wojciech Wnętrzak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &20755180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *20755180
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &20754620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *20754620
+description: ActiveModel session
+email:
+- qoobaa@gmail.com
+- w.wnetrzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_session.gemspec
+- lib/active_session.rb
+- lib/active_session/errors.rb
+- lib/active_session/version.rb
+- test/basic_session_test.rb
+- test/helper.rb
+- test/models/basic_session.rb
+- test/models/user.rb
+- test/models/user_session.rb
+- test/user_session_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: ActiveModel session
+test_files: []