matic 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+= 0.2.0
+
+* Changed Matic.field to Matic.fields
+* Added support for short field names
+
 = 0.1.0
 
 * Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    matic (0.1.1)
+    matic (0.2.0)
       activemodel (~> 3.0.0)
       activesupport (~> 3.0.0)
       mongomatic (~> 0.6.0)

data/README.md

@@ -1,31 +1,54 @@
 # Matic
 
-Matic adds attribute accessors and dirty tracking to Mongomatic.
+Matic adds attribute accessors and dirty tracking to Mongomatic and
+optionally shortens field names to optimize storing and indexing.
 
 ## Examples
 
     class Person < Mongomatic::Base
       include Matic
 
-      field :name
+      fields :first_name,
+             :last_name
     end
 
     person = Person.new
-    person.name = "John Doe"
+    person.first_name = "John"
 
-    person.name_changed?
+    person.first_name_changed?
     => true
 
-    person.changes["name"]
-    => [nil, "John Doe"]
+    person.changes["first_name"]
+    => [nil, "John"]
 
     person.insert
 
-    person.name_changed?
+    person.first_name_changed?
     => false
 
-    person.changes["name"]
+    person.changes["first_name"]
     => nil
 
-    person.previous_changes["name"]
-    => [nil, "John Doe"]
+    person.previous_changes["first_name"]
+    => [nil, "John"]
+
+This is a model with short field names:
+
+    class Person < Mongomatic::Base
+      include Matic
+
+      fields :first_name => 'f',
+             :last_name  => 'l'
+
+    end
+
+    person = Person.new
+
+    person.first_name = "John"
+    person.last_name = "Doe"
+
+    person.insert
+    => #<Person:0x000001023cea30
+     @doc=
+      {"f"=>"John", "l" => "Doe", "_id"=>BSON::ObjectId('4cdd1b0c6aa2b112e1000001')}
+     ...>

data/lib/matic.rb

@@ -9,33 +9,31 @@ module Matic
       self.name.tableize
     end
 
-    def field(attr_name)
-      generate_attribute_methods(attr_name)
+    def fields(*attrs)
+      if attrs.first.is_a? Hash
+        attrs.first.each { |k, v| define_accessor(k, v) }
+        define_attribute_methods(attrs.first.keys)
+      else
+        attrs.each { |k, v| define_accessor(k, v) }
+        define_attribute_methods(attrs)
+      end
+    end
+
+    private
+
+    def define_accessor(attr_name, attr_field=nil)
+      attr_field ||= attr_name
 
       define_method(attr_name) do
-        self[attr_name.to_s]
+        self[attr_field.to_s]
       end
 
       define_method("#{attr_name}=") do |val|
-        unless val == self[attr_name.to_s]
+        unless val == self[attr_field.to_s]
           eval("#{attr_name}_will_change!")
         end
 
