static-record 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7da53ed48dde6c544df166fad92cba19ba41114a
-  data.tar.gz: eb494a5eab6d82746d0654fcddc20b2d5d6cfc8c
+  metadata.gz: 4d06c5fc59b117a47f86a218489bd6d95f68cfbe
+  data.tar.gz: 68da7ab138c5dbd25db2cbd359acc30296f0eb16
 SHA512:
-  metadata.gz: eec734004a50419ddedfd06c5d8c44432f73ac58cc7e3280407ce95ce775a559d9e98ae2ec618d04293c58dfb15afa3ad5a8efd80a5147e62f5900750d228eb4
-  data.tar.gz: ebee3f534fc292c7f80c9f0d7e0f80aca269f4e02e336198670665d0468c7f628e8fdea2ebd39021d871d4da36dc302f4727c861c41e13d8641ebb2f59b9c0e2
+  metadata.gz: 5c2535dc8d88779a4d1489dc21dfd8a3c00ef13ff6c7d98869b1c87eb30c68edba56d9d01529cc17f582e946969fff2ff26858d38cdf7e5c37e1344febc8b1b1
+  data.tar.gz: 46ccc4996e2c053e29e153cb8101c44b3aaa58e5a6b4cf1e14a37404f5f36cf8bf24aea4bc1d5224239b411bc7817f891b03a26a5f494a7a696c7262bd6b68d5

data/README.rdoc

@@ -36,10 +36,24 @@ Create your base class inheriting from StaticRecord::Base.
     # .find will only be available if a primary key is defined
     primary_key :name
 
+    # You can specify default values for each column of your static records
+    # Just create a method with name: default_<attribute_name>
+    def default_author
+      'Default author'
+    end
+
+    # You can override any attribute value
+    # Just create a method with name: override_<attribute_name>
+    def override_cover(cover)
+      return cover if cover.to_s.include?('/')
+      Rails.root.join('public', 'default_cover_path', cover)
+    end
+
     # Specify which "article" attributes can be queried over with their types
     columns     name:   :string,
                 author: :string,
-                rank:   :integer
+                rank:   :integer,
+                cover:  :string
   end
 
 At each application startup, an SQLite3 database will be created to store this class' children.
@@ -59,6 +73,7 @@ Create has many child class as you want.
     attribute :name, 'Article One'
     attribute :author, 'The author'
     attribute :rank, 2
+    attribute :cover, Rails.root.join('public', 'articles', 'one.jpg')
 
     # Your class can be used as any other Ruby class
     def initialize

data/lib/static_record/exceptions.rb

@@ -1,6 +1,7 @@
 module StaticRecord
   class RecordNotFound < RuntimeError; end
   class ReservedAttributeName < RuntimeError; end
+  class MissingAttribute < RuntimeError; end
   class NoPrimaryKey < RuntimeError; end
   class UnkownType < RuntimeError; end
   class ClassError < RuntimeError; end

data/lib/static_record/models/base.rb

@@ -67,7 +67,7 @@ module StaticRecord
         next if RESERVED_ATTRIBUTES.include?(var)
         attrs[var.to_s.sub(/@@/, '').to_sym] = klass.class_variable_get(var)
       end
-      attrs
+      default_attributes(attrs)
     end
 
     def self.columns(cols)
@@ -78,5 +78,31 @@ module StaticRecord
     def self.get_column_type(column)
       class_variable_get(:@@_columns)[column]
     end
+
+    private
+
+    def default_attributes(attrs)
+      klass = self.class
+      klass.class_variable_get(:@@_columns).each do |column, _ctype|
+        column_defined = attrs.key?(column)
+        unless column_defined || default?(column)
+          err = "You must define attribute '#{column}' for #{klass.name}"
+          raise StaticRecord::MissingAttribute, err
+        end
+
+        v = column_defined ? attrs[column] : klass.send(:"default_#{column}")
+        v = klass.send(:"override_#{column}", v) if override?(column)
+        attrs[column] = v
+      end
+      attrs
+    end
+
+    def default?(column)
+      self.class.respond_to?("default_#{column}")
+    end
+
+    def override?(column)
+      self.class.respond_to?("override_#{column}")
+    end
   end
 end

