plain_record 0.2 → 0.3

data/lib/plain_record/extra/i18n.rb

@@ -0,0 +1,157 @@
+=begin
+Extention to get field value depend on user locale.
+
+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 field value depend on user locale.
+  #
+  # You can’t use this filter for texts, because you need to set hash of
+  # language code to translated string. For example in YAML fiels:
+  #
+  # title:
+  #   en: Title
+  #   ru: Заголовок
+  #
+  # Then just set filter to `virtual` or `field`.
+  #
+  #   class Post
+  #     include PlainRecord::Resource
+  #     include PlainRecord::Extra::I18n
+  #
+  #     field :title, i18n
+  #   end
+  #
+  # By default, this filter will use current locale from Rails I18n or R18n,
+  # if they are defined. If you need to take locale from another space, just
+  # redefine `locale` model method.
+  #
+  #   class Post
+  #     def locale
+  #       ENV['locale']
+  #     end
+  #   end
+  module I18n
+    class << self
+      def included(base)
+        base.send :extend, Model
+      end
+    end
+
+    # Return default locale. By default it look in R18n or Rails I18n.
+    # Redefine it if you need another logic.
+    def locale
+      if defined? ::R18n::I18n
+        ::R18n.get
+      elsif defined? ::I18n
+        ::I18n.locale
+      else
+        raise "Can't find R18n or I18n. Redefine `locale` method."
+      end
+    end
+
+    # Return locale code depend on autodetected I18n library.
+    def locale_code
+      code = locale
+      if defined? R18n::I18n and code.is_a? R18n::I18n
+        code.locale.code
+      elsif code.is_a? Symbol
+        code.to_s
+      else
+        code
+      end
+    end
+
+    # Return subvalue of `hash` depend on user locale from `locale` method.
+    #
+    # If R18n or Rails I18n is loaded it will use them logic to translate.
+    def get_translation(name, hash, *params)
+      return hash unless hash.is_a? Hash
+      path = "#{self.class.name}##{name}"
+
+      if defined? R18n::I18n and locale.is_a? R18n::I18n
+        r18n = locale
+        r18n.locales.each do |lang|
+          code = lang.code
+          next unless hash.has_key? code
+
+          result = hash[code]
+          type   = self.class.fields_i18n_types[name.to_sym]
+
+          if type
+            return r18n.filter_list.
+              process(:all, type, result, lang, path, params)
+          elsif result.is_a? String
+            result = ::R18n::TranslatedString.new(result, lang, path)
+            return r18n.filter_list.process_string(:all, result, path, params)
+          else
+            return result
+          end
+        end
+
+        ::R18n::Untranslated.new("#{self.class.name}#", name,
+                                 locale.locale, locale.filter_list)
+
+      elsif defined? ::I18n
+        hash[locale.to_s]
+
+      else
+        hash[locale]
+      end
+    end
+
+    module Model
+      # R18n type for fields.
+      attr_accessor :fields_i18n_types
+
+      private
+
+      # Filter to return value depend on model locale.
+      #
+      # If you use R18n, you can set `type` to specify filters.
+      #
+      #   field comment_count, i18n('pl')
+      def i18n(r18n_type = nil)
+        proc do |model, field, type|
+          if :text == type
+            raise ArgumentError, "You can't set i18n filter for text"
+          end
+
+          model.fields_i18n_types ||= { }
+          model.fields_i18n_types[field] = r18n_type if r18n_type
+
+          model.send :alias_method, "untraslated_#{field}",  field
+          model.send :alias_method, "untraslated_#{field}=", "#{field}="
+
+          model.add_accessors <<-EOS, __FILE__, __LINE__
+            def #{field}(*params)
+              get_translation("#{field}", super, *params)
+            end
+            def #{field}=(value)
+              if untraslated_#{field}
+                untraslated_#{field}[locale_code] = value
+              else
+                super({ locale_code => value })
+              end
+            end
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/plain_record/filepath.rb

@@ -1,7 +1,8 @@
 =begin
-Extention to get property from entry file path.
+Extention to get field from entry file path.
 
-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
@@ -18,18 +19,18 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 =end
 
 module PlainRecord
-  # Extention to get properties from enrty file path. For example, your blog
+  # Extention to get fields from enrty file path. For example, your blog
   # post may stored in <tt>_name_/post.md</tt>, and post model will have +name+
-  # property. Also if you set name property to Model#first or Model#all method,
+  # field. Also if you set name field to Model#first or Model#all method,
   # they will load entry directly only by it file.
   #
-  # To define filepath property:
+  # To define filepath field:
   # 1. Use <tt>*</tt> or <tt>**</tt> pattern in model path in +enrty_in+ or
   #    +list_in+.
