plain_record 0.3 → 0.4

data/lib/plain_record/model.rb

@@ -44,7 +44,7 @@ module PlainRecord
     attr_accessor :virtuals
 
     # Storage type: +:entry+ or +:list+.
-    attr_reader :storage
+    attr_reader   :storage
 
     # Content of already loaded files.
     attr_accessor :loaded
@@ -85,8 +85,8 @@ module PlainRecord
     # Write all loaded entries to +file+.
     def save_file(file)
       if @loaded.has_key? file
-        File.open(file, 'w') do |io|
-          io.write entries_string(@loaded[file]).slice(5..-1)
+        ::File.open(file, 'w') do |io|
+          io << entries_string(@loaded[file]).slice(5..-1)
         end
       end
     end
@@ -202,7 +202,7 @@ module PlainRecord
 
     # Delete file, cache and empty dirs in path.
     def delete_file(file)
-      File.delete(file)
+      ::File.delete(file)
       @loaded.delete(file)
 
       path = Pathname(file).dirname

data/lib/plain_record/rails.rb

@@ -0,0 +1,38 @@
+=begin
+Ruby on Rails integration.
+
+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
+
+ActiveSupport.on_load(:after_initialize) do
+  PlainRecord.root = Rails.root.join('data')
+  PlainRecord::Extra::Image.dir = Rails.root.join('app/assets/images/data/')
+  PlainRecord::Extra::Image.url = 'data/'
+end
+
+module PlainRecord::RailsController
+  private
+  def plain_record_convert_images
+    Dir.glob(Rails.root.join('app/models/**/*.rb')) { |i| require_dependency i }
+    PlainRecord::Extra::Image.convert_images!
+  end
+end
+
+if Rails.env.development?
+  ActionController::Base.send(:include, PlainRecord::RailsController)
+  ActionController::Base.send(:before_filter, :plain_record_convert_images)
+end

data/lib/plain_record/resource.rb

@@ -48,12 +48,13 @@ module PlainRecord
   #     text    :content
   #   end
   module Resource
-    class << self
-      def included(base)
-        base.send :extend, Model
-      end
+    def self.included(base)
+      base.send :extend, Model
+      base.send :extend, PlainRecord::File::Model
     end
 
+    include PlainRecord::File
+
     # Fields values.
     attr_reader :data
 
