active_nomad 0.0.2

data/CHANGELOG

@@ -0,0 +1,7 @@
+== 0.0.2 2010-09-28
+
+ * Rename to Active Nomad.
+
+== 0.0.1 2010-09-28
+
+ * Hi.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 George Ogata
+
+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.markdown

@@ -0,0 +1,63 @@
+# Active Nomad
+
+ActiveRecord objects with a customizable persistence strategy.
+
+## Why
+
+Sometimes you want an Active Record object that does not live in the database.
+Perhaps it never needs to be persisted, or you'd like to store it in a cookie,
+or a file, but it would still be handy to have ActiveRecord's ability to cast
+values, run validations, or fire callbacks.
+
+Ideally, the persistence strategy would be pluggable. With Active Nomad, it is!
+
+## How
+
+Subclass from ActiveNomad::Base and declare your attributes with the
+`attribute` class method. The arguments look just like creating a column in a
+migration:
+
+    class Thing < ActiveNomad::Base
+      attribute :name, :string, :limit => 20
+    end
+
+To persist the record, Active Nomad calls `persist`, which calls a
+Proc registered by `to_save`. For example, here's how you could
+persist to a cookie:
+
+    thing = Thing.deserialize(cookies[:thing])
+    thing.to_save do |thing|
+      cookies[:thing] = thing.serialize
+      true
+    end
+
+Things to note:
+
+ * Active Nomad defines `serialize` and `deserialize` which will
+   serialize to and from a valid query string with predictable
+   attribute order (i.e., appropriate for a cookie).
+ * The proc should return true if persistence was successful, false
+   otherwise. This will be the return value of `save`, etc.
+ * You may alternatively override `persist` in a subclass if you
+   don't want to register a proc for every instance.
+
+## Notes
+
+Only ActiveRecord 2.3 compatible. ActiveRecord 3.0 has a more modular
+architecture which makes this largely unnecessary.
+
+## Contributing
+
+ * Bug reports: http://github.com/oggy/active_nomad/issues
+ * Source: http://github.com/oggy/active_nomad
+ * Patches: Fork on Github, send pull request.
+   * Ensure patch includes tests.
+   * Leave the version alone, or bump it in a separate commit.
+
+## Copyright
+
+Copyright (c) 2010 George Ogata. See LICENSE for details.
+
+## Credit
+
+Inspired by Jonathan Viney's ActiveRecord::BaseWithoutTable.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'ritual'
+
+spec_task

data/lib/active_nomad/version.rb

@@ -0,0 +1,11 @@
+module ActiveNomad
+  VERSION = [0, 0, 2]
+
+  class << VERSION
+    include Comparable
+
+    def to_s
+      join('.')
+    end
+  end
+end

data/lib/active_nomad.rb

@@ -0,0 +1,127 @@
+require 'active_record'
+require 'cgi'
+
+module ActiveNomad
+  NoPersistenceStrategy = Class.new(RuntimeError)
+
+  class Base < ActiveRecord::Base
+    #
+    # Tell this record how to save itself.
+    #
+    def to_save(&proc)
+      @save_proc = proc
+    end
+
+    #
+    # Return the attributes of this object serialized as a valid query
+    # string.
+    #
+    # Attributes are sorted by name.
+    #
+    def serialize
+      self.class.columns.map do |column|
+        name = column.name
+        value = serialize_value(send(name), column.type) or
+          next
+        "#{CGI.escape(name)}=#{value}"
+      end.compact.sort.join('&')
+    end
+
+    def self.deserialize(string)
+      params = string ? CGI.parse(string.strip) : {}
+      instance = new
+      columns.map do |column|
+        next if !params.key?(column.name)
+        value = params[column.name].first
+        instance.send "#{column.name}=", deserialize_value(value, column.type)
+      end
+      instance
+    end
+
+    protected
+
+    #
+    # Persist the object.
+    #
+    # The default is to call the block registered with
+    # #to_save. Override if you don't want to use #to_save.
+    #
+    def persist
+      @save_proc or
+        raise NoPersistenceStrategy, "no persistence strategy - use #to_save to define one"
+      @save_proc.call(self)
+    end
+
+    private
+
+    class FakeAdapter < ActiveRecord::ConnectionAdapters::AbstractAdapter
+      def native_database_types
+        @native_database_types ||= Hash.new{|h,k| h[k] = k.to_s}
+      end
+
+      def initialize
+      end
+    end
+
+    FAKE_ADAPTER = FakeAdapter.new
+
+    class << self
+      #
+      # Declare a column.
+      #
+      # Works like #add_column in a migration:
+      #
+      #     column :name, :string, :limit => 1, :null => false, :default => 'Joe'
+      #
+      def attribute(name, type, options={})
+        sql_type = FAKE_ADAPTER.type_to_sql(type, options[:limit], options[:precision], options[:scale])
+        columns << ActiveRecord::ConnectionAdapters::Column.new(name.to_s, options[:default], sql_type, options[:null] != false)
+        reset_column_information
+      end
+
+      def columns
+        @columns ||= []
+      end
+
+      # Reset everything, except the column information
+      def reset_column_information
+        columns = @columns
+        super
+        @columns = columns
+      end
+    end
+
+    self.abstract_class = true
+
+    def create_or_update_without_callbacks
+      errors.empty?
+      persist
+    end
+
+    def serialize_value(value, type)
+      return nil if value.nil?
+      case type
+      when :datetime, :timestamp, :time
+        value.to_time.to_i.to_s
+      when :date
+        (value.to_date - DATE_EPOCH).to_i.to_s
+      else
+        CGI.escape(value.to_s)
+      end
+    end
+
+    def self.deserialize_value(string, type)
+      return nil if string.nil?
+      case type
+      when :datetime, :timestamp, :time
+        Time.at(string.to_i)
+      when :date
+        DATE_EPOCH + string.to_i
+      else
+        CGI.unescape(string)
+      end
+    end
+
+    DATE_EPOCH = Date.parse('1970-01-01')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'active_nomad'
+
+# TODO: This should not be necessary - we're not stubbing out enough.
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")

