From 562a1cd3b6f91ed1ede8535388160d16c1ff0601 Mon Sep 17 00:00:00 2001
From: Konstantinos Rousis <rousisk@gmail.com>
Date: Thu, 14 Feb 2013 22:28:34 +0100
Subject: [PATCH] add option to avoid caching of empty values

---
 README.md                      |  9 +++++++++
 lib/copycat.rb                 |  2 ++
 lib/copycat/implementation.rb  |  2 +-
 lib/tasks/copycat_tasks.rake   |  1 +
 spec/integration/dummy_spec.rb | 10 +++++++++-
 5 files changed, 22 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 1e0196f..c9368fa 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,15 @@ Rails.application.routes.draw do
 end
 ```
 
+## Caching empty values ##
+By default, copycat will cache empty values in the database. If a lookup results to a missing translation a new copycat entry will be created with an empty value for this locale and key.
+This may not be desirable, especially during development, as after the first lookup copycat will always serve the empty translation, preventing the YML files from being consulted again for this locale and key.
+Changing the default behaviour can be achieved through the following setting on the initializer:
+
+```ruby
+config.create_nils = false
+```
+
 ## Logging ##
 Because Copycat does a SQL query for each token, it can produce a lot of noise in the log output.
 Therefore by default the logger is disabled for the Copycat ActiveRecord class.
diff --git a/lib/copycat.rb b/lib/copycat.rb
index b485eb5..e5002b3 100644
--- a/lib/copycat.rb
+++ b/lib/copycat.rb
@@ -7,7 +7,9 @@ module Copycat
   mattr_accessor :username
   mattr_accessor :password
   mattr_accessor :route
+  mattr_accessor :create_nils
   @@route = 'copycat_translations'
+  @@create_nils = true
 
   def self.setup
     yield self
diff --git a/lib/copycat/implementation.rb b/lib/copycat/implementation.rb
index 48a43da..9e35195 100644
--- a/lib/copycat/implementation.rb
+++ b/lib/copycat/implementation.rb
@@ -6,7 +6,7 @@ def lookup(locale, key, scope = [], options = {})
       cct = CopycatTranslation.where(locale: locale.to_s, key: key.to_s).first
       return cct.value if cct
       value = super(locale, key, scope, options)
-      if value.is_a?(String) || value.nil?
+      if value.is_a?(String) || value.nil? && Copycat.create_nils
         CopycatTranslation.create(locale: locale.to_s, key: key.to_s, value: value)
       end
       value
diff --git a/lib/tasks/copycat_tasks.rake b/lib/tasks/copycat_tasks.rake
index ca671fb..b615c0a 100644
--- a/lib/tasks/copycat_tasks.rake
+++ b/lib/tasks/copycat_tasks.rake
@@ -15,6 +15,7 @@ namespace :copycat do
 Copycat.setup do |config|
   config.username = '#{username}'
   config.password = '#{password}'
+  #config.create_nils = true
   #config.route = 'copycat_translations'
 end
 CONFIG
diff --git a/spec/integration/dummy_spec.rb b/spec/integration/dummy_spec.rb
index 1247142..e62f823 100644
--- a/spec/integration/dummy_spec.rb
+++ b/spec/integration/dummy_spec.rb
@@ -21,12 +21,20 @@
     CopycatTranslation.find_by_key('site.index.header').should_not be_nil
   end
 
-  it "creates a copycat_translation if the yaml does not have an entry" do
+  it "by default creates an empty copycat_translation if the yaml does not have an entry" do
+    Copycat.create_nils = true
     CopycatTranslation.find_by_key('site.index.intro').should be_nil
     visit root_path
     CopycatTranslation.find_by_key('site.index.intro').should_not be_nil
   end
 
+  it "does not create an empty copycat_translation when create_nils is set to false" do
+    Copycat.create_nils = false
+    CopycatTranslation.find_by_key('site.index.intro').should be_nil
+    visit root_path
+    CopycatTranslation.find_by_key('site.index.intro').should be_nil
+  end
+
   it "shows the copycat_translation instead of the yaml" do
     FactoryGirl.create(:copycat_translation, key: 'site.index.header', value: 'A different header')
     visit root_path