-        self[attr_name.to_s] = val
-      end
-    end
-
-    private
-
-    def generate_attribute_methods(attr_name)
-      attribute_method_matchers.each do |matcher|
-        method_name = matcher.method_name(attr_name)
-
-        generated_attribute_methods.module_eval <<-STR, __FILE__, __LINE__ + 1
-          def #{method_name}(*args)
-            send(:#{matcher.method_missing_target}, '#{attr_name}', *args)
-          end
-        STR
+        self[attr_field.to_s] = val
       end
     end
   end
@@ -44,18 +42,10 @@ module Matic
     clear_changes if super
   end
 
-  def insert!(opts={})
-    insert(opts.merge(:safe => true))
-  end
-
   def update(opts={}, update_doc=@doc)
     clear_changes if super
   end
 
-  def update!(opts={}, update_doc=@doc)
-    update(opts.merge(:safe => true), update_doc)
-  end
-
   def save
     is_new ? insert : update
   end

data/lib/matic/version.rb

@@ -1,3 +1,3 @@
 module Matic
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/spec/matic_spec.rb

@@ -1,137 +1,184 @@
 require "spec_helper"
 
-describe "A matic model" do
+describe "a mongomatic model that includes matic" do
 
   let(:person) { Person.new }
+  let(:book) { Book.new }
 
   it "has a collection first_name" do
     person.class.collection_name.should eql "people"
   end
 
-  describe ".field" do
-    it "defines a getter" do
-      person["first_name"] = "John"
+  describe ".fields" do
 
-      person.first_name.should eql "John"
-      lambda { person.foo }.should raise_error NoMethodError
-    end
+    context "when it is passed an array" do
 
-    it "defines a setter" do
-      person.first_name = "John"
+      it "defines a getter" do
+        person["first_name"] = "John"
 
-      person["first_name"].should eql "John"
-      lambda { person.foo= "bar" }.should raise_error NoMethodError
-    end
-  end
+        person.first_name.should eql "John"
+        lambda { person.foo }.should raise_error NoMethodError
+      end
+
+      it "defines a setter" do
+        person.first_name = "John"
 
-  context "dirty tracking" do
+        person["first_name"].should eql "John"
+        lambda { person.foo= "bar" }.should raise_error NoMethodError
+      end
+
+    end
 
-    shared_examples_for "a dirty-tracking command" do
+    context "when it is passed a hash" do
 
-      it "marks a current change as previous" do
-        person.first_name_changed?.should be_false
-        person.previous_changes["first_name"].should eql [nil, "John"]
+      it "defines a getter" do
+        book["i"] = "9780485113358"
+        book.isbn.should eql "9780485113358"
 
-        person.last_name_changed?.should be_false
-        person.previous_changes["last_name"].should eql [nil, "Doe"]
+        book["a"] = ["Gilles Deleuze"]
+        book.authors.should eql ["Gilles Deleuze"]
       end
 
-      it "does callbacks" do
-        person.instance_variable_get(:@called_back).should be_true
+      it "defines a setter" do
+        book.isbn = "9780485113358"
+        book["i"].should eql "9780485113358"
+
+        book.authors = ["Gilles Deleuze"]
+        book["a"].should eql ["Gilles Deleuze"]
       end
 
+      it "stores documents with short field names" do
+        book.isbn = "9780485113358"
+        book.insert
+
+        book.instance_variable_get(:@doc).should have_key 'i'
+      end
     end
 
-    shared_examples_for "a dirty object" do
+  end
 
-      it "tells if an attribute changed" do
-        person.first_name_changed?.should be_true
-        person.last_name_changed?.should be_true
-      end
+  shared_examples_for "a dirty-tracking command" do
 
-      it "remembers changes to an attribute" do
-        person.changes["first_name"].should eql [nil, "John"]
-        person.changes["last_name"].should eql [nil, "Doe"]
-      end
+    it "marks a current change as previous" do
+      person.first_name_changed?.should be_false
+      person.previous_changes["first_name"].should eql [nil, "John"]
 
+      person.last_name_changed?.should be_false
+      person.previous_changes["last_name"].should eql [nil, "Doe"]
     end
 
-    context "when object is new" do
+    it "does callbacks" do
+      person.instance_variable_get(:@called_back).should be_true
+    end
 
-      before do
-        person.first_name = "John"
-        person.last_name = "Doe"
-      end
+  end
+
+  describe "a dirty-tracking setter" do
 
-      it_behaves_like "a dirty object"
+    context "when an attribute is set" do
 
-      describe "#insert" do
+      context "and its value has changed" do
 
-        before { person.insert }
+        before do
+          person.first_name = "John"
+        end
 
-        it_behaves_like "a dirty-tracking command"
+        it "marks the attribute as changed" do
+          person.first_name_changed?.should be_true
+        end
+
+        it "remembers changes to the attribute" do
+          person.changes["first_name"].should eql [nil, "John"]
+        end
 
       end
 
-      describe "#insert!" do
+      context "and its value has not changed" do
 
-        before { person.insert! }
+        before do
+          person.first_name = nil
+        end
 
-        it_behaves_like "a dirty-tracking command"
+        it "does not mark the attribute as changed" do
+          person.first_name_changed?.should be_false
+        end
 
       end
 
-      describe "#save" do
+    end
 
-        before { person.save }
+  end
 
-        it_behaves_like "a dirty-tracking command"
+  context "when object is new" do
 
-      end
+    before do
+      person.first_name = "John"
+      person.last_name = "Doe"
+    end
+
+    describe "#insert" do
+
+      before { person.insert }
+
+      it_behaves_like "a dirty-tracking command"
 
     end
 
-    context "when object is not new" do
+    describe "#insert!" do
 
-      before do
-        person.insert
-        person.instance_variable_set(:@called_back, false)
-        person.first_name = "John"
-        person.last_name = "Doe"
-      end
+      before { person.insert! }
 
-      it_behaves_like "a dirty object"
+      it_behaves_like "a dirty-tracking command"
 
-      describe "#update" do
+    end
 
-        before { person.update }
+    describe "#save" do
 
-        it_behaves_like "a dirty-tracking command"
+      before { person.save }
 
-      end
+      it_behaves_like "a dirty-tracking command"
 
-      describe "#update!" do
+    end
 
-        before { person.update! }
+  end
 
-        it_behaves_like "a dirty-tracking command"
+  context "when object is not new" do
 
-      end
+    before do
+      person.insert
+      person.instance_variable_set(:@called_back, false)
+      person.first_name = "John"
+      person.last_name = "Doe"
+    end
+
+    describe "#update" do
+
+      before { person.update }
+
+      it_behaves_like "a dirty-tracking command"
 
     end
 
-    context "when object is not valid" do
+    describe "#update!" do
 
-      before do
-        person.stub!(:valid?).and_return(false)
-        person.first_name = "John"
-      end
+      before { person.update! }
 
-      it "does not clear changes" do
-        person.save
-        person.first_name_changed?.should be_true
-      end
+      it_behaves_like "a dirty-tracking command"
+
+    end
+
+  end
+
+  context "when an invalid object is saved" do
+
+    before do
+      person.stub!(:valid?).and_return(false)
+      person.first_name = "John"
+    end
 
+    it "does not clear changes" do
+      person.save
+      person.first_name_changed?.should be_true
     end
 
   end

data/spec/models/book.rb

@@ -0,0 +1,8 @@
+class Book < Mongomatic::Base
+  include Matic
+
+  fields :title     => 't',
+         :authors   => 'a',
+         :publisher => 'p',
+         :isbn      => 'i'
+end

data/spec/models/person.rb

@@ -1,8 +1,8 @@
 class Person < Mongomatic::Base
   include Matic
 
-  field :first_name
-  field :last_name
+  fields :first_name,
+         :last_name
 
   private
 

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hakan Ensari
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-11 00:00:00 +00:00
+date: 2010-11-12 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,6 +130,7 @@ files:
 - lib/matic/version.rb
 - matic.gemspec
 - spec/matic_spec.rb
+- spec/models/book.rb
 - spec/models/person.rb
 - spec/spec_helper.rb
 - spec/support/mongomatic.rb
@@ -168,6 +169,7 @@ specification_version: 3
 summary: Mongomatic with attribute accessors and dirty tracking
 test_files: 
 - spec/matic_spec.rb
+- spec/models/book.rb
 - spec/models/person.rb
 - spec/spec_helper.rb
 - spec/support/mongomatic.rb