objectified_sessions 1.0.0

data/spec/objectified_sessions/system/setup_system_spec.rb

@@ -0,0 +1,65 @@
+require 'objectified_sessions'
+require "objectified_sessions/helpers/controller_helper"
+require "objectified_sessions/helpers/exception_helpers"
+
+describe "ObjectifiedSessions setup" do
+  include ObjectifiedSessions::Helpers::ControllerHelper
+  include ObjectifiedSessions::Helpers::ExceptionHelpers
+
+  before :each do
+    set_new_controller_instance
+    ::ObjectifiedSessions.instance_variable_set("@session_class", nil)
+  end
+
+  it "should allow setting the session class as a String" do
+    class SetupStringSpecifiedClass < ::ObjectifiedSessions::Base; end
+    ::ObjectifiedSessions.session_class = 'setup_string_specified_class'
+    @controller_instance.objsession.class.should == SetupStringSpecifiedClass
+  end
+
+  it "should allow setting the session class as a Symbol" do
+    class SetupSymbolSpecifiedClass < ::ObjectifiedSessions::Base; end
+    ::ObjectifiedSessions.session_class = :setup_symbol_specified_class
+    @controller_instance.objsession.class.should == SetupSymbolSpecifiedClass
+  end
+
+  it "should allow setting the session class as a Class" do
+    class SetupClassSpecifiedClass < ::ObjectifiedSessions::Base; end
+    ::ObjectifiedSessions.session_class = SetupClassSpecifiedClass
+    @controller_instance.objsession.class.should == SetupClassSpecifiedClass
+  end
+
+  it "should be able to load the session class from a file on the load path" do
+    require 'tmpdir'
+    require 'fileutils'
+
+    dir = Dir.mktmpdir('objectified_sessions')
+    dir = File.expand_path(dir)
+
+    subdir = File.join(dir, 'foo')
+    FileUtils.mkdir_p(subdir)
+
+    target_file = File.join(subdir, 'bar.rb')
+    File.open(target_file, 'w') do |f|
+      f.puts <<-EOF
+module Foo
+  class Bar < ObjectifiedSessions::Base
+    field :foo
+  end
+end
+EOF
+    end
+
+    $: << dir
+    ::ObjectifiedSessions.session_class = "Foo::Bar"
+    @controller_instance.objsession.class.name.should == "Foo::Bar"
+
+    expect(@underlying_session).to receive(:[]=).once.with('foo', 123)
+    @controller_instance.objsession.foo = 123
+
+    expect(@underlying_session).to receive(:[]).once.with('foo').and_return(234)
+    @controller_instance.objsession.foo.should == 234
+
+    FileUtils.rm_rf(dir)
+  end
+end

data/spec/objectified_sessions/system/strings_symbols_system_spec.rb

