norman 0.1.0

data/spec/mapper_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+MockAdapter = Struct.new(:db)
+
+class Value
+  extend Norman::Model
+  field :a
+end
+
+describe Norman::Mapper do
+
+  describe "#initialize" do
+
+    before do
+      Norman.adapters.clear
+      @adapter = Norman::Adapter.new
+    end
+
+    after do
+      Norman.adapters.clear
+    end
+
+    it "should set default adapter name if unspecified" do
+      mapper = Norman::Mapper.new "Class"
+      assert_equal Norman.default_adapter_name, mapper.adapter_name
+    end
+
+    it "should set adapter name if unspecified" do
+      Norman::Adapter.new :name => :hello
+      mapper = Norman::Mapper.new "Class", :hello
+      assert_equal :hello, mapper.adapter_name
+    end
+  end
+
+  describe "hash operations" do
+
+    before { load_fixtures }
+    after  { Norman.adapters.clear }
+
+    describe "#hash" do
+      it "should get a hash corresponding to the mapped class" do
+        assert_equal Person.mapper.adapter.db["Person"], Person.mapper.hash
+      end
+    end
+
+    describe "#[]" do
+      it "should return an attributes hash" do
+        assert_kind_of Hash, Person.mapper["moe@3stooges.com"]
+      end
+
+      it "should raise NotFoundError if key doesn't exist" do
+        assert_raises Norman::NotFoundError do
+          Person.mapper["BADKEY"]
+        end
+      end
+    end
+
+    describe "#[]=" do
+      it "should return the value" do
+        value = Person.mapper[:a] = Value.new(:a => "b")
+        assert_equal "b", value.a
+      end
+
+      it "should set value#to_hash as value for key" do
+        value = Person.mapper[:bogus] = Value.new(:a => "b")
+        assert_equal "b", Person.mapper[:bogus][:a]
+      end
+
+      it "should freeze the value" do
+        value = Person.mapper[:bogus] = Value.new(:a => "b")
+        assert Person.mapper[:bogus].frozen?
+      end
+    end
+
+    describe "#get" do
+      it "should return a model instance" do
+        assert_kind_of Person, Person.mapper.get("moe@3stooges.com")
+      end
+    end
+
+    describe "#key_set" do
+      it "should return a Norman::KeySet with all keys" do
+        ks = Person.mapper.key_set
+        assert_kind_of Norman::AbstractKeySet, ks
+        assert_equal Person.count, ks.count
+      end
+    end
+
+    describe "#put" do
+      it "should add to hash and return the value" do
+        instance = Value.new(:a => "b")
+        assert value = Value.mapper.put(instance)
+        assert_equal instance, value
+      end
+    end
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,162 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+describe Norman::Model do
+
+  before { load_fixtures }
+  after  { Norman.adapters.clear }
+
+  describe "#initialize" do
+
+    it "can be called with no arguments" do
+      assert Person.new
+    end
+
+    it "can be called with a block" do
+      p = Person.new do |person|
+        person.name = "joe"
+      end
+      assert_equal "joe", p.name
+    end
+
+    it "can be called with attributes and a block" do
+      assert Person.new(:name => "foo") {|p| p.name = "bar"}
+    end
+
+    it "calls the block after setting sttributes" do
+      p = Person.new(:name => "foo") {|p| p.name = "bar"}
+      assert_equal "bar", p.name
+    end
+
+    it "can set attributes from a hash" do
+      p = Person.new :name => "joe"
+      assert_equal "joe", p.name
+    end
+
+    # This means your custom accessors will be invoked.
+    it "invokes attr writers" do
+      Person.any_instance.expects(:name=).once
+      Person.new(:name => "joe")
+    end
+
+    # Don't loop through params that potentially came from the Internet,
+    # because we need to cast keys to Symbol, and that could leak memory.
+    it "iterates over attribute names, not params" do
+      Person.attribute_names.expects(:each)
+      Person.new(:name => "joe")
+    end
+  end
+
+  describe ".mapper" do
+    it "lazy-loads mapper if it's not set" do
+      Person.instance_variable_set :@mapper, nil
+      assert Person.mapper
+    end
+  end
+
+  describe ".use" do
+    it "sets a new mapper for the specified adapter" do
+      Person.instance_variable_set :@mapper, nil
+      Person.use :main
+      refute_nil Person.mapper
+    end
+  end
+
+  describe ".create" do
+    it "should add an instance to the database" do
+      Person.create(:name => "Ted Healy", :email => "ted@3stooges.com")
+      assert_equal "Ted Healy", Person.get("ted@3stooges.com").name
+    end
+  end
+
+
+  describe "an attribute reader" do
+    it "reads (first) from an instance var" do
+      p = Person.first
+      p.instance_variable_set :@name, "foo"
+      p.instance_variable_set :@attributes, nil
+      assert_equal "foo", p.name
+    end
+
+    # This also provides an easy way to check if a model instance has been
+    # edited. However most of the time we don't need this because Norman is
+    # not intended for frequent writes.
+    it "reads (second) from an attribute array" do
+      p = Person.first
+      assert_nil p.instance_variable_get :@name
+      refute_nil p.instance_variable_get :@attributes
+      refute_nil p.name
+    end
+  end
+
+  describe "an attribute writer" do
+
+    # The attributes hash is never written to, only replaced.
+    it "only sets instance vars" do
+      p = Person.first
+      p.name = "foo"
+      assert_equal "foo", p.instance_variable_get(:@name)
+      refute_equal "foo", p.instance_variable_get(:@attributes)[:name]
+    end
+  end
+
+  describe "#==" do
+    it "returns true if the class and id are the same" do
+      p = Person.first
+      p2 = Person.new(:email => p.email)
+      assert_equal p, p2
+    end
+  end
+
+  describe "#to_hash" do
+    it "returns a hash of the model's attributes" do
+      p = Person.new(:name => "joe")
+      assert_equal "joe", p.to_hash[:name]
+    end
+  end
+
+  describe "#to_id" do
+    it "returns the key attribute" do
+      p = Person.first
+      assert_equal p.email, p.to_id
+    end
+  end
+
+  describe "#id_changed?" do
+    it "should be true if the id changed" do
+      p = Person.get("moe@3stooges.com")
+      refute p.id_changed?
+    end
+
+    it "should be false if the id didn't change" do
+      p = Person.get("moe@3stooges.com")
+      p.email = "moe2@3stooges.com"
+      assert p.id_changed?
+    end
+  end
+
+  describe "#update" do
+    it "updates the database" do
+      p = Person.get("moe@3stooges.com")
+      original = p.name
+      p.update(:name => "Joe Schmoe")
+      p = Person.get("moe@3stooges.com")
+      refute_equal original, p.name
+    end
+
+    it "should allow updating the key" do
+      count = Person.count
+      p = Person.get("moe@3stooges.com")
+      p.update(:email => "moe2@3stooges.com")
+      assert_equal count, Person.count
+    end
+
+  end
+
+  describe "#save" do
+    it "passes itself to Mapper#put" do
+      p = Person.new(:name => "hello")
+      Person.mapper.expects(:put)
+      p.save
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+if ENV["coverage"]
+  require "simplecov"
+  SimpleCov.start
+end
+require "rubygems"
+require "bundler/setup"
+require "norman"
+require "norman/adapters/yaml"
+require 'minitest/spec'
+require "mocha"
+require "fileutils"
+require "ffaker"
+
+class Person
+  extend Norman::Model
+  field :email, :name
+
+  def self.stooges
+    with_index do
+      find_by_key {|k| k =~ /3stooges.com/}
+    end
+  end
+
+  filters do
+    def non_howards
+      find {|p| p[:name] !~ /Howard/}
+    end
+  end
+end
+
+def load_fixtures
+  Norman.adapters.clear
+  file = File.expand_path("../fixtures.yml", __FILE__)
+  Norman::Adapters::YAML.new :file => file
+  Person.use :main
+end
+
+MiniTest::Unit.autorun

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: norman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Norman Clarke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-17 00:00:00.000000000 -03:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: &70174904768720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174904768720
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70174904768080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70174904768080
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70174904767520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174904767520
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70174904766420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174904766420
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70174904765540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70174904765540
+description: ! "    Norman is not an ORM, man! It's a database and ORM replacement
+  for (mostly)\n    static models and small datasets. It provides ActiveModel compatibility,
+  and\n    flexible searching and storage.\n"
+email: norman@njclarke.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Changelog.md
+- Gemfile
+- Guide.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- extras/bench.rb
+- extras/cookie_demo.rb
+- extras/countries.rb
+- lib/generators/norman_generator.rb
+- lib/norman.rb
+- lib/norman/abstract_key_set.rb
+- lib/norman/active_model.rb
+- lib/norman/adapter.rb
+- lib/norman/adapters/cookie.rb
+- lib/norman/adapters/file.rb
+- lib/norman/adapters/yaml.rb
+- lib/norman/hash_proxy.rb
+- lib/norman/mapper.rb
+- lib/norman/model.rb
+- lib/norman/version.rb
+- lib/rack/norman.rb
+- norman.gemspec
+- spec/active_model_spec.rb
+- spec/adapter_spec.rb
+- spec/cookie_adapter_spec.rb
+- spec/file_adapter_spec.rb
+- spec/fixtures.yml
+- spec/key_set_spec.rb
+- spec/mapper_spec.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/norman/norman
+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: ! '[none]'
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An ActiveModel-compatible ORM-like library for storing model instances in
+  an in-memory Hash.
+test_files: []