clerk 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9b9856f19754930ae0e19639ddd18727dd74d34
-  data.tar.gz: b3551d9cb8d3826d4ef1e817c3b3c1b80f4d820e
+  metadata.gz: f2ee29689040f515048d33262d9717d47e4572ea
+  data.tar.gz: cfc014bf93106d3b0c82709f03da3ba3546b81e3
 SHA512:
-  metadata.gz: e98730c6d484a6eb0fb8eba042da984301f6e664ab21d4402e262c48674b932e6af2f1e03fdcc559b2ac2d48753b4a7774e22c860d0e90a072c463277d62102e
-  data.tar.gz: b3e9e6f698c162343166e2cfc4a3f032e7c82f6e46bce6de39e4d399623d9f287dc39db0d4b584d74d7ec24b68fa5501dc931e1d1ced64b0674da7dec1d7991c
+  metadata.gz: 3d42c93804677c2df22c6706e1a716d1da502d0b0f73b4e9f5dfb9237f03cc1bb8c92f2b7ab629b9ae5f7c6bd7f4649626785a8050eea53cc0db3b4f83209c07
+  data.tar.gz: 4c8e491a147aff637ab02c7a4d7bb9b42c345b154ac59a2989e2e3c857008f418f3c9a2e4d6bda985a10b497f252b390458e732595e94f743ba8855e2118d593

data/.travis.yml

@@ -1,10 +1,8 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.2"
   - "1.9.3"
-  - jruby-18mode # JRuby in 1.8 mode
+  - "2.0.0"
+  - "2.1.7"
+  - "2.2.3"
   - jruby-19mode # JRuby in 1.9 mode
-  - rbx-18mode
-  - rbx-19mode
 script: bundle exec rspec spec

data/README.md

@@ -86,6 +86,18 @@ Since we are using `sentient_user` you can also set the updater or creator in te
     Post.create!(:title => "New Post")
     Post.last.creator == user # => true
 