@@ -0,0 +1,73 @@
+require 'objectified_sessions'
+require "objectified_sessions/helpers/controller_helper"
+require "objectified_sessions/helpers/exception_helpers"
+
+describe "ObjectifiedSessions strings vs. symbols" do
+  include ObjectifiedSessions::Helpers::ControllerHelper
+  include ObjectifiedSessions::Helpers::ExceptionHelpers
+
+  before :each do
+    set_new_controller_instance
+  end
+
+  it "should always set and get by String, never Symbol" do
+    define_objsession_class { field :foo }
+
+    expect(@underlying_session).to receive(:[]=).once.with('foo', 123)
+    @controller_instance.objsession.foo = 123
+
+    expect(@underlying_session).to receive(:[]=).once.with('foo', 123)
+    @controller_instance.objsession.send(:[]=, :foo, 123)
+
+    expect(@underlying_session).to receive(:[]).once.with('foo').and_return(234)
+    @controller_instance.objsession.foo.should == 234
+
+    expect(@underlying_session).to receive(:[]).once.with('foo').and_return(234)
+    @controller_instance.objsession.send(:[], :foo).should == 234
+  end
+
+  it "should treat symbols and strings in received data identically" do
+    define_objsession_class do
+      prefix :prf
+      unknown_fields :delete
+
+      field :foo
+      field :bar
+    end
+
+    should_be_using_prefix('prf', false)
+    allow(@underlying_session).to receive(:keys).and_return([ 'foo', 'prf', :baz, :quux ])
+    allow(@prefixed_underlying_session).to receive(:keys).and_return([ 'foo', 'aaa', :bbb, :bar ])
+
+    expect(@prefixed_underlying_session).to receive(:delete).once do |arr|
+      unless arr.sort_by(&:to_s) == [ 'aaa', :bbb ].sort_by(&:to_s)
+        raise "Received :delete with incorrect arguments: #{arr.inspect}"
+      end
+    end
+
+    allow(@prefixed_underlying_session).to receive(:[]).with('foo').and_return(123)
+    allow(@prefixed_underlying_session).to receive(:[]).with('bar').and_return(345)
+
+    @controller_instance.objsession.foo.should == 123
+    @controller_instance.objsession.bar.should == 345
+  end
+
+  it "should preserve and delete data correctly, whether it's specified as a String or a Symbol" do
+    define_objsession_class do
+      unknown_fields :delete
+
+      field :preserve1
+      field :preserve2
+    end
+
+    expect(@underlying_session).to receive(:keys).once.with().and_return([ :preserve1, 'preserve2', :delete1, 'delete2' ])
+    expect(@underlying_session).to receive(:delete).once do |arr|
+      unless arr.sort_by(&:to_s) == [ :delete1, 'delete2' ].sort_by(&:to_s)
+        raise "Received :delete with incorrect arguments: #{arr.inspect}"
+      end
+    end
+
+    allow(@underlying_session).to receive(:[]).with('preserve1').and_return(234)
+    @controller_instance.objsession.preserve1.should == 234
+  end
+end

data/spec/objectified_sessions/system/unknown_data_system_spec.rb

@@ -0,0 +1,65 @@
+require 'objectified_sessions'
+require "objectified_sessions/helpers/controller_helper"
+require "objectified_sessions/helpers/exception_helpers"
+
+describe "ObjectifiedSessions unknown-data handling" do
+  include ObjectifiedSessions::Helpers::ControllerHelper
+  include ObjectifiedSessions::Helpers::ExceptionHelpers
+
+  before :each do
+    set_new_controller_instance
+  end
+
+  it "should not remove unknown data by default" do
+    define_objsession_class { field :foo; field :bar }
+
+    allow(@underlying_session).to receive(:keys).with().and_return([ :foo, :baz, :quux ])
+    allow(@underlying_session).to receive(:[]).with('foo').and_return(234)
+
+    @controller_instance.objsession.foo.should == 234
+  end
+
+  it "should remove unknown data if asked to" do
+    define_objsession_class do
+      unknown_fields :delete
+
+      field :foo
+      field :bar
+    end
+
+    allow(@underlying_session).to receive(:keys).with().and_return([ :foo, :baz, :quux ])
+    expect(@underlying_session).to receive(:delete).once do |arr|
+      unless arr.sort_by(&:to_s) == [ :baz, :quux ].sort_by(&:to_s)
+        raise "Received :delete with incorrect arguments: #{arr.inspect}"
+      end
+    end
+
+    allow(@underlying_session).to receive(:[]).with('foo').and_return(234)
+
+    @controller_instance.objsession.foo.should == 234
+  end
+
+  it "should not remove unknown data from outside the prefix" do
+    define_objsession_class do
+      prefix :prf
+      unknown_fields :delete
+
+      field :foo
+      field :bar
+    end
+
+    should_be_using_prefix('prf', false)
+    allow(@underlying_session).to receive(:keys).and_return([ :foo, :prf, :baz, :quux ])
+    allow(@prefixed_underlying_session).to receive(:keys).and_return([ :foo, :aaa, :bbb ])
+
+    expect(@prefixed_underlying_session).to receive(:delete).once do |arr|
+      unless arr.sort_by(&:to_s) == [ :aaa, :bbb ].sort_by(&:to_s)
+        raise "Received :delete with incorrect arguments: #{arr.inspect}"
+      end
+    end
+
+    allow(@prefixed_underlying_session).to receive(:[]).with('foo').and_return(123)
+
+    @controller_instance.objsession.foo.should == 123
+  end
+end

