plain_record 0.2 → 0.3

data/.travis.yml

@@ -3,4 +3,3 @@ rvm:
   - 1.8.7
   - ruby-head
   - jruby-18mode
-  - rbx-18mode

data/ChangeLog

@@ -1,3 +1,14 @@
+== 0.3 (Chlorine)
+* Use modules to use super in filters.
+* Add filter to i18n support.
+* Add filters to get updated and created time from git.
+* Add filters to set field type.
+* Add filter to set default field value.
+* Add alternate hash syntax to define filters.
+* Set deault data root in Rails project.
+* Fix association cache.
+* Allow to set Pathname in data root.
+
 == 0.2 (Smallpox)
 * Add associations.
 * Add special syntax for virtual properties.

data/Gemfile

@@ -4,3 +4,5 @@ gem 'rake'
 gem 'yard'
 gem 'rspec'
 gem 'redcarpet'
+gem 'r18n-core', :require => nil, :github => 'ai/r18n'
+gem 'i18n',      :require => nil

data/Gemfile.lock

@@ -1,14 +1,21 @@
+GIT
+  remote: git://github.com/ai/r18n.git
+  revision: ca6933926eb955344eeb982de35f492c76a38b1a
+  specs:
+    r18n-core (0.4.14)
+
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    i18n (0.6.0)
     rake (0.9.2.2)
     redcarpet (2.1.1)
     rspec (2.10.0)
       rspec-core (~> 2.10.0)
       rspec-expectations (~> 2.10.0)
       rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.0)
+    rspec-core (2.10.1)
     rspec-expectations (2.10.0)
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.10.1)
@@ -18,6 +25,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  i18n
+  r18n-core!
   rake
   redcarpet
   rspec

data/README.md

@@ -6,6 +6,10 @@ text files. It’s ideal for static generated sites, like blog or homepage.
 If you want to write another static website generator, you don’t need to write
 another file parser – you can use Plain Record.
 
+Sponsored by [Evil Martians].
+
+[Evil Martians]: http://evilmartians.com/
+
 ## How To
 
 For example we will create simple blog storage with posts and comments.
@@ -23,7 +27,7 @@ For example we will create simple blog storage with posts and comments.
      ```
 
 3. Create Post class, include `Plain::Resource` module, set glob pattern
-   to posts files and define properties:
+   to posts files and define fields:
 
      ```ruby
     class Post
@@ -31,16 +35,17 @@ For example we will create simple blog storage with posts and comments.
 
       entry_in '*/post.md'
 
-      virtual  :name,     in_filepath(1)
-      virtual  :comments, many(Comment)
-      property :title
-      property :tags
-      text     :summary
-      text     :content
+      virtual :name,     in_filepath(1)
+      virtual :comments, many(Comment)
+      field   :title     default("Untitled")
+      field   :tags      default([])
+      field   :created   type(Time)
+      text    :summary
+      text    :content
     end
      ```
 
-4. Create new post file `data/first/post.md`. Properties will be saved as
+4. Create new post file `data/first/post.md`. Fields will be saved as
    YAML and text will be placed as plain text, which is separated by 3 dashes:
 
      ```
@@ -61,10 +66,10 @@ For example we will create simple blog storage with posts and comments.
 
       list_in '*/comments.yml'
 
-      virtual  :post_name, in_filepath(1)
-      virtual  :post,      one(Post)
-      property :author
-      property :comment
+      virtual :post_name, in_filepath(1)
+      virtual :post,      one(Post)
+      field   :author
+      field   :comment
     end
      ```
    You can’t use text fields in list files.
@@ -90,7 +95,7 @@ For example we will create simple blog storage with posts and comments.
      ```
 
 9. To get one entry use `first` method, which also can take matchers. You can