data/lib/static_record/models/query_interface/search_modifiers.rb

@@ -4,7 +4,7 @@ module StaticRecord
     # Contains search modifiers
     module SearchModifiers
       private
-    
+
       def limit(amount)
         @sql_limit = amount
         self

data/lib/static_record/version.rb

@@ -1,3 +1,3 @@
 module StaticRecord
-  VERSION = '1.0.1'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/models/default_value_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'rails_helper'
+
+RSpec.describe StaticRecord::Base, :type => :module do
+  it 'calls default_<column> method when attribute is not defined' do
+    article = Article.find('Article Five')
+    expect(article.author).to eql(Article.default_author)
+    expect(article.rank).to eql(Article.default_rank)
+  end
+
+  it 'calls override_<column> method to override attribute when available' do
+    article = Article.find('Article Five')
+    expect(article.cover).to eql(Rails.root.join('public', 'articles', 'cover', 'article_five.jpg'))
+  end
+
+  it 'raises an error when attribute is not defined and no default method exists' do
+    err = "You must define attribute 'description' for BadgeOne"
+    expect { Badge.find('Badge One') }.to raise_error(StaticRecord::MissingAttribute, err)
+  end
+end

data/spec/models/relation_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe StaticRecord::Relation, :type => :model do
 
   context '.all' do
     it 'returns all results' do
-      expect(Article.all.count).to eql(4)
+      expect(Article.all.count).to eql(5)
       expect(Article.see_sql_of.all).to eql("SELECT * FROM articles")
     end
   end
@@ -18,7 +18,7 @@ RSpec.describe StaticRecord::Relation, :type => :model do
   context '.order' do
     context 'with a symbol' do
       it 'returns results ordered' do
-        expected = [ArticleFour, ArticleOne, ArticleThree, ArticleTwo]
+        expected = [ArticleFive, ArticleFour, ArticleOne, ArticleThree, ArticleTwo]
         expect(Article.order(:name).all.map(&:class)).to eql(expected)
         expect(Article.order(:name).to_sql).to eql("SELECT * FROM articles ORDER BY articles.name ASC")
       end
@@ -26,7 +26,7 @@ RSpec.describe StaticRecord::Relation, :type => :model do
 
     context 'with a string' do
       it 'returns results ordered' do
-        expected = [ArticleTwo, ArticleThree, ArticleOne, ArticleFour]
+        expected = [ArticleTwo, ArticleThree, ArticleOne, ArticleFour, ArticleFive]
         expect(Article.order("name DESC").all.map(&:class)).to eql(expected)
         expect(Article.order("name DESC").to_sql).to eql("SELECT * FROM articles ORDER BY name DESC")
       end
@@ -34,13 +34,13 @@ RSpec.describe StaticRecord::Relation, :type => :model do
 
     context 'with a hash' do
       it 'returns results ordered with one key' do
-        expected = [ArticleFour, ArticleOne, ArticleThree, ArticleTwo]
+        expected = [ArticleFive, ArticleFour, ArticleOne, ArticleThree, ArticleTwo]
         expect(Article.order(name: :asc).all.map(&:class)).to eql(expected)
         expect(Article.order(name: :asc).to_sql).to eql("SELECT * FROM articles ORDER BY articles.name ASC")
       end
 
       it 'returns results ordered with serveral keys' do
-        expected = [ArticleThree, ArticleOne, ArticleTwo, ArticleFour]
+        expected = [ArticleThree, ArticleOne, ArticleTwo, ArticleFour, ArticleFive]
         expect(Article.order(rank: :asc, name: :desc).all.map(&:class)).to eql(expected)
         expect(Article.order(rank: :asc, name: :desc).to_sql).to eql("SELECT * FROM articles ORDER BY articles.rank ASC, articles.name DESC")
       end