data/spec/objectified_sessions/system/visibility_system_spec.rb

@@ -0,0 +1,61 @@
+require 'objectified_sessions'
+require "objectified_sessions/helpers/controller_helper"
+require "objectified_sessions/helpers/exception_helpers"
+
+describe "ObjectifiedSessions visibility" do
+  include ObjectifiedSessions::Helpers::ControllerHelper
+  include ObjectifiedSessions::Helpers::ExceptionHelpers
+
+  before :each do
+    set_new_controller_instance
+  end
+
+  it "should allow making a field private, and generate only private methods for it" do
+    define_objsession_class do
+      field :foo, :visibility => :private
+
+      def set_foo(x)
+        self.foo = x
+      end
+
+      def get_foo
+        foo
+      end
+    end
+
+    @controller_instance.objsession.respond_to?(:foo).should_not be
+    @controller_instance.objsession.respond_to?(:foo=).should_not be
+    lambda { @controller_instance.objsession.foo }.should raise_error(NoMethodError)
+    lambda { @controller_instance.objsession.foo = 123 }.should raise_error(NoMethodError)
+
+    expect(@underlying_session).to receive(:[]=).once.with('foo', 123)
+    @controller_instance.objsession.set_foo(123)
+
+    expect(@underlying_session).to receive(:[]).once.with('foo').and_return(234)
+    @controller_instance.objsession.get_foo.should == 234
+  end
+
+  it "should allow setting the default visibility to private, but overriding it on a field-by-field basis" do
+    define_objsession_class do
+      default_visibility :private
+
+      field :foo
+      field :bar, :visibility => :public
+    end
+
+    @controller_instance.objsession.respond_to?(:foo).should_not be
+    @controller_instance.objsession.respond_to?(:foo=).should_not be
+    lambda { @controller_instance.objsession.foo }.should raise_error(NoMethodError)
+    lambda { @controller_instance.objsession.foo = 123 }.should raise_error(NoMethodError)
+
+    expect(@underlying_session).to receive(:[]=).once.with('bar', 123)
+    @controller_instance.objsession.bar = 123
+    expect(@underlying_session).to receive(:[]).once.with('bar').and_return(234)
+    @controller_instance.objsession.bar.should == 234
+
+    expect(@underlying_session).to receive(:[]=).once.with('foo', 123)
+    @controller_instance.objsession.send(:foo=, 123)
+    expect(@underlying_session).to receive(:[]).once.with('foo').and_return(234)
+    @controller_instance.objsession.send(:foo).should == 234
+  end
+end

data/spec/objectified_sessions/unit/objectified_session_generator_spec.rb