@@ -102,8 +103,8 @@ module PlainRecord
           unless self.class.path =~ /[\*\[\?\{]/
             self.file = self.class.path
           else
-            raise ArgumentError, "There isn't file to save entry. " +
-                                 "Set filepath fields or file."
+            raise ArgumentError,
+                 "There isn't file to save entry. Set filepath fields or file."
           end
         end
 

data/lib/plain_record/type.rb

@@ -75,6 +75,7 @@ module PlainRecord
       Time    => 'v.is_a?(String) ? Time.parse(v) : v',
       Date    => 'v.is_a?(String) ? Date.parse(v) : v'
     }
+
     Type.stringifies = {
       String  => 'v ? v.to_s : v',
       Integer => 'v ? v.to_i : v',
@@ -82,5 +83,6 @@ module PlainRecord
       Time    => 'v ? v.strftime("%Y-%m-%d %H:%M:%S %Z") : v',
       Date    => 'v'
     }
+
   end
 end

data/lib/plain_record/version.rb

@@ -1,3 +1,3 @@
 module PlainRecord
-  VERSION = '0.3' unless defined? PlainRecord::VERSION
+  VERSION = '0.4' unless defined? PlainRecord::VERSION
 end

data/lib/plain_record.rb

@@ -31,13 +31,15 @@ require dir + 'filepath'
 require dir + 'association_proxy'
 require dir + 'associations'
 require dir + 'type'
+require dir + 'file'
 require dir + 'model'
 require dir + 'resource'
 
 module PlainRecord
   module Extra
-    autoload :Git,  'plain_record/extra/git'
-    autoload :I18n, 'plain_record/extra/i18n'
+    autoload :Git,   'plain_record/extra/git'
+    autoload :I18n,  'plain_record/extra/i18n'
+    autoload :Image, 'plain_record/extra/image'
   end
 
   class << self
@@ -47,7 +49,7 @@ module PlainRecord
     # as <tt>/content/</tt>).
     def root=(value)
       value  = value.to_s
-      value += File::SEPARATOR if File::SEPARATOR != value[-1..-1]
+      value += ::File::SEPARATOR if ::File::SEPARATOR != value[-1..-1]
       @root  = value
     end
 
@@ -55,13 +57,9 @@ module PlainRecord
     #
     # If you set +path+ it will be added to root path.
     def root(path = '')
-      File.join(@root, path)
+      ::File.join(@root, path)
     end
   end
 end
 
-if defined? Rails
-  ActiveSupport.on_load(:after_initialize) do
-    PlainRecord.root = Rails.root.join('data')
-  end
-end
+require(dir + 'rails') if defined? Rails

data/plain_record.gemspec

@@ -22,11 +22,14 @@ Gem::Specification.new do |s|
   s.email    = 'andrey@sitnik.ru'
   s.homepage = 'https://github.com/ai/plain_record'
 
+  s.add_dependency "escape", [">= 0"]
+
   s.add_development_dependency "bundler",   [">= 1.0.10"]
   s.add_development_dependency "yard",      [">= 0"]
   s.add_development_dependency "rake",      [">= 0"]
   s.add_development_dependency "rspec",     [">= 0"]
   s.add_development_dependency "redcarpet", [">= 0"]
-  s.add_development_dependency "r18n-core", [">= 0"]
+  s.add_development_dependency "r18n-core", [">= 1.0.0"]
   s.add_development_dependency "i18n",      [">= 0"]
+  s.add_development_dependency "rmagick",   [">= 0"]
 end

data/spec/associations_spec.rb

@@ -9,8 +9,9 @@ describe PlainRecord::Associations do
 
     class ::RatedPost
       include PlainRecord::Resource
-      entry_in 'data/3/post.md'
-      field :rate, one(::Rate)
+      entry_in 'data/*/post.md'
+      virtual :name, in_filepath(1)
+      field   :rate, one(::Rate)
     end
 
     class ::Comment
@@ -51,17 +52,21 @@ describe PlainRecord::Associations do
   end
 
   it "should load one-to-one real association" do
-    rate = ::RatedPost.first().rate
+    rate = ::RatedPost.first(:name => '3').rate
     rate.should be_instance_of(::Rate)
     rate.path.should == 'data/3/post.md'
     rate.data.should == { 'subject' => 5, 'text' => 2 }
   end
 
+  it "should return nil if one-to-one real association is empty" do
+    ::RatedPost.first(:name => '1').rate.should be_nil
+  end
+
   it "should save one-to-one real association" do
     file = StringIO.new
     File.should_receive(:open).with(anything(), 'w').and_yield(file)
 
-    ::RatedPost.first().save()
+    ::RatedPost.first(:name => '3').save()
 
     file.should has_yaml({ 'title' => 'Third',
                            'rate'  => { 'text' => 2, 'subject' => 5 } })

data/spec/file_spec.rb

@@ -0,0 +1,88 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe PlainRecord::File do
+
+  it "should calculate file path" do
+    locale = 'en'
+    klass = Class.new do
+      include PlainRecord::Resource
+      field   :name
+      virtual :a, file('a')
+      virtual :b, file { |i| "#{i.name}.#{locale}" }
+    end
+    one = klass.new
+
+    one.name = '1'
+    one.field_filepath(:a).should == PlainRecord.root('a')
+    one.field_filepath(:b).should == PlainRecord.root('1.en')
+  end
+
+  it "should read field from file" do
+    File.stub!(:exists?).and_return(true)
+    File.stub!(:read)
+
+    type = '1'
+    klass = Class.new do
+      include PlainRecord::Resource
+      virtual :a, file { type }
+    end
+
+    one = klass.new
+    File.should_receive(:read).with(PlainRecord.root('1')).and_return('A')
+    one.a.should == 'A'
+
+    type = '2'
+    File.should_receive(:read).with(PlainRecord.root('2')).and_return('B')
+    one.a.should == 'B'
+  end
+
+  it "should return if file is not exists" do
+    klass = Class.new do
+      include PlainRecord::Resource
+      virtual :a, file { 'a' }
+    end
+
+    one = klass.new
+    one.a.should be_nil
+  end
+
+  it "should cache new value" do
+    type = '1'
+    klass = Class.new do
+      include PlainRecord::Resource
+      virtual :a, file { type }
+    end
+
+    one = klass.new
+    one.a = 1
+    one.unsaved_files.should == { PlainRecord.root('1') => 1 }
+    one.a.should == 1
+
+    type = '2'
+    one.a = 2
+    one.unsaved_files.should == { PlainRecord.root('1') => 1,
+                                  PlainRecord.root('2') => 2 }
+    one.a.should == 2
+  end
+
+  it "should save new value to file" do
+    file = ''
+    File.stub!(:open)
+    File.should_receive(:open).with(PlainRecord.root('a'), 'w').and_yield(file)
+    File.should_receive(:open).with(PlainRecord.root('file'), 'w').and_yield("")
+
+    klass = Class.new do
+      include PlainRecord::Resource
+      entry_in 'file'
+      virtual :a, file('a')
+    end
+
+    one = klass.new
+    one.a = 'B'
+    one.save
+
+    one.unsaved_files.should == { }
+    file.should == 'B'
+  end
+
+end

data/spec/image_spec.rb

@@ -0,0 +1,149 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe PlainRecord::Extra::Image do
+
+  before do
+    PlainRecord::Extra::Image.dir = 'images/data/'
+    PlainRecord::Extra::Image.url = 'data/'
+
+    @klass = Class.new do
+      include PlainRecord::Resource
+      include PlainRecord::Extra::Image
+
+      image_from { |entry, field|       "#{entry.name}/#{field}.png" }
+      image_url  { |entry, field, size| "#{field}.#{size}.png" }
+
+      field   :name
+      virtual :logo,  image(:small => '16x16')
+      virtual :photo, image
+    end
+
+    @entry = @klass.new
+    @entry.name = 'a'
+  end
+
+  it "should throw error if there is no image_to" do
+    PlainRecord::Extra::Image.dir = nil
+    PlainRecord::Extra::Image.url = nil
+
+    lambda {
+      @klass.get_image_file(@entry, :logo, :small)
+    }.should raise_error(ArgumentError, /Image.dir/)
+
+    lambda {
+      PlainRecord::Extra::Image.convert_images!
+    }.should raise_error(ArgumentError, /Image.dir/)
+
+    lambda {
+      @klass.get_image_url(@entry, :logo, :small)
+    }.should raise_error(ArgumentError, /Image.url/)
+  end
+
+  it "should calculate paths" do
+    @klass.get_image_from(@entry, :logo).should ==
+      PlainRecord.root('a/logo.png')
+    @klass.get_image_file(@entry, :logo, :small).should ==
+      'images/data/logo.small.png'
+    @klass.get_image_url(@entry,  :logo, :small).should ==
+      'data/logo.small.png'
+  end
+
+  it "should return image data" do
+    @entry.logo.should_not be_exists
+    File.stub!(:exists?).and_return(true)
+    @entry.logo.should be_exists
+
+    @entry.logo.original.should == PlainRecord.root('a/logo.png')
+    @entry.logo.file.should be_nil
+    @entry.logo.url.should  be_nil
+    @entry.logo(:small).url.should       == 'data/logo.small.png'
+    @entry.logo(:small).file.should      == 'images/data/logo.small.png'
+    @entry.logo(:small).size.should      == '16x16'
+    @entry.logo(:small).width.should     ==  16
+    @entry.logo(:small).height.should    ==  16
+    @entry.logo(:small).size_name.should == :small
+    @entry.photo.url.should              == 'data/photo..png'
+  end
+
+  it "should copy image without size" do
+    File.stub!(:exists?)
+    File.should_receive(:exists?).
+      with(PlainRecord.root('a/logo.png')).and_return(false)
+    File.should_receive(:exists?).
+      with(PlainRecord.root('a/photo.png')).and_return(true)
+
+    FileUtils.stub!(:cp)
+    FileUtils.should_receive(:cp).
+      with(PlainRecord.root('a/photo.png'), 'images/data/photo..png')
+
+    @entry.convert_images!
+  end
+
+  it "should resize image", :unless => is_rbx do
+    File.stub!(:exists?)
+    File.should_receive(:exists?).
+      with(PlainRecord.root('a/logo.png')).and_return(true)
+
+    thumb = double('thumb')
+    thumb.stub!(:write)
+    thumb.should_receive(:write).with('images/data/logo.small.png')
+
+    original = double('original')
+    original.stub!(:resize)
+    original.should_receive(:resize).with(16, 16).and_return(thumb)
+
+    require 'RMagick'
+    Magick::Image.stub!(:read)
+    Magick::Image.should_receive(:read).
+      with(PlainRecord.root('a/logo.png')).and_return([original])
+
+    @entry.convert_images!
+  end
+
+  it "should remember all models, which use extention" do
+    PlainRecord::Extra::Image.included_in = []
+
+    one = Class.new do
+      include PlainRecord::Resource
+      include PlainRecord::Extra::Image
+    end
+    two = Class.new do
+      include PlainRecord::Resource
+      include PlainRecord::Extra::Image
+    end
+
+    PlainRecord::Extra::Image.included_in.should == [one, two]
+  end
+
+  it "should delete all old image" do
+    PlainRecord::Extra::Image.included_in = [@klass]
+
+    def @klass.entry
+      @entry ||= self.new
+    end
+    def @klass.all
+      [entry]
+    end
+
+    Dir.stub!(:glob).and_yield('images/data/a.png')
+    Dir.should_receive(:glob).with('images/data/**/*')
+
+    File.stub!(:exists?).and_return(true)
+    File.should_receive(:exists?).with('images/data/a.png')
+
+    FileUtils.stub!(:rm_r)
+    FileUtils.should_receive(:rm_r).with('images/data/a.png')
+
+    @klass.entry.stub(:convert_images!)
+    @klass.entry.should_receive(:convert_images!)
+
+    PlainRecord::Extra::Image.convert_images!
+  end
+
+  it "should return right error on wrong size" do
+    lambda {
+      @entry.logo(:no)
+    }.should raise_error(ArgumentError, "Field `logo` doesn't have `no` size")
+  end
+
+end

data/spec/spec_helper.rb

@@ -61,3 +61,7 @@ RSpec::Matchers.define :has_yaml do |data|
     YAML.load(file.read).should == data
   end
 end
+
+def is_rbx
+  defined?(RUBY_ENGINE) and RUBY_ENGINE == 'rbx'
+end

metadata

@@ -1,93 +1,160 @@
 --- !ruby/object:Gem::Specification
 name: plain_record
 version: !ruby/object:Gem::Version
-  version: '0.3'
   prerelease: 
+  version: '0.4'
 platform: ruby
 authors:
 - Andrey "A.I." Sitnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  type: :runtime
+  name: escape
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  type: :development
   name: bundler
-  requirement: &23439240 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.10
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.10
-  type: :development
   prerelease: false
-  version_requirements: *23439240
 - !ruby/object:Gem::Dependency
+  type: :development
   name: yard
-  requirement: &23438660 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *23438660
 - !ruby/object:Gem::Dependency
+  type: :development
   name: rake
-  requirement: &23438060 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *23438060
 - !ruby/object:Gem::Dependency
+  type: :development
   name: rspec
-  requirement: &23437480 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *23437480
 - !ruby/object:Gem::Dependency
+  type: :development
   name: redcarpet
-  requirement: &23436940 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *23436940
 - !ruby/object:Gem::Dependency
+  type: :development
   name: r18n-core
-  requirement: &23436360 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.0.0
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   prerelease: false
-  version_requirements: *23436360
 - !ruby/object:Gem::Dependency
+  type: :development
   name: i18n
-  requirement: &23435760 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
   type: :development
+  name: rmagick
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   prerelease: false
-  version_requirements: *23435760
 description: ! "    Plain Record is a data persistence, which use human editable and\n
   \   readable plain text files. It's ideal for static generated sites,\n    like
   blog or homepage.\n"
@@ -116,10 +183,13 @@ files:
 - lib/plain_record/default.rb
 - lib/plain_record/extra/git.rb
 - lib/plain_record/extra/i18n.rb
+- lib/plain_record/extra/image.rb
+- lib/plain_record/file.rb
 - lib/plain_record/filepath.rb
 - lib/plain_record/model.rb
 - lib/plain_record/model/entry.rb
 - lib/plain_record/model/list.rb
+- lib/plain_record/rails.rb
 - lib/plain_record/resource.rb
 - lib/plain_record/type.rb
 - lib/plain_record/version.rb
@@ -135,9 +205,11 @@ files:
 - spec/data/authors/intern.yml
 - spec/data/best/4/post.md
 - spec/default_spec.rb
+- spec/file_spec.rb
 - spec/filepath_spec.rb
 - spec/git_spec.rb
 - spec/i18n_spec.rb
+- spec/image_spec.rb
 - spec/model_spec.rb
 - spec/plain_record_spec.rb
 - spec/resource_spec.rb
@@ -154,22 +226,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
       segments:
       - 0
-      hash: -2998465728385447997
+      hash: -1633277468961939816
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2998465728385447997
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Data persistence, which use human editable and readable plain text files.