-   access for properties and text by methods with same name:
+   access for fields and text by methods with same name:
 
      ```ruby
     post = Post.first(title: /first/)

data/lib/plain_record/association_proxy.rb

@@ -1,7 +1,8 @@
 =begin
 Storage for one-to-many virtual associations.
 
-Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+sponsored by Evil Martians.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -19,39 +20,39 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module PlainRecord
   # Storage for one-to-many virtual associations. When new object will pushed,
-  # proxy change it mapped properties.
+  # proxy change it mapped fields.
   class AssociationProxy < Array
     # Model with association.
     attr_accessor :owner
 
-    # Associations property name.
-    attr_accessor :property
+    # Associations field name.
+    attr_accessor :field
 
-    # Create proxy for one-to-many virtual associations +property+ in +owner+
+    # Create proxy for one-to-many virtual associations +field+ in +owner+
     # and put +array+ into it.
-    def self.link(array, owner, property)
-      proxy = new(array, owner, property)
+    def self.link(array, owner, field)
+      proxy = new(array, owner, field)
       proxy.each { |i| proxy.link(i) }
       proxy
     end
 
-    # Create proxy for one-to-many virtual associations +property+ in +owner+
+    # Create proxy for one-to-many virtual associations +field+ in +owner+
     # with +array+ in value.
-    def initialize(array, owner, property)
+    def initialize(array, owner, field)
       @owner = owner
-      @property = property
+      @field = field
       super(array)
     end
 
-    # Push new item in association and change it property by association map.
+    # Push new item in association and change it field by association map.
     def <<(obj)
       link(obj)
       super(obj)
     end
 
-    # Change properties in +obj+ by association map.
+    # Change fields in +obj+ by association map.
     def link(obj)
-      @owner.class.association_maps[@property].each do |from, to|
+      @owner.class.association_maps[@field].each do |from, to|
         obj.send(from.to_s + '=', @owner.send(to))
       end
     end

data/lib/plain_record/associations.rb

@@ -1,7 +1,8 @@
 =begin
 Extention to store or have link to another model.
 
-Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+sponsored by Evil Martians.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -21,30 +22,30 @@ module PlainRecord
   # Extention for model to store or have link to another model. There is two
   # type of association.
   #
-  # == Virtual property
-  # In +virtual+ method this definer create only _link_ to another model. When
-  # you try to use this virtual property, model will find association object by
+  # == Virtual field
+  # In +virtual+ method this filter create only _link_ to another model. When
+  # you try to use this virtual field, model will find association object by
   # rules in +map+.
   #
-  # Rules in +map+ is only Hash with model properties in key and association
-  # properties in value. For example, if model contain +name+ property and
+  # Rules in +map+ is only Hash with model fields in key and association
+  # fields in value. For example, if model contain +name+ field and
   # association must have +post_name+ with same value, +map+ will be 
   # <tt>{ :name => :post_name }</tt>.
   #
-  # If you didn’t set +map+ definer will try to find it automatically:
-  # it will find in model and association class all property pairs, what have
-  # name like +property+ → <tt>model</tt>_<tt>property</tt>. For example,
-  # if model +Post+ have property +name+ and +Comment+ have +post_name+, you
-  # may not set +map+ – definer will find it automatically.
+  # If you didn’t set +map+ filter will try to find it automatically:
+  # it will find in model and association class all field pairs, what have
+  # name like +field+ → <tt>model</tt>_<tt>field</tt>. For example,
+  # if model +Post+ have field +name+ and +Comment+ have +post_name+, you
+  # may not set +map+ – filter will find it automatically.
   #
   #   class Review
   #     include PlainRecord::Resource
   #
   #     entry_in 'reviews/*.md'
   #
-  #     virtual  :author, one(Author)
-  #     property :author_login
-  #     text     :review
+  #     virtual :author, one(Author)
+  #     field   :author_login
+  #     text    :review
   #   end
   #
   #   class Author
@@ -52,26 +53,26 @@ module PlainRecord
   #
   #     list_in 'authors.yml'
   #
-  #     virtual  :reviews, many(Review)
-  #     property :login
-  #     property :name
+  #     virtual :reviews, many(Review)
+  #     field   :login
+  #     field   :name
   #   end
   #
-  # == Real property
-  # If you will use this definer in +property+ method, association object data
+  # == Real field
+  # If you will use this filter in +field+ method, association object data
   # will store in you model file. For example model:
   #
   #   class Movie
   #     include PlainRecord::Resource
   #
-  #     property :title
-  #     property :genre
-  #     property :release_year
+  #     field :title
+  #     field :genre
+  #     field :release_year
   #   end
   #
   #   class Tag
   #     include PlainRecord::Resource
-  #     property :name
+  #     field :name
   #   end
   #
   #   class Review
@@ -79,10 +80,10 @@ module PlainRecord
   #
   #     entry_in 'reviews/*.md'
   #
-  #     property :author
-  #     property :movie, one(Movie)
-  #     property :tags, many(Tag)
-  #     text     :review
+  #     field :author
+  #     field :movie, one(Movie)
+  #     field :tags,  many(Tag)
+  #     text  :review
   #   end
   #
   # will be store as:
@@ -101,54 +102,47 @@ module PlainRecord
     # Hash with map for virtual associations.
     attr_accessor :association_maps
 
-    # Hash with cached values for virtual associations.
-    attr_accessor :association_cache
-
     private
 
-    # Return definer for one-to-one association with +klass+. Have different
-    # logic in +property+ and +virtual+ methods.
+    # Return filter for one-to-one association with +klass+. Have different
+    # logic in +field+ and +virtual+ methods.
     def one(klass, map = { })
-      proc do |property, caller|
-        if :property == caller
-          Associations.define_real_one(self, property, klass)
-          :accessor
-        elsif :virtual == caller
-          map = Associations.map(self, klass, "#{property}_") if map.empty?
-          Associations.define_link_one(self, klass, property, map)
-          nil
+      proc do |model, field, type|
+        if :field == type
+          Associations.define_real_one(model, field, klass)
+        elsif :virtual == type
+          map = Associations.map(model, klass, "#{field}_") if map.empty?
+          Associations.define_link_one(model, klass, field, map)
         else
-          raise ArgumentError, "You couldn't create association property" +
-                               " #{property} by text creator"
+          raise ArgumentError, "You couldn't create association field" +
+                               " #{field} by text creator"
         end
       end
     end
 
-    # Return definer for one-to-many or many-to-many association with +klass+.
-    # Have different login in +property+ and +virtual+ methods.
+    # Return filter for one-to-many or many-to-many association with +klass+.
+    # Have different login in +field+ and +virtual+ methods.
     def many(klass, prefix = nil, map = { })
-      proc do |property, caller|
-        if :property == caller
-          Associations.define_real_many(self, property, klass)
-          :accessor
-        elsif :virtual == caller
+      proc do |model, field, type|
+        if :field == type
+          Associations.define_real_many(model, field, klass)
+        elsif :virtual == type
           unless prefix
             prefix = self.to_s.gsub!(/[A-Z]/, '_\0')[1..-1].downcase + '_'
           end
-          map = Associations.map(klass, self, prefix) if map.empty?
-          Associations.define_link_many(self, klass, property, map)
-          nil
+          map = Associations.map(klass, model, prefix) if map.empty?
+          Associations.define_link_many(model, klass, field, map)
         else
-          raise ArgumentError, "You couldn't create association property" +
-                               " #{property} by text creator"
+          raise ArgumentError, "You couldn't create association field" +
+                               " #{field} by text creator"
         end
       end
     end
 
     class << self
-      # Define, that +property+ in +klass+ contain in file data from +model+.
-      def define_real_one(klass, property, model)
-        name = property.to_s
+      # Define, that +field+ in +klass+ contain in file data from +model+.
+      def define_real_one(klass, field, model)
+        name = field.to_s
         klass.after :load do |result, entry|
           entry.data[name] = model.new(entry.file, entry.data[name])
           result
@@ -164,10 +158,10 @@ module PlainRecord
         end
       end
 
-      # Define, that +property+ in +klass+ contain in file array of data from
+      # Define, that +field+ in +klass+ contain in file array of data from
       # +model+ objects.
-      def define_real_many(klass, property, model)
-        name = property.to_s
+      def define_real_many(klass, field, model)
+        name = field.to_s
         klass.after :load do |result, entry|
           if entry.data[name].is_a? Enumerable
             entry.data[name].map! { |i| model.new(entry.file, i) }
@@ -195,17 +189,17 @@ module PlainRecord
         end
       end
 
-      # Find properties pairs in +from+ and +to+ models, witch is like
+      # Find fields pairs in +from+ and +to+ models, witch is like
       # <tt>prefix</tt>_<tt>from</tt> → +to+.
       #
-      # For example, if Comment contain +post_name+ property and Post contain
+      # For example, if Comment contain +post_name+ field and Post contain
       # +name+:
       #
       #   Associations.map(Comment, Post, :post) #=> { :post_name => :name }
       def map(from, to, prefix)
-        from_fields = (from.properties + from.virtuals).map { |i| i.to_s }
+        from_fields = (from.fields + from.virtuals).map { |i| i.to_s }
         mapped = { }
-        (to.properties + to.virtuals).each do |to_field|
+        (to.fields + to.virtuals).each do |to_field|
           from_field = prefix + to_field.to_s
           if from_fields.include? from_field
             mapped[from_field.to_sym] = to_field
@@ -214,54 +208,60 @@ module PlainRecord
         mapped
       end
 
-      # Define that virtual property +name+ in +klass+ contain link to +model+
+      def init_association_cache(klass)
+        klass.after :load do |result, entry|
+          entry.instance_exec { @association_cache = { } }
+        end
+      end
+
+      # Define that virtual field +name+ in +klass+ contain link to +model+
       # witch is finded by +map+.
       def define_link_one(klass, model, name, map)
-        klass.association_cache ||= { }
-        klass.association_maps  ||= { }
+        klass.association_maps ||= { }
         klass.association_maps[name] = map
+        init_association_cache(klass)
 
-        klass.class_eval <<-EOS, __FILE__, __LINE__
+        klass.add_accessors <<-EOS, __FILE__, __LINE__
           def #{name}
-            unless self.class.association_cache[:#{name}]
+            unless @association_cache.has_key? :#{name}
               search = Hash[
                 self.class.association_maps[:#{name}].map do |from, to|
                   [to, send(from)]
                 end]
-              self.class.association_cache[:#{name}] = #{model}.first(search)
+              @association_cache[:#{name}] = #{model}.first(search)
             end
-            self.class.association_cache[:#{name}]
+            @association_cache[:#{name}]
           end
           def #{name}=(value)
             self.class.association_maps[:#{name}].each do |from, to|
               value.send(to.to_s + '=', send(from))
             end
-            self.class.association_cache[:#{name}] = value
+            @association_cache[:#{name}] = value
           end
         EOS
       end
 
-      # Define that virtual property +name+ in +klass+ contain links to +model+
+      # Define that virtual field +name+ in +klass+ contain links to +model+
       # witch are finded by +map+.
       def define_link_many(klass, model, name, map)
-        klass.association_cache ||= { }
-        klass.association_maps  ||= { }
+        klass.association_maps ||= { }
         klass.association_maps[name] = map
+        init_association_cache(klass)
 
-        klass.class_eval <<-EOS, __FILE__, __LINE__
+        klass.add_accessors <<-EOS, __FILE__, __LINE__
           def #{name}
-            unless self.class.association_cache[:#{name}]
+            unless @association_cache.has_key? :#{name}
               search = Hash[
                 self.class.association_maps[:#{name}].map do |from, to|
                   [from, send(to)]
                 end]
-              self.class.association_cache[:#{name}] = AssociationProxy.new(
+              @association_cache[:#{name}] = AssociationProxy.new(
                   #{model}.all(search), self, :#{name})
             end
-            self.class.association_cache[:#{name}]
+            @association_cache[:#{name}]
           end
           def #{name}=(values)
-            self.class.association_cache[:#{name}] = AssociationProxy.link(
+            @association_cache[:#{name}] = AssociationProxy.link(
                 values, self, :#{name})
           end
         EOS

data/lib/plain_record/callbacks.rb

@@ -1,7 +1,8 @@
 =begin
 Module to add before/after hooks.
 
-Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+sponsored by Evil Martians.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by
@@ -21,7 +22,7 @@ module PlainRecord
   # Callbacks are hooks that allow you to define methods to run before and
   # after some method, to change it logic.
   module Callbacks
-    # Hash of class callbacks with property.
+    # Hash of class callbacks with field.
     attr_accessor :callbacks
 
     # Set block as callback before +events+. Callback with less +priority+ will

data/lib/plain_record/default.rb

@@ -0,0 +1,56 @@
+=begin
+Extention to set default value for field.
+
+Copyright (C) 2012 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+sponsored by Evil Martians.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module PlainRecord
+  # Extention to set default value for field.
+  #
+  #   class Post
+  #     include PlainRecord::Resource
+  #
+  #     entry_in '*/*/post.md'
+  #
+  #     virtual :category, default('uncategorized')
+  #     …
+  #   end
+  #
+  #   post = Post.new
+  #   post.category       #=> "uncategorized"
+  #   post.category = "a"
+  #   post.category       #=> "a"
+  module Default
+    attr_accessor :default_values
+
+    private
+
+    # Filter to set default field value.
+    def default(value)
+      proc do |model, field, type|
+        model.default_values ||= { }
+        model.default_values[field] = value
+
+        model.add_accessors <<-EOS, __FILE__, __LINE__
+          def #{field}
+            super || self.class.default_values[:#{field}]
+          end
+        EOS
+      end
+    end
+  end
+end

data/lib/plain_record/extra/git.rb

@@ -0,0 +1,97 @@
+=begin
+Extention to get time from git commits of model file.
+
+Copyright (C) 2012 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
+sponsored by Evil Martians.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+module PlainRecord::Extra
+  # Extention to get time from git commits of model file.
+  #
+  # It make sense only with `entry_in` models. You can get created or modified
+  # time from first or last git commit time.
+  #
+  # It is additional extention, so you need to include `PlainRecord::Extra::Git`
+  # module to your model.
+  #
+  #   class Post
+  #     include PlainRecord::Resource
+  #     include PlainRecord::Extra::Git
+  #
+  #     virtual :created_at, git_created_time
+  #     virtual :updated_at, git_modify_time
+  #   end
+  module Git
+    class << self
+      def included(base)
+        base.send :extend, Model
+      end
+    end
+
+    # Return time of first commit of model file (created time).
+    #
+    # If file isn’t commited yet, it will return `Time.now`.
+    def first_git_commit
+      return Time.now unless file
+      times = `git log --reverse --date=iso --pretty=format:%cD #{file}`
+      time  = times.split("\n").first
+      time ? Time.parse(time) : Time.now
+    end
+
+    # Return time of last commit of model file (modified time).
+    #
+    # If file isn’t commited yet, it will return `Time.now`.
+    def last_git_commit
+      return Time.now if file.nil? or git_uncommitted?
+      time = `git log -1 --date=iso --pretty=format:%cD #{file}`
+      time ? Time.parse(time) : Time.now
+    end
+
+    # If file have changes, that is not commited yet.
+    def git_uncommitted?
+      not `git status -s #{file}`.empty?
+    end
+
+    module Model
+
+      private
+
+      # Filter to set default value to time of last file git commit.
+      # If file is not commited or has changes, filter will return `Time.now`.
+      def git_modified_time
+        proc do |model, name, type|
+          model.add_accessors <<-EOS, __FILE__, __LINE__
+            def #{name}
+              super || last_git_commit
+            end
+          EOS
+        end
+      end
+
+      # Filter to set default value to time of first file git commit.
+      # If file is not commited or has changes, filter will return `Time.now`.
+      def git_created_time
+        proc do |model, name, type|
+          model.add_accessors <<-EOS, __FILE__, __LINE__
+            def #{name}
+              super || first_git_commit
+            end
+          EOS
+        end
+      end
+    end
+  end
+end