cequel 1.2.6 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a64f78d32fbb2e223d8537d5f0cf8c7ff61ed81c
-  data.tar.gz: 50b4f001571a9aa00025e5e0b46a845dc8b70ae1
+  metadata.gz: bcbe817545ecdf0979da9b91e5e790965efdf8c4
+  data.tar.gz: acaede9ff87f4f1c379ab0f47dcba0f110905b45
 SHA512:
-  metadata.gz: 297d35f852f20151515ebba24607a7c13873f1a4930e365f75b1a9adf4352b7b14bc8a57b7e4f2348d64b2107631fff4b2f20bf5a8e385286df5143e3fff3faa
-  data.tar.gz: a12d232abd033573eaa674dd280dfee4d16a6775604ce510d23c7336190aa9572cf3cc4f23213e8bd5e41bd11a045ac7d5d44bbf579832ca78b6b0d6dddc1ad2
+  metadata.gz: 17b5623a4df15734d13f9c8d6bcef023d3b5a814582827260448a989c25832d4f95f8eda338a7bb322a5aeecc5e9ec04b6714b510719ec43d0e4531eaa84cca9
+  data.tar.gz: f75aac91c4ea18db149196aeaf3024a014bf5decc6a258b232c8c4c98fe2f41334d75d04b707d0ac459f990d104c606f68cd8717d2b3ab1954cd92cd098ca7d4

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.3.0
+
+* Add timestamps functionality (`created_at` and `updated_at`)
+* More robust error handling when loading models for migrations
+* Expose `#column_names` on Record and Schema
+
 ## 1.2.6
 
 * Fixes for Type::quote

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cequel (1.2.6)
+    cequel (1.3.0)
       activemodel (>= 3.1, < 5.0)
       cql-rb (~> 1.2)
 
@@ -27,7 +27,7 @@ GEM
       debugger-linecache (~> 1.2)
     coderay (1.1.0)
     columnize (0.8.9)
-    cql-rb (1.2.1)
+    cql-rb (1.2.2)
     debugger (1.6.6)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.2.0)
@@ -279,9 +279,10 @@ GEM
     slop (3.5.0)
     spoon (0.0.4)
       ffi
-    thread_safe (0.3.3)
-    thread_safe (0.3.3-java)
-    tzinfo (1.1.0)
+    thread_safe (0.3.4)
+    thread_safe (0.3.4-java)
+    timecop (0.7.1)
+    tzinfo (1.2.0)
       thread_safe (~> 0.1)
     yard (0.8.7.4)
 
@@ -301,4 +302,5 @@ DEPENDENCIES
   rspec (~> 2.0)
   rubocop (~> 0.19.0)
   rubysl (~> 2.0)
+  timecop (~> 0.7)
   yard (~> 0.6)

data/README.md

