ork-timestamps 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4e3a4447ac54c2f34109af946b278af6cc9b3294
+  data.tar.gz: d7c56f9257d2448b6c1224a5ea6a4b46e9aa8d04
+SHA512:
+  metadata.gz: 3bd8eaa13b7249165931dc86a74ca1b48f6b7861da149e5518e7e2623211939fe8cba59831dd9b05becb272f7c00314cfc111e0ae79a4091d17b73fba5a5df64
+  data.tar.gz: 2b17dc71d99b051984caf22aadbd22d672f8e860aecaed3b55fc658673ea3aabfae8ac03af21bcf6a5c5cd58a7e7742b1075ac9ce3b372b9c2f68aa826444a3f

data/README.md

@@ -0,0 +1,65 @@
+ork-timestamps
+==============
+
+[![Gem Version](https://badge.fury.io/rb/ork-timestamps.png)](http://badge.fury.io/rb/ork-timestamps)
+[![Build Status](https://secure.travis-ci.org/emancu/ork-timestamps.png)](http://travis-ci.org/emancu/ork-timestamps)
+[![Code Climate](https://codeclimate.com/github/emancu/ork-timestamps.png)](https://codeclimate.com/github/emancu/ork-timestamps)
+[![Coverage Status](https://coveralls.io/repos/emancu/ork/badge.png)](https://coveralls.io/r/emancu/ork-timestamps)
+[![Dependency Status](https://gemnasium.com/emancu/ork-timestamps.png)](https://gemnasium.com/emancu/ork-timestamps)
+
+
+Timestamps for your Ork Models
+
+## Dependencies
+
+`ork-timestamps` requires:
+
+* Ruby 1.9 or later.
+* `riak-client` to connect to **Riak**.
+* `ork` 0.1.3 or later.
+
+Install Dependencies using `dep` is easy as run:
+
+    $ dep insatll
+
+## Installation
+
+Install [Riak](http://basho.com/riak/) with your package manager:
+
+    $ brew install riak
+
+Or download it from [Riak's download page](http://docs.basho.com/riak/latest/downloads/)
+
+Once you have it installed, you can execute `riak start` and it will run on `localhost:8098` by default.
+
+If you don't have `Ork-Timestamps`, try this:
+
+    $ gem install ork-timestamps
+
+
+## Overview
+
+`Ork::Timestamps` creates two attributes that automatically set create and update timestamp fields.
+
+## Getting started
+
+Include `Ork::Timestamps` module in your `Ork::Document` class.
+
+```ruby
+class SomeDocument
+  include Ork::Document
+  include Ork::Timestamps
+
+  attribute :message
+end
+```
+
+Enjoy your models with timestamps!
+
+## Running the Tests
+
+Adjust the variable to point to a test riak database. Default is `http://localhost:8098`
+
+```bash
+$ ORK_RIAK_URL='http://localhost:8198' rake
+```

data/lib/ork/errors.rb

@@ -0,0 +1,7 @@
+module Ork
+  module Timestamps
+
+    class NotAnOrkDocument < StandardError; end
+  end
+end
+

data/lib/ork/timestamps.rb

@@ -0,0 +1,35 @@
+require_relative 'errors'
+
+module Ork
+  module Timestamps
+    VERSION = '0.0.1'
+
+    def self.included(klass)
+      raise NotAnOrkDocument unless klass.included_modules.include? Ork::Document
+
+      klass.class_eval do |base|
+        attribute :created_at, accessors: :reader
+        attribute :updated_at, accessors: :reader
+
+        def created_at=(a)
+          @attributes[:created_at] = Time.parse a.to_s
+        end
+
+        def updated_at=(a)
+          @attributes[:updated_at] = Time.parse a.to_s
+        end
+
+        def save_with_timestamps
+          self.created_at = Time.now if self.new?
+          self.updated_at = Time.now
+
+          save_without_timestamps
+        end
+
+        alias :save_without_timestamps :save
+        alias :save :save_with_timestamps
+      end
+    end
+  end
+end
+

data/ork-timestamps.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'ork-timestamps'
+  s.version     = '0.0.1'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = 'A simple library to add timestamps to Ork::Documents stored in riak.'
+  s.description = 'Add the clasic timestamps :created_at, :updated_at to the Ork::Documents'
+  s.authors     = ['Emiliano Mancuso']
+  s.email       = ['emiliano.mancuso@gmail.com']
+  s.homepage    = 'http://github.com/emancu/ork-timestamps'
+  s.license     = 'MIT'
+
+  s.files = Dir[
+    'README.md',
+    'rakefile',
+    'lib/**/*.rb',
+    '*.gemspec'
+  ]
+  s.test_files = Dir['test/*.*']
+
+  s.add_runtime_dependency 'riak-client', '~> 1.4'
+  s.add_runtime_dependency 'ork', '~> 0.1', '>= 0.1.3'
+  s.add_development_dependency 'protest', '~> 0'
+  s.add_development_dependency 'coveralls', '~> 0'
+end
+

data/rakefile

@@ -0,0 +1,10 @@
+task :default => :test
+
+ENV['ORK_RIAK_URL'] ||= 'http://localhost:8098'
+
+desc 'Run tests'
+task :test do
+  require File.expand_path("./test/helper", File.dirname(__FILE__))
+
+  Dir["test/**/*_test.rb"].each { |file| load file }
+end

data/test/helper.rb

@@ -0,0 +1,23 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.start do
+  project_name "Ork-Timestamps"
+  command_name "Protest"
+
+  add_filter "/test/"
+end
+
+require "rubygems"
+require "protest"
+require "ork"
+require 'ork/timestamps'
+
+Riak.disable_list_keys_warnings = true
+Protest.report_with(:progress)
+
+def deny(condition, message="Expected condition to be unsatisfied")
+  assert !condition, message
+end

data/test/timestamps_test.rb

@@ -0,0 +1,88 @@
+require_relative 'helper'
+
+class Event
+  include Ork::Document
+  include Ork::Timestamps
+
+  attribute :name
+end
+
+Protest.describe 'Ork::Timestamps' do
+  context 'include Ork::Timestamps' do
+    test 'raise an error if it is not a Ork::Document' do
+      assert_raise Ork::Timestamps::NotAnOrkDocument do
+        class NotADocument
+          include Ork::Timestamps
+        end
+      end
+    end
+
+    test 'add timestamps attributes' do
+      assert Event.attributes.include? :created_at
+      assert Event.attributes.include? :updated_at
+    end
+
+    context 'created_at' do
+      setup do
+        @event = Event.new name: 'Birthday'
+      end
+
+      test 'is not setted if save was not called' do
+        deny @event.created_at
+      end
+
+      test 'is setted on creation' do
+        @event.save
+
+        assert @event.created_at
+      end
+
+      test 'is not updated on each save' do
+        @event.save
+        prev_created_at = @event.created_at
+        @event.save
+
+        assert @event.created_at == prev_created_at
+      end
+
+      test 'retrieve the object returns a Time object' do
+        @event.save
+        same_event = Event[@event.id]
+
+        assert_equal @event.created_at, same_event.created_at
+        assert_equal Time, same_event.created_at.class
+      end
+    end
+
+    context 'updated_at' do
+      setup do
+        @event = Event.new name: 'Birthday'
+      end
+
+      test 'is not setted if save was not called' do
+        deny @event.updated_at
+      end
+
+      test 'is setted on creation' do
+        @event.save
+
+        assert @event.updated_at
+      end
+
+      test 'is updated on each save' do
+        prev_updated_at = @event.updated_at
+        @event.save
+
+        assert @event.updated_at != prev_updated_at
+      end
+
+      test 'retrieve the object returns a Time object' do
+        @event.save
+        same_event = Event[@event.id]
+
+        assert_equal @event.updated_at, same_event.updated_at
+        assert_equal Time, same_event.updated_at.class
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ork-timestamps
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Emiliano Mancuso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: riak-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: ork
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: protest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add the clasic timestamps :created_at, :updated_at to the Ork::Documents
+email:
+- emiliano.mancuso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ork/errors.rb
+- lib/ork/timestamps.rb
+- ork-timestamps.gemspec
+- rakefile
+- test/helper.rb
+- test/timestamps_test.rb
+homepage: http://github.com/emancu/ork-timestamps
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A simple library to add timestamps to Ork::Documents stored in riak.
+test_files:
+- test/helper.rb
+- test/timestamps_test.rb