data/spec/unit/active_nomad_spec.rb

@@ -0,0 +1,238 @@
+require 'spec_helper'
+
+describe ActiveNomad::Base do
+  describe ".attribute" do
+    it "should create a column with the given name and type" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :integer_attribute, :integer
+        attribute :string_attribute, :string
+        attribute :text_attribute, :text
+        attribute :float_attribute, :float
+        attribute :decimal_attribute, :decimal
+        attribute :datetime_attribute, :datetime
+        attribute :timestamp_attribute, :timestamp
+        attribute :time_attribute, :time
+        attribute :date_attribute, :date
+        attribute :binary_attribute, :binary
+        attribute :boolean_attribute, :boolean
+      end
+      klass.columns.should have(11).columns
+      klass.columns_hash['integer_attribute'].type.should == :integer
+      klass.columns_hash['string_attribute'].type.should == :string
+      klass.columns_hash['text_attribute'].type.should == :text
+      klass.columns_hash['float_attribute'].type.should == :float
+      klass.columns_hash['decimal_attribute'].type.should == :decimal
+      klass.columns_hash['datetime_attribute'].type.should == :datetime
+      klass.columns_hash['timestamp_attribute'].type.should == :timestamp
+      klass.columns_hash['time_attribute'].type.should == :time
+      klass.columns_hash['date_attribute'].type.should == :date
+      klass.columns_hash['binary_attribute'].type.should == :binary
+      klass.columns_hash['boolean_attribute'].type.should == :boolean
+    end
+
+    it "should treat a :limit option like #add_column in a migration" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :name, :string, :limit => 100
+      end
+      klass.columns_hash['name'].limit.should == 100
+    end
+
+    it "should treat :scale and :precision options like #add_column in a migration" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :value, :decimal, :precision => 5, :scale => 2
+      end
+      klass.columns_hash['value'].scale.should == 2
+      klass.columns_hash['value'].precision.should == 5
+    end
+
+    it "should treat a :null option like #add_column in a migration" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :mandatory, :decimal, :null => false
+        attribute :optional, :decimal, :null => true
+      end
+      klass.columns_hash['mandatory'].null.should be_false
+      klass.columns_hash['optional'].null.should be_true
+    end
+
+    it "should treat a :default option like #add_column in a migration" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :name, :string, :default => 'Joe'
+      end
+      klass.columns_hash['name'].default.should == 'Joe'
+    end
+  end
+
+  describe "an integer attribute" do
+    it "should cast the value from a string like ActiveRecord" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :value, :integer
+      end
+      instance = klass.new(:value => '123')
+      instance.value.should == 123
+    end
+  end
+
+  describe "#save" do
+    describe "when no save strategy has been defined" do
+      it "should raise a NoPersistenceStrategy error" do
+        instance = ActiveNomad::Base.new
+        lambda{instance.save}.should raise_error(ActiveNomad::NoPersistenceStrategy)
+      end
+    end
+
+    describe "when a save strategy has been defined" do
+      before do
+        saves = @saves = []
+        @instance = ActiveNomad::Base.new
+        @instance.to_save do |*args|
+          saves << args
+        end
+      end
+
+      it "should call the save_proc with the record as an argument" do
+        @instance.save
+        @saves.should == [[@instance]]
+      end
+    end
+
+    describe "when #persist has been overridden" do
+      before do
+        saves = @saves = []
+        @klass = Class.new(ActiveNomad::Base) do
+          define_method :persist do |*args|
+            saves << args
+          end
+        end
+      end
+
+      it "should call it and return the result" do
+        instance = @klass.new
+        instance.save
+        @saves.should == [[]]
+      end
+    end
+  end
+
+  describe "#serialize" do
+    it "should serialize the attributes as a query string" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :first_name, :string
+        attribute :last_name, :string
+      end
+      instance = klass.new(:first_name => 'Joe', :last_name => 'Blow')
+      instance.serialize.should == 'first_name=Joe&last_name=Blow'
+    end
+  end
+
+  describe ".deserialize" do
+    it "should create a new record with no attributes set if nil is given" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :name, :string
+      end
+      instance = klass.deserialize(nil)
+      instance.name.should be_nil
+    end
+
+    it "should create a new record with no attributes set if an empty string is given" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :name, :string
+      end
+      instance = klass.deserialize('')
+      instance.name.should be_nil
+    end
+
+    it "should create a new record with no attributes set if a blank string is given" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :name, :string
+      end
+      instance = klass.deserialize(" \t")
+      instance.name.should be_nil
+    end
+
+    it "should leave defaults alone for attributes which are not set" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :name, :string, :default => 'Joe'
+      end
+      instance = klass.deserialize(" \t")
+      instance.name.should == 'Joe'
+    end
+  end
+
+  describe "roundtripping through #serialize and .deserialize" do
+    it "should not be tripped up by delimiters in the keys" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :'a=x', :string
+        attribute :'b&x', :string
+      end
+      original = klass.new("a=x" => "1", "b&x" => "2")
+      roundtripped = klass.deserialize(original.serialize)
+      roundtripped.send("a=x").should == "1"
+      roundtripped.send("b&x").should == "2"
+    end
+
+    it "should not be tripped up by delimiters in the values" do
+      klass = Class.new(ActiveNomad::Base) do
+        attribute :a, :string
+        attribute :b, :string
+      end
+      original = klass.new(:a => "1=2", :b => "3&4")
+      roundtripped = klass.deserialize(original.serialize)
+      roundtripped.a.should == "1=2"
+      roundtripped.b.should == "3&4"
+    end
+
+    def self.it_should_roundtrip(type, value)
+      value = Time.at(value.to_i) if value.is_a?(Time) # chop off subseconds
+      it "should roundtrip #{value.inspect} correctly as a #{type}" do
+        klass = Class.new(ActiveNomad::Base) do
+          attribute :value, type
+        end
+        instance = klass.new(:value => value)
+        roundtripped = klass.deserialize(instance.serialize)
+        roundtripped.value.should == value
+      end
+    end
+
+    it_should_roundtrip :integer, nil
+    it_should_roundtrip :integer, 0
+    it_should_roundtrip :integer, 123
+
+    it_should_roundtrip :string, nil
+    it_should_roundtrip :string, ''
+    it_should_roundtrip :string, 'hi'
+
+    it_should_roundtrip :text, nil
+    it_should_roundtrip :text, ''
+    it_should_roundtrip :text, 'hi'
+
+    it_should_roundtrip :float, nil
+    it_should_roundtrip :float, 0
+    it_should_roundtrip :float, 0.123
+
+    it_should_roundtrip :decimal, nil
+    it_should_roundtrip :decimal, BigDecimal.new('0')
+    it_should_roundtrip :decimal, BigDecimal.new('123.45')
+
+    it_should_roundtrip :datetime, nil
+    it_should_roundtrip :datetime, Time.now.in_time_zone
+    # TODO: Support DateTime here, which is used when the value is
+    # outside the range of a Time.
+
+    it_should_roundtrip :timestamp, nil
+    it_should_roundtrip :timestamp, Time.now.in_time_zone
+
+    it_should_roundtrip :time, nil
+    it_should_roundtrip :time, Time.parse('2000-01-01 01:23:34').in_time_zone
+
+    it_should_roundtrip :date, nil
+    it_should_roundtrip :date, Date.today
+
+    it_should_roundtrip :binary, nil
+    it_should_roundtrip :binary, ''
+    it_should_roundtrip :binary, "\0\1"
+
+    it_should_roundtrip :boolean, nil
+    it_should_roundtrip :boolean, true
+    it_should_roundtrip :boolean, false
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: active_nomad
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- George Ogata
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+description: 
+email: 
+- george.ogata@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- lib/active_nomad/version.rb
+- lib/active_nomad.rb
+- CHANGELOG
+- LICENSE
+- README.markdown
+- Rakefile
+- spec/spec_helper.rb
+- spec/unit/active_nomad_spec.rb
+has_rdoc: true
+homepage: http://github.com/oggy/active_nomad
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ActiveRecord objects with a customizable persistence strategy.
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/active_nomad_spec.rb