@@ -115,6 +115,27 @@ class PostsController < ActionController::Base
 end
 ```
 
+### Timestamps ###
+
+If your final primary key column is a `timeuuid` with the `:auto` option set,
+the `created_at` method will return the time that the UUID key was generated.
+
+To add timestamp columns, simply use the `timestamps` class macro:
+
+```ruby
+class Blog
+  key :subdomain, :text
+  column :name, :text
+  timestamps
+end
+```
+
+This will automatically define `created_at` and `updated_at` columns, and
+populate them appropriately on save.
+
+If the creation time can be extracted from the primary key as outlined above,
+this method will be preferred and no `created_at` column will be defined.
+
 ### Schema synchronization ###
 
 Cequel will automatically synchronize the schema stored in Cassandra to match
@@ -541,6 +562,7 @@ Cequel was written by:
 * Ilya Bazylchuk
 * Dan Cardamore
 * Kei Kusakari
+* Oleh Novosad
 
 Special thanks to [Brewster](https://www.brewster.com), which supported the 0.x
 releases of Cequel.

data/lib/cequel/record.rb

@@ -23,6 +23,7 @@ require 'cequel/record/callbacks'
 require 'cequel/record/validations'
 require 'cequel/record/dirty'
 require 'cequel/record/conversion'
+require 'cequel/record/timestamps'
 
 require 'cequel/record'
 
@@ -93,6 +94,7 @@ module Cequel
       include Conversion
       include ActiveModel::Serializers::JSON
       include ActiveModel::Serializers::Xml
+      include Timestamps
     end
 
     #

data/lib/cequel/record/schema.rb

@@ -39,6 +39,9 @@ module Cequel
         # @!attribute [r] columns
         #   (see Cequel::Schema::Table#columns)
         #
+        # @!attribute [r] column_names
+        #   (see Cequel::Schema::Table#column_names)
+        #
         # @!attribute [r] key_columns
         #   (see Cequel::Schema::Table#key_columns)
         #
@@ -57,7 +60,7 @@ module Cequel
         # @!method compact_storage?
         #   (see Cequel::Schema::Table#compact_storage?)
         #
-        def_delegators :table_schema, :columns, :key_columns,
+        def_delegators :table_schema, :columns, :column_names, :key_columns,
                        :key_column_names, :partition_key_columns,
                        :partition_key_column_names, :clustering_columns,
                        :compact_storage?

data/lib/cequel/record/tasks.rb

@@ -38,7 +38,7 @@ namespace :cequel do
       new_constants.each do |class_name|
         begin
           clazz = class_name.constantize
-        rescue NameError # rubocop:disable HandleExceptions
+        rescue NameError, RuntimeError # rubocop:disable HandleExceptions
         else
           if clazz.ancestors.include?(Cequel::Record) &&
               !migration_table_names.include?(clazz.table_name.to_sym)

data/lib/cequel/record/timestamps.rb

@@ -0,0 +1,72 @@
+# -*- encoding : utf-8 -*-
+module Cequel
+  module Record
+    #
+    # This module provides `created_at` and `updated_at` functionality for
+    # records. It does this in two ways:
+    #
+    # * If a record's primary key is a `timeuuid` with the `:auto` option set,
+    #   the `created_at` method will return the time extracted from the primary
+    #   key.
+    # * Calling the `timestamps` macro in the class definition will define the
+    #   `updated_at` and (if necessary) `created_at` columns, and set up
+    #   lifecycle hooks to populate them appropriately.
+    #
+    # @example Record class with timestamps
+    #   class Blog
+    #     key :subdomain, :text
+    #     column :name, :text
+    #
+    #     timestamps
+    #   end
+    #
+    # @since 1.3.0
+    #
+    module Timestamps
+      extend ActiveSupport::Concern
+
+      #
+      # Provides class methods for the Timestamps module
+      #
+      module ClassMethods
+        protected
+
+        def key(name, type, options = {})
+          super
+          if type == :timeuuid && options[:auto]
+            module_eval(<<-RUBY, __FILE__, __LINE__+1)
+              def created_at
+                read_attribute(#{name.inspect}).try(:to_time)
+              end
+            RUBY
+          end
+        end
+
+        def timestamps
+          column :updated_at, :timestamp
+
+          if method_defined?(:created_at)
+            before_save :set_updated_at
+          else
+            column :created_at, :timestamp
+
+            before_create :set_created_and_updated_at
+            before_update :set_updated_at
+          end
+        end
+      end
+
+      private
+
+      def set_created_and_updated_at
+        now = Time.now
+        self.created_at = now
+        self.updated_at = now
+      end
+
+      def set_updated_at
+        self.updated_at = Time.now
+      end
+    end
+  end
+end

data/lib/cequel/schema/table.rb

@@ -184,6 +184,12 @@ module Cequel
         columns_by_name[name.to_sym]
       end
 
+      #
+      # @return [Array<Symbol>] the names of all columns
+      def column_names
+        columns.map { |column| column.name }
+      end
+
       #
       # @return [Array<Column>] all key columns (partition + clustering)
       #

data/lib/cequel/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Cequel
   # The current version of the library
-  VERSION = '1.2.6'
+  VERSION = '1.3.0'
 end

data/spec/examples/record/timestamps_spec.rb

@@ -0,0 +1,60 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Cequel::Record::Timestamps do
+  model :Blog do
+    key :subdomain, :text
+    column :name, :text
+    timestamps
+  end
+
+  model :Post do
+    key :blog_subdomain, :text
+    key :id, :timeuuid, auto: true
+    column :name, :text
+    timestamps
+  end
+
+  let!(:now) { Timecop.freeze }
+
+  context 'with simple primary key' do
+    let(:blog) { Blog.create!(subdomain: 'bigdata') }
+
+    it 'should populate created_at after create new record' do
+      expect(blog.created_at).to eq(now)
+    end
+
+    it 'should populate updated_at after create new record' do
+      expect(blog.updated_at).to eq(now)
+    end
+
+    it 'should update updated_at after record update but not created_at' do
+      future = Timecop.freeze(now + 2.minutes)
+      blog.name = 'name'
+      blog.save!
+      expect(blog.updated_at).to eq(future)
+    end
+  end
+
+  context 'with auto-generated timeuuid primary key' do
+    let(:post) { Post['bigdata'].create! }
+
+    it 'should not have created_at column' do
+      expect(Post.column_names).not_to include(:created_at)
+    end
+
+    it 'should expose created_at' do
+      expect(post.created_at.to_i).to eq(now.to_i)
+    end
+
+    it 'should populate updated_at after create new record' do
+      expect(post.updated_at).to eq(now)
+    end
+
+    it 'should update updated_at after record update but not created_at' do
+      future = Timecop.freeze(now + 2.minutes)
+      post.name = 'name'
+      post.save!
+      expect(post.updated_at).to eq(future)
+    end
+  end
+end

data/spec/examples/spec_helper.rb

@@ -34,6 +34,8 @@ RSpec.configure do |config|
   config.after(:all) do
     cequel.schema.drop!
   end
+
+  config.after(:each) { Timecop.return }
 end
 
 if defined? byebug

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cequel
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.3.0
 platform: ruby
 authors:
 - Mat Brown
@@ -15,6 +15,7 @@ authors:
 - Ilya Bazylchuk
 - Dan Cardamore
 - Kei Kusakari
+- Oleh Novosad
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -68,6 +69,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,47 +98,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.19.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: '0.6'
 description: |
   Cequel is an ActiveRecord-like domain model layer for Cassandra that exposes
   the robust data modeling capabilities of CQL3, including parent-child
@@ -188,6 +203,7 @@ files:
 - lib/cequel/record/schema.rb
 - lib/cequel/record/scoped.rb
 - lib/cequel/record/tasks.rb
+- lib/cequel/record/timestamps.rb
 - lib/cequel/record/validations.rb
 - lib/cequel/schema.rb
 - lib/cequel/schema/column.rb
@@ -224,6 +240,7 @@ files:
 - spec/examples/record/serialization_spec.rb
 - spec/examples/record/set_spec.rb
 - spec/examples/record/spec_helper.rb
+- spec/examples/record/timestamps_spec.rb
 - spec/examples/record/validations_spec.rb
 - spec/examples/schema/table_reader_spec.rb
 - spec/examples/schema/table_synchronizer_spec.rb
@@ -281,6 +298,7 @@ test_files:
 - spec/examples/record/serialization_spec.rb
 - spec/examples/record/set_spec.rb
 - spec/examples/record/spec_helper.rb
+- spec/examples/record/timestamps_spec.rb
 - spec/examples/record/validations_spec.rb
 - spec/examples/schema/table_reader_spec.rb
 - spec/examples/schema/table_synchronizer_spec.rb