+## Configuration
+
+In case you need to customize Clerk. Just create `config/initializers/clerk.rb` and set up your configuration:
+
+```ruby
+Clerk.configure do |config|
+  config.silence_warnings = true | false     # Defaults: false (true in test env)
+  config.logger = MyCustomLogger.new()       # Defaults: Rails.logger
+end
+```
+
+
 ## Resources used in the development of this gem
 
 * [http://ryanbigg.com/2011/01/extending-active-record/](http://ryanbigg.com/2011/01/extending-active-record/)
@@ -94,3 +106,4 @@ Since we are using `sentient_user` you can also set the updater or creator in te
 * [http://www.cowboycoded.com/2011/01/31/developing-is_able-or-acts_as-plugins-for-rails/](http://www.cowboycoded.com/2011/01/31/developing-is_able-or-acts_as-plugins-for-rails/)
 * [http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html](http://api.rubyonrails.org/classes/ActiveRecord/Callbacks.html)
 * [https://github.com/bokmann/sentient_user](https://github.com/bokmann/sentient_user)
+* [https://robots.thoughtbot.com/mygem-configure-block](https://robots.thoughtbot.com/mygem-configure-block)

data/lib/clerk.rb

@@ -1,6 +1,7 @@
 require 'active_record'
 require 'sentient_user'
 require 'clerk/version'
+require 'clerk/configuration'
 require 'clerk/callback'
 require 'clerk/railtie'
 

data/lib/clerk/callback.rb

@@ -4,21 +4,33 @@ module Clerk
       record.creator = current_user if record.respond_to?(:creator) && current_user
       record.updater = current_user if record.respond_to?(:updater) && current_user
     end
-  
+
     def before_update(record)
       record.updater = current_user if record.respond_to?(:updater) && current_user
     end
-    
+
     # relies on `include SentientUser` on User
     def current_user
-      logger.warn "WARNING: User#current is not defined, are you including SentientUser on your User model?" unless User.respond_to?(:current)
-      logger.warn "WARNING: User#current is nil, are you including SentientController on your ApplicationController?" unless User.current
+      warn "User#current is not defined, are you including SentientUser on your User model?" unless User.respond_to?(:current)
+      warn "User#current is nil, are you including SentientController on your ApplicationController?" unless User.current
 
       User.current
-    end  
-    
+    end
+
+    #######
+    private
+    #######
+
+    def warn(message)
+      logger.warn "WARNING: #{message}" unless configuration.silence_warnings
+    end
+
     def logger
-      Rails.logger
+      configuration.logger
+    end
+
+    def configuration
+      Clerk.configuration
     end
   end
 end

data/lib/clerk/configuration.rb

@@ -0,0 +1,22 @@
+require 'active_support/logger'
+
+module Clerk
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :silence_warnings,
+                  :logger
+
+    def initialize
+      @silence_warnings = false
+      @logger = ActiveSupport::Logger.new(STDOUT)
+    end
+  end
+end

data/lib/clerk/railtie.rb

@@ -5,6 +5,11 @@ module Clerk
   class Railtie < Rails::Railtie
     initializer 'clerk.ar_extensions' do |app|
       ActiveRecord::Base.extend Clerk
+
+      Clerk.configure do |config|
+        config.silence_warnings = Rails.env.test?
+        config.logger = Rails.logger
+      end
     end
   end
 end

data/lib/clerk/version.rb

@@ -1,3 +1,3 @@
 module Clerk
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/clerk/configuration_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Clerk::Configuration do
+  before(:each) do
+    Clerk.configure {}
+  end
+
+  after(:each) do
+    Clerk.configuration = Clerk::Configuration.new
+  end
+
+  it "should have a configuration" do
+    Clerk.configuration.should be_a(Clerk::Configuration)
+  end
+
+  context 'silence_warnings' do
+    it 'should be false by default' do
+      Clerk.configuration.silence_warnings.should be_false
+    end
+
+    it 'can be toggled to true' do
+      Clerk.configure { |c| c.silence_warnings = true }
+      Clerk.configuration.silence_warnings.should be_true
+    end
+  end
+
+  context 'logger' do
+    it 'should exist by default' do
+      Clerk.configuration.logger.should be_a ActiveSupport::Logger
+    end
+
+    it 'should be configurable' do
+      class FakeLogger
+        def warn(msg)
+          # noop
+        end
+      end
+
+      Clerk.configure { |c| c.logger = FakeLogger.new() }
+
+      Clerk.configuration.logger.should be_a FakeLogger
+    end
+  end
+end

data/spec/clerk_spec.rb

@@ -76,4 +76,69 @@ describe Clerk do
       this.updater.name.should == "creator"
     end
   end
+
+  describe "warning messages" do
+    Post.extend Clerk
+
+    class PostExtended < Post
+      track_who_does_it
+    end
+
+    before(:each) do
+      @logger = double("logger", warn: true)
+      Clerk.configure { |c| c.logger = @logger }
+    end
+
+    after(:each) do
+      # Reset configuration
+      Clerk.configuration = Clerk::Configuration.new
+    end
+
+    context "when missing SentientUser" do
+      before do
+        User.stub(:respond_to?).with(:current).and_return(false)
+      end
+      it "should log a message" do
+        @logger.should_receive(:warn).with("WARNING: User#current is not defined, are you including SentientUser on your User model?")
+        this = FooExtended.new(:bar => "Test")
+        this.save
+      end
+
+      context "amd warning are silenced" do
+        before do
+          Clerk.configure { |c| c.silence_warnings = true }
+        end
+
+        it "should not show a log message" do
+          @logger.should_not_receive(:warn).with("WARNING: User#current is not defined, are you including SentientUser on your User model?")
+          this = FooExtended.new(:bar => "Test")
+          this.save
+        end
+      end
+    end
+
+    context "when missing User.current" do
+      before do
+        User.current = nil
+      end
+
+      it "should log a message" do
+        @logger.should_receive(:warn).with("WARNING: User#current is nil, are you including SentientController on your ApplicationController?")
+        this = FooExtended.new(:bar => "Test")
+        this.save
+      end
+
+      context "amd warning are silenced" do
+        before do
+          Clerk.configure { |c| c.silence_warnings = true }
+        end
+
+        it "should not show a log message" do
+          @logger.should_not_receive(:warn).with("WARNING: User#current is nil, are you including SentientController on your ApplicationController?")
+          this = FooExtended.new(:bar => "Test")
+          this.save
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clerk
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Jesse House
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -114,8 +114,10 @@ files:
 - clerk.gemspec
 - lib/clerk.rb
 - lib/clerk/callback.rb
+- lib/clerk/configuration.rb
 - lib/clerk/railtie.rb
 - lib/clerk/version.rb
+- spec/clerk/configuration_spec.rb
 - spec/clerk_spec.rb
 - spec/spec_helper.rb
 - spec/support/data.rb
@@ -141,12 +143,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: For Rails applications - add creator and updater to your ActiveRecord models
   and automatically set these from current_user
 test_files:
+- spec/clerk/configuration_spec.rb
 - spec/clerk_spec.rb
 - spec/spec_helper.rb
 - spec/support/data.rb