plain_record 0.3 → 0.4

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
+bundler_args: --without development
 rvm:
   - 1.8.7
-  - ruby-head
+  - 1.9.3
   - jruby-18mode
+  - rbx-18mode
+  - rbx-19mode

data/ChangeLog

@@ -1,3 +1,8 @@
+== 0.4 (Phosgene)
+* Allow to store images.
+* Allow to store field in separated file.
+* Fix JRuby and Rubinius support.
+
 == 0.3 (Chlorine)
 * Use modules to use super in filters.
 * Add filter to i18n support.

data/Gemfile

@@ -1,8 +1,13 @@
 source :rubygems
 
 gem 'rake'
-gem 'yard'
 gem 'rspec'
-gem 'redcarpet'
-gem 'r18n-core', :require => nil, :github => 'ai/r18n'
+gem 'r18n-core', :require => nil
 gem 'i18n',      :require => nil
+gem 'rmagick',   :platforms => :ruby
+gem 'rmagick4j', :platforms => :jruby
+
+group :development do
+  gem 'redcarpet'
+  gem 'yard'
+end

data/Gemfile.lock

@@ -1,33 +1,31 @@
-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.1)
-    rspec-expectations (2.10.0)
+    i18n (0.6.1)
+    r18n-core (1.1.3)
+    rake (10.0.3)
+    redcarpet (2.2.2)
+    rmagick (2.13.1)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    yard (0.8.1)
+    rspec-mocks (2.12.1)
+    yard (0.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   i18n
-  r18n-core!
+  r18n-core
   rake
   redcarpet
+  rmagick
+  rmagick4j
   rspec
   yard

data/Rakefile

@@ -15,10 +15,12 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-require 'yard'
-YARD::Rake::YardocTask.new do |yard|
-  yard.options << "--title='Plain Record #{PlainRecord::VERSION}'"
-end
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new do |yard|
+    yard.options << "--title='Plain Record #{PlainRecord::VERSION}'"
+  end
+rescue LoadError; end
 
 task :clobber_doc do
   rm_r 'doc'     rescue nil

data/lib/plain_record/associations.rb

@@ -88,7 +88,7 @@ module PlainRecord
   #
   # will be store as:
   #
-  #   author: John Smith 
+  #   author: John Smith
   #   movie:
   #     title: Watchmen
   #     genre: action
@@ -114,8 +114,8 @@ module PlainRecord
           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 field" +
-                               " #{field} by text creator"
+          raise ArgumentError,
+               "You couldn't create association field #{field} by text creator"
         end
       end
     end
@@ -133,8 +133,8 @@ module PlainRecord
           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 field" +
-                               " #{field} by text creator"
+          raise ArgumentError,
+               "You couldn't create association field #{field} by text creator"
         end
       end
     end
@@ -144,16 +144,22 @@ module PlainRecord
       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])
+          if entry.data[name]
+            entry.data[name] = model.new(entry.file, entry.data[name])
+          end
           result
         end
         klass.before :save do |entry|
-          model.call_before_callbacks(:save, [entry.data[name]])
-          entry.data[name] = entry.data[name]
+          if entry.data[name]
+            model.call_before_callbacks(:save, [entry.data[name]])
+            entry.data[name] = entry.data[name]
+          end
         end
         klass.after :save do |result, entry|
-          entry.data[name] = model.new(entry.file, entry.data[name])
-          model.call_after_callbacks(:save, nil, [entry.data[name]])
+          if entry.data[name]
+            entry.data[name] = model.new(entry.file, entry.data[name])
+            model.call_after_callbacks(:save, nil, [entry.data[name]])
+          end
           result
         end
       end

data/lib/plain_record/extra/git.rb

@@ -35,10 +35,8 @@ module PlainRecord::Extra
   #     virtual :updated_at, git_modify_time
   #   end
   module Git
-    class << self
-      def included(base)
-        base.send :extend, Model
-      end
+    def self.included(base)
+      base.send :extend, Model
     end
 
     # Return time of first commit of model file (created time).
@@ -67,8 +65,6 @@ module PlainRecord::Extra
 
     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

data/lib/plain_record/extra/i18n.rb

@@ -47,10 +47,8 @@ module PlainRecord::Extra
   #     end
   #   end
   module I18n
