andrzejsliwa-session_management 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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

@@ -0,0 +1,6 @@
+SessionManagment
+================
+
+This is the simple plugin for session managing in objective way.
+
+Copyright (c) 2008 I-TOOL SOFTWARE - Andrzej Sliwa, released under the MIT license

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the session_management plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the session_management plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SessionManagement'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/session_management/USAGE

@@ -0,0 +1,10 @@
+Description:
+    This generator is used for enabling session_managment in 
+    your application.
+
+Example:
+    ./script/generate session_managment
+
+    This will create:
+        configuration file user_session.rb in config, and add
+        using of this api in application controller

data/generators/session_management/session_management_generator.rb

@@ -0,0 +1,22 @@
+class SessionManagementGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      
+      m.class_collisions 'UserSession'
+      m.directory 'config'
+      m.template 'user_session.rb', 'config/user_session.rb'
+                
+      gsub_file 'app/controllers/application.rb', /(#{Regexp.escape("class ApplicationController < ActionController::Base")})/mi do |match|
+        "#{match}\n  # See SessionManagment::ManagementsMethods for details\n  # This option enable object oriented session managment.\n  enable_session_management\n"
+      end
+      
+    end
+  end
+  
+  def gsub_file(relative_destination, regexp, *args, &block)
+    path = destination_path(relative_destination)
+    content = File.read(path).gsub(regexp, *args, &block)
+    File.open(path, 'wb') { |file| file.write(content) }
+  end
+  
+end

data/generators/session_management/templates/user_session.rb

@@ -0,0 +1,31 @@
+require 'session_management/session.rb'
+
+# This class is configuration for session managment.
+# Here you can define members or collection managed
+# by session.
+class UserSession < SessionManagement::Session
+  
+  # Example of member definition: 
+  #   <code>
+  #   member :last_action
+  #   </code>
+  # 
+  # Generated methods:
+  #   <code>last_action=        # set value on session </code>
+  #   <code>last_action         # return value from session </code>
+  #   <code>reset_last_action   # this reset value on session (and return value) </code>
+  member      :last_action
+  
+  # Example of collection definition: 
+  #   <code>
+  #   collection :products
+  #   </code>
+  # 
+  # Generated methods:
+  #   <code>add_product=         # set value on session collection </code>
+  #   <code>remove_product(prod) # remove value from session collection </code>
+  #   <code>products             # return session collection </code>
+  #   <code>reset_products       # this reset value on session (and return value) </code>
+  # collection :products
+
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/session_management.rb

@@ -0,0 +1,29 @@
+module SessionManagement
+  
+  def self.included(base)
+    base.extend ManagementsMethods
+  end
+    
+  # This module is for extending ActionController::Base
+  module ManagementsMethods
+    
+    # This method is for enabling session management
+    # functionality for application
+    def enable_session_management
+      unless included_modules.include? InstanceMethods
+        include InstanceMethods
+      end
+    end
+  end
+    
+  # This module is used for include instance methods
+  # for ActionController::Base
+  module InstanceMethods
+    
+    private 
+      def user_session
+        @user_session ||= UserSession.new(session) 
+      end
+  end
+  
+end

data/lib/session_management/exceptions.rb

@@ -0,0 +1,16 @@
+module SessionManagement
+
+  # This Exception class is used for
+  # raising exception when session variable
+  # is defined allready.
+  class DefinedException < Exception
+  end
+
+  # This Exception class is user for
+  # raising exception when param is
+  # not Symbol for instance method sess 
+  # of object created from Session class is
+  class ParamTypeException < Exception
+  end
+  
+end

data/lib/session_management/session.rb

@@ -0,0 +1,119 @@
+require 'session_management/exceptions.rb'
+
+module SessionManagement
+
+  # This class is used for managing objects on session
+  # with better controll of using session hash
+  #
+  # For using this you must extend this class.
+  # Example using:
+  #    <code>
+  #    class UserSession < SessionManagment::Session    
+  #    </code>
+  #
+  class Session
+  
+    # This is constructor for initializing
+    # Session object
+    def initialize(session)
+      @session = session
+    end
+  
+    # This helper method is for definie new
+    # session values ready to use in aplication
+    #
+    # Example using: 
+    #   <code>
+    #   member :last_action
+    #   </code>
+    # 
+    # This declaration add new methods helpers for 
+    # managing on session:
+    #   <code>last_action=        # set value on session </code>
+    #   <code>last_action         # return value from session </code>
+    #   <code>reset_last_action   # this reset value on session (and return value) </code>
+    #
+    def self.member(name)
+      raise ParamTypeException, "#{name} must be Symbol" unless name.class == Symbol
+    
+      setter_name = "#{name}=".to_sym
+      getter_name = name
+      reset_name  = "reset_#{name}".to_sym
+     
+      defined = instance_method( setter_name ) rescue false
+      raise DefinedException, "#{setter_name} is already defined in #{self}" if defined
+    
+      # define setter method in runtime
+      define_method( setter_name ) do |param|
+        @session[name] = param
+      end
+      # define getter method in runtime
+      define_method( getter_name ) do
+        @session[name]
+      end
+      # define reset method in runtime
+      define_method( reset_name ) do
+        orginal_value = @session[name]
+        @session[name] = nil
+        orginal_value
+      end
+    end
+    
+    # This helper method is for definie new
+    # session values ready to use in aplication
+    #
+    # Example using: 
+    #   <code>
+    #   collection :products
+    #   </code>
+    # 
+    # This declaration add new methods helpers for 
+    # managing on session:
+    #   <code>add_product(prod)    # set value on session collection </code>
+    #   <code>remove_product(prod) # remove value from session collection </code>
+    #   <code>products             # return session collection </code>
+    #   <code>reset_products       # this reset value on session (and return value) </code>
+    #
+    def self.collection(name)
+      raise ParamTypeException, "#{name} must be Symbol" unless name.class == Symbol
+      
+      singular_name = name.to_s.singularize
+      
+      add_name    = "add_#{singular_name}".to_sym
+      remove_name = "remove_#{singular_name}".to_sym
+      coll_name   = "#{name}".to_sym
+      reset_name  = "reset_#{name}".to_sym 
+
+      defined = instance_method( setter_name ) rescue false
+      raise DefinedException, "#{add_name} is already defined in #{self}" if defined
+
+      # define add method in runtime
+      define_method( add_name ) do |param|
+        resolve_collection( name ) << param
+      end
+      # define remove method in runtime
+      define_method( remove_name ) do |param|
+        resolve_collection( name ).delete param
+      end
+      # define get collection in runtime
+      define_method( coll_name ) do 
+        resolve_collection( name )
+      end
+      
+      # define reset collection method
+      define_method( reset_name ) do      
+        orginal_value = resolve_collection( name )
+        @session[name] = nil
+        orginal_value
+      end
+    end
+    
+    private
+      # helper method - stay DRY ;)
+      def resolve_collection(name)
+        @session[name] ||= Array.new
+      end
+    
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require 'session_management'
+
+ActionController::Base.send( :include, SessionManagement )
+
+RAILS_DEFAULT_LOGGER.info "** session_management: initialized properly."

data/session_management.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name = "session_management"
+  s.version = "1.0.0"
+  s.date = "2008-11-12"
+  s.summary = "Session Management Plugin in object oriented way."
+  s.email = "andrzej.sliwa@i-tool.eu"
+  s.homepage = "http://github.com/andrzejsliwa/session_management/tree/master"
+  s.description = "Session Management Plugin in object oriented way."
+  s.has_rdoc = false
+  s.authors = ["Andrzej Sliwa"]
+  s.files = [ 
+              "MIT-LICENSE",
+              "README",
+              "generators/session_management",
+              "generators/session_management/session_management_generator.rb",
+              "generators/session_management/templates",
+              "generators/session_management/templates/user_session.rb",
+              "generators/session_management/USAGE",
+              "init.rb",
+              "install.rb",
+              "lib/session_management",
+              "lib/session_management/exceptions.rb",
+              "lib/session_management/session.rb",
+              "lib/session_management.rb",
+              "rails/init.rb",
+              "Rakefile",
+              "session_management.gemspec",
+              "test/functional",
+              "test/functional/session_management_test.rb",
+              "test/unit/user_session_test.rb",
+              "uninstall.rb" ]
+  s.add_dependency("rails", [">= 2.1.0"])
+end

data/test/functional/session_management_test.rb

@@ -0,0 +1,74 @@
+require 'test/unit'
+require 'rubygems' 
+require 'action_controller'
+require 'action_controller/test_process' 
+require 'session_management'
+require 'session_management/session.rb'
+
+ActionController::Base.send( :include, SessionManagement )
+ActionController::Routing::Routes.reload rescue nil
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+end
+
+class UserSession < SessionManagement::Session
+  member     :last_action
+  collection :products
+end
+
+class SessionManagementController < ActionController::Base
+  enable_session_management
+
+  def set_last_action
+    user_session.last_action = "index"
+    render :xml => "<message>index</message>"
+  end
+
+  def get_last_action
+    render :xml => "<last_action>#{user_session.last_action}</last_action>"
+  end
+  
+  def add_product
+    user_session.add_product(params[:id].to_s)
+    render :xml => "<message>index</message>"
+  end
+
+  def get_products
+    render :xml => "<products>#{user_session.products.collect{|a| a + ", "}.to_s.chop.chop}</products>"
+  end
+
+end
+
+class SessionManagementTest < Test::Unit::TestCase
+
+  def setup
+    @controller = SessionManagementController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+  end
+
+
+  def test_should_manage_members_in_session
+    get :set_last_action
+    assert_response :success
+    assert_select 'message', 'index'
+    
+    get :get_last_action
+    assert_response :success
+    assert_select 'last_action', 'index'
+  end
+  
+  def test_should_manage_collection_in_session
+    get :add_product, :id => 1
+    assert_response :success
+    assert_select 'message', 'index'
+    
+    get :add_product, :id => 2
+    assert_response :success
+    assert_select 'message', 'index'
+    
+    get :get_products
+    assert_response :success
+    assert_select 'products', '1, 2'
+  end
+end

data/test/unit/user_session_test.rb

@@ -0,0 +1,44 @@
+require 'test/unit'
+require 'rubygems' 
+require 'action_controller'
+require 'action_controller/test_process' 
+require 'session_management'
+require 'session_management/session.rb'
+  
+class UserSessionTest < Test::Unit::TestCase
+
+  class UserSession < SessionManagement::Session
+    member  :last_action
+    collection :products
+  end
+  
+  def setup
+    @user_session = UserSession.new(Hash.new) 
+  end
+
+  def test_should_set_and_get_member
+    @user_session.last_action = "index"
+    assert_equal "index", @user_session.last_action
+  end
+  
+  def test_should_reset_member
+    @user_session.last_action = "index"
+    value = @user_session.reset_last_action
+    assert_equal "index", value
+    assert_nil @user_session.last_action
+  end
+  
+  def test_should_add_to_and_get_collection
+    @user_session.add_product(1)
+    assert_equal 1, @user_session.products[0]
+    @user_session.add_product(2)
+    assert_equal [1,2], @user_session.products
+  end
+  
+  def test_should_reset_collection
+    @user_session.add_product(1)
+    @user_session.reset_products
+    assert_equal [], @user_session.products
+  end
+  
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: andrzejsliwa-session_management
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Andrzej Sliwa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: Session Management Plugin in object oriented way.
+email: andrzej.sliwa@i-tool.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- README
+- generators/session_management
+- generators/session_management/session_management_generator.rb
+- generators/session_management/templates
+- generators/session_management/templates/user_session.rb
+- generators/session_management/USAGE
+- init.rb
+- install.rb
+- lib/session_management
+- lib/session_management/exceptions.rb
+- lib/session_management/session.rb
+- lib/session_management.rb
+- rails/init.rb
+- Rakefile
+- session_management.gemspec
+- test/functional
+- test/functional/session_management_test.rb
+- test/unit/user_session_test.rb
+- uninstall.rb
+has_rdoc: false
+homepage: http://github.com/andrzejsliwa/session_management/tree/master
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Session Management Plugin in object oriented way.
+test_files: []
+