-  # 2. In +virtual+ method use <tt>in_filepath(i)</tt> definer after name with
+  # 2. In +virtual+ method use <tt>in_filepath(i)</tt> filter after name with
   #    <tt>*</tt> or <tt>**</tt> number (start from 1).
   #
-  # Define filepath property only after +entry_in+ or +list_in+ call.
+  # Define filepath field only after +entry_in+ or +list_in+ call.
   #
   #   class Post
   #     include PlainRecord::Resource
@@ -48,21 +49,31 @@ module PlainRecord
   #
   #   bests = Post.all(category: 'best') # Look up only in best/ dir
   module Filepath
-    attr_accessor :filepath_properties
+    attr_accessor :filepath_fields
     attr_accessor :filepath_regexp
 
     private
 
-    # Return definer for filepath property for +number+ <tt>*</tt> or
+    # Return filter for filepath field for +number+ <tt>*</tt> or
     # <tt>**</tt> pattern in path.
     def in_filepath(number)
-      proc do |property, caller|
-        if :virtual != caller
-          raise ArgumentError, "You must create filepath property #{property}" +
+      proc do |model, field, type|
+        if :virtual != type
+          raise ArgumentError, "You must create filepath field #{field}" +
                                ' virtual creator'
         end
-        Filepath.define_property(self, property, number)
-        nil
+
+        Filepath.install(model) unless model.filepath_fields
+        model.filepath_fields[number] = field
+
+        model.add_accessors <<-EOS, __FILE__, __LINE__
+          def #{field}
+            @filepath_data[:#{field}]
+          end
+          def #{field}=(value)
+            @filepath_data[:#{field}] = value
+          end
+        EOS
       end
     end
 
@@ -70,7 +81,7 @@ module PlainRecord
       # Define class variables and events in +klass+. It should be call once on
       # same class after +entry_in+ or +list_in+ call.
       def install(klass)
-        klass.filepath_properties = { }
+        klass.filepath_fields = { }
 
         path = Regexp.escape(klass.path).gsub(/\\\*\\\*(\/|$)/, '(.*)').
                                          gsub('\\*', '([^/]+)')
@@ -84,12 +95,12 @@ module PlainRecord
           if entry.path
             data = klass.filepath_regexp.match(entry.path)
             entry.filepath_data = { }
-            klass.filepath_properties.each_pair do |number, name|
+            klass.filepath_fields.each_pair do |number, name|
               entry.filepath_data[name] = data[number]
             end
           else
             entry.filepath_data = { }
-            klass.filepath_properties.each_value do |name|
+            klass.filepath_fields.each_value do |name|
               entry.filepath_data[name] = entry.data[name]
               entry.data.delete(name)
             end
@@ -101,9 +112,9 @@ module PlainRecord
           i = 0
           path.gsub /(\*\*(\/|$)|\*)/ do |pattern|
             i += 1
-            property = klass.filepath_properties[i]
-            unless matchers[property].is_a? Regexp or matchers[property].nil?
-              matchers[property]
+            field = klass.filepath_fields[i]
+            unless matchers[field].is_a? Regexp or matchers[field].nil?
+              matchers[field]
             else
               pattern
             end
@@ -117,25 +128,6 @@ module PlainRecord
           end
         end
       end
-
-      # Define in +klass+ filepath property with +name+ for +number+ <tt>*</tt>
-      # or <tt>**</tt> pattern in path.
-      def define_property(klass, name, number)
-        unless klass.filepath_properties
-          install(klass)
-        end
-
-        klass.filepath_properties[number] = name
-
-        klass.class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}
-            @filepath_data[:#{name}]
-          end
-          def #{name}=(value)
-            @filepath_data[:#{name}] = value
-          end
-        EOS
-      end
     end
   end
 end

data/lib/plain_record/model/entry.rb

@@ -1,7 +1,8 @@
 =begin
 Class with static methods for entry_in model class.
 
-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

data/lib/plain_record/model/list.rb

@@ -1,7 +1,8 @@
 =begin
 Class with static methods for list_in model class.
 
-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

data/lib/plain_record/model.rb

@@ -1,7 +1,8 @@
 =begin
 Class with static methods for model class.
 
-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
@@ -28,16 +29,18 @@ module PlainRecord
     autoload :List,  (dir + 'list').to_s
 
     include PlainRecord::Callbacks
+    include PlainRecord::Default
     include PlainRecord::Filepath
     include PlainRecord::Associations
+    include PlainRecord::Type
 
-    # YAML properties names.
-    attr_accessor :properties
+    # YAML fields names.
+    attr_accessor :fields
 
-    # Name of special properties with big text.
+    # Name of special fields with big text.
     attr_accessor :texts
 
-    # Properties names with dynamic value.
+    # Fields names with dynamic value.
     attr_accessor :virtuals
 
     # Storage type: +:entry+ or +:list+.
@@ -46,11 +49,15 @@ module PlainRecord
     # Content of already loaded files.
     attr_accessor :loaded
 
-    def self.extended(base) #:nodoc:
-      base.properties = []
-      base.virtuals   = []
-      base.texts      = []
-      base.loaded     = { }
+    # Named modules, created by +add_accessors+.
+    attr_accessor :accessors_modules
+
+    def self.extended(base)
+      base.fields   = []
+      base.virtuals = []
+      base.texts    = []
+      base.loaded   = { }
+      base.accessors_modules = { }
     end
 
     # Load and return all entries in +file+.
@@ -87,7 +94,7 @@ module PlainRecord
     # Return all entries, which is match for +matchers+ and return true on
     # +block+.
     #
-    # Matchers is a Hash with property name in key and String or Regexp for
+    # Matchers is a Hash with field name in key and String or Regexp for
     # match in value.
     #
     #   Post.all(title: 'Post title')
@@ -103,7 +110,7 @@ module PlainRecord
     # Return first entry, which is match for +matchers+ and return true on
     # +block+.
     #
-    # Matchers is a Hash with property name in key and String or Regexp for
+    # Matchers is a Hash with field name in key and String or Regexp for
     # match in value.
     #
     #   Post.first(title: 'Post title')
@@ -137,6 +144,50 @@ module PlainRecord
       end
     end
 
+    # Create new anonymous module and include in model.
+    #
+    # You can set +name+ and it will old module, if it was created with same
+    # name.
+    #
+    # It is helper to create model fields accessors and filters for it with
+    # +super+ support.
+    #
+    #   add_accessors <<-EOS, __FILE__, __LINE__
+    #     def #{name}
+    #       @data['#{name}']
+    #     end
+    #   EOS
+    def add_accessors(name = nil, file = nil, line = nil, code = nil)
+      if name.is_a? String
+        code = line
+        line = file
+        file = name
+        name = nil
+      end
+
+      if file and code.nil?
+        code = file
+        file = line = nil
+      end
+
+      if name and @accessors_modules.has_key? name
+        mod = @accessors_modules[name]
+      else
+        mod = Module.new
+        if name
+          @accessors_modules[name] = mod
+        end
+        include mod
+      end
+
+      if file and code
+        mod.module_eval(file, line, code)
+      elsif code
+        mod.module_eval(code)
+      end
+      mod
+    end
+
     private
 
     # Return all model entries, which is may be match for +matchers+.
@@ -200,13 +251,12 @@ module PlainRecord
       self.extend PlainRecord::Model::List
     end
 
-    # Add virtual property with some +name+ to model. It value willn’t be in
+    # Add virtual field with some +name+ to model. It value willn’t be in
     # file and will be calculated dynamically.
     #
-    # You _must_ provide your own define logic by +definers+. Definer Proc
-    # will be call with property name in first argument and may return
-    # +:accessor+, +:writer+ or +:reader+ this method create standard methods
-    # to access to property.
+    # You _must_ provide your own define logic by +filters+. Filter Proc
+    # will be call with models class as first argument, field name as second and
+    # field type as second.
     #
     #   class Post
     #     include PlainRecord::Resource
@@ -215,61 +265,53 @@ module PlainRecord
     #
     #     virtual :name, in_filepath(1)
     #   end
-    def virtual(name, *definers)
+    def virtual(name, *filters)
       @virtuals ||= []
       @virtuals << name
 
-      accessors = call_definers(definers, name, :virtual)
-
-      if accessors[:reader] or accessors[:writer]
+      if filters.length.zero?
         raise ArgumentError, 'You must provide you own accessors for virtual ' +
-                             "property #{name}"
+                             "field #{name} by any filter"
       end
+
+      field_filters(filters, name, :virtual)
     end
 
-    # Add property with some +name+ to model. It will be stored as YAML.
+    # Add field with some +name+ to model. It will be stored as YAML.
     #
-    # You can provide your own define logic by +definers+. Definer Proc
-    # will be call with property name in first argument and may return
-    # +:accessor+, +:writer+ or +:reader+ this method create standard methods
-    # to access to property.
+    # You may provide your own define logic by +filters+. Filter Proc will be
+    # call with models class as first argument, field name as second and
+    # field type as second.
     #
     #   class Post
     #     include PlainRecord::Resource
     #
     #     entry_in 'posts/*/post.md'
     #
-    #     property :title
+    #     field :title
     #   end
-    def property(name, *definers)
-      @properties ||= []
-      @properties << name
-
-      accessors = call_definers(definers, name, :property)
-
-      if accessors[:reader]
-        class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}
-            @data['#{name}']
-          end
-        EOS
-      end
-      if accessors[:writer]
-        class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}=(value)
-            @data['#{name}'] = value
-          end
-        EOS
-      end
+    def field(name, *filters)
+      @fields ||= []
+      @fields  << name
+
+      add_accessors :main, <<-EOS, __FILE__, __LINE__
+        def #{name}(*params)
+          @data['#{name}']
+        end
+        def #{name}=(value)
+          @data['#{name}'] = value
+        end
+      EOS
+
+      field_filters(filters, name, :field)
     end
 
-    # Add special property with big text (for example, blog entry content). It
-    # will stored after 3 dashes (<tt>---</tt>).
+    # Add special field with big text (for example, blog entry content).
+    # It will stored after 3 dashes (<tt>---</tt>).
     #
-    # You can provide your own define logic by +definers+. Definer Proc
-    # will be call with property name in first argument and may return
-    # +:accessor+, +:writer+ or +:reader+ this method create standard methods
-    # to access to property.
+    # You may provide your own define logic by +filter+. Filter Proc  will be
+    # call with models class as first argument, field name as second and
+    # field type as second.
     #
     # Note, that text is supported by only +entry_in+ models, which entry store
     # in separated files.
@@ -283,9 +325,9 @@ module PlainRecord
     #
     #     entry_in 'posts/*/post.md'
     #
-    #     property :title
-    #     text :summary
-    #     text :content
+    #     field :title
+    #     text  :summary
+    #     text  :content
     #   end
     #
     # File:
@@ -295,7 +337,7 @@ module PlainRecord
     #   Post summary
     #   ---
     #   Post text
-    def text(name, *definers)
+    def text(name, *filters)
       if :list == @storage
         raise ArgumentError, 'Text is supported by only entry_in models'
       end
@@ -304,41 +346,28 @@ module PlainRecord
       @texts << name
       number = @texts.length - 1
 
-      accessors = call_definers(definers, name, :text)
+      add_accessors :main, <<-EOS, __FILE__, __LINE__
+        def #{name}
+          @texts[#{number}]
+        end
+        def #{name}=(value)
+          @texts[#{number}] = value
+        end
+      EOS
 
-      if accessors[:reader]
-        class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}
-            @texts[#{number}]
-          end
-        EOS
-      end
-      if accessors[:writer]
-        class_eval <<-EOS, __FILE__, __LINE__
-          def #{name}=(value)
-            @texts[#{number}] = value
-          end
-        EOS
-      end
+      field_filters(filters, name, :text)
     end
 
-    # Call +definers+ from +caller+ (<tt>:virtual</tt>, <tt>:property</tt> or
-    # <tt>:text</tt>) for property with +name+ and return accessors, which will
-    # be created as standart by +property+ or +text+ method.
-    def call_definers(definers, name, caller)
-      accessors = { :reader => true, :writer => true }
-
-      definers.each do |definer|
-        access = definer.call(name, caller)
-        if :writer == access or access.nil?
-          accessors[:reader] = false
-        end
-        if :reader == access or access.nil?
-          accessors[:writer] = false
+    # Call all +filters+ for some +field+ with +type+.
+    def field_filters(filters, field, type)
+      filters.each do |filter|
+        if filter.is_a? Hash
+          filter = filter.map { |name, param| send(name, param) }
+          field_filters(filter, field, type)
+        else
+          filter.call(self, field, type)
         end
       end
-
-      accessors
     end
   end
 end

data/lib/plain_record/resource.rb

@@ -1,7 +1,8 @@
 =begin
 Module to be included into model class.
 
-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
@@ -29,7 +30,7 @@ module PlainRecord
   # * <tt>save(entry)</tt> – write entry to file.
   # See PlainRecord::Callbacks for details.
   #
-  # You can define properties  from entry file path, by +in_filepath+ definer.
+  # You can define fields from entry file path, by +in_filepath+ filter.
   # See PlainRecord::Filepath for details.
   #
   #   class Post
@@ -42,18 +43,18 @@ module PlainRecord
   #     end
   #
   #     virtual :name, in_filepath(1)
-  #     property :title
-  #     text :summary
-  #     text :content
+  #     field   :title
+  #     text    :summary
+  #     text    :content
   #   end
   module Resource
     class << self
-      def included(base) #:nodoc:
+      def included(base)
         base.send :extend, Model
       end
     end
 
-    # Properties values.
+    # Fields values.
     attr_reader :data
 
     # Texts values.
@@ -102,7 +103,7 @@ module PlainRecord
             self.file = self.class.path
           else
             raise ArgumentError, "There isn't file to save entry. " +
-                                 "Set filepath properties or file."
+                                 "Set filepath fields or file."
           end
         end
 
@@ -122,7 +123,7 @@ module PlainRecord
       @data.to_yaml(opts)
     end
 
-    # Compare if its properties and texts are equal.
+    # Compare if its fields and texts are equal.
     def eql?(other)
       return false unless other.kind_of?(self.class)
       @file == other.file and @data == other.data and @texts == @texts