ork-hooks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 404c0cc428845a9e2772f37e03bbe63dd93496fd
+  data.tar.gz: d0dd37d728f6fa70814ae79b22492d71fbddd847
+SHA512:
+  metadata.gz: 08b06478581cb6082df398aee2e8316aae04eae347f4c6305d514b5b5e3bbbfb701847c38a145b38ddc68bc793ac63284b4938c110f12a98c856f88bc1f54ff4
+  data.tar.gz: b641b503d16882b8a4571073c8c804c1836ec4fd44c05202416577f9f39d315688db1cb8738a63f2fd766a8592ebaacde31dcca4c545fd9cecd5e4fc07c11d2b

data/README.md

@@ -0,0 +1,75 @@
+ork-hooks
+==============
+
+[![Gem Version](https://badge.fury.io/rb/ork-hooks.png)](http://badge.fury.io/rb/ork-hooks)
+[![Build Status](https://secure.travis-ci.org/emancu/ork-hooks.png)](http://travis-ci.org/emancu/ork-hooks)
+[![Code Climate](https://codeclimate.com/github/emancu/ork-hooks.png)](https://codeclimate.com/github/emancu/ork-hooks)
+[![Coverage Status](https://coveralls.io/repos/emancu/ork-hooks/badge.png)](https://coveralls.io/r/emancu/ork-hooks)
+[![Dependency Status](https://gemnasium.com/emancu/ork-hooks.png)](https://gemnasium.com/emancu/ork-hooks)
+
+
+Timestamps for your Ork Models
+
+## Dependencies
+
+`ork-hooks` requires:
+
+* Ruby 1.9 or later.
+* `riak-client` to connect to **Riak**.
+* `ork` 0.1.4 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-hooks`, try this:
+
+    $ gem install ork-hooks
+
+
+## Overview
+
+`Ork::Hooks` creates the following hooks
+
+- before_create
+- before_delete
+- before_update
+- before_save
+
+- after_create
+- after_delete
+- after_update
+- after_save
+
+## Getting started
+
+Include `Ork::Hooks` module in your `Ork::Document` class.
+
+```ruby
+class SomeDocument
+  include Ork::Document
+  include Ork::Hooks
+
+  attribute :message
+end
+```
+
+Enjoy your models with hooks!
+
+## 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/hooks.rb

@@ -0,0 +1,70 @@
+module Ork
+  module Hooks
+    VERSION = '0.0.1'
+
+    def self.included(klass)
+      raise Ork::NotOrkObject unless klass.included_modules.include? Ork::Document
+
+      klass.class_eval do |base|
+        def save_with_hooks
+          is_new = self.new?
+
+          before_create if is_new
+          before_update unless is_new
+          before_save
+
+          result = save_without_hooks
+
+          after_create if is_new
+          after_update unless is_new
+          after_save
+
+          result
+        end
+
+        alias :save_without_hooks :save
+        alias :save :save_with_hooks
+
+        def delete_with_hooks
+          before_delete
+
+          result = delete_without_hooks
+
+          after_delete
+
+          result
+        end
+
+        alias :delete_without_hooks :delete
+        alias :delete :delete_with_hooks
+      end
+    end
+
+    protected
+
+    def before_create
+    end
+
+    def before_update
+    end
+
+    def before_save
+    end
+
+    def before_delete
+    end
+
+    def after_create
+    end
+
+    def after_update
+    end
+
+    def after_save
+    end
+
+    def after_delete
+    end
+  end
+end
+

data/ork-hooks.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'ork-hooks'
+  s.version     = '0.0.1'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  s.summary     = 'A hooks to your Ork Documents'
+  s.description = 'Add the clasic callbacks to the Ork::Documents'
+  s.authors     = ['Emiliano Mancuso']
+  s.email       = ['emiliano.mancuso@gmail.com']
+  s.homepage    = 'http://github.com/emancu/ork-hooks'
+  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.4'
+  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-Hooks"
+  command_name "Protest"
+
+  add_filter "/test/"
+end
+
+require "rubygems"
+require "protest"
+require "ork"
+require 'ork/hooks'
+
+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/hooks_test.rb

@@ -0,0 +1,112 @@
+require_relative 'helper'
+
+class Event
+  include Ork::Document
+  include Ork::Hooks
+
+  @@hooks_called = []
+end
+
+Protest.describe 'Ork::Hooks' do
+  context 'include Ork::Hooks' do
+    test 'raise an error if it is not a Ork::Document' do
+      assert_raise Ork::NotOrkObject do
+        class NotADocument
+          include Ork::Hooks
+        end
+      end
+    end
+
+    test 'add hooks method' do
+      event = Event.new
+
+      assert event.respond_to? :before_create
+      assert event.respond_to? :before_delete
+      assert event.respond_to? :before_update
+      assert event.respond_to? :before_save
+
+      assert event.respond_to? :after_create
+      assert event.respond_to? :after_delete
+      assert event.respond_to? :after_update
+      assert event.respond_to? :after_save
+    end
+  end
+
+  context '' do
+    class Event
+      def hooks_called
+        @@hooks_called
+      end
+
+      def before_create
+        @@hooks_called << :before_create
+      end
+
+      def before_update
+        @@hooks_called << :before_update
+      end
+
+      def before_save
+        @@hooks_called << :before_save
+      end
+
+      def before_delete
+        @@hooks_called << :before_delete
+      end
+
+      def after_create
+        @@hooks_called << :after_create
+      end
+
+      def after_update
+        @@hooks_called << :after_update
+      end
+
+      def after_save
+        @@hooks_called << :after_save
+      end
+
+      def after_delete
+        @@hooks_called << :after_delete
+      end
+    end
+
+    context 'create' do
+      test 'hooks were called in order' do
+        @event = Event.create
+
+        assert_equal :before_create, @event.hooks_called.shift
+        assert_equal :before_save,   @event.hooks_called.shift
+        assert_equal :after_create,  @event.hooks_called.shift
+        assert_equal :after_save,    @event.hooks_called.shift
+        assert @event.hooks_called.empty?
+      end
+    end
+
+    context 'update' do
+      test 'hooks were called in order' do
+        @event = Event.create
+        @event.hooks_called.replace []
+        @event.save
+
+        assert_equal :before_update, @event.hooks_called.shift
+        assert_equal :before_save,   @event.hooks_called.shift
+        assert_equal :after_update,  @event.hooks_called.shift
+        assert_equal :after_save,    @event.hooks_called.shift
+        assert @event.hooks_called.empty?
+      end
+    end
+
+    context 'delete' do
+      test 'hooks were called in order' do
+        @event = Event.create
+        @event.hooks_called.replace []
+        @event.delete
+
+        assert_equal :before_delete, @event.hooks_called.shift
+        assert_equal :after_delete,  @event.hooks_called.shift
+        assert @event.hooks_called.empty?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ork-hooks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Emiliano Mancuso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-16 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.4
+  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.4
+- !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 callbacks to the Ork::Documents
+email:
+- emiliano.mancuso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/ork/hooks.rb
+- ork-hooks.gemspec
+- rakefile
+- test/helper.rb
+- test/hooks_test.rb
+homepage: http://github.com/emancu/ork-hooks
+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 hooks to your Ork Documents
+test_files:
+- test/helper.rb
+- test/hooks_test.rb