@@ -0,0 +1,121 @@
+require 'objectified_sessions'
+require 'fileutils'
+
+describe ObjectifiedSessionGenerator do
+  before :each do
+    @dir = Dir.mktmpdir("objectified_sessions_spec_generator")
+
+    allow(::Rails).to receive(:root).with().and_return(@dir)
+    FileUtils.mkdir_p(File.join(@dir, "lib"))
+
+    @generator = ObjectifiedSessionGenerator.new
+
+    @puts_msgs = [ ]
+    pm = @puts_msgs
+    allow($stdout).to receive(:puts) { |*args| pm << args }
+  end
+
+  def output
+    @puts_msgs.flatten.join("\n")
+  end
+
+  after :each do
+    FileUtils.rm_rf(@dir) if @dir && File.exist?(@dir)
+  end
+
+  context "actual class creation" do
+    def expect_class_creation(class_name, subpath)
+      @generator.create_session_file
+
+      output.should match(/#{class_name}/)
+      output.should match(/#{@dir}/)
+
+      target_file = File.join(@dir, subpath)
+      File.exist?(target_file).should be
+
+      const_target = ::Object
+      while const_target && class_name =~ /^(.*?)::(.*)$/i
+        if const_target.const_defined?($1)
+          const_target = const_target.const_get($1)
+        else
+          const_target = nil
+        end
+      end
+
+      const_target.send(:remove_const, class_name.to_sym) if const_target && const_target.const_defined?(class_name.to_sym)
+
+      load(target_file)
+
+      klass = class_name.constantize
+      klass.superclass.should == ::ObjectifiedSessions::Base
+      klass.accessible_field_names.should == [ ]
+      klass.default_visibility.should == :public
+      klass.prefix.should == nil
+      klass.unknown_fields.should == :preserve
+    end
+
+    it "should create a normal 'objsession' class" do
+      ::ObjectifiedSessions.session_class = ::ObjectifiedSessions::DEFAULT_OBJSESSION_CLASS_NAME
+      expect_class_creation("Objsession", "lib/objsession.rb")
+    end
+
+    it "should create an alternate class if so configured" do
+      ::ObjectifiedSessions.session_class = "FooBar"
+      expect_class_creation("FooBar", "lib/foo_bar.rb")
+    end
+
+    it "should create a nested class if asked to" do
+      ::ObjectifiedSessions.session_class = "BazTest::BarTest::FooBarTest"
+      expect_class_creation("BazTest::BarTest::FooBarTest", "lib/baz_test/bar_test/foo_bar_test.rb")
+    end
+  end
+
+  context "class creation failures" do
+    it "should not create an Objsession class if one exists already in the namespace" do
+      class Objsession; end
+      ::ObjectifiedSessions.session_class = ::ObjectifiedSessions::DEFAULT_OBJSESSION_CLASS_NAME
+
+      @generator.create_session_file
+      target_file = File.join(@dir, "lib/objsession.rb")
+
+      File.exist?(target_file).should_not be
+      output.should match(/doing nothing/i)
+      output.should match(/Objsession/i)
+    end
+
+    it "should not create a custom-named class if one exists already in the namespace" do
+      class FooBar1; end
+      ::ObjectifiedSessions.session_class = :FooBar1
+
+      @generator.create_session_file
+      target_file = File.join(@dir, "lib/foo_bar1.rb")
+
+      File.exist?(target_file).should_not be
+      output.should match(/doing nothing/i)
+      output.should match(/FooBar1/i)
+    end
+
+    it "should not create an Objsession class if a file exists on disk" do
+      ::ObjectifiedSessions.session_class = ::ObjectifiedSessions::DEFAULT_OBJSESSION_CLASS_NAME
+      ::Object.send(:remove_const, :Objsession) if ::Object.const_defined?(:Objsession)
+
+      FileUtils.mkdir_p(File.join(@dir, "lib"))
+      File.open(File.join(@dir, "lib/objsession.rb"), "w") { |f| f.puts "hi!" }
+      @generator.create_session_file
+
+      output.should match(/already a file/i)
+      output.should match(%r{#{@dir}/lib/objsession\.rb}i)
+    end
+
+    it "should not create a custom class if a file exists on disk" do
+      ::ObjectifiedSessions.session_class = "Foo::Bar2"
+
+      FileUtils.mkdir_p(File.join(@dir, "lib/foo"))
+      File.open(File.join(@dir, "lib/foo/bar2.rb"), "w") { |f| f.puts "hi!" }
+      @generator.create_session_file
+
+      output.should match(/already a file/i)
+      output.should match(%r{#{@dir}/lib/foo/bar2\.rb}i)
+    end
+  end
+end