whowish_word 0.3.1 → 0.3.2

data/README.md

@@ -1,209 +1,209 @@
-WhowishWord - a Rails gem that make static content editable
-====================
-
-WhowishWord makes static content editable, as long as the programmers follow its convention.
-
-Demo: http://whowish-word.heroku.com
-
-
-The problem WhowishWord tries to solve
----------------------------------------
-
-The problem that I personally faced in my company, Whowish, is that:
-
-	Occasionally CEO or VP of Marketing would send me an email to change the word 'Save'(on a submit button) to the word 'Post'.
-	I would have to go to the source code and change it.
-	And when this happens too often, it drives us, the programmers, crazy
-
-WhowishWord tries to solve this problem elegantly. It is much better than using a config file.
-
-It gives a simple tool for CEO, VP of Marketing (or whoever it is) to make changes themselves.
-
-The beauty of WhowishWord is that:
-
-* It is almost transparent to programmers
-* Programmers don't have to care how wording should be. This makes them work much faster
-* It does not clutter up your source code because you replace one static content unit with one function call
-
-Demo: http://whowish-word.heroku.com
-
-
-How you should work
--------------------
-
-In your view, e.g. index.html.erb, use word_for(:identifier) and word_for_attr(:identifier):
-
-```erb
-<h1><%= word_for :title%></h1>
-<h3><%= word_for :you_are_here_for_number_of_times, :number=> 10 %></h3>
-
-<b><%= word_for :name_label%><b> <%= word_for :my_name%><br/>
-
-<b><%= word_for :your_name_label%></b> 
-<input type="text" placeholder="<%= word_for_attr :your_name_here%>"><br/>
-<a href="#" title="<%= word_for_attr :your_name_will_be_kept_secret%>">?</a>
-
-<button><%= word_for_attr :submit_button%></button>
-```
-
-Now when you want to edit wording:
-
-1. Activate edit mode by calling:
-```
-whowish_word.activate_edit_mode
-```
- in any controller. 
- (The usual way is to use user's session to determine whether or not to activate WhowishWord's edit mode)
-
-2. You'll see an edit icon on each word
-3. Click on an edit icon to edit the corresponding word
-4. Fill in a new word, and click save
-
-And when you have finished, deactivate edit mode.
-
-WhowishWord empowers normal users (project manager, marketing department, or sales) to change wording on a website.
-This take the burden off programmers because it is extremely boring to change wording...
-
-Demo: http://whowish-word.heroku.com
-
-### Note
-
-WhowishWord supports variables:
-
-```erb
-<%= word_for :you_are_here_for_number_of_times, :number=> 10 %>
-```
-
-If you set the word :you_are_here_for_number_of_times to be 
-
-```
-You are here {number} times already
-```
-
-WhowishWord renders it as:
-
-```
-You are here 10 times already
-```
-
-Multi-language support
------------------------
-
-You can change locale of WhowishWord by:
-
-```ruby
-whowish_word.set_locale("jp")
-```
-
-In Rails, you should add before_filter in the application controller as shown below:
-
-```ruby
-before_filter :set_locale
-
-def set_locale
-  if params[:locale]
-    session[:locale] = params[:locale]
-  end
-
-  session[:locale] ||= "en"
-  whowish_word.set_locale(session[:locale])
-end
-```
-
-
-Prerequisite
--------------------
-
-Rails 3.1.*
-
-It does not work with Rails 3.0.*, yet. Please send me an issue and I will fix it. (I'm just lazy)
-
-
-
-How to use it
--------------------
-
-First, install it:
-```
-gem install whowish_word
-```
-
-Or, in your Gemfile, put in the below line:
-```
-gem 'whowish_word'
-```
-
-Second, create RAILS_ROOT/config/initializers/whowish_word.rb that contains:
-
-```ruby
-require 'whowish_word'
-
-WhowishWord.init(:active_record)
-
-```
-
-You can use either use :active_record or :mongoid
-
-And, in your layout, please drop this line inside the tag header:
-
-```erb
-<%= whowish_word_javascript_and_css%>
-```
-
-It is to include the required Javascript and css files, when the edit mode is activated.
-
-
-Performance
--------------------
-
-It is fast because words are kept in memory. They are not kept in database while your Rails is running.
-
-
-Help me
--------------------------------------------------
-
-1. Fork the project
-	* Run all tests first:
-		* Go to ROOT, type 
-		```
-			bundle exec rspec spec/*
-		```
-		* Go to ROOT/rails, type
-		```
-			bundle exec rspec spec/*
-		```
-		* If all tests pass, you are ready to add a feature
-2. Add a feature
-3. Write a test for it
-4. Send me a pull request
-
-Please learn the code structure. If you have any question, feel free to ask me.
-
-
-Authors
--------------------
-
-Tanin Na Nakorn
-
-Tanun Niyomjit (Designer)
-
-
-Boring legal stuff
------------------------
-
-WhowishWord relies on several libraries that you won't see.
-They are embedded into whowish_word.js.
-
-The libraries:
-
-* jQuery 1.6.4 http://jquery.com/
-* Class.js (John Resig) http://ejohn.org/blog/simple-javascript-inheritance/
-* jQuery.escape http://plugins.jquery.com/project/escape
-* JSizes http://www.bramstein.com/projects/jsizes/
-* jQuery.loading_button (This is mine)
-
-Please be aware of the licenses of other libraries.
-
-For WhowishWord's code itself, it is under this license: http://creativecommons.org/licenses/by/3.0/
-
+WhowishWord - a Rails gem that make static content editable
+====================
+
+WhowishWord makes static content editable, as long as the programmers follow its convention.
+
+Demo: http://whowish-word.heroku.com
+
+
+The problem WhowishWord tries to solve
+---------------------------------------
+
+The problem that I personally faced in my company, Whowish, is that:
+
+	Occasionally CEO or VP of Marketing would send me an email to change the word 'Save'(on a submit button) to the word 'Post'.
+	I would have to go to the source code and change it.
+	And when this happens too often, it drives us, the programmers, crazy
+
+WhowishWord tries to solve this problem elegantly. It is much better than using a config file.
+
+It gives a simple tool for CEO, VP of Marketing (or whoever it is) to make changes themselves.
+
+The beauty of WhowishWord is that:
+
+* It is almost transparent to programmers
+* Programmers don't have to care how wording should be. This makes them work much faster
+* It does not clutter up your source code because you replace one static content unit with one function call
+
+Demo: http://whowish-word.heroku.com
+
+
+How you should work
+-------------------
+
+In your view, e.g. index.html.erb, use word_for(:identifier) and word_for_attr(:identifier):
+
+```erb
+<h1><%= word_for :title%></h1>
+<h3><%= word_for :you_are_here_for_number_of_times, :number=> 10 %></h3>
+
+<b><%= word_for :name_label%><b> <%= word_for :my_name%><br/>
+
+<b><%= word_for :your_name_label%></b> 
+<input type="text" placeholder="<%= word_for_attr :your_name_here%>"><br/>
+<a href="#" title="<%= word_for_attr :your_name_will_be_kept_secret%>">?</a>
+
+<button><%= word_for_attr :submit_button%></button>
+```
+
+Now when you want to edit wording:
+
+1. Activate edit mode by calling:
+```
+whowish_word.activate_edit_mode
+```
+ in any controller. 
+ (The usual way is to use user's session to determine whether or not to activate WhowishWord's edit mode)
+
+2. You'll see an edit icon on each word
+3. Click on an edit icon to edit the corresponding word
+4. Fill in a new word, and click save
+
+And when you have finished, deactivate edit mode.
+
+WhowishWord empowers normal users (project manager, marketing department, or sales) to change wording on a website.
+This take the burden off programmers because it is extremely boring to change wording...
+
+Demo: http://whowish-word.heroku.com
+
+### Note
+
+WhowishWord supports variables:
+
+```erb
+<%= word_for :you_are_here_for_number_of_times, :number=> 10 %>
+```
+
+If you set the word :you_are_here_for_number_of_times to be 
+
+```
+You are here {number} times already
+```
+
+WhowishWord renders it as:
+
+```
+You are here 10 times already
+```
+
+Multi-language support
+-----------------------
+
+You can change locale of WhowishWord by:
+
+```ruby
+whowish_word.set_locale("jp")
+```
+
+In Rails, you should add before_filter in the application controller as shown below:
+
+```ruby
+before_filter :set_locale
+
+def set_locale
+  if params[:locale]
+    session[:locale] = params[:locale]
+  end
+
+  session[:locale] ||= "en"
+  whowish_word.set_locale(session[:locale])
+end
+```
+
+
+Prerequisite
+-------------------
+
+Rails 3.1.*
+
+It does not work with Rails 3.0.*, yet. Please send me an issue and I will fix it. (I'm just lazy)
+
+
+
+How to use it
+-------------------
+
+First, install it:
+```
+gem install whowish_word
+```
+
+Or, in your Gemfile, put in the below line:
+```
+gem 'whowish_word'
+```
+
+Second, create RAILS_ROOT/config/initializers/whowish_word.rb that contains:
+
+```ruby
+require 'whowish_word'
+
+WhowishWord.init(:active_record)
+
+```
+
+You can use either use :active_record or :mongoid
+
+And, in your layout, please drop this line inside the tag header:
+
+```erb
+<%= whowish_word_javascript_and_css%>
+```
+
+It is to include the required Javascript and css files, when the edit mode is activated.
+
+
+Performance
+-------------------
+
+It is fast because words are kept in memory. They are not kept in database while your Rails is running.
+
+
+Help me
+-------------------------------------------------
+
+1. Fork the project
+	* Run all tests first:
+		* Go to ROOT, type 
+		```
+			bundle exec rspec spec/*
+		```
+		* Go to ROOT/rails, type
+		```
+			bundle exec rspec spec/*
+		```
+		* If all tests pass, you are ready to add a feature
+2. Add a feature
+3. Write a test for it
+4. Send me a pull request
+
+Please learn the code structure. If you have any question, feel free to ask me.
+
+
+Authors
+-------------------
+
+Tanin Na Nakorn
+
+Tanun Niyomjit (Designer)
+
+
+Boring legal stuff
+-----------------------
+
+WhowishWord relies on several libraries that you won't see.
+They are embedded into whowish_word.js.
+
+The libraries:
+
+* jQuery 1.6.4 http://jquery.com/
+* Class.js (John Resig) http://ejohn.org/blog/simple-javascript-inheritance/
+* jQuery.escape http://plugins.jquery.com/project/escape
+* JSizes http://www.bramstein.com/projects/jsizes/
+* jQuery.loading_button (This is mine)
+
+Please be aware of the licenses of other libraries.
+
+For WhowishWord's code itself, it is under this license: http://creativecommons.org/licenses/by/3.0/
+
 Basically, you can do whatever you want with it. Just give us some credits.

data/lib/whowish_word/action_controller/base.rb

@@ -1,45 +1,45 @@
-
-if defined?(ActionController) and defined?(ActionController::Base)
-
-  class ActionController::Base
-    
-    prepend_before_filter :initialize_whowish_word
-    attr_accessor :whowish_word_config
-
-
-    def initialize_whowish_word
-      @whowish_word_config = WhowishWord::Config.new
-    end
-
-
-    helper_method :whowish_word
-    
-    def whowish_word
-      return @whowish_word_config
-    end
-
-
-    def word_for(namespace, id, *variables)
-      
-      if @whowish_word_config.edit_mode == true
-        return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-      else
-        return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
-      end
-      
-    end
-    
-    
-    def word_for_attr(namespace, id, *variables)
-      
-      if @whowish_word_config.edit_mode == true
-        return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-      else
-        return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
-      end
-      
-    end
-
-  end
-
+
+if defined?(ActionController) and defined?(ActionController::Base)
+
+  class ActionController::Base
+    
+    prepend_before_filter :initialize_whowish_word
+    attr_accessor :whowish_word_config
+
+
+    def initialize_whowish_word
+      @whowish_word_config = WhowishWord::Config.new
+    end
+
+
+    helper_method :whowish_word
+    
+    def whowish_word
+      return @whowish_word_config
+    end
+
+
+    def word_for(namespace, id, *variables)
+      
+      if @whowish_word_config.edit_mode == true
+        return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
+      else
+        return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
+      end
+      
+    end
+    
+    
+    def word_for_attr(namespace, id, *variables)
+      
+      if @whowish_word_config.edit_mode == true
+        return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
+      else
+        return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
+      end
+      
+    end
+
+  end
+
 end

data/lib/whowish_word/action_mailer/base.rb

@@ -1,12 +1,12 @@
-
-if defined?(ActionMailer) and defined?(ActionMailer::Base)
-
-  class ActionMailer::Base
-    
-    def word_for(id, *p)
-      WhowishWord.word_for(mailer_name + "/" + @template+".html.erb",id,*p)
-    end
-    
-  end
-
+
+if defined?(ActionMailer) and defined?(ActionMailer::Base)
+
+  class ActionMailer::Base
+    
+    def word_for(id, *p)
+      WhowishWord.word_for(mailer_name + "/" + @template+".html.erb",id,*p)
+    end
+    
+  end
+
 end

data/lib/whowish_word/action_view/base.rb

@@ -1,71 +1,71 @@
-
-if defined?(ActionView) and defined?(ActionView::Base)
-
-  class ActionView::Base
-
-
-    def whowish_word_javascript_and_css(force = false)
-      
-      return "" if @whowish_word_config.edit_mode != true and force == false
-      
-      script_text = <<-HTML
-        <script type="text/javascript">
-          $w(function() {
-            $w.whowishWord();
-          });
-        </script>
-      HTML
-      
-      return javascript_include_tag("/whowish_word_js").sub('.js', '').html_safe + \
-              stylesheet_link_tag("/whowish_word_css").sub('.css', '').html_safe + \
-              script_text.html_safe
-    end
-
-
-    def global_word_for(namespace, id, *variables)
-      
-      if @whowish_word_config.edit_mode == true
-        return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-      else
-        return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
-      end
-      
-    end
-
-
-    def global_word_for_attr(namespace, id, *variables)
-      
-      if @whowish_word_config.edit_mode == true
-        return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
-      else
-        return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
-      end
-      
-    end
-
-
-    def word_for(id, *variables)
-      
-      namespace = get_relative_view_path(@whowish_word_page)
-      global_word_for(namespace, id, *variables)
-      
-    end
-
-
-    def word_for_attr(id, *variables)
-      
-      namespace = get_relative_view_path(@whowish_word_page)
-      global_word_for_attr(namespace, id, *variables)
-      
-    end
-
-
-    private
-      def get_relative_view_path(full_path)
-        result = @whowish_word_page.match(/[\/\\](([^\/\\]+)[\/\\]([^\/\\]+))\Z/)
-        return result[1]
-    end
-
-  end
-
+
+if defined?(ActionView) and defined?(ActionView::Base)
+
+  class ActionView::Base
+
+
+    def whowish_word_javascript_and_css(force = false)
+      
+      return "" if @whowish_word_config.edit_mode != true and force == false
+      
+      script_text = <<-HTML
+        <script type="text/javascript">
+          $w(function() {
+            $w.whowishWord();
+          });
+        </script>
+      HTML
+      
+      return "<script src='/whowish_word_js?#{Time.now.to_i}' type='text/javascript'></script>".html_safe + \
+             "<link href='/whowish_word_css?#{Time.now.to_i}' rel='stylesheet' type='text/css' />".html_safe + \
+              script_text.html_safe
+    end
+
+
+    def global_word_for(namespace, id, *variables)
+      
+      if @whowish_word_config.edit_mode == true
+        return WhowishWord.word_for_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
+      else
+        return WhowishWord.word_for(namespace, id, @whowish_word_config.locale, *variables)
+      end
+      
+    end
+
+
+    def global_word_for_attr(namespace, id, *variables)
+      
+      if @whowish_word_config.edit_mode == true
+        return WhowishWord.word_for_attr_in_edit_mode(namespace, id, @whowish_word_config.locale, *variables)
+      else
+        return WhowishWord.word_for_attr(namespace, id, @whowish_word_config.locale, *variables)
+      end
+      
+    end
+
+
+    def word_for(id, *variables)
+      
+      namespace = get_relative_view_path(@whowish_word_page)
+      global_word_for(namespace, id, *variables)
+      
+    end
+
+
+    def word_for_attr(id, *variables)
+      
+      namespace = get_relative_view_path(@whowish_word_page)
+      global_word_for_attr(namespace, id, *variables)
+      
+    end
+
+
+    private
+      def get_relative_view_path(full_path)
+        result = @whowish_word_page.match(/[\/\\](([^\/\\]+)[\/\\]([^\/\\]+))\Z/)
+        return result[1]
+    end
+
+  end
+
 end