norman 0.1.0

data/lib/norman/version.rb

@@ -0,0 +1,9 @@
+module Norman
+  module Version
+    MAJOR  = 0
+    MINOR  = 1
+    TINY   = 0
+    BUILD  = nil
+    STRING = [MAJOR, MINOR, TINY, BUILD].compact.join('.')
+  end
+end

data/lib/rack/norman.rb

@@ -0,0 +1,21 @@
+require "rack/contrib"
+
+module Rack
+  # Rack::Norman is a middleware that allows you to store a Norman datbase
+  # in a cookie.
+  # @see Norman::Adapters::Cookie
+  class Norman
+    def initialize(app, options = {})
+      @app     = app
+      @norman = ::Norman::Adapters::Cookie.new(options.merge(:sync => true))
+    end
+
+    def call(env)
+      @norman.data = env["rack.cookies"]["norman_data"]
+      @norman.load_database
+      status, headers, body = @app.call(env)
+      env["rack.cookies"]["norman_data"] = @norman.export_data
+      [status, headers, body]
+    end
+  end
+end

data/norman.gemspec

@@ -0,0 +1,25 @@
+require File.expand_path("../lib/norman/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors           = "Norman Clarke"
+  s.email             = "norman@njclarke.com"
+  s.files             = `git ls-files`.split("\n").reject {|f| f =~ /^\./}
+  s.has_rdoc          = true
+  s.homepage          = "http://github.com/norman/norman"
+  s.name              = "norman"
+  s.platform          = Gem::Platform::RUBY
+  s.rubyforge_project = "[none]"
+  s.summary           = "An ActiveModel-compatible ORM-like library for storing model instances in an in-memory Hash."
+  s.test_files        = Dir.glob "test/**/*_test.rb"
+  s.version           = Norman::Version::STRING
+  s.description       = <<-EOD
+    Norman is not an ORM, man! It's a database and ORM replacement for (mostly)
+    static models and small datasets. It provides ActiveModel compatibility, and
+    flexible searching and storage.
+  EOD
+  s.add_development_dependency "ffaker"
+  s.add_development_dependency "minitest", "~> 2.2.2"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "activesupport", "~> 3.0"
+  s.add_development_dependency "activemodel", "~> 3.0"
+end

data/spec/active_model_spec.rb

@@ -0,0 +1,115 @@
+require File.expand_path("../spec_helper", __FILE__)
+require "norman/active_model"
+
+class Book
+  extend Norman::Model
+  extend Norman::ActiveModel
+  field :slug, :title, :author
+  validates_presence_of :slug
+  validates_uniqueness_of :slug, :title
+  before_save :save_callback_fired
+  before_destroy :destroy_callback_fired
+
+  def save_callback_fired
+    @save_callback_fired = true
+  end
+
+  def destroy_callback_fired
+    @destroy_callback_fired = true
+  end
+end
+
+module ActiveModuleSupportSpecHelper
+  def valid_book
+    {:slug => "war-and-peace", :title => "War and Peace", :author => "Leo Tolstoy"}
+  end
+
+  def load_fixtures
+    Norman.adapters.clear
+    Norman::Adapter.new :name => :main
+    Book.use :main
+    @model = Book.create! valid_book
+  end
+end
+
+describe Norman::ActiveModel do
+
+  before { load_fixtures }
+
+  include ActiveModuleSupportSpecHelper
+  include ActiveModel::Lint::Tests
+
+  describe ".model_name" do
+    it "should return an ActiveModel::Name" do
+      assert_kind_of ::ActiveModel::Name, Book.model_name
+    end
+  end
+
+  describe "#keys" do
+    it "should return an array of attribute names" do
+      assert @model.keys.include?(:slug), "@model.keys should include :slug"
+    end
+  end
+
+  describe "#save!" do
+    it "should raise an exception if the model is not valid" do
+      assert_raises Norman::NormanError do
+        Book.new.save!
+      end
+    end
+  end
+
+  describe "#to_json" do
+    it "should serialize" do
+      json = @model.to_json
+      refute_nil @model.to_json
+      assert_match /"author":"Leo Tolstoy"/, json
+    end
+  end
+
+  describe "#to_xml" do
+    it "should serialize to XML" do
+      xml = @model.to_xml
+      refute_nil xml
+      assert_match /<author>Leo Tolstoy<\/author>/, xml
+    end
+  end
+
+  describe "#valid?" do
+    it "should do validation" do
+      book = Book.new
+      refute book.valid?
+      book.slug = "hello-world"
+      assert book.valid?
+    end
+  end
+
+  describe "callbacks" do
+    it "should fire save callbacks" do
+      book = Book.new valid_book
+      book.save
+      assert book.instance_variable_defined? :@save_callback_fired
+    end
+
+    it "should fire destroy callbacks" do
+      @model.destroy
+      assert @model.instance_variable_defined? :@destroy_callback_fired
+    end
+  end
+
+  describe ".validates_uniqueness_of" do
+    it "should validate on id attribute" do
+      @book = Book.new valid_book.merge(:title => "War and Peace II")
+      refute @book.valid?
+      @book.slug = "war-and-peace-2"
+      assert @book.valid?
+    end
+
+    it "should validate on non-id attribute" do
+      @book = Book.new valid_book.merge(:slug => "war-and-peace-2")
+      refute @book.valid?
+      @book.title = "War and Peace II"
+      assert @book.valid?
+    end
+  end
+end

data/spec/adapter_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Norman::Adapter do
+
+  before { Norman.adapters.clear }
+  after  { Norman.adapters.clear }
+
+  describe "#initialize" do
+
+    it "should register itself" do
+      Norman::Adapter.new :name => :an_adapter
+      assert_equal :an_adapter,  Norman.adapters.keys.first
+    end
+
+    it "should use a default name if none given" do
+      assert_equal Norman.default_adapter_name, Norman::Adapter.new.name
+    end
+
+    it "should raise error if a duplicate name is used" do
+      assert_raises Norman::NormanError do
+        2.times {Norman::Adapter.new(:name => :test_adapter)}
+      end
+    end
+
+    it "should set an empty hash as the db" do
+      assert_equal Hash.new, Norman::Adapter.new.db
+    end
+  end
+
+  describe "#db_for" do
+
+    before { load_fixtures }
+
+    it "should return a instance of Hash" do
+      adapter = Norman.adapters[:main]
+      assert_kind_of Hash, adapter.db_for(Person)
+    end
+  end
+
+  describe "stubbed io operations" do
+    it "should return true" do
+      adapter = Norman::Adapter.new
+      [:export_data, :import_data, :save_database].each do |method|
+        assert adapter.send method
+      end
+    end
+  end
+end

data/spec/cookie_adapter_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path("../spec_helper", __FILE__)
+require "norman/adapters/cookie"
+
+class User
+  extend Norman::Model
+  field :email, :name
+end
+
+module CookieAdapterSpecHelpers
+  def secret
+    "ssssshh... this is a secret!"
+  end
+
+  def sample_data
+    # hash = {"User" => {valid_user[:email] => valid_user}}
+    # p ActiveSupport::MessageVerifier.new(secret).generate(Zlib::Deflate.deflate(Marshal.dump(hash)))
+    "BAgiTnicY+GoZvNU4gwtTi1is2JzDQHxhLPyUx2KkzNy81P1kvNz2awZQqrZrTjzEnNTPZX4" +
+    "vfJTFYLBkiAJK67U3MTMHKyaAJGaGlk=--08913fe1c677e4bb0dd34ef90fb22f9027e587f4"
+  end
+
+  def valid_user
+    @valid_user ||= {:name => "Joe Schmoe", :email => "joe@schmoe.com"}
+  end
+
+  def load_fixtures
+    Norman.adapters.clear
+    @adapter = Norman::Adapters::Cookie.new \
+      :name   => :cookie,
+      :secret => secret
+    User.use :cookie, :sync => true
+  end
+end
+
+describe Norman::Adapters::Cookie do
+
+  include CookieAdapterSpecHelpers
+
+  before { load_fixtures }
+  after  { Norman.adapters.clear }
+
+  describe Norman::Adapters::Cookie do
+
+    describe "#initialize" do
+      it "should decode signed data if given" do
+        adapter = Norman::Adapters::Cookie.new \
+          :secret => secret,
+          :data   => sample_data
+        assert_kind_of Hash, adapter.db["User"]
+        assert_equal "joe@schmoe.com", adapter.db["User"].keys.first
+      end
+
+      it "should load properly with nil or blank data" do
+        [nil, ""].each_with_index do |arg, index|
+          adapter = Norman::Adapters::Cookie.new \
+            :secret => secret,
+            :data   => arg,
+            :name   => :"main_#{index}"
+          assert_instance_of Hash, adapter.db
+        end
+      end
+    end
+
+    describe "#export_data" do
+      it "should encode and sign the database" do
+        User.create \
+          :name  => Faker::Name.name,
+          :email => Faker::Internet.email
+        refute_nil @adapter.export_data
+      end
+    end
+
+    describe "#save_database" do
+      it "should raise a NormanError if signed data exceeds max data length" do
+        Norman::Adapters::Cookie.stubs(:max_data_length).returns(1)
+        assert_raises Norman::NormanError do
+          User.create valid_user
+        end
+      end
+    end
+  end
+end

data/spec/file_adapter_spec.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require File.expand_path("../spec_helper", __FILE__)
+
+classes = [Norman::Adapters::File, Norman::Adapters::YAML]
+
+classes.each do |klass|
+
+  describe klass.to_s do
+
+    before do
+      Norman.adapters.clear
+      @path = File.expand_path("../file_adapter_test", __FILE__)
+      @adapter = klass.new(:file => @path)
+      @adapter.instance_variable_set :@db, {
+        "Class" => {
+          :a => :b,
+          :unicode => "ü"
+        }
+      }
+    end
+
+    after do
+      Norman.adapters.clear
+      FileUtils.rm_f @path
+    end
+
+    describe "#export_data" do
+      it "should be a string" do
+        assert_kind_of String, @adapter.export_data
+      end
+    end
+
+    describe "#save_database" do
+      it "should write the data to disk" do
+        assert @adapter.save_database
+        assert File.exists? @path
+      end
+    end
+
+    describe "#load_database" do
+      it "should load the data from the filesystem" do
+        @adapter.save_database
+        a2 = @adapter.class.new(:name => "a2", :file => @path)
+        assert_equal @adapter.db["Class"][:unicode].bytes.entries, a2.db["Class"][:unicode].bytes.entries
+      end
+    end
+  end
+end

data/spec/fixtures.yml

@@ -0,0 +1,18 @@
+---
+Person:
+  moe@3stooges.com:
+      :name: Moe Howard
+      :email: moe@3stooges.com
+  shemp@3stooges.com:
+      :name: Shemp Howard
+      :email: shemp@3stooges.com
+  curly@3stooges.com:
+      :name: Curly Howard
+      :email: curly@3stooges.com
+  larry@3stooges.com:
+      :name: Larry Fine
+      :email: larry@3stooges.com
+"MyModule::Animal":
+  Canis Familaris:
+    :species: Canis Familaris
+    :common_name: Dog

data/spec/key_set_spec.rb

@@ -0,0 +1,104 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Norman::AbstractKeySet do
+
+  before { load_fixtures }
+  after  { Norman.adapters.clear }
+
+  describe "#+" do
+    it "should add two key sets" do
+      key_set = Person.find {|p| p.name =~ /Curly/} + Person.find {|p| p.name =~ /Larry/}
+      assert_equal 2, key_set.length
+    end
+
+    it "should not duplicate entries" do
+      key_set = Person.find {|p| p.name =~ /Curly/} + Person.find {|p| p.name =~ /Curly/}
+      assert_equal 1, key_set.length
+    end
+  end
+
+  describe "#-" do
+    it "should subtract a key set" do
+      a = Person.find
+      b = Person.find {|p| p.name =~ /Larry|Ted/}
+      key_set = a - b
+      assert_equal 3, key_set.length
+    end
+  end
+
+  describe "#&" do
+    it "should get set intersection" do
+      key_set = Person.find & Person.find {|p| p.name =~ /Larry/}
+      assert_equal 1, key_set.length
+    end
+  end
+
+  describe "#first" do
+    it "should return the first matching instance when called with a block" do
+      assert_equal "Curly Howard", Person.first {|p| p.name =~ /Curly/}.name
+    end
+
+    it "should return the first instance when not called with a block" do
+      assert_kind_of Person, Person.first
+    end
+  end
+
+  describe "#count" do
+    it "should count matching instances when called with a block" do
+      assert_equal 3, Person.count {|p| p.name =~ /Howard/}
+    end
+
+    it "should count all keys when called without a block" do
+      assert_equal 4, Person.count
+    end
+  end
+
+  describe "#find" do
+    it "should return a KeySet of matching keys when called with a block" do
+      key_set = Person.find {|p| p.name =~ /Larry/}
+      assert_kind_of Norman::AbstractKeySet, key_set
+      assert_equal 1, key_set.size
+    end
+
+    it "should return a KeySet of all keys when called with no block" do
+      assert_equal 4, Person.find.size
+    end
+
+    it "should yield an instance of HashProxy to the block" do
+      Person.find {|x| assert_kind_of Norman::HashProxy, x}
+    end
+
+    it "should be chainable" do
+      assert_equal "Larry Fine", Person.stooges.non_howards.first.name
+    end
+
+    it "should raise error when trying to chain nonexistant method" do
+      assert_raises NoMethodError do
+        Person.stooges.foobar
+      end
+    end
+  end
+
+  describe "#find_by_key" do
+    it "should yield a key to the block" do
+      Person.find_by_key {|x| assert_kind_of String, x}
+    end
+
+    it "should return a KeySet of all keys when called with no block" do
+      assert_equal 4, Person.find_by_key.size
+    end
+  end
+
+  describe "#sort" do
+    it "should sort" do
+      assert_equal "Curly Howard", Person.find.sort {|a, b| a.name <=> b.name}.first.name
+      assert_equal "Shemp Howard", Person.find.sort {|b, a| a.name <=> b.name}.first.name
+    end
+  end
+
+  describe "#limit" do
+    it "should limit" do
+      assert_equal 2, Person.find.limit(2).count
+    end
+  end
+end