document_mapper 0.1.0 → 0.1.1

data/README.textile

@@ -89,11 +89,12 @@ Not all of the documents in the directory need to have all of the attributes. Yo
 
 The document queries do support more operators than just equality. The following operators are available:
 
-<pre><code>MyDocument.where(:year.gt => 2010)
-MyDocument.where(:year.gte => 2010)
-MyDocument.where(:year.in => [2010,2011])
-MyDocument.where(:year.lt => 2010)
-MyDocument.where(:year.lte => 2010)
+<pre><code>MyDocument.where(:year.gt => 2010)        # year > 2010
+MyDocument.where(:year.gte => 2010)       # year >= 2010
+MyDocument.where(:year.in => [2010,2011]) # year one of [2010,2011]
+MyDocument.where(:tags.include => 'ruby') # 'ruby' is included in tags = ['ruby', 'rails', ...]
+MyDocument.where(:year.lt => 2010)        # year < 2010
+MyDocument.where(:year.lte => 2010)       # year <= 2010
 </code></pre>
 
 

data/lib/document_mapper/attribute_methods.rb

@@ -10,14 +10,8 @@ module DocumentMapper
 
       module ClassMethods
         def define_read_method(attr_name)
-          access_code = "attributes['#{attr_name}']"
+          access_code = "attributes[:#{attr_name}]"
           generated_attribute_methods.module_eval("def #{attr_name}; #{access_code}; end", __FILE__, __LINE__)
-
-          %w(year month day).each do |attr_name|
-            access_code = "date.#{attr_name} if date"
-            generated_attribute_methods.module_eval("def #{attr_name}; #{access_code}; end", __FILE__, __LINE__)
-          end
-
         end
       end
     end

data/lib/document_mapper/constants.rb

@@ -1,12 +1,13 @@
 module DocumentMapper
