static-record 1.0.0.pre.2 → 1.0.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8161a80bb87cca0d2ed854c4f92b9d105c9bf155
-  data.tar.gz: 44030ffa8c6d7095b5160f4c807e881ca65b33d8
+  metadata.gz: 7a3706048403361650a6116e13d8e88d6afd574d
+  data.tar.gz: e3576955961ae0c8f612feae91608eb589e718cd
 SHA512:
-  metadata.gz: 6ab0ef1663587e2d2e495802305bc8c568b81dbdb72f56d49b8743f80071714054c7af9a6863c4f3ae70fcd3019c3bf9f61373b7adb640c60f78b93725424ef3
-  data.tar.gz: 5aca5a3f02caa4bbc8add5b73c037306984c7380018f749c17ff9398b8f14678e15edc177bd371450a894cf2bc5bae740a8d48c3342deee43e8a0ae2309bbfbe
+  metadata.gz: 22b0f67f4373b06df4555dbbb99464b914414a8c9e6c21d383964959efd17d7d179a560c5f9ec4597e5124b8555dd72c895e7c84f7b12cbfec8f2d15beb1a5c5
+  data.tar.gz: 57fe5f972a3c944fb0ebb17a2cfddc6d53c3c4ba03951e2ca8928a8052c140f3b3fddfe747b51f0d82dd6b97369f68f5fc71ac2fa0079bbe10e9e803d00dabc6

data/README.rdoc

@@ -1,5 +1,7 @@
 = StaticRecord
 
+{<img src="https://badge.fury.io/rb/static-record.svg" alt="Gem Version" />}[https://badge.fury.io/rb/static-record] {<img src="https://codeclimate.com/github/hchevalier/static_record/badges/gpa.svg" />}[https://codeclimate.com/github/hchevalier/static_record] {<img src="https://travis-ci.org/hchevalier/static_record.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/hchevalier/static_record]
+
 StaticRecord allows you to perform ActiveRecord-like queries over ruby files.
 
 Those files act as immutable database records that only developers can alter.
@@ -10,7 +12,7 @@ You can use it when you need several files inheriting a base class.
 
 Add this to your Gemfile:
 
-  gem 'static_record', require: 'static_record'
+  gem 'static-record', require: 'static_record'
 
 and run the bundle install command.
 
@@ -31,15 +33,23 @@ Create your base class inheriting from StaticRecord::Base.
     path        Rails.root.join('app', 'models', 'articles', '**', '*.rb')
 
     # Optionnal, declare which column can be used as the primary key (must be unique)
-    # .find will only be availble if a primary key is defined
+    # .find will only be available if a primary key is defined
     primary_key :name
 
-    # Specify which "article" attributes can be queried over
-    columns     [:name, :author, :rank]
+    # Specify which "article" attributes can be queried over with their types
+    columns     name:   :string,
+                author: :string,
+                rank:   :integer
   end
 
 At each application startup, an SQLite3 database will be created to store this class' children.
 
+Available column types are
+- :string
+- :integer
+- :boolean
+- :float
+
 === Child class
 
 Create has many child class as you want.
@@ -48,7 +58,7 @@ Create has many child class as you want.
     # Define the attributes that will be available for your StaticRecord queries
     attribute :name, 'Article One'
     attribute :author, 'The author'
-    attribute :rank, '2'
+    attribute :rank, 2
 
     # Your class can be used as any other Ruby class
     def initialize
@@ -67,17 +77,17 @@ Create has many child class as you want.
 
 In your code, you can perform queries like this one:
 
-Article.where(name: 'Article Two').or.where.not(author: ['Author 1', 'Author 2']).limit(2).offset(3)
+Article.where(name: 'Article Two').or.where('rank >= 2').limit(2).offset(3)
 
 I tried to implement as many SQL functions wrappers that ActiveRecord provides as I could.
 
-There is still a lot of work before everything is available, but I chosed to release the 1.0.0.pre nevertheless.
+There is still a lot of work before everything is available, but I chose to release the 1.0.0.pre nevertheless.
 
 Here is a full list:
 * where
   * supports Hash -> where(name: 'Name', author: 'Author')
   * supports String -> where("name = 'Name'") or where("name = ?", 'Name') or where("name = :name", name: 'Name')
-* find (requires a primary key has been set)
+* find (only if a primary key has been set)
 * find_by
 * not
 * or
@@ -109,7 +119,6 @@ As StaticRecord is in active development and a full list of feature is already s
 
 Here is what will be available soon:
 - Better documentation
-- Typed attributes
-- Foreign keys
+- Support for Date, Datetime and Foreign keys
 - Joins
 - Generators

data/Rakefile

@@ -20,3 +20,11 @@ load 'rails/tasks/engine.rake'
 load 'rails/tasks/statistics.rake'
 
 Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = Dir.glob('../spec/**/*_spec.rb')
+end
+task :default => :spec

data/lib/static_record/concerns/sqlite_storing_concern.rb

@@ -6,15 +6,15 @@ module StaticRecord
 
     module ClassMethods # :nodoc:
       def create_store
-        columns = class_variable_get(:@@_columns)
+        cols = class_variable_get(:@@_columns)
         begin
           dbname = Rails.root.join('db', "static_#{store}.sqlite3").to_s
           SQLite3::Database.new(dbname)
           db = SQLite3::Database.open(dbname)
           db.execute("DROP TABLE IF EXISTS #{store}")
-          create_table(db, columns)
+          create_table(db, cols)
           load_records.each_with_index do |record, index|
-            insert_into_database(db, record, index, columns)
+            insert_into_database(db, record, index, cols)
           end
         rescue SQLite3::Exception => e
           puts 'Exception occurred', e
@@ -25,16 +25,34 @@ module StaticRecord
 
       private
 
-      def create_table(db, columns)
-        cols = columns.map { |c| c.to_s + ' TEXT' }.join(', ')
-        sql = "CREATE TABLE #{store}(id INTEGER PRIMARY KEY, klass TEXT, #{cols})"
+      def create_table(db, cols)
+        attr_list = []
+        cols.each do |c, v|
+          attr_list << c.to_s + column_type_to_sql(v)
+        end
+        str_attr = attr_list.join(', ')
+        sql = "CREATE TABLE #{store}(id INTEGER PRIMARY KEY, klass TEXT, #{str_attr})"
         db.execute(sql)
       end
 
-      def insert_into_database(db, record, index, columns)
+      def column_type_to_sql(ctype)
+        case ctype.to_s
+        when 'string'
+          ' TEXT'
+        else
+          " #{ctype.to_s.upcase}"
+        end
+      end
+
+      def insert_into_database(db, record, index, cols)
         attrs = record.constantize.new.attributes
-        sqlized = [index.to_s, "'#{record}'"] # id, klass
-        sqlized += columns.map { |c| "'#{attrs[c]}'" } # model's attributes
+        # id, klass
+        sqlized = [index.to_s, "'#{record}'"]
+        # model's attributes
+        sqlized += cols.map do |name, ctype|
+          ctype == :integer ? attrs[name].to_s : "'#{attrs[name]}'"
+        end
+
         db.execute("INSERT INTO #{store} VALUES(#{sqlized.join(', ')})")
       end
 

data/lib/static_record/exceptions.rb

@@ -2,4 +2,5 @@ module StaticRecord
   class RecordNotFound < RuntimeError; end
   class ReservedAttributeName < RuntimeError; end
   class NoPrimaryKey < RuntimeError; end
+  class UnkownType < RuntimeError; end
 end

data/lib/static_record/models/base.rb

@@ -11,6 +11,13 @@ module StaticRecord
       :@@_store
     ].freeze
 
