mongoid-clerk 0.0.1

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3 --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-clerk.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    mongoid-clerk (0.0.1)
+      activesupport
+      bson_ext
+      foreman
+      mongoid
+      mongoid-rspec
+      rake
+      rspec
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.7)
+      activesupport (= 3.2.7)
+      builder (~> 3.0.0)
+    activesupport (3.2.7)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.6.4)
+    bson_ext (1.6.4)
+      bson (~> 1.6.4)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    foreman (0.53.0)
+      thor (>= 0.13.6)
+    i18n (0.6.0)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.11)
+      activemodel (~> 3.1)
+      mongo (<= 1.6.2)
+      tzinfo (~> 0.3.22)
+    mongoid-rspec (1.4.5)
+      mongoid (>= 2.4.6)
+      rake
+      rspec (>= 2.9)
+    multi_json (1.3.6)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.2)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    thor (0.15.4)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mongoid-clerk!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 80beans
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Procfile

@@ -0,0 +1 @@
+MongoDB:       mongod run --config /usr/local/etc/mongod.conf

data/README.md

@@ -0,0 +1,57 @@
+# Mongoid::Clerk
+
+[![Build Status](https://secure.travis-ci.org/80beans/mongoid-clerk.png?branch=master)](http://travis-ci.org/80beans/mongoid-clerk)
+
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/80beans/mongoid-clerk)
+
+A simple logger for Mongoid.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid-clerk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid-clerk
+
+## Usage
+
+Include `Clerk::Logger` in your model, then log anything with `log()`. The first argument is the message and the second the level.
+
+You can add default fields to your log entry by adding `clerk_always_include` this method accepts an array of fields it should include, or a hash if you want to rename a field.
+
+Clerk adds a polymorphic relation to the model `log_items` so you can scope log entries on this model.
+
+`Clerk::Log` behaves like a regular mongoid model for easy access to your log entries.
+
+example model:
+
+    class User
+      include Clerk::Logger
+
+      field :name
+      field :address
+
+      clerk_always_include :name, :address => :place
+
+      def something
+        log('Something went wrong!', :error)
+      end
+
+    end
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require 'rake'
+require 'rspec'
+
+require "bundler/gem_tasks"
+require File.expand_path('../spec/spec_helper', __FILE__)
+
+task :default do
+  system 'bundle exec rspec spec'
+end

data/lib/clerk/log.rb

@@ -0,0 +1,10 @@
+class Clerk::Log
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field :message
+  field :level, :type => Symbol
+
+  belongs_to :logable, :polymorphic => true
+
+end

data/lib/clerk/logger.rb

@@ -0,0 +1,54 @@
+module Clerk::Logger
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+
+    def default_fields
+      @default_fields ||= {}
+    end
+
+    def clerk_always_include(*new_default_fields)
+      new_default_fields.each do |default_field|
+        default_field = { default_field => default_field } unless default_field.is_a?(Hash)
+        Clerk::Log.send(:field, default_field.values.first)
+        default_fields.merge!(default_field)
+      end
+    end
+
+  end
+
+  def log(msg, level = :info)
+    Clerk::Log.create!(
+      included_fields.merge(
+        :message => msg,
+        :level => level
+      )
+    )
+  end
+
+  def included_fields
+    {}.tap do |return_hash|
+      self.class.default_fields.each do |source_field, target_field|
+        return_hash[target_field.to_sym] = read_attribute(source_field.to_sym)
+      end
+    end
+  end
+
+  included do
+    has_many :log_items, :as => :logable
+  end
+end
+
+#### usage
+#
+# class InputStream
+#   include Clerk::Logger
+#
+#   clerk_always_include :id => :input_stream_id, :company_id
+#
+#   def something
+#     log('Something went wrong!', :error)
+#   end
+#
+# end
+#

data/lib/clerk/version.rb

@@ -0,0 +1,3 @@
+module Clerk
+  VERSION = "0.0.1"
+end

data/lib/clerk.rb

@@ -0,0 +1,7 @@
+require "clerk/version"
+
+module Clerk
+end
+
+require 'clerk/log'
+require 'clerk/logger'

data/mongoid-clerk.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/clerk/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Robert Beekman"]
+  gem.email         = ["robert@80beans.com"]
+  gem.description   = %q{A simple logger for mongoid}
+  gem.summary       = %q{A simple logger for mongoid}
+  gem.homepage      = "http://github.com/80beans/mongoid-clerk"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongoid-clerk"
+  gem.require_paths = ["lib"]
+  gem.version       = Clerk::VERSION
+
+  gem.add_dependency 'mongoid'
+  gem.add_dependency 'bson_ext'
+  gem.add_dependency 'rspec'
+  gem.add_dependency 'mongoid-rspec'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'rake'
+  gem.add_dependency 'foreman'
+end

data/spec/mongoid-clerk/log_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Clerk::Log do
+
+  it { should be_timestamped_document }
+
+  it { should have_field(:message) }
+  it { should have_field(:level).of_type(Symbol) }
+
+  it { should belong_to :logable }
+
+end

data/spec/mongoid-clerk/logger_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+class MongoidDocumentWithClerk
+  include Mongoid::Document
+  include Clerk::Logger
+
+  field :name
+  field :address
+
+  clerk_always_include :name, :address => :place
+
+end
+
+describe MongoidDocumentWithClerk do
+
+  context "class methods" do
+    subject { MongoidDocumentWithClerk }
+
+    it { should respond_to :default_fields }
+    it { should respond_to :clerk_always_include }
+  end
+
+  context "instance methods" do
+    subject { MongoidDocumentWithClerk.new }
+
+    it { should respond_to :log }
+    it { should respond_to :included_fields }
+    it { should have_many :log_items }
+  end
+
+  describe ".clerk_always_include" do
+
+    describe "dynamic Clerk::Log fields" do
+      subject { Clerk::Log }
+
+      it { should have_field :name }
+      it { should have_field :place }
+    end
+
+    describe "default fields" do
+      subject { MongoidDocumentWithClerk.default_fields }
+
+      it "should contain the field mapping" do
+        should == {:name => :name, :address => :place}
+      end
+
+    end
+
+  end
+
+  describe "#included_fields" do
+    let(:document_with_clerk) { MongoidDocumentWithClerk.new(:name => 'James Bond', :address => 'Secret') }
+    subject { document_with_clerk.included_fields }
+
+    it { should == {:name => 'James Bond', :place => 'Secret'} }
+  end
+
+  describe "#log" do
+    let(:document_with_clerk) { MongoidDocumentWithClerk.new(:name => 'James Bond', :address => 'Secret') }
+
+    context "with default values" do
+
+      it "should call Clerk::Log with the correct params" do
+        Clerk::Log.should_receive(:create!).with(
+          :name => 'James Bond',
+          :place => 'Secret',
+          :message => 'bananas',
+          :level => :info
+        )
+      end
+
+      after { document_with_clerk.log('bananas') }
+    end
+
+    context "with overriden status level" do
+
+      it "should call Clerk::Log with the correct params" do
+        Clerk::Log.should_receive(:create!).with(
+          :name => 'James Bond',
+          :place => 'Secret',
+          :message => 'bananas',
+          :level => :error
+        )
+      end
+
+      after { document_with_clerk.log('bananas', :error) }
+    end
+
+  end
+
+end

data/spec/mongoid.yml

@@ -0,0 +1,4 @@
+test:
+  host: 127.0.0.1
+  port: 27017
+  database: mongoid_clerk_test

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'active_support/all'
+require 'mongoid'
+require 'mongo'
+require 'uri'
+require 'mongoid-rspec'
+
+mongoid_config = YAML.load_file(File.join(File.dirname(__FILE__),"mongoid.yml"))['test']
+Mongoid.configure do |config|
+  if !mongoid_config['uri'].blank?
+    config.master = Mongo::Connection.from_uri(mongoid_config['uri']).db(mongoid_config['uri'].split('/').last)
+  else
+    config.master = Mongo::Connection.new(mongoid_config['host'], mongoid_config['port']).db(mongoid_config['database'])
+  end
+end
+
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include Mongoid::Matchers
+
+  config.after :suite do
+    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+  end
+end
+
+require 'clerk'

data/travis.yml

@@ -0,0 +1,2 @@
+rvm: 1.9.3
+

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-clerk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Beekman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: foreman
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple logger for mongoid
+email:
+- robert@80beans.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJzcGVj
+- !binary |-
+  LnJ2bXJj
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  R2VtZmlsZS5sb2Nr
+- !binary |-
+  TElDRU5TRQ==
+- !binary |-
+  UHJvY2ZpbGU=
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  bGliL2NsZXJrLnJi
+- !binary |-
+  bGliL2NsZXJrL2xvZy5yYg==
+- !binary |-
+  bGliL2NsZXJrL2xvZ2dlci5yYg==
+- !binary |-
+  bGliL2NsZXJrL3ZlcnNpb24ucmI=
+- !binary |-
+  bW9uZ29pZC1jbGVyay5nZW1zcGVj
+- !binary |-
+  c3BlYy9tb25nb2lkLWNsZXJrL2xvZ19zcGVjLnJi
+- !binary |-
+  c3BlYy9tb25nb2lkLWNsZXJrL2xvZ2dlcl9zcGVjLnJi
+- !binary |-
+  c3BlYy9tb25nb2lkLnltbA==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+- !binary |-
+  dHJhdmlzLnltbA==
+homepage: http://github.com/80beans/mongoid-clerk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A simple logger for mongoid
+test_files:
+- !binary |-
+  c3BlYy9tb25nb2lkLWNsZXJrL2xvZ19zcGVjLnJi
+- !binary |-
+  c3BlYy9tb25nb2lkLWNsZXJrL2xvZ2dlcl9zcGVjLnJi
+- !binary |-
+  c3BlYy9tb25nb2lkLnltbA==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==