-  REVERSE_OPERATOR_MAPPING = {
-    'equal' => :==,
-    'gt'    => :<,
-    'gte'   => :<=,
-    'in'    => :include?,
-    'lt'    => :>,
-    'lte'   => :>=
+  OPERATOR_MAPPING = {
+    'equal'   => :==,
+    'gt'      => :>,
+    'gte'     => :>=,
+    'in'      => :in?,
+    'include' => :include?,
+    'lt'      => :<,
+    'lte'     => :<=
   }
 
-  VALID_OPERATORS = REVERSE_OPERATOR_MAPPING.keys
+  VALID_OPERATORS = OPERATOR_MAPPING.keys
 end

data/lib/document_mapper/core_ext/object.rb

@@ -0,0 +1,18 @@
+# Backported from ActiveSupport 3.1. Should be removed once the 3.1
+# version is out.
+
+class Object
+  # Returns true if this object is included in the argument. Argument must be
+  # any object which responds to +#include?+. Usage:
+  #
+  #   characters = ["Konata", "Kagami", "Tsukasa"]
+  #   "Konata".in?(characters) # => true
+  #
+  # This will throw an ArgumentError if the argument doesn't respond
+  # to +#include?+.
+  def in?(another_object)
+    another_object.include?(self)
+  rescue NoMethodError
+    raise ArgumentError.new("The parameter passed to #in? must respond to #include?")
+  end
+end

data/lib/document_mapper/core_ext/symbol.rb

@@ -2,7 +2,7 @@ class Symbol
   DocumentMapper::VALID_OPERATORS.each do |operator|
     class_eval <<-OPERATORS
       def #{operator}
-        Selector.new(:attribute => self, :operator => '#{operator}')
+        DocumentMapper::Selector.new(:attribute => self, :operator => '#{operator}')
       end
     OPERATORS
   end

data/lib/document_mapper/document.rb

@@ -7,7 +7,7 @@ module DocumentMapper
     include AttributeMethods::Read
     include YamlParsing
 
-    attr_accessor :attributes, :content, :directory, :file_path
+    attr_accessor :attributes, :content, :directory
 
     included do
       @@documents = []
@@ -33,7 +33,9 @@ module DocumentMapper
           raise FileNotFoundError
         end
         self.new.tap do |document|
-          document.file_path = File.expand_path(file_path)
+          document.attributes = {
+            :file_path => File.expand_path(file_path)
+          }
           document.read_yaml
           @@documents << document
         end
@@ -53,10 +55,10 @@ module DocumentMapper
         documents = @@documents.dup
         options[:where].each do |selector, selector_value|
           documents.select! do |document|
-            next unless document.respond_to? selector.attribute
+            next unless document.attributes.has_key? selector.attribute
             document_value = document.send(selector.attribute)
-            operator = REVERSE_OPERATOR_MAPPING[selector.operator]
-            selector_value.send operator, document_value
+            operator = OPERATOR_MAPPING[selector.operator]
+            document_value.send operator, selector_value
           end
         end
         documents

data/lib/document_mapper/version.rb

@@ -1,3 +1,3 @@
 module DocumentMapper
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/document_mapper/yaml_parsing.rb

@@ -1,22 +1,37 @@
 module DocumentMapper
   module YamlParsing
     def read_yaml
+      file_path = self.attributes[:file_path]
       @content = File.read(file_path)
 
       if @content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
         @content = @content[($1.size + $2.size)..-1]
-        self.attributes = YAML.load($1)
+        self.attributes.update(YAML.load($1).symbolize_keys)
       end
 
-      self.attributes ||= {}
-      if !self.attributes.has_key? 'date'
+      file_name = File.basename(file_path)
+      extension = File.extname(file_path)
+      self.attributes.update({
+        :file_name => file_name,
+        :extension => extension.sub(/^\./, ''),
+        :file_name_without_extension => File.basename(file_path, extension)
+      })
+
+      if !self.attributes.has_key? :date
         begin
-          match = File.basename(@file_path).match(/(\d{4})-(\d{1,2})-(\d{1,2}).*/)
-          self.attributes['date'] = Date.new(match[1].to_i, match[2].to_i, match[3].to_i)
+          match = attributes[:file_name].match(/(\d{4})-(\d{1,2})-(\d{1,2}).*/)
+          year, month, day = match[1].to_i, match[2].to_i, match[3].to_i
+          self.attributes[:date] = Date.new(year, month, day)
         rescue NoMethodError => err
         end
       end
 
+      if self.attributes.has_key? :date
+        self.attributes[:year] = self.attributes[:date].year
+        self.attributes[:month] = self.attributes[:date].month
+        self.attributes[:day] = self.attributes[:date].day
+      end
+
       self.class.define_attribute_methods self.attributes.keys
       self.attributes.keys.each { |attr| self.class.define_read_method attr }
     end

data/lib/document_mapper.rb

@@ -11,4 +11,5 @@ require 'document_mapper/query'
 require 'document_mapper/selector'
 require 'document_mapper/version'
 
+require 'document_mapper/core_ext/object'
 require 'document_mapper/core_ext/symbol'

data/test/document_mapper/document_mapper_test.rb

@@ -13,10 +13,10 @@ describe MyDocument do
     end
 
     it 'should load the document from a yaml file' do
-      assert_equal 1, @document.attributes['id']
-      assert_equal 'Some fancy title', @document.attributes['title']
-      assert_equal ['ruby'], @document.attributes['tags']
-      assert_equal :published, @document.attributes['status']
+      assert_equal 1, @document.attributes[:id]
+      assert_equal 'Some fancy title', @document.attributes[:title]
+      assert_equal ['ruby'], @document.attributes[:tags]
+      assert_equal :published, @document.attributes[:status]
     end
 
     it 'should specify attributes from the YAML header' do
@@ -24,9 +24,26 @@ describe MyDocument do
       assert_equal 'Some fancy title', @document.title
       assert_equal ['ruby'], @document.tags
       assert_equal :published, @document.status
+    end
+
+    it 'should return the file path' do
       assert_equal File.expand_path(@file_path), @document.file_path
     end
 
+    it 'should return the file name' do
+      expected_name = '2010-08-08-test-document-file.textile'
+      assert_equal expected_name, @document.file_name
+    end
+
+    it 'should return the file name without extension' do
+      expected_name = '2010-08-08-test-document-file'
+      assert_equal expected_name, @document.file_name_without_extension
+    end
+
+    it 'should return the extension' do
+      assert_equal 'textile', @document.extension
+    end
+
     describe 'specifying the date of the document' do
       it 'should get the date from the filename' do
         assert_equal '2010-08-08', @document.date.to_s
@@ -131,6 +148,19 @@ describe MyDocument do
         assert_equal @document_1, document_proxy.first
       end
 
+      it 'should work with file names without extensions' do
+        file_name = '2010-08-08-test-document-file'
+        selector_hash = { :file_name_without_extension => file_name }
+        found_document = MyDocument.where(selector_hash).first
+        assert_equal sample_document_1, found_document
+      end
+
+      it 'should work with file names' do
+        file_name = '2010-08-08-test-document-file.textile'
+        found_document = MyDocument.where(:file_name => file_name).first
+        assert_equal sample_document_1, found_document
+      end
+
       it 'should work with dates' do
         found_documents = MyDocument.where(:year => 2010).all
         expected_documents = [sample_document_1, sample_document_2]
@@ -146,7 +176,7 @@ describe MyDocument do
 
     describe 'with a gt operator' do
       it 'should return the right documents' do
-        selector = Selector.new :attribute => 'id', :operator => 'gt'
+        selector = Selector.new :attribute => :id, :operator => 'gt'
         found_documents = MyDocument.where(selector => 2).all
         assert_equal [3,4], found_documents.map(&:id)
       end
@@ -154,7 +184,7 @@ describe MyDocument do
 
     describe 'with a gte operator' do
       it 'should return the right documents' do
-        selector = Selector.new :attribute => 'id', :operator => 'gte'
+        selector = Selector.new :attribute => :id, :operator => 'gte'
         found_documents = MyDocument.where(selector => 2).all
         assert_equal [2,3,4], found_documents.map(&:id)
       end
@@ -162,7 +192,7 @@ describe MyDocument do
 
     describe 'with an in operator' do
       it 'should return the right documents' do
-        selector = Selector.new :attribute => 'id', :operator => 'in'
+        selector = Selector.new :attribute => :id, :operator => 'in'
         found_documents = MyDocument.where(selector => [2,3]).all
         assert_equal [2,3], found_documents.map(&:id)
       end
@@ -170,7 +200,7 @@ describe MyDocument do
 
     describe 'with an lt operator' do
       it 'should return the right documents' do
-        selector = Selector.new :attribute => 'id', :operator => 'lt'
+        selector = Selector.new :attribute => :id, :operator => 'lt'
         found_documents = MyDocument.where(selector => 2).all
         assert_equal [1], found_documents.map(&:id)
       end
@@ -178,16 +208,24 @@ describe MyDocument do
 
     describe 'with an lte operator' do
       it 'should return the right documents' do
-        selector = Selector.new :attribute => 'id', :operator => 'lte'
+        selector = Selector.new :attribute => :id, :operator => 'lte'
         found_documents = MyDocument.where(selector => 2).all
         assert_equal [1,2], found_documents.map(&:id)
       end
     end
 
+    describe 'with an include operator' do
+      it 'include should return the right documents' do
+        selector = Selector.new :attribute => :tags, :operator => 'include'
+        found_documents = MyDocument.where(selector => 'ruby').all
+        assert_equal [1,2], found_documents.map(&:id)
+      end
+    end
+
     describe 'with mixed operators' do
       it 'should return the right documents' do
-        in_selector = Selector.new :attribute => 'id', :operator => 'in'
-        gt_selector = Selector.new :attribute => 'id', :operator => 'gt'
+        in_selector = Selector.new :attribute => :id, :operator => 'in'
+        gt_selector = Selector.new :attribute => :id, :operator => 'gt'
         documents_proxy = MyDocument.where(in_selector => [2,3])
         found_documents = documents_proxy.where(gt_selector => 2).all
         assert_equal [3], found_documents.map(&:id)
@@ -196,7 +234,7 @@ describe MyDocument do
 
     describe 'using multiple constrains in one where' do
       it 'should return the right documents' do
-        selector = Selector.new :attribute => 'id', :operator => 'lte'
+        selector = Selector.new :attribute => :id, :operator => 'lte'
         found_documents = MyDocument.where(selector => 2, :status => :published).all
         assert_equal [1,2], found_documents.map(&:id)
       end

data/test/document_mapper/selector_test.rb

@@ -3,14 +3,14 @@ include DocumentMapper
 
 describe Selector do
   it 'should initialize with an attribute and an operator' do
-    selector = Selector.new :attribute => 'author', :operator => 'equal'
-    assert_equal 'author', selector.attribute
+    selector = Selector.new :attribute => :author, :operator => 'equal'
+    assert_equal :author, selector.attribute
     assert_equal 'equal', selector.operator
   end
 
   it 'should raise an exception if the operator is not supported' do
     assert_raises OperatorNotSupportedError do
-      selector = Selector.new :attribute => 'author', :operator => 'zomg'
+      selector = Selector.new :attribute => :author, :operator => 'zomg'
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: document_mapper
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ralph von der Heyden
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-30 00:00:00 Z
+date: 2011-05-02 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -47,6 +47,7 @@ files:
 - README.textile
 - lib/document_mapper/attribute_methods.rb
 - lib/document_mapper/constants.rb
+- lib/document_mapper/core_ext/object.rb
 - lib/document_mapper/core_ext/symbol.rb
 - lib/document_mapper/document.rb
 - lib/document_mapper/errors.rb