+    KNOWN_TYPES = [
+      :string,
+      :boolean,
+      :integer,
+      :float
+    ].freeze
+
     def initialize
       attributes.each do |attr, value|
         instance_variable_set "@#{attr}", value
@@ -67,5 +74,9 @@ module StaticRecord
       class_variable_set('@@_columns', cols)
       create_store
     end
+
+    def self.get_column_type(column)
+      class_variable_get(:@@_columns)[column]
+    end
   end
 end

data/lib/static_record/version.rb

@@ -1,3 +1,3 @@
 module StaticRecord
-  VERSION = '1.0.0.pre.2'.freeze
+  VERSION = '1.0.0.pre.3'.freeze
 end

data/spec/models/static_record/base_spec.rb

@@ -12,6 +12,6 @@ RSpec.describe StaticRecord::Base, :type => :model do
     article = Article.find('Article One')
     expect(article.name).to eql('Article One')
     expect(article.author).to eql('The author')
-    expect(article.rank).to eql('2')
+    expect(article.rank).to eql(2)
   end
 end

data/spec/models/static_record/querying_spec.rb

@@ -5,4 +5,12 @@ RSpec.describe StaticRecord::Querying, :type => :model do
   it 'delegates requests to StaticRecord::Relation' do
     expect(Article.where(author: 'The author')).to be_a(StaticRecord::Relation)
   end
+
+  it 'returns a new StaticRecord::Relation for each method chaining node' do
+    first_node = Article.where(author: 'The author')
+    expect(first_node).to be_a(StaticRecord::Relation)
+    second_node = first_node.where(rank: 3)
+    expect(second_node).to be_a(StaticRecord::Relation)
+    expect(second_node).not_to eql(first_node)
+  end
 end

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

@@ -2,5 +2,8 @@ class Article < StaticRecord::Base
   table       :articles
   path        Rails.root.join('app', 'models', 'articles', '**', '*.rb')
   primary_key :name
-  columns     [:name, :author, :rank]
+
+  columns     name:   :string,
+              author: :string,
+              rank:   :integer
 end

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

@@ -1,5 +1,5 @@
 class ArticleFour < Article
   attribute :name, 'Article Four'
   attribute :author, 'Me'
-  attribute :rank, '3'
+  attribute :rank, 3
 end

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

@@ -1,5 +1,5 @@
 class ArticleOne < Article
   attribute :name, 'Article One'
   attribute :author, 'The author'
-  attribute :rank, '2'
+  attribute :rank, 2
 end

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

@@ -1,5 +1,5 @@
 class ArticleThree < Article
   attribute :name, 'Article Three'
   attribute :author, 'Another author'
-  attribute :rank, '1'
+  attribute :rank, 1
 end

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

@@ -1,5 +1,5 @@
 class ArticleTwo < Article
   attribute :name, 'Article Two'
   attribute :author, 'The author'
-  attribute :rank, '3'
+  attribute :rank, 3
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static-record
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.2
+  version: 1.0.0.pre.3
 platform: ruby
 authors:
 - Hugo Chevalier
@@ -28,56 +28,70 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.12
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.12
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.2
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.2
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.46.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.46.0
 description: |2