@@ -48,13 +48,13 @@ RSpec.describe StaticRecord::Relation, :type => :model do
 
     context 'with an array' do
       it 'returns results ordered with one key' do
-        expected = [ArticleFour, ArticleOne, ArticleThree, ArticleTwo]
+        expected = [ArticleFive, ArticleFour, ArticleOne, ArticleThree, ArticleTwo]
         expect(Article.order([:name]).all.map(&:class)).to eql(expected)
         expect(Article.order([:name]).to_sql).to eql("SELECT * FROM articles ORDER BY articles.name ASC")
       end
 
       it 'returns results ordered with several keys' do
-        expected = [ArticleThree, ArticleOne, ArticleFour, ArticleTwo]
+        expected = [ArticleThree, ArticleOne, ArticleFive, ArticleFour, ArticleTwo]
         expect(Article.order([:rank, :name]).all.map(&:class)).to eql(expected)
         expect(Article.order([:rank, :name]).to_sql).to eql("SELECT * FROM articles ORDER BY articles.rank ASC, articles.name ASC")
       end
@@ -64,14 +64,14 @@ RSpec.describe StaticRecord::Relation, :type => :model do
   context '.first' do
     context 'without parameter' do
       it 'returns first record ordered by primary key' do
-        expect(Article.first.class).to eql(ArticleFour)
+        expect(Article.first.class).to eql(ArticleFive)
         expect(Article.see_sql_of.first).to eql("SELECT * FROM articles ORDER BY articles.name ASC LIMIT 1")
       end
     end
 
     context 'with a parameter' do
       it 'orders records by primary key and returns up to specified number of records from the beginning' do
-        expect(Article.first(2).map(&:class)).to eql([ArticleFour, ArticleOne])
+        expect(Article.first(2).map(&:class)).to eql([ArticleFive, ArticleFour])
         expect(Article.see_sql_of.first(2)).to eql("SELECT * FROM articles ORDER BY articles.name ASC LIMIT 2")
       end
     end
@@ -107,14 +107,14 @@ RSpec.describe StaticRecord::Relation, :type => :model do
 
   context '.limit' do
     it 'returns up to specified number of records' do
-      expect(Article.limit(2).all.map(&:class)).to eql([ArticleFour, ArticleOne])
+      expect(Article.limit(2).all.map(&:class)).to eql([ArticleFive, ArticleFour])
       expect(Article.limit(2).to_sql).to eql("SELECT * FROM articles LIMIT 2")
     end
   end
 
   context '.limit.offset' do
     it 'returns up to specified number of records with specified offset' do
-      expect(Article.limit(2).offset(1).all.map(&:class)).to eql([ArticleOne, ArticleThree])
+      expect(Article.limit(2).offset(1).all.map(&:class)).to eql([ArticleFour, ArticleOne])
       expect(Article.limit(2).offset(1).to_sql).to eql("SELECT * FROM articles LIMIT 2 OFFSET 1")
     end
   end

data/spec/test_app/app/models/article.rb

@@ -3,8 +3,25 @@ class Article < StaticRecord::Base
   path        Rails.root.join('app', 'models', 'articles', '**', '*.rb')
   primary_key :name
 
+  def self.default_author
+    'Default author'
+  end
+
+  def self.default_rank
+    3
+  end
+
+  def self.override_cover(cover)
+    unless cover.to_s.include?('/')
+      folder = Rails.root.join('public', 'articles', 'cover').itself
+      return folder + cover
+    end
+    cover
+  end
+
   columns     name:       :string,
               author:     :string,
               rank:       :integer,
-              important:  :boolean
+              important:  :boolean,
+              cover:      :string
 end

data/spec/test_app/app/models/articles/article_five.rb

@@ -0,0 +1,5 @@
+class ArticleFive < Article
+  attribute :name, 'Article Five'
+  attribute :important, false
+  attribute :cover, 'article_five.jpg'
+end

data/spec/test_app/app/models/articles/article_four.rb