-    class << self
-      def included(base)
-        base.send :extend, Model
-      end
+    def self.included(base)
+      base.send :extend, Model
     end
 
     # Return default locale. By default it look in R18n or Rails I18n.

data/lib/plain_record/extra/image.rb

@@ -0,0 +1,282 @@
+=begin
+Extention to store images.
+
+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
+
+require 'fileutils'
+
+module PlainRecord::Extra
+  # Extention to store images.
+  #
+  # 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 User
+  #     include PlainRecord::Resource
+  #     include PlainRecord::Extra::Image
+  #
+  #     entry_in   "users/*.yml"
+  #
+  #     image_from do |user, field|
+  #       "users/#{field}/#{user.name}.png"
+  #     end
+  #     image_url do |user, field, size|
+  #       if size
+  #         "users/#{user.name}/#{field}.#{size}.png"
+  #       else
+  #         "users/#{user.name}/#{field}.png"
+  #       end
+  #     end
+  #
+  #     virtual :name,   in_filepath(1)
+  #     virtual :avatar, image(small: '32x32', big: '64x64')
+  #     virtual :photo,  image
+  #   end
+  #
+  #   # There are images at `data/users/avatar/ai.png` and
+  #   # `data/users/photo/ai.png`
+  #
+  #   PlainRecord::Extra::Image.convert_images!
+  #   user = User.first(name: 'ai')
+  #
+  #   user.photo.url  #=> "data/users/ai/photo.png"
+  #   user.photo.file #=> "app/assets/images/data/users/ai/avatar.small.png"
+  #   user.avatar(:small).url  #=> "data/users/ai/avatar.small.png"
+  module Image
+    class << self
+      # Models, that used this extention.
+      attr_accessor :included_in
+
+      # Base of converted images.
+      # Set to <tt>app/aseets/images/data</tt> in Rails.
+      attr_accessor :dir
+
+      # Base of converted images URL. Set to <tt>data/</tt> in Rails.
+      attr_accessor :url
+
+      def included(base)
+        base.send :extend, Model
+        self.included_in ||= []
+        self.included_in << base
+      end
+
+      # Define class variables.
+      def install(klass)
+        klass.image_sizes = { }
+      end
+
+      def dir
+        unless @dir
+          raise ArgumentError,
+               'You need to set `PlainRecord::Extra::Image.dir`'
+        end
+        @dir
+      end
+
+      def url
+        unless @url
+          raise ArgumentError,
+               'You need to set `PlainRecord::Extra::Image.url`'
+        end
+        @url
+      end
+
+      # Delete all converted images.
+      def clean_images!
+        Dir.glob(File.join(self.dir, '**/*')) do |file|
+          FileUtils.rm_r(file) if File.exists? file
+        end
+      end
+
+      # Convert images in all models.
+      def convert_images!
+        clean_images!
+        return unless included_in
+
+        included_in.each do |model|
+          model.all.each { |i| i.convert_images! }
+        end
+      end
+
+    end
+
+    # Convert all images to public dir.
+    def convert_images!
+      self.class.image_sizes.each_pair do |field, sizes|
+        from = self.class.get_image_from(self, field)
+        next unless File.exists? from
+
+        if sizes.empty?
+          to = self.class.get_image_file(self, field, nil)
+          FileUtils.mkpath(File.dirname(to))
+          FileUtils.cp(from, to)
+        else
+          require 'RMagick'
+          source = ::Magick::Image.read(from).first
+          sizes.each_pair do |name, size|
+            to    = self.class.get_image_file(self, field, name)
+            w, h  = size.split('x')
+            image = source.resize(w.to_i, h.to_i)
+            self.class.use_callbacks(:convert_image, self, to) do
+              FileUtils.mkpath(File.dirname(to))
+              image.write(to)
+            end
+          end
+        end
+      end
+    end
+
+    # Field value object with image paths and URL.
+    class Data
+
+      # Name of image size.
+      attr_reader :size_name
+
+      # Format of image size.
+      attr_reader :size
+
+      # Image width.
+      attr_reader :width
+
+      # Image height.
+      attr_reader :height
+
+      # Converted image URL.
+      attr_reader :url
+
+      # Converted image file.
+      attr_reader :file
+
+      # Original image file.
+      attr_reader :original
+
+      # Set image paths.
+      def initialize(entry, field, size)
+        @size_name = size
+        @original  = entry.class.get_image_from(entry, field)
+
+        if size
+          @size = entry.class.image_sizes[field][size]
+          unless @size
+            raise ArgumentError, "Field `#{field}` doesn't have `#{size}` size"
+          end
+          @width, @height = @size.split('x').map { |i| i.to_i }
+        end
+
+        if size or entry.class.image_sizes[field].empty?
+          @url  = entry.class.get_image_url(entry, field, size)
+          @file = entry.class.get_image_file(entry, field, size)
+        end
+      end
+
+      def exists?
+        File.exists? @original
+      end
+
+    end
+
+    module Model
+
+      # Hash of image sizes.
+      attr_accessor :image_sizes
+
+      # Set source image path.
+      def image_from(&block)
+        @image_from = block
+      end
+
+      # Set relative image URL path from +image_base+.
+      def image_url(&block)
+        @image_url = block
+      end
+
+      # Get source image path.
+      def get_image_from(entry, field)
+        PlainRecord.root(@image_from.call(entry, field))
+      end
+
+      # Get converted image path.
+      def get_image_file(entry, field, size)
+        unless @image_url
+          raise ArgumentError,
+               "You need to set `image_url` in #{to_s} to calculate file path."
+        end
+        File.join(Image.dir, @image_url.call(entry, field, size))
+      end
+
+      # Get relative image URL path.
+      def get_image_url(entry, field, size)
+        unless @image_url
+          raise ArgumentError,
+               "You need to set `image_url` in #{to_s} to calculate file path."
+        end
+        File.join(Image.url, @image_url.call(entry, field, size))
+      end
+
+      private
+
+      # Use pngcrush (you must install it in system) to optimize png images.
+      #
+      #   class User
+      #     include PlainRecord::Resource
+      #     include PlainRecord::Extra::Image
+      #
+      #     optimize_png
+      #     …
+      #   end
+      def optimize_png
+        after :convert_image do |result, entry, file|
+          file = file.gsub(/([^A-Za-z0-9_\-\.,:\/@])/, "\\\\\\1")
+          file = file.gsub(/(^|\/)\.?\.($|\/)/, '')
+          return unless file =~ /\.png$/
+
+          tmp = file + '.optimized'
+          `pngcrush -rem gAMA -rem cHRM -rem iCCP -rem sRGB "#{file}" "#{tmp}"`
+          FileUtils.rm(file)
+          FileUtils.mv(tmp, file)
+        end
+      end
+
+      # Filter to create field with image. You must set +image_from+.
+      #
+      # If you create Rails application you must set also +image_url+.
+      # If you create web application with another web framework, you must
+      # also redefine `image_url_to_path` or set `image_to`.
+      #
+      # If you create non-web application, you must set only `image_to`.
+      #
+      # You can set sizes hash (name to ImageMagick size) to convert images.
+      def image(sizes = { })
+        proc do |model, name, type|
+          Image.install(model) unless model.image_sizes
+          model.image_sizes[name] = sizes
+
+          model.add_accessors <<-EOS, __FILE__, __LINE__
+            def #{name}(size = nil)
+              PlainRecord::Extra::Image::Data.new(self, :#{name}, size)
+            end
+          EOS
+        end
+      end
+
+    end
+  end
+end

data/lib/plain_record/file.rb

@@ -0,0 +1,91 @@
+=begin
+Extention to set to get field value from external 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
+  # Extention to set to get field value from external file.
+  #
+  #   class Post
+  #     include PlainRecord::Resource
+  #
+  #     entry_in '*/post.md'
+  #
+  #     virtual :name, in_filepath(1)
+  #     virtuel :text, file { |p| "#{p.name}/text.#{I18n.locale}.md" }
+  #   end
+  module File
+    # Cache of field content before save.
+    attr_accessor :unsaved_files
+
+    # Return file pathname for fiel field.
+    def field_filepath(field)
+      path = self.class.fields_files[field]
+      path = path.call(self) if path.is_a? Proc
+      PlainRecord.root(path)
+    end
+
+    private
+
+    # Define class variables and events in +klass+. It should be call once.
+    def self.install(klass)
+      klass.fields_files = { }
+
+      klass.before :load do |entry|
+        entry.unsaved_files = { }
+      end
+
+      klass.before :save do |entry|
+        entry.unsaved_files.each_pair do |file, value|
+          ::File.open(file, 'w') { |io| io << value; }
+        end
+        entry.unsaved_files = { }
+      end
+    end
+
+    module Model
+
+      # Field file paths.
+      attr_accessor :fields_files
+
+      private
+
+      # Filter to load field value from file.
+      def file(path = nil, &block)
+        proc do |model, field, type|
+          File.install(model) unless model.fields_files
+          model.fields_files[field] = block_given? ? block : path
+
+          model.add_accessors <<-EOS, __FILE__, __LINE__
+            def #{field}
+              path = field_filepath(:#{field})
+              return @unsaved_files[path] if @unsaved_files.has_key? path
+              return nil unless ::File.exists? path
+              ::File.read(path)
+            end
+
+            def #{field}=(value)
+              @unsaved_files[field_filepath(:#{field})] = value
+            end
+          EOS
+        end
+      end
+
+    end
+  end
+end

data/lib/plain_record/filepath.rb

@@ -59,8 +59,8 @@ module PlainRecord
     def in_filepath(number)
       proc do |model, field, type|
         if :virtual != type
-          raise ArgumentError, "You must create filepath field #{field}" +
-                               ' virtual creator'
+          raise ArgumentError,
+               "You must create filepath field #{field} virtual creator"
         end
 
         Filepath.install(model) unless model.filepath_fields
@@ -77,57 +77,56 @@ module PlainRecord
       end
     end
 
-    class << self
-      # 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_fields = { }
+    # Define class variables and events in +klass+. It should be call once on
+    # same class after +entry_in+ or +list_in+ call.
+    def self.install(klass)
+      klass.filepath_fields = { }
 
-        path = Regexp.escape(klass.path).gsub(/\\\*\\\*(\/|$)/, '(.*)').
-                                         gsub('\\*', '([^/]+)')
-        klass.filepath_regexp = Regexp.new(path)
+      path = Regexp.escape(klass.path).gsub(/\\\*\\\*(\/|$)/, '(.*)').
+                                       gsub('\\*', '([^/]+)')
+      klass.filepath_regexp = Regexp.new(path)
 
-        klass.class_eval do
-          attr_accessor :filepath_data
-        end
+      klass.class_eval do
+        attr_accessor :filepath_data
+      end
 
-        klass.after :load do |result, entry|
-          if entry.path
-            data = klass.filepath_regexp.match(entry.path)
-            entry.filepath_data = { }
-            klass.filepath_fields.each_pair do |number, name|
-              entry.filepath_data[name] = data[number]
-            end
-          else
-            entry.filepath_data = { }
-            klass.filepath_fields.each_value do |name|
-              entry.filepath_data[name] = entry.data[name]
-              entry.data.delete(name)
-            end
+      klass.after :load do |result, entry|
+        if entry.path
+          data = klass.filepath_regexp.match(entry.path)
+          entry.filepath_data = { }
+          klass.filepath_fields.each_pair do |number, name|
+            entry.filepath_data[name] = data[number]
+          end
+        else
+          entry.filepath_data = { }
+          klass.filepath_fields.each_value do |name|
+            entry.filepath_data[name] = entry.data[name]
+            entry.data.delete(name)
           end
-          result
         end
+        result
+      end
 
-        klass.after :path do |path, matchers|
-          i = 0
-          path.gsub /(\*\*(\/|$)|\*)/ do |pattern|
-            i += 1
-            field = klass.filepath_fields[i]
-            unless matchers[field].is_a? Regexp or matchers[field].nil?
-              matchers[field]
-            else
-              pattern
-            end
+      klass.after :path do |path, matchers|
+        i = 0
+        path.gsub /(\*\*(\/|$)|\*)/ do |pattern|
+          i += 1
+          field = klass.filepath_fields[i]
+          unless matchers[field].is_a? Regexp or matchers[field].nil?
+            matchers[field]
+          else
+            pattern
           end
         end
+      end
 
-        klass.before :save do |entry|
-          unless entry.file
-            path = klass.path(entry.filepath_data)
-            entry.file = path unless path =~ /[\*\[\?\{]/
-          end
+      klass.before :save do |entry|
+        unless entry.file
+          path = klass.path(entry.filepath_data)
+          entry.file = path unless path =~ /[\*\[\?\{]/
         end
       end
     end
+
   end
 end