@@ -3,4 +3,5 @@ class ArticleFour < Article
   attribute :author, 'Me'
   attribute :rank, 3
   attribute :important, false
+  attribute :cover, Rails.root.join('public', 'articles', 'cover', 'article_four.jpg')
 end

data/spec/test_app/app/models/articles/article_one.rb

@@ -3,4 +3,5 @@ class ArticleOne < Article
   attribute :author, 'The author'
   attribute :rank, 2
   attribute :important, false
+  attribute :cover, Rails.root.join('public', 'articles', 'cover', 'article_one.jpg')
 end

data/spec/test_app/app/models/articles/article_three.rb

@@ -3,4 +3,5 @@ class ArticleThree < Article
   attribute :author, 'Another author'
   attribute :rank, 1
   attribute :important, true
+  attribute :cover, Rails.root.join('public', 'articles', 'cover', 'article_three.jpg')
 end

data/spec/test_app/app/models/articles/article_two.rb

@@ -3,4 +3,5 @@ class ArticleTwo < Article
   attribute :author, 'The author'
   attribute :rank, 3
   attribute :important, true
+  attribute :cover, Rails.root.join('public', 'articles', 'cover', 'article_two.jpg')
 end

data/spec/test_app/app/models/badge.rb

@@ -0,0 +1,6 @@
+class Badge < StaticRecord::Base
+  table     :badges
+  path      Rails.root.join('app', 'models', 'badges', '**', '*.rb')
+  columns   name:         :string,
+            description:  :string
+end

data/spec/test_app/app/models/badges/badge_one.rb

@@ -0,0 +1,3 @@
+class BadgeOne < Badge
+  attribute :name, 'Badge One'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: static-record
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Hugo Chevalier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2016-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -164,6 +164,7 @@ files:
 - spec/helpers/migration_has_been_run.rb
 - spec/migrations/railtie_spec.rb
 - spec/models/base_spec.rb
+- spec/models/default_value_spec.rb
 - spec/models/querying_spec.rb
 - spec/models/relation_spec.rb
 - spec/rails_helper.rb
@@ -171,10 +172,13 @@ files:
 - spec/test_app/app/controllers/application_controller.rb
 - spec/test_app/app/helpers/application_helper.rb
 - spec/test_app/app/models/article.rb
+- spec/test_app/app/models/articles/article_five.rb
 - spec/test_app/app/models/articles/article_four.rb
 - spec/test_app/app/models/articles/article_one.rb
 - spec/test_app/app/models/articles/article_three.rb
 - spec/test_app/app/models/articles/article_two.rb
+- spec/test_app/app/models/badge.rb
+- spec/test_app/app/models/badges/badge_one.rb
 - spec/test_app/app/models/role.rb
 - spec/test_app/app/models/roles/role_one.rb
 - spec/test_app/app/models/roles/role_two.rb
@@ -227,6 +231,7 @@ test_files:
 - spec/helpers/migration_has_been_run.rb
 - spec/migrations/railtie_spec.rb
 - spec/models/base_spec.rb
+- spec/models/default_value_spec.rb
 - spec/models/querying_spec.rb
 - spec/models/relation_spec.rb
 - spec/rails_helper.rb
@@ -234,10 +239,13 @@ test_files:
 - spec/test_app/app/controllers/application_controller.rb
 - spec/test_app/app/helpers/application_helper.rb
 - spec/test_app/app/models/article.rb
+- spec/test_app/app/models/articles/article_five.rb
 - spec/test_app/app/models/articles/article_four.rb
 - spec/test_app/app/models/articles/article_one.rb
 - spec/test_app/app/models/articles/article_three.rb
 - spec/test_app/app/models/articles/article_two.rb
+- spec/test_app/app/models/badge.rb
+- spec/test_app/app/models/badges/badge_one.rb
 - spec/test_app/app/models/role.rb
 - spec/test_app/app/models/roles/role_one.rb
 - spec/test_app/app/models/roles/role_two.rb